DescribeMaintenanceWindowsForTarget - AWS Systems Manager


Retrieves information about the maintenance window targets or tasks that a managed node is associated with.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "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.


The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1.

Required: No


The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No


The type of resource you want to retrieve information about. For example, INSTANCE.

Type: String


Required: Yes


The managed node ID or key-value pair to retrieve information about.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: Yes

Response Syntax

{ "NextToken": "string", "WindowIdentities": [ { "Name": "string", "WindowId": "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.


The token for the next set of items to return. (You use this token in the next call.)

Type: String


Information about the maintenance window targets and tasks a managed node is associated with.

Type: Array of MaintenanceWindowIdentityForTarget objects


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


An error occurred on the server side.

HTTP Status Code: 500



This example illustrates one usage of DescribeMaintenanceWindowsForTarget.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowsForTarget 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: 20200225T003520Z 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: 100 { "Targets": [ { "Key": "InstanceIds", "Values": [ "i-07782c72faEXAMPLE" ] } ], "ResourceType": "INSTANCE" }

Sample Response

{ "WindowIdentities": [ { "Name": "MyFirstMaintenanceWindow", "WindowId": "mw-0c50858d01EXAMPLE" }, { "Name": "MySecondMaintenanceWindow", "WindowId": "mw-05aaf9f490EXAMPLE" }, { "Name": "MyThirdMaintenanceWindow", "WindowId": "mw-0ecb1226ddEXAMPLE" } ] }

See Also

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