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
Length Constraints: Maximum length of 2147483647.
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
- DataTransferProgressPercent
-
The percent of data transferred from source cluster to target cluster.
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
Length Constraints: Maximum length of 2147483647.
- ImportTablesInProgress.member.N
-
The names of tables that are being currently imported.
Valid Values: List of table names.
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
- ImportTablesNotStarted.member.N
-
The names of tables that have not been yet imported.
Valid Values: List of table names
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
- Message
-
An optional string to provide additional details about the resize action.
Type: String
Length Constraints: Maximum length of 2147483647.
- 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
- ResizeType
-
An enum with possible values of
ClassicResize
andElasticResize
. These values describe the type of resize operation being performed.Type: String
Length Constraints: Maximum length of 2147483647.
- Status
-
The status of the resize operation.
Valid Values:
NONE
|IN_PROGRESS
|FAILED
|SUCCEEDED
|CANCELLING
Type: String
Length Constraints: Maximum length of 2147483647.
- TargetClusterType
-
The cluster type after the resize operation is complete.
Valid Values:
multi-node
|single-node
Type: String
Length Constraints: Maximum length of 2147483647.
- TargetEncryptionType
-
The type of encryption for the cluster after the resize is complete.
Possible values are
KMS
andNone
.Type: String
Length Constraints: Maximum length of 2147483647.
- TargetNodeType
-
The node type that the cluster will have after the resize operation is complete.
Type: String
Length Constraints: Maximum length of 2147483647.
- 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
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeResize.
Sample Request
https://redshift.us-east-2.amazonaws.com/
?Action=DescribeResize
&ClusterIdentifier=mycluster
&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
<DescribeResizeResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
<DescribeResizeResult>
<AvgResizeRateInMegaBytesPerSecond>0.1498</AvgResizeRateInMegaBytesPerSecond>
<TargetNodeType>dc2.large</TargetNodeType>
<TargetEncryptionType>NONE</TargetEncryptionType>
<EstimatedTimeToCompletionInSeconds>0</EstimatedTimeToCompletionInSeconds>
<ProgressInMegaBytes>55</ProgressInMegaBytes>
<DataTransferProgressPercent>100.0</DataTransferProgressPercent>
<TotalResizeDataInMegaBytes>55</TotalResizeDataInMegaBytes>
<ElapsedTimeInSeconds>1226</ElapsedTimeInSeconds>
<TargetClusterType>single-node</TargetClusterType>
<ResizeType>ClassicResize</ResizeType>
<Status>SUCCEEDED</Status>
</DescribeResizeResult>
<ResponseMetadata>
<RequestId>6a152dbe-28d1-11ea-8cc9-43f1872b4b75</RequestId>
</ResponseMetadata>
</DescribeResizeResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: