/ - Amazon Simple Systems Manager (SSM)

Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "InstanceId": "string", "Items": [] }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

InstanceId

string

required

An managed node ID where you want to add or update inventory items.

Match pattern:

(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Items

array[object (InventoryItem) {6}]

required

The inventory items that you want to add or update on managed nodes.

>= 1 items<= 30 items

TypeName

string

required

The name of the inventory type. Default inventory item type names start with AWS. 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.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

SchemaVersion

string

required

The schema version for the inventory item.

Match pattern:

^([0-9]{1,6})(\.[0-9]{1,6})$

CaptureTime

string

required

The time the inventory information was collected.

Match pattern:

^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$

ContentHash

string

optional

MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API doesn't update the inventory item type contents if the MD5 hash hasn't changed since last update.

<= 256 characters

Content

array[object (InventoryItemEntry)]

optional

The inventory data of the inventory type.

>= 0 items<= 10000 items

Context

object

optional

A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type.

Examples

Responses

🟢200Success

application/json

Body

Message

string

optional

Information about the request.

🟠480InternalServerError

🟠481InvalidInstanceId

🟠482InvalidTypeNameException

🟠483InvalidItemContentException

🟠484TotalSizeLimitExceededException

🟠485ItemSizeLimitExceededException

🟠486ItemContentMismatchException

🟠487CustomSchemaCountLimitExceededException

🟠488UnsupportedInventorySchemaVersionException

🟠489UnsupportedInventoryItemContextException

🟠490InvalidInventoryItemContextException

🟠491SubTypeCountLimitExceededException