/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSM::DeleteInventory

NAME

Paws::SSM::DeleteInventory - Arguments for method DeleteInventory on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method DeleteInventory on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method DeleteInventory.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteInventory.

SYNOPSIS

my $ssm = Paws->service('SSM');
my $DeleteInventoryResult = $ssm->DeleteInventory(
  TypeName           => 'MyInventoryItemTypeName',
  ClientToken        => 'MyUUID',                    # OPTIONAL
  DryRun             => 1,                           # OPTIONAL
  SchemaDeleteOption => 'DisableSchema',             # OPTIONAL
);

# Results:
my $DeletionId      = $DeleteInventoryResult->DeletionId;
my $DeletionSummary = $DeleteInventoryResult->DeletionSummary;
my $TypeName        = $DeleteInventoryResult->TypeName;

# Returns a L<Paws::SSM::DeleteInventoryResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/DeleteInventory

ATTRIBUTES

ClientToken => Str

User-provided idempotency token.

DryRun => Bool

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.

SchemaDeleteOption => Str

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.

Valid values are: "DisableSchema", "DeleteSchema"

REQUIRED TypeName => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteInventory in Paws::SSM

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues