[ aws . ssm ]

list-inventory-entries

Description

A list of inventory items returned by the request.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-inventory-entries
--instance-id <value>
--type-name <value>
[--filters <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--instance-id (string)

The instance ID for which you want inventory information.

--type-name (string)

The type of inventory item for which you want information.

--filters (list)

One or more filters. Use a filter to return a more specific list of results.

(structure)

One or more filters. Use a filter to return a more specific list of results.

Key -> (string)

The name of the filter key.

Values -> (list)

Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

(string)

Type -> (string)

The type of filter.

Note

The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide .

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
  }
  ...
]

--next-token (string)

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

--max-results (integer)

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.

--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.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view specific inventory type entries for an instance

This example lists the inventory entries for the AWS:Application inventory type on a specific instance.

Command:

aws ssm list-inventory-entries --instance-id "i-1234567890abcdef0" --type-name "AWS:Application"

Output:

{
  "TypeName": "AWS:Application",
  "InstanceId": "i-1234567890abcdef0",
  "SchemaVersion": "1.1",
  "CaptureTime": "2019-02-15T12:17:55Z",
  "Entries": [
      {
          "Architecture": "i386",
          "Name": "Amazon SSM Agent",
          "PackageId": "{88a60be2-89a1-4df8-812a-80863c2a2b68}",
          "Publisher": "Amazon Web Services",
          "Version": "2.3.274.0"
      },
      {
          "Architecture": "x86_64",
          "InstalledTime": "2018-05-03T13:42:34Z",
          "Name": "AmazonCloudWatchAgent",
          "Publisher": "",
          "Version": "1.200442.0"
      },
      ...
  ]
}

Output

TypeName -> (string)

The type of inventory item returned by the request.

InstanceId -> (string)

The instance ID targeted by the request to query inventory information.

SchemaVersion -> (string)

The inventory schema version used by the instance(s).

CaptureTime -> (string)

The time that inventory information was collected for the instance(s).

Entries -> (list)

A list of inventory items on the instance(s).

(map)

key -> (string)

value -> (string)

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.