Menu
Amazon ElastiCache
API Reference (API Version 2015-02-02)

DescribeCacheParameters

Returns the detailed parameter list for a particular cache parameter group.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CacheParameterGroupName

The name of a specific cache parameter group to return details for.

Type: String

Required: Yes

Marker

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: 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 can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Type: Integer

Required: No

Source

The parameter types to return.

Valid values: user | system | engine-default

Type: String

Required: No

Response Elements

The following elements are returned by the service.

CacheNodeTypeSpecificParameters.CacheNodeTypeSpecificParameter.N

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

Type: Array of CacheNodeTypeSpecificParameter objects

Marker

Provides an identifier to allow retrieval of paginated results.

Type: String

Parameters.Parameter.N

A list of Parameter instances.

Type: Array of Parameter objects

Errors

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

CacheParameterGroupNotFound

The requested cache parameter group name does not refer to an existing cache parameter group.

HTTP Status Code: 404

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

Example

Some of the output has been omitted for brevity.

Sample Request

Copy
https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheParameters &CacheParameterGroupName=default.memcached1.4 &MaxRecords=100 &Version=2015-02-02 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

Sample Response

Copy
<DescribeCacheParametersResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/"> <DescribeCacheParametersResult> <CacheNodeTypeSpecificParameters> <CacheNodeTypeSpecificParameter> <CacheNodeTypeSpecificValues> <CacheNodeTypeSpecificValue> <CacheNodeType>cache.c1.xlarge</CacheNodeType> <Value>6000</Value> </CacheNodeTypeSpecificValue> (...output omitted...) </CacheNodeTypeSpecificValues> <DataType>integer</DataType> <Source>system</Source> <IsModifiable>false</IsModifiable> <Description>The maximum configurable amount of memory to use to store items, in megabytes.</Description> <AllowedValues>1-100000</AllowedValues> <ParameterName>max_cache_memory</ParameterName> <MinimumEngineVersion>1.4.5</MinimumEngineVersion> </CacheNodeTypeSpecificParameter> <CacheNodeTypeSpecificParameter> (...output omitted...) </CacheNodeTypeSpecificParameter> </CacheNodeTypeSpecificParameters> <Parameters> <Parameter> <ParameterValue>1024</ParameterValue> <DataType>integer</DataType> <Source>system</Source> <IsModifiable>false</IsModifiable> <Description>The backlog queue limit.</Description> <AllowedValues>1-10000</AllowedValues> <ParameterName>backlog_queue_limit</ParameterName> <MinimumEngineVersion>1.4.5</MinimumEngineVersion> </Parameter> (...output omitted...) </Parameters> </DescribeCacheParametersResult> <ResponseMetadata> <RequestId>0c507368-b7fe-11e0-9326-b7275b9d4a6c</RequestId> </ResponseMetadata> </DescribeCacheParametersResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: