Interface AccountAccessAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface AccountAccessAsyncClient extends AwsClient
Service client for accessing Account Access 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.

Account access manager enables you to manage applications and entitlements that grant IAM Identity Center principals access to IAM roles across accounts.

  • Field Details

  • Method Details

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)

      Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance. This operation is idempotent; calling it multiple times with the same parameters returns the existing application.

      Parameters:
      createApplicationRequest -
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AlreadyCreatedException The resource you are trying to create already exists. To retrieve the existing resource, use the corresponding Get operation.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)

      Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance. This operation is idempotent; calling it multiple times with the same parameters returns the existing application.


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

      Parameters:
      createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AlreadyCreatedException The resource you are trying to create already exists. To retrieve the existing resource, use the corresponding Get operation.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createEntitlement

      default CompletableFuture<CreateEntitlementResponse> createEntitlement(CreateEntitlementRequest createEntitlementRequest)

      Creates an entitlement (assignment) in account access manager. An entitlement (assignment) grants a principal (IAM Identity Center user or group) permission to assume a specified IAM role in an Amazon Web Services account. This operation is idempotent.

      Parameters:
      createEntitlementRequest -
      Returns:
      A Java Future containing the result of the CreateEntitlement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • ServiceQuotaExceededException The request exceeds a service quota for your account.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createEntitlement

      default CompletableFuture<CreateEntitlementResponse> createEntitlement(Consumer<CreateEntitlementRequest.Builder> createEntitlementRequest)

      Creates an entitlement (assignment) in account access manager. An entitlement (assignment) grants a principal (IAM Identity Center user or group) permission to assume a specified IAM role in an Amazon Web Services account. This operation is idempotent.


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

      Parameters:
      createEntitlementRequest - A Consumer that will call methods on CreateEntitlementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEntitlement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • ServiceQuotaExceededException The request exceeds a service quota for your account.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

      Deletes an account access manager application. This operation is idempotent; deleting an application that has already been deleted does not return an error.

      Parameters:
      deleteApplicationRequest -
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)

      Deletes an account access manager application. This operation is idempotent; deleting an application that has already been deleted does not return an error.


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

      Parameters:
      deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteEntitlement

      default CompletableFuture<DeleteEntitlementResponse> deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest)

      Deletes an entitlement from an account access manager application. This operation is idempotent; deleting an entitlement that has already been deleted does not return an error.

      Parameters:
      deleteEntitlementRequest -
      Returns:
      A Java Future containing the result of the DeleteEntitlement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • deleteEntitlement

      default CompletableFuture<DeleteEntitlementResponse> deleteEntitlement(Consumer<DeleteEntitlementRequest.Builder> deleteEntitlementRequest)

      Deletes an entitlement from an account access manager application. This operation is idempotent; deleting an entitlement that has already been deleted does not return an error.


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

      Parameters:
      deleteEntitlementRequest - A Consumer that will call methods on DeleteEntitlementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEntitlement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ConflictException The request conflicts with the current state of the resource.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)

      Retrieves details about an account access manager application, including its status, identity source, and tags.

      Parameters:
      getApplicationRequest -
      Returns:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)

      Retrieves details about an account access manager application, including its status, identity source, and tags.


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

      Parameters:
      getApplicationRequest - A Consumer that will call methods on GetApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getEntitlement

      default CompletableFuture<GetEntitlementResponse> getEntitlement(GetEntitlementRequest getEntitlementRequest)

      Retrieves details about a specific entitlement for an account access manager application, including the principal, IAM role, and target account.

      Parameters:
      getEntitlementRequest -
      Returns:
      A Java Future containing the result of the GetEntitlement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getEntitlement

      default CompletableFuture<GetEntitlementResponse> getEntitlement(Consumer<GetEntitlementRequest.Builder> getEntitlementRequest)

      Retrieves details about a specific entitlement for an account access manager application, including the principal, IAM role, and target account.


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

      Parameters:
      getEntitlementRequest - A Consumer that will call methods on GetEntitlementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEntitlement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

      Lists the account access manager applications in your account. Use pagination to ensure that the operation returns quickly and successfully.

      Parameters:
      listApplicationsRequest -
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      Lists the account access manager applications in your account. Use pagination to ensure that the operation returns quickly and successfully.


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

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)

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

      Parameters:
      listApplicationsRequest -
      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.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

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


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

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.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.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listEntitlements

      default CompletableFuture<ListEntitlementsResponse> listEntitlements(ListEntitlementsRequest listEntitlementsRequest)

      Lists the entitlements for a specified account access manager application. You can filter results by principal, IAM role, or account. Use pagination to ensure that the operation returns quickly and successfully.

      Parameters:
      listEntitlementsRequest -
      Returns:
      A Java Future containing the result of the ListEntitlements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listEntitlements

      default CompletableFuture<ListEntitlementsResponse> listEntitlements(Consumer<ListEntitlementsRequest.Builder> listEntitlementsRequest)

      Lists the entitlements for a specified account access manager application. You can filter results by principal, IAM role, or account. Use pagination to ensure that the operation returns quickly and successfully.


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

      Parameters:
      listEntitlementsRequest - A Consumer that will call methods on ListEntitlementsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEntitlements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listEntitlementsPaginator

      default ListEntitlementsPublisher listEntitlementsPaginator(ListEntitlementsRequest listEntitlementsRequest)

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

      Parameters:
      listEntitlementsRequest -
      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.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listEntitlementsPaginator

      default ListEntitlementsPublisher listEntitlementsPaginator(Consumer<ListEntitlementsRequest.Builder> listEntitlementsRequest)

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


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

      Parameters:
      listEntitlementsRequest - A Consumer that will call methods on ListEntitlementsRequest.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.
      • AccessDeniedException You do not have sufficient access to perform this operation.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException 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 an account access manager 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.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException 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 an account access manager 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.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException 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 tags to an account access manager resource.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException 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 tags to an account access manager resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from an account access manager resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • untagResource

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

      Removes tags from an account access manager resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.
      • ThrottlingException The request was denied due to request throttling. Try your request again later.
      • ValidationException The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.
      • InternalServerException An internal service error occurred. Try your request 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.
      • AccountAccessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • waiter

      default AccountAccessAsyncWaiter waiter()
      Create an instance of AccountAccessAsyncWaiter using this client.

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

      Returns:
      an instance of AccountAccessAsyncWaiter
    • serviceClientConfiguration

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

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