Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateSnapshotScheduleCommand

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

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { StorageGatewayClient, UpdateSnapshotScheduleCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, UpdateSnapshotScheduleCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // UpdateSnapshotScheduleInput
  VolumeARN: "STRING_VALUE", // required
  StartAt: Number("int"), // required
  RecurrenceInHours: Number("int"), // required
  Description: "STRING_VALUE",
  Tags: [ // Tags
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new UpdateSnapshotScheduleCommand(input);
const response = await client.send(command);
// { // UpdateSnapshotScheduleOutput
//   VolumeARN: "STRING_VALUE",
// };

Example Usage

Loading code editorLoading code editor