DescribeDBParameterGroups - Amazon Relational Database Service

Description

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required

Name	Description	Required
`DBParameterGroupName`	The name of a specific DB Parameter Group to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Type: String	No
`Marker`	An optional marker provided in the previous DescribeDBParameterGroups 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

DBParameterGroupName

The name of a specific DB Parameter Group to return details for.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Type: String

No

Marker

An optional marker provided in the previous DescribeDBParameterGroups 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 DescribeDBParameterGroupsResult structure.

Name Description

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

DBParameterGroups

A list of DBParameterGroup instances.

Type: DBParameterGroup 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
`DBParameterGroupNotFound`	DBParameterGroupName does not refer to an existing DB Parameter Group.	404

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=DescribeDBParameterGroups
    &DBParameterGroupName=myparamsgroup
    &MaxRecords=100
    &Version=2012-04-23
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2011-02-15T17%3A54%3A32.899Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<DescribeDBParameterGroupsResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeDBParameterGroupsResult>
    <DBParameterGroups>
      <DBParameterGroup>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <Description>Default parameter group for mysql5.1</Description>
        <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>
      </DBParameterGroup>
      <DBParameterGroup>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <Description>My DB Param Group</Description>
        <DBParameterGroupName>testdbparamgroup</DBParameterGroupName>
      </DBParameterGroup>
    </DBParameterGroups>
  </DescribeDBParameterGroupsResult>
  <ResponseMetadata>
    <RequestId>cb8d9bb4-a02a-11df-bd60-c955b7d6e8e0</RequestId>
  </ResponseMetadata>
</DescribeDBParameterGroupsResponse>