« blib/lib/Paws/Kendra/BatchGetDocumentStatusResponseError.pm
↑ Summary
blib/lib/Paws/Kendra/BatchPutDocumentResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::BatchPutDocument; | ||
| 3 | use Moose; | ||
| 4 | has Documents => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::Document]', required => 1); | ||
| 5 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchPutDocument'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::BatchPutDocumentResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Kendra::BatchPutDocument - Arguments for method BatchPutDocument on L<Paws::Kendra> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method BatchPutDocument on the | ||
| 24 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 25 | as arguments to method BatchPutDocument. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchPutDocument. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kendra = Paws->service('Kendra'); | ||
| 32 | my $BatchPutDocumentResponse = $kendra->BatchPutDocument( | ||
| 33 | Documents => [ | ||
| 34 | { | ||
| 35 | Id => 'MyDocumentId', # min: 1, max: 2048 | ||
| 36 | AccessControlList => [ | ||
| 37 | { | ||
| 38 | Access => 'ALLOW', # values: ALLOW, DENY | ||
| 39 | Name => 'MyPrincipalName', # min: 1, max: 200 | ||
| 40 | Type => 'USER', # values: USER, GROUP | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | Attributes => [ | ||
| 46 | { | ||
| 47 | Key => 'MyDocumentAttributeKey', # min: 1, max: 200 | ||
| 48 | Value => { | ||
| 49 | DateValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 50 | LongValue => 1, # OPTIONAL | ||
| 51 | StringListValue => [ | ||
| 52 | 'MyString', ... # min: 1, max: 2048 | ||
| 53 | ], # OPTIONAL | ||
| 54 | StringValue => 'MyDocumentAttributeStringValue' | ||
| 55 | , # min: 1, max: 2048; OPTIONAL | ||
| 56 | }, | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | Blob => 'BlobBlob', # OPTIONAL | ||
| 62 | ContentType => | ||
| 63 | 'PDF', # values: PDF, HTML, MS_WORD, PLAIN_TEXT, PPT; OPTIONAL | ||
| 64 | S3Path => { | ||
| 65 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 66 | Key => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 67 | |||
| 68 | }, # OPTIONAL | ||
| 69 | Title => 'MyTitle', # OPTIONAL | ||
| 70 | }, | ||
| 71 | ... | ||
| 72 | ], | ||
| 73 | IndexId => 'MyIndexId', | ||
| 74 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 75 | ); | ||
| 76 | |||
| 77 | # Results: | ||
| 78 | my $FailedDocuments = $BatchPutDocumentResponse->FailedDocuments; | ||
| 79 | |||
| 80 | # Returns a L<Paws::Kendra::BatchPutDocumentResponse> object. | ||
| 81 | |||
| 82 | 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. | ||
| 83 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/BatchPutDocument> | ||
| 84 | |||
| 85 | =head1 ATTRIBUTES | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> Documents => ArrayRef[L<Paws::Kendra::Document>] | ||
| 89 | |||
| 90 | One or more documents to add to the index. | ||
| 91 | |||
| 92 | Documents can include custom attributes. For example, 'DataSourceId' | ||
| 93 | and 'DataSourceSyncJobId' are custom attributes that provide | ||
| 94 | information on the synchronization of documents running on a data | ||
| 95 | source. Note, 'DataSourceSyncJobId' could be an optional custom | ||
| 96 | attribute as Amazon Kendra will use the ID of a running sync job. | ||
| 97 | |||
| 98 | Documents have the following file size limits. | ||
| 99 | |||
| 100 | =over | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | 5 MB total size for inline documents | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | 50 MB total size for files from an S3 bucket | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | 5 MB extracted text for any file | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | For more information about file size and transaction per second quotas, | ||
| 117 | see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> IndexId => Str | ||
| 122 | |||
| 123 | The identifier of the index to add the documents to. You need to create | ||
| 124 | the index first using the C<CreateIndex> operation. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 RoleArn => Str | ||
| 129 | |||
| 130 | The Amazon Resource Name (ARN) of a role that is allowed to run the | ||
| 131 | C<BatchPutDocument> operation. For more information, see IAM Roles for | ||
| 132 | Amazon Kendra | ||
| 133 | (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head1 SEE ALSO | ||
| 139 | |||
| 140 | This class forms part of L<Paws>, documenting arguments for method BatchPutDocument in L<Paws::Kendra> | ||
| 141 | |||
| 142 | =head1 BUGS and CONTRIBUTIONS | ||
| 143 | |||
| 144 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 145 | |||
| 146 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 147 | |||
| 148 | =cut | ||
| 149 |