:doc:`Lambda <../../lambda>` / Client / list_aliases

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



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

  

  Returns a list of `aliases <https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html>`__ for a Lambda function.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/ListAliases>`_  


  **Request Syntax**
  ::

    response = client.list_aliases(
        FunctionName='string',
        FunctionVersion='string',
        Marker='string',
        MaxItems=123
    )
    
  :type FunctionName: string
  :param FunctionName: **[REQUIRED]** 

    The name or ARN of the Lambda function.

     

    **Name formats**

     

    
    * **Function name** - ``MyFunction``.
     
    * **Function ARN** - ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``.
     
    * **Partial ARN** - ``123456789012:function:MyFunction``.
    

     

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    

  
  :type FunctionVersion: string
  :param FunctionVersion: 

    Specify a function version to only list aliases that invoke that version.

    

  
  :type Marker: string
  :param Marker: 

    Specify the pagination token that's returned by a previous request to retrieve the next page of results.

    

  
  :type MaxItems: integer
  :param MaxItems: 

    Limit the number of aliases returned.

    

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

    
    ::

      {
          'NextMarker': 'string',
          'Aliases': [
              {
                  'AliasArn': 'string',
                  'Name': 'string',
                  'FunctionVersion': 'string',
                  'Description': 'string',
                  'RoutingConfig': {
                      'AdditionalVersionWeights': {
                          'string': 123.0
                      }
                  },
                  'RevisionId': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextMarker** *(string) --* 

        The pagination token that's included if more results are available.

        
      

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

        A list of aliases.

        
        

        - *(dict) --* 

          Provides configuration information about a Lambda function `alias <https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html>`__.

          
          

          - **AliasArn** *(string) --* 

            The Amazon Resource Name (ARN) of the alias.

            
          

          - **Name** *(string) --* 

            The name of the alias.

            
          

          - **FunctionVersion** *(string) --* 

            The function version that the alias invokes.

            
          

          - **Description** *(string) --* 

            A description of the alias.

            
          

          - **RoutingConfig** *(dict) --* 

            The `routing configuration <https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html>`__ of the alias.

            
            

            - **AdditionalVersionWeights** *(dict) --* 

              The second version, and the percentage of traffic that's routed to it.

              
              

              - *(string) --* 
                

                - *(float) --* 
          
        
        
          

          - **RevisionId** *(string) --* 

            A unique identifier that changes when you update the alias.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Lambda.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`Lambda.Client.exceptions.ServiceException`

  
  *   :py:class:`Lambda.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`Lambda.Client.exceptions.ResourceNotFoundException`

  

  **Examples**

  The following example returns a list of aliases for a function named my-function.
  ::

    response = client.list_aliases(
        FunctionName='my-function',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'Aliases': [
            {
                'AliasArn': 'arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA',
                'Description': 'Production environment BLUE.',
                'FunctionVersion': '2',
                'Name': 'BLUE',
                'RevisionId': 'a410117f-xmpl-494e-8035-7e204bb7933b',
                'RoutingConfig': {
                    'AdditionalVersionWeights': {
                        '1': 0.7,
                    },
                },
            },
            {
                'AliasArn': 'arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE',
                'Description': 'Production environment GREEN.',
                'FunctionVersion': '1',
                'Name': 'GREEN',
                'RevisionId': '21d40116-xmpl-40ba-9360-3ea284da1bb5',
            },
        ],
        'ResponseMetadata': {
            '...': '...',
        },
    }

  