Skip to content

RDS  >  Operations  >  describe_engine_default_cluster_parameters

describe_engine_default_cluster_parameters

Operation

describe_engine_default_cluster_parameters async

describe_engine_default_cluster_parameters(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeEngineDefaultClusterParametersInputDict]) -> DescribeEngineDefaultClusterParametersOutput

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

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeEngineDefaultClusterParametersOutput

An instance of DescribeEngineDefaultClusterParametersOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeEngineDefaultClusterParametersInput dataclass

Bases: _SerdeShape

Attributes
db_parameter_group_family class-attribute instance-attribute
db_parameter_group_family: str | None = ...

The name of the DB cluster parameter group family to return engine parameter information for.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

marker class-attribute instance-attribute
marker: str | None = ...

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

max_records class-attribute instance-attribute
max_records: int | None = ...

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Dictionaries

DescribeEngineDefaultClusterParametersInputDict

Bases: TypedDict

Dictionary form of DescribeEngineDefaultClusterParametersInput.

Attributes
db_parameter_group_family instance-attribute
db_parameter_group_family: Required[str]

The name of the DB cluster parameter group family to return engine parameter information for.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

marker instance-attribute
marker: str | None

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

max_records instance-attribute
max_records: int | None

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Output

DescribeEngineDefaultClusterParametersOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeEngineDefaultClusterParametersOutput structure.

Attributes

engine_defaults class-attribute instance-attribute
engine_defaults: EngineDefaults | None = ...

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.