Chime / Client / list_accounts

list_accounts#

Chime.Client.list_accounts(**kwargs)#

Lists the Amazon Chime accounts under the administrator’s AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user’s email address, which returns one account result.

See also: AWS API Documentation

Request Syntax

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

Parameters:

Name (string) – Amazon Chime account name prefix with which to filter results.
UserEmail (string) – User email address with which to filter results.
NextToken (string) – The token to use to retrieve the next page of results.
MaxResults (integer) – The maximum number of results to return in a single call. Defaults to 100.

Return type:

dict

Returns:

Response Syntax

{
    'Accounts': [
        {
            '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Accounts (list) –
  
  List of Amazon Chime accounts and account details.
  - (dict) –
    
    The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
    - 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.
- NextToken (string) –
  
  The token to use to retrieve the next page of results.

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