DescribeNodeConfigurationOptions - Amazon Redshift

DescribeNodeConfigurationOptions

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ActionType

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.

Type: String

Valid Values: restore-cluster | recommend-node-config | resize-cluster

Required: Yes

ClusterIdentifier

The identifier of the cluster to evaluate for possible node configurations.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Filter.NodeConfigurationOptionsFilter.N

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

Type: Array of NodeConfigurationOptionsFilter objects

Required: No

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, AWS 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.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

MaxRecords

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: 500

Constraints: minimum 100, maximum 500.

Type: Integer

Required: No

OwnerAccount

The AWS 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.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

SnapshotIdentifier

The identifier of the snapshot to evaluate for possible node configurations.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Response Elements

The following elements are returned by the service.

Marker

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.

Type: String

Length Constraints: Maximum length of 2147483647.

NodeConfigurationOptionList.NodeConfigurationOption.N

A list of valid node configurations.

Type: Array of NodeConfigurationOption objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessToSnapshotDenied

The owner of the specified snapshot has not authorized your account to access the snapshot.

HTTP Status Code: 400

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

ClusterSnapshotNotFound

The snapshot identifier does not refer to an existing cluster snapshot.

HTTP Status Code: 404

InvalidClusterSnapshotState

The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeNodeConfigurationOptions.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=DescribeNodeConfigurationOptions &ActionType=restore-cluster &SnapshotIdentifier=mysnapshotid &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<DescribeNodeConfigurationOptionsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <DescribeNodeConfigurationOptionsResult> <NodeConfigurationOptionList> <NodeConfigurationOption> <EstimatedDiskUtilizationPercent>0.01</EstimatedDiskUtilizationPercent> <NumberOfNodes>2</NumberOfNodes> <NodeType>dc2.large</NodeType> </NodeConfigurationOption> <NodeConfigurationOption> <EstimatedDiskUtilizationPercent>0.01</EstimatedDiskUtilizationPercent> <NumberOfNodes>4</NumberOfNodes> <NodeType>dc2.large</NodeType> </NodeConfigurationOption> <NodeConfigurationOption> <EstimatedDiskUtilizationPercent>0.01</EstimatedDiskUtilizationPercent> <NumberOfNodes>2</NumberOfNodes> <NodeType>ds2.xlarge</NodeType> </NodeConfigurationOption> <NodeConfigurationOption> <EstimatedDiskUtilizationPercent>0.01</EstimatedDiskUtilizationPercent> <NumberOfNodes>4</NumberOfNodes> <NodeType>ds2.xlarge</NodeType> </NodeConfigurationOption> </NodeConfigurationOptionList> </DescribeNodeConfigurationOptionsResult> <ResponseMetadata> <RequestId>ed601e39-28cc-11ea-a940-1b28a85fd753</RequestId> </ResponseMetadata> </DescribeNodeConfigurationOptionsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: