com.amazonaws.services.account

Interface AWSAccount

All Known Subinterfaces:

AWSAccountAsync

All Known Implementing Classes:

AbstractAWSAccount, AbstractAWSAccountAsync, AWSAccountAsyncClient, AWSAccountClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAccount

Interface for accessing AWS Account.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAccount instead.

Operations for Amazon Web Services Account Management

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptPrimaryEmailUpdateResult	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.
DeleteAlternateContactResult	deleteAlternateContact(DeleteAlternateContactRequest deleteAlternateContactRequest) Deletes the specified alternate contact from an Amazon Web Services account.
DisableRegionResult	disableRegion(DisableRegionRequest disableRegionRequest) Disables (opts-out) a particular Region for an account.
EnableRegionResult	enableRegion(EnableRegionRequest enableRegionRequest) Enables (opts-in) a particular Region for an account.
GetAlternateContactResult	getAlternateContact(GetAlternateContactRequest getAlternateContactRequest) Retrieves the specified alternate contact attached to an Amazon Web Services account.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetContactInformationResult	getContactInformation(GetContactInformationRequest getContactInformationRequest) Retrieves the primary contact information of an Amazon Web Services account.
GetPrimaryEmailResult	getPrimaryEmail(GetPrimaryEmailRequest getPrimaryEmailRequest) Retrieves the primary email address for the specified account.
GetRegionOptStatusResult	getRegionOptStatus(GetRegionOptStatusRequest getRegionOptStatusRequest) Retrieves the opt-in status of a particular Region.
ListRegionsResult	listRegions(ListRegionsRequest listRegionsRequest) Lists all the Regions for a given account and their respective opt-in statuses.
PutAlternateContactResult	putAlternateContact(PutAlternateContactRequest putAlternateContactRequest) Modifies the specified alternate contact attached to an Amazon Web Services account.
PutContactInformationResult	putContactInformation(PutContactInformationRequest putContactInformationRequest) Updates the primary contact information of an Amazon Web Services account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartPrimaryEmailUpdateResult	startPrimaryEmailUpdate(StartPrimaryEmailUpdateRequest startPrimaryEmailUpdateRequest) Starts the process to update the primary email address for the specified account.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptPrimaryEmailUpdate

AcceptPrimaryEmailUpdateResult 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:

Result of the AcceptPrimaryEmailUpdate 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.

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.

See Also:

AWS API Documentation

deleteAlternateContact

DeleteAlternateContactResult 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:

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.

See Also:

AWS API Documentation

disableRegion

DisableRegionResult 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:

Result of the DisableRegion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

enableRegion

EnableRegionResult enableRegion(EnableRegionRequest enableRegionRequest)

Enables (opts-in) a particular Region for an account.

Parameters:

enableRegionRequest -

Returns:

Result of the EnableRegion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAlternateContact

GetAlternateContactResult 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:

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.

See Also:

AWS API Documentation

getContactInformation

GetContactInformationResult 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:

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.

See Also:

AWS API Documentation

getPrimaryEmail

GetPrimaryEmailResult getPrimaryEmail(GetPrimaryEmailRequest getPrimaryEmailRequest)

Retrieves the primary email address for the specified account.

Parameters:

getPrimaryEmailRequest -

Returns:

Result of the GetPrimaryEmail 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.

See Also:

AWS API Documentation

getRegionOptStatus

GetRegionOptStatusResult getRegionOptStatus(GetRegionOptStatusRequest getRegionOptStatusRequest)

Retrieves the opt-in status of a particular Region.

Parameters:

getRegionOptStatusRequest -

Returns:

Result of the GetRegionOptStatus 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.

See Also:

AWS API Documentation

listRegions

ListRegionsResult 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.

Parameters:

listRegionsRequest -

Returns:

Result of the ListRegions 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.

See Also:

AWS API Documentation

putAlternateContact

PutAlternateContactResult 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:

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.

See Also:

AWS API Documentation

putContactInformation

PutContactInformationResult 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:

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.

See Also:

AWS API Documentation

startPrimaryEmailUpdate

StartPrimaryEmailUpdateResult startPrimaryEmailUpdate(StartPrimaryEmailUpdateRequest startPrimaryEmailUpdateRequest)

Starts the process to update the primary email address for the specified account.

Parameters:

startPrimaryEmailUpdateRequest -

Returns:

Result of the StartPrimaryEmailUpdate 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.

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.