Use PutInventory with an AWS SDK or CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use PutInventory with an AWS SDK or CLI

The following code examples show how to use PutInventory.

CLI
AWS CLI

To assign customer metadata to an instance

This example assigns rack location information to an instance. There is no output if the command succeeds.

Command (Linux):

<userinput>aws ssm put-inventory --instance-id <replaceable>"i-016648b75dd622dab"</replaceable> --items '<replaceable>[{"TypeName": "Custom:RackInfo","SchemaVersion": "1.0","CaptureTime": "2019-01-22T10:01:01Z","Content":[{"RackLocation": "Bay B/Row C/Rack D/Shelf E"}]}]</replaceable>'</userinput>

Command (Windows):

<userinput>aws ssm put-inventory --instance-id <replaceable>"i-016648b75dd622dab"</replaceable> --items <replaceable>"TypeName=Custom:RackInfo,SchemaVersion=1.0,CaptureTime=2019-01-22T10:01:01Z,Content=[{RackLocation='Bay B/Row C/Rack D/Shelf F'}]"</replaceable></userinput>
  • For API details, see PutInventory in AWS CLI Command Reference.

PowerShell
Tools for PowerShell

Example 1: This example assigns rack location information to an instance. There is no output if the command succeeds.

$data = New-Object "System.Collections.Generic.Dictionary[System.String,System.String]" $data.Add("RackLocation", "Bay B/Row C/Rack D/Shelf F") $items = New-Object "System.Collections.Generic.List[System.Collections.Generic.Dictionary[System.String, System.String]]" $items.Add($data) $customInventoryItem = New-Object Amazon.SimpleSystemsManagement.Model.InventoryItem $customInventoryItem.CaptureTime = "2016-08-22T10:01:01Z" $customInventoryItem.Content = $items $customInventoryItem.TypeName = "Custom:TestRackInfo2" $customInventoryItem.SchemaVersion = "1.0" $inventoryItems = @($customInventoryItem) Write-SSMInventory -InstanceId "i-0cb2b964d3e14fd9f" -Item $inventoryItems
  • For API details, see PutInventory in AWS Tools for PowerShell Cmdlet Reference.