Table of Contents
Account.Client¶A low-level client representing AWS Account
Operations for Amazon Web Services Account Management
import boto3
client = boto3.client('account')
These are the available methods:
can_paginate()close()delete_alternate_contact()disable_region()enable_region()get_alternate_contact()get_contact_information()get_paginator()get_region_opt_status()get_waiter()list_regions()put_alternate_contact()put_contact_information()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
delete_alternate_contact(**kwargs)¶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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_alternate_contact(
AccountId='string',
AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY'
)
Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.
If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.
To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId ; it must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Specifies which of the alternate contacts to delete.
None
Exceptions
Account.Client.exceptions.ResourceNotFoundExceptionAccount.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptiondisable_region(**kwargs)¶Disables (opts-out) a particular Region for an account.
See also: AWS API Documentation
Request Syntax
response = client.disable_region(
AccountId='string',
RegionName='string'
)
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId . It must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Specifies the Region-code for a given Region name (for example, af-south-1 ). When you disable a Region, AWS performs actions to deactivate that Region in your account, such as destroying IAM resources in the Region. This process takes a few minutes for most accounts, but this can take several hours. You cannot enable the Region until the disabling process is fully completed.
None
Exceptions
Account.Client.exceptions.ValidationExceptionAccount.Client.exceptions.ConflictExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionenable_region(**kwargs)¶Enables (opts-in) a particular Region for an account.
See also: AWS API Documentation
Request Syntax
response = client.enable_region(
AccountId='string',
RegionName='string'
)
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId . It must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Specifies the Region-code for a given Region name (for example, af-south-1 ). When you enable a Region, AWS performs actions to prepare your account in that Region, such as distributing your IAM resources to the Region. This process takes a few minutes for most accounts, but it can take several hours. You cannot use the Region until this process is complete. Furthermore, you cannot disable the Region until the enabling process is fully completed.
None
Exceptions
Account.Client.exceptions.ValidationExceptionAccount.Client.exceptions.ConflictExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionget_alternate_contact(**kwargs)¶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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.get_alternate_contact(
AccountId='string',
AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY'
)
Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.
If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.
To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId ; it must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Specifies which alternate contact you want to retrieve.
dict
Response Syntax
{
'AlternateContact': {
'AlternateContactType': 'BILLING'|'OPERATIONS'|'SECURITY',
'EmailAddress': 'string',
'Name': 'string',
'PhoneNumber': 'string',
'Title': 'string'
}
}
Response Structure
(dict) --
AlternateContact (dict) --
A structure that contains the details for the specified alternate contact.
AlternateContactType (string) --
The type of alternate contact.
EmailAddress (string) --
The email address associated with this alternate contact.
Name (string) --
The name associated with this alternate contact.
PhoneNumber (string) --
The phone number associated with this alternate contact.
Title (string) --
The title associated with this alternate contact.
Exceptions
Account.Client.exceptions.ResourceNotFoundExceptionAccount.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionget_contact_information(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_contact_information(
AccountId='string'
)
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId . It must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
{
'ContactInformation': {
'AddressLine1': 'string',
'AddressLine2': 'string',
'AddressLine3': 'string',
'City': 'string',
'CompanyName': 'string',
'CountryCode': 'string',
'DistrictOrCounty': 'string',
'FullName': 'string',
'PhoneNumber': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'WebsiteUrl': 'string'
}
}
Response Structure
Contains the details of the primary contact information associated with an Amazon Web Services account.
The first line of the primary contact address.
The second line of the primary contact address, if any.
The third line of the primary contact address, if any.
The city of the primary contact address.
The name of the company associated with the primary contact information, if any.
The ISO-3166 two-letter country code for the primary contact address.
The district or county of the primary contact address, if any.
The full name of the primary contact address.
The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
The postal code of the primary contact address.
The state or region of the primary contact address. This field is required in selected countries.
The URL of the website associated with the primary contact information, if any.
Exceptions
Account.Client.exceptions.ResourceNotFoundExceptionAccount.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_region_opt_status(**kwargs)¶Retrieves the opt-in status of a particular Region.
See also: AWS API Documentation
Request Syntax
response = client.get_region_opt_status(
AccountId='string',
RegionName='string'
)
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId . It must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Specifies the Region-code for a given Region name (for example, af-south-1 ). This function will return the status of whatever Region you pass into this parameter.
dict
Response Syntax
{
'RegionName': 'string',
'RegionOptStatus': 'ENABLED'|'ENABLING'|'DISABLING'|'DISABLED'|'ENABLED_BY_DEFAULT'
}
Response Structure
(dict) --
RegionName (string) --
The Region code that was passed in.
RegionOptStatus (string) --
One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
Exceptions
Account.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_regions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_regions(
AccountId='string',
MaxResults=123,
NextToken='string',
RegionOptStatusContains=[
'ENABLED'|'ENABLING'|'DISABLING'|'DISABLED'|'ENABLED_BY_DEFAULT',
]
)
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId . It must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide .NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide .A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.
dict
Response Syntax
{
'NextToken': 'string',
'Regions': [
{
'RegionName': 'string',
'RegionOptStatus': 'ENABLED'|'ENABLING'|'DISABLING'|'DISABLED'|'ENABLED_BY_DEFAULT'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there is more data to be returned, this will be populated. It should be passed into the next-token request parameter of list-regions .
Regions (list) --
This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the filter parameter.
(dict) --
This is a structure that expresses the Region for a given account, consisting of a name and opt-in status.
RegionName (string) --
The Region code of a given Region (for example, us-east-1 ).
RegionOptStatus (string) --
One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
Exceptions
Account.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionput_alternate_contact(**kwargs)¶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.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.put_alternate_contact(
AccountId='string',
AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY',
EmailAddress='string',
Name='string',
PhoneNumber='string',
Title='string'
)
Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation.
If you do not specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation.
To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId ; it must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Specifies which alternate contact you want to create or update.
[REQUIRED]
Specifies an email address for the alternate contact.
[REQUIRED]
Specifies a name for the alternate contact.
[REQUIRED]
Specifies a phone number for the alternate contact.
[REQUIRED]
Specifies a title for the alternate contact.
None
Exceptions
Account.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionput_contact_information(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.put_contact_information(
AccountId='string',
ContactInformation={
'AddressLine1': 'string',
'AddressLine2': 'string',
'AddressLine3': 'string',
'City': 'string',
'CompanyName': 'string',
'CountryCode': 'string',
'DistrictOrCounty': 'string',
'FullName': 'string',
'PhoneNumber': 'string',
'PostalCode': 'string',
'StateOrRegion': 'string',
'WebsiteUrl': 'string'
}
)
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin account assigned.
Note
The management account can't specify its own AccountId . It must call the operation in standalone context by not including the AccountId parameter.
To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
[REQUIRED]
Contains the details of the primary contact information associated with an Amazon Web Services account.
The first line of the primary contact address.
The second line of the primary contact address, if any.
The third line of the primary contact address, if any.
The city of the primary contact address.
The name of the company associated with the primary contact information, if any.
The ISO-3166 two-letter country code for the primary contact address.
The district or county of the primary contact address, if any.
The full name of the primary contact address.
The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
The postal code of the primary contact address.
The state or region of the primary contact address. This field is required in selected countries.
The URL of the website associated with the primary contact information, if any.
None
Exceptions
Account.Client.exceptions.ValidationExceptionAccount.Client.exceptions.AccessDeniedExceptionAccount.Client.exceptions.TooManyRequestsExceptionAccount.Client.exceptions.InternalServerExceptionThe available paginators are: