« blib/lib/Paws/WorkDocs/GroupMetadata.pm
↑ Summary
blib/lib/Paws/WorkDocs/InitiateDocumentVersionUploadResponse.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::InitiateDocumentVersionUpload; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has ContentCreatedTimestamp => (is => 'ro', isa => 'Str'); | ||
| 6 | has ContentModifiedTimestamp => (is => 'ro', isa => 'Str'); | ||
| 7 | has ContentType => (is => 'ro', isa => 'Str'); | ||
| 8 | has DocumentSizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 9 | has Id => (is => 'ro', isa => 'Str'); | ||
| 10 | has Name => (is => 'ro', isa => 'Str'); | ||
| 11 | has ParentFolderId => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'InitiateDocumentVersionUpload'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::InitiateDocumentVersionUploadResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::WorkDocs::InitiateDocumentVersionUpload - Arguments for method InitiateDocumentVersionUpload on L<Paws::WorkDocs> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method InitiateDocumentVersionUpload on the | ||
| 30 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 31 | as arguments to method InitiateDocumentVersionUpload. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InitiateDocumentVersionUpload. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $workdocs = Paws->service('WorkDocs'); | ||
| 38 | my $InitiateDocumentVersionUploadResponse = | ||
| 39 | $workdocs->InitiateDocumentVersionUpload( | ||
| 40 | ParentFolderId => 'MyResourceIdType', | ||
| 41 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 42 | ContentCreatedTimestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | ContentModifiedTimestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | ContentType => 'MyDocumentContentType', # OPTIONAL | ||
| 45 | DocumentSizeInBytes => 1, # OPTIONAL | ||
| 46 | Id => 'MyResourceIdType', # OPTIONAL | ||
| 47 | Name => 'MyResourceNameType', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Metadata = $InitiateDocumentVersionUploadResponse->Metadata; | ||
| 52 | my $UploadMetadata = $InitiateDocumentVersionUploadResponse->UploadMetadata; | ||
| 53 | |||
| 54 | # Returns a L<Paws::WorkDocs::InitiateDocumentVersionUploadResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/InitiateDocumentVersionUpload> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 AuthenticationToken => Str | ||
| 63 | |||
| 64 | Amazon WorkDocs authentication token. Not required when using AWS | ||
| 65 | administrator credentials to access the API. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 ContentCreatedTimestamp => Str | ||
| 70 | |||
| 71 | The timestamp when the content of the document was originally created. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 ContentModifiedTimestamp => Str | ||
| 76 | |||
| 77 | The timestamp when the content of the document was modified. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 ContentType => Str | ||
| 82 | |||
| 83 | The content type of the document. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 DocumentSizeInBytes => Int | ||
| 88 | |||
| 89 | The size of the document, in bytes. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Id => Str | ||
| 94 | |||
| 95 | The ID of the document. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 Name => Str | ||
| 100 | |||
| 101 | The name of the document. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> ParentFolderId => Str | ||
| 106 | |||
| 107 | The ID of the parent folder. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method InitiateDocumentVersionUpload in L<Paws::WorkDocs> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |