:doc:`DocDB <../../docdb>` / Client / describe_db_subnet_groups

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



.. py:method:: DocDB.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``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/docdb-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 subnet group to return details for.

    

  
  :type Filters: list
  :param Filters: 

    This parameter is not currently supported.

    

  
    - *(dict) --* 

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

       

      Wildcards are not supported in filters.

      

    
      - **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 (marker) is included in the response so that the remaining results can be retrieved.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    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``.

    

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

    
    ::

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

    

    - *(dict) --* 

      Represents the output of  DescribeDBSubnetGroups.

      
      

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

        Detailed information about one or more subnet groups.

        
        

        - *(dict) --* 

          Detailed information about a subnet group.

          
          

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

            The name of the subnet group.

            
          

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

            Provides the description of the subnet group.

            
          

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

            Provides the virtual private cloud (VPC) ID of the subnet group.

            
          

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

            Provides the status of the subnet group.

            
          

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

            Detailed information about one or more subnets within a subnet group.

            
            

            - *(dict) --* 

              Detailed information about a subnet.

              
              

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

                Specifies the identifier of the subnet.

                
              

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

                Specifies the Availability Zone for the subnet.

                
                

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

                  The name of the Availability Zone.

                  
            
              

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

                Specifies 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).

            
            

            - *(string) --* 
        
      
    
  
  **Exceptions**
  
  *   :py:class:`DocDB.Client.exceptions.DBSubnetGroupNotFoundFault`

  