CmdID / aws / aws ssm

aws ssm 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. AWS CLI reference

2 examples 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To view your inventory schema

The following get-inventory-schema example returns a list of inventory type names for the account.

aws ssm get-inventory-schemaIdentify

Its output, shortened

{
    "Schemas": [
        {
            "TypeName": "AWS:AWSComponent",
            "Version": "1.0",
            "Attributes": [
                {
                    "Name": "Name",
                    "DataType": "STRING"
                },
                {
                    "Name": "ApplicationType",
                    "DataType": "STRING"
                },
                {
                    "Name": "Publisher",
                    "DataType": "STRING"
                },
                {
                    "Name": "Version",
                    "DataType": "STRING"
                },
                {
                    "Name": "InstalledTime",
                    "DataType": "STRING"
                },
                {
                    "Name": "Architecture",
                    "DataType": "STRING"
                },
… 9 more lines

For more information, see Metadata collected by Inventory in the AWS Systems Manager User Guide.

Example 2: To view the inventory schema for a specific inventory type

The following get-inventory-schema example returns the inventory schema for the AWS:AWSComponent inventory type.

aws ssm get-inventory-schema --type-name "AWS:AWSComponent"Identify

--type-nameThe type of inventory item to return.

Its output, shortened

{
    "Schemas": [
        {
            "TypeName": "AWS:AWSComponent",
            "Version": "1.0",
            "Attributes": [
                {
                    "Name": "Name",
                    "DataType": "STRING"
                },
                {
                    "Name": "ApplicationType",
                    "DataType": "STRING"
                },
                {
                    "Name": "Publisher",
                    "DataType": "STRING"
                },
                {
                    "Name": "Version",
                    "DataType": "STRING"
                },
                {
                    "Name": "InstalledTime",
                    "DataType": "STRING"
                },
                {
                    "Name": "Architecture",
                    "DataType": "STRING"
                },
… 8 more lines

For more information, see Metadata collected by Inventory in the AWS Systems Manager User Guide.

Options

5 in the AWS CLI reference

--aggregatorReturns inventory schemas that support aggregation.

--max-resultsThe maximum number of items to return for this call.

--next-tokenThe token for the next set of items to return.

--sub-typeReturns the sub-type schema for a specified inventory type.

--type-nameThe type of inventory item to return.