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

GetMaintenanceWindowExecution

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

Request Syntax

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

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,
   "StartTime": number,
   "Status": "string",
   "StatusDetails": "string",
   "TaskIds": [ "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 Maintenance Window finished executing.

Type: Timestamp

StartTime

The time the Maintenance Window started executing.

Type: Timestamp

Status

The status of the Maintenance Window execution.

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.

TaskIds

The ID of the task executions from the Maintenance Window execution.

Type: Array of strings

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

WindowExecutionId

The ID of the Maintenance Window execution.

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: