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

Activation

An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.

Contents

ActivationId

The ID created by Systems Manager when you submitted the activation.

Type: String

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

Required: No

CreatedDate

The date the activation was created.

Type: Timestamp

Required: No

DefaultInstanceName

A name for the managed instance when it is created.

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

Type: String

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

Required: No

ExpirationDate

The date when this activation can no longer be used to register managed instances.

Type: Timestamp

Required: No

Expired

Whether or not the activation is expired.

Type: Boolean

Required: No

IamRole

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

Type: String

Length Constraints: Maximum length of 64.

Required: No

RegistrationLimit

The maximum number of managed instances that can be registered using this activation.

Type: Integer

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

Required: No

RegistrationsCount

The number of managed instances already registered with this activation.

Type: Integer

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

Required: No

See Also

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

On this page: