Skip to content

RDS  >  Operations  >  describe_engine_default_parameters

describe_engine_default_parameters

Operation

describe_engine_default_parameters async 

describe_engine_default_parameters(input: DescribeEngineDefaultParametersInput, plugins: list[Plugin] | None = None) -> DescribeEngineDefaultParametersOutput

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

Parameters:

Name Type Description Default
input DescribeEngineDefaultParametersInput

An instance of DescribeEngineDefaultParametersInput.

 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
DescribeEngineDefaultParametersOutput

An instance of DescribeEngineDefaultParametersOutput.

Input

DescribeEngineDefaultParametersInput dataclass

Bases: _SerdeShape

Attributes

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

The name of the DB parameter group family.

Valid Values:

  • aurora-mysql5.7

  • aurora-mysql8.0

  • aurora-postgresql10

  • aurora-postgresql11

  • aurora-postgresql12

  • aurora-postgresql13

  • aurora-postgresql14

  • custom-oracle-ee-19

  • custom-oracle-ee-cdb-19

  • db2-ae

  • db2-ce

  • db2-se

  • mariadb10.2

  • mariadb10.3

  • mariadb10.4

  • mariadb10.5

  • mariadb10.6

  • mysql5.7

  • mysql8.0

  • oracle-ee-19

  • oracle-ee-cdb-19

  • oracle-ee-cdb-21

  • oracle-se2-19

  • oracle-se2-cdb-19

  • oracle-se2-cdb-21

  • postgres10

  • postgres11

  • postgres12

  • postgres13

  • postgres14

  • sqlserver-ee-11.0

  • sqlserver-ee-12.0

  • sqlserver-ee-13.0

  • sqlserver-ee-14.0

  • sqlserver-ee-15.0

  • sqlserver-ex-11.0

  • sqlserver-ex-12.0

  • sqlserver-ex-13.0

  • sqlserver-ex-14.0

  • sqlserver-ex-15.0

  • sqlserver-se-11.0

  • sqlserver-se-12.0

  • sqlserver-se-13.0

  • sqlserver-se-14.0

  • sqlserver-se-15.0

  • sqlserver-web-11.0

  • sqlserver-web-12.0

  • sqlserver-web-13.0

  • sqlserver-web-14.0

  • sqlserver-web-15.0

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

A filter that specifies one or more parameters to describe.

The only supported filter is parameter-name. The results list only includes information about the parameters with these names.

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

An optional pagination token provided by a previous DescribeEngineDefaultParameters 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

DescribeEngineDefaultParametersOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeEngineDefaultParametersOutput 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.