Describe Instance Properties

ssm_describe_instance_properties

R Documentation

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes

Description

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

Usage

ssm_describe_instance_properties(InstancePropertyFilterList,
  FiltersWithOperator, MaxResults, NextToken)

Arguments

InstancePropertyFilterList

An array of instance property filters.

FiltersWithOperator

The request filters to use with the operator.

MaxResults

The maximum number of items to return for the 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 provided by a previous request to use to return the next set of properties.

Value

A list with the following syntax:

list(
  InstanceProperties = list(
    list(
      Name = "string",
      InstanceId = "string",
      InstanceType = "string",
      InstanceRole = "string",
      KeyName = "string",
      InstanceState = "string",
      Architecture = "string",
      IPAddress = "string",
      LaunchTime = as.POSIXct(
        "2015-01-01"
      ),
      PingStatus = "Online"|"ConnectionLost"|"Inactive",
      LastPingDateTime = as.POSIXct(
        "2015-01-01"
      ),
      AgentVersion = "string",
      PlatformType = "Windows"|"Linux"|"MacOS",
      PlatformName = "string",
      PlatformVersion = "string",
      ActivationId = "string",
      IamRole = "string",
      RegistrationDate = as.POSIXct(
        "2015-01-01"
      ),
      ResourceType = "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_properties(
  InstancePropertyFilterList = list(
    list(
      key = "InstanceIds"|"AgentVersion"|"PingStatus"|"PlatformTypes"|"DocumentName"|"ActivationIds"|"IamRole"|"ResourceType"|"AssociationStatus",
      valueSet = list(
        "string"
      )
    )
  ),
  FiltersWithOperator = list(
    list(
      Key = "string",
      Values = list(
        "string"
      ),
      Operator = "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)