| 1 | |||
| 2 | package Paws::SSM::DeleteInventory; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 6 | has SchemaDeleteOption => (is => 'ro', isa => 'Str'); | ||
| 7 | has TypeName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteInventory'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::DeleteInventoryResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::SSM::DeleteInventory - Arguments for method DeleteInventory on L<Paws::SSM> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DeleteInventory on the | ||
| 25 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 26 | as arguments to method DeleteInventory. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteInventory. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ssm = Paws->service('SSM'); | ||
| 33 | my $DeleteInventoryResult = $ssm->DeleteInventory( | ||
| 34 | TypeName => 'MyInventoryItemTypeName', | ||
| 35 | ClientToken => 'MyUUID', # OPTIONAL | ||
| 36 | DryRun => 1, # OPTIONAL | ||
| 37 | SchemaDeleteOption => 'DisableSchema', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $DeletionId = $DeleteInventoryResult->DeletionId; | ||
| 42 | my $DeletionSummary = $DeleteInventoryResult->DeletionSummary; | ||
| 43 | my $TypeName = $DeleteInventoryResult->TypeName; | ||
| 44 | |||
| 45 | # Returns a L<Paws::SSM::DeleteInventoryResult> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/DeleteInventory> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ClientToken => Str | ||
| 54 | |||
| 55 | User-provided idempotency token. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 DryRun => Bool | ||
| 60 | |||
| 61 | Use this option to view a summary of the deletion request without | ||
| 62 | deleting any data or the data type. This option is useful when you only | ||
| 63 | want to understand what will be deleted. Once you validate that the | ||
| 64 | data to be deleted is what you intend to delete, you can run the same | ||
| 65 | command without specifying the C<DryRun> option. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 SchemaDeleteOption => Str | ||
| 70 | |||
| 71 | Use the C<SchemaDeleteOption> to delete a custom inventory type | ||
| 72 | (schema). If you don't choose this option, the system only deletes | ||
| 73 | existing inventory data associated with the custom inventory type. | ||
| 74 | Choose one of the following options: | ||
| 75 | |||
| 76 | DisableSchema: If you choose this option, the system ignores all | ||
| 77 | inventory data for the specified version, and any earlier versions. To | ||
| 78 | enable this schema again, you must call the C<PutInventory> action for | ||
| 79 | a version greater than the disabled version. | ||
| 80 | |||
| 81 | DeleteSchema: This option deletes the specified custom type from the | ||
| 82 | Inventory service. You can recreate the schema later, if you want. | ||
| 83 | |||
| 84 | Valid values are: C<"DisableSchema">, C<"DeleteSchema"> | ||
| 85 | |||
| 86 | =head2 B<REQUIRED> TypeName => Str | ||
| 87 | |||
| 88 | The name of the custom inventory type for which you want to delete | ||
| 89 | either all previously collected data or the inventory type itself. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method DeleteInventory in L<Paws::SSM> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |