aws-sdk-kendraranking 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,664 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::KendraRanking
11
+ module Types
12
+
13
+ # You don’t have sufficient access to perform this action. Please ensure
14
+ # you have the required permission policies and user accounts and try
15
+ # again.
16
+ #
17
+ # @!attribute [rw] message
18
+ # @return [String]
19
+ #
20
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/AccessDeniedException AWS API Documentation
21
+ #
22
+ class AccessDeniedException < Struct.new(
23
+ :message)
24
+ SENSITIVE = []
25
+ include Aws::Structure
26
+ end
27
+
28
+ # Sets additional capacity units configured for your rescore execution
29
+ # plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking
30
+ # resource used for provisioning the `Rescore` API. You can add and
31
+ # remove capacity units to fit your usage requirements.
32
+ #
33
+ # @!attribute [rw] rescore_capacity_units
34
+ # The amount of extra capacity for your rescore execution plan.
35
+ #
36
+ # A single extra capacity unit for a rescore execution plan provides
37
+ # 0.01 rescore requests per second. You can add up to 1000 extra
38
+ # capacity units.
39
+ # @return [Integer]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/CapacityUnitsConfiguration AWS API Documentation
42
+ #
43
+ class CapacityUnitsConfiguration < Struct.new(
44
+ :rescore_capacity_units)
45
+ SENSITIVE = []
46
+ include Aws::Structure
47
+ end
48
+
49
+ # A conflict occurred with the request. Please fix any inconsistencies
50
+ # with your resources and try again.
51
+ #
52
+ # @!attribute [rw] message
53
+ # @return [String]
54
+ #
55
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ConflictException AWS API Documentation
56
+ #
57
+ class ConflictException < Struct.new(
58
+ :message)
59
+ SENSITIVE = []
60
+ include Aws::Structure
61
+ end
62
+
63
+ # @!attribute [rw] name
64
+ # A name for the rescore execution plan.
65
+ # @return [String]
66
+ #
67
+ # @!attribute [rw] description
68
+ # A description for the rescore execution plan.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] capacity_units
72
+ # You can set additional capacity units to meet the needs of your
73
+ # rescore execution plan. You are given a single capacity unit by
74
+ # default. If you want to use the default capacity, you don't set
75
+ # additional capacity units. For more information on the default
76
+ # capacity and additional capacity units, see [Adjusting capacity][1].
77
+ #
78
+ #
79
+ #
80
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
81
+ # @return [Types::CapacityUnitsConfiguration]
82
+ #
83
+ # @!attribute [rw] tags
84
+ # A list of key-value pairs that identify or categorize your rescore
85
+ # execution plan. You can also use tags to help control access to the
86
+ # rescore execution plan. Tag keys and values can consist of Unicode
87
+ # letters, digits, white space, and any of the following symbols: \_ .
88
+ # : / = + - @.
89
+ # @return [Array<Types::Tag>]
90
+ #
91
+ # @!attribute [rw] client_token
92
+ # A token that you provide to identify the request to create a rescore
93
+ # execution plan. Multiple calls to the
94
+ # `CreateRescoreExecutionPlanRequest` API with the same client token
95
+ # will create only one rescore execution plan.
96
+ #
97
+ # **A suitable default value is auto-generated.** You should normally
98
+ # not need to pass this option.
99
+ # @return [String]
100
+ #
101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/CreateRescoreExecutionPlanRequest AWS API Documentation
102
+ #
103
+ class CreateRescoreExecutionPlanRequest < Struct.new(
104
+ :name,
105
+ :description,
106
+ :capacity_units,
107
+ :tags,
108
+ :client_token)
109
+ SENSITIVE = []
110
+ include Aws::Structure
111
+ end
112
+
113
+ # @!attribute [rw] id
114
+ # The identifier of the rescore execution plan.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] arn
118
+ # The Amazon Resource Name (ARN) of the rescore execution plan.
119
+ # @return [String]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/CreateRescoreExecutionPlanResponse AWS API Documentation
122
+ #
123
+ class CreateRescoreExecutionPlanResponse < Struct.new(
124
+ :id,
125
+ :arn)
126
+ SENSITIVE = []
127
+ include Aws::Structure
128
+ end
129
+
130
+ # @!attribute [rw] id
131
+ # The identifier of the rescore execution plan that you want to
132
+ # delete.
133
+ # @return [String]
134
+ #
135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlanRequest AWS API Documentation
136
+ #
137
+ class DeleteRescoreExecutionPlanRequest < Struct.new(
138
+ :id)
139
+ SENSITIVE = []
140
+ include Aws::Structure
141
+ end
142
+
143
+ # @!attribute [rw] id
144
+ # The identifier of the rescore execution plan that you want to get
145
+ # information on.
146
+ # @return [String]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlanRequest AWS API Documentation
149
+ #
150
+ class DescribeRescoreExecutionPlanRequest < Struct.new(
151
+ :id)
152
+ SENSITIVE = []
153
+ include Aws::Structure
154
+ end
155
+
156
+ # @!attribute [rw] id
157
+ # The identifier of the rescore execution plan.
158
+ # @return [String]
159
+ #
160
+ # @!attribute [rw] arn
161
+ # The Amazon Resource Name (ARN) of the rescore execution plan.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] name
165
+ # The name for the rescore execution plan.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] description
169
+ # The description for the rescore execution plan.
170
+ # @return [String]
171
+ #
172
+ # @!attribute [rw] capacity_units
173
+ # The capacity units set for the rescore execution plan. A capacity of
174
+ # zero indicates that the rescore execution plan is using the default
175
+ # capacity. For more information on the default capacity and
176
+ # additional capacity units, see [Adjusting capacity][1].
177
+ #
178
+ #
179
+ #
180
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
181
+ # @return [Types::CapacityUnitsConfiguration]
182
+ #
183
+ # @!attribute [rw] created_at
184
+ # The Unix timestamp of when the rescore execution plan was created.
185
+ # @return [Time]
186
+ #
187
+ # @!attribute [rw] updated_at
188
+ # The Unix timestamp of when the rescore execution plan was last
189
+ # updated.
190
+ # @return [Time]
191
+ #
192
+ # @!attribute [rw] status
193
+ # The current status of the rescore execution plan. When the value is
194
+ # `ACTIVE`, the rescore execution plan is ready for use. If the
195
+ # `Status` field value is `FAILED`, the `ErrorMessage` field contains
196
+ # a message that explains why.
197
+ # @return [String]
198
+ #
199
+ # @!attribute [rw] error_message
200
+ # When the `Status` field value is `FAILED`, the `ErrorMessage` field
201
+ # contains a message that explains why.
202
+ # @return [String]
203
+ #
204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlanResponse AWS API Documentation
205
+ #
206
+ class DescribeRescoreExecutionPlanResponse < Struct.new(
207
+ :id,
208
+ :arn,
209
+ :name,
210
+ :description,
211
+ :capacity_units,
212
+ :created_at,
213
+ :updated_at,
214
+ :status,
215
+ :error_message)
216
+ SENSITIVE = []
217
+ include Aws::Structure
218
+ end
219
+
220
+ # Information about a document from a search service such as OpenSearch
221
+ # (self managed). Amazon Kendra Intelligent Ranking uses this
222
+ # information to rank and score on.
223
+ #
224
+ # @!attribute [rw] id
225
+ # The identifier of the document from the search service.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] group_id
229
+ # The optional group identifier of the document from the search
230
+ # service. Documents with the same group identifier are grouped
231
+ # together and processed as one document within the service.
232
+ # @return [String]
233
+ #
234
+ # @!attribute [rw] title
235
+ # The title of the search service's document.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] body
239
+ # The body text of the search service's document.
240
+ # @return [String]
241
+ #
242
+ # @!attribute [rw] tokenized_title
243
+ # The title of the search service's document represented as a list of
244
+ # tokens or words. You must choose to provide `Title` or
245
+ # `TokenizedTitle`. You cannot provide both.
246
+ # @return [Array<String>]
247
+ #
248
+ # @!attribute [rw] tokenized_body
249
+ # The body text of the search service's document represented as a
250
+ # list of tokens or words. You must choose to provide `Body` or
251
+ # `TokenizedBody`. You cannot provide both.
252
+ # @return [Array<String>]
253
+ #
254
+ # @!attribute [rw] original_score
255
+ # The original document score or rank from the search service. Amazon
256
+ # Kendra Intelligent Ranking gives the document a new score or rank
257
+ # based on its intelligent search algorithms.
258
+ # @return [Float]
259
+ #
260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/Document AWS API Documentation
261
+ #
262
+ class Document < Struct.new(
263
+ :id,
264
+ :group_id,
265
+ :title,
266
+ :body,
267
+ :tokenized_title,
268
+ :tokenized_body,
269
+ :original_score)
270
+ SENSITIVE = []
271
+ include Aws::Structure
272
+ end
273
+
274
+ # An issue occurred with the internal server used for your Amazon Kendra
275
+ # Intelligent Ranking service. Please wait a few minutes and try again,
276
+ # or contact [Support][1] for help.
277
+ #
278
+ #
279
+ #
280
+ # [1]: http://aws.amazon.com/contact-us/
281
+ #
282
+ # @!attribute [rw] message
283
+ # @return [String]
284
+ #
285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/InternalServerException AWS API Documentation
286
+ #
287
+ class InternalServerException < Struct.new(
288
+ :message)
289
+ SENSITIVE = []
290
+ include Aws::Structure
291
+ end
292
+
293
+ # @!attribute [rw] next_token
294
+ # If the response is truncated, Amazon Kendra Intelligent Ranking
295
+ # returns a pagination token in the response. You can use this
296
+ # pagination token to retrieve the next set of rescore execution
297
+ # plans.
298
+ # @return [String]
299
+ #
300
+ # @!attribute [rw] max_results
301
+ # The maximum number of rescore execution plans to return.
302
+ # @return [Integer]
303
+ #
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListRescoreExecutionPlansRequest AWS API Documentation
305
+ #
306
+ class ListRescoreExecutionPlansRequest < Struct.new(
307
+ :next_token,
308
+ :max_results)
309
+ SENSITIVE = []
310
+ include Aws::Structure
311
+ end
312
+
313
+ # @!attribute [rw] summary_items
314
+ # An array of summary information for one or more rescore execution
315
+ # plans.
316
+ # @return [Array<Types::RescoreExecutionPlanSummary>]
317
+ #
318
+ # @!attribute [rw] next_token
319
+ # If the response is truncated, Amazon Kendra Intelligent Ranking
320
+ # returns a pagination token in the response.
321
+ # @return [String]
322
+ #
323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListRescoreExecutionPlansResponse AWS API Documentation
324
+ #
325
+ class ListRescoreExecutionPlansResponse < Struct.new(
326
+ :summary_items,
327
+ :next_token)
328
+ SENSITIVE = []
329
+ include Aws::Structure
330
+ end
331
+
332
+ # The request information for listing tags associated with a rescore
333
+ # execution plan. A rescore execution plan is an Amazon Kendra
334
+ # Intelligent Ranking resource used for provisioning the `Rescore` API.
335
+ #
336
+ # @!attribute [rw] resource_arn
337
+ # The Amazon Resource Name (ARN) of the rescore execution plan to get
338
+ # a list of tags for.
339
+ # @return [String]
340
+ #
341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListTagsForResourceRequest AWS API Documentation
342
+ #
343
+ class ListTagsForResourceRequest < Struct.new(
344
+ :resource_arn)
345
+ SENSITIVE = []
346
+ include Aws::Structure
347
+ end
348
+
349
+ # If the action is successful, the service sends back an HTTP 200
350
+ # response.
351
+ #
352
+ # @!attribute [rw] tags
353
+ # A list of tags associated with the rescore execution plan.
354
+ # @return [Array<Types::Tag>]
355
+ #
356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ListTagsForResourceResponse AWS API Documentation
357
+ #
358
+ class ListTagsForResourceResponse < Struct.new(
359
+ :tags)
360
+ SENSITIVE = []
361
+ include Aws::Structure
362
+ end
363
+
364
+ # Summary information for a rescore execution plan. A rescore execution
365
+ # plan is an Amazon Kendra Intelligent Ranking resource used for
366
+ # provisioning the `Rescore` API.
367
+ #
368
+ # @!attribute [rw] name
369
+ # The name of the rescore execution plan.
370
+ # @return [String]
371
+ #
372
+ # @!attribute [rw] id
373
+ # The identifier of the rescore execution plan.
374
+ # @return [String]
375
+ #
376
+ # @!attribute [rw] created_at
377
+ # The Unix timestamp when the rescore execution plan was created.
378
+ # @return [Time]
379
+ #
380
+ # @!attribute [rw] updated_at
381
+ # The Unix timestamp when the rescore execution plan was last updated.
382
+ # @return [Time]
383
+ #
384
+ # @!attribute [rw] status
385
+ # The current status of the rescore execution plan. When the value is
386
+ # `ACTIVE`, the rescore execution plan is ready for use.
387
+ # @return [String]
388
+ #
389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/RescoreExecutionPlanSummary AWS API Documentation
390
+ #
391
+ class RescoreExecutionPlanSummary < Struct.new(
392
+ :name,
393
+ :id,
394
+ :created_at,
395
+ :updated_at,
396
+ :status)
397
+ SENSITIVE = []
398
+ include Aws::Structure
399
+ end
400
+
401
+ # @!attribute [rw] rescore_execution_plan_id
402
+ # The identifier of the rescore execution plan. A rescore execution
403
+ # plan is an Amazon Kendra Intelligent Ranking resource used for
404
+ # provisioning the `Rescore` API.
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] search_query
408
+ # The input query from the search service.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] documents
412
+ # The list of documents for Amazon Kendra Intelligent Ranking to
413
+ # rescore or rank on.
414
+ # @return [Array<Types::Document>]
415
+ #
416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/RescoreRequest AWS API Documentation
417
+ #
418
+ class RescoreRequest < Struct.new(
419
+ :rescore_execution_plan_id,
420
+ :search_query,
421
+ :documents)
422
+ SENSITIVE = []
423
+ include Aws::Structure
424
+ end
425
+
426
+ # @!attribute [rw] rescore_id
427
+ # The identifier associated with the scores that Amazon Kendra
428
+ # Intelligent Ranking gives to the results. Amazon Kendra Intelligent
429
+ # Ranking rescores or re-ranks the results for the search service.
430
+ # @return [String]
431
+ #
432
+ # @!attribute [rw] result_items
433
+ # A list of result items for documents with new relevancy scores. The
434
+ # results are in descending order.
435
+ # @return [Array<Types::RescoreResultItem>]
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/RescoreResult AWS API Documentation
438
+ #
439
+ class RescoreResult < Struct.new(
440
+ :rescore_id,
441
+ :result_items)
442
+ SENSITIVE = []
443
+ include Aws::Structure
444
+ end
445
+
446
+ # A result item for a document with a new relevancy score.
447
+ #
448
+ # @!attribute [rw] document_id
449
+ # The identifier of the document from the search service.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] score
453
+ # The relevancy score or rank that Amazon Kendra Intelligent Ranking
454
+ # gives to the result.
455
+ # @return [Float]
456
+ #
457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/RescoreResultItem AWS API Documentation
458
+ #
459
+ class RescoreResultItem < Struct.new(
460
+ :document_id,
461
+ :score)
462
+ SENSITIVE = []
463
+ include Aws::Structure
464
+ end
465
+
466
+ # The resource you want to use doesn't exist. Please check you have
467
+ # provided the correct resource and try again.
468
+ #
469
+ # @!attribute [rw] message
470
+ # @return [String]
471
+ #
472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ResourceNotFoundException AWS API Documentation
473
+ #
474
+ class ResourceNotFoundException < Struct.new(
475
+ :message)
476
+ SENSITIVE = []
477
+ include Aws::Structure
478
+ end
479
+
480
+ # The resource you want to use is unavailable. Please check you have
481
+ # provided the correct resource information and try again.
482
+ #
483
+ # @!attribute [rw] message
484
+ # @return [String]
485
+ #
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ResourceUnavailableException AWS API Documentation
487
+ #
488
+ class ResourceUnavailableException < Struct.new(
489
+ :message)
490
+ SENSITIVE = []
491
+ include Aws::Structure
492
+ end
493
+
494
+ # You have exceeded the set limits for your Amazon Kendra Intelligent
495
+ # Ranking service. Please see [Quotas][1] for more information, or
496
+ # contact [Support][2] to inquire about an increase of limits.
497
+ #
498
+ #
499
+ #
500
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
501
+ # [2]: http://aws.amazon.com/contact-us/
502
+ #
503
+ # @!attribute [rw] message
504
+ # @return [String]
505
+ #
506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ServiceQuotaExceededException AWS API Documentation
507
+ #
508
+ class ServiceQuotaExceededException < Struct.new(
509
+ :message)
510
+ SENSITIVE = []
511
+ include Aws::Structure
512
+ end
513
+
514
+ # A key-value pair that identifies or categorizes a rescore execution
515
+ # plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking
516
+ # resource used for provisioning the `Rescore` API. You can also use a
517
+ # tag to help control access to a rescore execution plan. A tag key and
518
+ # value can consist of Unicode letters, digits, white space, and any of
519
+ # the following symbols: \_ . : / = + - @.
520
+ #
521
+ # @!attribute [rw] key
522
+ # The key for the tag. Keys are not case sensitive and must be unique.
523
+ # @return [String]
524
+ #
525
+ # @!attribute [rw] value
526
+ # The value associated with the tag. The value can be an empty string
527
+ # but it can't be null.
528
+ # @return [String]
529
+ #
530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/Tag AWS API Documentation
531
+ #
532
+ class Tag < Struct.new(
533
+ :key,
534
+ :value)
535
+ SENSITIVE = []
536
+ include Aws::Structure
537
+ end
538
+
539
+ # The request information for tagging a rescore execution plan. A
540
+ # rescore execution plan is an Amazon Kendra Intelligent Ranking
541
+ # resource used for provisioning the `Rescore` API.
542
+ #
543
+ # @!attribute [rw] resource_arn
544
+ # The Amazon Resource Name (ARN) of the rescore execution plan to tag.
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] tags
548
+ # A list of tag keys to add to a rescore execution plan. If a tag
549
+ # already exists, the existing value is replaced with the new value.
550
+ # @return [Array<Types::Tag>]
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/TagResourceRequest AWS API Documentation
553
+ #
554
+ class TagResourceRequest < Struct.new(
555
+ :resource_arn,
556
+ :tags)
557
+ SENSITIVE = []
558
+ include Aws::Structure
559
+ end
560
+
561
+ # If the action is successful, the service sends back an HTTP 200
562
+ # response with an empty HTTP body.
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/TagResourceResponse AWS API Documentation
565
+ #
566
+ class TagResourceResponse < Aws::EmptyStructure; end
567
+
568
+ # The request was denied due to request throttling. Please reduce the
569
+ # number of requests and try again.
570
+ #
571
+ # @!attribute [rw] message
572
+ # @return [String]
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ThrottlingException AWS API Documentation
575
+ #
576
+ class ThrottlingException < Struct.new(
577
+ :message)
578
+ SENSITIVE = []
579
+ include Aws::Structure
580
+ end
581
+
582
+ # The request information to remove a tag from a rescore execution plan.
583
+ # A rescore execution plan is an Amazon Kendra Intelligent Ranking
584
+ # resource used for provisioning the `Rescore` API.
585
+ #
586
+ # @!attribute [rw] resource_arn
587
+ # The Amazon Resource Name (ARN) of the rescore execution plan to
588
+ # remove the tag.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] tag_keys
592
+ # A list of tag keys to remove from the rescore execution plan. If a
593
+ # tag key does not exist on the resource, it is ignored.
594
+ # @return [Array<String>]
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/UntagResourceRequest AWS API Documentation
597
+ #
598
+ class UntagResourceRequest < Struct.new(
599
+ :resource_arn,
600
+ :tag_keys)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # If the action is successful, the service sends back an HTTP 200
606
+ # response with an empty HTTP body.
607
+ #
608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/UntagResourceResponse AWS API Documentation
609
+ #
610
+ class UntagResourceResponse < Aws::EmptyStructure; end
611
+
612
+ # @!attribute [rw] id
613
+ # The identifier of the rescore execution plan that you want to
614
+ # update.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] name
618
+ # A new name for the rescore execution plan.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] description
622
+ # A new description for the rescore execution plan.
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] capacity_units
626
+ # You can set additional capacity units to meet the needs of your
627
+ # rescore execution plan. You are given a single capacity unit by
628
+ # default. If you want to use the default capacity, you don't set
629
+ # additional capacity units. For more information on the default
630
+ # capacity and additional capacity units, see [Adjusting capacity][1].
631
+ #
632
+ #
633
+ #
634
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
635
+ # @return [Types::CapacityUnitsConfiguration]
636
+ #
637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlanRequest AWS API Documentation
638
+ #
639
+ class UpdateRescoreExecutionPlanRequest < Struct.new(
640
+ :id,
641
+ :name,
642
+ :description,
643
+ :capacity_units)
644
+ SENSITIVE = []
645
+ include Aws::Structure
646
+ end
647
+
648
+ # The input fails to satisfy the constraints set by the Amazon Kendra
649
+ # Intelligent Ranking service. Please provide the correct input and try
650
+ # again.
651
+ #
652
+ # @!attribute [rw] message
653
+ # @return [String]
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-ranking-2022-10-19/ValidationException AWS API Documentation
656
+ #
657
+ class ValidationException < Struct.new(
658
+ :message)
659
+ SENSITIVE = []
660
+ include Aws::Structure
661
+ end
662
+
663
+ end
664
+ end