:doc:`SFN <../../stepfunctions>` / Client / list_state_machine_aliases

**************************
list_state_machine_aliases
**************************



.. py:method:: SFN.Client.list_state_machine_aliases(**kwargs)

  

  Lists `aliases <https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html>`__ for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

   

  To list aliases that reference a state machine `version <https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html>`__, you can specify the version ARN in the ``stateMachineArn`` parameter.

   

  If ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an *HTTP 400 InvalidToken* error.

   

  **Related operations:**

   

  
  *  CreateStateMachineAlias
   
  *  DescribeStateMachineAlias
   
  *  UpdateStateMachineAlias
   
  *  DeleteStateMachineAlias
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachineAliases>`_  


  **Request Syntax**
  ::

    response = client.list_state_machine_aliases(
        stateMachineArn='string',
        nextToken='string',
        maxResults=123
    )
    
  :type stateMachineArn: string
  :param stateMachineArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

     

    If you specify a state machine version ARN, this API returns a list of aliases for that version.

    

  
  :type nextToken: string
  :param nextToken: 

    If ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an *HTTP 400 InvalidToken* error.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that are returned per call. You can use ``nextToken`` to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

     

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    

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

    
    ::

      {
          'stateMachineAliases': [
              {
                  'stateMachineAliasArn': 'string',
                  'creationDate': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **stateMachineAliases** *(list) --* 

        Aliases for the state machine.

        
        

        - *(dict) --* 

          Contains details about a specific state machine alias.

          
          

          - **stateMachineAliasArn** *(string) --* 

            The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, ``stateMachineARN:PROD``.

            
          

          - **creationDate** *(datetime) --* 

            The creation date of a state machine alias.

            
      
    
      

      - **nextToken** *(string) --* 

        If ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an *HTTP 400 InvalidToken* error.

        
  
  **Exceptions**
  
  *   :py:class:`SFN.Client.exceptions.InvalidArn`

  
  *   :py:class:`SFN.Client.exceptions.InvalidToken`

  
  *   :py:class:`SFN.Client.exceptions.ResourceNotFound`

  
  *   :py:class:`SFN.Client.exceptions.StateMachineDoesNotExist`

  
  *   :py:class:`SFN.Client.exceptions.StateMachineDeleting`

  