describe_db_parameters¶
Operation¶
describe_db_parameters
async
¶
describe_db_parameters(request: DescribeDBParametersInput | DescribeDBParametersInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBParametersOutput
describe_db_parameters(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBParametersInputDict]) -> DescribeDBParametersOutput
Returns the detailed parameter list for a particular 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 |
|---|---|
DescribeDBParametersOutput
|
An instance of |
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¶
DescribeDBParametersInput
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 DBParameterGroup.
filters
class-attribute
instance-attribute
¶
A filter that specifies one or more DB parameters to describe.
The only supported filter is parameter-name. The results list only
includes information about the DB parameters with these names.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBParameters 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¶
DescribeDBParametersInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBParametersInput.
Attributes¶
db_parameter_group_name
instance-attribute
¶
The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
A filter that specifies one or more DB parameters to describe.
The only supported filter is parameter-name. The results list only
includes information about the DB parameters with these names.
marker
instance-attribute
¶
marker: str | None
An optional pagination token provided by a previous
DescribeDBParameters 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¶
DescribeDBParametersOutput
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeDBParameters action.
Attributes¶
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.
parameters
class-attribute
instance-attribute
¶
A list of Parameter values.
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.