DescribeDBParameters - Amazon Relational Database Service

Description

Returns the detailed parameter list for a particular DBParameterGroup.

Request Parameters

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

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	Yes
`Marker`	An optional marker provided in the previous DescribeDBParameters 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
`Source`	The parameter types to return. Default: All parameter types returned Valid Values: `user \| system \| engine-default` Type: String	No

Response Elements

The following elements come wrapped in a DescribeDBParametersResult structure.

Name Description

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

Marker

The marker obtained from a previous operation response.

Type: String

Parameters

A list of Parameter instances.

Type: Parameter list

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=DescribeDBParameters
    &DBParameterGroupName=mydbparametergroup
    &Source=system
    &MaxRecords=100
    &Version=2012-04-23
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2011-05-11T19%3A31%3A42.262Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<DescribeDBParametersResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeDBParametersResult>
    <Parameters>
      <Parameter>
        <ParameterValue>/rdsdbbin/mysql</ParameterValue>
        <DataType>string</DataType>
        <Source>system</Source>
        <IsModifiable>false</IsModifiable>
        <Description>The MySQL installation base directory.</Description>
        <ApplyType>static</ApplyType>
        <ParameterName>basedir</ParameterName>
      </Parameter>
      <Parameter>
        <ParameterValue>32768</ParameterValue>
        <DataType>integer</DataType>
        <Source>system</Source>
        <IsModifiable>true</IsModifiable>
        <Description>The size of the cache to hold the SQL statements for the binary log during a transaction.</Description>
        <ApplyType>dynamic</ApplyType>
        <AllowedValues>4096-9223372036854775807</AllowedValues>
        <ParameterName>binlog_cache_size</ParameterName>
      </Parameter>
    </Parameters>
  </DescribeDBParametersResult>
  <ResponseMetadata>
    <RequestId>8743f2cf-bf41-11de-8c8e-49155882c409</RequestId>
  </ResponseMetadata>
</DescribeDBParametersResponse>