UpdateMaintenanceStartTime - Storage Gateway

UpdateMaintenanceStartTime

Updates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time configuration uses the gateway's time zone. You can pass values for a complete maintenance schedule, or update policy, or both. Previous values will persist for whichever setting you choose not to modify. If an incomplete or invalid maintenance schedule is passed, the entire request will be rejected with an error and no changes will occur.

A complete maintenance schedule must include values for both MinuteOfHour and HourOfDay, and either DayOfMonth or DayOfWeek.

Note

We recommend keeping maintenance updates turned on, except in specific use cases where the brief disruptions caused by updating the gateway could critically impact your deployment.

Request Syntax

{ "DayOfMonth": number, "DayOfWeek": number, "GatewayARN": "string", "HourOfDay": number, "MinuteOfHour": number, "SoftwareUpdatePreferences": { "AutomaticUpdatePolicy": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DayOfMonth

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month. It is not possible to set the maintenance schedule to start on days 29 through 31.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 28.

Required: No

DayOfWeek

The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 6.

Required: No

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

HourOfDay

The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 23.

Required: No

MinuteOfHour

The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 59.

Required: No

SoftwareUpdatePreferences

A set of variables indicating the software update preferences for the gateway.

Includes AutomaticUpdatePolicy field with the following inputs:

ALL_VERSIONS - Enables regular gateway maintenance updates.

EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.

Type: SoftwareUpdatePreferences object

Required: No

Response Syntax

{ "GatewayARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Examples

Update a gateway's maintenance start time

The following example shows a request that enables automatic maintenance updates and sets a maintenance start time on the 28th day of each month for gateway ID sgw-12A3456B.

Sample Request

POST / HTTP/1.1 Host: storagegateway.us-east-2.amazonaws.com x-amz-Date: 20120425T120000Z Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG Content-type: application/x-amz-json-1.1 x-amz-target: StorageGateway_20130630.UpdateMaintenanceStartTime { "SoftwareUpdatePreferences": { "AutomaticUpdatePolicy": "ALL_VERSIONS" }, "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B", "DayOfMonth": "28", "HourOfDay": "15", "MinuteOfHour": "35" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: