GetMaintenanceWindowExecutionTaskInvocation
Retrieves a task invocation. A task invocation is a specific task running on a specific target. maintenance windows report status for all invocations.
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 CloudWatch 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
Valid Values:
PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING - 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. Task types include the following: LAMBDA, STEP_FUNCTION, AUTOMATION, RUN_COMMAND.
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 limits in Systems Manager, see AWS Systems Manager Limits.
HTTP Status Code: 400
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
