describe-instance-information¶

Description¶

Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.

If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

Note

The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.

Synopsis¶

  describe-instance-information
[--instance-information-filter-list <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--instance-information-filter-list (list)

This is a legacy method. We recommend that you don’t use this method. Instead, use the Filters data type. Filters enables you to return instance information by filtering based on tags applied to managed instances.

Note

Attempting to use InstanceInformationFilterList and Filters leads to an exception error.

(structure)

Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.

Use this action instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and does not support tags.

key -> (string)

The name of the filter.

valueSet -> (list)

The filter values.

(string)

Shorthand Syntax:

key=string,valueSet=string,string ...

JSON Syntax:

[
  {
    "key": "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus",
    "valueSet": ["string", ...]
  }
  ...
]

--filters (list)

One or more filters. Use a filter to return a more specific list of instances. You can filter based on tags applied to EC2 instances. Use this Filters data type instead of InstanceInformationFilterList , which is deprecated.

(structure)

The filters to describe or get information about your managed instances.

Key -> (string)

The filter key name to describe your instances. For example:

“InstanceIds”|”AgentVersion”|”PingStatus”|”PlatformTypes”|”ActivationIds”|”IamRole”|”ResourceType”|”AssociationStatus”|”Tag Key”

Warning

Tag key is not a valid filter. You must specify either tag-key or tag:keyname and a string. Here are some valid examples: tag-key, tag:123, tag:al!, tag:Windows. Here are some invalid examples: tag-keys, Tag Key, tag:, tagKey, abc:keyname.

Values -> (list)

The filter values.

(string)

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Example 1: To describe managed instance information

The following describe-instance-information example retrieves details of each of your managed instances.

aws ssm describe-instance-information

Example 2: To describe information about a specific managed instance

The following describe-instance-information example shows details of the managed instance i-028ea792daEXAMPLE.

aws ssm describe-instance-information \
    --filters "Key=InstanceIds,Values=i-028ea792daEXAMPLE"

Example 3: To describe information about managed instances with a specific tag key

The following describe-instance-information example shows details for managed instances that have the tag key DEV.

aws ssm describe-instance-information \
    --filters "Key=tag-key,Values=DEV"

Output:

{
    "InstanceInformationList": [
        {
            "InstanceId": "i-028ea792daEXAMPLE",
            "PingStatus": "Online",
            "LastPingDateTime": 1582221233.421,
            "AgentVersion": "2.3.842.0",
            "IsLatestVersion": true,
            "PlatformType": "Linux",
            "PlatformName": "SLES",
            "PlatformVersion": "15.1",
            "ResourceType": "EC2Instance",
            "IPAddress": "192.0.2.0",
            "ComputerName": "ip-198.51.100.0.us-east-2.compute.internal",
            "AssociationStatus": "Success",
            "LastAssociationExecutionDate": 1582220806.0,
            "LastSuccessfulAssociationExecutionDate": 1582220806.0,
            "AssociationOverview": {
                "DetailedStatus": "Success",
                "InstanceAssociationStatusAggregatedCount": {
                    "Success": 2
                }
            }
        }
    ]
}

For more information, see Managed Instances in the AWS Systems Manager User Guide.

Output¶

InstanceInformationList -> (list)

The instance information list.

(structure)

Describes a filter for a specific list of instances.

InstanceId -> (string)

The instance ID.

PingStatus -> (string)

Connection status of SSM Agent.

Note

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

LastPingDateTime -> (timestamp)

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

AgentVersion -> (string)

The version of SSM Agent running on your Linux instance.

IsLatestVersion -> (boolean)

Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.

PlatformType -> (string)

The operating system platform type.

PlatformName -> (string)

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

PlatformVersion -> (string)

The version of the OS platform running on your instance.

ActivationId -> (string)

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

IamRole -> (string)

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

RegistrationDate -> (timestamp)

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

ResourceType -> (string)

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

Name -> (string)

The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, 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 action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference .

IPAddress -> (string)

The IP address of the managed instance.

ComputerName -> (string)

The fully qualified host name of the managed instance.

AssociationStatus -> (string)

The status of the association.

LastAssociationExecutionDate -> (timestamp)

The date the association was last run.

LastSuccessfulAssociationExecutionDate -> (timestamp)

The last date the association was successfully run.

AssociationOverview -> (structure)

Information about the association.

DetailedStatus -> (string)

Detailed status information about the aggregated associations.

InstanceAssociationStatusAggregatedCount -> (map)

The number of associations for the instance(s).

key -> (string)

value -> (integer)

NextToken -> (string)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Table of Contents

Feedback

User Guide