aws ssm delete-inventory

Delete a custom inventory type or the data associated with a custom Inventory type. AWS CLI reference

2 examples 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To delete a custom inventory type

The following delete-inventory example deletes a custom inventory schema.

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DeleteSchema"Identify

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

--schema-delete-optionUse the SchemaDeleteOption to delete a custom inventory type (schema).

Its output

{
    "DeletionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "TypeName": "Custom:RackInfo",
    "DeletionSummary": {
        "TotalCount": 1,
        "RemainingCount": 1,
        "SummaryItems": [
            {
                "Version": "1.0",
                "Count": 1,
                "RemainingCount": 1
            }
        ]
    }
}

For more information, see Working with custom inventory in the AWS Systems Manager User Guide.

Example 2: To disable a custom inventory type

The following delete-inventory example disables a custom inventory schema.

aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DisableSchema"Identify

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

--schema-delete-optionUse the SchemaDeleteOption to delete a custom inventory type (schema).

Its output

{
    "DeletionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "TypeName": "Custom:RackInformation",
    "DeletionSummary": {
        "TotalCount": 0,
        "RemainingCount": 0,
        "SummaryItems": []
    }
}

For more information, see Working with custom inventory in the AWS Systems Manager User Guide.

Options

4 in the AWS CLI reference

--client-tokenUser-provided idempotency token.

--dry-runUse this option to view a summary of the deletion request without deleting any data or the data type.

--schema-delete-optionUse the SchemaDeleteOption to delete a custom inventory type (schema).

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