:doc:`AppStream <../../appstream>` / Paginator / DescribeUserStackAssociations

*****************************
DescribeUserStackAssociations
*****************************



.. py:class:: AppStream.Paginator.DescribeUserStackAssociations

  ::

    
    paginator = client.get_paginator('describe_user_stack_associations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`AppStream.Client.describe_user_stack_associations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeUserStackAssociations>`_    


    **Request Syntax**
    ::

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

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

      

    
    :type UserName: string
    :param UserName: 

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

       

      .. note::

        

        Users' email addresses are case-sensitive.

        

      

    
    :type AuthenticationType: string
    :param AuthenticationType: 

      The authentication type for the user who is associated with the stack. You must specify USERPOOL.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

              
        
      
    