Skip to content

RDS  >  Operations  >  describe_db_parameter_groups

describe_db_parameter_groups

Operation

describe_db_parameter_groups async

describe_db_parameter_groups(request: DescribeDBParameterGroupsInput | DescribeDBParameterGroupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBParameterGroupsOutput
describe_db_parameter_groups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBParameterGroupsInputDict]) -> 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
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 DescribeDBParameterGroupsOutput.

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

DescribeDBParameterGroupsInput dataclass

Bases: _SerdeShape

Attributes
db_parameter_group_name 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.
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 DescribeDBParameterGroups 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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Dictionaries

DescribeDBParameterGroupsInputDict

Bases: TypedDict

Dictionary form of DescribeDBParameterGroupsInput.

Attributes
db_parameter_group_name 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.
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 DescribeDBParameterGroups 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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Output

DescribeDBParameterGroupsOutput dataclass

Bases: _SerdeShape

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

Attributes

db_parameter_groups class-attribute instance-attribute
db_parameter_groups: list[DBParameterGroup] | None = ...

A list of DBParameterGroup instances.

marker 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.

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.