:doc:`AppStream <../../appstream>` / Client / describe_user_stack_associations

********************************
describe_user_stack_associations
********************************



.. py:method:: AppStream.Client.describe_user_stack_associations(**kwargs)

  

  Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

   

  
  * The stack name
   
  * The user name (email address of the user associated with the stack) and the authentication type for the user
  

  

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


  **Request Syntax**
  ::

    response = client.describe_user_stack_associations(
        StackName='string',
        UserName='string',
        AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD',
        MaxResults=123,
        NextToken='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 MaxResults: integer
  :param MaxResults: 

    The maximum size of each page of results.

    

  
  :type NextToken: string
  :param NextToken: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'UserStackAssociations': [
              {
                  'StackName': 'string',
                  'UserName': 'string',
                  'AuthenticationType': 'API'|'SAML'|'USERPOOL'|'AWS_AD',
                  'SendEmailNotification': True|False
              },
          ],
          'NextToken': 'string'
      }
      
    **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.

            
      
    
      

      - **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**
  
  *   :py:class:`AppStream.Client.exceptions.InvalidParameterCombinationException`

  
  *   :py:class:`AppStream.Client.exceptions.OperationNotPermittedException`

  