Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeMaintenanceStartTime

Returns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone.

Request Syntax


{
   "GatewayARN": "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.

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

Response Syntax


{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayARN": "string",
   "HourOfDay": number,
   "MinuteOfHour": number,
   "SoftwareUpdatePreferences": { 
      "AutomaticUpdatePolicy": "string"
   },
   "Timezone": "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.

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.

DayOfWeek

An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

Type: Integer

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

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.

HourOfDay

The hour component of the maintenance start time represented as hh, where hh is the hour (0 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.

MinuteOfHour

The minute component of the maintenance start time represented as mm, where mm is the minute (0 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.

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

Timezone

A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 10.

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

Return information about a gateway's maintenance window

The following example shows a request that describes a gateway's maintenance window.

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_20120630.DescribeMaintenanceStartTime

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 136

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
    "DayOfMonth": "28",
    "DayOfWeek": "2",
    "HourOfDay": "15",
    "MinuteOfHour": "35",
    "Timezone": "GMT+7:00"
}