get_account

Chime.Client.get_account(**kwargs)

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

See also: AWS API Documentation

Request Syntax

response = client.get_account(
    AccountId='string'
)

Parameters

AccountId (string) --

[REQUIRED]

The Amazon Chime account ID.

Return type

dict

Returns

Response Syntax

{
    'Account': {
        'AwsAccountId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'SupportedLicenses': [
            'Basic'|'Plus'|'Pro'|'ProTrial',
        ],
        'AccountStatus': 'Suspended'|'Active',
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --
  • Account (dict) --

    The Amazon Chime account details.

    • AwsAccountId (string) --

      The AWS account ID.

    • AccountId (string) --

      The Amazon Chime account ID.

    • Name (string) --

      The Amazon Chime account name.

    • AccountType (string) --

      The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .

    • CreatedTimestamp (datetime) --

      The Amazon Chime account creation timestamp, in ISO 8601 format.

    • DefaultLicense (string) --

      The default license for the Amazon Chime account.

    • SupportedLicenses (list) --

      Supported licenses for the Amazon Chime account.

      • (string) --
    • AccountStatus (string) --

      The status of the account.

    • SigninDelegateGroups (list) --

      The sign-in delegate groups associated with the account.

      • (dict) --

        An Active Directory (AD) group whose members are granted permission to act as delegates.

        • GroupName (string) --

          The group name.

Exceptions

• Chime.Client.exceptions.UnauthorizedClientException
• Chime.Client.exceptions.NotFoundException
• Chime.Client.exceptions.ForbiddenException
• Chime.Client.exceptions.BadRequestException
• Chime.Client.exceptions.ThrottledClientException
• Chime.Client.exceptions.ServiceUnavailableException
• Chime.Client.exceptions.ServiceFailureException