Package software.amazon.awssdk.services.apigatewaymanagementapi

Interface ApiGatewayManagementApiAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ApiGatewayManagementApiAsyncClient extends AwsClient
Service client for accessing AmazonApiGatewayManagementApi asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
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.

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

  • Field Details

  • Method Details

    • deleteConnection

      default CompletableFuture<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest deleteConnectionRequest)

      Delete the connection with the provided id.

      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.
      • GoneException The connection with the provided id no longer exists.
      • LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
      • ForbiddenException The caller is not authorized to invoke this operation.
      • 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.
      • ApiGatewayManagementApiException 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)

      Delete the connection with the provided id.


      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.
      • GoneException The connection with the provided id no longer exists.
      • LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
      • ForbiddenException The caller is not authorized to invoke this operation.
      • 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.
      • ApiGatewayManagementApiException 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)

      Get information about the connection with the provided id.

      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.
      • GoneException The connection with the provided id no longer exists.
      • LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
      • ForbiddenException The caller is not authorized to invoke this operation.
      • 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.
      • ApiGatewayManagementApiException 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)

      Get information about the connection with the provided id.


      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.
      • GoneException The connection with the provided id no longer exists.
      • LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
      • ForbiddenException The caller is not authorized to invoke this operation.
      • 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.
      • ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • postToConnection

      default CompletableFuture<PostToConnectionResponse> postToConnection(PostToConnectionRequest postToConnectionRequest)

      Sends the provided data to the specified connection.

      Parameters:
      postToConnectionRequest -
      Returns:
      A Java Future containing the result of the PostToConnection 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.
      • GoneException The connection with the provided id no longer exists.
      • LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
      • PayloadTooLargeException The data has exceeded the maximum size allowed.
      • ForbiddenException The caller is not authorized to invoke this operation.
      • 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.
      • ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • postToConnection

      default CompletableFuture<PostToConnectionResponse> postToConnection(Consumer<PostToConnectionRequest.Builder> postToConnectionRequest)

      Sends the provided data to the specified connection.


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

      Parameters:
      postToConnectionRequest - A Consumer that will call methods on PostToConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PostToConnection 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.
      • GoneException The connection with the provided id no longer exists.
      • LimitExceededException The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
      • PayloadTooLargeException The data has exceeded the maximum size allowed.
      • ForbiddenException The caller is not authorized to invoke this operation.
      • 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.
      • ApiGatewayManagementApiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ApiGatewayManagementApiServiceClientConfiguration 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 ApiGatewayManagementApiAsyncClient create()
      Create a ApiGatewayManagementApiAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ApiGatewayManagementApiAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ApiGatewayManagementApiAsyncClient.