Interface AccountAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Operations for Amazon Web Services Account Management
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AccountAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAccountAsyncClient
.static AccountAsyncClient
create()
Create aAccountAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteAlternateContact
(Consumer<DeleteAlternateContactRequest.Builder> deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.deleteAlternateContact
(DeleteAlternateContactRequest deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.default CompletableFuture
<DisableRegionResponse> disableRegion
(Consumer<DisableRegionRequest.Builder> disableRegionRequest) Disables (opts-out) a particular Region for an account.default CompletableFuture
<DisableRegionResponse> disableRegion
(DisableRegionRequest disableRegionRequest) Disables (opts-out) a particular Region for an account.default CompletableFuture
<EnableRegionResponse> enableRegion
(Consumer<EnableRegionRequest.Builder> enableRegionRequest) Enables (opts-in) a particular Region for an account.default CompletableFuture
<EnableRegionResponse> enableRegion
(EnableRegionRequest enableRegionRequest) Enables (opts-in) a particular Region for an account.getAlternateContact
(Consumer<GetAlternateContactRequest.Builder> getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.getAlternateContact
(GetAlternateContactRequest getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.getContactInformation
(Consumer<GetContactInformationRequest.Builder> getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.getContactInformation
(GetContactInformationRequest getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.getRegionOptStatus
(Consumer<GetRegionOptStatusRequest.Builder> getRegionOptStatusRequest) Retrieves the opt-in status of a particular Region.getRegionOptStatus
(GetRegionOptStatusRequest getRegionOptStatusRequest) Retrieves the opt-in status of a particular Region.default CompletableFuture
<ListRegionsResponse> listRegions
(Consumer<ListRegionsRequest.Builder> listRegionsRequest) Lists all the Regions for a given account and their respective opt-in statuses.default CompletableFuture
<ListRegionsResponse> listRegions
(ListRegionsRequest listRegionsRequest) Lists all the Regions for a given account and their respective opt-in statuses.default ListRegionsPublisher
listRegionsPaginator
(Consumer<ListRegionsRequest.Builder> listRegionsRequest) This is a variant oflistRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)
operation.default ListRegionsPublisher
listRegionsPaginator
(ListRegionsRequest listRegionsRequest) This is a variant oflistRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)
operation.putAlternateContact
(Consumer<PutAlternateContactRequest.Builder> putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.putAlternateContact
(PutAlternateContactRequest putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.putContactInformation
(Consumer<PutContactInformationRequest.Builder> putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.putContactInformation
(PutContactInformationRequest putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods 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
-
deleteAlternateContact
default CompletableFuture<DeleteAlternateContactResponse> deleteAlternateContact(DeleteAlternateContactRequest deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
- Parameters:
deleteAlternateContactRequest
-- Returns:
- A Java Future containing the result of the DeleteAlternateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation failed because it specified a resource that can't be found.
- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlternateContact
default CompletableFuture<DeleteAlternateContactResponse> deleteAlternateContact(Consumer<DeleteAlternateContactRequest.Builder> deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
This is a convenience which creates an instance of the
DeleteAlternateContactRequest.Builder
avoiding the need to create one manually viaDeleteAlternateContactRequest.builder()
- Parameters:
deleteAlternateContactRequest
- AConsumer
that will call methods onDeleteAlternateContactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAlternateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation failed because it specified a resource that can't be found.
- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableRegion
default CompletableFuture<DisableRegionResponse> disableRegion(DisableRegionRequest disableRegionRequest) Disables (opts-out) a particular Region for an account.
- Parameters:
disableRegionRequest
-- Returns:
- A Java Future containing the result of the DisableRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableRegion
default CompletableFuture<DisableRegionResponse> disableRegion(Consumer<DisableRegionRequest.Builder> disableRegionRequest) Disables (opts-out) a particular Region for an account.
This is a convenience which creates an instance of the
DisableRegionRequest.Builder
avoiding the need to create one manually viaDisableRegionRequest.builder()
- Parameters:
disableRegionRequest
- AConsumer
that will call methods onDisableRegionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableRegion
default CompletableFuture<EnableRegionResponse> enableRegion(EnableRegionRequest enableRegionRequest) Enables (opts-in) a particular Region for an account.
- Parameters:
enableRegionRequest
-- Returns:
- A Java Future containing the result of the EnableRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableRegion
default CompletableFuture<EnableRegionResponse> enableRegion(Consumer<EnableRegionRequest.Builder> enableRegionRequest) Enables (opts-in) a particular Region for an account.
This is a convenience which creates an instance of the
EnableRegionRequest.Builder
avoiding the need to create one manually viaEnableRegionRequest.builder()
- Parameters:
enableRegionRequest
- AConsumer
that will call methods onEnableRegionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAlternateContact
default CompletableFuture<GetAlternateContactResponse> getAlternateContact(GetAlternateContactRequest getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
- Parameters:
getAlternateContactRequest
-- Returns:
- A Java Future containing the result of the GetAlternateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation failed because it specified a resource that can't be found.
- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAlternateContact
default CompletableFuture<GetAlternateContactResponse> getAlternateContact(Consumer<GetAlternateContactRequest.Builder> getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
This is a convenience which creates an instance of the
GetAlternateContactRequest.Builder
avoiding the need to create one manually viaGetAlternateContactRequest.builder()
- Parameters:
getAlternateContactRequest
- AConsumer
that will call methods onGetAlternateContactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAlternateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation failed because it specified a resource that can't be found.
- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContactInformation
default CompletableFuture<GetContactInformationResponse> getContactInformation(GetContactInformationRequest getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
- Parameters:
getContactInformationRequest
-- Returns:
- A Java Future containing the result of the GetContactInformation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation failed because it specified a resource that can't be found.
- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContactInformation
default CompletableFuture<GetContactInformationResponse> getContactInformation(Consumer<GetContactInformationRequest.Builder> getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
This is a convenience which creates an instance of the
GetContactInformationRequest.Builder
avoiding the need to create one manually viaGetContactInformationRequest.builder()
- Parameters:
getContactInformationRequest
- AConsumer
that will call methods onGetContactInformationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetContactInformation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The operation failed because it specified a resource that can't be found.
- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegionOptStatus
default CompletableFuture<GetRegionOptStatusResponse> getRegionOptStatus(GetRegionOptStatusRequest getRegionOptStatusRequest) Retrieves the opt-in status of a particular Region.
- Parameters:
getRegionOptStatusRequest
-- Returns:
- A Java Future containing the result of the GetRegionOptStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegionOptStatus
default CompletableFuture<GetRegionOptStatusResponse> getRegionOptStatus(Consumer<GetRegionOptStatusRequest.Builder> getRegionOptStatusRequest) Retrieves the opt-in status of a particular Region.
This is a convenience which creates an instance of the
GetRegionOptStatusRequest.Builder
avoiding the need to create one manually viaGetRegionOptStatusRequest.builder()
- Parameters:
getRegionOptStatusRequest
- AConsumer
that will call methods onGetRegionOptStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRegionOptStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegions
Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the
region-opt-status-contains
parameter.- Parameters:
listRegionsRequest
-- Returns:
- A Java Future containing the result of the ListRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegions
default CompletableFuture<ListRegionsResponse> listRegions(Consumer<ListRegionsRequest.Builder> listRegionsRequest) Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the
region-opt-status-contains
parameter.
This is a convenience which creates an instance of the
ListRegionsRequest.Builder
avoiding the need to create one manually viaListRegionsRequest.builder()
- Parameters:
listRegionsRequest
- AConsumer
that will call methods onListRegionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRegions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegionsPaginator
This is a variant of
listRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.account.model.ListRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.account.model.ListRegionsResponse 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
listRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)
operation.- Parameters:
listRegionsRequest
-- 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.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegionsPaginator
default ListRegionsPublisher listRegionsPaginator(Consumer<ListRegionsRequest.Builder> listRegionsRequest) This is a variant of
listRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.account.model.ListRegionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.account.model.ListRegionsResponse 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
listRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)
operation.
This is a convenience which creates an instance of the
ListRegionsRequest.Builder
avoiding the need to create one manually viaListRegionsRequest.builder()
- Parameters:
listRegionsRequest
- AConsumer
that will call methods onListRegionsRequest.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.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAlternateContact
default CompletableFuture<PutAlternateContactResponse> putAlternateContact(PutAlternateContactRequest putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
- Parameters:
putAlternateContactRequest
-- Returns:
- A Java Future containing the result of the PutAlternateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAlternateContact
default CompletableFuture<PutAlternateContactResponse> putAlternateContact(Consumer<PutAlternateContactRequest.Builder> putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management.
This is a convenience which creates an instance of the
PutAlternateContactRequest.Builder
avoiding the need to create one manually viaPutAlternateContactRequest.builder()
- Parameters:
putAlternateContactRequest
- AConsumer
that will call methods onPutAlternateContactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAlternateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putContactInformation
default CompletableFuture<PutContactInformationResponse> putContactInformation(PutContactInformationRequest putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
- Parameters:
putContactInformationRequest
-- Returns:
- A Java Future containing the result of the PutContactInformation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putContactInformation
default CompletableFuture<PutContactInformationResponse> putContactInformation(Consumer<PutContactInformationRequest.Builder> putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
This is a convenience which creates an instance of the
PutContactInformationRequest.Builder
avoiding the need to create one manually viaPutContactInformationRequest.builder()
- Parameters:
putContactInformationRequest
- AConsumer
that will call methods onPutContactInformationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutContactInformation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The operation failed because one of the input parameters was invalid.
- AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
- TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
- InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation 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.
- AccountException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAccountAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAccountAsyncClient
.
-