Account ******* Client ====== class 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: * accept_primary_email_update * can_paginate * close * delete_alternate_contact * disable_region * enable_region * get_account_information * get_alternate_contact * get_contact_information * get_paginator * get_primary_email * get_region_opt_status * get_waiter * list_regions * put_account_name * put_alternate_contact * put_contact_information * start_primary_email_update Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListRegions Account / Paginator / ListRegions ListRegions *********** class Account.Paginator.ListRegions paginator = client.get_paginator('list_regions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Account.Client.list_regions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AccountId='string', RegionOptStatusContains=[ 'ENABLED'|'ENABLING'|'DISABLING'|'DISABLED'|'ENABLED_BY_DEFAULT', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **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 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. * **RegionOptStatusContains** (*list*) -- 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. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Regions': [ { 'RegionName': 'string', 'RegionOptStatus': 'ENABLED'|'ENABLING'|'DISABLING'|'DISABLED'|'ENABLED_BY_DEFAULT' }, ] } **Response Structure** * *(dict) --* * **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). Account / Client / put_contact_information put_contact_information *********************** Account.Client.put_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' } ) Parameters: * **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 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** (*dict*) -- **[REQUIRED]** Contains the details of the primary contact information associated with an Amazon Web Services account. * **AddressLine1** *(string) --* **[REQUIRED]** The first line of the primary contact address. * **AddressLine2** *(string) --* The second line of the primary contact address, if any. * **AddressLine3** *(string) --* The third line of the primary contact address, if any. * **City** *(string) --* **[REQUIRED]** The city of the primary contact address. * **CompanyName** *(string) --* The name of the company associated with the primary contact information, if any. * **CountryCode** *(string) --* **[REQUIRED]** The ISO-3166 two-letter country code for the primary contact address. * **DistrictOrCounty** *(string) --* The district or county of the primary contact address, if any. * **FullName** *(string) --* **[REQUIRED]** The full name of the primary contact address. * **PhoneNumber** *(string) --* **[REQUIRED]** The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation. * **PostalCode** *(string) --* **[REQUIRED]** The postal code of the primary contact address. * **StateOrRegion** *(string) --* The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, "NJ") or the full state name (for example, "New Jersey"). This field is required in the following countries: "US", "CA", "GB", "DE", "JP", "IN", and "BR". * **WebsiteUrl** *(string) --* The URL of the website associated with the primary contact information, if any. Returns: None **Exceptions** * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / get_paginator get_paginator ************* Account.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Account / Client / put_account_name put_account_name **************** Account.Client.put_account_name(**kwargs) Updates the account name of the specified account. To use this API, IAM principals must have the "account:PutAccountName" IAM permission. See also: AWS API Documentation **Request Syntax** response = client.put_account_name( AccountId='string', AccountName='string' ) Parameters: * **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 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. * **AccountName** (*string*) -- **[REQUIRED]** The name of the account. Returns: None **Exceptions** * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / put_alternate_contact put_alternate_contact ********************* Account.Client.put_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' ) Parameters: * **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 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. * **AlternateContactType** (*string*) -- **[REQUIRED]** Specifies which alternate contact you want to create or update. * **EmailAddress** (*string*) -- **[REQUIRED]** Specifies an email address for the alternate contact. * **Name** (*string*) -- **[REQUIRED]** Specifies a name for the alternate contact. * **PhoneNumber** (*string*) -- **[REQUIRED]** Specifies a phone number for the alternate contact. * **Title** (*string*) -- **[REQUIRED]** Specifies a title for the alternate contact. Returns: None **Exceptions** * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / can_paginate can_paginate ************ Account.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. Account / Client / get_waiter get_waiter ********** Account.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Account / Client / delete_alternate_contact delete_alternate_contact ************************ Account.Client.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' ) Parameters: * **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 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. * **AlternateContactType** (*string*) -- **[REQUIRED]** Specifies which of the alternate contacts to delete. Returns: None **Exceptions** * "Account.Client.exceptions.ResourceNotFoundException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / accept_primary_email_update accept_primary_email_update *************************** Account.Client.accept_primary_email_update(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.accept_primary_email_update( AccountId='string', Otp='string', PrimaryEmail='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this 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 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. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. Note: The management account can't specify its own "AccountId". * **Otp** (*string*) -- **[REQUIRED]** The OTP code sent to the "PrimaryEmail" specified on the "StartPrimaryEmailUpdate" API call. * **PrimaryEmail** (*string*) -- **[REQUIRED]** The new primary email address for use with the specified account. This must match the "PrimaryEmail" from the "StartPrimaryEmailUpdate" API call. Return type: dict Returns: **Response Syntax** { 'Status': 'PENDING'|'ACCEPTED' } **Response Structure** * *(dict) --* * **Status** *(string) --* Retrieves the status of the accepted primary email update request. **Exceptions** * "Account.Client.exceptions.ResourceNotFoundException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.ConflictException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / start_primary_email_update start_primary_email_update ************************** Account.Client.start_primary_email_update(**kwargs) Starts the process to update the primary email address for the specified account. See also: AWS API Documentation **Request Syntax** response = client.start_primary_email_update( AccountId='string', PrimaryEmail='string' ) Parameters: * **AccountId** (*string*) -- **[REQUIRED]** Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this 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 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. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. Note: The management account can't specify its own "AccountId". * **PrimaryEmail** (*string*) -- **[REQUIRED]** The new primary email address (also known as the root user email address) to use in the specified account. Return type: dict Returns: **Response Syntax** { 'Status': 'PENDING'|'ACCEPTED' } **Response Structure** * *(dict) --* * **Status** *(string) --* The status of the primary email update request. **Exceptions** * "Account.Client.exceptions.ResourceNotFoundException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.ConflictException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / get_primary_email get_primary_email ***************** Account.Client.get_primary_email(**kwargs) Retrieves the primary email address for the specified account. See also: AWS API Documentation **Request Syntax** response = client.get_primary_email( AccountId='string' ) Parameters: **AccountId** (*string*) -- **[REQUIRED]** Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this 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 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. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. Note: The management account can't specify its own "AccountId". Return type: dict Returns: **Response Syntax** { 'PrimaryEmail': 'string' } **Response Structure** * *(dict) --* * **PrimaryEmail** *(string) --* Retrieves the primary email address associated with the specified account. **Exceptions** * "Account.Client.exceptions.ResourceNotFoundException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / get_region_opt_status get_region_opt_status ********************* Account.Client.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' ) Parameters: * **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 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. * **RegionName** (*string*) -- **[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. Return type: dict Returns: **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.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / disable_region disable_region ************** Account.Client.disable_region(**kwargs) Disables (opts-out) a particular Region for an account. Note: The act of disabling a Region will remove all IAM access to any resources that reside in that Region. See also: AWS API Documentation **Request Syntax** response = client.disable_region( AccountId='string', RegionName='string' ) Parameters: * **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 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. * **RegionName** (*string*) -- **[REQUIRED]** Specifies the Region-code for a given Region name (for example, "af-south-1"). When you disable a Region, Amazon Web Services 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. Returns: None **Exceptions** * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.ConflictException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / get_alternate_contact get_alternate_contact ********************* Account.Client.get_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' ) Parameters: * **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 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. * **AlternateContactType** (*string*) -- **[REQUIRED]** Specifies which alternate contact you want to retrieve. Return type: dict Returns: **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.ResourceNotFoundException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / close close ***** Account.Client.close() Closes underlying endpoint connections. Account / Client / get_contact_information get_contact_information *********************** Account.Client.get_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' ) Parameters: **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 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. Return type: dict Returns: **Response Syntax** { '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** * *(dict) --* * **ContactInformation** *(dict) --* Contains the details of the primary contact information associated with an Amazon Web Services account. * **AddressLine1** *(string) --* The first line of the primary contact address. * **AddressLine2** *(string) --* The second line of the primary contact address, if any. * **AddressLine3** *(string) --* The third line of the primary contact address, if any. * **City** *(string) --* The city of the primary contact address. * **CompanyName** *(string) --* The name of the company associated with the primary contact information, if any. * **CountryCode** *(string) --* The ISO-3166 two-letter country code for the primary contact address. * **DistrictOrCounty** *(string) --* The district or county of the primary contact address, if any. * **FullName** *(string) --* The full name of the primary contact address. * **PhoneNumber** *(string) --* The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation. * **PostalCode** *(string) --* The postal code of the primary contact address. * **StateOrRegion** *(string) --* The state or region of the primary contact address. If the mailing address is within the United States (US), the value in this field can be either a two character state code (for example, "NJ") or the full state name (for example, "New Jersey"). This field is required in the following countries: "US", "CA", "GB", "DE", "JP", "IN", and "BR". * **WebsiteUrl** *(string) --* The URL of the website associated with the primary contact information, if any. **Exceptions** * "Account.Client.exceptions.ResourceNotFoundException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / list_regions list_regions ************ Account.Client.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', ] ) Parameters: * **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 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. * **MaxResults** (*integer*) -- The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a "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** (*string*) -- A token used to specify where to start paginating. This is the "NextToken" from a previously truncated response. For usage examples, see Pagination in the *Amazon Web Services Command Line Interface User Guide*. * **RegionOptStatusContains** (*list*) -- 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. * *(string) --* Return type: dict Returns: **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.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / get_account_information get_account_information *********************** Account.Client.get_account_information(**kwargs) Retrieves information about the specified account including its account name, account ID, and account creation date and time. To use this API, an IAM user or role must have the "account:GetAccountInformation" IAM permission. See also: AWS API Documentation **Request Syntax** response = client.get_account_information( AccountId='string' ) Parameters: **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 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. Return type: dict Returns: **Response Syntax** { 'AccountCreatedDate': datetime(2015, 1, 1), 'AccountId': 'string', 'AccountName': 'string' } **Response Structure** * *(dict) --* * **AccountCreatedDate** *(datetime) --* The date and time the account was created. * **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. 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 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. This operation can only be called from the management account or the delegated administrator account of an organization for a member account. Note: The management account can't specify its own "AccountId". * **AccountName** *(string) --* The name of the account. **Exceptions** * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException" Account / Client / enable_region enable_region ************* Account.Client.enable_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' ) Parameters: * **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 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. * **RegionName** (*string*) -- **[REQUIRED]** Specifies the Region-code for a given Region name (for example, "af-south-1"). When you enable a Region, Amazon Web Services 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. Returns: None **Exceptions** * "Account.Client.exceptions.AccessDeniedException" * "Account.Client.exceptions.ValidationException" * "Account.Client.exceptions.ConflictException" * "Account.Client.exceptions.TooManyRequestsException" * "Account.Client.exceptions.InternalServerException"