2024/06/06 - AWS Storage Gateway - 2 updated api methods
Changes Adds SoftwareUpdatePreferences to DescribeMaintenanceStartTime and UpdateMaintenanceStartTime, a structure which contains AutomaticUpdatePolicy.
{'SoftwareUpdatePreferences': {'AutomaticUpdatePolicy': 'ALL_VERSIONS | '
'EMERGENCY_VERSIONS_ONLY'}}
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.
See also: AWS API Documentation
Request Syntax
client.describe_maintenance_start_time(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
dict
Response Syntax
{
'GatewayARN': 'string',
'HourOfDay': 123,
'MinuteOfHour': 123,
'DayOfWeek': 123,
'DayOfMonth': 123,
'Timezone': 'string',
'SoftwareUpdatePreferences': {
'AutomaticUpdatePolicy': 'ALL_VERSIONS'|'EMERGENCY_VERSIONS_ONLY'
}
}
Response Structure
(dict) --
A JSON object containing the following fields:
DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences
DescribeMaintenanceStartTimeOutput$DayOfMonth
DescribeMaintenanceStartTimeOutput$DayOfWeek
DescribeMaintenanceStartTimeOutput$HourOfDay
DescribeMaintenanceStartTimeOutput$MinuteOfHour
DescribeMaintenanceStartTimeOutput$Timezone
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
HourOfDay (integer) --
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.
MinuteOfHour (integer) --
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.
DayOfWeek (integer) --
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.
DayOfMonth (integer) --
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.
Timezone (string) --
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.
SoftwareUpdatePreferences (dict) --
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.
AutomaticUpdatePolicy (string) --
Indicates the automatic update policy for a gateway.
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
{'SoftwareUpdatePreferences': {'AutomaticUpdatePolicy': 'ALL_VERSIONS | '
'EMERGENCY_VERSIONS_ONLY'}}
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.
See also: AWS API Documentation
Request Syntax
client.update_maintenance_start_time(
GatewayARN='string',
HourOfDay=123,
MinuteOfHour=123,
DayOfWeek=123,
DayOfMonth=123,
SoftwareUpdatePreferences={
'AutomaticUpdatePolicy': 'ALL_VERSIONS'|'EMERGENCY_VERSIONS_ONLY'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
integer
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.
integer
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.
integer
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.
integer
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.
dict
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.
AutomaticUpdatePolicy (string) --
Indicates the automatic update policy for a gateway.
ALL_VERSIONS - Enables regular gateway maintenance updates.
EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
A JSON object containing the Amazon Resource Name (ARN) of the gateway whose maintenance start time is updated.
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.