« blib/lib/Paws/WorkDocs/Subscription.pm
↑ Summary
blib/lib/Paws/WorkDocs/UpdateDocumentVersion.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::UpdateDocument; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has DocumentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DocumentId', required => 1); | ||
| 6 | has Name => (is => 'ro', isa => 'Str'); | ||
| 7 | has ParentFolderId => (is => 'ro', isa => 'Str'); | ||
| 8 | has ResourceState => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDocument'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents/{DocumentId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::WorkDocs::UpdateDocument - Arguments for method UpdateDocument on L<Paws::WorkDocs> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateDocument on the | ||
| 27 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateDocument. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDocument. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $workdocs = Paws->service('WorkDocs'); | ||
| 35 | $workdocs->UpdateDocument( | ||
| 36 | DocumentId => 'MyResourceIdType', | ||
| 37 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 38 | Name => 'MyResourceNameType', # OPTIONAL | ||
| 39 | ParentFolderId => 'MyResourceIdType', # OPTIONAL | ||
| 40 | ResourceState => 'ACTIVE', # 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/UpdateDocument> | ||
| 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 B<REQUIRED> DocumentId => Str | ||
| 57 | |||
| 58 | The ID of the document. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 Name => Str | ||
| 63 | |||
| 64 | The name of the document. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 ParentFolderId => Str | ||
| 69 | |||
| 70 | The ID of the parent folder. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 ResourceState => Str | ||
| 75 | |||
| 76 | The resource state of the document. Only ACTIVE and RECYCLED are | ||
| 77 | supported. | ||
| 78 | |||
| 79 | Valid values are: C<"ACTIVE">, C<"RESTORING">, C<"RECYCLING">, C<"RECYCLED"> | ||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method UpdateDocument in L<Paws::WorkDocs> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |