AmazonDirectConnectClient (AWS SDK for Java

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

All Implemented Interfaces:

AmazonDirectConnect

Direct Known Subclasses:

AmazonDirectConnectAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDirectConnectClient
extends AmazonWebServiceClient
implements AmazonDirectConnect
```
Client for accessing AWS Direct Connect. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Direct Connect 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. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon Elastic Compute Cloud (Amazon EC2) and Amazon Simple Storage Service (Amazon S3)) and to Amazon Virtual Private Cloud (Amazon VPC), bypassing Internet service providers in your network path. An AWS Direct Connect location provides access to AWS in the region it is associated with, as well as access to other US regions. For example, you can provision a single connection to any AWS Direct Connect location in the US and use it to access public AWS services in all US Regions and AWS GovCloud (US).

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.directconnect.AmazonDirectConnect
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AmazonDirectConnectClient()` Deprecated. use `AmazonDirectConnectClientBuilder.defaultClient()`
`AmazonDirectConnectClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AmazonDirectConnectClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AmazonDirectConnectClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AmazonDirectConnectClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AllocateConnectionOnInterconnectResult`	`allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest request)` Deprecated.
`AllocateHostedConnectionResult`	`allocateHostedConnection(AllocateHostedConnectionRequest request)` Creates a hosted connection on an interconnect or a link aggregation group (LAG).
`AllocatePrivateVirtualInterfaceResult`	`allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest request)` Provisions a private virtual interface to be owned by another AWS customer.
`AllocatePublicVirtualInterfaceResult`	`allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest request)` Provisions a public virtual interface to be owned by a different customer.
`AssociateConnectionWithLagResult`	`associateConnectionWithLag(AssociateConnectionWithLagRequest request)` Associates an existing connection with a link aggregation group (LAG).
`AssociateHostedConnectionResult`	`associateHostedConnection(AssociateHostedConnectionRequest request)` Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect.
`AssociateVirtualInterfaceResult`	`associateVirtualInterface(AssociateVirtualInterfaceRequest request)` Associates a virtual interface with a specified link aggregation group (LAG) or connection.
`static AmazonDirectConnectClientBuilder`	`builder()`
`ConfirmConnectionResult`	`confirmConnection(ConfirmConnectionRequest request)` Confirm the creation of a hosted connection on an interconnect.
`ConfirmPrivateVirtualInterfaceResult`	`confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest request)` Accept ownership of a private virtual interface created by another customer.
`ConfirmPublicVirtualInterfaceResult`	`confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest request)` Accept ownership of a public virtual interface created by another customer.
`CreateBGPPeerResult`	`createBGPPeer(CreateBGPPeerRequest request)` Creates a new BGP peer on a specified virtual interface.
`CreateConnectionResult`	`createConnection(CreateConnectionRequest request)` Creates a new connection between the customer network and a specific AWS Direct Connect location.
`CreateDirectConnectGatewayResult`	`createDirectConnectGateway(CreateDirectConnectGatewayRequest request)` Creates a new direct connect gateway.
`CreateDirectConnectGatewayAssociationResult`	`createDirectConnectGatewayAssociation(CreateDirectConnectGatewayAssociationRequest request)` Creates an association between a direct connect gateway and a virtual private gateway (VGW).
`CreateInterconnectResult`	`createInterconnect(CreateInterconnectRequest request)` Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.
`CreateLagResult`	`createLag(CreateLagRequest request)` Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location.
`CreatePrivateVirtualInterfaceResult`	`createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest request)` Creates a new private virtual interface.
`CreatePublicVirtualInterfaceResult`	`createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest request)` Creates a new public virtual interface.
`DeleteBGPPeerResult`	`deleteBGPPeer(DeleteBGPPeerRequest request)` Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN.
`DeleteConnectionResult`	`deleteConnection(DeleteConnectionRequest request)` Deletes the connection.
`DeleteDirectConnectGatewayResult`	`deleteDirectConnectGateway(DeleteDirectConnectGatewayRequest request)` Deletes a direct connect gateway.
`DeleteDirectConnectGatewayAssociationResult`	`deleteDirectConnectGatewayAssociation(DeleteDirectConnectGatewayAssociationRequest request)` Deletes the association between a direct connect gateway and a virtual private gateway.
`DeleteInterconnectResult`	`deleteInterconnect(DeleteInterconnectRequest request)` Deletes the specified interconnect.
`DeleteLagResult`	`deleteLag(DeleteLagRequest request)` Deletes a link aggregation group (LAG).
`DeleteVirtualInterfaceResult`	`deleteVirtualInterface(DeleteVirtualInterfaceRequest request)` Deletes a virtual interface.
`DescribeConnectionLoaResult`	`describeConnectionLoa(DescribeConnectionLoaRequest request)` Deprecated.
`DescribeConnectionsResult`	`describeConnections()` Simplified method form for invoking the DescribeConnections operation.
`DescribeConnectionsResult`	`describeConnections(DescribeConnectionsRequest request)` Displays all connections in this region.
`DescribeConnectionsOnInterconnectResult`	`describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest request)` Deprecated.
`DescribeDirectConnectGatewayAssociationsResult`	`describeDirectConnectGatewayAssociations(DescribeDirectConnectGatewayAssociationsRequest request)` Returns a list of all direct connect gateway and virtual private gateway (VGW) associations.
`DescribeDirectConnectGatewayAttachmentsResult`	`describeDirectConnectGatewayAttachments(DescribeDirectConnectGatewayAttachmentsRequest request)` Returns a list of all direct connect gateway and virtual interface (VIF) attachments.
`DescribeDirectConnectGatewaysResult`	`describeDirectConnectGateways(DescribeDirectConnectGatewaysRequest request)` Returns a list of direct connect gateways in your account.
`DescribeHostedConnectionsResult`	`describeHostedConnections(DescribeHostedConnectionsRequest request)` Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).
`DescribeInterconnectLoaResult`	`describeInterconnectLoa(DescribeInterconnectLoaRequest request)` Deprecated.
`DescribeInterconnectsResult`	`describeInterconnects()` Simplified method form for invoking the DescribeInterconnects operation.
`DescribeInterconnectsResult`	`describeInterconnects(DescribeInterconnectsRequest request)` Returns a list of interconnects owned by the AWS account.
`DescribeLagsResult`	`describeLags(DescribeLagsRequest request)` Describes the link aggregation groups (LAGs) in your account.
`DescribeLoaResult`	`describeLoa(DescribeLoaRequest request)` Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
`DescribeLocationsResult`	`describeLocations()` Simplified method form for invoking the DescribeLocations operation.
`DescribeLocationsResult`	`describeLocations(DescribeLocationsRequest request)` Returns the list of AWS Direct Connect locations in the current AWS region.
`DescribeTagsResult`	`describeTags(DescribeTagsRequest request)` Describes the tags associated with the specified Direct Connect resources.
`DescribeVirtualGatewaysResult`	`describeVirtualGateways()` Simplified method form for invoking the DescribeVirtualGateways operation.
`DescribeVirtualGatewaysResult`	`describeVirtualGateways(DescribeVirtualGatewaysRequest request)` Returns a list of virtual private gateways owned by the AWS account.
`DescribeVirtualInterfacesResult`	`describeVirtualInterfaces()` Simplified method form for invoking the DescribeVirtualInterfaces operation.
`DescribeVirtualInterfacesResult`	`describeVirtualInterfaces(DescribeVirtualInterfacesRequest request)` Displays all virtual interfaces for an AWS account.
`DisassociateConnectionFromLagResult`	`disassociateConnectionFromLag(DisassociateConnectionFromLagRequest request)` Disassociates a connection from a link aggregation group (LAG).
`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.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds the specified tags to the specified Direct Connect resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified Direct Connect resource.
`UpdateLagResult`	`updateLag(UpdateLagRequest request)` Updates the attributes of a link aggregation group (LAG).

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
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AmazonDirectConnectClient
```
@Deprecated
public AmazonDirectConnectClient()
```
    Deprecated. use AmazonDirectConnectClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on AWS Direct Connect. 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
```
@Deprecated
public AmazonDirectConnectClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on AWS Direct Connect. 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 AWS Direct Connect (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonDirectConnectClient
```
@Deprecated
public AmazonDirectConnectClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonDirectConnectClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on AWS Direct Connect 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
```
@Deprecated
public AmazonDirectConnectClient(AWSCredentials awsCredentials,
                                             ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS Direct Connect 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 AWS Direct Connect (ex: proxy settings, retry counts, etc.).
  - AmazonDirectConnectClient
```
@Deprecated
public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on AWS Direct Connect 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
```
@Deprecated
public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
                                             ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS Direct Connect 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 AWS Direct Connect (ex: proxy settings, retry counts, etc.).
  - AmazonDirectConnectClient
```
@Deprecated
public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
                                             ClientConfiguration clientConfiguration,
                                             RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on AWS Direct Connect using the specified AWS account credentials provider, client configuration options, and request metric collector.
    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 AWS Direct Connect (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AmazonDirectConnectClientBuilder builder()
```
  - allocateConnectionOnInterconnect
```
@Deprecated
public AllocateConnectionOnInterconnectResult allocateConnectionOnInterconnect(AllocateConnectionOnInterconnectRequest request)
```
    Deprecated.
    
    Deprecated in favor of AllocateHostedConnection.
    
    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.
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    allocateConnectionOnInterconnect in interface AmazonDirectConnect
    
    Parameters:
    
    allocateConnectionOnInterconnectRequest - Container for the parameters to the AllocateConnectionOnInterconnect operation.
    
    Returns:
    
    Result of the AllocateConnectionOnInterconnect operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - allocateHostedConnection
```
public AllocateHostedConnectionResult allocateHostedConnection(AllocateHostedConnectionRequest request)
```
    Creates a hosted connection on an interconnect or a link aggregation group (LAG).
    
    Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect or LAG.
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    allocateHostedConnection in interface AmazonDirectConnect
    
    Parameters:
    
    allocateHostedConnectionRequest - Container for the parameters to theHostedConnection operation.
    
    Returns:
    
    Result of the AllocateHostedConnection operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - allocatePrivateVirtualInterface
```
public AllocatePrivateVirtualInterfaceResult allocatePrivateVirtualInterface(AllocatePrivateVirtualInterfaceRequest request)
```
    Provisions a private virtual interface to be owned by another AWS customer.
    
    Virtual interfaces created using this action must be confirmed by the virtual interface owner by using the ConfirmPrivateVirtualInterface action. Until then, 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 parameters to the AllocatePrivateVirtualInterface operation.
    
    Returns:
    
    Result of the AllocatePrivateVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - allocatePublicVirtualInterface
```
public AllocatePublicVirtualInterfaceResult allocatePublicVirtualInterface(AllocatePublicVirtualInterfaceRequest request)
```
    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.
    
    When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.
    
    Specified by:
    
    allocatePublicVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    
    allocatePublicVirtualInterfaceRequest - Container for the parameters to the AllocatePublicVirtualInterface operation.
    
    Returns:
    
    Result of the AllocatePublicVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - associateConnectionWithLag
```
public AssociateConnectionWithLagResult associateConnectionWithLag(AssociateConnectionWithLagRequest request)
```
    Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS will be interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can reassociate a connection that's currently associated with a different LAG; however, if removing the connection will cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.
    
    Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.
    
    For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.
    
    Specified by:
    
    associateConnectionWithLag in interface AmazonDirectConnect
    
    Parameters:
    
    associateConnectionWithLagRequest - Container for the parameters to the AssociateConnectionWithLag operation.
    
    Returns:
    
    Result of the AssociateConnectionWithLag operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - associateHostedConnection
```
public AssociateHostedConnectionResult associateHostedConnection(AssociateHostedConnectionRequest request)
```
    Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    associateHostedConnection in interface AmazonDirectConnect
    
    Parameters:
    
    associateHostedConnectionRequest - Container for the parameters to the AssociateHostedConnection operation.
    
    Returns:
    
    Result of the AssociateHostedConnection operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - associateVirtualInterface
```
public AssociateVirtualInterfaceResult associateVirtualInterface(AssociateVirtualInterfaceRequest request)
```
    Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.
    
    Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.
    
    In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.
    
    Specified by:
    
    associateVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    
    associateVirtualInterfaceRequest - Container for the parameters to the AssociateVirtualInterface operation.
    
    Returns:
    
    Result of the AssociateVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - confirmConnection
```
public ConfirmConnectionResult confirmConnection(ConfirmConnectionRequest request)
```
    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 parameters to the ConfirmConnection operation.
    
    Returns:
    
    Result of the ConfirmConnection operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - confirmPrivateVirtualInterface
```
public ConfirmPrivateVirtualInterfaceResult confirmPrivateVirtualInterface(ConfirmPrivateVirtualInterfaceRequest request)
```
    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 or direct connect gateway, and will be available for handling traffic.
    
    Specified by:
    
    confirmPrivateVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    
    confirmPrivateVirtualInterfaceRequest - Container for the parameters to the ConfirmPrivateVirtualInterface operation.
    
    Returns:
    
    Result of the ConfirmPrivateVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - confirmPublicVirtualInterface
```
public ConfirmPublicVirtualInterfaceResult confirmPublicVirtualInterface(ConfirmPublicVirtualInterfaceRequest request)
```
    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 parameters to the ConfirmPublicVirtualInterface operation.
    
    Returns:
    
    Result of the ConfirmPublicVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createBGPPeer
```
public CreateBGPPeerResult createBGPPeer(CreateBGPPeerRequest request)
```
    Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.
    
    You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.
    
    When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
    
    For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.
    
    Specified by:
    
    createBGPPeer in interface AmazonDirectConnect
    
    Parameters:
    
    createBGPPeerRequest - Container for the parameters to the CreateBGPPeer operation.
    
    Returns:
    
    Result of the CreateBGPPeer operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createConnection
```
public CreateConnectionResult createConnection(CreateConnectionRequest request)
```
    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.
    
    To find the locations for your region, use DescribeLocations.
    
    You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.
    
    Specified by:
    
    createConnection in interface AmazonDirectConnect
    
    Parameters:
    
    createConnectionRequest - Container for the parameters to the CreateConnection operation.
    
    Returns:
    
    Result of the CreateConnection operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createDirectConnectGateway
```
public CreateDirectConnectGatewayResult createDirectConnectGateway(CreateDirectConnectGatewayRequest request)
```
    Creates a new direct connect gateway. A direct connect gateway is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. direct connect gateways are global and visible in any AWS region after they are created. The virtual interfaces and virtual private gateways that are connected through a direct connect gateway can be in different regions. This enables you to connect to a VPC in any region, regardless of the region in which the virtual interfaces are located, and pass traffic between them.
    
    Specified by:
    
    createDirectConnectGateway in interface AmazonDirectConnect
    
    Parameters:
    
    createDirectConnectGatewayRequest - Container for the parameters to the CreateDirectConnectGateway operation.
    
    Returns:
    
    Result of the CreateDirectConnectGateway operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createDirectConnectGatewayAssociation
```
public CreateDirectConnectGatewayAssociationResult createDirectConnectGatewayAssociation(CreateDirectConnectGatewayAssociationRequest request)
```
    Creates an association between a direct connect gateway and a virtual private gateway (VGW). The VGW must be attached to a VPC and must not be associated with another direct connect gateway.
    
    Specified by:
    
    createDirectConnectGatewayAssociation in interface AmazonDirectConnect
    
    Parameters:
    
    createDirectConnectGatewayAssociationRequest - Container for the parameters to the CreateDirectConnectGatewayAssociation operation.
    
    Returns:
    
    Result of the CreateDirectConnectGatewayAssociation operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createInterconnect
```
public CreateInterconnectResult createInterconnect(CreateInterconnectRequest request)
```
    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.
    
    You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect will be created.
    
    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.
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    createInterconnect in interface AmazonDirectConnect
    
    Parameters:
    
    createInterconnectRequest - Container for the parameters to the CreateInterconnect operation.
    
    Returns:
    
    Result of the CreateInterconnect operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createLag
```
public CreateLagResult createLag(CreateLagRequest request)
```
    Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.
    
    All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.
    
    You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.
    
    You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.
    
    If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.
    
    Specified by:
    
    createLag in interface AmazonDirectConnect
    
    Parameters:
    
    createLagRequest - Container for the parameters to the CreateLag operation.
    
    Returns:
    
    Result of the CreateLag operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createPrivateVirtualInterface
```
public CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest request)
```
    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 parameters to the CreatePrivateVirtualInterface operation.
    
    Returns:
    
    Result of the CreatePrivateVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - createPublicVirtualInterface
```
public CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest request)
```
    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).
    
    When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.
    
    Specified by:
    
    createPublicVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    
    createPublicVirtualInterfaceRequest - Container for the parameters to the CreatePublicVirtualInterface operation.
    
    Returns:
    
    Result of the CreatePublicVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteBGPPeer
```
public DeleteBGPPeerResult deleteBGPPeer(DeleteBGPPeerRequest request)
```
    Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.
    
    Specified by:
    
    deleteBGPPeer in interface AmazonDirectConnect
    
    Parameters:
    
    deleteBGPPeerRequest - Container for the parameters to the DeleteBGPPeer operation.
    
    Returns:
    
    Result of the DeleteBGPPeer operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteConnection
```
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
```
    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 parameters to the DeleteConnection operation.
    
    Returns:
    
    Result of the DeleteConnection operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectConnectGateway
```
public DeleteDirectConnectGatewayResult deleteDirectConnectGateway(DeleteDirectConnectGatewayRequest request)
```
    Deletes a direct connect gateway. You must first delete all virtual interfaces that are attached to the direct connect gateway and disassociate all virtual private gateways that are associated with the direct connect gateway.
    
    Specified by:
    
    deleteDirectConnectGateway in interface AmazonDirectConnect
    
    Parameters:
    
    deleteDirectConnectGatewayRequest - Container for the parameters to the DeleteDirectConnectGateway operation.
    
    Returns:
    
    Result of the DeleteDirectConnectGateway operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectConnectGatewayAssociation
```
public DeleteDirectConnectGatewayAssociationResult deleteDirectConnectGatewayAssociation(DeleteDirectConnectGatewayAssociationRequest request)
```
    Deletes the association between a direct connect gateway and a virtual private gateway.
    
    Specified by:
    
    deleteDirectConnectGatewayAssociation in interface AmazonDirectConnect
    
    Parameters:
    
    deleteDirectConnectGatewayAssociationRequest - Container for the parameters to the DeleteDirectConnectGatewayAssociation operation.
    
    Returns:
    
    Result of the DeleteDirectConnectGatewayAssociation operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteInterconnect
```
public DeleteInterconnectResult deleteInterconnect(DeleteInterconnectRequest request)
```
    Deletes the specified interconnect.
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    deleteInterconnect in interface AmazonDirectConnect
    
    Parameters:
    
    deleteInterconnectRequest - Container for the parameters to the DeleteInterconnect operation.
    
    Returns:
    
    Result of the DeleteInterconnect operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteLag
```
public DeleteLagResult deleteLag(DeleteLagRequest request)
```
    Deletes a link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.
    
    Specified by:
    
    deleteLag in interface AmazonDirectConnect
    
    Parameters:
    
    deleteLagRequest - Container for the parameters to the DeleteLag operation.
    
    Returns:
    
    Result of the DeleteLag operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - deleteVirtualInterface
```
public DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest request)
```
    Deletes a virtual interface.
    
    Specified by:
    
    deleteVirtualInterface in interface AmazonDirectConnect
    
    Parameters:
    
    deleteVirtualInterfaceRequest - Container for the parameters to the DeleteVirtualInterface operation.
    
    Returns:
    
    Result of the DeleteVirtualInterface operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeConnectionLoa
```
@Deprecated
public DescribeConnectionLoaResult describeConnectionLoa(DescribeConnectionLoaRequest request)
```
    Deprecated.
    
    Deprecated in favor of DescribeLoa.
    
    Returns the LOA-CFA for a Connection.
    
    The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.
    
    Specified by:
    
    describeConnectionLoa in interface AmazonDirectConnect
    
    Parameters:
    
    describeConnectionLoaRequest - Container for the parameters to the DescribeConnectionLoa operation.
    
    Returns:
    
    Result of the DescribeConnectionLoa operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeConnections
```
public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
```
    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 parameters to the DescribeConnections operation.
    
    Returns:
    
    Result of the DescribeConnections operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeConnections
```
public DescribeConnectionsResult describeConnections()
```
    Description copied from interface: AmazonDirectConnect
    
    Simplified method form for invoking the DescribeConnections operation.
    
    Specified by:
    
    describeConnections in interface AmazonDirectConnect
    
    See Also:
    
    AmazonDirectConnect.describeConnections(DescribeConnectionsRequest)
  - describeConnectionsOnInterconnect
```
@Deprecated
public DescribeConnectionsOnInterconnectResult describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest request)
```
    Deprecated.
    
    Deprecated in favor of DescribeHostedConnections.
    
    Returns a list of connections that have been provisioned on the given interconnect.
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    describeConnectionsOnInterconnect in interface AmazonDirectConnect
    
    Parameters:
    
    describeConnectionsOnInterconnectRequest - Container for the parameters to the DescribeConnectionsOnInterconnect operation.
    
    Returns:
    
    Result of the DescribeConnectionsOnInterconnect operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeDirectConnectGatewayAssociations
```
public DescribeDirectConnectGatewayAssociationsResult describeDirectConnectGatewayAssociations(DescribeDirectConnectGatewayAssociationsRequest request)
```
    Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.
    
    Specified by:
    
    describeDirectConnectGatewayAssociations in interface AmazonDirectConnect
    
    Parameters:
    
    describeDirectConnectGatewayAssociationsRequest - Container for the parameters to the DescribeDirectConnectGatewayAssociations operation.
    
    Returns:
    
    Result of the DescribeDirectConnectGatewayAssociations operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeDirectConnectGatewayAttachments
```
public DescribeDirectConnectGatewayAttachmentsResult describeDirectConnectGatewayAttachments(DescribeDirectConnectGatewayAttachmentsRequest request)
```
    Returns a list of all direct connect gateway and virtual interface (VIF) attachments. Either a direct connect gateway ID or a VIF ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VIFs attached to the direct connect gateway. If a VIF ID is provided, the response returns all direct connect gateways attached to the VIF. If both are provided, the response only returns the attachment that matches both the direct connect gateway and the VIF.
    
    Specified by:
    
    describeDirectConnectGatewayAttachments in interface AmazonDirectConnect
    
    Parameters:
    
    describeDirectConnectGatewayAttachmentsRequest - Container for the parameters to the DescribeDirectConnectGatewayAttachments operation.
    
    Returns:
    
    Result of the DescribeDirectConnectGatewayAttachments operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeDirectConnectGateways
```
public DescribeDirectConnectGatewaysResult describeDirectConnectGateways(DescribeDirectConnectGatewaysRequest request)
```
    Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned.
    
    Specified by:
    
    describeDirectConnectGateways in interface AmazonDirectConnect
    
    Parameters:
    
    describeDirectConnectGatewaysRequest - Container for the parameters to the DescribeDirectConnectGateways operation.
    
    Returns:
    
    Result of the DescribeDirectConnectGateways operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeHostedConnections
```
public DescribeHostedConnectionsResult describeHostedConnections(DescribeHostedConnectionsRequest request)
```
    Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).
    
    This is intended for use by AWS Direct Connect partners only.
    
    Specified by:
    
    describeHostedConnections in interface AmazonDirectConnect
    
    Parameters:
    
    describeHostedConnectionsRequest - Container for the parameters to the DescribeHostedConnections operation.
    
    Returns:
    
    Result of the DescribeHostedConnections operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeInterconnectLoa
```
@Deprecated
public DescribeInterconnectLoaResult describeInterconnectLoa(DescribeInterconnectLoaRequest request)
```
    Deprecated.
    
    Deprecated in favor of DescribeLoa.
    
    Returns the LOA-CFA for an Interconnect.
    
    The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.
    
    Specified by:
    
    describeInterconnectLoa in interface AmazonDirectConnect
    
    Parameters:
    
    describeInterconnectLoaRequest - Container for the parameters to the DescribeInterconnectLoa operation.
    
    Returns:
    
    Result of the DescribeInterconnectLoa operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeInterconnects
```
public DescribeInterconnectsResult describeInterconnects(DescribeInterconnectsRequest request)
```
    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 parameters to the DescribeInterconnects operation.
    
    Returns:
    
    Result of the DescribeInterconnects operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeInterconnects
```
public DescribeInterconnectsResult describeInterconnects()
```
    Description copied from interface: AmazonDirectConnect
    
    Simplified method form for invoking the DescribeInterconnects operation.
    
    Specified by:
    
    describeInterconnects in interface AmazonDirectConnect
    
    See Also:
    
    AmazonDirectConnect.describeInterconnects(DescribeInterconnectsRequest)
  - describeLags
```
public DescribeLagsResult describeLags(DescribeLagsRequest request)
```
    Describes the link aggregation groups (LAGs) in your account.
    
    If a LAG ID is provided, only information about the specified LAG is returned.
    
    Specified by:
    
    describeLags in interface AmazonDirectConnect
    
    Parameters:
    
    describeLagsRequest - Container for the parameters to the DescribeLags operation.
    
    Returns:
    
    Result of the DescribeLags operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeLoa
```
public DescribeLoaResult describeLoa(DescribeLoaRequest request)
```
    Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
    
    The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.
    
    Specified by:
    
    describeLoa in interface AmazonDirectConnect
    
    Parameters:
    
    describeLoaRequest - Container for the parameters to the DescribeLoa operation.
    
    Returns:
    
    Result of the DescribeLoa operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeLocations
```
public DescribeLocationsResult describeLocations(DescribeLocationsRequest request)
```
    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 -
    
    Returns:
    
    Result of the DescribeLocations operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeLocations
```
public DescribeLocationsResult describeLocations()
```
    Description copied from interface: AmazonDirectConnect
    
    Simplified method form for invoking the DescribeLocations operation.
    
    Specified by:
    
    describeLocations in interface AmazonDirectConnect
    
    See Also:
    
    AmazonDirectConnect.describeLocations(DescribeLocationsRequest)
  - describeTags
```
public DescribeTagsResult describeTags(DescribeTagsRequest request)
```
    Describes the tags associated with the specified Direct Connect resources.
    
    Specified by:
    
    describeTags in interface AmazonDirectConnect
    
    Parameters:
    
    describeTagsRequest - Container for the parameters to the DescribeTags operation.
    
    Returns:
    
    Result of the DescribeTags operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeVirtualGateways
```
public DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest request)
```
    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 -
    
    Returns:
    
    Result of the DescribeVirtualGateways operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeVirtualGateways
```
public DescribeVirtualGatewaysResult describeVirtualGateways()
```
    Description copied from interface: AmazonDirectConnect
    
    Simplified method form for invoking the DescribeVirtualGateways operation.
    
    Specified by:
    
    describeVirtualGateways in interface AmazonDirectConnect
    
    See Also:
    
    AmazonDirectConnect.describeVirtualGateways(DescribeVirtualGatewaysRequest)
  - describeVirtualInterfaces
```
public DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest request)
```
    Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
    
    A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
    
    Specified by:
    
    describeVirtualInterfaces in interface AmazonDirectConnect
    
    Parameters:
    
    describeVirtualInterfacesRequest - Container for the parameters to the DescribeVirtualInterfaces operation.
    
    Returns:
    
    Result of the DescribeVirtualInterfaces operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - describeVirtualInterfaces
```
public DescribeVirtualInterfacesResult describeVirtualInterfaces()
```
    Description copied from interface: AmazonDirectConnect
    
    Simplified method form for invoking the DescribeVirtualInterfaces operation.
    
    Specified by:
    
    describeVirtualInterfaces in interface AmazonDirectConnect
    
    See Also:
    
    AmazonDirectConnect.describeVirtualInterfaces(DescribeVirtualInterfacesRequest)
  - disassociateConnectionFromLag
```
public DisassociateConnectionFromLagResult disassociateConnectionFromLag(DisassociateConnectionFromLagRequest request)
```
    Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect partner is automatically converted to an interconnect.
    
    If disassociating the connection will cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.
    
    Specified by:
    
    disassociateConnectionFromLag in interface AmazonDirectConnect
    
    Parameters:
    
    disassociateConnectionFromLagRequest - Container for the parameters to the DisassociateConnectionFromLag operation.
    
    Returns:
    
    Result of the DisassociateConnectionFromLag operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds the specified tags to the specified Direct Connect resource. Each Direct Connect resource can have a maximum of 50 tags.
    
    Each tag consists of a key and an optional value. If a tag with the same key is already associated with the Direct Connect resource, this action updates its value.
    
    Specified by:
    
    tagResource in interface AmazonDirectConnect
    
    Parameters:
    
    tagResourceRequest - Container for the parameters to the TagResource operation.
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    DuplicateTagKeysException - A tag key was specified more than once.
    
    TooManyTagsException - You have reached the limit on the number of tags that can be assigned to a Direct Connect resource.
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from the specified Direct Connect resource.
    
    Specified by:
    
    untagResource in interface AmazonDirectConnect
    
    Parameters:
    
    untagResourceRequest - Container for the parameters to the UntagResource operation.
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - updateLag
```
public UpdateLagResult updateLag(UpdateLagRequest request)
```
    Updates the attributes of a link aggregation group (LAG).
    
    You can update the following attributes:
    - The name of the LAG.
    - The value for the minimum number of connections that must be operational for the LAG itself to be operational.
    When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value, and the number of operational connections falls below the specified value, the LAG will automatically go down to avoid overutilization of the remaining connections. Adjusting this value should be done with care as it could force the LAG down if the value is set higher than the current number of operational connections.
    Specified by:
    
    updateLag in interface AmazonDirectConnect
    
    Parameters:
    
    updateLagRequest - Container for the parameters to the UpdateLag operation.
    
    Returns:
    
    Result of the UpdateLag operation returned by the service.
    
    Throws:
    
    DirectConnectServerException - A server-side error occurred during the API call. The error message will contain additional details about the cause.
    
    DirectConnectClientException - The API was called with invalid parameters. The error message will contain additional details about the cause.
    
    See Also:
    
    AWS API Documentation
  - 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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

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

AmazonDirectConnectClient

Method Detail

builder

allocateConnectionOnInterconnect

allocateHostedConnection

allocatePrivateVirtualInterface

allocatePublicVirtualInterface

associateConnectionWithLag

associateHostedConnection

associateVirtualInterface

confirmConnection

confirmPrivateVirtualInterface

confirmPublicVirtualInterface

createBGPPeer

createConnection

createDirectConnectGateway

createDirectConnectGatewayAssociation

createInterconnect

createLag

createPrivateVirtualInterface

createPublicVirtualInterface

deleteBGPPeer

deleteConnection

deleteDirectConnectGateway

deleteDirectConnectGatewayAssociation

deleteInterconnect

deleteLag

deleteVirtualInterface

describeConnectionLoa

describeConnections

describeConnections

describeConnectionsOnInterconnect

describeDirectConnectGatewayAssociations

describeDirectConnectGatewayAttachments

describeDirectConnectGateways

describeHostedConnections

describeInterconnectLoa

describeInterconnects

describeInterconnects

describeLags

describeLoa

describeLocations

describeLocations

describeTags

describeVirtualGateways

describeVirtualGateways

describeVirtualInterfaces

describeVirtualInterfaces

disassociateConnectionFromLag

tagResource

untagResource

updateLag

getCachedResponseMetadata