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

*************************
DescribeCacheSubnetGroups
*************************



.. py:class:: ElastiCache.Paginator.DescribeCacheSubnetGroups

  ::

    
    paginator = client.get_paginator('describe_cache_subnet_groups')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The name of the cache subnet 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**

      
      ::

        {
            'CacheSubnetGroups': [
                {
                    'CacheSubnetGroupName': 'string',
                    'CacheSubnetGroupDescription': 'string',
                    'VpcId': 'string',
                    'Subnets': [
                        {
                            'SubnetIdentifier': 'string',
                            'SubnetAvailabilityZone': {
                                'Name': 'string'
                            },
                            'SubnetOutpost': {
                                'SubnetOutpostArn': 'string'
                            },
                            'SupportedNetworkTypes': [
                                'ipv4'|'ipv6'|'dual_stack',
                            ]
                        },
                    ],
                    'ARN': 'string',
                    'SupportedNetworkTypes': [
                        'ipv4'|'ipv6'|'dual_stack',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

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

        
        

        - **CacheSubnetGroups** *(list) --* 

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

          
          

          - *(dict) --* 

            Represents the output of one of the following operations:

             

            
            * ``CreateCacheSubnetGroup``
             
            * ``ModifyCacheSubnetGroup``
            

            
            

            - **CacheSubnetGroupName** *(string) --* 

              The name of the cache subnet group.

              
            

            - **CacheSubnetGroupDescription** *(string) --* 

              The description of the cache subnet group.

              
            

            - **VpcId** *(string) --* 

              The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

              
            

            - **Subnets** *(list) --* 

              A list of subnets associated with the cache subnet group.

              
              

              - *(dict) --* 

                Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

                
                

                - **SubnetIdentifier** *(string) --* 

                  The unique identifier for the subnet.

                  
                

                - **SubnetAvailabilityZone** *(dict) --* 

                  The Availability Zone associated with the subnet.

                  
                  

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

                    The name of the Availability Zone.

                    
              
                

                - **SubnetOutpost** *(dict) --* 

                  The outpost ARN of the subnet.

                  
                  

                  - **SubnetOutpostArn** *(string) --* 

                    The outpost ARN of the subnet.

                    
              
                

                - **SupportedNetworkTypes** *(list) --* 

                  Either ``ipv4`` | ``ipv6`` | ``dual_stack``. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the `Nitro system <http://aws.amazon.com/ec2/nitro/>`__.

                  
                  

                  - *(string) --* 
              
            
          
            

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

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

              
            

            - **SupportedNetworkTypes** *(list) --* 

              Either ``ipv4`` | ``ipv6`` | ``dual_stack``. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the `Nitro system <http://aws.amazon.com/ec2/nitro/>`__.

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    