SSM / Client / get_maintenance_window_execution

get_maintenance_window_execution#

SSM.Client.get_maintenance_window_execution(**kwargs)#

Retrieves details about a specific a maintenance window execution.

See also: AWS API Documentation

Request Syntax

response = client.get_maintenance_window_execution(
    WindowExecutionId='string'
)
Parameters:

WindowExecutionId (string) –

[REQUIRED]

The ID of the maintenance window execution that includes the task.

Return type:

dict

Returns:

Response Syntax

{
    'WindowExecutionId': 'string',
    'TaskIds': [
        'string',
    ],
    'Status': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'TIMED_OUT'|'CANCELLING'|'CANCELLED'|'SKIPPED_OVERLAPPING',
    'StatusDetails': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • WindowExecutionId (string) –

      The ID of the maintenance window execution.

    • TaskIds (list) –

      The ID of the task executions from the maintenance window execution.

      • (string) –

    • Status (string) –

      The status of the maintenance window execution.

    • StatusDetails (string) –

      The details explaining the status. Not available for all status values.

    • StartTime (datetime) –

      The time the maintenance window started running.

    • EndTime (datetime) –

      The time the maintenance window finished running.

Exceptions

  • SSM.Client.exceptions.DoesNotExistException

  • SSM.Client.exceptions.InternalServerError