:doc:`Neptune <../../neptune>` / Client / describe_db_subnet_groups

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



.. py:method:: Neptune.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/neptune-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 is not currently supported.

    

  
    - *(dict) --* 

      This type is not currently supported.

      

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

        This parameter is not currently supported.

        

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

        This parameter is not currently supported.

        

      
        - *(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 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 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'
                          },
                          'SubnetStatus': 'string'
                      },
                  ],
                  'DBSubnetGroupArn': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **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 Neptune 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.

            
            

            - *(dict) --* 

              Specifies a subnet.

               

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

              
              

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

                Specifies the identifier of the subnet.

                
              

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

                Specifies the EC2 Availability Zone that the subnet is in.

                
                

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Neptune.Client.exceptions.DBSubnetGroupNotFoundFault`

  