/ - Amazon Simple Systems Manager (SSM)

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "WindowId": "string", "ResourceType": "INSTANCE", "Targets": [], "OwnerInformation": "string", "Name": "string", "Description": "string", "ClientToken": "string" }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

WindowId

string

required

The ID of the maintenance window the target should be registered with.

>= 20 characters<= 20 characters

Match pattern:

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

ResourceType

enum<string>

required

The type of target being registered with the maintenance window.

Allowed values:

INSTANCERESOURCE_GROUP

Targets

array [object]

required

The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

Example 1: Specify managed node IDs

Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>

Example 2: Use tag key-pairs applied to managed nodes

Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

Example 3: Use tag-keys applied to managed nodes

Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

Example 4: Use resource group names

Key=resource-groups:Name,Values=<resource-group-name>

Example 5: Use filters for resource group types

Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

>= 0 items<= 5 items

OwnerInformation

string <password>

optional

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

>= 1 characters<= 128 characters

Name

string

optional

An optional name for the target.

>= 3 characters<= 128 characters

Match pattern:

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

Description

string <password>

optional

An optional description for the target.

>= 1 characters<= 128 characters

ClientToken

string

optional

User-provided idempotency token.

>= 1 characters<= 64 characters

Examples

Responses

🟢200Success

application/json

Body

WindowTargetId

string

optional

The ID of the target definition in this maintenance window.

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

🟠480IdempotentParameterMismatch

🟠481DoesNotExistException

🟠482ResourceLimitExceededException

🟠483InternalServerError