Interface SupportAuthzAsyncClient

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

AWS Support Authorization

AWS SupportAuthZ enables you to control and authorize the actions that AWS support operators can perform on your resources. You create cryptographically signed support permits specifying which actions operators can perform, on which resources, and under what time-window conditions. Permits are signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

  • Field Details

  • Method Details

    • createSupportPermit

      default CompletableFuture<CreateSupportPermitResponse> createSupportPermit(CreateSupportPermitRequest createSupportPermitRequest)

      Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

      Parameters:
      createSupportPermitRequest -
      Returns:
      A Java Future containing the result of the CreateSupportPermit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ConflictException The request conflicts with the current state of the resource.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • ServiceQuotaExceededException The request exceeds a service quota for your account.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSupportPermit

      default CompletableFuture<CreateSupportPermitResponse> createSupportPermit(Consumer<CreateSupportPermitRequest.Builder> createSupportPermitRequest)

      Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.


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

      Parameters:
      createSupportPermitRequest - A Consumer that will call methods on CreateSupportPermitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSupportPermit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ConflictException The request conflicts with the current state of the resource.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • ServiceQuotaExceededException The request exceeds a service quota for your account.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSupportPermit

      default CompletableFuture<DeleteSupportPermitResponse> deleteSupportPermit(DeleteSupportPermitRequest deleteSupportPermitRequest)

      Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

      Parameters:
      deleteSupportPermitRequest -
      Returns:
      A Java Future containing the result of the DeleteSupportPermit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSupportPermit

      default CompletableFuture<DeleteSupportPermitResponse> deleteSupportPermit(Consumer<DeleteSupportPermitRequest.Builder> deleteSupportPermitRequest)

      Deletes a support permit, revoking the authorization previously granted to the AWS support operator.


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

      Parameters:
      deleteSupportPermitRequest - A Consumer that will call methods on DeleteSupportPermitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSupportPermit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAction

      default CompletableFuture<GetActionResponse> getAction(GetActionRequest getActionRequest)

      Retrieves the description of a specific support action.

      Parameters:
      getActionRequest -
      Returns:
      A Java Future containing the result of the GetAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAction

      default CompletableFuture<GetActionResponse> getAction(Consumer<GetActionRequest.Builder> getActionRequest)

      Retrieves the description of a specific support action.


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

      Parameters:
      getActionRequest - A Consumer that will call methods on GetActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSupportPermit

      default CompletableFuture<GetSupportPermitResponse> getSupportPermit(GetSupportPermitRequest getSupportPermitRequest)

      Retrieves the details of a support permit by its ARN or name.

      Parameters:
      getSupportPermitRequest -
      Returns:
      A Java Future containing the result of the GetSupportPermit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSupportPermit

      default CompletableFuture<GetSupportPermitResponse> getSupportPermit(Consumer<GetSupportPermitRequest.Builder> getSupportPermitRequest)

      Retrieves the details of a support permit by its ARN or name.


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

      Parameters:
      getSupportPermitRequest - A Consumer that will call methods on GetSupportPermitRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSupportPermit operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActions

      default CompletableFuture<ListActionsResponse> listActions(ListActionsRequest listActionsRequest)

      Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.

      Parameters:
      listActionsRequest -
      Returns:
      A Java Future containing the result of the ListActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActions

      default CompletableFuture<ListActionsResponse> listActions(Consumer<ListActionsRequest.Builder> listActionsRequest)

      Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.


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

      Parameters:
      listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActionsPaginator

      default ListActionsPublisher listActionsPaginator(ListActionsRequest listActionsRequest)

      This is a variant of listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) 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.supportauthz.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.supportauthz.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportauthz.model.ListActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.supportauthz.model.ListActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) operation.

      Parameters:
      listActionsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActionsPaginator

      default ListActionsPublisher listActionsPaginator(Consumer<ListActionsRequest.Builder> listActionsRequest)

      This is a variant of listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) 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.supportauthz.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.supportauthz.paginators.ListActionsPublisher publisher = client.listActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportauthz.model.ListActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.supportauthz.model.ListActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the listActions(software.amazon.awssdk.services.supportauthz.model.ListActionsRequest) operation.


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

      Parameters:
      listActionsRequest - A Consumer that will call methods on ListActionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermitRequests

      default CompletableFuture<ListSupportPermitRequestsResponse> listSupportPermitRequests(ListSupportPermitRequestsRequest listSupportPermitRequestsRequest)

      Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.

      Parameters:
      listSupportPermitRequestsRequest -
      Returns:
      A Java Future containing the result of the ListSupportPermitRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermitRequests

      default CompletableFuture<ListSupportPermitRequestsResponse> listSupportPermitRequests(Consumer<ListSupportPermitRequestsRequest.Builder> listSupportPermitRequestsRequest)

      Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.


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

      Parameters:
      listSupportPermitRequestsRequest - A Consumer that will call methods on ListSupportPermitRequestsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSupportPermitRequests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermitRequestsPaginator

      default ListSupportPermitRequestsPublisher listSupportPermitRequestsPaginator(ListSupportPermitRequestsRequest listSupportPermitRequestsRequest)

      This is a variant of listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) 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.supportauthz.paginators.ListSupportPermitRequestsPublisher publisher = client.listSupportPermitRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitRequestsPublisher publisher = client.listSupportPermitRequestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) operation.

      Parameters:
      listSupportPermitRequestsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermitRequestsPaginator

      default ListSupportPermitRequestsPublisher listSupportPermitRequestsPaginator(Consumer<ListSupportPermitRequestsRequest.Builder> listSupportPermitRequestsRequest)

      This is a variant of listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) 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.supportauthz.paginators.ListSupportPermitRequestsPublisher publisher = client.listSupportPermitRequestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitRequestsPublisher publisher = client.listSupportPermitRequestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the listSupportPermitRequests(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitRequestsRequest) operation.


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

      Parameters:
      listSupportPermitRequestsRequest - A Consumer that will call methods on ListSupportPermitRequestsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermits

      default CompletableFuture<ListSupportPermitsResponse> listSupportPermits(ListSupportPermitsRequest listSupportPermitsRequest)

      Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.

      Parameters:
      listSupportPermitsRequest -
      Returns:
      A Java Future containing the result of the ListSupportPermits operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermits

      default CompletableFuture<ListSupportPermitsResponse> listSupportPermits(Consumer<ListSupportPermitsRequest.Builder> listSupportPermitsRequest)

      Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.


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

      Parameters:
      listSupportPermitsRequest - A Consumer that will call methods on ListSupportPermitsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSupportPermits operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermitsPaginator

      default ListSupportPermitsPublisher listSupportPermitsPaginator(ListSupportPermitsRequest listSupportPermitsRequest)

      This is a variant of listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) 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.supportauthz.paginators.ListSupportPermitsPublisher publisher = client.listSupportPermitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitsPublisher publisher = client.listSupportPermitsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) operation.

      Parameters:
      listSupportPermitsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSupportPermitsPaginator

      default ListSupportPermitsPublisher listSupportPermitsPaginator(Consumer<ListSupportPermitsRequest.Builder> listSupportPermitsRequest)

      This is a variant of listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) 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.supportauthz.paginators.ListSupportPermitsPublisher publisher = client.listSupportPermitsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.supportauthz.paginators.ListSupportPermitsPublisher publisher = client.listSupportPermitsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the listSupportPermits(software.amazon.awssdk.services.supportauthz.model.ListSupportPermitsRequest) operation.


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

      Parameters:
      listSupportPermitsRequest - A Consumer that will call methods on ListSupportPermitsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags associated with a support permit resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

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

      Lists the tags associated with a support permit resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rejectSupportPermitRequest

      default CompletableFuture<RejectSupportPermitRequestResponse> rejectSupportPermitRequest(RejectSupportPermitRequestRequest rejectSupportPermitRequestRequest)

      Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

      Parameters:
      rejectSupportPermitRequestRequest -
      Returns:
      A Java Future containing the result of the RejectSupportPermitRequest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ConflictException The request conflicts with the current state of the resource.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rejectSupportPermitRequest

      default CompletableFuture<RejectSupportPermitRequestResponse> rejectSupportPermitRequest(Consumer<RejectSupportPermitRequestRequest.Builder> rejectSupportPermitRequestRequest)

      Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.


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

      Parameters:
      rejectSupportPermitRequestRequest - A Consumer that will call methods on RejectSupportPermitRequestRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RejectSupportPermitRequest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ConflictException The request conflicts with the current state of the resource.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds or overwrites one or more tags for a support permit resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

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

      Adds or overwrites one or more tags for a support permit resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from a support permit resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

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

      Removes one or more tags from a support permit resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by the service.
      • ResourceNotFoundException The specified resource does not exist.
      • AccessDeniedException You don't have sufficient permissions to perform this operation.
      • ThrottlingException The request rate exceeded the allowed limit. Try again later.
      • InternalServerException An internal service error occurred. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SupportAuthzException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static SupportAuthzAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SupportAuthzAsyncClient.