« blib/lib/Paws/WorkDocs/DeleteComment.pm
↑ Summary
blib/lib/Paws/WorkDocs/DeleteCustomMetadataResponse.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::DeleteCustomMetadata; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has DeleteAll => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'deleteAll'); | ||
| 6 | has Keys => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'keys'); | ||
| 7 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ResourceId', required => 1); | ||
| 8 | has VersionId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'versionId'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteCustomMetadata'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/resources/{ResourceId}/customMetadata'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'DELETE'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::DeleteCustomMetadataResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::WorkDocs::DeleteCustomMetadata - Arguments for method DeleteCustomMetadata on L<Paws::WorkDocs> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DeleteCustomMetadata on the | ||
| 27 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 28 | as arguments to method DeleteCustomMetadata. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteCustomMetadata. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $workdocs = Paws->service('WorkDocs'); | ||
| 35 | my $DeleteCustomMetadataResponse = $workdocs->DeleteCustomMetadata( | ||
| 36 | ResourceId => 'MyResourceIdType', | ||
| 37 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 38 | DeleteAll => 1, # OPTIONAL | ||
| 39 | Keys => [ | ||
| 40 | 'MyCustomMetadataKeyType', ... # min: 1, max: 56 | ||
| 41 | ], # OPTIONAL | ||
| 42 | VersionId => 'MyDocumentVersionIdType', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/DeleteCustomMetadata> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AuthenticationToken => Str | ||
| 52 | |||
| 53 | Amazon WorkDocs authentication token. Not required when using AWS | ||
| 54 | administrator credentials to access the API. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 DeleteAll => Bool | ||
| 59 | |||
| 60 | Flag to indicate removal of all custom metadata properties from the | ||
| 61 | specified resource. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 Keys => ArrayRef[Str|Undef] | ||
| 66 | |||
| 67 | List of properties to remove. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> ResourceId => Str | ||
| 72 | |||
| 73 | The ID of the resource, either a document or folder. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 VersionId => Str | ||
| 78 | |||
| 79 | The ID of the version, if the custom metadata is being deleted from a | ||
| 80 | document version. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, documenting arguments for method DeleteCustomMetadata in L<Paws::WorkDocs> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |