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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.



In the following list, the required parameters are described first.


The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

Type: Double

Required: No


The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

Type: Long

Required: No


The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

Type: Long

Required: No


The number of megabytes that have been transferred from snapshot storage.

Type: Long

Required: No


The size of the set of snapshot data used to restore the cluster.

Type: Long

Required: No


The status of the restore action. Returns starting, restoring, completed, or failed.

Type: String

Required: No

See Also

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

On this page: