« blib/lib/Paws/Kafka/__mapOf__string.pm
↑ Summary
blib/lib/Paws/Kendra/AccessControlListConfiguration.pm »
| 1 | package Paws::Kendra; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'kendra' } | ||
| 4 | sub signing_name { 'kendra' } | ||
| 5 | sub version { '2019-02-03' } | ||
| 6 | sub target_prefix { 'AWSKendraFrontendService' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub BatchDeleteDocument { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::Kendra::BatchDeleteDocument', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub BatchGetDocumentStatus { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::Kendra::BatchGetDocumentStatus', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub BatchPutDocument { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::Kendra::BatchPutDocument', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub ClearQuerySuggestions { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::Kendra::ClearQuerySuggestions', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | sub CreateDataSource { | ||
| 39 | my $self = shift; | ||
| 40 | my $call_object = $self->new_with_coercions('Paws::Kendra::CreateDataSource', @_); | ||
| 41 | return $self->caller->do_call($self, $call_object); | ||
| 42 | } | ||
| 43 | sub CreateFaq { | ||
| 44 | my $self = shift; | ||
| 45 | my $call_object = $self->new_with_coercions('Paws::Kendra::CreateFaq', @_); | ||
| 46 | return $self->caller->do_call($self, $call_object); | ||
| 47 | } | ||
| 48 | sub CreateIndex { | ||
| 49 | my $self = shift; | ||
| 50 | my $call_object = $self->new_with_coercions('Paws::Kendra::CreateIndex', @_); | ||
| 51 | return $self->caller->do_call($self, $call_object); | ||
| 52 | } | ||
| 53 | sub CreateQuerySuggestionsBlockList { | ||
| 54 | my $self = shift; | ||
| 55 | my $call_object = $self->new_with_coercions('Paws::Kendra::CreateQuerySuggestionsBlockList', @_); | ||
| 56 | return $self->caller->do_call($self, $call_object); | ||
| 57 | } | ||
| 58 | sub CreateThesaurus { | ||
| 59 | my $self = shift; | ||
| 60 | my $call_object = $self->new_with_coercions('Paws::Kendra::CreateThesaurus', @_); | ||
| 61 | return $self->caller->do_call($self, $call_object); | ||
| 62 | } | ||
| 63 | sub DeleteDataSource { | ||
| 64 | my $self = shift; | ||
| 65 | my $call_object = $self->new_with_coercions('Paws::Kendra::DeleteDataSource', @_); | ||
| 66 | return $self->caller->do_call($self, $call_object); | ||
| 67 | } | ||
| 68 | sub DeleteFaq { | ||
| 69 | my $self = shift; | ||
| 70 | my $call_object = $self->new_with_coercions('Paws::Kendra::DeleteFaq', @_); | ||
| 71 | return $self->caller->do_call($self, $call_object); | ||
| 72 | } | ||
| 73 | sub DeleteIndex { | ||
| 74 | my $self = shift; | ||
| 75 | my $call_object = $self->new_with_coercions('Paws::Kendra::DeleteIndex', @_); | ||
| 76 | return $self->caller->do_call($self, $call_object); | ||
| 77 | } | ||
| 78 | sub DeleteQuerySuggestionsBlockList { | ||
| 79 | my $self = shift; | ||
| 80 | my $call_object = $self->new_with_coercions('Paws::Kendra::DeleteQuerySuggestionsBlockList', @_); | ||
| 81 | return $self->caller->do_call($self, $call_object); | ||
| 82 | } | ||
| 83 | sub DeleteThesaurus { | ||
| 84 | my $self = shift; | ||
| 85 | my $call_object = $self->new_with_coercions('Paws::Kendra::DeleteThesaurus', @_); | ||
| 86 | return $self->caller->do_call($self, $call_object); | ||
| 87 | } | ||
| 88 | sub DescribeDataSource { | ||
| 89 | my $self = shift; | ||
| 90 | my $call_object = $self->new_with_coercions('Paws::Kendra::DescribeDataSource', @_); | ||
| 91 | return $self->caller->do_call($self, $call_object); | ||
| 92 | } | ||
| 93 | sub DescribeFaq { | ||
| 94 | my $self = shift; | ||
| 95 | my $call_object = $self->new_with_coercions('Paws::Kendra::DescribeFaq', @_); | ||
| 96 | return $self->caller->do_call($self, $call_object); | ||
| 97 | } | ||
| 98 | sub DescribeIndex { | ||
| 99 | my $self = shift; | ||
| 100 | my $call_object = $self->new_with_coercions('Paws::Kendra::DescribeIndex', @_); | ||
| 101 | return $self->caller->do_call($self, $call_object); | ||
| 102 | } | ||
| 103 | sub DescribeQuerySuggestionsBlockList { | ||
| 104 | my $self = shift; | ||
| 105 | my $call_object = $self->new_with_coercions('Paws::Kendra::DescribeQuerySuggestionsBlockList', @_); | ||
| 106 | return $self->caller->do_call($self, $call_object); | ||
| 107 | } | ||
| 108 | sub DescribeQuerySuggestionsConfig { | ||
| 109 | my $self = shift; | ||
| 110 | my $call_object = $self->new_with_coercions('Paws::Kendra::DescribeQuerySuggestionsConfig', @_); | ||
| 111 | return $self->caller->do_call($self, $call_object); | ||
| 112 | } | ||
| 113 | sub DescribeThesaurus { | ||
| 114 | my $self = shift; | ||
| 115 | my $call_object = $self->new_with_coercions('Paws::Kendra::DescribeThesaurus', @_); | ||
| 116 | return $self->caller->do_call($self, $call_object); | ||
| 117 | } | ||
| 118 | sub GetQuerySuggestions { | ||
| 119 | my $self = shift; | ||
| 120 | my $call_object = $self->new_with_coercions('Paws::Kendra::GetQuerySuggestions', @_); | ||
| 121 | return $self->caller->do_call($self, $call_object); | ||
| 122 | } | ||
| 123 | sub ListDataSources { | ||
| 124 | my $self = shift; | ||
| 125 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListDataSources', @_); | ||
| 126 | return $self->caller->do_call($self, $call_object); | ||
| 127 | } | ||
| 128 | sub ListDataSourceSyncJobs { | ||
| 129 | my $self = shift; | ||
| 130 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListDataSourceSyncJobs', @_); | ||
| 131 | return $self->caller->do_call($self, $call_object); | ||
| 132 | } | ||
| 133 | sub ListFaqs { | ||
| 134 | my $self = shift; | ||
| 135 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListFaqs', @_); | ||
| 136 | return $self->caller->do_call($self, $call_object); | ||
| 137 | } | ||
| 138 | sub ListIndices { | ||
| 139 | my $self = shift; | ||
| 140 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListIndices', @_); | ||
| 141 | return $self->caller->do_call($self, $call_object); | ||
| 142 | } | ||
| 143 | sub ListQuerySuggestionsBlockLists { | ||
| 144 | my $self = shift; | ||
| 145 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListQuerySuggestionsBlockLists', @_); | ||
| 146 | return $self->caller->do_call($self, $call_object); | ||
| 147 | } | ||
| 148 | sub ListTagsForResource { | ||
| 149 | my $self = shift; | ||
| 150 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListTagsForResource', @_); | ||
| 151 | return $self->caller->do_call($self, $call_object); | ||
| 152 | } | ||
| 153 | sub ListThesauri { | ||
| 154 | my $self = shift; | ||
| 155 | my $call_object = $self->new_with_coercions('Paws::Kendra::ListThesauri', @_); | ||
| 156 | return $self->caller->do_call($self, $call_object); | ||
| 157 | } | ||
| 158 | sub Query { | ||
| 159 | my $self = shift; | ||
| 160 | my $call_object = $self->new_with_coercions('Paws::Kendra::Query', @_); | ||
| 161 | return $self->caller->do_call($self, $call_object); | ||
| 162 | } | ||
| 163 | sub StartDataSourceSyncJob { | ||
| 164 | my $self = shift; | ||
| 165 | my $call_object = $self->new_with_coercions('Paws::Kendra::StartDataSourceSyncJob', @_); | ||
| 166 | return $self->caller->do_call($self, $call_object); | ||
| 167 | } | ||
| 168 | sub StopDataSourceSyncJob { | ||
| 169 | my $self = shift; | ||
| 170 | my $call_object = $self->new_with_coercions('Paws::Kendra::StopDataSourceSyncJob', @_); | ||
| 171 | return $self->caller->do_call($self, $call_object); | ||
| 172 | } | ||
| 173 | sub SubmitFeedback { | ||
| 174 | my $self = shift; | ||
| 175 | my $call_object = $self->new_with_coercions('Paws::Kendra::SubmitFeedback', @_); | ||
| 176 | return $self->caller->do_call($self, $call_object); | ||
| 177 | } | ||
| 178 | sub TagResource { | ||
| 179 | my $self = shift; | ||
| 180 | my $call_object = $self->new_with_coercions('Paws::Kendra::TagResource', @_); | ||
| 181 | return $self->caller->do_call($self, $call_object); | ||
| 182 | } | ||
| 183 | sub UntagResource { | ||
| 184 | my $self = shift; | ||
| 185 | my $call_object = $self->new_with_coercions('Paws::Kendra::UntagResource', @_); | ||
| 186 | return $self->caller->do_call($self, $call_object); | ||
| 187 | } | ||
| 188 | sub UpdateDataSource { | ||
| 189 | my $self = shift; | ||
| 190 | my $call_object = $self->new_with_coercions('Paws::Kendra::UpdateDataSource', @_); | ||
| 191 | return $self->caller->do_call($self, $call_object); | ||
| 192 | } | ||
| 193 | sub UpdateIndex { | ||
| 194 | my $self = shift; | ||
| 195 | my $call_object = $self->new_with_coercions('Paws::Kendra::UpdateIndex', @_); | ||
| 196 | return $self->caller->do_call($self, $call_object); | ||
| 197 | } | ||
| 198 | sub UpdateQuerySuggestionsBlockList { | ||
| 199 | my $self = shift; | ||
| 200 | my $call_object = $self->new_with_coercions('Paws::Kendra::UpdateQuerySuggestionsBlockList', @_); | ||
| 201 | return $self->caller->do_call($self, $call_object); | ||
| 202 | } | ||
| 203 | sub UpdateQuerySuggestionsConfig { | ||
| 204 | my $self = shift; | ||
| 205 | my $call_object = $self->new_with_coercions('Paws::Kendra::UpdateQuerySuggestionsConfig', @_); | ||
| 206 | return $self->caller->do_call($self, $call_object); | ||
| 207 | } | ||
| 208 | sub UpdateThesaurus { | ||
| 209 | my $self = shift; | ||
| 210 | my $call_object = $self->new_with_coercions('Paws::Kendra::UpdateThesaurus', @_); | ||
| 211 | return $self->caller->do_call($self, $call_object); | ||
| 212 | } | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | sub operations { qw/BatchDeleteDocument BatchGetDocumentStatus BatchPutDocument ClearQuerySuggestions CreateDataSource CreateFaq CreateIndex CreateQuerySuggestionsBlockList CreateThesaurus DeleteDataSource DeleteFaq DeleteIndex DeleteQuerySuggestionsBlockList DeleteThesaurus DescribeDataSource DescribeFaq DescribeIndex DescribeQuerySuggestionsBlockList DescribeQuerySuggestionsConfig DescribeThesaurus GetQuerySuggestions ListDataSources ListDataSourceSyncJobs ListFaqs ListIndices ListQuerySuggestionsBlockLists ListTagsForResource ListThesauri Query StartDataSourceSyncJob StopDataSourceSyncJob SubmitFeedback TagResource UntagResource UpdateDataSource UpdateIndex UpdateQuerySuggestionsBlockList UpdateQuerySuggestionsConfig UpdateThesaurus / } | ||
| 217 | |||
| 218 | 1; | ||
| 219 | |||
| 220 | ### main pod documentation begin ### | ||
| 221 | |||
| 222 | =head1 NAME | ||
| 223 | |||
| 224 | Paws::Kendra - Perl Interface to AWS AWSKendraFrontendService | ||
| 225 | |||
| 226 | =head1 SYNOPSIS | ||
| 227 | |||
| 228 | use Paws; | ||
| 229 | |||
| 230 | my $obj = Paws->service('Kendra'); | ||
| 231 | my $res = $obj->Method( | ||
| 232 | Arg1 => $val1, | ||
| 233 | Arg2 => [ 'V1', 'V2' ], | ||
| 234 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 235 | # of the arguments type | ||
| 236 | Arg3 => { Att1 => 'Val1' }, | ||
| 237 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 238 | # the constructor of the arguments type | ||
| 239 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 240 | ); | ||
| 241 | |||
| 242 | =head1 DESCRIPTION | ||
| 243 | |||
| 244 | Amazon Kendra is a service for indexing large document sets. | ||
| 245 | |||
| 246 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03> | ||
| 247 | |||
| 248 | |||
| 249 | =head1 METHODS | ||
| 250 | |||
| 251 | =head2 BatchDeleteDocument | ||
| 252 | |||
| 253 | =over | ||
| 254 | |||
| 255 | =item DocumentIdList => ArrayRef[Str|Undef] | ||
| 256 | |||
| 257 | =item IndexId => Str | ||
| 258 | |||
| 259 | =item [DataSourceSyncJobMetricTarget => L<Paws::Kendra::DataSourceSyncJobMetricTarget>] | ||
| 260 | |||
| 261 | |||
| 262 | =back | ||
| 263 | |||
| 264 | Each argument is described in detail in: L<Paws::Kendra::BatchDeleteDocument> | ||
| 265 | |||
| 266 | Returns: a L<Paws::Kendra::BatchDeleteDocumentResponse> instance | ||
| 267 | |||
| 268 | Removes one or more documents from an index. The documents must have | ||
| 269 | been added with the C<BatchPutDocument> operation. | ||
| 270 | |||
| 271 | The documents are deleted asynchronously. You can see the progress of | ||
| 272 | the deletion by using AWS CloudWatch. Any error messages related to the | ||
| 273 | processing of the batch are sent to you CloudWatch log. | ||
| 274 | |||
| 275 | |||
| 276 | =head2 BatchGetDocumentStatus | ||
| 277 | |||
| 278 | =over | ||
| 279 | |||
| 280 | =item DocumentInfoList => ArrayRef[L<Paws::Kendra::DocumentInfo>] | ||
| 281 | |||
| 282 | =item IndexId => Str | ||
| 283 | |||
| 284 | |||
| 285 | =back | ||
| 286 | |||
| 287 | Each argument is described in detail in: L<Paws::Kendra::BatchGetDocumentStatus> | ||
| 288 | |||
| 289 | Returns: a L<Paws::Kendra::BatchGetDocumentStatusResponse> instance | ||
| 290 | |||
| 291 | Returns the indexing status for one or more documents submitted with | ||
| 292 | the BatchPutDocument | ||
| 293 | (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) | ||
| 294 | operation. | ||
| 295 | |||
| 296 | When you use the C<BatchPutDocument> operation, documents are indexed | ||
| 297 | asynchronously. You can use the C<BatchGetDocumentStatus> operation to | ||
| 298 | get the current status of a list of documents so that you can determine | ||
| 299 | if they have been successfully indexed. | ||
| 300 | |||
| 301 | You can also use the C<BatchGetDocumentStatus> operation to check the | ||
| 302 | status of the BatchDeleteDocument | ||
| 303 | (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) | ||
| 304 | operation. When a document is deleted from the index, Amazon Kendra | ||
| 305 | returns C<NOT_FOUND> as the status. | ||
| 306 | |||
| 307 | |||
| 308 | =head2 BatchPutDocument | ||
| 309 | |||
| 310 | =over | ||
| 311 | |||
| 312 | =item Documents => ArrayRef[L<Paws::Kendra::Document>] | ||
| 313 | |||
| 314 | =item IndexId => Str | ||
| 315 | |||
| 316 | =item [RoleArn => Str] | ||
| 317 | |||
| 318 | |||
| 319 | =back | ||
| 320 | |||
| 321 | Each argument is described in detail in: L<Paws::Kendra::BatchPutDocument> | ||
| 322 | |||
| 323 | Returns: a L<Paws::Kendra::BatchPutDocumentResponse> instance | ||
| 324 | |||
| 325 | Adds one or more documents to an index. | ||
| 326 | |||
| 327 | The C<BatchPutDocument> operation enables you to ingest inline | ||
| 328 | documents or a set of documents stored in an Amazon S3 bucket. Use this | ||
| 329 | operation to ingest your text and unstructured text into an index, add | ||
| 330 | custom attributes to the documents, and to attach an access control | ||
| 331 | list to the documents added to the index. | ||
| 332 | |||
| 333 | The documents are indexed asynchronously. You can see the progress of | ||
| 334 | the batch using AWS CloudWatch. Any error messages related to | ||
| 335 | processing the batch are sent to your AWS CloudWatch log. | ||
| 336 | |||
| 337 | |||
| 338 | =head2 ClearQuerySuggestions | ||
| 339 | |||
| 340 | =over | ||
| 341 | |||
| 342 | =item IndexId => Str | ||
| 343 | |||
| 344 | |||
| 345 | =back | ||
| 346 | |||
| 347 | Each argument is described in detail in: L<Paws::Kendra::ClearQuerySuggestions> | ||
| 348 | |||
| 349 | Returns: nothing | ||
| 350 | |||
| 351 | Clears existing query suggestions from an index. | ||
| 352 | |||
| 353 | This deletes existing suggestions only, not the queries in the query | ||
| 354 | log. After you clear suggestions, Amazon Kendra learns new suggestions | ||
| 355 | based on new queries added to the query log from the time you cleared | ||
| 356 | suggestions. If you do not see any new suggestions, then please allow | ||
| 357 | Amazon Kendra to collect enough queries to learn new suggestions. | ||
| 358 | |||
| 359 | |||
| 360 | =head2 CreateDataSource | ||
| 361 | |||
| 362 | =over | ||
| 363 | |||
| 364 | =item IndexId => Str | ||
| 365 | |||
| 366 | =item Name => Str | ||
| 367 | |||
| 368 | =item Type => Str | ||
| 369 | |||
| 370 | =item [ClientToken => Str] | ||
| 371 | |||
| 372 | =item [Configuration => L<Paws::Kendra::DataSourceConfiguration>] | ||
| 373 | |||
| 374 | =item [Description => Str] | ||
| 375 | |||
| 376 | =item [RoleArn => Str] | ||
| 377 | |||
| 378 | =item [Schedule => Str] | ||
| 379 | |||
| 380 | =item [Tags => ArrayRef[L<Paws::Kendra::Tag>]] | ||
| 381 | |||
| 382 | |||
| 383 | =back | ||
| 384 | |||
| 385 | Each argument is described in detail in: L<Paws::Kendra::CreateDataSource> | ||
| 386 | |||
| 387 | Returns: a L<Paws::Kendra::CreateDataSourceResponse> instance | ||
| 388 | |||
| 389 | Creates a data source that you use to with an Amazon Kendra index. | ||
| 390 | |||
| 391 | You specify a name, data source connector type and description for your | ||
| 392 | data source. You also specify configuration information such as | ||
| 393 | document metadata (author, source URI, and so on) and user context | ||
| 394 | information. | ||
| 395 | |||
| 396 | C<CreateDataSource> is a synchronous operation. The operation returns | ||
| 397 | 200 if the data source was successfully created. Otherwise, an | ||
| 398 | exception is raised. | ||
| 399 | |||
| 400 | |||
| 401 | =head2 CreateFaq | ||
| 402 | |||
| 403 | =over | ||
| 404 | |||
| 405 | =item IndexId => Str | ||
| 406 | |||
| 407 | =item Name => Str | ||
| 408 | |||
| 409 | =item RoleArn => Str | ||
| 410 | |||
| 411 | =item S3Path => L<Paws::Kendra::S3Path> | ||
| 412 | |||
| 413 | =item [ClientToken => Str] | ||
| 414 | |||
| 415 | =item [Description => Str] | ||
| 416 | |||
| 417 | =item [FileFormat => Str] | ||
| 418 | |||
| 419 | =item [Tags => ArrayRef[L<Paws::Kendra::Tag>]] | ||
| 420 | |||
| 421 | |||
| 422 | =back | ||
| 423 | |||
| 424 | Each argument is described in detail in: L<Paws::Kendra::CreateFaq> | ||
| 425 | |||
| 426 | Returns: a L<Paws::Kendra::CreateFaqResponse> instance | ||
| 427 | |||
| 428 | Creates an new set of frequently asked question (FAQ) questions and | ||
| 429 | answers. | ||
| 430 | |||
| 431 | |||
| 432 | =head2 CreateIndex | ||
| 433 | |||
| 434 | =over | ||
| 435 | |||
| 436 | =item Name => Str | ||
| 437 | |||
| 438 | =item RoleArn => Str | ||
| 439 | |||
| 440 | =item [ClientToken => Str] | ||
| 441 | |||
| 442 | =item [Description => Str] | ||
| 443 | |||
| 444 | =item [Edition => Str] | ||
| 445 | |||
| 446 | =item [ServerSideEncryptionConfiguration => L<Paws::Kendra::ServerSideEncryptionConfiguration>] | ||
| 447 | |||
| 448 | =item [Tags => ArrayRef[L<Paws::Kendra::Tag>]] | ||
| 449 | |||
| 450 | =item [UserContextPolicy => Str] | ||
| 451 | |||
| 452 | =item [UserTokenConfigurations => ArrayRef[L<Paws::Kendra::UserTokenConfiguration>]] | ||
| 453 | |||
| 454 | |||
| 455 | =back | ||
| 456 | |||
| 457 | Each argument is described in detail in: L<Paws::Kendra::CreateIndex> | ||
| 458 | |||
| 459 | Returns: a L<Paws::Kendra::CreateIndexResponse> instance | ||
| 460 | |||
| 461 | Creates a new Amazon Kendra index. Index creation is an asynchronous | ||
| 462 | operation. To determine if index creation has completed, check the | ||
| 463 | C<Status> field returned from a call to C<DescribeIndex>. The C<Status> | ||
| 464 | field is set to C<ACTIVE> when the index is ready to use. | ||
| 465 | |||
| 466 | Once the index is active you can index your documents using the | ||
| 467 | C<BatchPutDocument> operation or using one of the supported data | ||
| 468 | sources. | ||
| 469 | |||
| 470 | |||
| 471 | =head2 CreateQuerySuggestionsBlockList | ||
| 472 | |||
| 473 | =over | ||
| 474 | |||
| 475 | =item IndexId => Str | ||
| 476 | |||
| 477 | =item Name => Str | ||
| 478 | |||
| 479 | =item RoleArn => Str | ||
| 480 | |||
| 481 | =item SourceS3Path => L<Paws::Kendra::S3Path> | ||
| 482 | |||
| 483 | =item [ClientToken => Str] | ||
| 484 | |||
| 485 | =item [Description => Str] | ||
| 486 | |||
| 487 | =item [Tags => ArrayRef[L<Paws::Kendra::Tag>]] | ||
| 488 | |||
| 489 | |||
| 490 | =back | ||
| 491 | |||
| 492 | Each argument is described in detail in: L<Paws::Kendra::CreateQuerySuggestionsBlockList> | ||
| 493 | |||
| 494 | Returns: a L<Paws::Kendra::CreateQuerySuggestionsBlockListResponse> instance | ||
| 495 | |||
| 496 | Creates a block list to exlcude certain queries from suggestions. | ||
| 497 | |||
| 498 | Any query that contains words or phrases specified in the block list is | ||
| 499 | blocked or filtered out from being shown as a suggestion. | ||
| 500 | |||
| 501 | You need to provide the file location of your block list text file in | ||
| 502 | your S3 bucket. In your text file, enter each block word or phrase on a | ||
| 503 | separate line. | ||
| 504 | |||
| 505 | For information on the current quota limits for block lists, see Quotas | ||
| 506 | for Amazon Kendra | ||
| 507 | (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). | ||
| 508 | |||
| 509 | |||
| 510 | =head2 CreateThesaurus | ||
| 511 | |||
| 512 | =over | ||
| 513 | |||
| 514 | =item IndexId => Str | ||
| 515 | |||
| 516 | =item Name => Str | ||
| 517 | |||
| 518 | =item RoleArn => Str | ||
| 519 | |||
| 520 | =item SourceS3Path => L<Paws::Kendra::S3Path> | ||
| 521 | |||
| 522 | =item [ClientToken => Str] | ||
| 523 | |||
| 524 | =item [Description => Str] | ||
| 525 | |||
| 526 | =item [Tags => ArrayRef[L<Paws::Kendra::Tag>]] | ||
| 527 | |||
| 528 | |||
| 529 | =back | ||
| 530 | |||
| 531 | Each argument is described in detail in: L<Paws::Kendra::CreateThesaurus> | ||
| 532 | |||
| 533 | Returns: a L<Paws::Kendra::CreateThesaurusResponse> instance | ||
| 534 | |||
| 535 | Creates a thesaurus for an index. The thesaurus contains a list of | ||
| 536 | synonyms in Solr format. | ||
| 537 | |||
| 538 | |||
| 539 | =head2 DeleteDataSource | ||
| 540 | |||
| 541 | =over | ||
| 542 | |||
| 543 | =item Id => Str | ||
| 544 | |||
| 545 | =item IndexId => Str | ||
| 546 | |||
| 547 | |||
| 548 | =back | ||
| 549 | |||
| 550 | Each argument is described in detail in: L<Paws::Kendra::DeleteDataSource> | ||
| 551 | |||
| 552 | Returns: nothing | ||
| 553 | |||
| 554 | Deletes an Amazon Kendra data source. An exception is not thrown if the | ||
| 555 | data source is already being deleted. While the data source is being | ||
| 556 | deleted, the C<Status> field returned by a call to the | ||
| 557 | C<DescribeDataSource> operation is set to C<DELETING>. For more | ||
| 558 | information, see Deleting Data Sources | ||
| 559 | (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html). | ||
| 560 | |||
| 561 | |||
| 562 | =head2 DeleteFaq | ||
| 563 | |||
| 564 | =over | ||
| 565 | |||
| 566 | =item Id => Str | ||
| 567 | |||
| 568 | =item IndexId => Str | ||
| 569 | |||
| 570 | |||
| 571 | =back | ||
| 572 | |||
| 573 | Each argument is described in detail in: L<Paws::Kendra::DeleteFaq> | ||
| 574 | |||
| 575 | Returns: nothing | ||
| 576 | |||
| 577 | Removes an FAQ from an index. | ||
| 578 | |||
| 579 | |||
| 580 | =head2 DeleteIndex | ||
| 581 | |||
| 582 | =over | ||
| 583 | |||
| 584 | =item Id => Str | ||
| 585 | |||
| 586 | |||
| 587 | =back | ||
| 588 | |||
| 589 | Each argument is described in detail in: L<Paws::Kendra::DeleteIndex> | ||
| 590 | |||
| 591 | Returns: nothing | ||
| 592 | |||
| 593 | Deletes an existing Amazon Kendra index. An exception is not thrown if | ||
| 594 | the index is already being deleted. While the index is being deleted, | ||
| 595 | the C<Status> field returned by a call to the C<DescribeIndex> | ||
| 596 | operation is set to C<DELETING>. | ||
| 597 | |||
| 598 | |||
| 599 | =head2 DeleteQuerySuggestionsBlockList | ||
| 600 | |||
| 601 | =over | ||
| 602 | |||
| 603 | =item Id => Str | ||
| 604 | |||
| 605 | =item IndexId => Str | ||
| 606 | |||
| 607 | |||
| 608 | =back | ||
| 609 | |||
| 610 | Each argument is described in detail in: L<Paws::Kendra::DeleteQuerySuggestionsBlockList> | ||
| 611 | |||
| 612 | Returns: nothing | ||
| 613 | |||
| 614 | Deletes a block list used for query suggestions for an index. | ||
| 615 | |||
| 616 | A deleted block list might not take effect right away. Amazon Kendra | ||
| 617 | needs to refresh the entire suggestions list to add back the queries | ||
| 618 | that were previously blocked. | ||
| 619 | |||
| 620 | |||
| 621 | =head2 DeleteThesaurus | ||
| 622 | |||
| 623 | =over | ||
| 624 | |||
| 625 | =item Id => Str | ||
| 626 | |||
| 627 | =item IndexId => Str | ||
| 628 | |||
| 629 | |||
| 630 | =back | ||
| 631 | |||
| 632 | Each argument is described in detail in: L<Paws::Kendra::DeleteThesaurus> | ||
| 633 | |||
| 634 | Returns: nothing | ||
| 635 | |||
| 636 | Deletes an existing Amazon Kendra thesaurus. | ||
| 637 | |||
| 638 | |||
| 639 | =head2 DescribeDataSource | ||
| 640 | |||
| 641 | =over | ||
| 642 | |||
| 643 | =item Id => Str | ||
| 644 | |||
| 645 | =item IndexId => Str | ||
| 646 | |||
| 647 | |||
| 648 | =back | ||
| 649 | |||
| 650 | Each argument is described in detail in: L<Paws::Kendra::DescribeDataSource> | ||
| 651 | |||
| 652 | Returns: a L<Paws::Kendra::DescribeDataSourceResponse> instance | ||
| 653 | |||
| 654 | Gets information about a Amazon Kendra data source. | ||
| 655 | |||
| 656 | |||
| 657 | =head2 DescribeFaq | ||
| 658 | |||
| 659 | =over | ||
| 660 | |||
| 661 | =item Id => Str | ||
| 662 | |||
| 663 | =item IndexId => Str | ||
| 664 | |||
| 665 | |||
| 666 | =back | ||
| 667 | |||
| 668 | Each argument is described in detail in: L<Paws::Kendra::DescribeFaq> | ||
| 669 | |||
| 670 | Returns: a L<Paws::Kendra::DescribeFaqResponse> instance | ||
| 671 | |||
| 672 | Gets information about an FAQ list. | ||
| 673 | |||
| 674 | |||
| 675 | =head2 DescribeIndex | ||
| 676 | |||
| 677 | =over | ||
| 678 | |||
| 679 | =item Id => Str | ||
| 680 | |||
| 681 | |||
| 682 | =back | ||
| 683 | |||
| 684 | Each argument is described in detail in: L<Paws::Kendra::DescribeIndex> | ||
| 685 | |||
| 686 | Returns: a L<Paws::Kendra::DescribeIndexResponse> instance | ||
| 687 | |||
| 688 | Describes an existing Amazon Kendra index | ||
| 689 | |||
| 690 | |||
| 691 | =head2 DescribeQuerySuggestionsBlockList | ||
| 692 | |||
| 693 | =over | ||
| 694 | |||
| 695 | =item Id => Str | ||
| 696 | |||
| 697 | =item IndexId => Str | ||
| 698 | |||
| 699 | |||
| 700 | =back | ||
| 701 | |||
| 702 | Each argument is described in detail in: L<Paws::Kendra::DescribeQuerySuggestionsBlockList> | ||
| 703 | |||
| 704 | Returns: a L<Paws::Kendra::DescribeQuerySuggestionsBlockListResponse> instance | ||
| 705 | |||
| 706 | Describes a block list used for query suggestions for an index. | ||
| 707 | |||
| 708 | This is used to check the current settings that are applied to a block | ||
| 709 | list. | ||
| 710 | |||
| 711 | |||
| 712 | =head2 DescribeQuerySuggestionsConfig | ||
| 713 | |||
| 714 | =over | ||
| 715 | |||
| 716 | =item IndexId => Str | ||
| 717 | |||
| 718 | |||
| 719 | =back | ||
| 720 | |||
| 721 | Each argument is described in detail in: L<Paws::Kendra::DescribeQuerySuggestionsConfig> | ||
| 722 | |||
| 723 | Returns: a L<Paws::Kendra::DescribeQuerySuggestionsConfigResponse> instance | ||
| 724 | |||
| 725 | Describes the settings of query suggestions for an index. | ||
| 726 | |||
| 727 | This is used to check the current settings applied to query | ||
| 728 | suggestions. | ||
| 729 | |||
| 730 | |||
| 731 | =head2 DescribeThesaurus | ||
| 732 | |||
| 733 | =over | ||
| 734 | |||
| 735 | =item Id => Str | ||
| 736 | |||
| 737 | =item IndexId => Str | ||
| 738 | |||
| 739 | |||
| 740 | =back | ||
| 741 | |||
| 742 | Each argument is described in detail in: L<Paws::Kendra::DescribeThesaurus> | ||
| 743 | |||
| 744 | Returns: a L<Paws::Kendra::DescribeThesaurusResponse> instance | ||
| 745 | |||
| 746 | Describes an existing Amazon Kendra thesaurus. | ||
| 747 | |||
| 748 | |||
| 749 | =head2 GetQuerySuggestions | ||
| 750 | |||
| 751 | =over | ||
| 752 | |||
| 753 | =item IndexId => Str | ||
| 754 | |||
| 755 | =item QueryText => Str | ||
| 756 | |||
| 757 | =item [MaxSuggestionsCount => Int] | ||
| 758 | |||
| 759 | |||
| 760 | =back | ||
| 761 | |||
| 762 | Each argument is described in detail in: L<Paws::Kendra::GetQuerySuggestions> | ||
| 763 | |||
| 764 | Returns: a L<Paws::Kendra::GetQuerySuggestionsResponse> instance | ||
| 765 | |||
| 766 | Fetches the queries that are suggested to your users. | ||
| 767 | |||
| 768 | |||
| 769 | =head2 ListDataSources | ||
| 770 | |||
| 771 | =over | ||
| 772 | |||
| 773 | =item IndexId => Str | ||
| 774 | |||
| 775 | =item [MaxResults => Int] | ||
| 776 | |||
| 777 | =item [NextToken => Str] | ||
| 778 | |||
| 779 | |||
| 780 | =back | ||
| 781 | |||
| 782 | Each argument is described in detail in: L<Paws::Kendra::ListDataSources> | ||
| 783 | |||
| 784 | Returns: a L<Paws::Kendra::ListDataSourcesResponse> instance | ||
| 785 | |||
| 786 | Lists the data sources that you have created. | ||
| 787 | |||
| 788 | |||
| 789 | =head2 ListDataSourceSyncJobs | ||
| 790 | |||
| 791 | =over | ||
| 792 | |||
| 793 | =item Id => Str | ||
| 794 | |||
| 795 | =item IndexId => Str | ||
| 796 | |||
| 797 | =item [MaxResults => Int] | ||
| 798 | |||
| 799 | =item [NextToken => Str] | ||
| 800 | |||
| 801 | =item [StartTimeFilter => L<Paws::Kendra::TimeRange>] | ||
| 802 | |||
| 803 | =item [StatusFilter => Str] | ||
| 804 | |||
| 805 | |||
| 806 | =back | ||
| 807 | |||
| 808 | Each argument is described in detail in: L<Paws::Kendra::ListDataSourceSyncJobs> | ||
| 809 | |||
| 810 | Returns: a L<Paws::Kendra::ListDataSourceSyncJobsResponse> instance | ||
| 811 | |||
| 812 | Gets statistics about synchronizing Amazon Kendra with a data source. | ||
| 813 | |||
| 814 | |||
| 815 | =head2 ListFaqs | ||
| 816 | |||
| 817 | =over | ||
| 818 | |||
| 819 | =item IndexId => Str | ||
| 820 | |||
| 821 | =item [MaxResults => Int] | ||
| 822 | |||
| 823 | =item [NextToken => Str] | ||
| 824 | |||
| 825 | |||
| 826 | =back | ||
| 827 | |||
| 828 | Each argument is described in detail in: L<Paws::Kendra::ListFaqs> | ||
| 829 | |||
| 830 | Returns: a L<Paws::Kendra::ListFaqsResponse> instance | ||
| 831 | |||
| 832 | Gets a list of FAQ lists associated with an index. | ||
| 833 | |||
| 834 | |||
| 835 | =head2 ListIndices | ||
| 836 | |||
| 837 | =over | ||
| 838 | |||
| 839 | =item [MaxResults => Int] | ||
| 840 | |||
| 841 | =item [NextToken => Str] | ||
| 842 | |||
| 843 | |||
| 844 | =back | ||
| 845 | |||
| 846 | Each argument is described in detail in: L<Paws::Kendra::ListIndices> | ||
| 847 | |||
| 848 | Returns: a L<Paws::Kendra::ListIndicesResponse> instance | ||
| 849 | |||
| 850 | Lists the Amazon Kendra indexes that you have created. | ||
| 851 | |||
| 852 | |||
| 853 | =head2 ListQuerySuggestionsBlockLists | ||
| 854 | |||
| 855 | =over | ||
| 856 | |||
| 857 | =item IndexId => Str | ||
| 858 | |||
| 859 | =item [MaxResults => Int] | ||
| 860 | |||
| 861 | =item [NextToken => Str] | ||
| 862 | |||
| 863 | |||
| 864 | =back | ||
| 865 | |||
| 866 | Each argument is described in detail in: L<Paws::Kendra::ListQuerySuggestionsBlockLists> | ||
| 867 | |||
| 868 | Returns: a L<Paws::Kendra::ListQuerySuggestionsBlockListsResponse> instance | ||
| 869 | |||
| 870 | Lists the block lists used for query suggestions for an index. | ||
| 871 | |||
| 872 | For information on the current quota limits for block lists, see Quotas | ||
| 873 | for Amazon Kendra | ||
| 874 | (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). | ||
| 875 | |||
| 876 | |||
| 877 | =head2 ListTagsForResource | ||
| 878 | |||
| 879 | =over | ||
| 880 | |||
| 881 | =item ResourceARN => Str | ||
| 882 | |||
| 883 | |||
| 884 | =back | ||
| 885 | |||
| 886 | Each argument is described in detail in: L<Paws::Kendra::ListTagsForResource> | ||
| 887 | |||
| 888 | Returns: a L<Paws::Kendra::ListTagsForResourceResponse> instance | ||
| 889 | |||
| 890 | Gets a list of tags associated with a specified resource. Indexes, | ||
| 891 | FAQs, and data sources can have tags associated with them. | ||
| 892 | |||
| 893 | |||
| 894 | =head2 ListThesauri | ||
| 895 | |||
| 896 | =over | ||
| 897 | |||
| 898 | =item IndexId => Str | ||
| 899 | |||
| 900 | =item [MaxResults => Int] | ||
| 901 | |||
| 902 | =item [NextToken => Str] | ||
| 903 | |||
| 904 | |||
| 905 | =back | ||
| 906 | |||
| 907 | Each argument is described in detail in: L<Paws::Kendra::ListThesauri> | ||
| 908 | |||
| 909 | Returns: a L<Paws::Kendra::ListThesauriResponse> instance | ||
| 910 | |||
| 911 | Lists the Amazon Kendra thesauri associated with an index. | ||
| 912 | |||
| 913 | |||
| 914 | =head2 Query | ||
| 915 | |||
| 916 | =over | ||
| 917 | |||
| 918 | =item IndexId => Str | ||
| 919 | |||
| 920 | =item QueryText => Str | ||
| 921 | |||
| 922 | =item [AttributeFilter => L<Paws::Kendra::AttributeFilter>] | ||
| 923 | |||
| 924 | =item [DocumentRelevanceOverrideConfigurations => ArrayRef[L<Paws::Kendra::DocumentRelevanceConfiguration>]] | ||
| 925 | |||
| 926 | =item [Facets => ArrayRef[L<Paws::Kendra::Facet>]] | ||
| 927 | |||
| 928 | =item [PageNumber => Int] | ||
| 929 | |||
| 930 | =item [PageSize => Int] | ||
| 931 | |||
| 932 | =item [QueryResultTypeFilter => Str] | ||
| 933 | |||
| 934 | =item [RequestedDocumentAttributes => ArrayRef[Str|Undef]] | ||
| 935 | |||
| 936 | =item [SortingConfiguration => L<Paws::Kendra::SortingConfiguration>] | ||
| 937 | |||
| 938 | =item [UserContext => L<Paws::Kendra::UserContext>] | ||
| 939 | |||
| 940 | =item [VisitorId => Str] | ||
| 941 | |||
| 942 | |||
| 943 | =back | ||
| 944 | |||
| 945 | Each argument is described in detail in: L<Paws::Kendra::Query> | ||
| 946 | |||
| 947 | Returns: a L<Paws::Kendra::QueryResult> instance | ||
| 948 | |||
| 949 | Searches an active index. Use this API to search your documents using | ||
| 950 | query. The C<Query> operation enables to do faceted search and to | ||
| 951 | filter results based on document attributes. | ||
| 952 | |||
| 953 | It also enables you to provide user context that Amazon Kendra uses to | ||
| 954 | enforce document access control in the search results. | ||
| 955 | |||
| 956 | Amazon Kendra searches your index for text content and question and | ||
| 957 | answer (FAQ) content. By default the response contains three types of | ||
| 958 | results. | ||
| 959 | |||
| 960 | =over | ||
| 961 | |||
| 962 | =item * | ||
| 963 | |||
| 964 | Relevant passages | ||
| 965 | |||
| 966 | =item * | ||
| 967 | |||
| 968 | Matching FAQs | ||
| 969 | |||
| 970 | =item * | ||
| 971 | |||
| 972 | Relevant documents | ||
| 973 | |||
| 974 | =back | ||
| 975 | |||
| 976 | You can specify that the query return only one type of result using the | ||
| 977 | C<QueryResultTypeConfig> parameter. | ||
| 978 | |||
| 979 | Each query returns the 100 most relevant results. | ||
| 980 | |||
| 981 | |||
| 982 | =head2 StartDataSourceSyncJob | ||
| 983 | |||
| 984 | =over | ||
| 985 | |||
| 986 | =item Id => Str | ||
| 987 | |||
| 988 | =item IndexId => Str | ||
| 989 | |||
| 990 | |||
| 991 | =back | ||
| 992 | |||
| 993 | Each argument is described in detail in: L<Paws::Kendra::StartDataSourceSyncJob> | ||
| 994 | |||
| 995 | Returns: a L<Paws::Kendra::StartDataSourceSyncJobResponse> instance | ||
| 996 | |||
| 997 | Starts a synchronization job for a data source. If a synchronization | ||
| 998 | job is already in progress, Amazon Kendra returns a | ||
| 999 | C<ResourceInUseException> exception. | ||
| 1000 | |||
| 1001 | |||
| 1002 | =head2 StopDataSourceSyncJob | ||
| 1003 | |||
| 1004 | =over | ||
| 1005 | |||
| 1006 | =item Id => Str | ||
| 1007 | |||
| 1008 | =item IndexId => Str | ||
| 1009 | |||
| 1010 | |||
| 1011 | =back | ||
| 1012 | |||
| 1013 | Each argument is described in detail in: L<Paws::Kendra::StopDataSourceSyncJob> | ||
| 1014 | |||
| 1015 | Returns: nothing | ||
| 1016 | |||
| 1017 | Stops a running synchronization job. You can't stop a scheduled | ||
| 1018 | synchronization job. | ||
| 1019 | |||
| 1020 | |||
| 1021 | =head2 SubmitFeedback | ||
| 1022 | |||
| 1023 | =over | ||
| 1024 | |||
| 1025 | =item IndexId => Str | ||
| 1026 | |||
| 1027 | =item QueryId => Str | ||
| 1028 | |||
| 1029 | =item [ClickFeedbackItems => ArrayRef[L<Paws::Kendra::ClickFeedback>]] | ||
| 1030 | |||
| 1031 | =item [RelevanceFeedbackItems => ArrayRef[L<Paws::Kendra::RelevanceFeedback>]] | ||
| 1032 | |||
| 1033 | |||
| 1034 | =back | ||
| 1035 | |||
| 1036 | Each argument is described in detail in: L<Paws::Kendra::SubmitFeedback> | ||
| 1037 | |||
| 1038 | Returns: nothing | ||
| 1039 | |||
| 1040 | Enables you to provide feedback to Amazon Kendra to improve the | ||
| 1041 | performance of the service. | ||
| 1042 | |||
| 1043 | |||
| 1044 | =head2 TagResource | ||
| 1045 | |||
| 1046 | =over | ||
| 1047 | |||
| 1048 | =item ResourceARN => Str | ||
| 1049 | |||
| 1050 | =item Tags => ArrayRef[L<Paws::Kendra::Tag>] | ||
| 1051 | |||
| 1052 | |||
| 1053 | =back | ||
| 1054 | |||
| 1055 | Each argument is described in detail in: L<Paws::Kendra::TagResource> | ||
| 1056 | |||
| 1057 | Returns: a L<Paws::Kendra::TagResourceResponse> instance | ||
| 1058 | |||
| 1059 | Adds the specified tag to the specified index, FAQ, or data source | ||
| 1060 | resource. If the tag already exists, the existing value is replaced | ||
| 1061 | with the new value. | ||
| 1062 | |||
| 1063 | |||
| 1064 | =head2 UntagResource | ||
| 1065 | |||
| 1066 | =over | ||
| 1067 | |||
| 1068 | =item ResourceARN => Str | ||
| 1069 | |||
| 1070 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 1071 | |||
| 1072 | |||
| 1073 | =back | ||
| 1074 | |||
| 1075 | Each argument is described in detail in: L<Paws::Kendra::UntagResource> | ||
| 1076 | |||
| 1077 | Returns: a L<Paws::Kendra::UntagResourceResponse> instance | ||
| 1078 | |||
| 1079 | Removes a tag from an index, FAQ, or a data source. | ||
| 1080 | |||
| 1081 | |||
| 1082 | =head2 UpdateDataSource | ||
| 1083 | |||
| 1084 | =over | ||
| 1085 | |||
| 1086 | =item Id => Str | ||
| 1087 | |||
| 1088 | =item IndexId => Str | ||
| 1089 | |||
| 1090 | =item [Configuration => L<Paws::Kendra::DataSourceConfiguration>] | ||
| 1091 | |||
| 1092 | =item [Description => Str] | ||
| 1093 | |||
| 1094 | =item [Name => Str] | ||
| 1095 | |||
| 1096 | =item [RoleArn => Str] | ||
| 1097 | |||
| 1098 | =item [Schedule => Str] | ||
| 1099 | |||
| 1100 | |||
| 1101 | =back | ||
| 1102 | |||
| 1103 | Each argument is described in detail in: L<Paws::Kendra::UpdateDataSource> | ||
| 1104 | |||
| 1105 | Returns: nothing | ||
| 1106 | |||
| 1107 | Updates an existing Amazon Kendra data source. | ||
| 1108 | |||
| 1109 | |||
| 1110 | =head2 UpdateIndex | ||
| 1111 | |||
| 1112 | =over | ||
| 1113 | |||
| 1114 | =item Id => Str | ||
| 1115 | |||
| 1116 | =item [CapacityUnits => L<Paws::Kendra::CapacityUnitsConfiguration>] | ||
| 1117 | |||
| 1118 | =item [Description => Str] | ||
| 1119 | |||
| 1120 | =item [DocumentMetadataConfigurationUpdates => ArrayRef[L<Paws::Kendra::DocumentMetadataConfiguration>]] | ||
| 1121 | |||
| 1122 | =item [Name => Str] | ||
| 1123 | |||
| 1124 | =item [RoleArn => Str] | ||
| 1125 | |||
| 1126 | =item [UserContextPolicy => Str] | ||
| 1127 | |||
| 1128 | =item [UserTokenConfigurations => ArrayRef[L<Paws::Kendra::UserTokenConfiguration>]] | ||
| 1129 | |||
| 1130 | |||
| 1131 | =back | ||
| 1132 | |||
| 1133 | Each argument is described in detail in: L<Paws::Kendra::UpdateIndex> | ||
| 1134 | |||
| 1135 | Returns: nothing | ||
| 1136 | |||
| 1137 | Updates an existing Amazon Kendra index. | ||
| 1138 | |||
| 1139 | |||
| 1140 | =head2 UpdateQuerySuggestionsBlockList | ||
| 1141 | |||
| 1142 | =over | ||
| 1143 | |||
| 1144 | =item Id => Str | ||
| 1145 | |||
| 1146 | =item IndexId => Str | ||
| 1147 | |||
| 1148 | =item [Description => Str] | ||
| 1149 | |||
| 1150 | =item [Name => Str] | ||
| 1151 | |||
| 1152 | =item [RoleArn => Str] | ||
| 1153 | |||
| 1154 | =item [SourceS3Path => L<Paws::Kendra::S3Path>] | ||
| 1155 | |||
| 1156 | |||
| 1157 | =back | ||
| 1158 | |||
| 1159 | Each argument is described in detail in: L<Paws::Kendra::UpdateQuerySuggestionsBlockList> | ||
| 1160 | |||
| 1161 | Returns: nothing | ||
| 1162 | |||
| 1163 | Updates a block list used for query suggestions for an index. | ||
| 1164 | |||
| 1165 | Updates to a block list might not take effect right away. Amazon Kendra | ||
| 1166 | needs to refresh the entire suggestions list to apply any updates to | ||
| 1167 | the block list. Other changes not related to the block list apply | ||
| 1168 | immediately. | ||
| 1169 | |||
| 1170 | If a block list is updating, then you need to wait for the first update | ||
| 1171 | to finish before submitting another update. | ||
| 1172 | |||
| 1173 | Amazon Kendra supports partial updates, so you only need to provide the | ||
| 1174 | fields you want to update. | ||
| 1175 | |||
| 1176 | |||
| 1177 | =head2 UpdateQuerySuggestionsConfig | ||
| 1178 | |||
| 1179 | =over | ||
| 1180 | |||
| 1181 | =item IndexId => Str | ||
| 1182 | |||
| 1183 | =item [IncludeQueriesWithoutUserInformation => Bool] | ||
| 1184 | |||
| 1185 | =item [MinimumNumberOfQueryingUsers => Int] | ||
| 1186 | |||
| 1187 | =item [MinimumQueryCount => Int] | ||
| 1188 | |||
| 1189 | =item [Mode => Str] | ||
| 1190 | |||
| 1191 | =item [QueryLogLookBackWindowInDays => Int] | ||
| 1192 | |||
| 1193 | |||
| 1194 | =back | ||
| 1195 | |||
| 1196 | Each argument is described in detail in: L<Paws::Kendra::UpdateQuerySuggestionsConfig> | ||
| 1197 | |||
| 1198 | Returns: nothing | ||
| 1199 | |||
| 1200 | Updates the settings of query suggestions for an index. | ||
| 1201 | |||
| 1202 | Amazon Kendra supports partial updates, so you only need to provide the | ||
| 1203 | fields you want to update. | ||
| 1204 | |||
| 1205 | If an update is currently processing (i.e. 'happening'), you need to | ||
| 1206 | wait for the update to finish before making another update. | ||
| 1207 | |||
| 1208 | Updates to query suggestions settings might not take effect right away. | ||
| 1209 | The time for your updated settings to take effect depends on the | ||
| 1210 | updates made and the number of search queries in your index. | ||
| 1211 | |||
| 1212 | You can still enable/disable query suggestions at any time. | ||
| 1213 | |||
| 1214 | |||
| 1215 | =head2 UpdateThesaurus | ||
| 1216 | |||
| 1217 | =over | ||
| 1218 | |||
| 1219 | =item Id => Str | ||
| 1220 | |||
| 1221 | =item IndexId => Str | ||
| 1222 | |||
| 1223 | =item [Description => Str] | ||
| 1224 | |||
| 1225 | =item [Name => Str] | ||
| 1226 | |||
| 1227 | =item [RoleArn => Str] | ||
| 1228 | |||
| 1229 | =item [SourceS3Path => L<Paws::Kendra::S3Path>] | ||
| 1230 | |||
| 1231 | |||
| 1232 | =back | ||
| 1233 | |||
| 1234 | Each argument is described in detail in: L<Paws::Kendra::UpdateThesaurus> | ||
| 1235 | |||
| 1236 | Returns: nothing | ||
| 1237 | |||
| 1238 | Updates a thesaurus file associated with an index. | ||
| 1239 | |||
| 1240 | |||
| 1241 | |||
| 1242 | |||
| 1243 | =head1 PAGINATORS | ||
| 1244 | |||
| 1245 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 1246 | |||
| 1247 | |||
| 1248 | |||
| 1249 | |||
| 1250 | =head1 SEE ALSO | ||
| 1251 | |||
| 1252 | This service class forms part of L<Paws> | ||
| 1253 | |||
| 1254 | =head1 BUGS and CONTRIBUTIONS | ||
| 1255 | |||
| 1256 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 1257 | |||
| 1258 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 1259 | |||
| 1260 | =cut | ||
| 1261 |