Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateActivation

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with AWS 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 Using AWS Systems Manager in hybrid and multicloud environments in the AWS Systems Manager User Guide.

Note

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

Request Syntax


{
   "DefaultInstanceName": "string",
   "Description": "string",
   "ExpirationDate": number,
   "IamRole": "string",
   "RegistrationLimit": number,
   "RegistrationMetadata": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

DefaultInstanceName

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

Important

Don't enter personally identifiable information in this field.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

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

Required: No

Description

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

Important

Don't enter personally identifiable information in this field.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

ExpirationDate

The date by which this activation request should expire, in timestamp format, such as "2024-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.

Type: Timestamp

Required: No

IamRole

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

Note

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

RegistrationLimit

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

RegistrationMetadata

Reserved for internal use.

Type: Array of RegistrationMetadataItem objects

Required: No

Tags

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

Important

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

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 AWS 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.

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

Response Syntax


{
   "ActivationCode": "string",
   "ActivationId": "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.

ActivationCode

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 250.

ActivationId

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

Type: String

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

Errors

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

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidParameters

You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateActivation.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.CreateActivation
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T135329Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 70

{
    "IamRole": "service-role/role_name"
}

Sample Response


{
    "ActivationCode": "Fjz3/sZfSvv78EXAMPLE",
    "ActivationId": "e488f2f6-e686-4afb-8a04-ef6dfEXAMPLE"
}