AppStream / Client / describe_users

describe_users#

AppStream.Client.describe_users(**kwargs)#

Retrieves a list that describes one or more specified users in the user pool.

See also: AWS API Documentation

Request Syntax

response = client.describe_users(
    AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AuthenticationType (string) –

    [REQUIRED]

    The authentication type for the users in the user pool to describe. You must specify USERPOOL.

  • MaxResults (integer) – The maximum size of each page of results.

  • NextToken (string) – The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

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

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.

    • NextToken (string) –

      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Exceptions

  • AppStream.Client.exceptions.ResourceNotFoundException

  • AppStream.Client.exceptions.InvalidParameterCombinationException

  • AppStream.Client.exceptions.OperationNotPermittedException