Describe Instance Information

ssm_describe_instance_information

R Documentation

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address¶

Description¶

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.

Usage¶

ssm_describe_instance_information(InstanceInformationFilterList,
  Filters, MaxResults, NextToken)

Arguments¶

InstanceInformationFilterList

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 node information by filtering based on tags applied to managed nodes.

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

Filters

One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can't be combined with other filter types. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. The default value is 10 items.

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Value¶

A list with the following syntax:

list(
  InstanceInformationList = list(
    list(
      InstanceId = "string",
      PingStatus = "Online"|"ConnectionLost"|"Inactive",
      LastPingDateTime = as.POSIXct(
        "2015-01-01"
      ),
      AgentVersion = "string",
      IsLatestVersion = TRUE|FALSE,
      PlatformType = "Windows"|"Linux"|"MacOS",
      PlatformName = "string",
      PlatformVersion = "string",
      ActivationId = "string",
      IamRole = "string",
      RegistrationDate = as.POSIXct(
        "2015-01-01"
      ),
      ResourceType = "ManagedInstance"|"EC2Instance",
      Name = "string",
      IPAddress = "string",
      ComputerName = "string",
      AssociationStatus = "string",
      LastAssociationExecutionDate = as.POSIXct(
        "2015-01-01"
      ),
      LastSuccessfulAssociationExecutionDate = as.POSIXct(
        "2015-01-01"
      ),
      AssociationOverview = list(
        DetailedStatus = "string",
        InstanceAssociationStatusAggregatedCount = list(
          123
        )
      ),
      SourceId = "string",
      SourceType = "AWS::EC2::Instance"|"AWS::IoT::Thing"|"AWS::SSM::ManagedInstance"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_instance_information(
  InstanceInformationFilterList = list(
    list(
      key = "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus",
      valueSet = list(
        "string"
      )
    )
  ),
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)