Menu
Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DescribeDBSubnetGroups

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBSubnetGroupName

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

Type: String

Required: No

Filters.Filter.N

This parameter is not currently supported.

Type: array of Filter objects

Required: No

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.

Type: String

Required: No

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

Required: No

Response Elements

The following elements are returned by the service.

DBSubnetGroups.DBSubnetGroup.N

A list of DBSubnetGroup instances.

Type: array of DBSubnetGroup objects

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DBSubnetGroupNotFoundFault

DBSubnetGroupName does not refer to an existing DB subnet group.

HTTP Status Code: 404

Example

Sample Request

Copy
https://rds.us-west-2.amazonaws.com/ ?Action=DescribeDBSubnetGroups &MaxRecords=100 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request &X-Amz-Date=20140421T194732Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=6cc9b2825866148e1d6290b8aa2e9d75b1884b116d8665759942d87ebfbed426

Sample Response

Copy
<DescribeDBSubnetGroupsResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <DescribeDBSubnetGroupsResult> <DBSubnetGroups> <DBSubnetGroup> <VpcId>vpc-e7abbdce</VpcId> <SubnetGroupStatus>Complete</SubnetGroupStatus> <DBSubnetGroupDescription>DB subnet group 1</DBSubnetGroupDescription> <DBSubnetGroupName>mydbsubnetgroup1</DBSubnetGroupName> <Subnets> <Subnet> <SubnetStatus>Active</SubnetStatus> <SubnetIdentifier>subnet-e8b3e5b1</SubnetIdentifier> <SubnetAvailabilityZone> <Name>us-west-2a</Name> <ProvisionedIopsCapable>false</ProvisionedIopsCapable> </SubnetAvailabilityZone> </Subnet> <Subnet> <SubnetStatus>Active</SubnetStatus> <SubnetIdentifier>subnet-44b2f22e</SubnetIdentifier> <SubnetAvailabilityZone> <Name>us-west-2b</Name> <ProvisionedIopsCapable>false</ProvisionedIopsCapable> </SubnetAvailabilityZone> </Subnet> </Subnets> </DBSubnetGroup> <DBSubnetGroup> <VpcId>vpc-c1e17bb8</VpcId> <SubnetGroupStatus>Complete</SubnetGroupStatus> <DBSubnetGroupDescription>My DB Subnet Group 2</DBSubnetGroupDescription> <DBSubnetGroupName>sub-grp-2</DBSubnetGroupName> <Subnets> <Subnet> <SubnetStatus>Active</SubnetStatus> <SubnetIdentifier>subnet-d281ef8a</SubnetIdentifier> <SubnetAvailabilityZone> <Name>us-west-2a</Name> <ProvisionedIopsCapable>false</ProvisionedIopsCapable> </SubnetAvailabilityZone> </Subnet> <Subnet> <SubnetStatus>Active</SubnetStatus> <SubnetIdentifier>subnet-b381ef9f</SubnetIdentifier> <SubnetAvailabilityZone> <Name>us-west-2c</Name> <ProvisionedIopsCapable>false</ProvisionedIopsCapable> </SubnetAvailabilityZone> </Subnet> <Subnet> <SubnetStatus>Active</SubnetStatus> <SubnetIdentifier>subnet-e1e17ebd</SubnetIdentifier> <SubnetAvailabilityZone> <Name>us-west-2b</Name> <ProvisionedIopsCapable>false</ProvisionedIopsCapable> </SubnetAvailabilityZone> </Subnet> </Subnets> </DBSubnetGroup> </DBSubnetGroups> </DescribeDBSubnetGroupsResult> <ResponseMetadata> <RequestId>b783db3b-b98c-11d3-fbc7-5c0aad74da7c</RequestId> </ResponseMetadata> </DescribeDBSubnetGroupsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: