Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

DescribeResize

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

Request Parameters

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

ClusterIdentifier

The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

By default, resize operations for all clusters defined for an AWS account are returned.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

AvgResizeRateInMegaBytesPerSecond

The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

Type: Double

ElapsedTimeInSeconds

The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

Type: Long

EstimatedTimeToCompletionInSeconds

The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

Type: Long

ImportTablesCompleted.member.N

The names of tables that have been completely imported .

Valid Values: List of table names.

Type: Array of strings

ImportTablesInProgress.member.N

The names of tables that are being currently imported.

Valid Values: List of table names.

Type: Array of strings

ImportTablesNotStarted.member.N

The names of tables that have not been yet imported.

Valid Values: List of table names

Type: Array of strings

ProgressInMegaBytes

While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

Type: Long

Status

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED

Type: String

TargetClusterType

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

Type: String

TargetNodeType

The node type that the cluster will have after the resize operation is complete.

Type: String

TargetNumberOfNodes

The number of nodes that the cluster will have after the resize operation is complete.

Type: Integer

TotalResizeDataInMegaBytes

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

Type: Long

Errors

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

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

ResizeNotFound

A resize operation for the specified cluster is not found.

HTTP Status Code: 404

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/
   ?Action=DescribeResize
   &ClusterIdentifier=examplecluster
   &Version=2012-12-01
   &x-amz-algorithm=AWS4-HMAC-SHA256
   &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request
   &x-amz-date=20121207T232427Z
   &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<DescribeResizeResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <DescribeResizeResult>
    <TargetClusterType>multi-node</TargetClusterType>
    <Status>SUCCEEDED</Status>
    <AvgResizeRateInMegaBytesPerSecond>6.5263</AvgResizeRateInMegaBytesPerSecond>
    <ProgressInMegaBytes>66922</ProgressInMegaBytes>
    <EstimatedTimeToCompletionInSeconds>0</EstimatedTimeToCompletionInSeconds>
    <ImportTablesCompleted>
      <member>users</member>
      <member>venue</member>
      <member>sales</member>
      <member>listing</member>
      <member>event</member>
      <member>date</member>
      <member>category</member>
    </ImportTablesCompleted>
    <ElapsedTimeInSeconds>10254</ElapsedTimeInSeconds>
    <TargetNodeType>ds2.xlarge</TargetNodeType>
    <TargetNumberOfNodes>2</TargetNumberOfNodes>
  </DescribeResizeResult>
  <ResponseMetadata>
    <RequestId>a6d59c61-a162-11e2-b2bc-fb54c9d11e09</RequestId>
  </ResponseMetadata>
</DescribeResizeResponse>

See Also

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