DescribeEngineDefaultParameters - Amazon Relational Database Service

Description

Returns the default engine and system parameter information for the specified database engine.

Request Parameters

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

Name Description Required

Name	Description	Required
`DBParameterGroupFamily`	The name of the DB Parameter Group Family. Type: String	Yes
`Marker`	An optional marker provided in the previous DescribeEngineDefaultParameters 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

DBParameterGroupFamily

The name of the DB Parameter Group Family.

Type: String

Yes

Marker

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

Name Description

Name	Description
`DBParameterGroupFamily`	Specifies the name of the DB Parameter Group Family which the engine default parameters apply to. Type: String
`Marker`	Provides an identifier to allow retrieval of paginated results. Type: String
`Parameters`	Contains a list of engine default parameters. Type: Parameter list

DBParameterGroupFamily

Specifies the name of the DB Parameter Group Family which the engine default parameters apply to.

Type: String

Marker

Provides an identifier to allow retrieval of paginated results.

Type: String

Parameters

Contains a list of engine default parameters.

Type: Parameter list

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=DescribeEngineDefaultParameters
    &DBParameterGroupFamily=mysql5.1
    &Version=2012-04-23    
    &MaxRecords=100
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2011-02-15T19%3A10%3A03.510Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<DescribeEngineDefaultParametersResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeEngineDefaultParametersResult>
    <EngineDefaults>
      <Marker>bG93ZXJfY2FzZV90YWJsZV9uYW1lcw==</Marker>
      <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
      <Parameters>
        <Parameter>
          <DataType>boolean</DataType>
          <Source>engine-default</Source>
          <IsModifiable>false</IsModifiable>
          <Description>Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded</Description>
          <ApplyType>static</ApplyType>
          <AllowedValues>0,1</AllowedValues>
          <ParameterName>allow-suspicious-udfs</ParameterName>
        </Parameter>
        <Parameter>
          <DataType>integer</DataType>
          <Source>engine-default</Source>
          <IsModifiable>true</IsModifiable>
          <Description>Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns</Description>
          <ApplyType>dynamic</ApplyType>
          <AllowedValues>1-65535</AllowedValues>
          <ParameterName>auto_increment_increment</ParameterName>
        </Parameter>
        <Parameter>
          <DataType>integer</DataType>
          <Source>engine-default</Source>
          <IsModifiable>true</IsModifiable>
          <Description>Determines the starting point for the AUTO_INCREMENT column value</Description>
          <ApplyType>dynamic</ApplyType>
          <AllowedValues>1-65535</AllowedValues>
          <ParameterName>auto_increment_offset</ParameterName>
        </Parameter>       
    </EngineDefaults>
  </DescribeEngineDefaultParametersResult>
  <ResponseMetadata>
    <RequestId>6c1341eb-a124-11df-bf5c-973b09643c5d</RequestId>
  </ResponseMetadata>
</DescribeEngineDefaultParametersResponse>