describe_db_cluster_parameter_groups¶
Operation¶
describe_db_cluster_parameter_groups
¶
describe_db_cluster_parameter_groups(request: DescribeDBClusterParameterGroupsInput | DescribeDBClusterParameterGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterParameterGroupsInputDict]) -> DescribeDBClusterParameterGroupsOutput
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list will
contain only the description of the specified DB cluster parameter
group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBClusterParameterGroupsInput | DescribeDBClusterParameterGroupsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeDBClusterParameterGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBClusterParameterGroupsOutput
|
An instance of |
describe_db_cluster_parameter_groups
async
¶
describe_db_cluster_parameter_groups(request: DescribeDBClusterParameterGroupsInput | DescribeDBClusterParameterGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterParameterGroupsInputDict]) -> DescribeDBClusterParameterGroupsOutput
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list will
contain only the description of the specified DB cluster parameter
group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeDBClusterParameterGroupsInput | DescribeDBClusterParameterGroupsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DescribeDBClusterParameterGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeDBClusterParameterGroupsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeDBClusterParameterGroupsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBClusterParameterGroupsInput.
Attributes¶
db_cluster_parameter_group_name
instance-attribute
¶
db_cluster_parameter_group_name: str | None
The name of a specific DB cluster parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
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
DescribeDBClusterParameterGroups 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.
DescribeDBClusterParameterGroupsInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_cluster_parameter_group_name
class-attribute
instance-attribute
¶
db_cluster_parameter_group_name: str | None = ...
The name of a specific DB cluster parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
filters
class-attribute
instance-attribute
¶
This parameter isn't currently supported.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBClusterParameterGroups 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.
Output¶
DescribeDBClusterParameterGroupsOutput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_cluster_parameter_groups
class-attribute
instance-attribute
¶
db_cluster_parameter_groups: list[DBClusterParameterGroup] | None = ...
A list of DB cluster parameter groups.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBClusterParameterGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
response_metadata
class-attribute
instance-attribute
¶
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.