DescribeClusterParameters¶

class Redshift.Paginator.DescribeClusterParameters¶

paginator = client.get_paginator('describe_cluster_parameters')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ParameterGroupName='string',
    Source='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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
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

{
    '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) --

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.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeClusterParameters¶