SSM / Client / get_maintenance_window_execution_task

get_maintenance_window_execution_task#

SSM.Client.get_maintenance_window_execution_task(**kwargs)#

Retrieves the details about a specific task run as part of a maintenance window execution.

See also: AWS API Documentation

Request Syntax

response = client.get_maintenance_window_execution_task(
    WindowExecutionId='string',
    TaskId='string'
)
Parameters:

  • WindowExecutionId (string) –

    [REQUIRED]

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

  • TaskId (string) –

    [REQUIRED]

    The ID of the specific task execution in the maintenance window task that should be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'WindowExecutionId': 'string',
    'TaskExecutionId': 'string',
    'TaskArn': 'string',
    'ServiceRole': 'string',
    'Type': 'RUN_COMMAND'|'AUTOMATION'|'STEP_FUNCTIONS'|'LAMBDA',
    'TaskParameters': [
        {
            'string': {
                'Values': [
                    'string',
                ]
            }
        },
    ],
    'Priority': 123,
    'MaxConcurrency': 'string',
    'MaxErrors': '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),
    'AlarmConfiguration': {
        'IgnorePollAlarmFailure': True|False,
        'Alarms': [
            {
                'Name': 'string'
            },
        ]
    },
    'TriggeredAlarms': [
        {
            'Name': 'string',
            'State': 'UNKNOWN'|'ALARM'
        },
    ]
}

Response Structure

  • (dict) –

    • WindowExecutionId (string) –

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

    • TaskExecutionId (string) –

      The ID of the specific task execution in the maintenance window task that was retrieved.

    • TaskArn (string) –

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

    • ServiceRole (string) –

      The role that was assumed when running the task.

    • Type (string) –

      The type of task that was run.

    • TaskParameters (list) –

      The parameters passed to the task when it was run.

      Note

      TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

      The map has the following format:

      • Key: string, between 1 and 255 characters

      • Value: an array of strings, each between 1 and 255 characters

      • (dict) –

        • (string) –

          • (dict) –

            Defines the values for a task parameter.

            • Values (list) –

              This field contains an array of 0 or more strings, each 1 to 255 characters in length.

              • (string) –

    • Priority (integer) –

      The priority of the task.

    • MaxConcurrency (string) –

      The defined maximum number of task executions that could be run in parallel.

    • MaxErrors (string) –

      The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

    • Status (string) –

      The status of the task.

    • StatusDetails (string) –

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

    • StartTime (datetime) –

      The time the task execution started.

    • EndTime (datetime) –

      The time the task execution completed.

    • AlarmConfiguration (dict) –

      The details for the CloudWatch alarm you 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 alarms that were 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.

Exceptions