AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

You can't use this operation to restore tables with interleaved sort keys.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRestoreTableFromClusterSnapshot and EndRestoreTableFromClusterSnapshot.

Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<RestoreTableFromClusterSnapshotResponse> RestoreTableFromClusterSnapshotAsync(
         RestoreTableFromClusterSnapshotRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.RestoreTableFromClusterSnapshotRequest

Container for the necessary parameters to execute the RestoreTableFromClusterSnapshot service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the RestoreTableFromClusterSnapshot service method, as returned by Redshift.

Exceptions

ExceptionCondition
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
InProgressTableRestoreQuotaExceededException You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.
InvalidClusterSnapshotStateException The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.
InvalidClusterStateException The specified cluster is not in the available state.
InvalidTableRestoreArgumentException The value specified for the sourceDatabaseName, sourceSchemaName, or sourceTableName parameter, or a combination of these, doesn't exist in the snapshot.
UnsupportedOperationException The requested operation isn't supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also