RDS / Client / describe_engine_default_parameters

describe_engine_default_parameters

RDS.Client.describe_engine_default_parameters(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_engine_default_parameters(
    DBParameterGroupFamily='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• DBParameterGroupFamily (string) –

  [REQUIRED]

  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-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 (list) –

  This parameter isn’t currently supported.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribeDBRecommendations

    • DescribeDBShardGroups

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) –

• MaxRecords (integer) –

  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.

• Marker (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'EngineDefaults': {
        'DBParameterGroupFamily': 'string',
        'Marker': 'string',
        'Parameters': [
            {
                'ParameterName': 'string',
                'ParameterValue': 'string',
                'Description': 'string',
                'Source': 'string',
                'ApplyType': 'string',
                'DataType': 'string',
                'AllowedValues': 'string',
                'IsModifiable': True|False,
                'MinimumEngineVersion': 'string',
                'ApplyMethod': 'immediate'|'pending-reboot',
                'SupportedEngineModes': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

• (dict) –

  • EngineDefaults (dict) –

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

    • DBParameterGroupFamily (string) –

      Specifies the name of the DB parameter group family that the engine default parameters apply to.

    • Marker (string) –

      An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    • Parameters (list) –

      Contains a list of engine default parameters.

      • (dict) –

        This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

        This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

        • ParameterName (string) –

          The name of the parameter.

        • ParameterValue (string) –

          The value of the parameter.

        • Description (string) –

          Provides a description of the parameter.

        • Source (string) –

          The source of the parameter value.

        • ApplyType (string) –

          Specifies the engine specific parameters type.

        • DataType (string) –

          Specifies the valid data type for the parameter.

        • AllowedValues (string) –

          Specifies the valid range of values for the parameter.

        • IsModifiable (boolean) –

          Indicates whether ( true) or not ( false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion (string) –

          The earliest engine version to which the parameter can apply.

        • ApplyMethod (string) –

          Indicates when to apply parameter updates.

        • SupportedEngineModes (list) –

          The valid DB engine modes.

          • (string) –

Examples

This example lists default parameters for the specified DB engine.

response = client.describe_engine_default_parameters(
    DBParameterGroupFamily='mysql5.6',
)

print(response)

Expected Output:

{
    'EngineDefaults': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}