com.amazonaws.services.directconnect

Class AmazonDirectConnectClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.directconnect.AmazonDirectConnectClient

All Implemented Interfaces:

AmazonDirectConnect

Direct Known Subclasses:

AmazonDirectConnectAsyncClient

@ThreadSafe
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() Constructs a new client to invoke service methods on AWS Direct Connect.
AmazonDirectConnectClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS Direct Connect using the specified AWS account credentials.
AmazonDirectConnectClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Direct Connect using the specified AWS account credentials and client configuration options.
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS Direct Connect using the specified AWS account credentials provider.
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Direct Connect using the specified AWS account credentials provider and client configuration options.
AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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.
AmazonDirectConnectClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Direct Connect.

Method Summary

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.
DescribeConnectionLoaResult	describeConnectionLoa(DescribeConnectionLoaRequest describeConnectionLoaRequest) Returns the LOA-CFA for a Connection.
DescribeConnectionsResult	describeConnections() Simplified method form for invoking the DescribeConnections operation.
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.
DescribeInterconnectLoaResult	describeInterconnectLoa(DescribeInterconnectLoaRequest describeInterconnectLoaRequest) Returns the LOA-CFA for an Interconnect.
DescribeInterconnectsResult	describeInterconnects() Simplified method form for invoking the DescribeInterconnects operation.
DescribeInterconnectsResult	describeInterconnects(DescribeInterconnectsRequest describeInterconnectsRequest) Returns a list of interconnects owned by the AWS account.
DescribeLocationsResult	describeLocations() Simplified method form for invoking the DescribeLocations operation.
DescribeLocationsResult	describeLocations(DescribeLocationsRequest describeLocationsRequest) Returns the list of AWS Direct Connect locations in the current AWS region.
DescribeVirtualGatewaysResult	describeVirtualGateways() Simplified method form for invoking the DescribeVirtualGateways operation.
DescribeVirtualGatewaysResult	describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest) 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 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, 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

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonDirectConnectClient

public AmazonDirectConnectClient()

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

public AmazonDirectConnectClient(ClientConfiguration 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

public AmazonDirectConnectClient(AWSCredentials awsCredentials)

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

public AmazonDirectConnectClient(AWSCredentials awsCredentials,
                                 ClientConfiguration 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

public AmazonDirectConnectClient(AWSCredentialsProvider 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

public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
                                 ClientConfiguration 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

public AmazonDirectConnectClient(AWSCredentialsProvider awsCredentialsProvider,
                                 ClientConfiguration clientConfiguration,
                                 RequestMetricCollector 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

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.

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.

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 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.

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 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.

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 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.

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 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.

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 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.

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 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.

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.

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.

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 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.

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 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.

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 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.

deleteInterconnect

public DeleteInterconnectResult deleteInterconnect(DeleteInterconnectRequest deleteInterconnectRequest)

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.

deleteVirtualInterface

public DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)

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.

describeConnectionLoa

public DescribeConnectionLoaResult describeConnectionLoa(DescribeConnectionLoaRequest describeConnectionLoaRequest)

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.

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 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.

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

public DescribeConnectionsOnInterconnectResult describeConnectionsOnInterconnect(DescribeConnectionsOnInterconnectRequest describeConnectionsOnInterconnectRequest)

Return 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.

describeInterconnectLoa

public DescribeInterconnectLoaResult describeInterconnectLoa(DescribeInterconnectLoaRequest describeInterconnectLoaRequest)

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.

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 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.

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)

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 -

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.

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)

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 -

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.

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 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 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.

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)

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.