Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetMaintenanceWindowExecutionTaskInvocation

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

Request Syntax


{
   "InvocationId": "string",
   "TaskId": "string",
   "WindowExecutionId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InvocationId

The invocation ID to retrieve.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Required: Yes

TaskId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Required: Yes

WindowExecutionId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Required: Yes

Response Syntax


{
   "EndTime": number,
   "ExecutionId": "string",
   "InvocationId": "string",
   "OwnerInformation": "string",
   "Parameters": "string",
   "StartTime": number,
   "Status": "string",
   "StatusDetails": "string",
   "TaskExecutionId": "string",
   "TaskType": "string",
   "WindowExecutionId": "string",
   "WindowTargetId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EndTime

The time that the task finished running on the target.

Type: Timestamp

ExecutionId

The execution ID.

Type: String

InvocationId

The invocation ID.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

OwnerInformation

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Parameters

The parameters used at the time that the task ran.

Type: String

StartTime

The time that the task started running on the target.

Type: Timestamp

Status

The task status for an invocation.

Type: String

StatusDetails

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 250.

TaskExecutionId

The task execution ID.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

TaskType

Retrieves the task type for a maintenance window.

Type: String

Valid Values: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA

WindowExecutionId

The maintenance window execution ID.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

WindowTargetId

The maintenance window target ID.

Type: String

Length Constraints: Maximum length of 36.

Errors

For information about the errors that are common to all actions, see Common Errors.

DoesNotExistException

Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of GetMaintenanceWindowExecutionTaskInvocation.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecutionTaskInvocation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20200225T001923Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200225/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 167

{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE",
    "TaskId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE",
    "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE"
}

Sample Response


{
    "WindowExecutionId": "b40a588d-32a7-4ea7-9a6b-b4ef4EXAMPLE",
    "TaskExecutionId": "0c9ac961-dafd-4a94-b6c7-1bef3EXAMPLE",
    "InvocationId": "0e466033-290b-4d74-9ae0-f33e3EXAMPLE",
    "ExecutionId": "1203cf98-5a79-4ec3-97e9-12e0bEXAMPLE",
    "TaskType": "RUN_COMMAND",
    "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-ApplyPatchBaseline\",\"instanceIds\":[\"i-02573cafcfEXAMPLE\",\"i-0471e04240EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"SnapshotId\":[\"\"],\"Operation\":[\"Install\"]},\"timeoutSeconds\":600}",
    "Status": "SUCCESS",
    "StatusDetails": "Success",
    "StartTime": "2021-08-04T11:45:35.141000-07:00",
    "EndTime": "2021-08-04T11:48:08.960000-07:00"
}