list_accounts

list_accounts(**kwargs)

Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

Note

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

See also: AWS API Documentation

Request Syntax

response = client.list_accounts(
    NextToken='string',
    MaxResults=123
)

Parameters

• NextToken (string) -- The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
• MaxResults (integer) -- The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Return type

dict

Returns

Response Syntax

{
    'Accounts': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Email': 'string',
            'Name': 'string',
            'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
            'JoinedMethod': 'INVITED'|'CREATED',
            'JoinedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Accounts (list) --

    A list of objects in the organization.

    • (dict) --

      Contains information about an Amazon Web Services account that is a member of an organization.

      • Id (string) --

        The unique identifier (ID) of the account.

        The regex pattern for an account ID string requires exactly 12 digits.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the account.

        For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference .

      • Email (string) --

        The email address associated with the Amazon Web Services account.

        The regex pattern for this parameter is a string of characters that represents a standard internet email address.

      • Name (string) --

        The friendly name of the account.

        The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

      • Status (string) --

        The status of the account in the organization.

      • JoinedMethod (string) --

        The method by which the account joined the organization.

      • JoinedTimestamp (datetime) --

        The date the account became a part of the organization.

  • NextToken (string) --

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

Exceptions

• Organizations.Client.exceptions.AccessDeniedException
• Organizations.Client.exceptions.AWSOrganizationsNotInUseException
• Organizations.Client.exceptions.InvalidInputException
• Organizations.Client.exceptions.ServiceException
• Organizations.Client.exceptions.TooManyRequestsException

Examples

The following example shows you how to request a list of the accounts in an organization:

response = client.list_accounts(
)

print(response)

Expected Output:

{
    'Accounts': [
        {
            'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111',
            'Email': 'bill@example.com',
            'Id': '111111111111',
            'JoinedMethod': 'INVITED',
            'JoinedTimestamp': datetime(2016, 12, 15, 19, 30, 15, 3, 350, 0),
            'Name': 'Master Account',
            'Status': 'ACTIVE',
        },
        {
            'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222',
            'Email': 'alice@example.com',
            'Id': '222222222222',
            'JoinedMethod': 'INVITED',
            'JoinedTimestamp': datetime(2016, 12, 15, 21, 2, 21, 3, 350, 0),
            'Name': 'Developer Account',
            'Status': 'ACTIVE',
        },
        {
            'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333',
            'Email': 'juan@example.com',
            'Id': '333333333333',
            'JoinedMethod': 'INVITED',
            'JoinedTimestamp': datetime(2016, 12, 15, 21, 3, 47, 3, 350, 0),
            'Name': 'Test Account',
            'Status': 'ACTIVE',
        },
        {
            'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444',
            'Email': 'anika@example.com',
            'Id': '444444444444',
            'JoinedMethod': 'INVITED',
            'JoinedTimestamp': datetime(2016, 12, 15, 21, 3, 32, 3, 350, 0),
            'Name': 'Production Account',
            'Status': 'ACTIVE',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}