Redshift / Client / describe_resize

describe_resize#

Redshift.Client.describe_resize(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_resize(
    ClusterIdentifier='string'
)
Parameters:

ClusterIdentifier (string) –

[REQUIRED]

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 Amazon Web Services account are returned.

Return type:

dict

Returns:

Response Syntax

{
    'TargetNodeType': 'string',
    'TargetNumberOfNodes': 123,
    'TargetClusterType': 'string',
    'Status': 'string',
    'ImportTablesCompleted': [
        'string',
    ],
    'ImportTablesInProgress': [
        'string',
    ],
    'ImportTablesNotStarted': [
        'string',
    ],
    'AvgResizeRateInMegaBytesPerSecond': 123.0,
    'TotalResizeDataInMegaBytes': 123,
    'ProgressInMegaBytes': 123,
    'ElapsedTimeInSeconds': 123,
    'EstimatedTimeToCompletionInSeconds': 123,
    'ResizeType': 'string',
    'Message': 'string',
    'TargetEncryptionType': 'string',
    'DataTransferProgressPercent': 123.0
}

Response Structure

  • (dict) –

    Describes the result of a cluster resize operation.

    • TargetNodeType (string) –

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

    • TargetNumberOfNodes (integer) –

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

    • TargetClusterType (string) –

      The cluster type after the resize operation is complete.

      Valid Values: multi-node | single-node

    • Status (string) –

      The status of the resize operation.

      Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

    • ImportTablesCompleted (list) –

      The names of tables that have been completely imported .

      Valid Values: List of table names.

      • (string) –

    • ImportTablesInProgress (list) –

      The names of tables that are being currently imported.

      Valid Values: List of table names.

      • (string) –

    • ImportTablesNotStarted (list) –

      The names of tables that have not been yet imported.

      Valid Values: List of table names

      • (string) –

    • AvgResizeRateInMegaBytesPerSecond (float) –

      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.

    • TotalResizeDataInMegaBytes (integer) –

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

    • ProgressInMegaBytes (integer) –

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

    • ElapsedTimeInSeconds (integer) –

      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.

    • EstimatedTimeToCompletionInSeconds (integer) –

      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.

    • ResizeType (string) –

      An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

    • Message (string) –

      An optional string to provide additional details about the resize action.

    • TargetEncryptionType (string) –

      The type of encryption for the cluster after the resize is complete.

      Possible values are KMS and None.

    • DataTransferProgressPercent (float) –

      The percent of data transferred from source cluster to target cluster.

Exceptions