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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

User-provided idempotency token.

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

Returns:

  • (String)


3316
3317
3318
3319
3320
3321
3322
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3316

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

#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)


3316
3317
3318
3319
3320
3321
3322
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3316

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

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

Returns:

  • (String)


3316
3317
3318
3319
3320
3321
3322
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3316

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

#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)


3316
3317
3318
3319
3320
3321
3322
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3316

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