/

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

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠480InvalidParameters

🟠481InternalServerError

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Modified at 2023-08-15 10:32:32