:doc:`ElastiCache <../../elasticache>` / Paginator / DescribeCacheParameterGroups

****************************
DescribeCacheParameterGroups
****************************



.. py:class:: ElastiCache.Paginator.DescribeCacheParameterGroups

  ::

    
    paginator = client.get_paginator('describe_cache_parameter_groups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_parameter_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheParameterGroups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CacheParameterGroupName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CacheParameterGroupName: string
    :param CacheParameterGroupName: 

      The name of a specific cache parameter group to return details for.

      

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

      
      ::

        {
            'CacheParameterGroups': [
                {
                    'CacheParameterGroupName': 'string',
                    'CacheParameterGroupFamily': 'string',
                    'Description': 'string',
                    'IsGlobal': True|False,
                    'ARN': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of a ``DescribeCacheParameterGroups`` operation.

        
        

        - **CacheParameterGroups** *(list) --* 

          A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

          
          

          - *(dict) --* 

            Represents the output of a ``CreateCacheParameterGroup`` operation.

            
            

            - **CacheParameterGroupName** *(string) --* 

              The name of the cache parameter group.

              
            

            - **CacheParameterGroupFamily** *(string) --* 

              The name of the cache parameter group family that this cache parameter group is compatible with.

               

              Valid values are: ``memcached1.4`` | ``memcached1.5`` | ``memcached1.6`` | ``redis2.6`` | ``redis2.8`` | ``redis3.2`` | ``redis4.0`` | ``redis5.0`` | ``redis6.x`` | ``redis7``

              
            

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

              The description for this cache parameter group.

              
            

            - **IsGlobal** *(boolean) --* 

              Indicates whether the parameter group is associated with a Global datastore

              
            

            - **ARN** *(string) --* 

              The ARN (Amazon Resource Name) of the cache parameter group.

              
        
      
        

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

          A token to resume pagination.

          
    