:doc:`RDS <../../rds>` / Paginator / DescribeDBSubnetGroups

**********************
DescribeDBSubnetGroups
**********************



.. py:class:: RDS.Paginator.DescribeDBSubnetGroups

  ::

    
    paginator = client.get_paginator('describe_db_subnet_groups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`RDS.Client.describe_db_subnet_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSubnetGroups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DBSubnetGroupName='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DBSubnetGroupName: string
    :param DBSubnetGroupName: 

      The name of the DB subnet group to return details for.

      

    
    :type Filters: list
    :param Filters: 

      This parameter isn't currently supported.

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

         

        .. note::

          

          Currently, wildcards are not supported in filters.

          

         

        The following actions can be filtered:

         

        
        * ``DescribeDBClusterBacktracks``
         
        * ``DescribeDBClusterEndpoints``
         
        * ``DescribeDBClusters``
         
        * ``DescribeDBInstances``
         
        * ``DescribeDBRecommendations``
         
        * ``DescribeDBShardGroups``
         
        * ``DescribePendingMaintenanceActions``
        

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          One or more filter values. Filter values are case-sensitive.

          

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

      
      ::

        {
            'DBSubnetGroups': [
                {
                    'DBSubnetGroupName': 'string',
                    'DBSubnetGroupDescription': 'string',
                    'VpcId': 'string',
                    'SubnetGroupStatus': 'string',
                    'Subnets': [
                        {
                            'SubnetIdentifier': 'string',
                            'SubnetAvailabilityZone': {
                                'Name': 'string'
                            },
                            'SubnetOutpost': {
                                'Arn': 'string'
                            },
                            'SubnetStatus': 'string'
                        },
                    ],
                    'DBSubnetGroupArn': 'string',
                    'SupportedNetworkTypes': [
                        'string',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the result of a successful invocation of the ``DescribeDBSubnetGroups`` action.

        
        

        - **DBSubnetGroups** *(list) --* 

          A list of ``DBSubnetGroup`` instances.

          
          

          - *(dict) --* 

            Contains the details of an Amazon RDS DB subnet group.

             

            This data type is used as a response element in the ``DescribeDBSubnetGroups`` action.

            
            

            - **DBSubnetGroupName** *(string) --* 

              The name of the DB subnet group.

              
            

            - **DBSubnetGroupDescription** *(string) --* 

              Provides the description of the DB subnet group.

              
            

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

              Provides the VpcId of the DB subnet group.

              
            

            - **SubnetGroupStatus** *(string) --* 

              Provides the status of the DB subnet group.

              
            

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

              Contains a list of ``Subnet`` elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

              
              

              - *(dict) --* 

                This data type is used as a response element for the ``DescribeDBSubnetGroups`` operation.

                
                

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

                  The identifier of the subnet.

                  
                

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

                  Contains Availability Zone information.

                   

                  This data type is used as an element in the ``OrderableDBInstanceOption`` data type.

                  
                  

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

                    The name of the Availability Zone.

                    
              
                

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

                  If the subnet is associated with an Outpost, this value specifies the Outpost.

                   

                  For more information about RDS on Outposts, see `Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`__ in the *Amazon RDS User Guide.*

                  
                  

                  - **Arn** *(string) --* 

                    The Amazon Resource Name (ARN) of the Outpost.

                    
              
                

                - **SubnetStatus** *(string) --* 

                  The status of the subnet.

                  
            
          
            

            - **DBSubnetGroupArn** *(string) --* 

              The Amazon Resource Name (ARN) for the DB subnet group.

              
            

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

              The network type of the DB subnet group.

               

              Valid values:

               

              
              * ``IPV4``
               
              * ``DUAL``
              

               

              A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( ``DUAL``).

               

              For more information, see `Working with a DB instance in a VPC <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html>`__ in the *Amazon RDS User Guide.*

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    