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