Redshift / Client / describe_cluster_parameters

describe_cluster_parameters#

Redshift.Client.describe_cluster_parameters(**kwargs)#

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_parameters(
    ParameterGroupName='string',
    Source='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • ParameterGroupName (string) –

    [REQUIRED]

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

  • Source (string) –

    The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

    Default: All parameter types returned.

    Valid Values: user | engine-default

  • MaxRecords (integer) –

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • Marker (string) – An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Return type:

dict

Returns:

Response Syntax

{
    'Parameters': [
        {
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'ApplyType': 'static'|'dynamic',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –

    Contains the output from the DescribeClusterParameters action.

    • Parameters (list) –

      A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

      • (dict) –

        Describes a parameter in a cluster parameter group.

        • ParameterName (string) –

          The name of the parameter.

        • ParameterValue (string) –

          The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

        • Description (string) –

          A description of the parameter.

        • Source (string) –

          The source of the parameter value, such as “engine-default” or “user”.

        • DataType (string) –

          The data type of the parameter.

        • AllowedValues (string) –

          The valid range of values for the parameter.

        • ApplyType (string) –

          Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

        • IsModifiable (boolean) –

          If true, 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.

    • Marker (string) –

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Exceptions