ssm_describe_instance_information: Describes one or more of your instances, including...

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

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.

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.

Usage

1
2
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 instance information by filtering based on tags applied to managed instances.

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 instances. You can filter based on tags applied to EC2 instances. 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.

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
list(
  InstanceInformationList = list(
    list(
      InstanceId = "string",
      PingStatus = "Online"|"ConnectionLost"|"Inactive",
      LastPingDateTime = as.POSIXct(
        "2015-01-01"
      ),
      AgentVersion = "string",
      IsLatestVersion = TRUE|FALSE,
      PlatformType = "Windows"|"Linux",
      PlatformName = "string",
      PlatformVersion = "string",
      ActivationId = "string",
      IamRole = "string",
      RegistrationDate = as.POSIXct(
        "2015-01-01"
      ),
      ResourceType = "ManagedInstance"|"Document"|"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
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
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"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.