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.

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway architectures.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

Note:

For PCL this operation is only available in asynchronous form. Please refer to UpdateSnapshotScheduleAsync.

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

Syntax

C#
public virtual UpdateSnapshotScheduleResponse UpdateSnapshotSchedule(
         UpdateSnapshotScheduleRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest

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

Return Value
The response from the UpdateSnapshotSchedule service method, as returned by StorageGateway.

Exceptions

ExceptionCondition
InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

Examples

Updates a snapshot schedule configured for a gateway volume.

To update a volume snapshot schedule


var response = client.UpdateSnapshotSchedule(new UpdateSnapshotScheduleRequest 
{
    Description = "Hourly snapshot",
    RecurrenceInHours = 1,
    StartAt = 0,
    VolumeARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
});

string volumeARN = response.VolumeARN;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also