Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

GetMaintenanceWindowExecutionTask

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

Request Syntax

{
   "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.

TaskId

The ID of the specific task execution 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 that includes the task.

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,
   "MaxConcurrency": "string",
   "MaxErrors": "string",
   "Priority": number,
   "ServiceRole": "string",
   "StartTime": number,
   "Status": "string",
   "StatusDetails": "string",
   "TaskArn": "string",
   "TaskExecutionId": "string",
   "TaskParameters": [ 
      { 
         "string" : { 
            "Values": [ "string" ]
         }
      }
   ],
   "Type": "string",
   "WindowExecutionId": "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 the task execution completed.

Type: Timestamp

MaxConcurrency

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

Type: String

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

Pattern: ^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$

MaxErrors

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

Type: String

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

Pattern: ^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$

Priority

The priority of the task.

Type: Integer

Valid Range: Minimum value of 0.

ServiceRole

The role that was assumed when executing the task.

Type: String

StartTime

The time the task execution started.

Type: Timestamp

Status

The status of the task.

Type: String

Valid Values: PENDING | IN_PROGRESS | SUCCESS | FAILED | TIMED_OUT | CANCELLING | CANCELLED | SKIPPED_OVERLAPPING

StatusDetails

The details explaining the Status. Only available for certain status values.

Type: String

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

TaskArn

The ARN of the executed task.

Type: String

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

TaskExecutionId

The ID of the specific task execution in the Maintenance Window task that was 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}$

TaskParameters

The parameters passed to the task when it was executed. The map has the following format:

Key: string, between 1 and 255 characters

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

Type: Array of string to MaintenanceWindowTaskParameterValueExpression object maps

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Type

The type of task executed.

Type: String

Valid Values: RUN_COMMAND | AUTOMATION | STEP_FUNCTIONS | LAMBDA

WindowExecutionId

The ID of the Maintenance Window execution that includes the task.

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}$

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 (e.g. a Maintenance Window) doesn't exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: