Redshift / Paginator / DescribeNodeConfigurationOptions

DescribeNodeConfigurationOptions

class Redshift.Paginator.DescribeNodeConfigurationOptions

paginator = client.get_paginator('describe_node_configuration_options')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ActionType='restore-cluster'|'recommend-node-config'|'resize-cluster',
    ClusterIdentifier='string',
    SnapshotIdentifier='string',
    SnapshotArn='string',
    OwnerAccount='string',
    Filters=[
        {
            'Name': 'NodeType'|'NumberOfNodes'|'EstimatedDiskUtilizationPercent'|'Mode',
            'Operator': 'eq'|'lt'|'gt'|'le'|'ge'|'in'|'between',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ActionType (string) –

  [REQUIRED]

  The action type to evaluate for possible node configurations. Specify “restore-cluster” to get configuration combinations based on an existing snapshot. Specify “recommend-node-config” to get configuration recommendations based on an existing cluster or snapshot. Specify “resize-cluster” to get configuration combinations for elastic resize based on an existing cluster.

• ClusterIdentifier (string) – The identifier of the cluster to evaluate for possible node configurations.

• SnapshotIdentifier (string) – The identifier of the snapshot to evaluate for possible node configurations.

• SnapshotArn (string) – The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

• OwnerAccount (string) – The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

• Filters (list) –

  A set of name, operator, and value items to filter the results.

  • (dict) –

    A set of elements to filter the returned node configurations.

    • Name (string) –

      The name of the element to filter.

    • Operator (string) –

      The filter operator. If filter Name is NodeType only the ‘in’ operator is supported. Provide one value to evaluate for ‘eq’, ‘lt’, ‘le’, ‘gt’, and ‘ge’. Provide two values to evaluate for ‘between’. Provide a list of values for ‘in’.

    • Values (list) –

      List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).

      • (string) –

• 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

{
    'NodeConfigurationOptionList': [
        {
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'EstimatedDiskUtilizationPercent': 123.0,
            'Mode': 'standard'|'high-performance'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • NodeConfigurationOptionList (list) –

    A list of valid node configurations.

    • (dict) –

      A list of node configurations.

      • NodeType (string) –

        The node type, such as, “ra3.4xlarge”.

      • NumberOfNodes (integer) –

        The number of nodes.

      • EstimatedDiskUtilizationPercent (float) –

        The estimated disk utilizaton percentage.

      • Mode (string) –

        The category of the node configuration recommendation.

  • NextToken (string) –

    A token to resume pagination.