DescribeDBClusterParametersCommand

Suggest an Edit

Returns the detailed parameter list for a particular DB cluster parameter group.

Example Syntax

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

import { NeptuneClient, DescribeDBClusterParametersCommand } from "@aws-sdk/client-neptune"; // ES Modules import
// const { NeptuneClient, DescribeDBClusterParametersCommand } = require("@aws-sdk/client-neptune"); // CommonJS import
const client = new NeptuneClient(config);
const input = { // DescribeDBClusterParametersMessage
  DBClusterParameterGroupName: "STRING_VALUE", // required
  Source: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeDBClusterParametersCommand(input);
const response = await client.send(command);
// { // DBClusterParameterGroupDetails
//   Parameters: [ // ParametersList
//     { // Parameter
//       ParameterName: "STRING_VALUE",
//       ParameterValue: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       Source: "STRING_VALUE",
//       ApplyType: "STRING_VALUE",
//       DataType: "STRING_VALUE",
//       AllowedValues: "STRING_VALUE",
//       IsModifiable: true || false,
//       MinimumEngineVersion: "STRING_VALUE",
//       ApplyMethod: "immediate" || "pending-reboot",
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeDBClusterParametersCommand Input

See DescribeDBClusterParametersCommandInput for more details

Parameter
Type
Description
DBClusterParameterGroupName
Required
string | undefined

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

Constraints:

  • If supplied, 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 DescribeDBClusterParameters 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 called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Source
string | undefined

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

DescribeDBClusterParametersCommand Output

See DescribeDBClusterParametersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Marker
string | undefined

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

Parameters
Parameter[] | undefined

Provides a list of parameters for the DB cluster parameter group.

Throws

Name
Fault
Details
DBParameterGroupNotFoundFault
client

DBParameterGroupName does not refer to an existing DB parameter group.

NeptuneServiceException
Base exception class for all service exceptions from Neptune service.