DocDB / Client / describe_db_cluster_parameters

describe_db_cluster_parameters

DocDB.Client.describe_db_cluster_parameters(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DBClusterParameterGroupName (string) –

  [REQUIRED]

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

  Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup .

• Source (string) – A value that indicates to return only parameters for a specific source. Parameter sources can be engine , service , or customer .

• Filters (list) –

  This parameter is not currently supported.

  • (dict) –

    A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

    Wildcards are not supported in filters.

    • 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 (marker) is included in the response so that the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

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

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

Response Structure

• (dict) –

  Represents the output of DBClusterParameterGroup.

  • Parameters (list) –

    Provides a list of parameters for the cluster parameter group.

    • (dict) –

      Detailed information about an individual parameter.

      • ParameterName (string) –

        Specifies the name of the parameter.

      • ParameterValue (string) –

        Specifies the value of the parameter.

      • Description (string) –

        Provides a description of the parameter.

      • Source (string) –

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

  • 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

• DocDB.Client.exceptions.DBParameterGroupNotFoundFault