:doc:`CloudFrontKeyValueStore <../../cloudfront-keyvaluestore>` / Paginator / ListKeys

********
ListKeys
********



.. py:class:: CloudFrontKeyValueStore.Paginator.ListKeys

  ::

    
    paginator = client.get_paginator('list_keys')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CloudFrontKeyValueStore.Client.list_keys`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudfront-keyvaluestore-2022-07-26/ListKeys>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          KvsARN='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type KvsARN: string
    :param KvsARN: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the Key Value Store.

      

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

      
      ::

        {
            'Items': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Items** *(list) --* 

          Key value pairs

          
          

          - *(dict) --* 

            A key value pair.

            
            

            - **Key** *(string) --* 

              The key of the key value pair.

              
            

            - **Value** *(string) --* 

              The value of the key value pair.

              
        
      
    