Skip to content

aws.ssm.get_inventory

Example SQL Queries

SELECT * FROM
aws.ssm.get_inventory;

Description

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

Table Definition

Column NameColumn Data Type
aggregators Input Column

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.

STRUCT(
"expression" VARCHAR,
"groups" STRUCT(
"name" VARCHAR,
"filters" STRUCT(
"key" VARCHAR,
"values" VARCHAR[],
"type" VARCHAR
)[]
)[]
)[]
Show child fields
aggregators[]
Show child fields
aggregators[].expression

The inventory type and attribute name for aggregation.

aggregators[].groups[]
Show child fields
aggregators[].groups[].filters[]
Show child fields
aggregators[].groups[].filters[].key

The name of the filter key.

aggregators[].groups[].filters[].type

The type of filter.

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

aggregators[].groups[].filters[].values[]
aggregators[].groups[].name

The name of the group.

filters Input Column

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

STRUCT(
"key" VARCHAR,
"values" VARCHAR[],
"type" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].key

The name of the filter key.

filters[].type

The type of filter.

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

filters[].values[]
result_attributes Input Column

The list of inventory item types to return.

STRUCT(
"type_name" VARCHAR
)[]
Show child fields
result_attributes[]
Show child fields
result_attributes[].type_name

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

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
data

The data section in the inventory result entity JSON.

MAP(VARCHAR, STRUCT(
"type_name" VARCHAR,
"schema_version" VARCHAR,
"capture_time" VARCHAR,
"content_hash" VARCHAR,
"content" MAP(VARCHAR, VARCHAR)[]
))
id

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.

VARCHAR