:doc:`DAX <../../dax>` / Paginator / DescribeSubnetGroups

********************
DescribeSubnetGroups
********************



.. py:class:: DAX.Paginator.DescribeSubnetGroups

  ::

    
    paginator = client.get_paginator('describe_subnet_groups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DAX.Client.describe_subnet_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeSubnetGroups>`_    


    **Request Syntax**
    ::

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

      The name of the subnet group.

      

    
      - *(string) --* 

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

      
      ::

        {
            'SubnetGroups': [
                {
                    'SubnetGroupName': 'string',
                    'Description': 'string',
                    'VpcId': 'string',
                    'Subnets': [
                        {
                            'SubnetIdentifier': 'string',
                            'SubnetAvailabilityZone': 'string',
                            'SupportedNetworkTypes': [
                                'ipv4'|'ipv6'|'dual_stack',
                            ]
                        },
                    ],
                    'SupportedNetworkTypes': [
                        'ipv4'|'ipv6'|'dual_stack',
                    ]
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **SubnetGroups** *(list) --* 

          An array of subnet groups. Each element in the array represents a single subnet group.

          
          

          - *(dict) --* 

            Represents the output of one of the following actions:

             

            
            * *CreateSubnetGroup*
             
            * *ModifySubnetGroup*
            

            
            

            - **SubnetGroupName** *(string) --* 

              The name of the subnet group.

              
            

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

              The description of the subnet group.

              
            

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

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

              
            

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

              A list of subnets associated with the subnet group.

              
              

              - *(dict) --* 

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

                
                

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

                  The system-assigned identifier for the subnet.

                  
                

                - **SubnetAvailabilityZone** *(string) --* 

                  The Availability Zone (AZ) for the subnet.

                  
                

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

                  The network types supported by this subnet. Returns an array of strings that can include ``ipv4``, ``ipv6``, or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.

                  
                  

                  - *(string) --* 
              
            
          
            

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

              The network types supported by this subnet. Returns an array of strings that can include ``ipv4``, ``ipv6``, or both, indicating whether the subnet group supports IPv4 only, IPv6 only, or dual-stack deployments.

              
              

              - *(string) --* 
          
        
      
    