Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DescribeCacheParameterGroupsCommand

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElastiCacheClient, DescribeCacheParameterGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
// const { ElastiCacheClient, DescribeCacheParameterGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
const client = new ElastiCacheClient(config);
const input = { // DescribeCacheParameterGroupsMessage
  CacheParameterGroupName: "STRING_VALUE",
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeCacheParameterGroupsCommand(input);
const response = await client.send(command);
// { // CacheParameterGroupsMessage
//   Marker: "STRING_VALUE",
//   CacheParameterGroups: [ // CacheParameterGroupList
//     { // CacheParameterGroup
//       CacheParameterGroupName: "STRING_VALUE",
//       CacheParameterGroupFamily: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       IsGlobal: true || false,
//       ARN: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

Loading code editorLoading code editor

DescribeCacheParameterGroupsCommand Input

See DescribeCacheParameterGroupsCommandInput for more details

Parameter	Type	Description
`CacheParameterGroupName`	`string \| undefined`	The name of a specific cache parameter group to return details for.
`Marker`	`string \| undefined`	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`.
`MaxRecords`	`number \| undefined`	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.

DescribeCacheParameterGroupsCommand Output

See DescribeCacheParameterGroupsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`CacheParameterGroups`	`CacheParameterGroup[] \| undefined`	A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
`Marker`	`string \| undefined`	Provides an identifier to allow retrieval of paginated results.

Throws

Name	Fault	Details
CacheParameterGroupNotFoundFault	client	The requested cache parameter group name does not refer to an existing cache parameter group.
InvalidParameterCombinationException	client	Two or more incompatible parameters were specified.
InvalidParameterValueException	client	The value for a parameter is invalid.
ElastiCacheServiceException		Base exception class for all service exceptions from ElastiCache service.

Getting Started

References