<a id="cli-aws-ssm-get-inventory"></a>

# get-inventory

## Description

Query inventory information. This includes managed node status, such as `Stopped` or `Terminated` .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/GetInventory)

`get-inventory` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `Entities`

## Synopsis

```
  get-inventory
[--filters <value>]
[--aggregators <value>]
[--result-attributes <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
```

## Options

`--filters` (list)

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

> Constraints:

> * min: `1`
> * max: `5`

> (structure)

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

> > > **Example formats for the \`\`aws ssm get-inventory\`\` command:**

> > > `--filters Key=AWS:InstanceInformation.AgentType,Values=amazon-ssm-agent,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.AgentVersion,Values=3.3.2299.0,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.ComputerName,Values=ip-192.0.2.0.us-east-2.compute.internal,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.InstanceId,Values=i-0a4cd6ceffEXAMPLE,i-1a2b3c4d5e6EXAMPLE,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.InstanceStatus,Values=Active,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.IpAddress,Values=198.51.100.0,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.PlatformName,Values="Amazon Linux",Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.PlatformType,Values=Linux,Type=Equal`

> > > `--filters Key=AWS:InstanceInformation.PlatformVersion,Values=2023,Type=BeginWith`

> > > `--filters Key=AWS:InstanceInformation.ResourceType,Values=EC2Instance,Type=Equal`

> > Key -> (string) [required]

> > > The name of the filter key.

> > > Constraints:

> > > * min: `1`
> > > * max: `200`

> > Values -> (list) [required]

> > > Inventory filter values.

> > > Constraints:

> > > * min: `1`
> > > * max: `40`

> > > (string)

> > Type -> (string)

> > > The type of filter.

> > > #### NOTE
> > > The `Exists` filter must be used with aggregators. For more information, see [Aggregating inventory data](https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-aggregate.html) in the *Amazon Web Services Systems Manager User Guide* .

> > > Possible values:

> > > * `Equal`
> > > * `NotEqual`
> > > * `BeginWith`
> > > * `LessThan`
> > > * `GreaterThan`
> > > * `Exists`

Shorthand Syntax:

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

JSON Syntax:

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

`--aggregators` (list)

> Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the `AWS:InstanceInformation.PlatformType` type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.

> Constraints:

> * min: `1`
> * max: `10`

> (structure)

> > Specifies the inventory type and attribute for the aggregation execution.

> > Expression -> (string)

> > > The inventory type and attribute name for aggregation.

> > > Constraints:

> > > * min: `1`
> > > * max: `1000`

> > Aggregators -> (list)

> > > Nested aggregators to further refine aggregation for an inventory type.

> > > Constraints:

> > > * min: `1`
> > > * max: `10`

> > > (structure)

> > > > Specifies the inventory type and attribute for the aggregation execution.

> > > > Expression -> (string)

> > > > > The inventory type and attribute name for aggregation.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `1000`

> > > > Groups -> (list)

> > > > > A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don’t match the specified criteria.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `15`

> > > > > (structure)

> > > > > > A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don’t match the specified criteria.

> > > > > > Name -> (string) [required]

> > > > > > > The name of the group.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `200`

> > > > > > Filters -> (list) [required]

> > > > > > > Filters define the criteria for the group. The `matchingCount` field displays the number of resources that match the criteria. The `notMatchingCount` field displays the number of resources that don’t match the criteria.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `5`

> > > > > > > (structure)

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

> > > > > > > > > **Example formats for the \`\`aws ssm get-inventory\`\` command:**

> > > > > > > > > `--filters Key=AWS:InstanceInformation.AgentType,Values=amazon-ssm-agent,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.AgentVersion,Values=3.3.2299.0,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.ComputerName,Values=ip-192.0.2.0.us-east-2.compute.internal,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.InstanceId,Values=i-0a4cd6ceffEXAMPLE,i-1a2b3c4d5e6EXAMPLE,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.InstanceStatus,Values=Active,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.IpAddress,Values=198.51.100.0,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.PlatformName,Values="Amazon Linux",Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.PlatformType,Values=Linux,Type=Equal`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.PlatformVersion,Values=2023,Type=BeginWith`

> > > > > > > > > `--filters Key=AWS:InstanceInformation.ResourceType,Values=EC2Instance,Type=Equal`

> > > > > > > > Key -> (string) [required]

> > > > > > > > > The name of the filter key.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `1`
> > > > > > > > > * max: `200`

> > > > > > > > Values -> (list) [required]

> > > > > > > > > Inventory filter values.

> > > > > > > > > Constraints:

> > > > > > > > > * min: `1`
> > > > > > > > > * max: `40`

> > > > > > > > > (string)

> > > > > > > > Type -> (string)

> > > > > > > > > The type of filter.

> > > > > > > > > #### NOTE
> > > > > > > > > The `Exists` filter must be used with aggregators. For more information, see [Aggregating inventory data](https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-aggregate.html) in the *Amazon Web Services Systems Manager User Guide* .

> > > > > > > > > Possible values:

> > > > > > > > > * `Equal`
> > > > > > > > > * `NotEqual`
> > > > > > > > > * `BeginWith`
> > > > > > > > > * `LessThan`
> > > > > > > > > * `GreaterThan`
> > > > > > > > > * `Exists`

> > Groups -> (list)

> > > A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don’t match the specified criteria.

> > > Constraints:

> > > * min: `1`
> > > * max: `15`

> > > (structure)

> > > > A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don’t match the specified criteria.

> > > > Name -> (string) [required]

> > > > > The name of the group.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `200`

> > > > Filters -> (list) [required]

> > > > > Filters define the criteria for the group. The `matchingCount` field displays the number of resources that match the criteria. The `notMatchingCount` field displays the number of resources that don’t match the criteria.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `5`

> > > > > (structure)

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

> > > > > > > **Example formats for the \`\`aws ssm get-inventory\`\` command:**

> > > > > > > `--filters Key=AWS:InstanceInformation.AgentType,Values=amazon-ssm-agent,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.AgentVersion,Values=3.3.2299.0,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.ComputerName,Values=ip-192.0.2.0.us-east-2.compute.internal,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.InstanceId,Values=i-0a4cd6ceffEXAMPLE,i-1a2b3c4d5e6EXAMPLE,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.InstanceStatus,Values=Active,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.IpAddress,Values=198.51.100.0,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.PlatformName,Values="Amazon Linux",Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.PlatformType,Values=Linux,Type=Equal`

> > > > > > > `--filters Key=AWS:InstanceInformation.PlatformVersion,Values=2023,Type=BeginWith`

> > > > > > > `--filters Key=AWS:InstanceInformation.ResourceType,Values=EC2Instance,Type=Equal`

> > > > > > Key -> (string) [required]

> > > > > > > The name of the filter key.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `200`

> > > > > > Values -> (list) [required]

> > > > > > > Inventory filter values.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `40`

> > > > > > > (string)

> > > > > > Type -> (string)

> > > > > > > The type of filter.

> > > > > > > #### NOTE
> > > > > > > The `Exists` filter must be used with aggregators. For more information, see [Aggregating inventory data](https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-aggregate.html) in the *Amazon Web Services Systems Manager User Guide* .

> > > > > > > Possible values:

> > > > > > > * `Equal`
> > > > > > > * `NotEqual`
> > > > > > > * `BeginWith`
> > > > > > > * `LessThan`
> > > > > > > * `GreaterThan`
> > > > > > > * `Exists`

JSON Syntax:

```json
[
  {
    "Expression": "string",
    "Aggregators": [
      {
        "Expression": "string",
        "Aggregators": ,
        "Groups": [
          {
            "Name": "string",
            "Filters": [
              {
                "Key": "string",
                "Values": ["string", ...],
                "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
              }
              ...
            ]
          }
          ...
        ]
      }
      ...
    ],
    "Groups": [
      {
        "Name": "string",
        "Filters": [
          {
            "Key": "string",
            "Values": ["string", ...],
            "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
          }
          ...
        ]
      }
      ...
    ]
  }
  ...
]
```

`--result-attributes` (list)

> The list of inventory item types to return.

> Constraints:

> * min: `1`
> * max: `1`

> (structure)

> > The inventory item result attribute.

> > TypeName -> (string) [required]

> > > Name of the inventory item type. Valid value: `AWS:InstanceInformation` . Default Value: `AWS:InstanceInformation` .

> > > Constraints:

> > > * min: `1`
> > > * max: `100`
> > > * pattern: `^(AWS|Custom):.*$`

Shorthand Syntax:

```
TypeName=string ...
```

JSON Syntax:

```json
[
  {
    "TypeName": "string"
  }
  ...
]
```

`--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) 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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `50`

`--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To view your inventory**

The following `get-inventory` example gets the custom metadata for your inventory.

```bash
aws ssm get-inventory
```

Output:

```json
{
    "Entities": [
        {
            "Data": {
                "AWS:InstanceInformation": {
                    "Content": [
                        {
                            "ComputerName": "ip-172-31-44-222.us-west-2.compute.internal",
                            "InstanceId": "i-0cb2b964d3e14fd9f",
                            "IpAddress": "172.31.44.222",
                            "AgentType": "amazon-ssm-agent",
                            "ResourceType": "EC2Instance",
                            "AgentVersion": "2.0.672.0",
                            "PlatformVersion": "2016.09",
                            "PlatformName": "Amazon Linux AMI",
                            "PlatformType": "Linux"
                        }
                    ],
                    "TypeName": "AWS:InstanceInformation",
                    "SchemaVersion": "1.0",
                    "CaptureTime": "2017-02-20T18:03:58Z"
                }
            },
            "Id": "i-0cb2b964d3e14fd9f"
        }
    ]
}
```

For more information, see [AWS Systems Manager Inventory](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-inventory.html) in the *AWS Systems Manager User Guide*.

## Output

Entities -> (list)

> Collection of inventory entities such as a collection of managed node inventory.

> (structure)

> > Inventory query results.

> > Id -> (string)

> > > ID of the inventory result entity. For example, for managed node inventory the result will be the managed node ID. For EC2 instance inventory, the result will be the instance ID.

> > Data -> (map)

> > > The data section in the inventory result entity JSON.

> > > key -> (string)

> > > value -> (structure)

> > > > The inventory result item.

> > > > TypeName -> (string) [required]

> > > > > The name of the inventory result item type.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `100`
> > > > > * pattern: `^(AWS|Custom):.*$`

> > > > SchemaVersion -> (string) [required]

> > > > > The schema version for the inventory result item/

> > > > > Constraints:

> > > > > * pattern: `^([0-9]{1,6})(\.[0-9]{1,6})$`

> > > > CaptureTime -> (string)

> > > > > The time inventory item data was captured.

> > > > > Constraints:

> > > > > * pattern: `^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$`

> > > > ContentHash -> (string)

> > > > > MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn’t update the inventory item type contents if the MD5 hash hasn’t changed since last update.

> > > > > Constraints:

> > > > > * max: `256`

> > > > Content -> (list) [required]

> > > > > Contains all the inventory data of the item type. Results include attribute names and values.

> > > > > Constraints:

> > > > > * min: `0`
> > > > > * max: `10000`

> > > > > (map)

> > > > > > Constraints:

> > > > > > * min: `0`
> > > > > > * max: `50`

> > > > > > key -> (string)

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `64`

> > > > > > value -> (string)

> > > > > > > Constraints:

> > > > > > > * min: `0`
> > > > > > > * max: `4096`

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.