You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::DeleteInventoryRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteInventoryRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  type_name: "InventoryItemTypeName", # required
  schema_delete_option: "DisableSchema", # accepts DisableSchema, DeleteSchema
  dry_run: false,
  client_token: "ClientToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

User-provided idempotency token.

Returns:

  • (String)

    User-provided idempotency token.

#dry_runBoolean

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.

Returns:

  • (Boolean)

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

#schema_delete_optionString

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 action 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.

Possible values:

  • DisableSchema
  • DeleteSchema

Returns:

  • (String)

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

#type_nameString

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

Returns:

  • (String)

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