StorageGateway / Client / update_maintenance_start_time

update_maintenance_start_time#

StorageGateway.Client.update_maintenance_start_time(**kwargs)#

Updates a gateway’s weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway’s time zone.

See also: AWS API Documentation

Request Syntax

response = client.update_maintenance_start_time(
    GatewayARN='string',
    HourOfDay=123,
    MinuteOfHour=123,
    DayOfWeek=123,
    DayOfMonth=123
)
Parameters:

  • GatewayARN (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.

  • HourOfDay (integer) –

    [REQUIRED]

    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.

  • MinuteOfHour (integer) –

    [REQUIRED]

    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.

  • DayOfWeek (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 Saturday.

  • 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 and 28 represents the last day of the month.

Return type:

dict

Returns:

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.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError

Examples

Updates a gateway’s weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway’s time zone.

response = client.update_maintenance_start_time(
    DayOfWeek=2,
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    HourOfDay=0,
    MinuteOfHour=30,
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'ResponseMetadata': {
        '...': '...',
    },
}