SSM / Client / get_maintenance_window_execution_task_invocation

get_maintenance_window_execution_task_invocation#

SSM.Client.get_maintenance_window_execution_task_invocation(**kwargs)#

Retrieves information about a specific task running on a specific target.

See also: AWS API Documentation

Request Syntax

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

  • WindowExecutionId (string) –

    [REQUIRED]

    The ID of the maintenance window execution for which the task is a part.

  • TaskId (string) –

    [REQUIRED]

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

  • InvocationId (string) –

    [REQUIRED]

    The invocation ID to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'WindowExecutionId': 'string',
    'TaskExecutionId': 'string',
    'InvocationId': 'string',
    'ExecutionId': 'string',
    'TaskType': 'RUN_COMMAND'|'AUTOMATION'|'STEP_FUNCTIONS'|'LAMBDA',
    'Parameters': '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),
    'OwnerInformation': 'string',
    'WindowTargetId': 'string'
}

Response Structure

  • (dict) –

    • WindowExecutionId (string) –

      The maintenance window execution ID.

    • TaskExecutionId (string) –

      The task execution ID.

    • InvocationId (string) –

      The invocation ID.

    • ExecutionId (string) –

      The execution ID.

    • TaskType (string) –

      Retrieves the task type for a maintenance window.

    • Parameters (string) –

      The parameters used at the time that the task ran.

    • Status (string) –

      The task status for an invocation.

    • StatusDetails (string) –

      The details explaining the status. Details are only available for certain status values.

    • StartTime (datetime) –

      The time that the task started running on the target.

    • EndTime (datetime) –

      The time that the task finished running on the target.

    • OwnerInformation (string) –

      User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.

    • WindowTargetId (string) –

      The maintenance window target ID.

Exceptions

  • SSM.Client.exceptions.DoesNotExistException

  • SSM.Client.exceptions.InternalServerError