/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TypeName": "string",
    "SchemaDeleteOption": "DisableSchema",
    "DryRun": true,
    "ClientToken": "string"
}'

Response Example

200 - Example 1

{
    "DeletionId": "string",
    "TypeName": "string",
    "DeletionSummary": {
        "TotalCount": 0,
        "RemainingCount": 0,
        "SummaryItems": []
    }
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

TypeName

string

required

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

SchemaDeleteOption

enum<string>

optional

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Allowed values:

DisableSchemaDeleteSchema

DryRun

boolean

optional

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

ClientToken

string

optional

User-provided idempotency token.

Match pattern:

[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Examples

Responses

🟢200Success

application/json

Body

DeletionId

string

optional

Every DeleteInventory operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations.

Match pattern:

[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

TypeName

string

optional

The name of the inventory data type specified in the request.

>= 1 characters<= 100 characters

Match pattern:

^(AWS|Custom):.*$

DeletionSummary

object

optional

A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.

TotalCount

integer

optional

The total number of items to delete. This count doesn't change during the delete operation.

RemainingCount

integer

optional

Remaining number of items to delete.

SummaryItems

array[object (InventoryDeletionSummaryItem) {3}]

optional

A list of counts and versions for deleted items.

🟠480InternalServerError

🟠481InvalidTypeNameException

🟠482InvalidOptionException

🟠483InvalidDeleteInventoryParametersException

🟠484InvalidInventoryRequestException