GetMaintenanceWindowExecution - AWS Systems Manager

GetMaintenanceWindowExecution

Retrieves details about a specific 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 running.

Type: Timestamp

StartTime

The time the maintenance window started running.

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. Not available for all 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, 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 GetMaintenanceWindowExecution.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 61 X-Amz-Target: AmazonSSM.GetMaintenanceWindowExecution X-Amz-Date: 20240312T205830Z User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240312/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE" }

Sample Response

{ "WindowExecutionId": "9fac7dd9-ff21-42a5-96ad-bbc4bEXAMPLE", "TaskIds": [ "4b9f371e-a820-422d-b432-8dec9EXAMPLE" ], "Status": "SUCCESS", "StartTime": "2024-08-04T11:45:34.994000-07:00", "EndTime": "2024-08-04T11:48:09.123000-07:00" }

See Also

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