DescribeDBClusterParameterGroupsCommand

Suggest an Edit

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

Example Syntax

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

import { DocDBClient, DescribeDBClusterParameterGroupsCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribeDBClusterParameterGroupsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribeDBClusterParameterGroupsMessage
  DBClusterParameterGroupName: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeDBClusterParameterGroupsCommand(input);
const response = await client.send(command);
// { // DBClusterParameterGroupsMessage
//   Marker: "STRING_VALUE",
//   DBClusterParameterGroups: [ // DBClusterParameterGroupList
//     { // DBClusterParameterGroup
//       DBClusterParameterGroupName: "STRING_VALUE",
//       DBParameterGroupFamily: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       DBClusterParameterGroupArn: "STRING_VALUE",
//     },
//   ],
// };

DescribeDBClusterParameterGroupsCommand Input

See DescribeDBClusterParameterGroupsCommandInput for more details

Parameter
Type
Description
DBClusterParameterGroupName
string | undefined

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

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

Filters
Filter[] | undefined

This parameter is not currently supported.

Marker
string | undefined

An optional pagination token provided by a previous request. 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 pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeDBClusterParameterGroupsCommand Output

See DescribeDBClusterParameterGroupsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBClusterParameterGroups
DBClusterParameterGroup[] | undefined

A list of cluster parameter groups.

Marker
string | undefined

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Throws

Name
Fault
Details
DBParameterGroupNotFoundFault
client

DBParameterGroupName doesn't refer to an existing parameter group.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.