AmazonDirectConnectClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.directconnect.AmazonDirectConnectClient

All Implemented Interfaces:

AmazonDirectConnect

Direct Known Subclasses:

AmazonDirectConnectAsyncClient
```
public class AmazonDirectConnectClient
extends AmazonWebServiceClient
implements AmazonDirectConnect
```
Client for accessing AmazonDirectConnect. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.

The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference :
- Actions : An alphabetical list of all AWS Direct Connect actions.
- Data Types : An alphabetical list of all AWS Direct Connect data types.
- Common Query Parameters : Parameters that all Query actions can use.
- Common Errors : Client and server errors that all actions can return.

Constructor Summary

Constructors
Constructor and Description
`AmazonDirectConnectClient()` Constructs a new client to invoke service methods on AmazonDirectConnect.
`AmazonDirectConnectClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials.
`AmazonDirectConnectClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials and client configuration options.
`AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials provider.
`AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials provider and client configuration options.
`AmazonDirectConnectClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonDirectConnect.

Method Summary

Methods
Modifier and Type	Method and Description
`AllocateConnectionOnInterconnectResult`	`allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest allocateConnectionOnInterconnectRequest)` Creates a hosted connection on an interconnect.
`AllocatePrivateVirtualInterfaceResult`	`allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest allocatePrivateVirtualInterfaceRequest)` Provisions a private virtual interface to be owned by a different customer.
`AllocatePublicVirtualInterfaceResult`	`allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest allocatePublicVirtualInterfaceRequest)` Provisions a public virtual interface to be owned by a different customer.
`ConfirmConnectionResult`	`confirmConnection(ConfirmConnectionRequest confirmConnectionRequest)` Confirm the creation of a hosted connection on an interconnect.
`ConfirmPrivateVirtualInterfaceResult`	`confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest confirmPrivateVirtualInterfaceRequest)` Accept ownership of a private virtual interface created by another customer.
`ConfirmPublicVirtualInterfaceResult`	`confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest confirmPublicVirtualInterfaceRequest)` Accept ownership of a public virtual interface created by another customer.
`CreateConnectionResult`	`createConnection(CreateConnectionRequest createConnectionRequest)` Creates a new connection between the customer network and a specific AWS Direct Connect location.
`CreateInterconnectResult`	`createInterconnect(CreateInterconnectRequest createInterconnectRequest)` Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.
`CreatePrivateVirtualInterfaceResult`	`createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest)` Creates a new private virtual interface.
`CreatePublicVirtualInterfaceResult`	`createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest)` Creates a new public virtual interface.
`DeleteConnectionResult`	`deleteConnection(DeleteConnectionRequest deleteConnectionRequest)` Deletes the connection.
`DeleteInterconnectResult`	`deleteInterconnect(DeleteInterconnectRequest deleteInterconnectRequest)` Deletes the specified interconnect.
`DeleteVirtualInterfaceResult`	`deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)` Deletes a virtual interface.
`DescribeConnectionsResult`	`describeConnections()` Displays all connections in this region.
`DescribeConnectionsResult`	`describeConnections(DescribeConnectionsRequest describeConnectionsRequest)` Displays all connections in this region.
`DescribeConnectionsOnInterconnectResult`	`describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest describeConnectionsOnInterconnectRequest)` Return a list of connections that have been provisioned on the given interconnect.
`DescribeInterconnectsResult`	`describeInterconnects()` Returns a list of interconnects owned by the AWS account.
`DescribeInterconnectsResult`	`describeInterconnects(DescribeInterconnectsRequest describeInterconnectsRequest)` Returns a list of interconnects owned by the AWS account.
`DescribeLocationsResult`	`describeLocations()` Returns the list of AWS Direct Connect locations in the current AWS region.
`DescribeLocationsResult`	`describeLocations(DescribeLocationsRequest describeLocationsRequest)` Returns the list of AWS Direct Connect locations in the current AWS region.
`DescribeVirtualGatewaysResult`	`describeVirtualGateways()` Returns a list of virtual private gateways owned by the AWS account.
`DescribeVirtualGatewaysResult`	`describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest)` Returns a list of virtual private gateways owned by the AWS account.
`DescribeVirtualInterfacesResult`	`describeVirtualInterfaces()` Displays all virtual interfaces for an AWS account.
`DescribeVirtualInterfacesResult`	`describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest)` Displays all virtual interfaces for an AWS account.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client.
`void`	`setEndpoint(String endpoint, String serviceName, String regionId)` Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setRegion, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.directconnect.AmazonDirectConnect
setRegion, shutdown

- Constructor Detail
  - AmazonDirectConnectClient
```
public AmazonDirectConnectClient()
```
    Constructs a new client to invoke service methods on AmazonDirectConnect. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    DefaultAWSCredentialsProviderChain
  - AmazonDirectConnectClient
```
public AmazonDirectConnectClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonDirectConnect. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to AmazonDirectConnect (ex: proxy settings, retry counts, etc.).
    See Also:
    DefaultAWSCredentialsProviderChain
  - AmazonDirectConnectClient
```
public AmazonDirectConnectClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonDirectConnectClient
```
public AmazonDirectConnectClient(AWSCredentials awsCredentials,
                         ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AmazonDirectConnect (ex: proxy settings, retry counts, etc.).
  - AmazonDirectConnectClient
```
public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonDirectConnectClient
```
public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonDirectConnect using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AmazonDirectConnect (ex: proxy settings, retry counts, etc.).
- Method Detail
  - describeLocations
```
public DescribeLocationsResult describeLocations(DescribeLocationsRequest describeLocationsRequest)
```
    Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.
    
    Specified by:
    
    describeLocations in interface AmazonDirectConnect
    
    Parameters:
    describeLocationsRequest - Container for the necessary parameters to execute the DescribeLocations service method on AmazonDirectConnect.
    
    Returns:
    The response from the DescribeLocations service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - confirmPublicVirtualInterface
```
public ConfirmPublicVirtualInterfaceResult confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest confirmPublicVirtualInterfaceRequest)
```
    Accept ownership of a public virtual interface created by another customer.
    
    After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.
    
    Specified by:
    
    confirmPublicVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    confirmPublicVirtualInterfaceRequest - Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the ConfirmPublicVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - createPrivateVirtualInterface
```
public CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest)
```
    Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).
    
    Specified by:
    
    createPrivateVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    createPrivateVirtualInterfaceRequest - Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the CreatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - deleteVirtualInterface
```
public DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)
```
    Deletes a virtual interface.
    
    Specified by:
    
    deleteVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    deleteVirtualInterfaceRequest - Container for the necessary parameters to execute the DeleteVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the DeleteVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - createPublicVirtualInterface
```
public CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest)
```
    Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).
    
    Specified by:
    
    createPublicVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    createPublicVirtualInterfaceRequest - Container for the necessary parameters to execute the CreatePublicVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the CreatePublicVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - createInterconnect
```
public CreateInterconnectResult createInterconnect(CreateInterconnectRequest createInterconnectRequest)
```
    Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.
    
    An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.
    
    For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.
    
    Specified by:
    
    createInterconnect in interface AmazonDirectConnect
    
    Parameters:
    createInterconnectRequest - Container for the necessary parameters to execute the CreateInterconnect service method on AmazonDirectConnect.
    
    Returns:
    The response from the CreateInterconnect service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeVirtualInterfaces
```
public DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest)
```
    Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.
    
    A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
    
    If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.
    
    Specified by:
    
    describeVirtualInterfaces in interface AmazonDirectConnect
    
    Parameters:
    describeVirtualInterfacesRequest - Container for the necessary parameters to execute the DescribeVirtualInterfaces service method on AmazonDirectConnect.
    
    Returns:
    The response from the DescribeVirtualInterfaces service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - confirmConnection
```
public ConfirmConnectionResult confirmConnection(ConfirmConnectionRequest confirmConnectionRequest)
```
    Confirm the creation of a hosted connection on an interconnect.
    
    Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.
    
    Specified by:
    
    confirmConnection in interface AmazonDirectConnect
    
    Parameters:
    confirmConnectionRequest - Container for the necessary parameters to execute the ConfirmConnection service method on AmazonDirectConnect.
    
    Returns:
    The response from the ConfirmConnection service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeInterconnects
```
public DescribeInterconnectsResult describeInterconnects(DescribeInterconnectsRequest describeInterconnectsRequest)
```
    Returns a list of interconnects owned by the AWS account.
    
    If an interconnect ID is provided, it will only return this particular interconnect.
    
    Specified by:
    
    describeInterconnects in interface AmazonDirectConnect
    
    Parameters:
    describeInterconnectsRequest - Container for the necessary parameters to execute the DescribeInterconnects service method on AmazonDirectConnect.
    
    Returns:
    The response from the DescribeInterconnects service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeVirtualGateways
```
public DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest)
```
    Returns a list of virtual private gateways owned by the AWS account.
    
    You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
    
    Specified by:
    
    describeVirtualGateways in interface AmazonDirectConnect
    
    Parameters:
    describeVirtualGatewaysRequest - Container for the necessary parameters to execute the DescribeVirtualGateways service method on AmazonDirectConnect.
    
    Returns:
    The response from the DescribeVirtualGateways service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - confirmPrivateVirtualInterface
```
public ConfirmPrivateVirtualInterfaceResult confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest confirmPrivateVirtualInterfaceRequest)
```
    Accept ownership of a private virtual interface created by another customer.
    
    After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.
    
    Specified by:
    
    confirmPrivateVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    confirmPrivateVirtualInterfaceRequest - Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the ConfirmPrivateVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeConnections
```
public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
```
    Displays all connections in this region.
    
    If a connection ID is provided, the call returns only that particular connection.
    
    Specified by:
    
    describeConnections in interface AmazonDirectConnect
    
    Parameters:
    describeConnectionsRequest - Container for the necessary parameters to execute the DescribeConnections service method on AmazonDirectConnect.
    
    Returns:
    The response from the DescribeConnections service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - allocatePublicVirtualInterface
```
public AllocatePublicVirtualInterfaceResult allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest allocatePublicVirtualInterfaceRequest)
```
    Provisions a public virtual interface to be owned by a different customer.
    
    The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.
    
    Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
    
    Specified by:
    
    allocatePublicVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    allocatePublicVirtualInterfaceRequest - Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the AllocatePublicVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - allocatePrivateVirtualInterface
```
public AllocatePrivateVirtualInterfaceResult allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest allocatePrivateVirtualInterfaceRequest)
```
    Provisions a private virtual interface to be owned by a different customer.
    
    The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.
    
    Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
    
    Specified by:
    
    allocatePrivateVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    allocatePrivateVirtualInterfaceRequest - Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method on AmazonDirectConnect.
    
    Returns:
    The response from the AllocatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - deleteConnection
```
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
```
    Deletes the connection.
    
    Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.
    
    Specified by:
    
    deleteConnection in interface AmazonDirectConnect
    
    Parameters:
    deleteConnectionRequest - Container for the necessary parameters to execute the DeleteConnection service method on AmazonDirectConnect.
    
    Returns:
    The response from the DeleteConnection service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeConnectionsOnInterconnect
```
public DescribeConnectionsOnInterconnectResult describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest describeConnectionsOnInterconnectRequest)
```
    Return a list of connections that have been provisioned on the given interconnect.
    
    Specified by:
    
    describeConnectionsOnInterconnect in interface AmazonDirectConnect
    
    Parameters:
    describeConnectionsOnInterconnectRequest - Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method on AmazonDirectConnect.
    
    Returns:
    The response from the DescribeConnectionsOnInterconnect service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - allocateConnectionOnInterconnect
```
public AllocateConnectionOnInterconnectResult allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest allocateConnectionOnInterconnectRequest)
```
    Creates a hosted connection on an interconnect.
    
    Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.
    
    Specified by:
    
    allocateConnectionOnInterconnect in interface AmazonDirectConnect
    
    Parameters:
    allocateConnectionOnInterconnectRequest - Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method on AmazonDirectConnect.
    
    Returns:
    The response from the AllocateConnectionOnInterconnect service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - createConnection
```
public CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest)
```
    Creates a new connection between the customer network and a specific AWS Direct Connect location.
    
    A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.
    
    Specified by:
    
    createConnection in interface AmazonDirectConnect
    
    Parameters:
    createConnectionRequest - Container for the necessary parameters to execute the CreateConnection service method on AmazonDirectConnect.
    
    Returns:
    The response from the CreateConnection service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - deleteInterconnect
```
public DeleteInterconnectResult deleteInterconnect(DeleteInterconnectRequest deleteInterconnectRequest)
```
    Deletes the specified interconnect.
    
    Specified by:
    
    deleteInterconnect in interface AmazonDirectConnect
    
    Parameters:
    deleteInterconnectRequest - Container for the necessary parameters to execute the DeleteInterconnect service method on AmazonDirectConnect.
    
    Returns:
    The response from the DeleteInterconnect service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeLocations
```
public DescribeLocationsResult describeLocations()
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.
    
    Specified by:
    
    describeLocations in interface AmazonDirectConnect
    
    Returns:
    The response from the DescribeLocations service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeVirtualInterfaces
```
public DescribeVirtualInterfacesResult describeVirtualInterfaces()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.
    
    A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
    
    If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.
    
    Specified by:
    
    describeVirtualInterfaces in interface AmazonDirectConnect
    
    Returns:
    The response from the DescribeVirtualInterfaces service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeInterconnects
```
public DescribeInterconnectsResult describeInterconnects()
                                                  throws AmazonServiceException,
                                                         AmazonClientException
```
    Returns a list of interconnects owned by the AWS account.
    
    If an interconnect ID is provided, it will only return this particular interconnect.
    
    Specified by:
    
    describeInterconnects in interface AmazonDirectConnect
    
    Returns:
    The response from the DescribeInterconnects service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeVirtualGateways
```
public DescribeVirtualGatewaysResult describeVirtualGateways()
                                                      throws AmazonServiceException,
                                                             AmazonClientException
```
    Returns a list of virtual private gateways owned by the AWS account.
    
    You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
    
    Specified by:
    
    describeVirtualGateways in interface AmazonDirectConnect
    
    Returns:
    The response from the DescribeVirtualGateways service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - describeConnections
```
public DescribeConnectionsResult describeConnections()
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    Displays all connections in this region.
    
    If a connection ID is provided, the call returns only that particular connection.
    
    Specified by:
    
    describeConnections in interface AmazonDirectConnect
    
    Returns:
    The response from the DescribeConnections service method, as returned by AmazonDirectConnect.
    
    Throws:
    
    DirectConnectServerException
    
    DirectConnectClientException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from class: AmazonWebServiceClient
    
    Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.
    This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
    Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    
    Specified by:
    
    setEndpoint in interface AmazonDirectConnect
    
    Overrides:
    
    setEndpoint in class AmazonWebServiceClient
    
    Parameters:
    endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setEndpoint
```
public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException
```
    Description copied from class: AmazonWebServiceClient
    
    Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
    This method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
    Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    
    Overrides:
    
    setEndpoint in class AmazonWebServiceClient
    
    Parameters:
    endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
    serviceName - The name of the AWS service to use when signing requests.
    regionId - The ID of the region in which this service resides.
    
    Throws:
    
    IllegalArgumentException - If any problems are detected with the specified endpoint.
    See Also:
    AmazonDynamoDB#setRegion(Region)
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonDirectConnect
    
    Parameters:
    request - The originally executed request
    
    Returns:
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AmazonDirectConnectClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.directconnect.AmazonDirectConnect

Constructor Detail

AmazonDirectConnectClient

AmazonDirectConnectClient

AmazonDirectConnectClient

AmazonDirectConnectClient

AmazonDirectConnectClient

AmazonDirectConnectClient

Method Detail

describeLocations

confirmPublicVirtualInterface

createPrivateVirtualInterface

deleteVirtualInterface

createPublicVirtualInterface

createInterconnect

describeVirtualInterfaces

confirmConnection

describeInterconnects

describeVirtualGateways

confirmPrivateVirtualInterface

describeConnections

allocatePublicVirtualInterface

allocatePrivateVirtualInterface

deleteConnection

describeConnectionsOnInterconnect

allocateConnectionOnInterconnect

createConnection

deleteInterconnect

describeLocations

describeVirtualInterfaces

describeInterconnects

describeVirtualGateways

describeConnections

setEndpoint

setEndpoint

getCachedResponseMetadata