Skip to content

InstanceInformation

Source code in docs_src/capo_ssm/types/instance_information.py
class InstanceInformation(TypedDict, closed=True):
    instance_id: NotRequired["capo_ssm.types.instance_id.InstanceId"]
    """<p>The managed node ID. </p>"""
    ping_status: NotRequired["capo_ssm.types.ping_status.PingStatus"]
    """<p>Connection status of SSM Agent. </p> <note> <p>The status <code>Inactive</code> has been deprecated and is no longer in use.</p> </note>"""
    last_ping_date_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time when the agent last pinged the Systems Manager service. </p>"""
    agent_version: NotRequired["capo_ssm.types.version.Version"]
    """<p>The version of SSM Agent running on your Linux managed node. </p>"""
    is_latest_version: NotRequired["capo_ssm.types.boolean.Boolean"]
    """<p>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.</p>"""
    platform_type: NotRequired["capo_ssm.types.platform_type.PlatformType"]
    """<p>The operating system platform type.</p>"""
    platform_name: NotRequired["capo_ssm.types.string.String"]
    """<p>The name of the operating system platform running on your managed node. </p>"""
    platform_version: NotRequired["capo_ssm.types.string.String"]
    """<p>The version of the OS platform running on your managed node. </p>"""
    activation_id: NotRequired["capo_ssm.types.activation_id.ActivationId"]
    """<p>The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.</p>"""
    iam_role: NotRequired["capo_ssm.types.iam_role.IamRole"]
    """<p>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.</p> <p> This call doesn't return the IAM role for <i>unmanaged</i> Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html">describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>"""
    registration_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the server or VM was registered with Amazon Web Services as a managed node.</p>"""
    resource_type: NotRequired["capo_ssm.types.resource_type.ResourceType"]
    """<p>The type of instance. Instances are either EC2 instances or managed instances. </p>"""
    name: NotRequired["capo_ssm.types.string.String"]
    """<p>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 <code>DefaultInstanceName</code> property using the <a>CreateActivation</a> 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 <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-ssm-agent-install-linux.html">How to install SSM Agent on hybrid Linux nodes</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/hybrid-multicloud-ssm-agent-install-windows.html">How to install SSM Agent on hybrid Windows Server nodes</a>. To retrieve the <code>Name</code> tag of an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html">describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>"""
    ip_address: NotRequired["capo_ssm.types.ip_address.IPAddress"]
    """<p>The IP address of the managed node.</p>"""
    computer_name: NotRequired["capo_ssm.types.computer_name.ComputerName"]
    """<p>The fully qualified host name of the managed node.</p>"""
    association_status: NotRequired["capo_ssm.types.status_name.StatusName"]
    """<p>The status of the association.</p>"""
    last_association_execution_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date the association was last run.</p>"""
    last_successful_association_execution_date: NotRequired[
        "capo_ssm.types.date_time.DateTime"
    ]
    """<p>The last date the association was successfully run.</p>"""
    association_overview: NotRequired[
        "capo_ssm.types.instance_aggregated_association_overview.InstanceAggregatedAssociationOverview"
    ]
    """<p>Information about the association.</p>"""
    source_id: NotRequired["capo_ssm.types.source_id.SourceId"]
    """<p>The ID of the source resource. For IoT Greengrass devices, <code>SourceId</code> is the Thing name. </p>"""
    source_type: NotRequired["capo_ssm.types.source_type.SourceType"]
    """<p>The type of the source resource. For IoT Greengrass devices, <code>SourceType</code> is <code>AWS::IoT::Thing</code>. For Azure Virtual Machines, <code>SourceType</code> is <code>Microsoft.Compute/virtualMachines</code>.</p>"""
    source_location: NotRequired["capo_ssm.types.source_location.SourceLocation"]
    """<p>The location of the source resource in the third-party cloud environment.</p>"""

activation_id instance-attribute

activation_id: NotRequired[ActivationId]

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

agent_version instance-attribute

agent_version: NotRequired[Version]

The version of SSM Agent running on your Linux managed node.

association_overview instance-attribute

association_overview: NotRequired[InstanceAggregatedAssociationOverview]

Information about the association.

association_status instance-attribute

association_status: NotRequired[StatusName]

The status of the association.

computer_name instance-attribute

computer_name: NotRequired[ComputerName]

The fully qualified host name of the managed node.

iam_role instance-attribute

iam_role: NotRequired[IamRole]

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 instance-attribute

instance_id: NotRequired[InstanceId]

The managed node ID.

ip_address instance-attribute

ip_address: NotRequired[IPAddress]

The IP address of the managed node.

is_latest_version instance-attribute

is_latest_version: NotRequired[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 instance-attribute

last_association_execution_date: NotRequired[DateTime]

The date the association was last run.

last_ping_date_time instance-attribute

last_ping_date_time: NotRequired[DateTime]

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

last_successful_association_execution_date instance-attribute

last_successful_association_execution_date: NotRequired[DateTime]

The last date the association was successfully run.

name instance-attribute

name: NotRequired[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 instance-attribute

ping_status: NotRequired[PingStatus]

Connection status of SSM Agent.

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

platform_name instance-attribute

platform_name: NotRequired[String]

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

platform_type instance-attribute

platform_type: NotRequired[PlatformType]

The operating system platform type.

platform_version instance-attribute

platform_version: NotRequired[String]

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

registration_date instance-attribute

registration_date: NotRequired[DateTime]

The date the server or VM was registered with Amazon Web Services as a managed node.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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

source_id instance-attribute

source_id: NotRequired[SourceId]

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

source_location instance-attribute

source_location: NotRequired[SourceLocation]

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

source_type instance-attribute

source_type: NotRequired[SourceType]

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines.