Chime.Paginator.
ListAccounts
¶paginator = client.get_paginator('list_accounts')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from Chime.Client.list_accounts()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Name='string',
UserEmail='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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'
},
]
},
],
}
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.
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.