instance_informations
Creates, updates, deletes, gets or lists an instance_informations resource.
Overview
| Name | instance_informations |
| Type | Resource |
| Id | aws.ssm.instance_informations |
Fields
The following fields are returned by SELECT queries:
- describe_instance_information
| Name | Datatype | Description |
|---|---|---|
activation_id | string | The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered. (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>) |
agent_version | string | The version of SSM Agent running on your Linux managed node. (pattern: <code>^[0-9]{1,6}(.[0-9]{1,6}){2,3}$</code>) |
association_overview | object | Information about the association. |
association_status | string | The status of the association. |
computer_name | string | The fully qualified host name of the managed node. |
ip_address | string | The IP address of the managed node. |
iam_role | string | The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node. This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference. |
instance_id | string | The managed node ID. (pattern: <code>(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)</code>) |
is_latest_version | boolean | 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. |
last_association_execution_date | string (date-time) | The date the association was last run. |
last_ping_date_time | string (date-time) | The date and time when the agent last pinged the Systems Manager service. |
last_successful_association_execution_date | string (date-time) | The last date the association was successfully run. |
name | string | 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 How to install SSM Agent on hybrid Linux nodes and How to install SSM Agent on hybrid Windows Server nodes. 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 Amazon Web Services CLI Command Reference. |
ping_status | string | Connection status of SSM Agent. The status Inactive has been deprecated and is no longer in use. (Online, ConnectionLost, Inactive) |
platform_name | string | The name of the operating system platform running on your managed node. |
platform_type | string | The operating system platform type. (Windows, Linux, MacOS) |
platform_version | string | The version of the OS platform running on your managed node. |
registration_date | string (date-time) | The date the server or VM was registered with Amazon Web Services as a managed node. |
resource_type | string | The type of instance. Instances are either EC2 instances or managed instances. (ManagedInstance, EC2Instance) |
source_id | string | The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name. (pattern: <code>^[a-zA-Z0-9:_-]*$</code>) |
source_location | string | The location of the source resource in the third-party cloud environment. (pattern: <code>^.{1,128}$</code>) |
source_type | string | The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines. (AWS::EC2::Instance, AWS::IoT::Thing, AWS::SSM::ManagedInstance, Microsoft.Compute/virtualMachines) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_instance_information | select | region | Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated. If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error. The IamRole field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_instance_information
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated. If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error. The IamRole field returned for this API operation is the role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.
SELECT
activation_id,
agent_version,
association_overview,
association_status,
computer_name,
ip_address,
iam_role,
instance_id,
is_latest_version,
last_association_execution_date,
last_ping_date_time,
last_successful_association_execution_date,
name,
ping_status,
platform_name,
platform_type,
platform_version,
registration_date,
resource_type,
source_id,
source_location,
source_type
FROM aws.ssm.instance_informations
WHERE region = '{{ region }}' -- required
;