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.

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

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 BeginEnableSnapshotCopy and EndEnableSnapshotCopy.

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

Syntax

C#
public virtual Task<EnableSnapshotCopyResponse> EnableSnapshotCopyAsync(
         EnableSnapshotCopyRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.EnableSnapshotCopyRequest

Container for the necessary parameters to execute the EnableSnapshotCopy 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 EnableSnapshotCopy service method, as returned by Redshift.

Exceptions

ExceptionCondition
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
CopyToRegionDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
IncompatibleOrderableOptionsException The specified options are incompatible.
InvalidClusterStateException The specified cluster is not in the available state.
InvalidRetentionPeriodException The retention period specified is either in the past or is not a valid value. The value must be either -1 or an integer between 1 and 3,653.
LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
SnapshotCopyAlreadyEnabledException The cluster already has cross-region snapshot copy enabled.
SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
UnauthorizedOperationException Your account is not authorized to perform the requested operation.
UnknownSnapshotCopyRegionException The specified region is incorrect or does not exist.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also