inventory_schemas

Creates, updates, deletes, gets or lists an inventory_schemas resource.

Overview

Name	inventory_schemas
Type	Resource
Id	aws.ssm.inventory_schemas

Fields

The following fields are returned by SELECT queries:

get_inventory_schema

Name	Datatype	Description
attributes	array	The schema attributes for inventory. This contains data type and attribute name.
display_name	string	The alias name of the inventory type. The alias name is used for display purposes.
type_name	string	The name of the inventory type. Default inventory item type names start with Amazon Web Services. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate. (pattern: <code>^(AWS|Custom):.*$</code>)
version	string	The schema version for the inventory item. (pattern: <code>^([0-9]{1,6})(.[0-9]{1,6})$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_inventory_schema	select	region		Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_inventory_schema

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

SELECT
attributes,
display_name,
type_name,
version
FROM aws.ssm.inventory_schemas
WHERE region = '{{ region }}' -- required
;