@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AccountAsyncClient extends AwsClient
builder()
method.
Operations for Amazon Web Services Account Management
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static AccountAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
AccountAsyncClient. |
static AccountAsyncClient |
create()
Create a
AccountAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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<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 ListRegionsPublisher |
listRegionsPaginator(Consumer<ListRegionsRequest.Builder> listRegionsRequest)
Lists all the Regions for a given account and their respective opt-in statuses.
|
default ListRegionsPublisher |
listRegionsPaginator(ListRegionsRequest listRegionsRequest)
Lists all the Regions for a given account and their respective opt-in statuses.
|
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 AccountServiceClientConfiguration |
serviceClientConfiguration() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
deleteAlternateContactRequest - 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 via DeleteAlternateContactRequest.builder()
deleteAlternateContactRequest - A Consumer that will call methods on DeleteAlternateContactRequest.Builder to create a
request.default CompletableFuture<DisableRegionResponse> disableRegion(DisableRegionRequest disableRegionRequest)
Disables (opts-out) a particular Region for an account.
disableRegionRequest - 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 via DisableRegionRequest.builder()
disableRegionRequest - A Consumer that will call methods on DisableRegionRequest.Builder to create a request.default CompletableFuture<EnableRegionResponse> enableRegion(EnableRegionRequest enableRegionRequest)
Enables (opts-in) a particular Region for an account.
enableRegionRequest - 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 via EnableRegionRequest.builder()
enableRegionRequest - A Consumer that will call methods on EnableRegionRequest.Builder to create a request.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.
getAlternateContactRequest - 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 via GetAlternateContactRequest.builder()
getAlternateContactRequest - A Consumer that will call methods on GetAlternateContactRequest.Builder to create a
request.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.
getContactInformationRequest - 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 via GetContactInformationRequest.builder()
getContactInformationRequest - A Consumer that will call methods on GetContactInformationRequest.Builder to create a
request.default CompletableFuture<GetRegionOptStatusResponse> getRegionOptStatus(GetRegionOptStatusRequest getRegionOptStatusRequest)
Retrieves the opt-in status of a particular Region.
getRegionOptStatusRequest - 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 via GetRegionOptStatusRequest.builder()
getRegionOptStatusRequest - A Consumer that will call methods on GetRegionOptStatusRequest.Builder to create a
request.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-contains parameter.
listRegionsRequest - 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 via ListRegionsRequest.builder()
listRegionsRequest - A Consumer that will call methods on ListRegionsRequest.Builder to create a request.default ListRegionsPublisher listRegionsPaginator(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-contains parameter.
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 new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRegions(software.amazon.awssdk.services.account.model.ListRegionsRequest) operation.
listRegionsRequest - default ListRegionsPublisher listRegionsPaginator(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 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 new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.account.paginators.ListRegionsPublisher publisher = client.listRegionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 via ListRegionsRequest.builder()
listRegionsRequest - A Consumer that will call methods on ListRegionsRequest.Builder to create a request.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.
putAlternateContactRequest - 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 via PutAlternateContactRequest.builder()
putAlternateContactRequest - A Consumer that will call methods on PutAlternateContactRequest.Builder to create a
request.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.
putContactInformationRequest - 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 via PutContactInformationRequest.builder()
putContactInformationRequest - A Consumer that will call methods on PutContactInformationRequest.Builder to create a
request.default AccountServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic AccountAsyncClient create()
AccountAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AccountAsyncClientBuilder builder()
AccountAsyncClient.Copyright © 2023. All rights reserved.