describe_maintenance_window_execution_tasks

describe_maintenance_window_execution_tasks(**kwargs)

For a given maintenance window execution, lists the tasks that were run.

See also: AWS API Documentation

Request Syntax

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

Parameters

• WindowExecutionId (string) --

  [REQUIRED]

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

• Filters (list) --

  Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING , IN_PROGRESS , SUCCESS , FAILED , TIMED_OUT , CANCELLING , and CANCELLED .

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

{
    'WindowExecutionTaskIdentities': [
        {
            'WindowExecutionId': 'string',
            'TaskExecutionId': '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),
            'TaskArn': 'string',
            'TaskType': 'RUN_COMMAND'|'AUTOMATION'|'STEP_FUNCTIONS'|'LAMBDA',
            'AlarmConfiguration': {
                'IgnorePollAlarmFailure': True|False,
                'Alarms': [
                    {
                        'Name': 'string'
                    },
                ]
            },
            'TriggeredAlarms': [
                {
                    'Name': 'string',
                    'State': 'UNKNOWN'|'ALARM'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • WindowExecutionTaskIdentities (list) --

    Information about the task executions.

    • (dict) --

      Information about a task execution performed as part of a maintenance window execution.

      • WindowExecutionId (string) --

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

      • TaskExecutionId (string) --

        The ID of the specific task execution in the maintenance window execution.

      • Status (string) --

        The status of the task execution.

      • StatusDetails (string) --

        The details explaining the status of the task execution. Not available for all status values.

      • StartTime (datetime) --

        The time the task execution started.

      • EndTime (datetime) --

        The time the task execution finished.

      • TaskArn (string) --

        The Amazon Resource Name (ARN) of the task that ran.

      • TaskType (string) --

        The type of task that ran.

      • AlarmConfiguration (dict) --

        The details for the CloudWatch alarm applied to your maintenance window task.

        • IgnorePollAlarmFailure (boolean) --

          When this value is true , your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false .

        • Alarms (list) --

          The name of the CloudWatch alarm specified in the configuration.

          • (dict) --

            A CloudWatch alarm you apply to an automation or command.

            • Name (string) --

              The name of your CloudWatch alarm.

      • TriggeredAlarms (list) --

        The CloudWatch alarm that was invoked by the maintenance window task.

        • (dict) --

          The details about the state of your CloudWatch alarm.

          • Name (string) --

            The name of your CloudWatch alarm.

          • State (string) --

            The state of your CloudWatch alarm.

  • 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.DoesNotExistException
• SSM.Client.exceptions.InternalServerError