Interface InterconnectClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface InterconnectClient
extends AwsClient

Service client for accessing Interconnect. This can be created using the static builder() method.

Provides managed connections between your AWS network resources and select partner network resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AcceptConnectionProposalResponse	acceptConnectionProposal(Consumer<AcceptConnectionProposalRequest.Builder> acceptConnectionProposalRequest)	Accepts a connection proposal which was generated at a supported partner's portal.
default AcceptConnectionProposalResponse	acceptConnectionProposal(AcceptConnectionProposalRequest acceptConnectionProposalRequest)	Accepts a connection proposal which was generated at a supported partner's portal.
static InterconnectClientBuilder	builder()	Create a builder that can be used to configure and create a InterconnectClient.
static InterconnectClient	create()	Create a InterconnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateConnectionResponse	createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest)	Initiates the process to create a Connection across the specified Environment.
default CreateConnectionResponse	createConnection(CreateConnectionRequest createConnectionRequest)	Initiates the process to create a Connection across the specified Environment.
default DeleteConnectionResponse	deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)	Deletes an existing Connection with the supplied identifier.
default DeleteConnectionResponse	deleteConnection(DeleteConnectionRequest deleteConnectionRequest)	Deletes an existing Connection with the supplied identifier.
default DescribeConnectionProposalResponse	describeConnectionProposal(Consumer<DescribeConnectionProposalRequest.Builder> describeConnectionProposalRequest)	Describes the details of a connection proposal generated at a partner's portal.
default DescribeConnectionProposalResponse	describeConnectionProposal(DescribeConnectionProposalRequest describeConnectionProposalRequest)	Describes the details of a connection proposal generated at a partner's portal.
default GetConnectionResponse	getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest)	Describes the current state of a Connection resource as specified by the identifier.
default GetConnectionResponse	getConnection(GetConnectionRequest getConnectionRequest)	Describes the current state of a Connection resource as specified by the identifier.
default GetEnvironmentResponse	getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)	Describes a specific Environment
default GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest getEnvironmentRequest)	Describes a specific Environment
default ListAttachPointsResponse	listAttachPoints(Consumer<ListAttachPointsRequest.Builder> listAttachPointsRequest)	Lists all Attach Points the caller has access to that are valid for the specified Environment.
default ListAttachPointsResponse	listAttachPoints(ListAttachPointsRequest listAttachPointsRequest)	Lists all Attach Points the caller has access to that are valid for the specified Environment.
default ListAttachPointsIterable	listAttachPointsPaginator(Consumer<ListAttachPointsRequest.Builder> listAttachPointsRequest)	This is a variant of listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation.
default ListAttachPointsIterable	listAttachPointsPaginator(ListAttachPointsRequest listAttachPointsRequest)	This is a variant of listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation.
default ListConnectionsResponse	listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)	Lists all connection objects to which the caller has access.
default ListConnectionsResponse	listConnections(ListConnectionsRequest listConnectionsRequest)	Lists all connection objects to which the caller has access.
default ListConnectionsIterable	listConnectionsPaginator(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)	This is a variant of listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation.
default ListConnectionsIterable	listConnectionsPaginator(ListConnectionsRequest listConnectionsRequest)	This is a variant of listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation.
default ListEnvironmentsResponse	listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	Lists all of the environments that can produce connections that will land in the called AWS region.
default ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)	Lists all of the environments that can produce connections that will land in the called AWS region.
default ListEnvironmentsIterable	listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation.
default ListEnvironmentsIterable	listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)	This is a variant of listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	List all current tags on the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	List all current tags on the specified resource.
default InterconnectServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Add new tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Add new tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from the specified resource.
default UpdateConnectionResponse	updateConnection(Consumer<UpdateConnectionRequest.Builder> updateConnectionRequest)	Modifies an existing connection.
default UpdateConnectionResponse	updateConnection(UpdateConnectionRequest updateConnectionRequest)	Modifies an existing connection.
default InterconnectWaiter	waiter()	Create an instance of InterconnectWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

acceptConnectionProposal

default AcceptConnectionProposalResponse acceptConnectionProposal(AcceptConnectionProposalRequest acceptConnectionProposalRequest)
                                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Accepts a connection proposal which was generated at a supported partner's portal.

The proposal contains the Environment and bandwidth that were chosen on the partner's portal and cannot be modified.

Upon accepting the proposal a connection will be made between the AWS network as accessed via the selected Attach Point and the network previously selected network on the partner's portal.

Parameters:

acceptConnectionProposalRequest -

Returns:

Result of the AcceptConnectionProposal operation returned by the service.

See Also:

• AWS API Documentation

acceptConnectionProposal

default AcceptConnectionProposalResponse acceptConnectionProposal(Consumer<AcceptConnectionProposalRequest.Builder> acceptConnectionProposalRequest)
                                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Accepts a connection proposal which was generated at a supported partner's portal.

The proposal contains the Environment and bandwidth that were chosen on the partner's portal and cannot be modified.

Upon accepting the proposal a connection will be made between the AWS network as accessed via the selected Attach Point and the network previously selected network on the partner's portal.

This is a convenience which creates an instance of the AcceptConnectionProposalRequest.Builder avoiding the need to create one manually via AcceptConnectionProposalRequest.builder()

Parameters:

acceptConnectionProposalRequest - A Consumer that will call methods on AcceptConnectionProposalRequest.Builder to create a request.

Returns:

Result of the AcceptConnectionProposal operation returned by the service.

See Also:

• AWS API Documentation

createConnection

default CreateConnectionResponse createConnection(CreateConnectionRequest createConnectionRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Initiates the process to create a Connection across the specified Environment.

The Environment dictates the specified partner and location to which the other end of the connection should attach. You can see a list of the available Environments by calling ListEnvironments

The Attach Point specifies where within the AWS Network your connection will logically connect.

After a successful call to this method, the resulting Connection will return an Activation Key which will need to be brought to the specific partner's portal to confirm the Connection on both sides. (See Environmentinvalid input: '&#36'activationPageUrl for a direct link to the partner portal).

Parameters:

createConnectionRequest -

Returns:

Result of the CreateConnection operation returned by the service.

See Also:

• AWS API Documentation

createConnection

default CreateConnectionResponse createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Initiates the process to create a Connection across the specified Environment.

The Environment dictates the specified partner and location to which the other end of the connection should attach. You can see a list of the available Environments by calling ListEnvironments

The Attach Point specifies where within the AWS Network your connection will logically connect.

After a successful call to this method, the resulting Connection will return an Activation Key which will need to be brought to the specific partner's portal to confirm the Connection on both sides. (See Environmentinvalid input: '&#36'activationPageUrl for a direct link to the partner portal).

This is a convenience which creates an instance of the CreateConnectionRequest.Builder avoiding the need to create one manually via CreateConnectionRequest.builder()

Parameters:

createConnectionRequest - A Consumer that will call methods on CreateConnectionRequest.Builder to create a request.

Returns:

Result of the CreateConnection operation returned by the service.

See Also:

• AWS API Documentation

deleteConnection

default DeleteConnectionResponse deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Deletes an existing Connection with the supplied identifier.

This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the Connection will cease to exist.

Parameters:

deleteConnectionRequest -

Returns:

Result of the DeleteConnection operation returned by the service.

See Also:

• AWS API Documentation

deleteConnection

default DeleteConnectionResponse deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Deletes an existing Connection with the supplied identifier.

This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the Connection will cease to exist.

This is a convenience which creates an instance of the DeleteConnectionRequest.Builder avoiding the need to create one manually via DeleteConnectionRequest.builder()

Parameters:

deleteConnectionRequest - A Consumer that will call methods on DeleteConnectionRequest.Builder to create a request.

Returns:

Result of the DeleteConnection operation returned by the service.

See Also:

• AWS API Documentation

describeConnectionProposal

default DescribeConnectionProposalResponse describeConnectionProposal(DescribeConnectionProposalRequest describeConnectionProposalRequest)
                                                               throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Describes the details of a connection proposal generated at a partner's portal.

Parameters:

describeConnectionProposalRequest -

Returns:

Result of the DescribeConnectionProposal operation returned by the service.

See Also:

• AWS API Documentation

describeConnectionProposal

default DescribeConnectionProposalResponse describeConnectionProposal(Consumer<DescribeConnectionProposalRequest.Builder> describeConnectionProposalRequest)
                                                               throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Describes the details of a connection proposal generated at a partner's portal.

This is a convenience which creates an instance of the DescribeConnectionProposalRequest.Builder avoiding the need to create one manually via DescribeConnectionProposalRequest.builder()

Parameters:

describeConnectionProposalRequest - A Consumer that will call methods on DescribeConnectionProposalRequest.Builder to create a request.

Returns:

Result of the DescribeConnectionProposal operation returned by the service.

See Also:

• AWS API Documentation

getConnection

default GetConnectionResponse getConnection(GetConnectionRequest getConnectionRequest)
                                     throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Describes the current state of a Connection resource as specified by the identifier.

Parameters:

getConnectionRequest -

Returns:

Result of the GetConnection operation returned by the service.

See Also:

• AWS API Documentation

getConnection

default GetConnectionResponse getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest)
                                     throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Describes the current state of a Connection resource as specified by the identifier.

This is a convenience which creates an instance of the GetConnectionRequest.Builder avoiding the need to create one manually via GetConnectionRequest.builder()

Parameters:

getConnectionRequest - A Consumer that will call methods on GetConnectionRequest.Builder to create a request.

Returns:

Result of the GetConnection operation returned by the service.

See Also:

• AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
                                       throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Describes a specific Environment

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

• AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
                                       throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Describes a specific Environment

This is a convenience which creates an instance of the GetEnvironmentRequest.Builder avoiding the need to create one manually via GetEnvironmentRequest.builder()

Parameters:

getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentRequest.Builder to create a request.

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

• AWS API Documentation

listAttachPoints

default ListAttachPointsResponse listAttachPoints(ListAttachPointsRequest listAttachPointsRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Lists all Attach Points the caller has access to that are valid for the specified Environment.

Parameters:

listAttachPointsRequest -

Returns:

Result of the ListAttachPoints operation returned by the service.

See Also:

• AWS API Documentation

listAttachPoints

default ListAttachPointsResponse listAttachPoints(Consumer<ListAttachPointsRequest.Builder> listAttachPointsRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Lists all Attach Points the caller has access to that are valid for the specified Environment.

This is a convenience which creates an instance of the ListAttachPointsRequest.Builder avoiding the need to create one manually via ListAttachPointsRequest.builder()

Parameters:

listAttachPointsRequest - A Consumer that will call methods on ListAttachPointsRequest.Builder to create a request.

Returns:

Result of the ListAttachPoints operation returned by the service.

See Also:

• AWS API Documentation

listAttachPointsPaginator

default ListAttachPointsIterable listAttachPointsPaginator(ListAttachPointsRequest listAttachPointsRequest)
                                                    throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

This is a variant of listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsIterable responses = client.listAttachPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsIterable responses = client
             .listAttachPointsPaginator(request);
     for (software.amazon.awssdk.services.interconnect.model.ListAttachPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsIterable responses = client.listAttachPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation.

Parameters:

listAttachPointsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAttachPointsPaginator

default ListAttachPointsIterable listAttachPointsPaginator(Consumer<ListAttachPointsRequest.Builder> listAttachPointsRequest)
                                                    throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

This is a variant of listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsIterable responses = client.listAttachPointsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsIterable responses = client
             .listAttachPointsPaginator(request);
     for (software.amazon.awssdk.services.interconnect.model.ListAttachPointsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsIterable responses = client.listAttachPointsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation.

This is a convenience which creates an instance of the ListAttachPointsRequest.Builder avoiding the need to create one manually via ListAttachPointsRequest.builder()

Parameters:

listAttachPointsRequest - A Consumer that will call methods on ListAttachPointsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listConnections

default ListConnectionsResponse listConnections(ListConnectionsRequest listConnectionsRequest)
                                         throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Lists all connection objects to which the caller has access.

Allows for optional filtering by the following properties:

• state

• environmentId

• provider

• attach point

Only Connection objects matching all filters will be returned.

Parameters:

listConnectionsRequest -

Returns:

Result of the ListConnections operation returned by the service.

See Also:

• AWS API Documentation

listConnections

default ListConnectionsResponse listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)
                                         throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Lists all connection objects to which the caller has access.

Allows for optional filtering by the following properties:

• state

• environmentId

• provider

• attach point

Only Connection objects matching all filters will be returned.

This is a convenience which creates an instance of the ListConnectionsRequest.Builder avoiding the need to create one manually via ListConnectionsRequest.builder()

Parameters:

listConnectionsRequest - A Consumer that will call methods on ListConnectionsRequest.Builder to create a request.

Returns:

Result of the ListConnections operation returned by the service.

See Also:

• AWS API Documentation

listConnectionsPaginator

default ListConnectionsIterable listConnectionsPaginator(ListConnectionsRequest listConnectionsRequest)
                                                  throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

This is a variant of listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.interconnect.paginators.ListConnectionsIterable responses = client
             .listConnectionsPaginator(request);
     for (software.amazon.awssdk.services.interconnect.model.ListConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation.

Parameters:

listConnectionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listConnectionsPaginator

default ListConnectionsIterable listConnectionsPaginator(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)
                                                  throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

This is a variant of listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.interconnect.paginators.ListConnectionsIterable responses = client
             .listConnectionsPaginator(request);
     for (software.amazon.awssdk.services.interconnect.model.ListConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsIterable responses = client.listConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation.

This is a convenience which creates an instance of the ListConnectionsRequest.Builder avoiding the need to create one manually via ListConnectionsRequest.builder()

Parameters:

listConnectionsRequest - A Consumer that will call methods on ListConnectionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Lists all of the environments that can produce connections that will land in the called AWS region.

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Lists all of the environments that can produce connections that will land in the called AWS region.

This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need to create one manually via ListEnvironmentsRequest.builder()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
                                                    throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

This is a variant of listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsIterable responses = client
             .listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.interconnect.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation.

Parameters:

listEnvironmentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                                    throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

This is a variant of listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsIterable responses = client
             .listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.interconnect.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation.

This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need to create one manually via ListEnvironmentsRequest.builder()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

List all current tags on the specified resource. Currently this supports Connection resources.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

List all current tags on the specified resource. Currently this supports Connection resources.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Add new tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Add new tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Removes tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Removes tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateConnection

default UpdateConnectionResponse updateConnection(UpdateConnectionRequest updateConnectionRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.

Parameters:

updateConnectionRequest -

Returns:

Result of the UpdateConnection operation returned by the service.

See Also:

• AWS API Documentation

updateConnection

default UpdateConnectionResponse updateConnection(Consumer<UpdateConnectionRequest.Builder> updateConnectionRequest)
                                           throws ResourceNotFoundException,
InterconnectClientException,
ThrottlingException,
AccessDeniedException,
InterconnectValidationException,
ServiceQuotaExceededException,
InterconnectServerException,
AwsServiceException,
SdkClientException,
InterconnectException

Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.

This is a convenience which creates an instance of the UpdateConnectionRequest.Builder avoiding the need to create one manually via UpdateConnectionRequest.builder()

Parameters:

updateConnectionRequest - A Consumer that will call methods on UpdateConnectionRequest.Builder to create a request.

Returns:

Result of the UpdateConnection operation returned by the service.

See Also:

• AWS API Documentation

waiter

default InterconnectWaiter waiter()

Create an instance of InterconnectWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of InterconnectWaiter

create

static InterconnectClient create()

Create a InterconnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static InterconnectClientBuilder builder()

Create a builder that can be used to configure and create a InterconnectClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default InterconnectServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration