:doc:`Kafka <../../kafka>` / Paginator / ListScramSecrets

****************
ListScramSecrets
****************



.. py:class:: Kafka.Paginator.ListScramSecrets

  ::

    
    paginator = client.get_paginator('list_scram_secrets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Kafka.Client.list_scram_secrets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListScramSecrets>`_    


    **Request Syntax**
    ::

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

      The arn of the cluster.

      

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

      
      ::

        {
            'SecretArnList': [
                'string',
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 

        200 response

        
        

        - **SecretArnList** *(list) --* 

          The list of scram secrets associated with the cluster.

          
          

          - *(string) --* 
      
    