Skip to content

DeleteInventoryRequest

Source code in docs_src/capo_ssm/types/delete_inventory_request.py
class DeleteInventoryRequest(TypedDict, closed=True):
    type_name: "capo_ssm.types.inventory_item_type_name.InventoryItemTypeName"
    """<p>The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself. </p>"""
    schema_delete_option: NotRequired[
        "capo_ssm.types.inventory_schema_delete_option.InventorySchemaDeleteOption"
    ]
    """<p>Use the <code>SchemaDeleteOption</code> 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:</p> <p>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 <code>PutInventory</code> operation for a version greater than the disabled version.</p> <p>DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.</p>"""
    dry_run: "capo_ssm.types.dry_run.DryRun"
    """<p>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 <code>DryRun</code> option.</p>"""
    client_token: NotRequired["capo_ssm.types.uuid.UUID"]
    """<p>User-provided idempotency token.</p>"""

client_token instance-attribute

client_token: NotRequired[UUID]

User-provided idempotency token.

dry_run instance-attribute

dry_run: DryRun

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.

schema_delete_option instance-attribute

schema_delete_option: NotRequired[InventorySchemaDeleteOption]

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.

type_name instance-attribute

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