software.amazon.awssdk.services.account

Interface AccountClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface AccountClient
extends SdkClient

Service client for accessing AWS Account. This can be created using the static builder() method.

Operations for Amazon Web Services Account Management

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static AccountClientBuilder	builder() Create a builder that can be used to configure and create a AccountClient.
static AccountClient	create() Create a AccountClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteAlternateContactResponse	deleteAlternateContact(Consumer<DeleteAlternateContactRequest.Builder> deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.
default DeleteAlternateContactResponse	deleteAlternateContact(DeleteAlternateContactRequest deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.
default GetAlternateContactResponse	getAlternateContact(Consumer<GetAlternateContactRequest.Builder> getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.
default GetAlternateContactResponse	getAlternateContact(GetAlternateContactRequest getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.
default GetContactInformationResponse	getContactInformation(Consumer<GetContactInformationRequest.Builder> getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.
default GetContactInformationResponse	getContactInformation(GetContactInformationRequest getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.
default PutAlternateContactResponse	putAlternateContact(Consumer<PutAlternateContactRequest.Builder> putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.
default PutAlternateContactResponse	putAlternateContact(PutAlternateContactRequest putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.
default PutContactInformationResponse	putContactInformation(Consumer<PutContactInformationRequest.Builder> putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.
default PutContactInformationResponse	putContactInformation(PutContactInformationRequest putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

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 the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static AccountClient create()

Create a AccountClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AccountClientBuilder builder()

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

deleteAlternateContact

default DeleteAlternateContactResponse deleteAlternateContact(DeleteAlternateContactRequest deleteAlternateContactRequest)
                                                       throws ResourceNotFoundException,
                                                              ValidationException,
                                                              AccessDeniedException,
                                                              TooManyRequestsException,
                                                              InternalServerException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              AccountException

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:

Result of the DeleteAlternateContact operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteAlternateContact

default DeleteAlternateContactResponse deleteAlternateContact(Consumer<DeleteAlternateContactRequest.Builder> deleteAlternateContactRequest)
                                                       throws ResourceNotFoundException,
                                                              ValidationException,
                                                              AccessDeniedException,
                                                              TooManyRequestsException,
                                                              InternalServerException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              AccountException

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()

Parameters:

deleteAlternateContactRequest - A Consumer that will call methods on DeleteAlternateContactRequest.Builder to create a request.

Returns:

Result of the DeleteAlternateContact operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getAlternateContact

default GetAlternateContactResponse getAlternateContact(GetAlternateContactRequest getAlternateContactRequest)
                                                 throws ResourceNotFoundException,
                                                        ValidationException,
                                                        AccessDeniedException,
                                                        TooManyRequestsException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        AccountException

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:

Result of the GetAlternateContact operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getAlternateContact

default GetAlternateContactResponse getAlternateContact(Consumer<GetAlternateContactRequest.Builder> getAlternateContactRequest)
                                                 throws ResourceNotFoundException,
                                                        ValidationException,
                                                        AccessDeniedException,
                                                        TooManyRequestsException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        AccountException

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()

Parameters:

getAlternateContactRequest - A Consumer that will call methods on GetAlternateContactRequest.Builder to create a request.

Returns:

Result of the GetAlternateContact operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getContactInformation

default GetContactInformationResponse getContactInformation(GetContactInformationRequest getContactInformationRequest)
                                                     throws ResourceNotFoundException,
                                                            ValidationException,
                                                            AccessDeniedException,
                                                            TooManyRequestsException,
                                                            InternalServerException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            AccountException

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:

Result of the GetContactInformation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getContactInformation

default GetContactInformationResponse getContactInformation(Consumer<GetContactInformationRequest.Builder> getContactInformationRequest)
                                                     throws ResourceNotFoundException,
                                                            ValidationException,
                                                            AccessDeniedException,
                                                            TooManyRequestsException,
                                                            InternalServerException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            AccountException

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()

Parameters:

getContactInformationRequest - A Consumer that will call methods on GetContactInformationRequest.Builder to create a request.

Returns:

Result of the GetContactInformation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putAlternateContact

default PutAlternateContactResponse putAlternateContact(PutAlternateContactRequest putAlternateContactRequest)
                                                 throws ValidationException,
                                                        AccessDeniedException,
                                                        TooManyRequestsException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        AccountException

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:

Result of the PutAlternateContact operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putAlternateContact

default PutAlternateContactResponse putAlternateContact(Consumer<PutAlternateContactRequest.Builder> putAlternateContactRequest)
                                                 throws ValidationException,
                                                        AccessDeniedException,
                                                        TooManyRequestsException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        AccountException

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()

Parameters:

putAlternateContactRequest - A Consumer that will call methods on PutAlternateContactRequest.Builder to create a request.

Returns:

Result of the PutAlternateContact operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putContactInformation

default PutContactInformationResponse putContactInformation(PutContactInformationRequest putContactInformationRequest)
                                                     throws ValidationException,
                                                            AccessDeniedException,
                                                            TooManyRequestsException,
                                                            InternalServerException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            AccountException

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:

Result of the PutContactInformation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

putContactInformation

default PutContactInformationResponse putContactInformation(Consumer<PutContactInformationRequest.Builder> putContactInformationRequest)
                                                     throws ValidationException,
                                                            AccessDeniedException,
                                                            TooManyRequestsException,
                                                            InternalServerException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            AccountException

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()

Parameters:

putContactInformationRequest - A Consumer that will call methods on PutContactInformationRequest.Builder to create a request.

Returns:

Result of the PutContactInformation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()