DescribeDBSubnetGroups - Amazon Relational Database Service

Description

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 common parameters that all actions use, see Common Query Parameters.

Name Description Required

Name	Description	Required
`DBSubnetGroupName`	The name of the DB Subnet Group to return details for. Type: String	No
`Marker`	An optional marker provided in the 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	No
`MaxRecords`	The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer	No

DBSubnetGroupName

The name of the DB Subnet Group to return details for.

Type: String

No

Marker

An optional marker provided in the 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

No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

Type: Integer

No

Response Elements

The following elements come wrapped in a DescribeDBSubnetGroupsResult structure.

Name Description

Name	Description
`DBSubnetGroups`	A list of DBSubnetGroup instances. Type: DBSubnetGroup list
`Marker`	The marker obtained from a previous operation response. Type: String

DBSubnetGroups

A list of DBSubnetGroup instances.

Type: DBSubnetGroup list

Marker

The marker obtained from a previous operation response.

Type: String

Errors

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

Error	Description	HTTP Status Code
`DBSubnetGroupNotFound`	DBSubnetGroupName does not refer to an existing DB Subnet Group.	400

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=DescribeDBSubnetGroups
    &Version=2012-04-23
    &MaxRecords=100
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2011-02-15T19%3A40%3A19.926Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<DescribeDBSubnetGroupsResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
        <DescribeDBSubnetGroupsResult>
            <DBSubnetGroups>
                <DBSubnetGroup>
                    <VpcId>990524496922</VpcId>
                    <SubnetGroupStatus>Complete</SubnetGroupStatus>
                    <DBSubnetGroupDescription>description</DBSubnetGroupDescription>
                    <DBSubnetGroupName>subnet_grp1</DBSubnetGroupName>
                    <Subnets>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-east-1c</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-east-1b</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-east-1d</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                    </Subnets>
                </DBSubnetGroup>
                <DBSubnetGroup>
                    <VpcId>990524496922</VpcId>
                    <SubnetGroupStatus>Complete</SubnetGroupStatus>
                    <DBSubnetGroupDescription>description</DBSubnetGroupDescription>
                    <DBSubnetGroupName>subnet_grp2</DBSubnetGroupName>
                    <Subnets>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-east-1c</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-east-1b</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                        <Subnet>
                            <SubnetStatus>Active</SubnetStatus>
                            <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>
                            <SubnetAvailabilityZone>
                                <Name>us-east-1d</Name>
                            </SubnetAvailabilityZone>
                        </Subnet>
                    </Subnets>
                </DBSubnetGroup>
            </DBSubnetGroups>
        </DescribeDBSubnetGroupsResult>
        <ResponseMetadata>
            <RequestId>31d0faee-229b-11e1-81f1-df3a2a803dad</RequestId>
        </ResponseMetadata>
    </DescribeDBSubnetGroupsResponse>