:doc:`WorkMail <../../workmail>` / Client / list_aliases

************
list_aliases
************



.. py:method:: WorkMail.Client.list_aliases(**kwargs)

  

  Creates a paginated call to list the aliases associated with a given entity.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliases>`_  


  **Request Syntax**
  ::

    response = client.list_aliases(
        OrganizationId='string',
        EntityId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The identifier for the organization under which the entity exists.

    

  
  :type EntityId: string
  :param EntityId: **[REQUIRED]** 

    The identifier for the entity for which to list the aliases.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

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

    
    ::

      {
          'Aliases': [
              'string',
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Aliases** *(list) --* 

        The entity's paginated aliases.

        
        

        - *(string) --* 
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  