AppStream / Paginator / DescribeUsers
DescribeUsers#
- class AppStream.Paginator.DescribeUsers#
paginator = client.get_paginator('describe_users')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
AppStream.Client.describe_users()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
AuthenticationType (string) –
[REQUIRED]
The authentication type for the users in the user pool to describe. You must specify USERPOOL.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'Users': [ { 'Arn': 'string', 'UserName': 'string', 'Enabled': True|False, 'Status': 'string', 'FirstName': 'string', 'LastName': 'string', 'CreatedTime': datetime(2015, 1, 1), 'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD' }, ], }
Response Structure
(dict) –
Users (list) –
Information about users in the user pool.
(dict) –
Describes a user in the user pool.
Arn (string) –
The ARN of the user.
UserName (string) –
The email address of the user.
Note
Users’ email addresses are case-sensitive.
Enabled (boolean) –
Specifies whether the user in the user pool is enabled.
Status (string) –
The status of the user in the user pool. The status can be one of the following:
UNCONFIRMED – The user is created but not confirmed.
CONFIRMED – The user is confirmed.
ARCHIVED – The user is no longer active.
COMPROMISED – The user is disabled because of a potential security threat.
UNKNOWN – The user status is not known.
FirstName (string) –
The first name, or given name, of the user.
LastName (string) –
The last name, or surname, of the user.
CreatedTime (datetime) –
The date and time the user was created in the user pool.
AuthenticationType (string) –
The authentication type for the user.