Interface AccountAccessAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aAccountAccessAsyncClient.static AccountAccessAsyncClientcreate()Create aAccountAccessAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.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.createApplication(CreateApplicationRequest createApplicationRequest) Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance.createEntitlement(Consumer<CreateEntitlementRequest.Builder> createEntitlementRequest) Creates an entitlement (assignment) in account access manager.createEntitlement(CreateEntitlementRequest createEntitlementRequest) Creates an entitlement (assignment) in account access manager.deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an account access manager application.deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an account access manager application.deleteEntitlement(Consumer<DeleteEntitlementRequest.Builder> deleteEntitlementRequest) Deletes an entitlement from an account access manager application.deleteEntitlement(DeleteEntitlementRequest deleteEntitlementRequest) Deletes an entitlement from an account access manager application.default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Retrieves details about an account access manager application, including its status, identity source, and tags.default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Retrieves details about an account access manager application, including its status, identity source, and tags.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.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.listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists the account access manager applications in your account.listApplications(ListApplicationsRequest listApplicationsRequest) Lists the account access manager applications in your account.default ListApplicationsPublisherlistApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.accountaccess.model.ListApplicationsRequest)operation.default ListApplicationsPublisherlistApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.accountaccess.model.ListApplicationsRequest)operation.listEntitlements(Consumer<ListEntitlementsRequest.Builder> listEntitlementsRequest) Lists the entitlements for a specified account access manager application.listEntitlements(ListEntitlementsRequest listEntitlementsRequest) Lists the entitlements for a specified account access manager application.default ListEntitlementsPublisherlistEntitlementsPaginator(Consumer<ListEntitlementsRequest.Builder> listEntitlementsRequest) This is a variant oflistEntitlements(software.amazon.awssdk.services.accountaccess.model.ListEntitlementsRequest)operation.default ListEntitlementsPublisherlistEntitlementsPaginator(ListEntitlementsRequest listEntitlementsRequest) This is a variant oflistEntitlements(software.amazon.awssdk.services.accountaccess.model.ListEntitlementsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with an account access manager resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with an account access manager resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds tags to an account access manager resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds tags to an account access manager resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an account access manager resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an account access manager resource.default AccountAccessAsyncWaiterwaiter()Create an instance ofAccountAccessAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
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 invokeThrowable.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.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
createApplicationRequest- AConsumerthat will call methods onCreateApplicationRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaCreateEntitlementRequest.builder()- Parameters:
createEntitlementRequest- AConsumerthat will call methods onCreateEntitlementRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
deleteApplicationRequest- AConsumerthat will call methods onDeleteApplicationRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaDeleteEntitlementRequest.builder()- Parameters:
deleteEntitlementRequest- AConsumerthat will call methods onDeleteEntitlementRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
getApplicationRequest- AConsumerthat will call methods onGetApplicationRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaGetEntitlementRequest.builder()- Parameters:
getEntitlementRequest- AConsumerthat will call methods onGetEntitlementRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.accountaccess.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.accountaccess.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListEntitlementsRequest.builder()- Parameters:
listEntitlementsRequest- AConsumerthat will call methods onListEntitlementsRequest.Builderto 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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.accountaccess.paginators.ListEntitlementsPublisher publisher = client.listEntitlementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.accountaccess.paginators.ListEntitlementsPublisher publisher = client.listEntitlementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListEntitlementsRequest.builder()- Parameters:
listEntitlementsRequest- AConsumerthat will call methods onListEntitlementsRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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 invokeThrowable.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
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 invokeThrowable.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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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 invokeThrowable.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 invokeThrowable.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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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 invokeThrowable.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
Create an instance ofAccountAccessAsyncWaiterusing 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
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aAccountAccessAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aAccountAccessAsyncClient.
-