View a markdown version of this page

InstanceInfo - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

InstanceInfo

Details about a specific managed node.

Contents

AgentType

The type of agent installed on the node.

Type: String

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

Required: No

AgentVersion

The version number of the agent installed on the node.

Type: String

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

Required: No

AvailabilityZone

The Availability Zone where the managed node is located.

Type: String

Length Constraints: Maximum length of 120.

Required: No

AvailabilityZoneId

The Availability Zone ID where the managed node is located.

Type: String

Length Constraints: Maximum length of 50.

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

InstanceStatus

The current status of the managed node.

Type: String

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

Required: No

IpAddress

The IP address of the managed node.

Type: String

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

Required: No

ManagedStatus

Indicates whether the node is managed by Systems Manager.

Type: String

Valid Values: All | Managed | Unmanaged

Required: No

Name

The name assigned to the managed node.

Type: String

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

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

Required: No

PlatformName

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

Type: String

Length Constraints: Maximum length of 120.

Required: No

PlatformType

The operating system platform type of the managed node.

Type: String

Valid Values: Windows | Linux | MacOS

Required: No

PlatformVersion

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

Type: String

Length Constraints: Maximum length of 120.

Required: No

ResourceType

The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet.

Type: String

Valid Values: ManagedInstance | EC2Instance

Required: No

SourceId

The ID of the source resource. For Amazon 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

SourceLocation

The location of the source resource in the third-party cloud environment.

Type: String

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

Pattern: ^.{1,128}$

Required: No

SourceType

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

Type: String

Valid Values: AWS::EC2::Instance | AWS::IoT::Thing | AWS::SSM::ManagedInstance | Microsoft.Compute/virtualMachines

Required: No

See Also

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