describe_db_parameter_groups¶
Operation¶
async
¶
describe_db_parameter_groups(input: DescribeDBParameterGroupsInput, plugins: list[Plugin] | None = None) -> DescribeDBParameterGroupsOutput
Returns a list of DBParameterGroup descriptions. If a
DBParameterGroupName is specified, the list will contain only the
description of the specified DB parameter group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeDBParameterGroupsInput
|
An instance of |
required |
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 |
|---|---|
DescribeDBParameterGroupsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_parameter_group_name: str | None = ...
The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
This parameter isn't currently supported.
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBParameterGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
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 that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeDBParameterGroups action.
Attributes¶
class-attribute
instance-attribute
¶
db_parameter_groups: list[DBParameterGroup] | None = ...
A list of DBParameterGroup instances.
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
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.