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