InstanceInformation - AWS Systems Manager

InstanceInformation

Describes a filter for a specific list of managed nodes.

Contents

ActivationId

The activation ID created by AWS Systems Manager when the server or virtual machine (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 managed node.

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

Type: String

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

Required: No

IamRole

The AWS Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

Type: String

Length Constraints: Maximum length of 64.

Required: No

InstanceId

The managed node ID.

Type: String

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

Required: No

IPAddress

The IP address of the managed node.

Type: String

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

Required: No

IsLatestVersion

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.

Type: Boolean

Required: No

LastAssociationExecutionDate

The date the association was last run.

Type: Timestamp

Required: No

LastPingDateTime

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

Type: Timestamp

Required: No

LastSuccessfulAssociationExecutionDate

The last date the association was successfully run.

Type: Timestamp

Required: No

Name

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

Type: String

Required: No

PingStatus

Connection status of SSM Agent.

Note

The status Inactive has been deprecated and is no longer in use.

Type: String

Valid Values: Online | ConnectionLost | Inactive

Required: No

PlatformName

The name of the operating system platform running on your managed node.

Type: String

Required: No

PlatformType

The operating system platform type.

Type: String

Valid Values: Windows | Linux | MacOS

Required: No

PlatformVersion

The version of the OS platform running on your managed node.

Type: String

Required: No

RegistrationDate

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

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

SourceId

The ID of the source resource. For AWS IoT Greengrass devices, SourceId is the Thing name.

Type: String

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

Pattern: ^[a-zA-Z0-9:_-]*$

Required: No

SourceType

The type of the source resource. For AWS IoT Greengrass devices, SourceType is AWS::IoT::Thing.

Type: String

Valid Values: AWS::EC2::Instance | AWS::IoT::Thing | AWS::SSM::ManagedInstance

Required: No

See Also

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