PutMaintenanceStartTime
Set the maintenance start time for a gateway.
Request Syntax
{
"DayOfMonth": number,
"DayOfWeek": number,
"GatewayArn": "string",
"HourOfDay": number,
"MinuteOfHour": number
}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 start maintenance on a gateway.
Valid values range from
SundaytoSaturday.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 31.
Required: No
- DayOfWeek
-
The day of the week to start maintenance on a gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 6.
Required: No
- GatewayArn
-
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$Required: Yes
- HourOfDay
-
The hour of the day to start maintenance on a gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 23.
Required: Yes
- MinuteOfHour
-
The minute of the hour to start maintenance on a gateway.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 59.
Required: Yes
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 a gateway for which you set the maintenance start time.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The operation cannot proceed because it is not supported.
HTTP Status Code: 400
- InternalServerException
-
The operation did not succeed because an internal error occurred. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
A resource that is required for the action wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
- ValidationException
-
The operation did not succeed because a validation error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: