DescribeMaintenanceWindowTargets - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.


Lists the targets registered with the maintenance window.

Request Syntax

{ "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "WindowId": "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.


Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId, and OwnerInformation.

Type: Array of MaintenanceWindowFilter objects

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

Required: No


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 10. Maximum value of 100.

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 ID of the maintenance window whose targets should be retrieved.

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^mw-[0-9a-f]{17}$

Required: Yes

Response Syntax

{ "NextToken": "string", "Targets": [ { "Description": "string", "Name": "string", "OwnerInformation": "string", "ResourceType": "string", "Targets": [ { "Key": "string", "Values": [ "string" ] } ], "WindowId": "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.


The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String


Information about the targets in the maintenance window.

Type: Array of MaintenanceWindowTarget objects


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


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 Amazon Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400


An error occurred on the server side.

HTTP Status Code: 500



This example illustrates one usage of DescribeMaintenanceWindowTargets.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity X-Amz-Target: AmazonSSM.DescribeMaintenanceWindowTargets 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: 20200225T003928Z 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: 36 { "WindowId": "mw-0c50858d01EXAMPLE" }

Sample Response

{ "Targets": [ { "WindowId": "mw-0c50858d01EXAMPLE", "Name": "MyTargets", "WindowTargetId": "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE", "ResourceType": "INSTANCE", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-02573cafcfEXAMPLE", "i-0471e04240EXAMPLE" ] } ] }, { "WindowId": "mw-0c50858d01EXAMPLE", "WindowTargetId": "7f4813bb-df25-4e59-b34f-c9e83EXAMPLE", "ResourceType": "INSTANCE", "Targets": [ { "Key": "InstanceIds", "Values": [ "i-07782c72faEXAMPLE" ] } ] } ] }

See Also

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