Redshift / Paginator / DescribeDefaultClusterParameters

DescribeDefaultClusterParameters

class Redshift.Paginator.DescribeDefaultClusterParameters

paginator = client.get_paginator('describe_default_cluster_parameters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_default_cluster_parameters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ParameterGroupFamily='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ParameterGroupFamily (string) –

  [REQUIRED]

  The name of the cluster parameter group family.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • DefaultClusterParameters (dict) –

    Describes the default cluster parameters for a parameter group family.

    • ParameterGroupFamily (string) –

      The name of the cluster parameter group family to which the engine default parameters 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.

    • Parameters (list) –

      The list of cluster default parameters.

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

  • NextToken (string) –

    A token to resume pagination.