:doc:`Lambda <../../lambda>` / Paginator / ListAliases

***********
ListAliases
***********



.. py:class:: Lambda.Paginator.ListAliases

  ::

    
    paginator = client.get_paginator('list_aliases')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Lambda.Client.list_aliases`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          FunctionName='string',
          FunctionVersion='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

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

      

      - *(dict) --* 
        

        - **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.

              
        
      
        

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

          A token to resume pagination.

          
    