Organizations / Client / describe_account

describe_account#

Organizations.Client.describe_account(**kwargs)#

Retrieves Organizations-related information about the specified account.

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.describe_account(
    AccountId='string'
)
Parameters:

AccountId (string) –

[REQUIRED]

The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Account (dict) –

      A structure that contains information about the requested account.

      • 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.

Exceptions

  • Organizations.Client.exceptions.AccessDeniedException

  • Organizations.Client.exceptions.AccountNotFoundException

  • Organizations.Client.exceptions.AWSOrganizationsNotInUseException

  • Organizations.Client.exceptions.InvalidInputException

  • Organizations.Client.exceptions.ServiceException

  • Organizations.Client.exceptions.TooManyRequestsException

Examples

The following example shows a user in the master account (111111111111) asking for details about account 555555555555:

response = client.describe_account(
    AccountId='555555555555',
)

print(response)

Expected Output:

{
    'Account': {
        'Arn': 'arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555',
        'Email': 'anika@example.com',
        'Id': '555555555555',
        'Name': 'Beta Account',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}