/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Description": "string",
    "DefaultInstanceName": "string",
    "IamRole": "string",
    "RegistrationLimit": 0,
    "ExpirationDate": "string",
    "Tags": [],
    "RegistrationMetadata": []
}'

Response Example

200 - Example 1

{
    "ActivationId": "string",
    "ActivationCode": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Description

string

optional

A user-defined description of the resource that you want to register with Systems Manager.

>= 0 characters<= 256 characters

DefaultInstanceName

string

optional

The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

>= 0 characters<= 256 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

IamRole

string

required

The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.

<= 64 characters

RegistrationLimit

integer

optional

Specify the maximum number of managed nodes you want to register. The default value is 1.

>= 1<= 1000

ExpirationDate

string <date-time>

optional

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

Tags

array[object (Tag) {2}]

optional

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

Key=OS,Value=Windows
Key=Environment,Value=Production

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

<= 1000 items

Key

string

required

The name of the tag.

>= 1 characters<= 128 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value

string

required

The value of the tag.

>= 0 characters<= 256 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

RegistrationMetadata

array[object (RegistrationMetadataItem) {2}]

optional

Reserved for internal use.

Key

string

required

Reserved for internal use.

>= 1 characters<= 128 characters

Match pattern:

^(?!\s*$).+

Value

string

required

Reserved for internal use.

>= 1 characters<= 2048 characters

Match pattern:

^(?!\s*$).+

Examples

Responses

🟢200Success

application/json

Body

ActivationId

string

optional

The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

Match pattern:

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

ActivationCode

string

optional

The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

>= 20 characters<= 250 characters

🟠480InvalidParameters

🟠481InternalServerError