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.

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume architectures.

Note:

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

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

Syntax

C#
public abstract DescribeSnapshotScheduleResponse DescribeSnapshotSchedule(
         DescribeSnapshotScheduleRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.DescribeSnapshotScheduleRequest

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

Return Value
The response from the DescribeSnapshotSchedule 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

Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.

To describe snapshot schedule for gateway volume


var response = client.DescribeSnapshotSchedule(new DescribeSnapshotScheduleRequest 
{
    VolumeARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
});

string description = response.Description;
integer recurrenceInHours = response.RecurrenceInHours;
integer startAt = response.StartAt;
string timezone = response.Timezone;
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