RDS / Client / describe_db_parameters

describe_db_parameters

RDS.Client.describe_db_parameters(**kwargs)

Returns the detailed parameter list for a particular DB parameter group.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DBParameterGroupName (string) –

  [REQUIRED]

  The name of a specific DB parameter group to return details for.

  Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

• Source (string) –

  The parameter types to return.

  Default: All parameter types returned

  Valid Values: user | system | engine-default

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

  Default: 100

  Constraints: Minimum 20, maximum 100.

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

Return type:

dict

Returns:

Response Syntax

{
    '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',
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

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

  • Parameters (list) –

    A list of Parameter values.

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

  • Marker (string) –

    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.

Exceptions

• RDS.Client.exceptions.DBParameterGroupNotFoundFault

Examples

This example lists information for up to the first 20 system parameters for the specified DB parameter group.

response = client.describe_db_parameters(
    DBParameterGroupName='mymysqlparametergroup',
    MaxRecords=20,
    Source='system',
)

print(response)

Expected Output:

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