Redshift / Client / describe_orderable_cluster_options

describe_orderable_cluster_options

Redshift.Client.describe_orderable_cluster_options(**kwargs)

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_orderable_cluster_options(
    ClusterVersion='string',
    NodeType='string',
    MaxRecords=123,
    Marker='string'
)

Parameters:

• ClusterVersion (string) –

  The version filter value. Specify this parameter to show only the available offerings matching the specified version.

  Default: All versions.

  Constraints: Must be one of the version returned from DescribeClusterVersions.

• NodeType (string) – The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

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

{
    'OrderableClusterOptions': [
        {
            'ClusterVersion': 'string',
            'ClusterType': 'string',
            'NodeType': 'string',
            'AvailabilityZones': [
                {
                    'Name': 'string',
                    'SupportedPlatforms': [
                        {
                            'Name': 'string'
                        },
                    ]
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  Contains the output from the DescribeOrderableClusterOptions action.

  • OrderableClusterOptions (list) –

    An OrderableClusterOption structure containing information about orderable options for the cluster.

    • (dict) –

      Describes an orderable cluster option.

      • ClusterVersion (string) –

        The version of the orderable cluster.

      • ClusterType (string) –

        The cluster type, for example multi-node.

      • NodeType (string) –

        The node type for the orderable cluster.

      • AvailabilityZones (list) –

        A list of availability zones for the orderable cluster.

        • (dict) –

          Describes an availability zone.

          • Name (string) –

            The name of the availability zone.

          • SupportedPlatforms (list) –

            • (dict) –

              A list of supported platforms for orderable clusters.

              • Name (string) –

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