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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DeleteInventoryRequest data as a hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

User-provided idempotency token.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/aws-sdk-ssm/types.rb', line 2903

class DeleteInventoryRequest < Struct.new(
  :type_name,
  :schema_delete_option,
  :dry_run,
  :client_token)
  include Aws::Structure
end

#dry_run ⇒ Boolean

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) 


2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/aws-sdk-ssm/types.rb', line 2903

class DeleteInventoryRequest < Struct.new(
  :type_name,
  :schema_delete_option,
  :dry_run,
  :client_token)
  include Aws::Structure
end

#schema_delete_option ⇒ String

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 disbled version.

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

Returns:

  • (String) 


2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/aws-sdk-ssm/types.rb', line 2903

class DeleteInventoryRequest < Struct.new(
  :type_name,
  :schema_delete_option,
  :dry_run,
  :client_token)
  include Aws::Structure
end

#type_name ⇒ String

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) 


2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/aws-sdk-ssm/types.rb', line 2903

class DeleteInventoryRequest < Struct.new(
  :type_name,
  :schema_delete_option,
  :dry_run,
  :client_token)
  include Aws::Structure
end