SSM / Client / describe_maintenance_window_executions

describe_maintenance_window_executions#

SSM.Client.describe_maintenance_window_executions(**kwargs)#

Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

See also: AWS API Documentation

Request Syntax

response = client.describe_maintenance_window_executions(
    WindowId='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • WindowId (string) –

    [REQUIRED]

    The ID of the maintenance window whose executions should be retrieved.

  • Filters (list) –

    Each entry in the array is a structure containing:

    • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.

    • Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.

    • (dict) –

      Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use MaintenanceWindowFilter> include the following:

      • DescribeMaintenanceWindowExecutions

      • DescribeMaintenanceWindowExecutionTaskInvocations

      • DescribeMaintenanceWindowExecutionTasks

      • DescribeMaintenanceWindows

      • DescribeMaintenanceWindowTargets

      • DescribeMaintenanceWindowTasks

      • Key (string) –

        The name of the filter.

      • Values (list) –

        The filter values.

        • (string) –

  • MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

  • NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

Return type:

dict

Returns:

Response Syntax

{
    'WindowExecutions': [
        {
            'WindowId': 'string',
            'WindowExecutionId': '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • WindowExecutions (list) –

      Information about the maintenance window executions.

      • (dict) –

        Describes the information about an execution of a maintenance window.

        • WindowId (string) –

          The ID of the maintenance window.

        • WindowExecutionId (string) –

          The ID of the maintenance window execution.

        • Status (string) –

          The status of the execution.

        • StatusDetails (string) –

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

        • StartTime (datetime) –

          The time the execution started.

        • EndTime (datetime) –

          The time the execution finished.

    • NextToken (string) –

      The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Exceptions

  • SSM.Client.exceptions.InternalServerError