Interface ApiGatewayAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ApiGatewayAsyncClient extends AwsClient
Service client for accessing Amazon API Gateway 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. Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

  • Field Details

  • Method Details

    • createApiKey

      default CompletableFuture<CreateApiKeyResponse> createApiKey(CreateApiKeyRequest createApiKeyRequest)

      Create an ApiKey resource.

      Parameters:
      createApiKeyRequest - Request to create an ApiKey resource.
      Returns:
      A Java Future containing the result of the CreateApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createApiKey

      default CompletableFuture<CreateApiKeyResponse> createApiKey(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest)

      Create an ApiKey resource.


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

      Parameters:
      createApiKeyRequest - A Consumer that will call methods on CreateApiKeyRequest.Builder to create a request. Request to create an ApiKey resource.
      Returns:
      A Java Future containing the result of the CreateApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createApiKey

      default CompletableFuture<CreateApiKeyResponse> createApiKey()

      Create an ApiKey resource.

      Returns:
      A Java Future containing the result of the CreateApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createAuthorizer

      default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)

      Adds a new Authorizer resource to an existing RestApi resource.

      Parameters:
      createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.
      Returns:
      A Java Future containing the result of the CreateAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createAuthorizer

      default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)

      Adds a new Authorizer resource to an existing RestApi resource.


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

      Parameters:
      createAuthorizerRequest - A Consumer that will call methods on CreateAuthorizerRequest.Builder to create a request. Request to add a new Authorizer to an existing RestApi resource.
      Returns:
      A Java Future containing the result of the CreateAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createBasePathMapping

      default CompletableFuture<CreateBasePathMappingResponse> createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)

      Creates a new BasePathMapping resource.

      Parameters:
      createBasePathMappingRequest - Requests API Gateway to create a new BasePathMapping resource.
      Returns:
      A Java Future containing the result of the CreateBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createBasePathMapping

      default CompletableFuture<CreateBasePathMappingResponse> createBasePathMapping(Consumer<CreateBasePathMappingRequest.Builder> createBasePathMappingRequest)

      Creates a new BasePathMapping resource.


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

      Parameters:
      createBasePathMappingRequest - A Consumer that will call methods on CreateBasePathMappingRequest.Builder to create a request. Requests API Gateway to create a new BasePathMapping resource.
      Returns:
      A Java Future containing the result of the CreateBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDeployment

      default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest)

      Creates a Deployment resource, which makes a specified RestApi callable over the internet.

      Parameters:
      createDeploymentRequest - Requests API Gateway to create a Deployment resource.
      Returns:
      A Java Future containing the result of the CreateDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDeployment

      default CompletableFuture<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)

      Creates a Deployment resource, which makes a specified RestApi callable over the internet.


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

      Parameters:
      createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request. Requests API Gateway to create a Deployment resource.
      Returns:
      A Java Future containing the result of the CreateDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDocumentationPart

      default CompletableFuture<CreateDocumentationPartResponse> createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)

      Creates a documentation part.

      Parameters:
      createDocumentationPartRequest - Creates a new documentation part of a given API.
      Returns:
      A Java Future containing the result of the CreateDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDocumentationPart

      default CompletableFuture<CreateDocumentationPartResponse> createDocumentationPart(Consumer<CreateDocumentationPartRequest.Builder> createDocumentationPartRequest)

      Creates a documentation part.


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

      Parameters:
      createDocumentationPartRequest - A Consumer that will call methods on CreateDocumentationPartRequest.Builder to create a request. Creates a new documentation part of a given API.
      Returns:
      A Java Future containing the result of the CreateDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDocumentationVersion

      default CompletableFuture<CreateDocumentationVersionResponse> createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)

      Creates a documentation version

      Parameters:
      createDocumentationVersionRequest - Creates a new documentation version of a given API.
      Returns:
      A Java Future containing the result of the CreateDocumentationVersion 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDocumentationVersion

      default CompletableFuture<CreateDocumentationVersionResponse> createDocumentationVersion(Consumer<CreateDocumentationVersionRequest.Builder> createDocumentationVersionRequest)

      Creates a documentation version


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

      Parameters:
      createDocumentationVersionRequest - A Consumer that will call methods on CreateDocumentationVersionRequest.Builder to create a request. Creates a new documentation version of a given API.
      Returns:
      A Java Future containing the result of the CreateDocumentationVersion 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDomainName

      default CompletableFuture<CreateDomainNameResponse> createDomainName(CreateDomainNameRequest createDomainNameRequest)

      Creates a new domain name.

      Parameters:
      createDomainNameRequest - A request to create a new domain name.
      Returns:
      A Java Future containing the result of the CreateDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createDomainName

      default CompletableFuture<CreateDomainNameResponse> createDomainName(Consumer<CreateDomainNameRequest.Builder> createDomainNameRequest)

      Creates a new domain name.


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

      Parameters:
      createDomainNameRequest - A Consumer that will call methods on CreateDomainNameRequest.Builder to create a request. A request to create a new domain name.
      Returns:
      A Java Future containing the result of the CreateDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createModel

      default CompletableFuture<CreateModelResponse> createModel(CreateModelRequest createModelRequest)

      Adds a new Model resource to an existing RestApi resource.

      Parameters:
      createModelRequest - Request to add a new Model to an existing RestApi resource.
      Returns:
      A Java Future containing the result of the CreateModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createModel

      default CompletableFuture<CreateModelResponse> createModel(Consumer<CreateModelRequest.Builder> createModelRequest)

      Adds a new Model resource to an existing RestApi resource.


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

      Parameters:
      createModelRequest - A Consumer that will call methods on CreateModelRequest.Builder to create a request. Request to add a new Model to an existing RestApi resource.
      Returns:
      A Java Future containing the result of the CreateModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createRequestValidator

      default CompletableFuture<CreateRequestValidatorResponse> createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)

      Creates a RequestValidator of a given RestApi.

      Parameters:
      createRequestValidatorRequest - Creates a RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the CreateRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createRequestValidator

      default CompletableFuture<CreateRequestValidatorResponse> createRequestValidator(Consumer<CreateRequestValidatorRequest.Builder> createRequestValidatorRequest)

      Creates a RequestValidator of a given RestApi.


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

      Parameters:
      createRequestValidatorRequest - A Consumer that will call methods on CreateRequestValidatorRequest.Builder to create a request. Creates a RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the CreateRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createResource

      default CompletableFuture<CreateResourceResponse> createResource(CreateResourceRequest createResourceRequest)

      Creates a Resource resource.

      Parameters:
      createResourceRequest - Requests API Gateway to create a Resource resource.
      Returns:
      A Java Future containing the result of the CreateResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createResource

      default CompletableFuture<CreateResourceResponse> createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)

      Creates a Resource resource.


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

      Parameters:
      createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request. Requests API Gateway to create a Resource resource.
      Returns:
      A Java Future containing the result of the CreateResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createRestApi

      default CompletableFuture<CreateRestApiResponse> createRestApi(CreateRestApiRequest createRestApiRequest)

      Creates a new RestApi resource.

      Parameters:
      createRestApiRequest - The POST Request to add a new RestApi resource to your collection.
      Returns:
      A Java Future containing the result of the CreateRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createRestApi

      default CompletableFuture<CreateRestApiResponse> createRestApi(Consumer<CreateRestApiRequest.Builder> createRestApiRequest)

      Creates a new RestApi resource.


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

      Parameters:
      createRestApiRequest - A Consumer that will call methods on CreateRestApiRequest.Builder to create a request. The POST Request to add a new RestApi resource to your collection.
      Returns:
      A Java Future containing the result of the CreateRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createStage

      default CompletableFuture<CreateStageResponse> createStage(CreateStageRequest createStageRequest)

      Creates a new Stage resource that references a pre-existing Deployment for the API.

      Parameters:
      createStageRequest - Requests API Gateway to create a Stage resource.
      Returns:
      A Java Future containing the result of the CreateStage 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createStage

      default CompletableFuture<CreateStageResponse> createStage(Consumer<CreateStageRequest.Builder> createStageRequest)

      Creates a new Stage resource that references a pre-existing Deployment for the API.


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

      Parameters:
      createStageRequest - A Consumer that will call methods on CreateStageRequest.Builder to create a request. Requests API Gateway to create a Stage resource.
      Returns:
      A Java Future containing the result of the CreateStage 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createUsagePlan

      default CompletableFuture<CreateUsagePlanResponse> createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)

      Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

      Parameters:
      createUsagePlanRequest - The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
      Returns:
      A Java Future containing the result of the CreateUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createUsagePlan

      default CompletableFuture<CreateUsagePlanResponse> createUsagePlan(Consumer<CreateUsagePlanRequest.Builder> createUsagePlanRequest)

      Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.


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

      Parameters:
      createUsagePlanRequest - A Consumer that will call methods on CreateUsagePlanRequest.Builder to create a request. The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
      Returns:
      A Java Future containing the result of the CreateUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createUsagePlanKey

      default CompletableFuture<CreateUsagePlanKeyResponse> createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)

      Creates a usage plan key for adding an existing API key to a usage plan.

      Parameters:
      createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.
      Returns:
      A Java Future containing the result of the CreateUsagePlanKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createUsagePlanKey

      default CompletableFuture<CreateUsagePlanKeyResponse> createUsagePlanKey(Consumer<CreateUsagePlanKeyRequest.Builder> createUsagePlanKeyRequest)

      Creates a usage plan key for adding an existing API key to a usage plan.


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

      Parameters:
      createUsagePlanKeyRequest - A Consumer that will call methods on CreateUsagePlanKeyRequest.Builder to create a request. The POST request to create a usage plan key for adding an existing API key to a usage plan.
      Returns:
      A Java Future containing the result of the CreateUsagePlanKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createVpcLink

      default CompletableFuture<CreateVpcLinkResponse> createVpcLink(CreateVpcLinkRequest createVpcLinkRequest)

      Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

      Parameters:
      createVpcLinkRequest - Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
      Returns:
      A Java Future containing the result of the CreateVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • createVpcLink

      default CompletableFuture<CreateVpcLinkResponse> createVpcLink(Consumer<CreateVpcLinkRequest.Builder> createVpcLinkRequest)

      Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.


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

      Parameters:
      createVpcLinkRequest - A Consumer that will call methods on CreateVpcLinkRequest.Builder to create a request. Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
      Returns:
      A Java Future containing the result of the CreateVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteApiKey

      default CompletableFuture<DeleteApiKeyResponse> deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)

      Deletes the ApiKey resource.

      Parameters:
      deleteApiKeyRequest - A request to delete the ApiKey resource.
      Returns:
      A Java Future containing the result of the DeleteApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteApiKey

      default CompletableFuture<DeleteApiKeyResponse> deleteApiKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest)

      Deletes the ApiKey resource.


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

      Parameters:
      deleteApiKeyRequest - A Consumer that will call methods on DeleteApiKeyRequest.Builder to create a request. A request to delete the ApiKey resource.
      Returns:
      A Java Future containing the result of the DeleteApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteAuthorizer

      default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)

      Deletes an existing Authorizer resource.

      Parameters:
      deleteAuthorizerRequest - Request to delete an existing Authorizer resource.
      Returns:
      A Java Future containing the result of the DeleteAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteAuthorizer

      default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)

      Deletes an existing Authorizer resource.


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

      Parameters:
      deleteAuthorizerRequest - A Consumer that will call methods on DeleteAuthorizerRequest.Builder to create a request. Request to delete an existing Authorizer resource.
      Returns:
      A Java Future containing the result of the DeleteAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteBasePathMapping

      default CompletableFuture<DeleteBasePathMappingResponse> deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)

      Deletes the BasePathMapping resource.

      Parameters:
      deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.
      Returns:
      A Java Future containing the result of the DeleteBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteBasePathMapping

      default CompletableFuture<DeleteBasePathMappingResponse> deleteBasePathMapping(Consumer<DeleteBasePathMappingRequest.Builder> deleteBasePathMappingRequest)

      Deletes the BasePathMapping resource.


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

      Parameters:
      deleteBasePathMappingRequest - A Consumer that will call methods on DeleteBasePathMappingRequest.Builder to create a request. A request to delete the BasePathMapping resource.
      Returns:
      A Java Future containing the result of the DeleteBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteClientCertificate

      default CompletableFuture<DeleteClientCertificateResponse> deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)

      Deletes the ClientCertificate resource.

      Parameters:
      deleteClientCertificateRequest - A request to delete the ClientCertificate resource.
      Returns:
      A Java Future containing the result of the DeleteClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteClientCertificate

      default CompletableFuture<DeleteClientCertificateResponse> deleteClientCertificate(Consumer<DeleteClientCertificateRequest.Builder> deleteClientCertificateRequest)

      Deletes the ClientCertificate resource.


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

      Parameters:
      deleteClientCertificateRequest - A Consumer that will call methods on DeleteClientCertificateRequest.Builder to create a request. A request to delete the ClientCertificate resource.
      Returns:
      A Java Future containing the result of the DeleteClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDeployment

      default CompletableFuture<DeleteDeploymentResponse> deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)

      Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

      Parameters:
      deleteDeploymentRequest - Requests API Gateway to delete a Deployment resource.
      Returns:
      A Java Future containing the result of the DeleteDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDeployment

      default CompletableFuture<DeleteDeploymentResponse> deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest)

      Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.


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

      Parameters:
      deleteDeploymentRequest - A Consumer that will call methods on DeleteDeploymentRequest.Builder to create a request. Requests API Gateway to delete a Deployment resource.
      Returns:
      A Java Future containing the result of the DeleteDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDocumentationPart

      default CompletableFuture<DeleteDocumentationPartResponse> deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)

      Deletes a documentation part

      Parameters:
      deleteDocumentationPartRequest - Deletes an existing documentation part of an API.
      Returns:
      A Java Future containing the result of the DeleteDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDocumentationPart

      default CompletableFuture<DeleteDocumentationPartResponse> deleteDocumentationPart(Consumer<DeleteDocumentationPartRequest.Builder> deleteDocumentationPartRequest)

      Deletes a documentation part


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

      Parameters:
      deleteDocumentationPartRequest - A Consumer that will call methods on DeleteDocumentationPartRequest.Builder to create a request. Deletes an existing documentation part of an API.
      Returns:
      A Java Future containing the result of the DeleteDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDocumentationVersion

      default CompletableFuture<DeleteDocumentationVersionResponse> deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)

      Deletes a documentation version.

      Parameters:
      deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.
      Returns:
      A Java Future containing the result of the DeleteDocumentationVersion 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDocumentationVersion

      default CompletableFuture<DeleteDocumentationVersionResponse> deleteDocumentationVersion(Consumer<DeleteDocumentationVersionRequest.Builder> deleteDocumentationVersionRequest)

      Deletes a documentation version.


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

      Parameters:
      deleteDocumentationVersionRequest - A Consumer that will call methods on DeleteDocumentationVersionRequest.Builder to create a request. Deletes an existing documentation version of an API.
      Returns:
      A Java Future containing the result of the DeleteDocumentationVersion 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDomainName

      default CompletableFuture<DeleteDomainNameResponse> deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)

      Deletes the DomainName resource.

      Parameters:
      deleteDomainNameRequest - A request to delete the DomainName resource.
      Returns:
      A Java Future containing the result of the DeleteDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteDomainName

      default CompletableFuture<DeleteDomainNameResponse> deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest)

      Deletes the DomainName resource.


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

      Parameters:
      deleteDomainNameRequest - A Consumer that will call methods on DeleteDomainNameRequest.Builder to create a request. A request to delete the DomainName resource.
      Returns:
      A Java Future containing the result of the DeleteDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteGatewayResponse

      default CompletableFuture<DeleteGatewayResponseResponse> deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)

      Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

      Parameters:
      deleteGatewayResponseRequest - Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
      Returns:
      A Java Future containing the result of the DeleteGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteGatewayResponse

      default CompletableFuture<DeleteGatewayResponseResponse> deleteGatewayResponse(Consumer<DeleteGatewayResponseRequest.Builder> deleteGatewayResponseRequest)

      Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.


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

      Parameters:
      deleteGatewayResponseRequest - A Consumer that will call methods on DeleteGatewayResponseRequest.Builder to create a request. Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
      Returns:
      A Java Future containing the result of the DeleteGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteIntegration

      default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)

      Represents a delete integration.

      Parameters:
      deleteIntegrationRequest - Represents a delete integration request.
      Returns:
      A Java Future containing the result of the DeleteIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteIntegration

      default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)

      Represents a delete integration.


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

      Parameters:
      deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request. Represents a delete integration request.
      Returns:
      A Java Future containing the result of the DeleteIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteIntegrationResponse

      default CompletableFuture<DeleteIntegrationResponseResponse> deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)

      Represents a delete integration response.

      Parameters:
      deleteIntegrationResponseRequest - Represents a delete integration response request.
      Returns:
      A Java Future containing the result of the DeleteIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteIntegrationResponse

      default CompletableFuture<DeleteIntegrationResponseResponse> deleteIntegrationResponse(Consumer<DeleteIntegrationResponseRequest.Builder> deleteIntegrationResponseRequest)

      Represents a delete integration response.


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

      Parameters:
      deleteIntegrationResponseRequest - A Consumer that will call methods on DeleteIntegrationResponseRequest.Builder to create a request. Represents a delete integration response request.
      Returns:
      A Java Future containing the result of the DeleteIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteMethod

      default CompletableFuture<DeleteMethodResponse> deleteMethod(DeleteMethodRequest deleteMethodRequest)

      Deletes an existing Method resource.

      Parameters:
      deleteMethodRequest - Request to delete an existing Method resource.
      Returns:
      A Java Future containing the result of the DeleteMethod 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteMethod

      default CompletableFuture<DeleteMethodResponse> deleteMethod(Consumer<DeleteMethodRequest.Builder> deleteMethodRequest)

      Deletes an existing Method resource.


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

      Parameters:
      deleteMethodRequest - A Consumer that will call methods on DeleteMethodRequest.Builder to create a request. Request to delete an existing Method resource.
      Returns:
      A Java Future containing the result of the DeleteMethod 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteMethodResponse

      default CompletableFuture<DeleteMethodResponseResponse> deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)

      Deletes an existing MethodResponse resource.

      Parameters:
      deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.
      Returns:
      A Java Future containing the result of the DeleteMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteMethodResponse

      default CompletableFuture<DeleteMethodResponseResponse> deleteMethodResponse(Consumer<DeleteMethodResponseRequest.Builder> deleteMethodResponseRequest)

      Deletes an existing MethodResponse resource.


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

      Parameters:
      deleteMethodResponseRequest - A Consumer that will call methods on DeleteMethodResponseRequest.Builder to create a request. A request to delete an existing MethodResponse resource.
      Returns:
      A Java Future containing the result of the DeleteMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteModel

      default CompletableFuture<DeleteModelResponse> deleteModel(DeleteModelRequest deleteModelRequest)

      Deletes a model.

      Parameters:
      deleteModelRequest - Request to delete an existing model in an existing RestApi resource.
      Returns:
      A Java Future containing the result of the DeleteModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteModel

      default CompletableFuture<DeleteModelResponse> deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)

      Deletes a model.


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

      Parameters:
      deleteModelRequest - A Consumer that will call methods on DeleteModelRequest.Builder to create a request. Request to delete an existing model in an existing RestApi resource.
      Returns:
      A Java Future containing the result of the DeleteModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteRequestValidator

      default CompletableFuture<DeleteRequestValidatorResponse> deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)

      Deletes a RequestValidator of a given RestApi.

      Parameters:
      deleteRequestValidatorRequest - Deletes a specified RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the DeleteRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteRequestValidator

      default CompletableFuture<DeleteRequestValidatorResponse> deleteRequestValidator(Consumer<DeleteRequestValidatorRequest.Builder> deleteRequestValidatorRequest)

      Deletes a RequestValidator of a given RestApi.


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

      Parameters:
      deleteRequestValidatorRequest - A Consumer that will call methods on DeleteRequestValidatorRequest.Builder to create a request. Deletes a specified RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the DeleteRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteResource

      default CompletableFuture<DeleteResourceResponse> deleteResource(DeleteResourceRequest deleteResourceRequest)

      Deletes a Resource resource.

      Parameters:
      deleteResourceRequest - Request to delete a Resource.
      Returns:
      A Java Future containing the result of the DeleteResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteResource

      default CompletableFuture<DeleteResourceResponse> deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)

      Deletes a Resource resource.


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

      Parameters:
      deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request. Request to delete a Resource.
      Returns:
      A Java Future containing the result of the DeleteResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteRestApi

      default CompletableFuture<DeleteRestApiResponse> deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)

      Deletes the specified API.

      Parameters:
      deleteRestApiRequest - Request to delete the specified API from your collection.
      Returns:
      A Java Future containing the result of the DeleteRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteRestApi

      default CompletableFuture<DeleteRestApiResponse> deleteRestApi(Consumer<DeleteRestApiRequest.Builder> deleteRestApiRequest)

      Deletes the specified API.


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

      Parameters:
      deleteRestApiRequest - A Consumer that will call methods on DeleteRestApiRequest.Builder to create a request. Request to delete the specified API from your collection.
      Returns:
      A Java Future containing the result of the DeleteRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteStage

      default CompletableFuture<DeleteStageResponse> deleteStage(DeleteStageRequest deleteStageRequest)

      Deletes a Stage resource.

      Parameters:
      deleteStageRequest - Requests API Gateway to delete a Stage resource.
      Returns:
      A Java Future containing the result of the DeleteStage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteStage

      default CompletableFuture<DeleteStageResponse> deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)

      Deletes a Stage resource.


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

      Parameters:
      deleteStageRequest - A Consumer that will call methods on DeleteStageRequest.Builder to create a request. Requests API Gateway to delete a Stage resource.
      Returns:
      A Java Future containing the result of the DeleteStage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteUsagePlan

      default CompletableFuture<DeleteUsagePlanResponse> deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)

      Deletes a usage plan of a given plan Id.

      Parameters:
      deleteUsagePlanRequest - The DELETE request to delete a usage plan of a given plan Id.
      Returns:
      A Java Future containing the result of the DeleteUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteUsagePlan

      default CompletableFuture<DeleteUsagePlanResponse> deleteUsagePlan(Consumer<DeleteUsagePlanRequest.Builder> deleteUsagePlanRequest)

      Deletes a usage plan of a given plan Id.


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

      Parameters:
      deleteUsagePlanRequest - A Consumer that will call methods on DeleteUsagePlanRequest.Builder to create a request. The DELETE request to delete a usage plan of a given plan Id.
      Returns:
      A Java Future containing the result of the DeleteUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteUsagePlanKey

      default CompletableFuture<DeleteUsagePlanKeyResponse> deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)

      Deletes a usage plan key and remove the underlying API key from the associated usage plan.

      Parameters:
      deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
      Returns:
      A Java Future containing the result of the DeleteUsagePlanKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteUsagePlanKey

      default CompletableFuture<DeleteUsagePlanKeyResponse> deleteUsagePlanKey(Consumer<DeleteUsagePlanKeyRequest.Builder> deleteUsagePlanKeyRequest)

      Deletes a usage plan key and remove the underlying API key from the associated usage plan.


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

      Parameters:
      deleteUsagePlanKeyRequest - A Consumer that will call methods on DeleteUsagePlanKeyRequest.Builder to create a request. The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
      Returns:
      A Java Future containing the result of the DeleteUsagePlanKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteVpcLink

      default CompletableFuture<DeleteVpcLinkResponse> deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)

      Deletes an existing VpcLink of a specified identifier.

      Parameters:
      deleteVpcLinkRequest - Deletes an existing VpcLink of a specified identifier.
      Returns:
      A Java Future containing the result of the DeleteVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • deleteVpcLink

      default CompletableFuture<DeleteVpcLinkResponse> deleteVpcLink(Consumer<DeleteVpcLinkRequest.Builder> deleteVpcLinkRequest)

      Deletes an existing VpcLink of a specified identifier.


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

      Parameters:
      deleteVpcLinkRequest - A Consumer that will call methods on DeleteVpcLinkRequest.Builder to create a request. Deletes an existing VpcLink of a specified identifier.
      Returns:
      A Java Future containing the result of the DeleteVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • flushStageAuthorizersCache

      default CompletableFuture<FlushStageAuthorizersCacheResponse> flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)

      Flushes all authorizer cache entries on a stage.

      Parameters:
      flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.
      Returns:
      A Java Future containing the result of the FlushStageAuthorizersCache 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • flushStageAuthorizersCache

      default CompletableFuture<FlushStageAuthorizersCacheResponse> flushStageAuthorizersCache(Consumer<FlushStageAuthorizersCacheRequest.Builder> flushStageAuthorizersCacheRequest)

      Flushes all authorizer cache entries on a stage.


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

      Parameters:
      flushStageAuthorizersCacheRequest - A Consumer that will call methods on FlushStageAuthorizersCacheRequest.Builder to create a request. Request to flush authorizer cache entries on a specified stage.
      Returns:
      A Java Future containing the result of the FlushStageAuthorizersCache 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • flushStageCache

      default CompletableFuture<FlushStageCacheResponse> flushStageCache(FlushStageCacheRequest flushStageCacheRequest)

      Flushes a stage's cache.

      Parameters:
      flushStageCacheRequest - Requests API Gateway to flush a stage's cache.
      Returns:
      A Java Future containing the result of the FlushStageCache 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • flushStageCache

      default CompletableFuture<FlushStageCacheResponse> flushStageCache(Consumer<FlushStageCacheRequest.Builder> flushStageCacheRequest)

      Flushes a stage's cache.


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

      Parameters:
      flushStageCacheRequest - A Consumer that will call methods on FlushStageCacheRequest.Builder to create a request. Requests API Gateway to flush a stage's cache.
      Returns:
      A Java Future containing the result of the FlushStageCache 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • generateClientCertificate

      default CompletableFuture<GenerateClientCertificateResponse> generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)

      Generates a ClientCertificate resource.

      Parameters:
      generateClientCertificateRequest - A request to generate a ClientCertificate resource.
      Returns:
      A Java Future containing the result of the GenerateClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • generateClientCertificate

      default CompletableFuture<GenerateClientCertificateResponse> generateClientCertificate(Consumer<GenerateClientCertificateRequest.Builder> generateClientCertificateRequest)

      Generates a ClientCertificate resource.


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

      Parameters:
      generateClientCertificateRequest - A Consumer that will call methods on GenerateClientCertificateRequest.Builder to create a request. A request to generate a ClientCertificate resource.
      Returns:
      A Java Future containing the result of the GenerateClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • generateClientCertificate

      default CompletableFuture<GenerateClientCertificateResponse> generateClientCertificate()

      Generates a ClientCertificate resource.

      Returns:
      A Java Future containing the result of the GenerateClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAccount

      default CompletableFuture<GetAccountResponse> getAccount(GetAccountRequest getAccountRequest)

      Gets information about the current Account resource.

      Parameters:
      getAccountRequest - Requests API Gateway to get information about the current Account resource.
      Returns:
      A Java Future containing the result of the GetAccount 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAccount

      default CompletableFuture<GetAccountResponse> getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)

      Gets information about the current Account resource.


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

      Parameters:
      getAccountRequest - A Consumer that will call methods on GetAccountRequest.Builder to create a request. Requests API Gateway to get information about the current Account resource.
      Returns:
      A Java Future containing the result of the GetAccount 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAccount

      default CompletableFuture<GetAccountResponse> getAccount()

      Gets information about the current Account resource.

      Returns:
      A Java Future containing the result of the GetAccount 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKey

      default CompletableFuture<GetApiKeyResponse> getApiKey(GetApiKeyRequest getApiKeyRequest)

      Gets information about the current ApiKey resource.

      Parameters:
      getApiKeyRequest - A request to get information about the current ApiKey resource.
      Returns:
      A Java Future containing the result of the GetApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKey

      default CompletableFuture<GetApiKeyResponse> getApiKey(Consumer<GetApiKeyRequest.Builder> getApiKeyRequest)

      Gets information about the current ApiKey resource.


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

      Parameters:
      getApiKeyRequest - A Consumer that will call methods on GetApiKeyRequest.Builder to create a request. A request to get information about the current ApiKey resource.
      Returns:
      A Java Future containing the result of the GetApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKeys

      default CompletableFuture<GetApiKeysResponse> getApiKeys(GetApiKeysRequest getApiKeysRequest)

      Gets information about the current ApiKeys resource.

      Parameters:
      getApiKeysRequest - A request to get information about the current ApiKeys resource.
      Returns:
      A Java Future containing the result of the GetApiKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKeys

      default CompletableFuture<GetApiKeysResponse> getApiKeys(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)

      Gets information about the current ApiKeys resource.


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

      Parameters:
      getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A request to get information about the current ApiKeys resource.
      Returns:
      A Java Future containing the result of the GetApiKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKeys

      default CompletableFuture<GetApiKeysResponse> getApiKeys()

      Gets information about the current ApiKeys resource.

      Returns:
      A Java Future containing the result of the GetApiKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKeysPaginator

      default GetApiKeysPublisher getApiKeysPaginator()

      This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) 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.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse 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 limit 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 getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.

      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKeysPaginator

      default GetApiKeysPublisher getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest)

      This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) 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.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse 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 limit 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 getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.

      Parameters:
      getApiKeysRequest - A request to get information about the current ApiKeys resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getApiKeysPaginator

      default GetApiKeysPublisher getApiKeysPaginator(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)

      This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) 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.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetApiKeysPublisher publisher = client.getApiKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse 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 limit 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 getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.


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

      Parameters:
      getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A request to get information about the current ApiKeys resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAuthorizer

      default CompletableFuture<GetAuthorizerResponse> getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)

      Describe an existing Authorizer resource.

      Parameters:
      getAuthorizerRequest - Request to describe an existing Authorizer resource.
      Returns:
      A Java Future containing the result of the GetAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAuthorizer

      default CompletableFuture<GetAuthorizerResponse> getAuthorizer(Consumer<GetAuthorizerRequest.Builder> getAuthorizerRequest)

      Describe an existing Authorizer resource.


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

      Parameters:
      getAuthorizerRequest - A Consumer that will call methods on GetAuthorizerRequest.Builder to create a request. Request to describe an existing Authorizer resource.
      Returns:
      A Java Future containing the result of the GetAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAuthorizers

      default CompletableFuture<GetAuthorizersResponse> getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)

      Describe an existing Authorizers resource.

      Parameters:
      getAuthorizersRequest - Request to describe an existing Authorizers resource.
      Returns:
      A Java Future containing the result of the GetAuthorizers 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getAuthorizers

      default CompletableFuture<GetAuthorizersResponse> getAuthorizers(Consumer<GetAuthorizersRequest.Builder> getAuthorizersRequest)

      Describe an existing Authorizers resource.


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

      Parameters:
      getAuthorizersRequest - A Consumer that will call methods on GetAuthorizersRequest.Builder to create a request. Request to describe an existing Authorizers resource.
      Returns:
      A Java Future containing the result of the GetAuthorizers 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getBasePathMapping

      default CompletableFuture<GetBasePathMappingResponse> getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)

      Describe a BasePathMapping resource.

      Parameters:
      getBasePathMappingRequest - Request to describe a BasePathMapping resource.
      Returns:
      A Java Future containing the result of the GetBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getBasePathMapping

      default CompletableFuture<GetBasePathMappingResponse> getBasePathMapping(Consumer<GetBasePathMappingRequest.Builder> getBasePathMappingRequest)

      Describe a BasePathMapping resource.


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

      Parameters:
      getBasePathMappingRequest - A Consumer that will call methods on GetBasePathMappingRequest.Builder to create a request. Request to describe a BasePathMapping resource.
      Returns:
      A Java Future containing the result of the GetBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getBasePathMappings

      default CompletableFuture<GetBasePathMappingsResponse> getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)

      Represents a collection of BasePathMapping resources.

      Parameters:
      getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.
      Returns:
      A Java Future containing the result of the GetBasePathMappings 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getBasePathMappings

      default CompletableFuture<GetBasePathMappingsResponse> getBasePathMappings(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)

      Represents a collection of BasePathMapping resources.


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

      Parameters:
      getBasePathMappingsRequest - A Consumer that will call methods on GetBasePathMappingsRequest.Builder to create a request. A request to get information about a collection of BasePathMapping resources.
      Returns:
      A Java Future containing the result of the GetBasePathMappings 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getBasePathMappingsPaginator

      default GetBasePathMappingsPublisher getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest)

      This is a variant of getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest) 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.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse 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 limit 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 getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest) operation.

      Parameters:
      getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getBasePathMappingsPaginator

      default GetBasePathMappingsPublisher getBasePathMappingsPaginator(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)

      This is a variant of getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest) 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.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsPublisher publisher = client.getBasePathMappingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse 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 limit 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 getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest) operation.


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

      Parameters:
      getBasePathMappingsRequest - A Consumer that will call methods on GetBasePathMappingsRequest.Builder to create a request. A request to get information about a collection of BasePathMapping resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificate

      default CompletableFuture<GetClientCertificateResponse> getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)

      Gets information about the current ClientCertificate resource.

      Parameters:
      getClientCertificateRequest - A request to get information about the current ClientCertificate resource.
      Returns:
      A Java Future containing the result of the GetClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificate

      default CompletableFuture<GetClientCertificateResponse> getClientCertificate(Consumer<GetClientCertificateRequest.Builder> getClientCertificateRequest)

      Gets information about the current ClientCertificate resource.


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

      Parameters:
      getClientCertificateRequest - A Consumer that will call methods on GetClientCertificateRequest.Builder to create a request. A request to get information about the current ClientCertificate resource.
      Returns:
      A Java Future containing the result of the GetClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificates

      default CompletableFuture<GetClientCertificatesResponse> getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)

      Gets a collection of ClientCertificate resources.

      Parameters:
      getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.
      Returns:
      A Java Future containing the result of the GetClientCertificates 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificates

      default CompletableFuture<GetClientCertificatesResponse> getClientCertificates(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)

      Gets a collection of ClientCertificate resources.


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

      Parameters:
      getClientCertificatesRequest - A Consumer that will call methods on GetClientCertificatesRequest.Builder to create a request. A request to get information about a collection of ClientCertificate resources.
      Returns:
      A Java Future containing the result of the GetClientCertificates 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificates

      default CompletableFuture<GetClientCertificatesResponse> getClientCertificates()

      Gets a collection of ClientCertificate resources.

      Returns:
      A Java Future containing the result of the GetClientCertificates 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificatesPaginator

      default GetClientCertificatesPublisher getClientCertificatesPaginator()

      This is a variant of getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) 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.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse 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 limit 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 getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) operation.

      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificatesPaginator

      default GetClientCertificatesPublisher getClientCertificatesPaginator(GetClientCertificatesRequest getClientCertificatesRequest)

      This is a variant of getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) 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.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse 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 limit 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 getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) operation.

      Parameters:
      getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getClientCertificatesPaginator

      default GetClientCertificatesPublisher getClientCertificatesPaginator(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)

      This is a variant of getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) 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.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesPublisher publisher = client.getClientCertificatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse 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 limit 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 getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) operation.


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

      Parameters:
      getClientCertificatesRequest - A Consumer that will call methods on GetClientCertificatesRequest.Builder to create a request. A request to get information about a collection of ClientCertificate resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDeployment

      default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest)

      Gets information about a Deployment resource.

      Parameters:
      getDeploymentRequest - Requests API Gateway to get information about a Deployment resource.
      Returns:
      A Java Future containing the result of the GetDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDeployment

      default CompletableFuture<GetDeploymentResponse> getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)

      Gets information about a Deployment resource.


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

      Parameters:
      getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request. Requests API Gateway to get information about a Deployment resource.
      Returns:
      A Java Future containing the result of the GetDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDeployments

      default CompletableFuture<GetDeploymentsResponse> getDeployments(GetDeploymentsRequest getDeploymentsRequest)

      Gets information about a Deployments collection.

      Parameters:
      getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.
      Returns:
      A Java Future containing the result of the GetDeployments 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDeployments

      default CompletableFuture<GetDeploymentsResponse> getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)

      Gets information about a Deployments collection.


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

      Parameters:
      getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request. Requests API Gateway to get information about a Deployments collection.
      Returns:
      A Java Future containing the result of the GetDeployments 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDeploymentsPaginator

      default GetDeploymentsPublisher getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest)

      This is a variant of getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) 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.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse 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 limit 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 getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) operation.

      Parameters:
      getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDeploymentsPaginator

      default GetDeploymentsPublisher getDeploymentsPaginator(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)

      This is a variant of getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) 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.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsPublisher publisher = client.getDeploymentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse 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 limit 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 getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) operation.


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

      Parameters:
      getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request. Requests API Gateway to get information about a Deployments collection.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationPart

      default CompletableFuture<GetDocumentationPartResponse> getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)

      Gets a documentation part.

      Parameters:
      getDocumentationPartRequest - Gets a specified documentation part of a given API.
      Returns:
      A Java Future containing the result of the GetDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationPart

      default CompletableFuture<GetDocumentationPartResponse> getDocumentationPart(Consumer<GetDocumentationPartRequest.Builder> getDocumentationPartRequest)

      Gets a documentation part.


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

      Parameters:
      getDocumentationPartRequest - A Consumer that will call methods on GetDocumentationPartRequest.Builder to create a request. Gets a specified documentation part of a given API.
      Returns:
      A Java Future containing the result of the GetDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationParts

      default CompletableFuture<GetDocumentationPartsResponse> getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)

      Gets documentation parts.

      Parameters:
      getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
      Returns:
      A Java Future containing the result of the GetDocumentationParts 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationParts

      default CompletableFuture<GetDocumentationPartsResponse> getDocumentationParts(Consumer<GetDocumentationPartsRequest.Builder> getDocumentationPartsRequest)

      Gets documentation parts.


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

      Parameters:
      getDocumentationPartsRequest - A Consumer that will call methods on GetDocumentationPartsRequest.Builder to create a request. Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
      Returns:
      A Java Future containing the result of the GetDocumentationParts 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationVersion

      default CompletableFuture<GetDocumentationVersionResponse> getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)

      Gets a documentation version.

      Parameters:
      getDocumentationVersionRequest - Gets a documentation snapshot of an API.
      Returns:
      A Java Future containing the result of the GetDocumentationVersion 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationVersion

      default CompletableFuture<GetDocumentationVersionResponse> getDocumentationVersion(Consumer<GetDocumentationVersionRequest.Builder> getDocumentationVersionRequest)

      Gets a documentation version.


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

      Parameters:
      getDocumentationVersionRequest - A Consumer that will call methods on GetDocumentationVersionRequest.Builder to create a request. Gets a documentation snapshot of an API.
      Returns:
      A Java Future containing the result of the GetDocumentationVersion 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationVersions

      default CompletableFuture<GetDocumentationVersionsResponse> getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)

      Gets documentation versions.

      Parameters:
      getDocumentationVersionsRequest - Gets the documentation versions of an API.
      Returns:
      A Java Future containing the result of the GetDocumentationVersions 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDocumentationVersions

      default CompletableFuture<GetDocumentationVersionsResponse> getDocumentationVersions(Consumer<GetDocumentationVersionsRequest.Builder> getDocumentationVersionsRequest)

      Gets documentation versions.


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

      Parameters:
      getDocumentationVersionsRequest - A Consumer that will call methods on GetDocumentationVersionsRequest.Builder to create a request. Gets the documentation versions of an API.
      Returns:
      A Java Future containing the result of the GetDocumentationVersions 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainName

      default CompletableFuture<GetDomainNameResponse> getDomainName(GetDomainNameRequest getDomainNameRequest)

      Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

      Parameters:
      getDomainNameRequest - Request to get the name of a DomainName resource.
      Returns:
      A Java Future containing the result of the GetDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainName

      default CompletableFuture<GetDomainNameResponse> getDomainName(Consumer<GetDomainNameRequest.Builder> getDomainNameRequest)

      Represents a domain name that is contained in a simpler, more intuitive URL that can be called.


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

      Parameters:
      getDomainNameRequest - A Consumer that will call methods on GetDomainNameRequest.Builder to create a request. Request to get the name of a DomainName resource.
      Returns:
      A Java Future containing the result of the GetDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainNames

      default CompletableFuture<GetDomainNamesResponse> getDomainNames(GetDomainNamesRequest getDomainNamesRequest)

      Represents a collection of DomainName resources.

      Parameters:
      getDomainNamesRequest - Request to describe a collection of DomainName resources.
      Returns:
      A Java Future containing the result of the GetDomainNames 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainNames

      default CompletableFuture<GetDomainNamesResponse> getDomainNames(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)

      Represents a collection of DomainName resources.


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

      Parameters:
      getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request. Request to describe a collection of DomainName resources.
      Returns:
      A Java Future containing the result of the GetDomainNames 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainNames

      default CompletableFuture<GetDomainNamesResponse> getDomainNames()

      Represents a collection of DomainName resources.

      Returns:
      A Java Future containing the result of the GetDomainNames 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainNamesPaginator

      default GetDomainNamesPublisher getDomainNamesPaginator()

      This is a variant of getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) 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.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse 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 limit 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 getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.

      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainNamesPaginator

      default GetDomainNamesPublisher getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest)

      This is a variant of getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) 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.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse 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 limit 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 getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.

      Parameters:
      getDomainNamesRequest - Request to describe a collection of DomainName resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getDomainNamesPaginator

      default GetDomainNamesPublisher getDomainNamesPaginator(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)

      This is a variant of getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) 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.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesPublisher publisher = client.getDomainNamesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse 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 limit 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 getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.


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

      Parameters:
      getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request. Request to describe a collection of DomainName resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getExport

      default CompletableFuture<GetExportResponse> getExport(GetExportRequest getExportRequest)

      Exports a deployed version of a RestApi in a specified format.

      Parameters:
      getExportRequest - Request a new export of a RestApi for a particular Stage.
      Returns:
      A Java Future containing the result of the GetExport 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getExport

      default CompletableFuture<GetExportResponse> getExport(Consumer<GetExportRequest.Builder> getExportRequest)

      Exports a deployed version of a RestApi in a specified format.


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

      Parameters:
      getExportRequest - A Consumer that will call methods on GetExportRequest.Builder to create a request. Request a new export of a RestApi for a particular Stage.
      Returns:
      A Java Future containing the result of the GetExport 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getGatewayResponse

      default CompletableFuture<GetGatewayResponseResponse> getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)

      Gets a GatewayResponse of a specified response type on the given RestApi.

      Parameters:
      getGatewayResponseRequest - Gets a GatewayResponse of a specified response type on the given RestApi.
      Returns:
      A Java Future containing the result of the GetGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getGatewayResponse

      default CompletableFuture<GetGatewayResponseResponse> getGatewayResponse(Consumer<GetGatewayResponseRequest.Builder> getGatewayResponseRequest)

      Gets a GatewayResponse of a specified response type on the given RestApi.


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

      Parameters:
      getGatewayResponseRequest - A Consumer that will call methods on GetGatewayResponseRequest.Builder to create a request. Gets a GatewayResponse of a specified response type on the given RestApi.
      Returns:
      A Java Future containing the result of the GetGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getGatewayResponses

      default CompletableFuture<GetGatewayResponsesResponse> getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest)

      Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

      Parameters:
      getGatewayResponsesRequest - Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
      Returns:
      A Java Future containing the result of the GetGatewayResponses 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getGatewayResponses

      default CompletableFuture<GetGatewayResponsesResponse> getGatewayResponses(Consumer<GetGatewayResponsesRequest.Builder> getGatewayResponsesRequest)

      Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.


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

      Parameters:
      getGatewayResponsesRequest - A Consumer that will call methods on GetGatewayResponsesRequest.Builder to create a request. Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
      Returns:
      A Java Future containing the result of the GetGatewayResponses 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getIntegration

      default CompletableFuture<GetIntegrationResponse> getIntegration(GetIntegrationRequest getIntegrationRequest)

      Get the integration settings.

      Parameters:
      getIntegrationRequest - Represents a request to get the integration configuration.
      Returns:
      A Java Future containing the result of the GetIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getIntegration

      default CompletableFuture<GetIntegrationResponse> getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)

      Get the integration settings.


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

      Parameters:
      getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request. Represents a request to get the integration configuration.
      Returns:
      A Java Future containing the result of the GetIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getIntegrationResponse

      default CompletableFuture<GetIntegrationResponseResponse> getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)

      Represents a get integration response.

      Parameters:
      getIntegrationResponseRequest - Represents a get integration response request.
      Returns:
      A Java Future containing the result of the GetIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getIntegrationResponse

      default CompletableFuture<GetIntegrationResponseResponse> getIntegrationResponse(Consumer<GetIntegrationResponseRequest.Builder> getIntegrationResponseRequest)

      Represents a get integration response.


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

      Parameters:
      getIntegrationResponseRequest - A Consumer that will call methods on GetIntegrationResponseRequest.Builder to create a request. Represents a get integration response request.
      Returns:
      A Java Future containing the result of the GetIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getMethod

      default CompletableFuture<GetMethodResponse> getMethod(GetMethodRequest getMethodRequest)

      Describe an existing Method resource.

      Parameters:
      getMethodRequest - Request to describe an existing Method resource.
      Returns:
      A Java Future containing the result of the GetMethod 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getMethod

      default CompletableFuture<GetMethodResponse> getMethod(Consumer<GetMethodRequest.Builder> getMethodRequest)

      Describe an existing Method resource.


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

      Parameters:
      getMethodRequest - A Consumer that will call methods on GetMethodRequest.Builder to create a request. Request to describe an existing Method resource.
      Returns:
      A Java Future containing the result of the GetMethod 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getMethodResponse

      default CompletableFuture<GetMethodResponseResponse> getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)

      Describes a MethodResponse resource.

      Parameters:
      getMethodResponseRequest - Request to describe a MethodResponse resource.
      Returns:
      A Java Future containing the result of the GetMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getMethodResponse

      default CompletableFuture<GetMethodResponseResponse> getMethodResponse(Consumer<GetMethodResponseRequest.Builder> getMethodResponseRequest)

      Describes a MethodResponse resource.


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

      Parameters:
      getMethodResponseRequest - A Consumer that will call methods on GetMethodResponseRequest.Builder to create a request. Request to describe a MethodResponse resource.
      Returns:
      A Java Future containing the result of the GetMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModel

      default CompletableFuture<GetModelResponse> getModel(GetModelRequest getModelRequest)

      Describes an existing model defined for a RestApi resource.

      Parameters:
      getModelRequest - Request to list information about a model in an existing RestApi resource.
      Returns:
      A Java Future containing the result of the GetModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModel

      default CompletableFuture<GetModelResponse> getModel(Consumer<GetModelRequest.Builder> getModelRequest)

      Describes an existing model defined for a RestApi resource.


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

      Parameters:
      getModelRequest - A Consumer that will call methods on GetModelRequest.Builder to create a request. Request to list information about a model in an existing RestApi resource.
      Returns:
      A Java Future containing the result of the GetModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModelTemplate

      default CompletableFuture<GetModelTemplateResponse> getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)

      Generates a sample mapping template that can be used to transform a payload into the structure of a model.

      Parameters:
      getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.
      Returns:
      A Java Future containing the result of the GetModelTemplate 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModelTemplate

      default CompletableFuture<GetModelTemplateResponse> getModelTemplate(Consumer<GetModelTemplateRequest.Builder> getModelTemplateRequest)

      Generates a sample mapping template that can be used to transform a payload into the structure of a model.


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

      Parameters:
      getModelTemplateRequest - A Consumer that will call methods on GetModelTemplateRequest.Builder to create a request. Request to generate a sample mapping template used to transform the payload.
      Returns:
      A Java Future containing the result of the GetModelTemplate 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModels

      default CompletableFuture<GetModelsResponse> getModels(GetModelsRequest getModelsRequest)

      Describes existing Models defined for a RestApi resource.

      Parameters:
      getModelsRequest - Request to list existing Models defined for a RestApi resource.
      Returns:
      A Java Future containing the result of the GetModels 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModels

      default CompletableFuture<GetModelsResponse> getModels(Consumer<GetModelsRequest.Builder> getModelsRequest)

      Describes existing Models defined for a RestApi resource.


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

      Parameters:
      getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request to list existing Models defined for a RestApi resource.
      Returns:
      A Java Future containing the result of the GetModels 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModelsPaginator

      default GetModelsPublisher getModelsPaginator(GetModelsRequest getModelsRequest)

      This is a variant of getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) 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.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetModelsResponse 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 limit 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 getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.

      Parameters:
      getModelsRequest - Request to list existing Models defined for a RestApi resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getModelsPaginator

      default GetModelsPublisher getModelsPaginator(Consumer<GetModelsRequest.Builder> getModelsRequest)

      This is a variant of getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) 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.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetModelsPublisher publisher = client.getModelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetModelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetModelsResponse 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 limit 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 getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.


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

      Parameters:
      getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request to list existing Models defined for a RestApi resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRequestValidator

      default CompletableFuture<GetRequestValidatorResponse> getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)

      Gets a RequestValidator of a given RestApi.

      Parameters:
      getRequestValidatorRequest - Gets a RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the GetRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRequestValidator

      default CompletableFuture<GetRequestValidatorResponse> getRequestValidator(Consumer<GetRequestValidatorRequest.Builder> getRequestValidatorRequest)

      Gets a RequestValidator of a given RestApi.


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

      Parameters:
      getRequestValidatorRequest - A Consumer that will call methods on GetRequestValidatorRequest.Builder to create a request. Gets a RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the GetRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRequestValidators

      default CompletableFuture<GetRequestValidatorsResponse> getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)

      Gets the RequestValidators collection of a given RestApi.

      Parameters:
      getRequestValidatorsRequest - Gets the RequestValidators collection of a given RestApi.
      Returns:
      A Java Future containing the result of the GetRequestValidators 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRequestValidators

      default CompletableFuture<GetRequestValidatorsResponse> getRequestValidators(Consumer<GetRequestValidatorsRequest.Builder> getRequestValidatorsRequest)

      Gets the RequestValidators collection of a given RestApi.


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

      Parameters:
      getRequestValidatorsRequest - A Consumer that will call methods on GetRequestValidatorsRequest.Builder to create a request. Gets the RequestValidators collection of a given RestApi.
      Returns:
      A Java Future containing the result of the GetRequestValidators 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getResource

      default CompletableFuture<GetResourceResponse> getResource(GetResourceRequest getResourceRequest)

      Lists information about a resource.

      Parameters:
      getResourceRequest - Request to list information about a resource.
      Returns:
      A Java Future containing the result of the GetResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getResource

      default CompletableFuture<GetResourceResponse> getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)

      Lists information about a resource.


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

      Parameters:
      getResourceRequest - A Consumer that will call methods on GetResourceRequest.Builder to create a request. Request to list information about a resource.
      Returns:
      A Java Future containing the result of the GetResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getResources

      default CompletableFuture<GetResourcesResponse> getResources(GetResourcesRequest getResourcesRequest)

      Lists information about a collection of Resource resources.

      Parameters:
      getResourcesRequest - Request to list information about a collection of resources.
      Returns:
      A Java Future containing the result of the GetResources 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getResources

      default CompletableFuture<GetResourcesResponse> getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)

      Lists information about a collection of Resource resources.


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

      Parameters:
      getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request. Request to list information about a collection of resources.
      Returns:
      A Java Future containing the result of the GetResources 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getResourcesPaginator

      default GetResourcesPublisher getResourcesPaginator(GetResourcesRequest getResourcesRequest)

      This is a variant of getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) 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.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetResourcesResponse 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 limit 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 getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.

      Parameters:
      getResourcesRequest - Request to list information about a collection of resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getResourcesPaginator

      default GetResourcesPublisher getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)

      This is a variant of getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) 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.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetResourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetResourcesResponse 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 limit 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 getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.


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

      Parameters:
      getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request. Request to list information about a collection of resources.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApi

      default CompletableFuture<GetRestApiResponse> getRestApi(GetRestApiRequest getRestApiRequest)

      Lists the RestApi resource in the collection.

      Parameters:
      getRestApiRequest - The GET request to list an existing RestApi defined for your collection.
      Returns:
      A Java Future containing the result of the GetRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApi

      default CompletableFuture<GetRestApiResponse> getRestApi(Consumer<GetRestApiRequest.Builder> getRestApiRequest)

      Lists the RestApi resource in the collection.


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

      Parameters:
      getRestApiRequest - A Consumer that will call methods on GetRestApiRequest.Builder to create a request. The GET request to list an existing RestApi defined for your collection.
      Returns:
      A Java Future containing the result of the GetRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApis

      default CompletableFuture<GetRestApisResponse> getRestApis(GetRestApisRequest getRestApisRequest)

      Lists the RestApis resources for your collection.

      Parameters:
      getRestApisRequest - The GET request to list existing RestApis defined for your collection.
      Returns:
      A Java Future containing the result of the GetRestApis 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApis

      default CompletableFuture<GetRestApisResponse> getRestApis(Consumer<GetRestApisRequest.Builder> getRestApisRequest)

      Lists the RestApis resources for your collection.


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

      Parameters:
      getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The GET request to list existing RestApis defined for your collection.
      Returns:
      A Java Future containing the result of the GetRestApis 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApis

      default CompletableFuture<GetRestApisResponse> getRestApis()

      Lists the RestApis resources for your collection.

      Returns:
      A Java Future containing the result of the GetRestApis 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApisPaginator

      default GetRestApisPublisher getRestApisPaginator()

      This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) 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.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetRestApisResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetRestApisResponse 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 limit 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 getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.

      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApisPaginator

      default GetRestApisPublisher getRestApisPaginator(GetRestApisRequest getRestApisRequest)

      This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) 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.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetRestApisResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetRestApisResponse 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 limit 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 getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.

      Parameters:
      getRestApisRequest - The GET request to list existing RestApis defined for your collection.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getRestApisPaginator

      default GetRestApisPublisher getRestApisPaginator(Consumer<GetRestApisRequest.Builder> getRestApisRequest)

      This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) 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.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetRestApisPublisher publisher = client.getRestApisPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetRestApisResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetRestApisResponse 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 limit 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 getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.


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

      Parameters:
      getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The GET request to list existing RestApis defined for your collection.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdk

      default CompletableFuture<GetSdkResponse> getSdk(GetSdkRequest getSdkRequest)

      Generates a client SDK for a RestApi and Stage.

      Parameters:
      getSdkRequest - Request a new generated client SDK for a RestApi and Stage.
      Returns:
      A Java Future containing the result of the GetSdk 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdk

      default CompletableFuture<GetSdkResponse> getSdk(Consumer<GetSdkRequest.Builder> getSdkRequest)

      Generates a client SDK for a RestApi and Stage.


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

      Parameters:
      getSdkRequest - A Consumer that will call methods on GetSdkRequest.Builder to create a request. Request a new generated client SDK for a RestApi and Stage.
      Returns:
      A Java Future containing the result of the GetSdk 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdkType

      default CompletableFuture<GetSdkTypeResponse> getSdkType(GetSdkTypeRequest getSdkTypeRequest)

      Gets an SDK type.

      Parameters:
      getSdkTypeRequest - Get an SdkType instance.
      Returns:
      A Java Future containing the result of the GetSdkType 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdkType

      default CompletableFuture<GetSdkTypeResponse> getSdkType(Consumer<GetSdkTypeRequest.Builder> getSdkTypeRequest)

      Gets an SDK type.


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

      Parameters:
      getSdkTypeRequest - A Consumer that will call methods on GetSdkTypeRequest.Builder to create a request. Get an SdkType instance.
      Returns:
      A Java Future containing the result of the GetSdkType 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdkTypes

      default CompletableFuture<GetSdkTypesResponse> getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)

      Gets SDK types

      Parameters:
      getSdkTypesRequest - Get the SdkTypes collection.
      Returns:
      A Java Future containing the result of the GetSdkTypes 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdkTypes

      default CompletableFuture<GetSdkTypesResponse> getSdkTypes(Consumer<GetSdkTypesRequest.Builder> getSdkTypesRequest)

      Gets SDK types


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

      Parameters:
      getSdkTypesRequest - A Consumer that will call methods on GetSdkTypesRequest.Builder to create a request. Get the SdkTypes collection.
      Returns:
      A Java Future containing the result of the GetSdkTypes 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getSdkTypes

      default CompletableFuture<GetSdkTypesResponse> getSdkTypes()

      Gets SDK types

      Returns:
      A Java Future containing the result of the GetSdkTypes 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getStage

      default CompletableFuture<GetStageResponse> getStage(GetStageRequest getStageRequest)

      Gets information about a Stage resource.

      Parameters:
      getStageRequest - Requests API Gateway to get information about a Stage resource.
      Returns:
      A Java Future containing the result of the GetStage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getStage

      default CompletableFuture<GetStageResponse> getStage(Consumer<GetStageRequest.Builder> getStageRequest)

      Gets information about a Stage resource.


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

      Parameters:
      getStageRequest - A Consumer that will call methods on GetStageRequest.Builder to create a request. Requests API Gateway to get information about a Stage resource.
      Returns:
      A Java Future containing the result of the GetStage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getStages

      default CompletableFuture<GetStagesResponse> getStages(GetStagesRequest getStagesRequest)

      Gets information about one or more Stage resources.

      Parameters:
      getStagesRequest - Requests API Gateway to get information about one or more Stage resources.
      Returns:
      A Java Future containing the result of the GetStages 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getStages

      default CompletableFuture<GetStagesResponse> getStages(Consumer<GetStagesRequest.Builder> getStagesRequest)

      Gets information about one or more Stage resources.


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

      Parameters:
      getStagesRequest - A Consumer that will call methods on GetStagesRequest.Builder to create a request. Requests API Gateway to get information about one or more Stage resources.
      Returns:
      A Java Future containing the result of the GetStages 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getTags

      default CompletableFuture<GetTagsResponse> getTags(GetTagsRequest getTagsRequest)

      Gets the Tags collection for a given resource.

      Parameters:
      getTagsRequest - Gets the Tags collection for a given resource.
      Returns:
      A Java Future containing the result of the GetTags 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getTags

      default CompletableFuture<GetTagsResponse> getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)

      Gets the Tags collection for a given resource.


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

      Parameters:
      getTagsRequest - A Consumer that will call methods on GetTagsRequest.Builder to create a request. Gets the Tags collection for a given resource.
      Returns:
      A Java Future containing the result of the GetTags 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsage

      default CompletableFuture<GetUsageResponse> getUsage(GetUsageRequest getUsageRequest)

      Gets the usage data of a usage plan in a specified time interval.

      Parameters:
      getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.
      Returns:
      A Java Future containing the result of the GetUsage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsage

      default CompletableFuture<GetUsageResponse> getUsage(Consumer<GetUsageRequest.Builder> getUsageRequest)

      Gets the usage data of a usage plan in a specified time interval.


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

      Parameters:
      getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET request to get the usage data of a usage plan in a specified time interval.
      Returns:
      A Java Future containing the result of the GetUsage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePaginator

      default GetUsagePublisher getUsagePaginator(GetUsageRequest getUsageRequest)

      This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) 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.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsageResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsageResponse 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 limit 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 getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.

      Parameters:
      getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePaginator

      default GetUsagePublisher getUsagePaginator(Consumer<GetUsageRequest.Builder> getUsageRequest)

      This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) 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.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePublisher publisher = client.getUsagePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsageResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsageResponse 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 limit 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 getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.


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

      Parameters:
      getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET request to get the usage data of a usage plan in a specified time interval.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlan

      default CompletableFuture<GetUsagePlanResponse> getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)

      Gets a usage plan of a given plan identifier.

      Parameters:
      getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.
      Returns:
      A Java Future containing the result of the GetUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlan

      default CompletableFuture<GetUsagePlanResponse> getUsagePlan(Consumer<GetUsagePlanRequest.Builder> getUsagePlanRequest)

      Gets a usage plan of a given plan identifier.


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

      Parameters:
      getUsagePlanRequest - A Consumer that will call methods on GetUsagePlanRequest.Builder to create a request. The GET request to get a usage plan of a given plan identifier.
      Returns:
      A Java Future containing the result of the GetUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlanKey

      default CompletableFuture<GetUsagePlanKeyResponse> getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)

      Gets a usage plan key of a given key identifier.

      Parameters:
      getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.
      Returns:
      A Java Future containing the result of the GetUsagePlanKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlanKey

      default CompletableFuture<GetUsagePlanKeyResponse> getUsagePlanKey(Consumer<GetUsagePlanKeyRequest.Builder> getUsagePlanKeyRequest)

      Gets a usage plan key of a given key identifier.


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

      Parameters:
      getUsagePlanKeyRequest - A Consumer that will call methods on GetUsagePlanKeyRequest.Builder to create a request. The GET request to get a usage plan key of a given key identifier.
      Returns:
      A Java Future containing the result of the GetUsagePlanKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlanKeys

      default CompletableFuture<GetUsagePlanKeysResponse> getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)

      Gets all the usage plan keys representing the API keys added to a specified usage plan.

      Parameters:
      getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
      Returns:
      A Java Future containing the result of the GetUsagePlanKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlanKeys

      default CompletableFuture<GetUsagePlanKeysResponse> getUsagePlanKeys(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)

      Gets all the usage plan keys representing the API keys added to a specified usage plan.


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

      Parameters:
      getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request. The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
      Returns:
      A Java Future containing the result of the GetUsagePlanKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlanKeysPaginator

      default GetUsagePlanKeysPublisher getUsagePlanKeysPaginator(GetUsagePlanKeysRequest getUsagePlanKeysRequest)

      This is a variant of getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) 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.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse 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 limit 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 getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) operation.

      Parameters:
      getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlanKeysPaginator

      default GetUsagePlanKeysPublisher getUsagePlanKeysPaginator(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)

      This is a variant of getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) 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.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysPublisher publisher = client.getUsagePlanKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse 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 limit 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 getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) operation.


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

      Parameters:
      getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request. The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlans

      default CompletableFuture<GetUsagePlansResponse> getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)

      Gets all the usage plans of the caller's account.

      Parameters:
      getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.
      Returns:
      A Java Future containing the result of the GetUsagePlans 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlans

      default CompletableFuture<GetUsagePlansResponse> getUsagePlans(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)

      Gets all the usage plans of the caller's account.


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

      Parameters:
      getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The GET request to get all the usage plans of the caller's account.
      Returns:
      A Java Future containing the result of the GetUsagePlans 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlans

      default CompletableFuture<GetUsagePlansResponse> getUsagePlans()

      Gets all the usage plans of the caller's account.

      Returns:
      A Java Future containing the result of the GetUsagePlans 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlansPaginator

      default GetUsagePlansPublisher getUsagePlansPaginator()

      This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse 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 limit 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 getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.

      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlansPaginator

      default GetUsagePlansPublisher getUsagePlansPaginator(GetUsagePlansRequest getUsagePlansRequest)

      This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse 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 limit 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 getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.

      Parameters:
      getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getUsagePlansPaginator

      default GetUsagePlansPublisher getUsagePlansPaginator(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)

      This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansPublisher publisher = client.getUsagePlansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse 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 limit 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 getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.


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

      Parameters:
      getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The GET request to get all the usage plans of the caller's account.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLink

      default CompletableFuture<GetVpcLinkResponse> getVpcLink(GetVpcLinkRequest getVpcLinkRequest)

      Gets a specified VPC link under the caller's account in a region.

      Parameters:
      getVpcLinkRequest - Gets a specified VPC link under the caller's account in a region.
      Returns:
      A Java Future containing the result of the GetVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLink

      default CompletableFuture<GetVpcLinkResponse> getVpcLink(Consumer<GetVpcLinkRequest.Builder> getVpcLinkRequest)

      Gets a specified VPC link under the caller's account in a region.


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

      Parameters:
      getVpcLinkRequest - A Consumer that will call methods on GetVpcLinkRequest.Builder to create a request. Gets a specified VPC link under the caller's account in a region.
      Returns:
      A Java Future containing the result of the GetVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLinks

      default CompletableFuture<GetVpcLinksResponse> getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)

      Gets the VpcLinks collection under the caller's account in a selected region.

      Parameters:
      getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.
      Returns:
      A Java Future containing the result of the GetVpcLinks 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLinks

      default CompletableFuture<GetVpcLinksResponse> getVpcLinks(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)

      Gets the VpcLinks collection under the caller's account in a selected region.


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

      Parameters:
      getVpcLinksRequest - A Consumer that will call methods on GetVpcLinksRequest.Builder to create a request. Gets the VpcLinks collection under the caller's account in a selected region.
      Returns:
      A Java Future containing the result of the GetVpcLinks 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLinks

      default CompletableFuture<GetVpcLinksResponse> getVpcLinks()

      Gets the VpcLinks collection under the caller's account in a selected region.

      Returns:
      A Java Future containing the result of the GetVpcLinks 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLinksPaginator

      default GetVpcLinksPublisher getVpcLinksPaginator()

      This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) 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.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse 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 limit 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 getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.

      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLinksPaginator

      default GetVpcLinksPublisher getVpcLinksPaginator(GetVpcLinksRequest getVpcLinksRequest)

      This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) 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.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse 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 limit 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 getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.

      Parameters:
      getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • getVpcLinksPaginator

      default GetVpcLinksPublisher getVpcLinksPaginator(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)

      This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) 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.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksPublisher publisher = client.getVpcLinksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse 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 limit 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 getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.


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

      Parameters:
      getVpcLinksRequest - A Consumer that will call methods on GetVpcLinksRequest.Builder to create a request. Gets the VpcLinks collection under the caller's account in a selected region.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • importApiKeys

      default CompletableFuture<ImportApiKeysResponse> importApiKeys(ImportApiKeysRequest importApiKeysRequest)

      Import API keys from an external source, such as a CSV-formatted file.

      Parameters:
      importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.
      Returns:
      A Java Future containing the result of the ImportApiKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • importApiKeys

      default CompletableFuture<ImportApiKeysResponse> importApiKeys(Consumer<ImportApiKeysRequest.Builder> importApiKeysRequest)

      Import API keys from an external source, such as a CSV-formatted file.


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

      Parameters:
      importApiKeysRequest - A Consumer that will call methods on ImportApiKeysRequest.Builder to create a request. The POST request to import API keys from an external source, such as a CSV-formatted file.
      Returns:
      A Java Future containing the result of the ImportApiKeys 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • importDocumentationParts

      default CompletableFuture<ImportDocumentationPartsResponse> importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)

      Imports documentation parts

      Parameters:
      importDocumentationPartsRequest - Import documentation parts from an external (e.g., OpenAPI) definition file.
      Returns:
      A Java Future containing the result of the ImportDocumentationParts 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • importDocumentationParts

      default CompletableFuture<ImportDocumentationPartsResponse> importDocumentationParts(Consumer<ImportDocumentationPartsRequest.Builder> importDocumentationPartsRequest)

      Imports documentation parts


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

      Parameters:
      importDocumentationPartsRequest - A Consumer that will call methods on ImportDocumentationPartsRequest.Builder to create a request. Import documentation parts from an external (e.g., OpenAPI) definition file.
      Returns:
      A Java Future containing the result of the ImportDocumentationParts 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • importRestApi

      default CompletableFuture<ImportRestApiResponse> importRestApi(ImportRestApiRequest importRestApiRequest)

      A feature of the API Gateway control service for creating a new API from an external API definition file.

      Parameters:
      importRestApiRequest - A POST request to import an API to API Gateway using an input of an API definition file.
      Returns:
      A Java Future containing the result of the ImportRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • importRestApi

      default CompletableFuture<ImportRestApiResponse> importRestApi(Consumer<ImportRestApiRequest.Builder> importRestApiRequest)

      A feature of the API Gateway control service for creating a new API from an external API definition file.


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

      Parameters:
      importRestApiRequest - A Consumer that will call methods on ImportRestApiRequest.Builder to create a request. A POST request to import an API to API Gateway using an input of an API definition file.
      Returns:
      A Java Future containing the result of the ImportRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putGatewayResponse

      default CompletableFuture<PutGatewayResponseResponse> putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)

      Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

      Parameters:
      putGatewayResponseRequest - Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
      Returns:
      A Java Future containing the result of the PutGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putGatewayResponse

      default CompletableFuture<PutGatewayResponseResponse> putGatewayResponse(Consumer<PutGatewayResponseRequest.Builder> putGatewayResponseRequest)

      Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.


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

      Parameters:
      putGatewayResponseRequest - A Consumer that will call methods on PutGatewayResponseRequest.Builder to create a request. Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
      Returns:
      A Java Future containing the result of the PutGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putIntegration

      default CompletableFuture<PutIntegrationResponse> putIntegration(PutIntegrationRequest putIntegrationRequest)

      Sets up a method's integration.

      Parameters:
      putIntegrationRequest - Sets up a method's integration.
      Returns:
      A Java Future containing the result of the PutIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putIntegration

      default CompletableFuture<PutIntegrationResponse> putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)

      Sets up a method's integration.


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

      Parameters:
      putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request. Sets up a method's integration.
      Returns:
      A Java Future containing the result of the PutIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putIntegrationResponse

      default CompletableFuture<PutIntegrationResponseResponse> putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)

      Represents a put integration.

      Parameters:
      putIntegrationResponseRequest - Represents a put integration response request.
      Returns:
      A Java Future containing the result of the PutIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putIntegrationResponse

      default CompletableFuture<PutIntegrationResponseResponse> putIntegrationResponse(Consumer<PutIntegrationResponseRequest.Builder> putIntegrationResponseRequest)

      Represents a put integration.


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

      Parameters:
      putIntegrationResponseRequest - A Consumer that will call methods on PutIntegrationResponseRequest.Builder to create a request. Represents a put integration response request.
      Returns:
      A Java Future containing the result of the PutIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putMethod

      default CompletableFuture<PutMethodResponse> putMethod(PutMethodRequest putMethodRequest)

      Add a method to an existing Resource resource.

      Parameters:
      putMethodRequest - Request to add a method to an existing Resource resource.
      Returns:
      A Java Future containing the result of the PutMethod 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putMethod

      default CompletableFuture<PutMethodResponse> putMethod(Consumer<PutMethodRequest.Builder> putMethodRequest)

      Add a method to an existing Resource resource.


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

      Parameters:
      putMethodRequest - A Consumer that will call methods on PutMethodRequest.Builder to create a request. Request to add a method to an existing Resource resource.
      Returns:
      A Java Future containing the result of the PutMethod 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putMethodResponse

      default CompletableFuture<PutMethodResponseResponse> putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)

      Adds a MethodResponse to an existing Method resource.

      Parameters:
      putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.
      Returns:
      A Java Future containing the result of the PutMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putMethodResponse

      default CompletableFuture<PutMethodResponseResponse> putMethodResponse(Consumer<PutMethodResponseRequest.Builder> putMethodResponseRequest)

      Adds a MethodResponse to an existing Method resource.


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

      Parameters:
      putMethodResponseRequest - A Consumer that will call methods on PutMethodResponseRequest.Builder to create a request. Request to add a MethodResponse to an existing Method resource.
      Returns:
      A Java Future containing the result of the PutMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putRestApi

      default CompletableFuture<PutRestApiResponse> putRestApi(PutRestApiRequest putRestApiRequest)

      A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

      Parameters:
      putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.
      Returns:
      A Java Future containing the result of the PutRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • putRestApi

      default CompletableFuture<PutRestApiResponse> putRestApi(Consumer<PutRestApiRequest.Builder> putRestApiRequest)

      A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.


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

      Parameters:
      putRestApiRequest - A Consumer that will call methods on PutRestApiRequest.Builder to create a request. A PUT request to update an existing API, with external API definitions specified as the request body.
      Returns:
      A Java Future containing the result of the PutRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds or updates a tag on a given resource.

      Parameters:
      tagResourceRequest - Adds or updates a tag on a given resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • tagResource

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

      Adds or updates a tag on a given 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. Adds or updates a tag on a given resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • testInvokeAuthorizer

      default CompletableFuture<TestInvokeAuthorizerResponse> testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)

      Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

      Parameters:
      testInvokeAuthorizerRequest - Make a request to simulate the invocation of an Authorizer.
      Returns:
      A Java Future containing the result of the TestInvokeAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • testInvokeAuthorizer

      default CompletableFuture<TestInvokeAuthorizerResponse> testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest)

      Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.


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

      Parameters:
      testInvokeAuthorizerRequest - A Consumer that will call methods on TestInvokeAuthorizerRequest.Builder to create a request. Make a request to simulate the invocation of an Authorizer.
      Returns:
      A Java Future containing the result of the TestInvokeAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • testInvokeMethod

      default CompletableFuture<TestInvokeMethodResponse> testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)

      Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

      Parameters:
      testInvokeMethodRequest - Make a request to simulate the invocation of a Method.
      Returns:
      A Java Future containing the result of the TestInvokeMethod 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • testInvokeMethod

      default CompletableFuture<TestInvokeMethodResponse> testInvokeMethod(Consumer<TestInvokeMethodRequest.Builder> testInvokeMethodRequest)

      Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.


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

      Parameters:
      testInvokeMethodRequest - A Consumer that will call methods on TestInvokeMethodRequest.Builder to create a request. Make a request to simulate the invocation of a Method.
      Returns:
      A Java Future containing the result of the TestInvokeMethod 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from a given resource.

      Parameters:
      untagResourceRequest - Removes a tag from a given resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • untagResource

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

      Removes a tag from a given 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. Removes a tag from a given resource.
      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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateAccount

      default CompletableFuture<UpdateAccountResponse> updateAccount(UpdateAccountRequest updateAccountRequest)

      Changes information about the current Account resource.

      Parameters:
      updateAccountRequest - Requests API Gateway to change information about the current Account resource.
      Returns:
      A Java Future containing the result of the UpdateAccount 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateAccount

      default CompletableFuture<UpdateAccountResponse> updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)

      Changes information about the current Account resource.


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

      Parameters:
      updateAccountRequest - A Consumer that will call methods on UpdateAccountRequest.Builder to create a request. Requests API Gateway to change information about the current Account resource.
      Returns:
      A Java Future containing the result of the UpdateAccount 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateApiKey

      default CompletableFuture<UpdateApiKeyResponse> updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)

      Changes information about an ApiKey resource.

      Parameters:
      updateApiKeyRequest - A request to change information about an ApiKey resource.
      Returns:
      A Java Future containing the result of the UpdateApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateApiKey

      default CompletableFuture<UpdateApiKeyResponse> updateApiKey(Consumer<UpdateApiKeyRequest.Builder> updateApiKeyRequest)

      Changes information about an ApiKey resource.


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

      Parameters:
      updateApiKeyRequest - A Consumer that will call methods on UpdateApiKeyRequest.Builder to create a request. A request to change information about an ApiKey resource.
      Returns:
      A Java Future containing the result of the UpdateApiKey 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateAuthorizer

      default CompletableFuture<UpdateAuthorizerResponse> updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)

      Updates an existing Authorizer resource.

      Parameters:
      updateAuthorizerRequest - Request to update an existing Authorizer resource.
      Returns:
      A Java Future containing the result of the UpdateAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateAuthorizer

      default CompletableFuture<UpdateAuthorizerResponse> updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest)

      Updates an existing Authorizer resource.


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

      Parameters:
      updateAuthorizerRequest - A Consumer that will call methods on UpdateAuthorizerRequest.Builder to create a request. Request to update an existing Authorizer resource.
      Returns:
      A Java Future containing the result of the UpdateAuthorizer 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateBasePathMapping

      default CompletableFuture<UpdateBasePathMappingResponse> updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)

      Changes information about the BasePathMapping resource.

      Parameters:
      updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.
      Returns:
      A Java Future containing the result of the UpdateBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateBasePathMapping

      default CompletableFuture<UpdateBasePathMappingResponse> updateBasePathMapping(Consumer<UpdateBasePathMappingRequest.Builder> updateBasePathMappingRequest)

      Changes information about the BasePathMapping resource.


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

      Parameters:
      updateBasePathMappingRequest - A Consumer that will call methods on UpdateBasePathMappingRequest.Builder to create a request. A request to change information about the BasePathMapping resource.
      Returns:
      A Java Future containing the result of the UpdateBasePathMapping 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateClientCertificate

      default CompletableFuture<UpdateClientCertificateResponse> updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)

      Changes information about an ClientCertificate resource.

      Parameters:
      updateClientCertificateRequest - A request to change information about an ClientCertificate resource.
      Returns:
      A Java Future containing the result of the UpdateClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateClientCertificate

      default CompletableFuture<UpdateClientCertificateResponse> updateClientCertificate(Consumer<UpdateClientCertificateRequest.Builder> updateClientCertificateRequest)

      Changes information about an ClientCertificate resource.


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

      Parameters:
      updateClientCertificateRequest - A Consumer that will call methods on UpdateClientCertificateRequest.Builder to create a request. A request to change information about an ClientCertificate resource.
      Returns:
      A Java Future containing the result of the UpdateClientCertificate 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDeployment

      default CompletableFuture<UpdateDeploymentResponse> updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)

      Changes information about a Deployment resource.

      Parameters:
      updateDeploymentRequest - Requests API Gateway to change information about a Deployment resource.
      Returns:
      A Java Future containing the result of the UpdateDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDeployment

      default CompletableFuture<UpdateDeploymentResponse> updateDeployment(Consumer<UpdateDeploymentRequest.Builder> updateDeploymentRequest)

      Changes information about a Deployment resource.


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

      Parameters:
      updateDeploymentRequest - A Consumer that will call methods on UpdateDeploymentRequest.Builder to create a request. Requests API Gateway to change information about a Deployment resource.
      Returns:
      A Java Future containing the result of the UpdateDeployment 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • ServiceUnavailableException The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDocumentationPart

      default CompletableFuture<UpdateDocumentationPartResponse> updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)

      Updates a documentation part.

      Parameters:
      updateDocumentationPartRequest - Updates an existing documentation part of a given API.
      Returns:
      A Java Future containing the result of the UpdateDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDocumentationPart

      default CompletableFuture<UpdateDocumentationPartResponse> updateDocumentationPart(Consumer<UpdateDocumentationPartRequest.Builder> updateDocumentationPartRequest)

      Updates a documentation part.


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

      Parameters:
      updateDocumentationPartRequest - A Consumer that will call methods on UpdateDocumentationPartRequest.Builder to create a request. Updates an existing documentation part of a given API.
      Returns:
      A Java Future containing the result of the UpdateDocumentationPart 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDocumentationVersion

      default CompletableFuture<UpdateDocumentationVersionResponse> updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)

      Updates a documentation version.

      Parameters:
      updateDocumentationVersionRequest - Updates an existing documentation version of an API.
      Returns:
      A Java Future containing the result of the UpdateDocumentationVersion 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDocumentationVersion

      default CompletableFuture<UpdateDocumentationVersionResponse> updateDocumentationVersion(Consumer<UpdateDocumentationVersionRequest.Builder> updateDocumentationVersionRequest)

      Updates a documentation version.


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

      Parameters:
      updateDocumentationVersionRequest - A Consumer that will call methods on UpdateDocumentationVersionRequest.Builder to create a request. Updates an existing documentation version of an API.
      Returns:
      A Java Future containing the result of the UpdateDocumentationVersion 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDomainName

      default CompletableFuture<UpdateDomainNameResponse> updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)

      Changes information about the DomainName resource.

      Parameters:
      updateDomainNameRequest - A request to change information about the DomainName resource.
      Returns:
      A Java Future containing the result of the UpdateDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateDomainName

      default CompletableFuture<UpdateDomainNameResponse> updateDomainName(Consumer<UpdateDomainNameRequest.Builder> updateDomainNameRequest)

      Changes information about the DomainName resource.


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

      Parameters:
      updateDomainNameRequest - A Consumer that will call methods on UpdateDomainNameRequest.Builder to create a request. A request to change information about the DomainName resource.
      Returns:
      A Java Future containing the result of the UpdateDomainName 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateGatewayResponse

      default CompletableFuture<UpdateGatewayResponseResponse> updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)

      Updates a GatewayResponse of a specified response type on the given RestApi.

      Parameters:
      updateGatewayResponseRequest - Updates a GatewayResponse of a specified response type on the given RestApi.
      Returns:
      A Java Future containing the result of the UpdateGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateGatewayResponse

      default CompletableFuture<UpdateGatewayResponseResponse> updateGatewayResponse(Consumer<UpdateGatewayResponseRequest.Builder> updateGatewayResponseRequest)

      Updates a GatewayResponse of a specified response type on the given RestApi.


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

      Parameters:
      updateGatewayResponseRequest - A Consumer that will call methods on UpdateGatewayResponseRequest.Builder to create a request. Updates a GatewayResponse of a specified response type on the given RestApi.
      Returns:
      A Java Future containing the result of the UpdateGatewayResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateIntegration

      default CompletableFuture<UpdateIntegrationResponse> updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)

      Represents an update integration.

      Parameters:
      updateIntegrationRequest - Represents an update integration request.
      Returns:
      A Java Future containing the result of the UpdateIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateIntegration

      default CompletableFuture<UpdateIntegrationResponse> updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest)

      Represents an update integration.


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

      Parameters:
      updateIntegrationRequest - A Consumer that will call methods on UpdateIntegrationRequest.Builder to create a request. Represents an update integration request.
      Returns:
      A Java Future containing the result of the UpdateIntegration 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateIntegrationResponse

      default CompletableFuture<UpdateIntegrationResponseResponse> updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)

      Represents an update integration response.

      Parameters:
      updateIntegrationResponseRequest - Represents an update integration response request.
      Returns:
      A Java Future containing the result of the UpdateIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateIntegrationResponse

      default CompletableFuture<UpdateIntegrationResponseResponse> updateIntegrationResponse(Consumer<UpdateIntegrationResponseRequest.Builder> updateIntegrationResponseRequest)

      Represents an update integration response.


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

      Parameters:
      updateIntegrationResponseRequest - A Consumer that will call methods on UpdateIntegrationResponseRequest.Builder to create a request. Represents an update integration response request.
      Returns:
      A Java Future containing the result of the UpdateIntegrationResponse 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateMethod

      default CompletableFuture<UpdateMethodResponse> updateMethod(UpdateMethodRequest updateMethodRequest)

      Updates an existing Method resource.

      Parameters:
      updateMethodRequest - Request to update an existing Method resource.
      Returns:
      A Java Future containing the result of the UpdateMethod 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateMethod

      default CompletableFuture<UpdateMethodResponse> updateMethod(Consumer<UpdateMethodRequest.Builder> updateMethodRequest)

      Updates an existing Method resource.


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

      Parameters:
      updateMethodRequest - A Consumer that will call methods on UpdateMethodRequest.Builder to create a request. Request to update an existing Method resource.
      Returns:
      A Java Future containing the result of the UpdateMethod 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateMethodResponse

      default CompletableFuture<UpdateMethodResponseResponse> updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)

      Updates an existing MethodResponse resource.

      Parameters:
      updateMethodResponseRequest - A request to update an existing MethodResponse resource.
      Returns:
      A Java Future containing the result of the UpdateMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateMethodResponse

      default CompletableFuture<UpdateMethodResponseResponse> updateMethodResponse(Consumer<UpdateMethodResponseRequest.Builder> updateMethodResponseRequest)

      Updates an existing MethodResponse resource.


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

      Parameters:
      updateMethodResponseRequest - A Consumer that will call methods on UpdateMethodResponseRequest.Builder to create a request. A request to update an existing MethodResponse resource.
      Returns:
      A Java Future containing the result of the UpdateMethodResponse 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateModel

      default CompletableFuture<UpdateModelResponse> updateModel(UpdateModelRequest updateModelRequest)

      Changes information about a model. The maximum size of the model is 400 KB.

      Parameters:
      updateModelRequest - Request to update an existing model in an existing RestApi resource.
      Returns:
      A Java Future containing the result of the UpdateModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateModel

      default CompletableFuture<UpdateModelResponse> updateModel(Consumer<UpdateModelRequest.Builder> updateModelRequest)

      Changes information about a model. The maximum size of the model is 400 KB.


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

      Parameters:
      updateModelRequest - A Consumer that will call methods on UpdateModelRequest.Builder to create a request. Request to update an existing model in an existing RestApi resource.
      Returns:
      A Java Future containing the result of the UpdateModel 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateRequestValidator

      default CompletableFuture<UpdateRequestValidatorResponse> updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)

      Updates a RequestValidator of a given RestApi.

      Parameters:
      updateRequestValidatorRequest - Updates a RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the UpdateRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateRequestValidator

      default CompletableFuture<UpdateRequestValidatorResponse> updateRequestValidator(Consumer<UpdateRequestValidatorRequest.Builder> updateRequestValidatorRequest)

      Updates a RequestValidator of a given RestApi.


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

      Parameters:
      updateRequestValidatorRequest - A Consumer that will call methods on UpdateRequestValidatorRequest.Builder to create a request. Updates a RequestValidator of a given RestApi.
      Returns:
      A Java Future containing the result of the UpdateRequestValidator 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateResource

      default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest)

      Changes information about a Resource resource.

      Parameters:
      updateResourceRequest - Request to change information about a Resource resource.
      Returns:
      A Java Future containing the result of the UpdateResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateResource

      default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)

      Changes information about a Resource resource.


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

      Parameters:
      updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request. Request to change information about a Resource resource.
      Returns:
      A Java Future containing the result of the UpdateResource 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.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateRestApi

      default CompletableFuture<UpdateRestApiResponse> updateRestApi(UpdateRestApiRequest updateRestApiRequest)

      Changes information about the specified API.

      Parameters:
      updateRestApiRequest - Request to update an existing RestApi resource in your collection.
      Returns:
      A Java Future containing the result of the UpdateRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateRestApi

      default CompletableFuture<UpdateRestApiResponse> updateRestApi(Consumer<UpdateRestApiRequest.Builder> updateRestApiRequest)

      Changes information about the specified API.


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

      Parameters:
      updateRestApiRequest - A Consumer that will call methods on UpdateRestApiRequest.Builder to create a request. Request to update an existing RestApi resource in your collection.
      Returns:
      A Java Future containing the result of the UpdateRestApi 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateStage

      default CompletableFuture<UpdateStageResponse> updateStage(UpdateStageRequest updateStageRequest)

      Changes information about a Stage resource.

      Parameters:
      updateStageRequest - Requests API Gateway to change information about a Stage resource.
      Returns:
      A Java Future containing the result of the UpdateStage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateStage

      default CompletableFuture<UpdateStageResponse> updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)

      Changes information about a Stage resource.


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

      Parameters:
      updateStageRequest - A Consumer that will call methods on UpdateStageRequest.Builder to create a request. Requests API Gateway to change information about a Stage resource.
      Returns:
      A Java Future containing the result of the UpdateStage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateUsage

      default CompletableFuture<UpdateUsageResponse> updateUsage(UpdateUsageRequest updateUsageRequest)

      Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

      Parameters:
      updateUsageRequest - The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
      Returns:
      A Java Future containing the result of the UpdateUsage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateUsage

      default CompletableFuture<UpdateUsageResponse> updateUsage(Consumer<UpdateUsageRequest.Builder> updateUsageRequest)

      Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.


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

      Parameters:
      updateUsageRequest - A Consumer that will call methods on UpdateUsageRequest.Builder to create a request. The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
      Returns:
      A Java Future containing the result of the UpdateUsage 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateUsagePlan

      default CompletableFuture<UpdateUsagePlanResponse> updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)

      Updates a usage plan of a given plan Id.

      Parameters:
      updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.
      Returns:
      A Java Future containing the result of the UpdateUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateUsagePlan

      default CompletableFuture<UpdateUsagePlanResponse> updateUsagePlan(Consumer<UpdateUsagePlanRequest.Builder> updateUsagePlanRequest)

      Updates a usage plan of a given plan Id.


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

      Parameters:
      updateUsagePlanRequest - A Consumer that will call methods on UpdateUsagePlanRequest.Builder to create a request. The PATCH request to update a usage plan of a given plan Id.
      Returns:
      A Java Future containing the result of the UpdateUsagePlan 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateVpcLink

      default CompletableFuture<UpdateVpcLinkResponse> updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)

      Updates an existing VpcLink of a specified identifier.

      Parameters:
      updateVpcLinkRequest - Updates an existing VpcLink of a specified identifier.
      Returns:
      A Java Future containing the result of the UpdateVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • updateVpcLink

      default CompletableFuture<UpdateVpcLinkResponse> updateVpcLink(Consumer<UpdateVpcLinkRequest.Builder> updateVpcLinkRequest)

      Updates an existing VpcLink of a specified identifier.


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

      Parameters:
      updateVpcLinkRequest - A Consumer that will call methods on UpdateVpcLinkRequest.Builder to create a request. Updates an existing VpcLink of a specified identifier.
      Returns:
      A Java Future containing the result of the UpdateVpcLink 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.
      • BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
      • ConflictException The request configuration has conflicts. For details, see the accompanying error message.
      • LimitExceededException The request exceeded the rate limit. Retry after the specified time period.
      • NotFoundException The requested resource is not found. Make sure that the request URI is correct.
      • UnauthorizedException The request is denied because the caller has insufficient permissions.
      • TooManyRequestsException The request has reached its throttling limit. Retry after the specified time period.
      • 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.
      • ApiGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

    • serviceClientConfiguration

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

    • builder

      static ApiGatewayAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ApiGatewayAsyncClient.