[ aws . chime ]

list-accounts

Description

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

See ‘aws help’ for descriptions of global parameters.

list-accounts is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Accounts

Synopsis

  list-accounts
[--name <value>]
[--user-email <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

Amazon Chime account name prefix with which to filter results.

--user-email (string)

User email address with which to filter results.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (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 AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get a list of accounts

The following list-accounts example retrieves a list of the Amazon Chime accounts in the administrator’s AWS account.

aws chime list-accounts

Output:

{
    "Accounts": [
        {
            "AwsAccountId": "111122223333",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "Name": "First Chime Account",
            "AccountType": "EnterpriseDirectory",
            "CreatedTimestamp": "2018-12-20T18:38:02.181Z",
            "DefaultLicense": "Pro",
            "SupportedLicenses": [
                "Basic",
                "Pro"
            ],
            "SigninDelegateGroups": [
                {
                    "GroupName": "myGroup"
                },
            ]
        },
        {
            "AwsAccountId": "111122223333",
            "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "Name": "Second Chime Account",
            "AccountType": "Team",
            "CreatedTimestamp": "2018-09-04T21:44:22.292Z",
            "DefaultLicense": "Pro",
            "SupportedLicenses": [
                "Basic",
                "Pro"
            ],
            "SigninDelegateGroups": [
                {
                    "GroupName": "myGroup"
                },
            ]
        }
    ]
}

For more information, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Output

Accounts -> (list)

List of Amazon Chime accounts and account details.

(structure)

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 -> (timestamp)

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.

(structure)

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.