com.amazonaws.services.directconnect
Interface AmazonDirectConnect

All Known Subinterfaces:

AmazonDirectConnectAsync

All Known Implementing Classes:

AmazonDirectConnectAsyncClient, AmazonDirectConnectClient

public interface AmazonDirectConnect

Interface for accessing AmazonDirectConnect.

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

The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference :

• Actions : An alphabetical list of all AWS Direct Connect actions.
• Data Types : An alphabetical list of all AWS Direct Connect data types.
• Common Parameters : Parameters that all Query actions can use.
• Common Errors : Client and server errors that all actions can return.
• Regions and Endpoints : Itemized regions and endpoints for all AWS products.

Method Summary

CreateConnectionResult	createConnection(CreateConnectionRequest createConnectionRequest) Creates a new network connection between the customer network and a specific AWS Direct Connect location.
CreatePrivateVirtualInterfaceResult	createPrivateVirtualInterface() Creates a new private virtual interface.
CreatePrivateVirtualInterfaceResult	createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest) Creates a new private virtual interface.
CreatePublicVirtualInterfaceResult	createPublicVirtualInterface() Creates a new public virtual interface.
CreatePublicVirtualInterfaceResult	createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest) Creates a new public virtual interface.
DeleteConnectionResult	deleteConnection(DeleteConnectionRequest deleteConnectionRequest) Deletes the connection.
DeleteVirtualInterfaceResult	deleteVirtualInterface() Deletes a virtual interface.
DeleteVirtualInterfaceResult	deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest) Deletes a virtual interface.
DescribeConnectionDetailResult	describeConnectionDetail(DescribeConnectionDetailRequest describeConnectionDetailRequest) Displays details about a specific connection including the order steps for the connection and the current state of the connection order.
DescribeConnectionsResult	describeConnections() Displays all connections in this region.
DescribeConnectionsResult	describeConnections(DescribeConnectionsRequest describeConnectionsRequest) Displays all connections in this region.
DescribeOfferingDetailResult	describeOfferingDetail(DescribeOfferingDetailRequest describeOfferingDetailRequest) Displays additional ordering step details for a specified offering.
DescribeOfferingsResult	describeOfferings() Describes one or more of the offerings that are currently available for creating new connections.
DescribeOfferingsResult	describeOfferings(DescribeOfferingsRequest describeOfferingsRequest) Describes one or more of the offerings that are currently available for creating new connections.
DescribeVirtualGatewaysResult	describeVirtualGateways() Returns a list of virtual private gateways owned by the AWS account.
DescribeVirtualGatewaysResult	describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest) Returns a list of virtual private gateways owned by the AWS account.
DescribeVirtualInterfacesResult	describeVirtualInterfaces() Displays all virtual interfaces for an AWS account.
DescribeVirtualInterfacesResult	describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest) Displays all virtual interfaces for an AWS account.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("http://directConnect.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("http://directConnect.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "directConnect.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://directConnect.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "directConnect.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://directConnect.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

describeVirtualInterfaces

DescribeVirtualInterfacesResult describeVirtualInterfaces(DescribeVirtualInterfacesRequest describeVirtualInterfacesRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a virtual interface ID is included then only a single virtual interface will be returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.

Parameters:

describeVirtualInterfacesRequest - Container for the necessary parameters to execute the DescribeVirtualInterfaces service method on AmazonDirectConnect.

Returns:

The response from the DescribeVirtualInterfaces service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeVirtualGateways

DescribeVirtualGatewaysResult describeVirtualGateways(DescribeVirtualGatewaysRequest describeVirtualGatewaysRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Parameters:

describeVirtualGatewaysRequest - Container for the necessary parameters to execute the DescribeVirtualGateways service method on AmazonDirectConnect.

Returns:

The response from the DescribeVirtualGateways service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeConnectionDetail

DescribeConnectionDetailResult describeConnectionDetail(DescribeConnectionDetailRequest describeConnectionDetailRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Displays details about a specific connection including the order steps for the connection and the current state of the connection order.

Parameters:

describeConnectionDetailRequest - Container for the necessary parameters to execute the DescribeConnectionDetail service method on AmazonDirectConnect.

Returns:

The response from the DescribeConnectionDetail service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeOfferings

DescribeOfferingsResult describeOfferings(DescribeOfferingsRequest describeOfferingsRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Describes one or more of the offerings that are currently available for creating new connections. The results include offerings for all regions.

To order a new connection you need to select a specific offering ID.

Parameters:

describeOfferingsRequest - Container for the necessary parameters to execute the DescribeOfferings service method on AmazonDirectConnect.

Returns:

The response from the DescribeOfferings service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeConnections

DescribeConnectionsResult describeConnections(DescribeConnectionsRequest describeConnectionsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Displays all connections in this region.

If a connection ID is provided, it will only return this particular connection.

Parameters:

describeConnectionsRequest - Container for the necessary parameters to execute the DescribeConnections service method on AmazonDirectConnect.

Returns:

The response from the DescribeConnections service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeOfferingDetail

DescribeOfferingDetailResult describeOfferingDetail(DescribeOfferingDetailRequest describeOfferingDetailRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Displays additional ordering step details for a specified offering.

Parameters:

describeOfferingDetailRequest - Container for the necessary parameters to execute the DescribeOfferingDetail service method on AmazonDirectConnect.

Returns:

The response from the DescribeOfferingDetail service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

deleteConnection

DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port and data transfer charges. You separately need to cancel any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location with the providers of those services.

Parameters:

deleteConnectionRequest - Container for the necessary parameters to execute the DeleteConnection service method on AmazonDirectConnect.

Returns:

The response from the DeleteConnection service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

createConnection

CreateConnectionResult createConnection(CreateConnectionRequest createConnectionRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates a new network 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. A 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.

Parameters:

createConnectionRequest - Container for the necessary parameters to execute the CreateConnection service method on AmazonDirectConnect.

Returns:

The response from the CreateConnection service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

createPrivateVirtualInterface

CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface(CreatePrivateVirtualInterfaceRequest createPrivateVirtualInterfaceRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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

Parameters:

createPrivateVirtualInterfaceRequest - Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method on AmazonDirectConnect.

Returns:

The response from the CreatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

deleteVirtualInterface

DeleteVirtualInterfaceResult deleteVirtualInterface(DeleteVirtualInterfaceRequest deleteVirtualInterfaceRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Deletes a virtual interface.

Parameters:

deleteVirtualInterfaceRequest - Container for the necessary parameters to execute the DeleteVirtualInterface service method on AmazonDirectConnect.

Returns:

The response from the DeleteVirtualInterface service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

createPublicVirtualInterface

CreatePublicVirtualInterfaceResult createPublicVirtualInterface(CreatePublicVirtualInterfaceRequest createPublicVirtualInterfaceRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

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

Parameters:

createPublicVirtualInterfaceRequest - Container for the necessary parameters to execute the CreatePublicVirtualInterface service method on AmazonDirectConnect.

Returns:

The response from the CreatePublicVirtualInterface service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeVirtualInterfaces

DescribeVirtualInterfacesResult describeVirtualInterfaces()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a virtual interface ID is included then only a single virtual interface will be returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.

Returns:

The response from the DescribeVirtualInterfaces service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeVirtualGateways

DescribeVirtualGatewaysResult describeVirtualGateways()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Returns:

The response from the DescribeVirtualGateways service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeOfferings

DescribeOfferingsResult describeOfferings()
                                          throws AmazonServiceException,
                                                 AmazonClientException

Describes one or more of the offerings that are currently available for creating new connections. The results include offerings for all regions.

To order a new connection you need to select a specific offering ID.

Returns:

The response from the DescribeOfferings service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

describeConnections

DescribeConnectionsResult describeConnections()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Displays all connections in this region.

If a connection ID is provided, it will only return this particular connection.

Returns:

The response from the DescribeConnections service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

createPrivateVirtualInterface

CreatePrivateVirtualInterfaceResult createPrivateVirtualInterface()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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

Returns:

The response from the CreatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

deleteVirtualInterface

DeleteVirtualInterfaceResult deleteVirtualInterface()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Deletes a virtual interface.

Returns:

The response from the DeleteVirtualInterface service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

createPublicVirtualInterface

CreatePublicVirtualInterfaceResult createPublicVirtualInterface()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

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

Returns:

The response from the CreatePublicVirtualInterface service method, as returned by AmazonDirectConnect.

Throws:

DirectConnectServerException

DirectConnectClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonDirectConnect indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.