/ - Amazon Simple Systems Manager (SSM)

Lists the targets registered with the maintenance window.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "WindowId": "string", "Filters": [], "MaxResults": 0, "NextToken": "string" }'

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowId

string

required

The ID of the maintenance window whose targets should be retrieved.

>= 20 characters<= 20 characters

Match pattern:

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

Filters

array [object]

optional

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.

>= 0 items<= 5 items

MaxResults

integer

optional

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.

>= 10<= 100

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

Targets

array[object (MaintenanceWindowTarget) {7}]

optional

Information about the targets in the maintenance window.

WindowId

string

optional

The ID of the maintenance window to register the target with.

>= 20 characters<= 20 characters

Match pattern:

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

WindowTargetId

string

optional

The ID of the target.

>= 36 characters<= 36 characters

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

ResourceType

enum<string>

optional

The type of target that is being registered with the maintenance window.

Allowed values:

INSTANCERESOURCE_GROUP

Targets

array [object]

optional

The targets, either managed nodes or tags.

Specify managed nodes using the following format:

Key=instanceids,Values=<instanceid1>,<instanceid2>

Tags are specified using the following format:

Key=<tag name>,Values=<tag value>.

>= 0 items<= 5 items

OwnerInformation

string <password>

optional

A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

>= 1 characters<= 128 characters

Name

string

optional

The name for the maintenance window target.

>= 3 characters<= 128 characters

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

Description

string <password>

optional

A description for the target.

>= 1 characters<= 128 characters

NextToken

string

optional

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

🟠480DoesNotExistException

🟠481InternalServerError