Interface InterconnectAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface InterconnectAsyncClient extends AwsClient
Service client for accessing Interconnect asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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

  • Field Details

  • Method Details

    • acceptConnectionProposal

      default CompletableFuture<AcceptConnectionProposalResponse> acceptConnectionProposal(AcceptConnectionProposalRequest acceptConnectionProposalRequest)

      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:
      A Java Future containing the result of the AcceptConnectionProposal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • acceptConnectionProposal

      default CompletableFuture<AcceptConnectionProposalResponse> acceptConnectionProposal(Consumer<AcceptConnectionProposalRequest.Builder> acceptConnectionProposalRequest)

      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:
      A Java Future containing the result of the AcceptConnectionProposal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnection

      default CompletableFuture<CreateConnectionResponse> createConnection(CreateConnectionRequest createConnectionRequest)

      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:
      A Java Future containing the result of the CreateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnection

      default CompletableFuture<CreateConnectionResponse> createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest)

      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:
      A Java Future containing the result of the CreateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnection

      default CompletableFuture<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest deleteConnectionRequest)

      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:
      A Java Future containing the result of the DeleteConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnection

      default CompletableFuture<DeleteConnectionResponse> deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)

      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:
      A Java Future containing the result of the DeleteConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectionProposal

      default CompletableFuture<DescribeConnectionProposalResponse> describeConnectionProposal(DescribeConnectionProposalRequest describeConnectionProposalRequest)

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

      Parameters:
      describeConnectionProposalRequest -
      Returns:
      A Java Future containing the result of the DescribeConnectionProposal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectionProposal

      default CompletableFuture<DescribeConnectionProposalResponse> describeConnectionProposal(Consumer<DescribeConnectionProposalRequest.Builder> describeConnectionProposalRequest)

      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:
      A Java Future containing the result of the DescribeConnectionProposal operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConnection

      default CompletableFuture<GetConnectionResponse> getConnection(GetConnectionRequest getConnectionRequest)

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

      Parameters:
      getConnectionRequest -
      Returns:
      A Java Future containing the result of the GetConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConnection

      default CompletableFuture<GetConnectionResponse> getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest)

      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:
      A Java Future containing the result of the GetConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEnvironment

      default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest)

      Describes a specific Environment

      Parameters:
      getEnvironmentRequest -
      Returns:
      A Java Future containing the result of the GetEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEnvironment

      default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)

      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:
      A Java Future containing the result of the GetEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachPoints

      default CompletableFuture<ListAttachPointsResponse> listAttachPoints(ListAttachPointsRequest listAttachPointsRequest)

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

      Parameters:
      listAttachPointsRequest -
      Returns:
      A Java Future containing the result of the ListAttachPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachPoints

      default CompletableFuture<ListAttachPointsResponse> listAttachPoints(Consumer<ListAttachPointsRequest.Builder> listAttachPointsRequest)

      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:
      A Java Future containing the result of the ListAttachPoints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachPointsPaginator

      default ListAttachPointsPublisher listAttachPointsPaginator(ListAttachPointsRequest listAttachPointsRequest)

      This is a variant of listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsPublisher publisher = client.listAttachPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsPublisher publisher = client.listAttachPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.interconnect.model.ListAttachPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.interconnect.model.ListAttachPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAttachPointsPaginator

      default ListAttachPointsPublisher listAttachPointsPaginator(Consumer<ListAttachPointsRequest.Builder> listAttachPointsRequest)

      This is a variant of listAttachPoints(software.amazon.awssdk.services.interconnect.model.ListAttachPointsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsPublisher publisher = client.listAttachPointsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.interconnect.paginators.ListAttachPointsPublisher publisher = client.listAttachPointsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.interconnect.model.ListAttachPointsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.interconnect.model.ListAttachPointsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnections

      default CompletableFuture<ListConnectionsResponse> listConnections(ListConnectionsRequest listConnectionsRequest)

      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:
      A Java Future containing the result of the ListConnections operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnections

      default CompletableFuture<ListConnectionsResponse> listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)

      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:
      A Java Future containing the result of the ListConnections operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectionsPaginator

      default ListConnectionsPublisher listConnectionsPaginator(ListConnectionsRequest listConnectionsRequest)

      This is a variant of listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.interconnect.model.ListConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.interconnect.model.ListConnectionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectionsPaginator

      default ListConnectionsPublisher listConnectionsPaginator(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)

      This is a variant of listConnections(software.amazon.awssdk.services.interconnect.model.ListConnectionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.interconnect.paginators.ListConnectionsPublisher publisher = client.listConnectionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.interconnect.model.ListConnectionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.interconnect.model.ListConnectionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironments

      default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)

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

      Parameters:
      listEnvironmentsRequest -
      Returns:
      A Java Future containing the result of the ListEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironments

      default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)

      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:
      A Java Future containing the result of the ListEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentsPaginator

      default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)

      This is a variant of listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.interconnect.model.ListEnvironmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEnvironmentsPaginator

      default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)

      This is a variant of listEnvironments(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.interconnect.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.interconnect.model.ListEnvironmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.interconnect.model.ListEnvironmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Add new tags to the specified resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from the specified resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnection

      default CompletableFuture<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest updateConnectionRequest)

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

      Parameters:
      updateConnectionRequest -
      Returns:
      A Java Future containing the result of the UpdateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnection

      default CompletableFuture<UpdateConnectionResponse> updateConnection(Consumer<UpdateConnectionRequest.Builder> updateConnectionRequest)

      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:
      A Java Future containing the result of the UpdateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The request specifies a resource that does not exist on the server.
      • InterconnectClientException The request was denied due to incorrect client supplied parameters.
      • ThrottlingException The request was denied due to request throttling.
      • AccessDeniedException The calling principal is not allowed to access the specified resource, or the resource does not exist.
      • InterconnectValidationException The input fails to satisfy the constraints specified.
      • ServiceQuotaExceededException The requested operation would result in the calling principal exceeding their allotted quota.
      • InterconnectServerException The request resulted in an exception internal to the service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • InterconnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default InterconnectAsyncWaiter waiter()
      Create an instance of InterconnectAsyncWaiter 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 InterconnectAsyncWaiter

    • 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

    • create

      static InterconnectAsyncClient create()
      Create a InterconnectAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static InterconnectAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a InterconnectAsyncClient.