Interface AccountAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AccountAsyncClient extends AwsClient
Service client for accessing AWS Account asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported 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.Operations for Amazon Web Services Account Management
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default CompletableFuture<AcceptPrimaryEmailUpdateResponse>acceptPrimaryEmailUpdate(Consumer<AcceptPrimaryEmailUpdateRequest.Builder> acceptPrimaryEmailUpdateRequest)Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.default CompletableFuture<AcceptPrimaryEmailUpdateResponse>acceptPrimaryEmailUpdate(AcceptPrimaryEmailUpdateRequest acceptPrimaryEmailUpdateRequest)Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.static AccountAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aAccountAsyncClient.static AccountAsyncClientcreate()Create aAccountAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<DeleteAlternateContactResponse>deleteAlternateContact(Consumer<DeleteAlternateContactRequest.Builder> deleteAlternateContactRequest)Deletes the specified alternate contact from an Amazon Web Services account.default CompletableFuture<DeleteAlternateContactResponse>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.default CompletableFuture<GetAlternateContactResponse>getAlternateContact(Consumer<GetAlternateContactRequest.Builder> getAlternateContactRequest)Retrieves the specified alternate contact attached to an Amazon Web Services account.default CompletableFuture<GetAlternateContactResponse>getAlternateContact(GetAlternateContactRequest getAlternateContactRequest)Retrieves the specified alternate contact attached to an Amazon Web Services account.default CompletableFuture<GetContactInformationResponse>getContactInformation(Consumer<GetContactInformationRequest.Builder> getContactInformationRequest)Retrieves the primary contact information of an Amazon Web Services account.default CompletableFuture<GetContactInformationResponse>getContactInformation(GetContactInformationRequest getContactInformationRequest)Retrieves the primary contact information of an Amazon Web Services account.default CompletableFuture<GetPrimaryEmailResponse>getPrimaryEmail(Consumer<GetPrimaryEmailRequest.Builder> getPrimaryEmailRequest)Retrieves the primary email address for the specified account.default CompletableFuture<GetPrimaryEmailResponse>getPrimaryEmail(GetPrimaryEmailRequest getPrimaryEmailRequest)Retrieves the primary email address for the specified account.default CompletableFuture<GetRegionOptStatusResponse>getRegionOptStatus(Consumer<GetRegionOptStatusRequest.Builder> getRegionOptStatusRequest)Retrieves the opt-in status of a particular Region.default CompletableFuture<GetRegionOptStatusResponse>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 ListRegionsPublisherlistRegionsPaginator(Consumer<ListRegionsRequest.Builder> listRegionsRequest)This is a variant oflistRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)operation.default ListRegionsPublisherlistRegionsPaginator(ListRegionsRequest listRegionsRequest)This is a variant oflistRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest)operation.default CompletableFuture<PutAlternateContactResponse>putAlternateContact(Consumer<PutAlternateContactRequest.Builder> putAlternateContactRequest)Modifies the specified alternate contact attached to an Amazon Web Services account.default CompletableFuture<PutAlternateContactResponse>putAlternateContact(PutAlternateContactRequest putAlternateContactRequest)Modifies the specified alternate contact attached to an Amazon Web Services account.default CompletableFuture<PutContactInformationResponse>putContactInformation(Consumer<PutContactInformationRequest.Builder> putContactInformationRequest)Updates the primary contact information of an Amazon Web Services account.default CompletableFuture<PutContactInformationResponse>putContactInformation(PutContactInformationRequest putContactInformationRequest)Updates the primary contact information of an Amazon Web Services account.default AccountServiceClientConfigurationserviceClientConfiguration()default CompletableFuture<StartPrimaryEmailUpdateResponse>startPrimaryEmailUpdate(Consumer<StartPrimaryEmailUpdateRequest.Builder> startPrimaryEmailUpdateRequest)Starts the process to update the primary email address for the specified account.default CompletableFuture<StartPrimaryEmailUpdateResponse>startPrimaryEmailUpdate(StartPrimaryEmailUpdateRequest startPrimaryEmailUpdateRequest)Starts the process to update the primary email address for the specified account.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptPrimaryEmailUpdate
default CompletableFuture<AcceptPrimaryEmailUpdateResponse> acceptPrimaryEmailUpdate(AcceptPrimaryEmailUpdateRequest acceptPrimaryEmailUpdateRequest)
Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
- Parameters:
acceptPrimaryEmailUpdateRequest-- Returns:
- A Java Future containing the result of the AcceptPrimaryEmailUpdate operation returned by the service.
The 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 operation failed because it specified a resource that can't be found.
- 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:
- AWS API Documentation
-
acceptPrimaryEmailUpdate
default CompletableFuture<AcceptPrimaryEmailUpdateResponse> acceptPrimaryEmailUpdate(Consumer<AcceptPrimaryEmailUpdateRequest.Builder> acceptPrimaryEmailUpdateRequest)
Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
This is a convenience which creates an instance of the
AcceptPrimaryEmailUpdateRequest.Builderavoiding the need to create one manually viaAcceptPrimaryEmailUpdateRequest.builder()- Parameters:
acceptPrimaryEmailUpdateRequest- AConsumerthat will call methods onAcceptPrimaryEmailUpdateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptPrimaryEmailUpdate operation returned by the service.
The 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 operation failed because it specified a resource that can't be found.
- 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAlternateContactRequest.builder()- Parameters:
deleteAlternateContactRequest- AConsumerthat will call methods onDeleteAlternateContactRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
disableRegion
default CompletableFuture<DisableRegionResponse> disableRegion(DisableRegionRequest disableRegionRequest)
Disables (opts-out) a particular Region for an account.
The act of disabling a Region will remove all IAM access to any resources that reside in that Region.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
disableRegion
default CompletableFuture<DisableRegionResponse> disableRegion(Consumer<DisableRegionRequest.Builder> disableRegionRequest)
Disables (opts-out) a particular Region for an account.
The act of disabling a Region will remove all IAM access to any resources that reside in that Region.
This is a convenience which creates an instance of the
DisableRegionRequest.Builderavoiding the need to create one manually viaDisableRegionRequest.builder()- Parameters:
disableRegionRequest- AConsumerthat will call methods onDisableRegionRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaEnableRegionRequest.builder()- Parameters:
enableRegionRequest- AConsumerthat will call methods onEnableRegionRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAlternateContactRequest.builder()- Parameters:
getAlternateContactRequest- AConsumerthat will call methods onGetAlternateContactRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetContactInformationRequest.builder()- Parameters:
getContactInformationRequest- AConsumerthat will call methods onGetContactInformationRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
getPrimaryEmail
default CompletableFuture<GetPrimaryEmailResponse> getPrimaryEmail(GetPrimaryEmailRequest getPrimaryEmailRequest)
Retrieves the primary email address for the specified account.
- Parameters:
getPrimaryEmailRequest-- Returns:
- A Java Future containing the result of the GetPrimaryEmail operation returned by the service.
The 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 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:
- AWS API Documentation
-
getPrimaryEmail
default CompletableFuture<GetPrimaryEmailResponse> getPrimaryEmail(Consumer<GetPrimaryEmailRequest.Builder> getPrimaryEmailRequest)
Retrieves the primary email address for the specified account.
This is a convenience which creates an instance of the
GetPrimaryEmailRequest.Builderavoiding the need to create one manually viaGetPrimaryEmailRequest.builder()- Parameters:
getPrimaryEmailRequest- AConsumerthat will call methods onGetPrimaryEmailRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetPrimaryEmail operation returned by the service.
The 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 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetRegionOptStatusRequest.builder()- Parameters:
getRegionOptStatusRequest- AConsumerthat will call methods onGetRegionOptStatusRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
listRegions
default CompletableFuture<ListRegionsResponse> listRegions(ListRegionsRequest 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-containsparameter.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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-containsparameter.
This is a convenience which creates an instance of the
ListRegionsRequest.Builderavoiding the need to create one manually viaListRegionsRequest.builder()- Parameters:
listRegionsRequest- AConsumerthat will call methods onListRegionsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
listRegionsPaginator
default ListRegionsPublisher listRegionsPaginator(ListRegionsRequest 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 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.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(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.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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 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.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(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.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.Builderavoiding the need to create one manually viaListRegionsRequest.builder()- Parameters:
listRegionsRequest- AConsumerthat will call methods onListRegionsRequest.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.- 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPutAlternateContactRequest.builder()- Parameters:
putAlternateContactRequest- AConsumerthat will call methods onPutAlternateContactRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaPutContactInformationRequest.builder()- Parameters:
putContactInformationRequest- AConsumerthat will call methods onPutContactInformationRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
- AWS API Documentation
-
startPrimaryEmailUpdate
default CompletableFuture<StartPrimaryEmailUpdateResponse> startPrimaryEmailUpdate(StartPrimaryEmailUpdateRequest startPrimaryEmailUpdateRequest)
Starts the process to update the primary email address for the specified account.
- Parameters:
startPrimaryEmailUpdateRequest-- Returns:
- A Java Future containing the result of the StartPrimaryEmailUpdate operation returned by the service.
The 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 operation failed because it specified a resource that can't be found.
- 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:
- AWS API Documentation
-
startPrimaryEmailUpdate
default CompletableFuture<StartPrimaryEmailUpdateResponse> startPrimaryEmailUpdate(Consumer<StartPrimaryEmailUpdateRequest.Builder> startPrimaryEmailUpdateRequest)
Starts the process to update the primary email address for the specified account.
This is a convenience which creates an instance of the
StartPrimaryEmailUpdateRequest.Builderavoiding the need to create one manually viaStartPrimaryEmailUpdateRequest.builder()- Parameters:
startPrimaryEmailUpdateRequest- AConsumerthat will call methods onStartPrimaryEmailUpdateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartPrimaryEmailUpdate operation returned by the service.
The 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 operation failed because it specified a resource that can't be found.
- 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:
- AWS API Documentation
-
serviceClientConfiguration
default AccountServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static AccountAsyncClient create()
Create aAccountAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static AccountAsyncClientBuilder builder()
Create a builder that can be used to configure and create aAccountAsyncClient.
-
-