Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

CreateActivation

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.

Request Syntax

{
   "DefaultInstanceName": "string",
   "Description": "string",
   "ExpirationDate": number,
   "IamRole": "string",
   "RegistrationLimit": number
}

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 instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.

Type: String

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

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

Required: No

Description

A userdefined description of the resource that you want to register with Amazon EC2.

Type: String

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

Required: No

ExpirationDate

The date by which this activation request should expire. The default value is 24 hours.

Type: Timestamp

Required: No

IamRole

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

RegistrationLimit

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

Type: Integer

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

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: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: