View a markdown version of this page

Use GetInventorySchema with a CLI - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Use GetInventorySchema with a CLI

The following code examples show how to use GetInventorySchema.

CLI
Amazon CLI

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

Output:

{
    "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"
                },
                {
                    "Name": "URL",
                    "DataType": "STRING"
                }
            ]
    }
    ],
    "NextToken": "--token string truncated--"
}

For more information, see Metadata collected by Inventory in the Amazon 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"

Output:

{
    "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"
                },
                {
                    "Name": "URL",
                    "DataType": "STRING"
                }
            ]
        }
    ]
}

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

PowerShell
Tools for PowerShell V4

Example 1: This example returns a list of inventory type names for the account.

Get-SSMInventorySchema

  • For API details, see GetInventorySchema in Amazon Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: This example returns a list of inventory type names for the account.

Get-SSMInventorySchema

  • For API details, see GetInventorySchema in Amazon Tools for PowerShell Cmdlet Reference (V5).

For a complete list of Amazon SDK developer guides and code examples, see Using this service with an Amazon SDK. This topic also includes information about getting started and details about previous SDK versions.