AppStream / Paginator / DescribeUserStackAssociations

DescribeUserStackAssociations

class AppStream.Paginator.DescribeUserStackAssociations

paginator = client.get_paginator('describe_user_stack_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AppStream.Client.describe_user_stack_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StackName='string',
    UserName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• StackName (string) – The name of the stack that is associated with the user.

• UserName (string) –

  The email address of the user who is associated with the stack.

  Note

  Users’ email addresses are case-sensitive.

• AuthenticationType (string) – The authentication type for the user who is associated with the stack. 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

{
    'UserStackAssociations': [
        {
            'StackName': 'string',
            'UserName': 'string',
            'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
            'SendEmailNotification': True|False
        },
    ],

}

Response Structure

• (dict) –

  • UserStackAssociations (list) –

    The UserStackAssociation objects.

    • (dict) –

      Describes a user in the user pool and the associated stack.

      • StackName (string) –

        The name of the stack that is associated with the user.

      • UserName (string) –

        The email address of the user who is associated with the stack.

        Note

        Users’ email addresses are case-sensitive.

      • AuthenticationType (string) –

        The authentication type for the user.

      • SendEmailNotification (boolean) –

        Specifies whether a welcome email is sent to a user after the user is created in the user pool.