Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetInventorySchema

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

Request Syntax


{
   "Aggregator": boolean,
   "MaxResults": number,
   "NextToken": "string",
   "SubType": boolean,
   "TypeName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Aggregator

Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

Type: Boolean

Required: No

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 50. Maximum value of 200.

Required: No

NextToken

The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No

SubType

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

Type: Boolean

Required: No

TypeName

The type of inventory item to return.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Schemas": [ 
      { 
         "Attributes": [ 
            { 
               "DataType": "string",
               "Name": "string"
            }
         ],
         "DisplayName": "string",
         "TypeName": "string",
         "Version": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Schemas

Inventory schemas returned by the request.

Type: Array of InventoryItemSchema objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidNextToken

The specified token isn't valid.

HTTP Status Code: 400

InvalidTypeNameException

The parameter type name isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetInventorySchema.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetInventorySchema
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240330T150040Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240330/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2

Sample Response


{
   "Schemas":[
      {
         "Attributes":[
            {
               "DataType":"STRING",
               "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"
            }
         ],
         "TypeName":"AWS:AWSComponent",
         "Version":"1.0"
      },--truncated--
      {
         "Attributes":[
            {
               "DataType":"STRING",
               "Name":"Name"
            },
            {
               "DataType":"STRING",
               "Name":"DisplayName"
            },
            {
               "DataType":"STRING",
               "Name":"ServiceType"
            },
            {
               "DataType":"STRING",
               "Name":"Status"
            },
            {
               "DataType":"STRING",
               "Name":"DependentServices"
            },
            {
               "DataType":"STRING",
               "Name":"ServicesDependedOn"
            },
            {
               "DataType":"STRING",
               "Name":"StartType"
            }
         ],
         "TypeName":"AWS:Service",
         "Version":"1.0"
      }--truncated--
   ]
}