com.amazonaws.services.account.AWSAccount Maven / Gradle / Ivy
Show all versions of aws-java-sdk-account Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.account;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.account.model.*;
/**
* Interface for accessing AWS Account.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.account.AbstractAWSAccount} instead.
*
*
*
* Operations for Amazon Web Services Account Management
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAccount {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "account";
/**
*
* 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.
*
*
* @param acceptPrimaryEmailUpdateRequest
* @return Result of the AcceptPrimaryEmailUpdate operation returned by the service.
* @throws ResourceNotFoundException
* The operation failed because it specified a resource that can't be found.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws 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).
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.AcceptPrimaryEmailUpdate
* @see AWS API Documentation
*/
AcceptPrimaryEmailUpdateResult acceptPrimaryEmailUpdate(AcceptPrimaryEmailUpdateRequest acceptPrimaryEmailUpdateRequest);
/**
*
* 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.
*
*
*
* @param deleteAlternateContactRequest
* @return Result of the DeleteAlternateContact operation returned by the service.
* @throws ResourceNotFoundException
* The operation failed because it specified a resource that can't be found.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.DeleteAlternateContact
* @see AWS
* API Documentation
*/
DeleteAlternateContactResult deleteAlternateContact(DeleteAlternateContactRequest deleteAlternateContactRequest);
/**
*
* 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.
*
*
*
* @param disableRegionRequest
* @return Result of the DisableRegion operation returned by the service.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws 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).
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.DisableRegion
* @see AWS API
* Documentation
*/
DisableRegionResult disableRegion(DisableRegionRequest disableRegionRequest);
/**
*
* Enables (opts-in) a particular Region for an account.
*
*
* @param enableRegionRequest
* @return Result of the EnableRegion operation returned by the service.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws 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).
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.EnableRegion
* @see AWS API
* Documentation
*/
EnableRegionResult enableRegion(EnableRegionRequest enableRegionRequest);
/**
*
* 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.
*
*
*
* @param getAlternateContactRequest
* @return Result of the GetAlternateContact operation returned by the service.
* @throws ResourceNotFoundException
* The operation failed because it specified a resource that can't be found.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.GetAlternateContact
* @see AWS
* API Documentation
*/
GetAlternateContactResult getAlternateContact(GetAlternateContactRequest getAlternateContactRequest);
/**
*
* 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.
*
*
* @param getContactInformationRequest
* @return Result of the GetContactInformation operation returned by the service.
* @throws ResourceNotFoundException
* The operation failed because it specified a resource that can't be found.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.GetContactInformation
* @see AWS
* API Documentation
*/
GetContactInformationResult getContactInformation(GetContactInformationRequest getContactInformationRequest);
/**
*
* Retrieves the primary email address for the specified account.
*
*
* @param getPrimaryEmailRequest
* @return Result of the GetPrimaryEmail operation returned by the service.
* @throws ResourceNotFoundException
* The operation failed because it specified a resource that can't be found.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.GetPrimaryEmail
* @see AWS API
* Documentation
*/
GetPrimaryEmailResult getPrimaryEmail(GetPrimaryEmailRequest getPrimaryEmailRequest);
/**
*
* Retrieves the opt-in status of a particular Region.
*
*
* @param getRegionOptStatusRequest
* @return Result of the GetRegionOptStatus operation returned by the service.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.GetRegionOptStatus
* @see AWS API
* Documentation
*/
GetRegionOptStatusResult getRegionOptStatus(GetRegionOptStatusRequest getRegionOptStatusRequest);
/**
*
* 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.
*
*
* @param listRegionsRequest
* @return Result of the ListRegions operation returned by the service.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.ListRegions
* @see AWS API
* Documentation
*/
ListRegionsResult listRegions(ListRegionsRequest listRegionsRequest);
/**
*
* 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.
*
*
*
* @param putAlternateContactRequest
* @return Result of the PutAlternateContact operation returned by the service.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.PutAlternateContact
* @see AWS
* API Documentation
*/
PutAlternateContactResult putAlternateContact(PutAlternateContactRequest putAlternateContactRequest);
/**
*
* 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.
*
*
* @param putContactInformationRequest
* @return Result of the PutContactInformation operation returned by the service.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.PutContactInformation
* @see AWS
* API Documentation
*/
PutContactInformationResult putContactInformation(PutContactInformationRequest putContactInformationRequest);
/**
*
* Starts the process to update the primary email address for the specified account.
*
*
* @param startPrimaryEmailUpdateRequest
* @return Result of the StartPrimaryEmailUpdate operation returned by the service.
* @throws ResourceNotFoundException
* The operation failed because it specified a resource that can't be found.
* @throws ValidationException
* The operation failed because one of the input parameters was invalid.
* @throws 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).
* @throws AccessDeniedException
* The operation failed because the calling identity doesn't have the minimum required permissions.
* @throws TooManyRequestsException
* The operation failed because it was called too frequently and exceeded a throttle limit.
* @throws InternalServerException
* The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
* @sample AWSAccount.StartPrimaryEmailUpdate
* @see AWS API Documentation
*/
StartPrimaryEmailUpdateResult startPrimaryEmailUpdate(StartPrimaryEmailUpdateRequest startPrimaryEmailUpdateRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}