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

InstanceInformation

Describes a filter for a specific list of instances.

Contents

ActivationId

The activation ID created by Systems Manager when the server or VM was registered.

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

AgentVersion

The version of SSM Agent running on your Linux instance.

Type: String

Pattern: ^[0-9]{1,6}(\.[0-9]{1,6}){2,3}$

Required: No

AssociationOverview

Information about the association.

Type: InstanceAggregatedAssociationOverview object

Required: No

AssociationStatus

The status of the association.

Type: String

Required: No

ComputerName

The fully qualified host name of the managed instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

IamRole

The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.

Type: String

Length Constraints: Maximum length of 64.

Required: No

InstanceId

The instance ID.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Required: No

IPAddress

The IP address of the managed instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 46.

Required: No

IsLatestVersion

Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.

Type: Boolean

Required: No

LastAssociationExecutionDate

The date the association was last executed.

Type: Timestamp

Required: No

LastPingDateTime

The date and time when agent last pinged Systems Manager service.

Type: Timestamp

Required: No

LastSuccessfulAssociationExecutionDate

The last date the association was successfully run.

Type: Timestamp

Required: No

Name

The name of the managed instance.

Type: String

Required: No

PingStatus

Connection status of SSM Agent.

Type: String

Valid Values: Online | ConnectionLost | Inactive

Required: No

PlatformName

The name of the operating system platform running on your instance.

Type: String

Required: No

PlatformType

The operating system platform type.

Type: String

Valid Values: Windows | Linux

Required: No

PlatformVersion

The version of the OS platform running on your instance.

Type: String

Required: No

RegistrationDate

The date the server or VM was registered with AWS as a managed instance.

Type: Timestamp

Required: No

ResourceType

The type of instance. Instances are either EC2 instances or managed instances.

Type: String

Valid Values: ManagedInstance | Document | EC2Instance

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: