Amazon Relational Database Service
API Reference (API Version 2012-04-23)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

DescribeDBSecurityGroups

Description

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.

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
DBSecurityGroupName

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

Type: String

No
Marker

An optional marker provided in the previous DescribeDBSecurityGroups 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 DescribeDBSecurityGroupsResult structure.
NameDescription
DBSecurityGroups

A list of DBSecurityGroup instances.

Type: DBSecurityGroup 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
DBSecurityGroupNotFound

DBSecurityGroupName does not refer to an existing DB Security Group.

404

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=DescribeDBSecurityGroups
    &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

<DescribeDBSecurityGroupsResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeDBSecurityGroupsResult>
    <DBSecurityGroups>
      <DBSecurityGroup>
        <EC2SecurityGroups>
          <EC2SecurityGroup>
            <Status>authorized</Status>
            <EC2SecurityGroupName>myec2securitygroup</EC2SecurityGroupName>
            <EC2SecurityGroupOwnerId>054794666394</EC2SecurityGroupOwnerId>
          </EC2SecurityGroup>
        </EC2SecurityGroups>
        <DBSecurityGroupDescription>default</DBSecurityGroupDescription>
        <IPRanges>
          <IPRange>
            <CIDRIP>127.0.0.1/30</CIDRIP>
            <Status>authorized</Status>
          </IPRange>
        </IPRanges>
        <OwnerId>621567473609</OwnerId>
        <DBSecurityGroupName>default</DBSecurityGroupName>
        <VpcId>vpc-1ab2c3d4</VpcId>
      </DBSecurityGroup>
      <DBSecurityGroup>
        <EC2SecurityGroups/>
        <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>
        <IPRanges>
          <IPRange>
            <CIDRIP>192.168.1.1/24</CIDRIP>
            <Status>authorized</Status>
          </IPRange>
        </IPRanges>
        <OwnerId>621567473609</OwnerId>
        <DBSecurityGroupName>mydbsecuritygroup</DBSecurityGroupName>
        <VpcId>vpc-1ab2c3d5</VpcId>
      </DBSecurityGroup>
      <DBSecurityGroup>
        <EC2SecurityGroups/>
        <DBSecurityGroupDescription>My new DBSecurityGroup</DBSecurityGroupDescription>
        <IPRanges/>
        <OwnerId>621567473609</OwnerId>
        <DBSecurityGroupName>mydbsecuritygroup4</DBSecurityGroupName>
        <VpcId>vpc-1ab2c3d6</VpcId>
      </DBSecurityGroup>
    </DBSecurityGroups>
  </DescribeDBSecurityGroupsResult>
  <ResponseMetadata>
    <RequestId>bbdad154-bf42-11de-86a4-97241dfaadff</RequestId>
  </ResponseMetadata>
</DescribeDBSecurityGroupsResponse>