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

****************************
describe_state_machine_alias
****************************



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

  

  Returns details about a state machine `alias <https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html>`__.

   

  **Related operations:**

   

  
  *  CreateStateMachineAlias
   
  *  ListStateMachineAliases
   
  *  UpdateStateMachineAlias
   
  *  DeleteStateMachineAlias
  

  

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


  **Request Syntax**
  ::

    response = client.describe_state_machine_alias(
        stateMachineAliasArn='string'
    )
    
  :type stateMachineAliasArn: string
  :param stateMachineAliasArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the state machine alias.

    

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

    
    ::

      {
          'stateMachineAliasArn': 'string',
          'name': 'string',
          'description': 'string',
          'routingConfiguration': [
              {
                  'stateMachineVersionArn': 'string',
                  'weight': 123
              },
          ],
          'creationDate': datetime(2015, 1, 1),
          'updateDate': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The Amazon Resource Name (ARN) of the state machine alias.

        
      

      - **name** *(string) --* 

        The name of the state machine alias.

        
      

      - **description** *(string) --* 

        A description of the alias.

        
      

      - **routingConfiguration** *(list) --* 

        The routing configuration of the alias.

        
        

        - *(dict) --* 

          Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.

          
          

          - **stateMachineVersionArn** *(string) --* 

            The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.

             

            If you specify the ARN of a second version, it must belong to the same state machine as the first version.

            
          

          - **weight** *(integer) --* 

            The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.

            
      
    
      

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

        The date the state machine alias was created.

        
      

      - **updateDate** *(datetime) --* 

        The date the state machine alias was last updated.

         

        For a newly created state machine, this is the same as the creation date.

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

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

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

  