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.

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

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 BeginModifySnapshotCopyRetentionPeriod and EndModifySnapshotCopyRetentionPeriod.

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

Syntax

C#
public virtual Task<ModifySnapshotCopyRetentionPeriodResponse> ModifySnapshotCopyRetentionPeriodAsync(
         ModifySnapshotCopyRetentionPeriodRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.ModifySnapshotCopyRetentionPeriodRequest

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

Exceptions

ExceptionCondition
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
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.
SnapshotCopyDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
UnauthorizedOperationException Your account is not authorized to perform the requested operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also