:doc:`RDS <../../rds>` / Client / describe_db_subnet_groups

*************************
describe_db_subnet_groups
*************************



.. py:method:: RDS.Client.describe_db_subnet_groups(**kwargs)

  

  Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

   

  For an overview of CIDR ranges, go to the `Wikipedia Tutorial <http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing>`__.

  

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


  **Request Syntax**
  ::

    response = client.describe_db_subnet_groups(
        DBSubnetGroupName='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='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 MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 

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

      
      

      - **Marker** *(string) --* 

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

        
      

      - **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) --* 
        
      
    
  
  **Exceptions**
  
  *   :py:class:`RDS.Client.exceptions.DBSubnetGroupNotFoundFault`

  

  **Examples**

  This example lists information about the specified DB subnet group.
  ::

    response = client.describe_db_subnet_groups(
        DBSubnetGroupName='mydbsubnetgroup',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ResponseMetadata': {
            '...': '...',
        },
    }

  