aws-sdk-connectwisdomservice 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2585 @@
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::ConnectWisdomService
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # Configuration information for Amazon AppIntegrations to automatically
27
+ # ingest content.
28
+ #
29
+ # @note When making an API call, you may pass AppIntegrationsConfiguration
30
+ # data as a hash:
31
+ #
32
+ # {
33
+ # app_integration_arn: "GenericArn", # required
34
+ # object_fields: ["NonEmptyString"], # required
35
+ # }
36
+ #
37
+ # @!attribute [rw] app_integration_arn
38
+ # The Amazon Resource Name (ARN) of the AppIntegrations
39
+ # DataIntegration to use for ingesting content.
40
+ # @return [String]
41
+ #
42
+ # @!attribute [rw] object_fields
43
+ # The fields from the source that are made available to your agents in
44
+ # Wisdom.
45
+ #
46
+ # * For [ Salesforce][1], you must include at least `Id`,
47
+ # `ArticleNumber`, `VersionNumber`, `Title`, `PublishStatus`, and
48
+ # `IsDeleted`.
49
+ #
50
+ # * For [ ServiceNow][2], you must include at least `number`,
51
+ # `short_description`, `sys_mod_count`, `workflow_state`, and
52
+ # `active`.
53
+ #
54
+ # Make sure to include additional field(s); these are indexed and used
55
+ # to source recommendations.
56
+ #
57
+ #
58
+ #
59
+ # [1]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm
60
+ # [2]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api
61
+ # @return [Array<String>]
62
+ #
63
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AppIntegrationsConfiguration AWS API Documentation
64
+ #
65
+ class AppIntegrationsConfiguration < Struct.new(
66
+ :app_integration_arn,
67
+ :object_fields)
68
+ SENSITIVE = []
69
+ include Aws::Structure
70
+ end
71
+
72
+ # Information about the assistant association.
73
+ #
74
+ # @!attribute [rw] assistant_arn
75
+ # The Amazon Resource Name (ARN) of the Wisdom assistant
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] assistant_association_arn
79
+ # The Amazon Resource Name (ARN) of the assistant association.
80
+ # @return [String]
81
+ #
82
+ # @!attribute [rw] assistant_association_id
83
+ # The identifier of the assistant association.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] assistant_id
87
+ # The identifier of the Wisdom assistant.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] association_data
91
+ # A union type that currently has a single argument, the knowledge
92
+ # base ID.
93
+ # @return [Types::AssistantAssociationOutputData]
94
+ #
95
+ # @!attribute [rw] association_type
96
+ # The type of association.
97
+ # @return [String]
98
+ #
99
+ # @!attribute [rw] tags
100
+ # The tags used to organize, track, or control access for this
101
+ # resource.
102
+ # @return [Hash<String,String>]
103
+ #
104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationData AWS API Documentation
105
+ #
106
+ class AssistantAssociationData < Struct.new(
107
+ :assistant_arn,
108
+ :assistant_association_arn,
109
+ :assistant_association_id,
110
+ :assistant_id,
111
+ :association_data,
112
+ :association_type,
113
+ :tags)
114
+ SENSITIVE = []
115
+ include Aws::Structure
116
+ end
117
+
118
+ # The data that is input into Wisdom as a result of the assistant
119
+ # association.
120
+ #
121
+ # @note AssistantAssociationInputData is a union - when making an API calls you must set exactly one of the members.
122
+ #
123
+ # @!attribute [rw] knowledge_base_id
124
+ # The the identifier of the knowledge base.
125
+ # @return [String]
126
+ #
127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationInputData AWS API Documentation
128
+ #
129
+ class AssistantAssociationInputData < Struct.new(
130
+ :knowledge_base_id,
131
+ :unknown)
132
+ SENSITIVE = []
133
+ include Aws::Structure
134
+ include Aws::Structure::Union
135
+
136
+ class KnowledgeBaseId < AssistantAssociationInputData; end
137
+ class Unknown < AssistantAssociationInputData; end
138
+ end
139
+
140
+ # The data that is output as a result of the assistant association.
141
+ #
142
+ # @note AssistantAssociationOutputData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AssistantAssociationOutputData corresponding to the set member.
143
+ #
144
+ # @!attribute [rw] knowledge_base_association
145
+ # The knowledge base where output data is sent.
146
+ # @return [Types::KnowledgeBaseAssociationData]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationOutputData AWS API Documentation
149
+ #
150
+ class AssistantAssociationOutputData < Struct.new(
151
+ :knowledge_base_association,
152
+ :unknown)
153
+ SENSITIVE = []
154
+ include Aws::Structure
155
+ include Aws::Structure::Union
156
+
157
+ class KnowledgeBaseAssociation < AssistantAssociationOutputData; end
158
+ class Unknown < AssistantAssociationOutputData; end
159
+ end
160
+
161
+ # Summary information about the assistant association.
162
+ #
163
+ # @!attribute [rw] assistant_arn
164
+ # The Amazon Resource Name (ARN) of the Wisdom assistant
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] assistant_association_arn
168
+ # The Amazon Resource Name (ARN) of the assistant association.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] assistant_association_id
172
+ # The identifier of the assistant association.
173
+ # @return [String]
174
+ #
175
+ # @!attribute [rw] assistant_id
176
+ # The identifier of the Wisdom assistant.
177
+ # @return [String]
178
+ #
179
+ # @!attribute [rw] association_data
180
+ # The association data.
181
+ # @return [Types::AssistantAssociationOutputData]
182
+ #
183
+ # @!attribute [rw] association_type
184
+ # The type of association.
185
+ # @return [String]
186
+ #
187
+ # @!attribute [rw] tags
188
+ # The tags used to organize, track, or control access for this
189
+ # resource.
190
+ # @return [Hash<String,String>]
191
+ #
192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationSummary AWS API Documentation
193
+ #
194
+ class AssistantAssociationSummary < Struct.new(
195
+ :assistant_arn,
196
+ :assistant_association_arn,
197
+ :assistant_association_id,
198
+ :assistant_id,
199
+ :association_data,
200
+ :association_type,
201
+ :tags)
202
+ SENSITIVE = []
203
+ include Aws::Structure
204
+ end
205
+
206
+ # The assistant data.
207
+ #
208
+ # @!attribute [rw] assistant_arn
209
+ # The Amazon Resource Name (ARN) of the Wisdom assistant
210
+ # @return [String]
211
+ #
212
+ # @!attribute [rw] assistant_id
213
+ # The identifier of the Wisdom assistant.
214
+ # @return [String]
215
+ #
216
+ # @!attribute [rw] description
217
+ # The description.
218
+ # @return [String]
219
+ #
220
+ # @!attribute [rw] name
221
+ # The name.
222
+ # @return [String]
223
+ #
224
+ # @!attribute [rw] server_side_encryption_configuration
225
+ # The KMS key used for encryption.
226
+ # @return [Types::ServerSideEncryptionConfiguration]
227
+ #
228
+ # @!attribute [rw] status
229
+ # The status of the assistant.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] tags
233
+ # The tags used to organize, track, or control access for this
234
+ # resource.
235
+ # @return [Hash<String,String>]
236
+ #
237
+ # @!attribute [rw] type
238
+ # The type of assistant.
239
+ # @return [String]
240
+ #
241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantData AWS API Documentation
242
+ #
243
+ class AssistantData < Struct.new(
244
+ :assistant_arn,
245
+ :assistant_id,
246
+ :description,
247
+ :name,
248
+ :server_side_encryption_configuration,
249
+ :status,
250
+ :tags,
251
+ :type)
252
+ SENSITIVE = []
253
+ include Aws::Structure
254
+ end
255
+
256
+ # Summary information about the assistant.
257
+ #
258
+ # @!attribute [rw] assistant_arn
259
+ # The Amazon Resource Name (ARN) of the Wisdom assistant
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] assistant_id
263
+ # The identifier of the Wisdom assistant.
264
+ # @return [String]
265
+ #
266
+ # @!attribute [rw] description
267
+ # The description of the assistant.
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] name
271
+ # The name of the assistant.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] server_side_encryption_configuration
275
+ # The KMS key used for encryption.
276
+ # @return [Types::ServerSideEncryptionConfiguration]
277
+ #
278
+ # @!attribute [rw] status
279
+ # The status of the assistant.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] tags
283
+ # The tags used to organize, track, or control access for this
284
+ # resource.
285
+ # @return [Hash<String,String>]
286
+ #
287
+ # @!attribute [rw] type
288
+ # The type of the assistant.
289
+ # @return [String]
290
+ #
291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantSummary AWS API Documentation
292
+ #
293
+ class AssistantSummary < Struct.new(
294
+ :assistant_arn,
295
+ :assistant_id,
296
+ :description,
297
+ :name,
298
+ :server_side_encryption_configuration,
299
+ :status,
300
+ :tags,
301
+ :type)
302
+ SENSITIVE = []
303
+ include Aws::Structure
304
+ end
305
+
306
+ # The request could not be processed because of conflict in the current
307
+ # state of the resource. For example, if you're using a `Create` API
308
+ # (such as `CreateAssistant`) that accepts name, a conflicting resource
309
+ # (usually with the same name) is being created or mutated.
310
+ #
311
+ # @!attribute [rw] message
312
+ # @return [String]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ConflictException AWS API Documentation
315
+ #
316
+ class ConflictException < Struct.new(
317
+ :message)
318
+ SENSITIVE = []
319
+ include Aws::Structure
320
+ end
321
+
322
+ # Information about the content.
323
+ #
324
+ # @!attribute [rw] content_arn
325
+ # The Amazon Resource Name (ARN) of the content.
326
+ # @return [String]
327
+ #
328
+ # @!attribute [rw] content_id
329
+ # The identifier of the content.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] content_type
333
+ # The media type of the content.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] knowledge_base_arn
337
+ # The Amazon Resource Name (ARN) of the knowledge base.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] knowledge_base_id
341
+ # The the identifier of the knowledge base.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] link_out_uri
345
+ # The URI of the content.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] metadata
349
+ # A key/value map to store attributes without affecting tagging or
350
+ # recommendations. For example, when synchronizing data between an
351
+ # external system and Wisdom, you can store an external version
352
+ # identifier as metadata to utilize for determining drift.
353
+ # @return [Hash<String,String>]
354
+ #
355
+ # @!attribute [rw] name
356
+ # The name of the content.
357
+ # @return [String]
358
+ #
359
+ # @!attribute [rw] revision_id
360
+ # The identifier of the content revision.
361
+ # @return [String]
362
+ #
363
+ # @!attribute [rw] status
364
+ # The status of the content.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] tags
368
+ # The tags used to organize, track, or control access for this
369
+ # resource.
370
+ # @return [Hash<String,String>]
371
+ #
372
+ # @!attribute [rw] title
373
+ # The title of the content.
374
+ # @return [String]
375
+ #
376
+ # @!attribute [rw] url
377
+ # The URL of the content.
378
+ # @return [String]
379
+ #
380
+ # @!attribute [rw] url_expiry
381
+ # The expiration time of the URL as an epoch timestamp.
382
+ # @return [Time]
383
+ #
384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentData AWS API Documentation
385
+ #
386
+ class ContentData < Struct.new(
387
+ :content_arn,
388
+ :content_id,
389
+ :content_type,
390
+ :knowledge_base_arn,
391
+ :knowledge_base_id,
392
+ :link_out_uri,
393
+ :metadata,
394
+ :name,
395
+ :revision_id,
396
+ :status,
397
+ :tags,
398
+ :title,
399
+ :url,
400
+ :url_expiry)
401
+ SENSITIVE = [:url]
402
+ include Aws::Structure
403
+ end
404
+
405
+ # Reference information about the content.
406
+ #
407
+ # @!attribute [rw] content_arn
408
+ # The Amazon Resource Name (ARN) of the content.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] content_id
412
+ # The identifier of the content.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] knowledge_base_arn
416
+ # The Amazon Resource Name (ARN) of the knowledge base.
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] knowledge_base_id
420
+ # The the identifier of the knowledge base.
421
+ # @return [String]
422
+ #
423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentReference AWS API Documentation
424
+ #
425
+ class ContentReference < Struct.new(
426
+ :content_arn,
427
+ :content_id,
428
+ :knowledge_base_arn,
429
+ :knowledge_base_id)
430
+ SENSITIVE = []
431
+ include Aws::Structure
432
+ end
433
+
434
+ # Summary information about the content.
435
+ #
436
+ # @!attribute [rw] content_arn
437
+ # The Amazon Resource Name (ARN) of the content.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] content_id
441
+ # The identifier of the content.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] content_type
445
+ # The media type of the content.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] knowledge_base_arn
449
+ # The Amazon Resource Name (ARN) of the knowledge base.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] knowledge_base_id
453
+ # The the identifier of the knowledge base.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] metadata
457
+ # A key/value map to store attributes without affecting tagging or
458
+ # recommendations. For example, when synchronizing data between an
459
+ # external system and Wisdom, you can store an external version
460
+ # identifier as metadata to utilize for determining drift.
461
+ # @return [Hash<String,String>]
462
+ #
463
+ # @!attribute [rw] name
464
+ # The name of the content.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] revision_id
468
+ # The identifier of the revision of the content.
469
+ # @return [String]
470
+ #
471
+ # @!attribute [rw] status
472
+ # The status of the content.
473
+ # @return [String]
474
+ #
475
+ # @!attribute [rw] tags
476
+ # The tags used to organize, track, or control access for this
477
+ # resource.
478
+ # @return [Hash<String,String>]
479
+ #
480
+ # @!attribute [rw] title
481
+ # The title of the content.
482
+ # @return [String]
483
+ #
484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentSummary AWS API Documentation
485
+ #
486
+ class ContentSummary < Struct.new(
487
+ :content_arn,
488
+ :content_id,
489
+ :content_type,
490
+ :knowledge_base_arn,
491
+ :knowledge_base_id,
492
+ :metadata,
493
+ :name,
494
+ :revision_id,
495
+ :status,
496
+ :tags,
497
+ :title)
498
+ SENSITIVE = []
499
+ include Aws::Structure
500
+ end
501
+
502
+ # @note When making an API call, you may pass CreateAssistantAssociationRequest
503
+ # data as a hash:
504
+ #
505
+ # {
506
+ # assistant_id: "UuidOrArn", # required
507
+ # association: { # required
508
+ # knowledge_base_id: "Uuid",
509
+ # },
510
+ # association_type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
511
+ # client_token: "ClientToken",
512
+ # tags: {
513
+ # "TagKey" => "TagValue",
514
+ # },
515
+ # }
516
+ #
517
+ # @!attribute [rw] assistant_id
518
+ # The identifier of the Wisdom assistant. Can be either the ID or the
519
+ # ARN. URLs cannot contain the ARN.
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] association
523
+ # The identifier of the associated resource.
524
+ # @return [Types::AssistantAssociationInputData]
525
+ #
526
+ # @!attribute [rw] association_type
527
+ # The type of association.
528
+ # @return [String]
529
+ #
530
+ # @!attribute [rw] client_token
531
+ # A unique, case-sensitive identifier that you provide to ensure the
532
+ # idempotency of the request.
533
+ #
534
+ # **A suitable default value is auto-generated.** You should normally
535
+ # not need to pass this option.
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] tags
539
+ # The tags used to organize, track, or control access for this
540
+ # resource.
541
+ # @return [Hash<String,String>]
542
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantAssociationRequest AWS API Documentation
544
+ #
545
+ class CreateAssistantAssociationRequest < Struct.new(
546
+ :assistant_id,
547
+ :association,
548
+ :association_type,
549
+ :client_token,
550
+ :tags)
551
+ SENSITIVE = []
552
+ include Aws::Structure
553
+ end
554
+
555
+ # @!attribute [rw] assistant_association
556
+ # The assistant association.
557
+ # @return [Types::AssistantAssociationData]
558
+ #
559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantAssociationResponse AWS API Documentation
560
+ #
561
+ class CreateAssistantAssociationResponse < Struct.new(
562
+ :assistant_association)
563
+ SENSITIVE = []
564
+ include Aws::Structure
565
+ end
566
+
567
+ # @note When making an API call, you may pass CreateAssistantRequest
568
+ # data as a hash:
569
+ #
570
+ # {
571
+ # client_token: "ClientToken",
572
+ # description: "Description",
573
+ # name: "Name", # required
574
+ # server_side_encryption_configuration: {
575
+ # kms_key_id: "NonEmptyString",
576
+ # },
577
+ # tags: {
578
+ # "TagKey" => "TagValue",
579
+ # },
580
+ # type: "AGENT", # required, accepts AGENT
581
+ # }
582
+ #
583
+ # @!attribute [rw] client_token
584
+ # A unique, case-sensitive identifier that you provide to ensure the
585
+ # idempotency of the request.
586
+ #
587
+ # **A suitable default value is auto-generated.** You should normally
588
+ # not need to pass this option.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] description
592
+ # The description of the assistant.
593
+ # @return [String]
594
+ #
595
+ # @!attribute [rw] name
596
+ # The name of the assistant.
597
+ # @return [String]
598
+ #
599
+ # @!attribute [rw] server_side_encryption_configuration
600
+ # The KMS key used for encryption.
601
+ # @return [Types::ServerSideEncryptionConfiguration]
602
+ #
603
+ # @!attribute [rw] tags
604
+ # The tags used to organize, track, or control access for this
605
+ # resource.
606
+ # @return [Hash<String,String>]
607
+ #
608
+ # @!attribute [rw] type
609
+ # The type of assistant.
610
+ # @return [String]
611
+ #
612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantRequest AWS API Documentation
613
+ #
614
+ class CreateAssistantRequest < Struct.new(
615
+ :client_token,
616
+ :description,
617
+ :name,
618
+ :server_side_encryption_configuration,
619
+ :tags,
620
+ :type)
621
+ SENSITIVE = []
622
+ include Aws::Structure
623
+ end
624
+
625
+ # @!attribute [rw] assistant
626
+ # Information about the assistant.
627
+ # @return [Types::AssistantData]
628
+ #
629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantResponse AWS API Documentation
630
+ #
631
+ class CreateAssistantResponse < Struct.new(
632
+ :assistant)
633
+ SENSITIVE = []
634
+ include Aws::Structure
635
+ end
636
+
637
+ # @note When making an API call, you may pass CreateContentRequest
638
+ # data as a hash:
639
+ #
640
+ # {
641
+ # client_token: "NonEmptyString",
642
+ # knowledge_base_id: "UuidOrArn", # required
643
+ # metadata: {
644
+ # "NonEmptyString" => "NonEmptyString",
645
+ # },
646
+ # name: "Name", # required
647
+ # override_link_out_uri: "Uri",
648
+ # tags: {
649
+ # "TagKey" => "TagValue",
650
+ # },
651
+ # title: "ContentTitle",
652
+ # upload_id: "NonEmptyString", # required
653
+ # }
654
+ #
655
+ # @!attribute [rw] client_token
656
+ # A unique, case-sensitive identifier that you provide to ensure the
657
+ # idempotency of the request.
658
+ #
659
+ # **A suitable default value is auto-generated.** You should normally
660
+ # not need to pass this option.
661
+ # @return [String]
662
+ #
663
+ # @!attribute [rw] knowledge_base_id
664
+ # The the identifier of the knowledge base. Can be either the ID or
665
+ # the ARN. URLs cannot contain the ARN.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] metadata
669
+ # A key/value map to store attributes without affecting tagging or
670
+ # recommendations. For example, when synchronizing data between an
671
+ # external system and Wisdom, you can store an external version
672
+ # identifier as metadata to utilize for determining drift.
673
+ # @return [Hash<String,String>]
674
+ #
675
+ # @!attribute [rw] name
676
+ # The name of the content. Each piece of content in a knowledge base
677
+ # must have a unique name. You can retrieve a piece of content using
678
+ # only its knowledge base and its name with the [SearchContent][1]
679
+ # API.
680
+ #
681
+ #
682
+ #
683
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html
684
+ # @return [String]
685
+ #
686
+ # @!attribute [rw] override_link_out_uri
687
+ # The URI you want to use for the article. If the knowledge base has a
688
+ # templateUri, setting this argument overrides it for this piece of
689
+ # content.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] tags
693
+ # The tags used to organize, track, or control access for this
694
+ # resource.
695
+ # @return [Hash<String,String>]
696
+ #
697
+ # @!attribute [rw] title
698
+ # The title of the content. If not set, the title is equal to the
699
+ # name.
700
+ # @return [String]
701
+ #
702
+ # @!attribute [rw] upload_id
703
+ # A pointer to the uploaded asset. This value is returned by
704
+ # [StartContentUpload][1].
705
+ #
706
+ #
707
+ #
708
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
709
+ # @return [String]
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateContentRequest AWS API Documentation
712
+ #
713
+ class CreateContentRequest < Struct.new(
714
+ :client_token,
715
+ :knowledge_base_id,
716
+ :metadata,
717
+ :name,
718
+ :override_link_out_uri,
719
+ :tags,
720
+ :title,
721
+ :upload_id)
722
+ SENSITIVE = []
723
+ include Aws::Structure
724
+ end
725
+
726
+ # @!attribute [rw] content
727
+ # The content.
728
+ # @return [Types::ContentData]
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateContentResponse AWS API Documentation
731
+ #
732
+ class CreateContentResponse < Struct.new(
733
+ :content)
734
+ SENSITIVE = []
735
+ include Aws::Structure
736
+ end
737
+
738
+ # @note When making an API call, you may pass CreateKnowledgeBaseRequest
739
+ # data as a hash:
740
+ #
741
+ # {
742
+ # client_token: "NonEmptyString",
743
+ # description: "Description",
744
+ # knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM
745
+ # name: "Name", # required
746
+ # rendering_configuration: {
747
+ # template_uri: "Uri",
748
+ # },
749
+ # server_side_encryption_configuration: {
750
+ # kms_key_id: "NonEmptyString",
751
+ # },
752
+ # source_configuration: {
753
+ # app_integrations: {
754
+ # app_integration_arn: "GenericArn", # required
755
+ # object_fields: ["NonEmptyString"], # required
756
+ # },
757
+ # },
758
+ # tags: {
759
+ # "TagKey" => "TagValue",
760
+ # },
761
+ # }
762
+ #
763
+ # @!attribute [rw] client_token
764
+ # A unique, case-sensitive identifier that you provide to ensure the
765
+ # idempotency of the request.
766
+ #
767
+ # **A suitable default value is auto-generated.** You should normally
768
+ # not need to pass this option.
769
+ # @return [String]
770
+ #
771
+ # @!attribute [rw] description
772
+ # The description.
773
+ # @return [String]
774
+ #
775
+ # @!attribute [rw] knowledge_base_type
776
+ # The type of knowledge base. Only CUSTOM knowledge bases allow you to
777
+ # upload your own content. EXTERNAL knowledge bases support
778
+ # integrations with third-party systems whose content is synchronized
779
+ # automatically.
780
+ # @return [String]
781
+ #
782
+ # @!attribute [rw] name
783
+ # The name of the knowledge base.
784
+ # @return [String]
785
+ #
786
+ # @!attribute [rw] rendering_configuration
787
+ # Information about how to render the content.
788
+ # @return [Types::RenderingConfiguration]
789
+ #
790
+ # @!attribute [rw] server_side_encryption_configuration
791
+ # The KMS key used for encryption.
792
+ # @return [Types::ServerSideEncryptionConfiguration]
793
+ #
794
+ # @!attribute [rw] source_configuration
795
+ # The source of the knowledge base content. Only set this argument for
796
+ # EXTERNAL knowledge bases.
797
+ # @return [Types::SourceConfiguration]
798
+ #
799
+ # @!attribute [rw] tags
800
+ # The tags used to organize, track, or control access for this
801
+ # resource.
802
+ # @return [Hash<String,String>]
803
+ #
804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateKnowledgeBaseRequest AWS API Documentation
805
+ #
806
+ class CreateKnowledgeBaseRequest < Struct.new(
807
+ :client_token,
808
+ :description,
809
+ :knowledge_base_type,
810
+ :name,
811
+ :rendering_configuration,
812
+ :server_side_encryption_configuration,
813
+ :source_configuration,
814
+ :tags)
815
+ SENSITIVE = []
816
+ include Aws::Structure
817
+ end
818
+
819
+ # @!attribute [rw] knowledge_base
820
+ # The knowledge base.
821
+ # @return [Types::KnowledgeBaseData]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateKnowledgeBaseResponse AWS API Documentation
824
+ #
825
+ class CreateKnowledgeBaseResponse < Struct.new(
826
+ :knowledge_base)
827
+ SENSITIVE = []
828
+ include Aws::Structure
829
+ end
830
+
831
+ # @note When making an API call, you may pass CreateSessionRequest
832
+ # data as a hash:
833
+ #
834
+ # {
835
+ # assistant_id: "UuidOrArn", # required
836
+ # client_token: "ClientToken",
837
+ # description: "Description",
838
+ # name: "Name", # required
839
+ # tags: {
840
+ # "TagKey" => "TagValue",
841
+ # },
842
+ # }
843
+ #
844
+ # @!attribute [rw] assistant_id
845
+ # The identifier of the Wisdom assistant. Can be either the ID or the
846
+ # ARN. URLs cannot contain the ARN.
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] client_token
850
+ # A unique, case-sensitive identifier that you provide to ensure the
851
+ # idempotency of the request.
852
+ #
853
+ # **A suitable default value is auto-generated.** You should normally
854
+ # not need to pass this option.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] description
858
+ # The description.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] name
862
+ # The name of the session.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] tags
866
+ # The tags used to organize, track, or control access for this
867
+ # resource.
868
+ # @return [Hash<String,String>]
869
+ #
870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateSessionRequest AWS API Documentation
871
+ #
872
+ class CreateSessionRequest < Struct.new(
873
+ :assistant_id,
874
+ :client_token,
875
+ :description,
876
+ :name,
877
+ :tags)
878
+ SENSITIVE = []
879
+ include Aws::Structure
880
+ end
881
+
882
+ # @!attribute [rw] session
883
+ # The session.
884
+ # @return [Types::SessionData]
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateSessionResponse AWS API Documentation
887
+ #
888
+ class CreateSessionResponse < Struct.new(
889
+ :session)
890
+ SENSITIVE = []
891
+ include Aws::Structure
892
+ end
893
+
894
+ # @note When making an API call, you may pass DeleteAssistantAssociationRequest
895
+ # data as a hash:
896
+ #
897
+ # {
898
+ # assistant_association_id: "UuidOrArn", # required
899
+ # assistant_id: "UuidOrArn", # required
900
+ # }
901
+ #
902
+ # @!attribute [rw] assistant_association_id
903
+ # The identifier of the assistant association. Can be either the ID or
904
+ # the ARN. URLs cannot contain the ARN.
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] assistant_id
908
+ # The identifier of the Wisdom assistant. Can be either the ID or the
909
+ # ARN. URLs cannot contain the ARN.
910
+ # @return [String]
911
+ #
912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantAssociationRequest AWS API Documentation
913
+ #
914
+ class DeleteAssistantAssociationRequest < Struct.new(
915
+ :assistant_association_id,
916
+ :assistant_id)
917
+ SENSITIVE = []
918
+ include Aws::Structure
919
+ end
920
+
921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantAssociationResponse AWS API Documentation
922
+ #
923
+ class DeleteAssistantAssociationResponse < Aws::EmptyStructure; end
924
+
925
+ # @note When making an API call, you may pass DeleteAssistantRequest
926
+ # data as a hash:
927
+ #
928
+ # {
929
+ # assistant_id: "UuidOrArn", # required
930
+ # }
931
+ #
932
+ # @!attribute [rw] assistant_id
933
+ # The identifier of the Wisdom assistant. Can be either the ID or the
934
+ # ARN. URLs cannot contain the ARN.
935
+ # @return [String]
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantRequest AWS API Documentation
938
+ #
939
+ class DeleteAssistantRequest < Struct.new(
940
+ :assistant_id)
941
+ SENSITIVE = []
942
+ include Aws::Structure
943
+ end
944
+
945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantResponse AWS API Documentation
946
+ #
947
+ class DeleteAssistantResponse < Aws::EmptyStructure; end
948
+
949
+ # @note When making an API call, you may pass DeleteContentRequest
950
+ # data as a hash:
951
+ #
952
+ # {
953
+ # content_id: "UuidOrArn", # required
954
+ # knowledge_base_id: "UuidOrArn", # required
955
+ # }
956
+ #
957
+ # @!attribute [rw] content_id
958
+ # The identifier of the content. Can be either the ID or the ARN. URLs
959
+ # cannot contain the ARN.
960
+ # @return [String]
961
+ #
962
+ # @!attribute [rw] knowledge_base_id
963
+ # The the identifier of the knowledge base. Can be either the ID or
964
+ # the ARN. URLs cannot contain the ARN.
965
+ # @return [String]
966
+ #
967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContentRequest AWS API Documentation
968
+ #
969
+ class DeleteContentRequest < Struct.new(
970
+ :content_id,
971
+ :knowledge_base_id)
972
+ SENSITIVE = []
973
+ include Aws::Structure
974
+ end
975
+
976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContentResponse AWS API Documentation
977
+ #
978
+ class DeleteContentResponse < Aws::EmptyStructure; end
979
+
980
+ # @note When making an API call, you may pass DeleteKnowledgeBaseRequest
981
+ # data as a hash:
982
+ #
983
+ # {
984
+ # knowledge_base_id: "UuidOrArn", # required
985
+ # }
986
+ #
987
+ # @!attribute [rw] knowledge_base_id
988
+ # The knowledge base to delete content from. Can be either the ID or
989
+ # the ARN. URLs cannot contain the ARN.
990
+ # @return [String]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteKnowledgeBaseRequest AWS API Documentation
993
+ #
994
+ class DeleteKnowledgeBaseRequest < Struct.new(
995
+ :knowledge_base_id)
996
+ SENSITIVE = []
997
+ include Aws::Structure
998
+ end
999
+
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteKnowledgeBaseResponse AWS API Documentation
1001
+ #
1002
+ class DeleteKnowledgeBaseResponse < Aws::EmptyStructure; end
1003
+
1004
+ # The document.
1005
+ #
1006
+ # @!attribute [rw] content_reference
1007
+ # A reference to the content resource.
1008
+ # @return [Types::ContentReference]
1009
+ #
1010
+ # @!attribute [rw] excerpt
1011
+ # The excerpt from the document.
1012
+ # @return [Types::DocumentText]
1013
+ #
1014
+ # @!attribute [rw] title
1015
+ # The title of the document.
1016
+ # @return [Types::DocumentText]
1017
+ #
1018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Document AWS API Documentation
1019
+ #
1020
+ class Document < Struct.new(
1021
+ :content_reference,
1022
+ :excerpt,
1023
+ :title)
1024
+ SENSITIVE = []
1025
+ include Aws::Structure
1026
+ end
1027
+
1028
+ # The text of the document.
1029
+ #
1030
+ # @!attribute [rw] highlights
1031
+ # Highlights in the document text.
1032
+ # @return [Array<Types::Highlight>]
1033
+ #
1034
+ # @!attribute [rw] text
1035
+ # Text in the document.
1036
+ # @return [String]
1037
+ #
1038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DocumentText AWS API Documentation
1039
+ #
1040
+ class DocumentText < Struct.new(
1041
+ :highlights,
1042
+ :text)
1043
+ SENSITIVE = [:text]
1044
+ include Aws::Structure
1045
+ end
1046
+
1047
+ # A search filter.
1048
+ #
1049
+ # @note When making an API call, you may pass Filter
1050
+ # data as a hash:
1051
+ #
1052
+ # {
1053
+ # field: "NAME", # required, accepts NAME
1054
+ # operator: "EQUALS", # required, accepts EQUALS
1055
+ # value: "NonEmptyString", # required
1056
+ # }
1057
+ #
1058
+ # @!attribute [rw] field
1059
+ # The field on which to filter.
1060
+ # @return [String]
1061
+ #
1062
+ # @!attribute [rw] operator
1063
+ # The operator to use for comparing the field’s value with the
1064
+ # provided value.
1065
+ # @return [String]
1066
+ #
1067
+ # @!attribute [rw] value
1068
+ # The desired field value on which to filter.
1069
+ # @return [String]
1070
+ #
1071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Filter AWS API Documentation
1072
+ #
1073
+ class Filter < Struct.new(
1074
+ :field,
1075
+ :operator,
1076
+ :value)
1077
+ SENSITIVE = []
1078
+ include Aws::Structure
1079
+ end
1080
+
1081
+ # @note When making an API call, you may pass GetAssistantAssociationRequest
1082
+ # data as a hash:
1083
+ #
1084
+ # {
1085
+ # assistant_association_id: "UuidOrArn", # required
1086
+ # assistant_id: "UuidOrArn", # required
1087
+ # }
1088
+ #
1089
+ # @!attribute [rw] assistant_association_id
1090
+ # The identifier of the assistant association. Can be either the ID or
1091
+ # the ARN. URLs cannot contain the ARN.
1092
+ # @return [String]
1093
+ #
1094
+ # @!attribute [rw] assistant_id
1095
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1096
+ # ARN. URLs cannot contain the ARN.
1097
+ # @return [String]
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantAssociationRequest AWS API Documentation
1100
+ #
1101
+ class GetAssistantAssociationRequest < Struct.new(
1102
+ :assistant_association_id,
1103
+ :assistant_id)
1104
+ SENSITIVE = []
1105
+ include Aws::Structure
1106
+ end
1107
+
1108
+ # @!attribute [rw] assistant_association
1109
+ # The assistant association.
1110
+ # @return [Types::AssistantAssociationData]
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantAssociationResponse AWS API Documentation
1113
+ #
1114
+ class GetAssistantAssociationResponse < Struct.new(
1115
+ :assistant_association)
1116
+ SENSITIVE = []
1117
+ include Aws::Structure
1118
+ end
1119
+
1120
+ # @note When making an API call, you may pass GetAssistantRequest
1121
+ # data as a hash:
1122
+ #
1123
+ # {
1124
+ # assistant_id: "UuidOrArn", # required
1125
+ # }
1126
+ #
1127
+ # @!attribute [rw] assistant_id
1128
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1129
+ # ARN. URLs cannot contain the ARN.
1130
+ # @return [String]
1131
+ #
1132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantRequest AWS API Documentation
1133
+ #
1134
+ class GetAssistantRequest < Struct.new(
1135
+ :assistant_id)
1136
+ SENSITIVE = []
1137
+ include Aws::Structure
1138
+ end
1139
+
1140
+ # @!attribute [rw] assistant
1141
+ # Information about the assistant.
1142
+ # @return [Types::AssistantData]
1143
+ #
1144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantResponse AWS API Documentation
1145
+ #
1146
+ class GetAssistantResponse < Struct.new(
1147
+ :assistant)
1148
+ SENSITIVE = []
1149
+ include Aws::Structure
1150
+ end
1151
+
1152
+ # @note When making an API call, you may pass GetContentRequest
1153
+ # data as a hash:
1154
+ #
1155
+ # {
1156
+ # content_id: "UuidOrArn", # required
1157
+ # knowledge_base_id: "UuidOrArn", # required
1158
+ # }
1159
+ #
1160
+ # @!attribute [rw] content_id
1161
+ # The identifier of the content. Can be either the ID or the ARN. URLs
1162
+ # cannot contain the ARN.
1163
+ # @return [String]
1164
+ #
1165
+ # @!attribute [rw] knowledge_base_id
1166
+ # The the identifier of the knowledge base. Can be either the ID or
1167
+ # the ARN. URLs cannot contain the ARN.
1168
+ # @return [String]
1169
+ #
1170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentRequest AWS API Documentation
1171
+ #
1172
+ class GetContentRequest < Struct.new(
1173
+ :content_id,
1174
+ :knowledge_base_id)
1175
+ SENSITIVE = []
1176
+ include Aws::Structure
1177
+ end
1178
+
1179
+ # @!attribute [rw] content
1180
+ # The content.
1181
+ # @return [Types::ContentData]
1182
+ #
1183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentResponse AWS API Documentation
1184
+ #
1185
+ class GetContentResponse < Struct.new(
1186
+ :content)
1187
+ SENSITIVE = []
1188
+ include Aws::Structure
1189
+ end
1190
+
1191
+ # @note When making an API call, you may pass GetContentSummaryRequest
1192
+ # data as a hash:
1193
+ #
1194
+ # {
1195
+ # content_id: "UuidOrArn", # required
1196
+ # knowledge_base_id: "UuidOrArn", # required
1197
+ # }
1198
+ #
1199
+ # @!attribute [rw] content_id
1200
+ # The identifier of the content. Can be either the ID or the ARN. URLs
1201
+ # cannot contain the ARN.
1202
+ # @return [String]
1203
+ #
1204
+ # @!attribute [rw] knowledge_base_id
1205
+ # The the identifier of the knowledge base. Can be either the ID or
1206
+ # the ARN. URLs cannot contain the ARN.
1207
+ # @return [String]
1208
+ #
1209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummaryRequest AWS API Documentation
1210
+ #
1211
+ class GetContentSummaryRequest < Struct.new(
1212
+ :content_id,
1213
+ :knowledge_base_id)
1214
+ SENSITIVE = []
1215
+ include Aws::Structure
1216
+ end
1217
+
1218
+ # @!attribute [rw] content_summary
1219
+ # The content summary.
1220
+ # @return [Types::ContentSummary]
1221
+ #
1222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummaryResponse AWS API Documentation
1223
+ #
1224
+ class GetContentSummaryResponse < Struct.new(
1225
+ :content_summary)
1226
+ SENSITIVE = []
1227
+ include Aws::Structure
1228
+ end
1229
+
1230
+ # @note When making an API call, you may pass GetKnowledgeBaseRequest
1231
+ # data as a hash:
1232
+ #
1233
+ # {
1234
+ # knowledge_base_id: "UuidOrArn", # required
1235
+ # }
1236
+ #
1237
+ # @!attribute [rw] knowledge_base_id
1238
+ # The the identifier of the knowledge base. Can be either the ID or
1239
+ # the ARN. URLs cannot contain the ARN.
1240
+ # @return [String]
1241
+ #
1242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBaseRequest AWS API Documentation
1243
+ #
1244
+ class GetKnowledgeBaseRequest < Struct.new(
1245
+ :knowledge_base_id)
1246
+ SENSITIVE = []
1247
+ include Aws::Structure
1248
+ end
1249
+
1250
+ # @!attribute [rw] knowledge_base
1251
+ # The knowledge base.
1252
+ # @return [Types::KnowledgeBaseData]
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBaseResponse AWS API Documentation
1255
+ #
1256
+ class GetKnowledgeBaseResponse < Struct.new(
1257
+ :knowledge_base)
1258
+ SENSITIVE = []
1259
+ include Aws::Structure
1260
+ end
1261
+
1262
+ # @note When making an API call, you may pass GetRecommendationsRequest
1263
+ # data as a hash:
1264
+ #
1265
+ # {
1266
+ # assistant_id: "UuidOrArn", # required
1267
+ # max_results: 1,
1268
+ # session_id: "UuidOrArn", # required
1269
+ # wait_time_seconds: 1,
1270
+ # }
1271
+ #
1272
+ # @!attribute [rw] assistant_id
1273
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1274
+ # ARN. URLs cannot contain the ARN.
1275
+ # @return [String]
1276
+ #
1277
+ # @!attribute [rw] max_results
1278
+ # The maximum number of results to return per page.
1279
+ # @return [Integer]
1280
+ #
1281
+ # @!attribute [rw] session_id
1282
+ # The identifier of the session. Can be either the ID or the ARN. URLs
1283
+ # cannot contain the ARN.
1284
+ # @return [String]
1285
+ #
1286
+ # @!attribute [rw] wait_time_seconds
1287
+ # The duration (in seconds) for which the call waits for a
1288
+ # recommendation to be made available before returning. If a
1289
+ # recommendation is available, the call returns sooner than
1290
+ # `WaitTimeSeconds`. If no messages are available and the wait time
1291
+ # expires, the call returns successfully with an empty list.
1292
+ # @return [Integer]
1293
+ #
1294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetRecommendationsRequest AWS API Documentation
1295
+ #
1296
+ class GetRecommendationsRequest < Struct.new(
1297
+ :assistant_id,
1298
+ :max_results,
1299
+ :session_id,
1300
+ :wait_time_seconds)
1301
+ SENSITIVE = []
1302
+ include Aws::Structure
1303
+ end
1304
+
1305
+ # @!attribute [rw] recommendations
1306
+ # The recommendations.
1307
+ # @return [Array<Types::RecommendationData>]
1308
+ #
1309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetRecommendationsResponse AWS API Documentation
1310
+ #
1311
+ class GetRecommendationsResponse < Struct.new(
1312
+ :recommendations)
1313
+ SENSITIVE = []
1314
+ include Aws::Structure
1315
+ end
1316
+
1317
+ # @note When making an API call, you may pass GetSessionRequest
1318
+ # data as a hash:
1319
+ #
1320
+ # {
1321
+ # assistant_id: "UuidOrArn", # required
1322
+ # session_id: "UuidOrArn", # required
1323
+ # }
1324
+ #
1325
+ # @!attribute [rw] assistant_id
1326
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1327
+ # ARN. URLs cannot contain the ARN.
1328
+ # @return [String]
1329
+ #
1330
+ # @!attribute [rw] session_id
1331
+ # The identifier of the session. Can be either the ID or the ARN. URLs
1332
+ # cannot contain the ARN.
1333
+ # @return [String]
1334
+ #
1335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetSessionRequest AWS API Documentation
1336
+ #
1337
+ class GetSessionRequest < Struct.new(
1338
+ :assistant_id,
1339
+ :session_id)
1340
+ SENSITIVE = []
1341
+ include Aws::Structure
1342
+ end
1343
+
1344
+ # @!attribute [rw] session
1345
+ # The session.
1346
+ # @return [Types::SessionData]
1347
+ #
1348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetSessionResponse AWS API Documentation
1349
+ #
1350
+ class GetSessionResponse < Struct.new(
1351
+ :session)
1352
+ SENSITIVE = []
1353
+ include Aws::Structure
1354
+ end
1355
+
1356
+ # Offset specification to describe highlighting of document excerpts for
1357
+ # rendering search results and recommendations.
1358
+ #
1359
+ # @!attribute [rw] begin_offset_inclusive
1360
+ # The offset for the start of the highlight.
1361
+ # @return [Integer]
1362
+ #
1363
+ # @!attribute [rw] end_offset_exclusive
1364
+ # The offset for the end of the highlight.
1365
+ # @return [Integer]
1366
+ #
1367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Highlight AWS API Documentation
1368
+ #
1369
+ class Highlight < Struct.new(
1370
+ :begin_offset_inclusive,
1371
+ :end_offset_exclusive)
1372
+ SENSITIVE = []
1373
+ include Aws::Structure
1374
+ end
1375
+
1376
+ # Association information about the knowledge base.
1377
+ #
1378
+ # @!attribute [rw] knowledge_base_arn
1379
+ # The Amazon Resource Name (ARN) of the knowledge base.
1380
+ # @return [String]
1381
+ #
1382
+ # @!attribute [rw] knowledge_base_id
1383
+ # The the identifier of the knowledge base.
1384
+ # @return [String]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseAssociationData AWS API Documentation
1387
+ #
1388
+ class KnowledgeBaseAssociationData < Struct.new(
1389
+ :knowledge_base_arn,
1390
+ :knowledge_base_id)
1391
+ SENSITIVE = []
1392
+ include Aws::Structure
1393
+ end
1394
+
1395
+ # Information about the knowledge base.
1396
+ #
1397
+ # @!attribute [rw] description
1398
+ # The description.
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] knowledge_base_arn
1402
+ # The Amazon Resource Name (ARN) of the knowledge base.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] knowledge_base_id
1406
+ # The the identifier of the knowledge base.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] knowledge_base_type
1410
+ # The type of knowledge base.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] last_content_modification_time
1414
+ # An epoch timestamp indicating the most recent content modification
1415
+ # inside the knowledge base. If no content exists in a knowledge base,
1416
+ # this value is unset.
1417
+ # @return [Time]
1418
+ #
1419
+ # @!attribute [rw] name
1420
+ # The name of the knowledge base.
1421
+ # @return [String]
1422
+ #
1423
+ # @!attribute [rw] rendering_configuration
1424
+ # Information about how to render the content.
1425
+ # @return [Types::RenderingConfiguration]
1426
+ #
1427
+ # @!attribute [rw] server_side_encryption_configuration
1428
+ # The KMS key used for encryption.
1429
+ # @return [Types::ServerSideEncryptionConfiguration]
1430
+ #
1431
+ # @!attribute [rw] source_configuration
1432
+ # Source configuration information about the knowledge base.
1433
+ # @return [Types::SourceConfiguration]
1434
+ #
1435
+ # @!attribute [rw] status
1436
+ # The status of the knowledge base.
1437
+ # @return [String]
1438
+ #
1439
+ # @!attribute [rw] tags
1440
+ # The tags used to organize, track, or control access for this
1441
+ # resource.
1442
+ # @return [Hash<String,String>]
1443
+ #
1444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseData AWS API Documentation
1445
+ #
1446
+ class KnowledgeBaseData < Struct.new(
1447
+ :description,
1448
+ :knowledge_base_arn,
1449
+ :knowledge_base_id,
1450
+ :knowledge_base_type,
1451
+ :last_content_modification_time,
1452
+ :name,
1453
+ :rendering_configuration,
1454
+ :server_side_encryption_configuration,
1455
+ :source_configuration,
1456
+ :status,
1457
+ :tags)
1458
+ SENSITIVE = []
1459
+ include Aws::Structure
1460
+ end
1461
+
1462
+ # Summary information about the knowledge base.
1463
+ #
1464
+ # @!attribute [rw] description
1465
+ # The description of the knowledge base.
1466
+ # @return [String]
1467
+ #
1468
+ # @!attribute [rw] knowledge_base_arn
1469
+ # The Amazon Resource Name (ARN) of the knowledge base.
1470
+ # @return [String]
1471
+ #
1472
+ # @!attribute [rw] knowledge_base_id
1473
+ # The the identifier of the knowledge base.
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] knowledge_base_type
1477
+ # The type of knowledge base.
1478
+ # @return [String]
1479
+ #
1480
+ # @!attribute [rw] name
1481
+ # The name of the knowledge base.
1482
+ # @return [String]
1483
+ #
1484
+ # @!attribute [rw] rendering_configuration
1485
+ # Information about how to render the content.
1486
+ # @return [Types::RenderingConfiguration]
1487
+ #
1488
+ # @!attribute [rw] server_side_encryption_configuration
1489
+ # The KMS key used for encryption.
1490
+ # @return [Types::ServerSideEncryptionConfiguration]
1491
+ #
1492
+ # @!attribute [rw] source_configuration
1493
+ # \[KEVIN\]
1494
+ # @return [Types::SourceConfiguration]
1495
+ #
1496
+ # @!attribute [rw] status
1497
+ # The status of the knowledge base summary.
1498
+ # @return [String]
1499
+ #
1500
+ # @!attribute [rw] tags
1501
+ # The tags used to organize, track, or control access for this
1502
+ # resource.
1503
+ # @return [Hash<String,String>]
1504
+ #
1505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseSummary AWS API Documentation
1506
+ #
1507
+ class KnowledgeBaseSummary < Struct.new(
1508
+ :description,
1509
+ :knowledge_base_arn,
1510
+ :knowledge_base_id,
1511
+ :knowledge_base_type,
1512
+ :name,
1513
+ :rendering_configuration,
1514
+ :server_side_encryption_configuration,
1515
+ :source_configuration,
1516
+ :status,
1517
+ :tags)
1518
+ SENSITIVE = []
1519
+ include Aws::Structure
1520
+ end
1521
+
1522
+ # @note When making an API call, you may pass ListAssistantAssociationsRequest
1523
+ # data as a hash:
1524
+ #
1525
+ # {
1526
+ # assistant_id: "UuidOrArn", # required
1527
+ # max_results: 1,
1528
+ # next_token: "NextToken",
1529
+ # }
1530
+ #
1531
+ # @!attribute [rw] assistant_id
1532
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1533
+ # ARN. URLs cannot contain the ARN.
1534
+ # @return [String]
1535
+ #
1536
+ # @!attribute [rw] max_results
1537
+ # The maximum number of results to return per page.
1538
+ # @return [Integer]
1539
+ #
1540
+ # @!attribute [rw] next_token
1541
+ # The token for the next set of results. Use the value returned in the
1542
+ # previous response in the next request to retrieve the next set of
1543
+ # results.
1544
+ # @return [String]
1545
+ #
1546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantAssociationsRequest AWS API Documentation
1547
+ #
1548
+ class ListAssistantAssociationsRequest < Struct.new(
1549
+ :assistant_id,
1550
+ :max_results,
1551
+ :next_token)
1552
+ SENSITIVE = []
1553
+ include Aws::Structure
1554
+ end
1555
+
1556
+ # @!attribute [rw] assistant_association_summaries
1557
+ # Summary information about assistant associations.
1558
+ # @return [Array<Types::AssistantAssociationSummary>]
1559
+ #
1560
+ # @!attribute [rw] next_token
1561
+ # If there are additional results, this is the token for the next set
1562
+ # of results.
1563
+ # @return [String]
1564
+ #
1565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantAssociationsResponse AWS API Documentation
1566
+ #
1567
+ class ListAssistantAssociationsResponse < Struct.new(
1568
+ :assistant_association_summaries,
1569
+ :next_token)
1570
+ SENSITIVE = []
1571
+ include Aws::Structure
1572
+ end
1573
+
1574
+ # @note When making an API call, you may pass ListAssistantsRequest
1575
+ # data as a hash:
1576
+ #
1577
+ # {
1578
+ # max_results: 1,
1579
+ # next_token: "NextToken",
1580
+ # }
1581
+ #
1582
+ # @!attribute [rw] max_results
1583
+ # The maximum number of results to return per page.
1584
+ # @return [Integer]
1585
+ #
1586
+ # @!attribute [rw] next_token
1587
+ # The token for the next set of results. Use the value returned in the
1588
+ # previous response in the next request to retrieve the next set of
1589
+ # results.
1590
+ # @return [String]
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantsRequest AWS API Documentation
1593
+ #
1594
+ class ListAssistantsRequest < Struct.new(
1595
+ :max_results,
1596
+ :next_token)
1597
+ SENSITIVE = []
1598
+ include Aws::Structure
1599
+ end
1600
+
1601
+ # @!attribute [rw] assistant_summaries
1602
+ # Information about the assistants.
1603
+ # @return [Array<Types::AssistantSummary>]
1604
+ #
1605
+ # @!attribute [rw] next_token
1606
+ # If there are additional results, this is the token for the next set
1607
+ # of results.
1608
+ # @return [String]
1609
+ #
1610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantsResponse AWS API Documentation
1611
+ #
1612
+ class ListAssistantsResponse < Struct.new(
1613
+ :assistant_summaries,
1614
+ :next_token)
1615
+ SENSITIVE = []
1616
+ include Aws::Structure
1617
+ end
1618
+
1619
+ # @note When making an API call, you may pass ListContentsRequest
1620
+ # data as a hash:
1621
+ #
1622
+ # {
1623
+ # knowledge_base_id: "UuidOrArn", # required
1624
+ # max_results: 1,
1625
+ # next_token: "NextToken",
1626
+ # }
1627
+ #
1628
+ # @!attribute [rw] knowledge_base_id
1629
+ # The the identifier of the knowledge base. Can be either the ID or
1630
+ # the ARN. URLs cannot contain the ARN.
1631
+ # @return [String]
1632
+ #
1633
+ # @!attribute [rw] max_results
1634
+ # The maximum number of results to return per page.
1635
+ # @return [Integer]
1636
+ #
1637
+ # @!attribute [rw] next_token
1638
+ # The token for the next set of results. Use the value returned in the
1639
+ # previous response in the next request to retrieve the next set of
1640
+ # results.
1641
+ # @return [String]
1642
+ #
1643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListContentsRequest AWS API Documentation
1644
+ #
1645
+ class ListContentsRequest < Struct.new(
1646
+ :knowledge_base_id,
1647
+ :max_results,
1648
+ :next_token)
1649
+ SENSITIVE = []
1650
+ include Aws::Structure
1651
+ end
1652
+
1653
+ # @!attribute [rw] content_summaries
1654
+ # Information about the content.
1655
+ # @return [Array<Types::ContentSummary>]
1656
+ #
1657
+ # @!attribute [rw] next_token
1658
+ # If there are additional results, this is the token for the next set
1659
+ # of results.
1660
+ # @return [String]
1661
+ #
1662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListContentsResponse AWS API Documentation
1663
+ #
1664
+ class ListContentsResponse < Struct.new(
1665
+ :content_summaries,
1666
+ :next_token)
1667
+ SENSITIVE = []
1668
+ include Aws::Structure
1669
+ end
1670
+
1671
+ # @note When making an API call, you may pass ListKnowledgeBasesRequest
1672
+ # data as a hash:
1673
+ #
1674
+ # {
1675
+ # max_results: 1,
1676
+ # next_token: "NonEmptyString",
1677
+ # }
1678
+ #
1679
+ # @!attribute [rw] max_results
1680
+ # The maximum number of results to return per page.
1681
+ # @return [Integer]
1682
+ #
1683
+ # @!attribute [rw] next_token
1684
+ # The token for the next set of results. Use the value returned in the
1685
+ # previous response in the next request to retrieve the next set of
1686
+ # results.
1687
+ # @return [String]
1688
+ #
1689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListKnowledgeBasesRequest AWS API Documentation
1690
+ #
1691
+ class ListKnowledgeBasesRequest < Struct.new(
1692
+ :max_results,
1693
+ :next_token)
1694
+ SENSITIVE = []
1695
+ include Aws::Structure
1696
+ end
1697
+
1698
+ # @!attribute [rw] knowledge_base_summaries
1699
+ # Information about the knowledge bases.
1700
+ # @return [Array<Types::KnowledgeBaseSummary>]
1701
+ #
1702
+ # @!attribute [rw] next_token
1703
+ # If there are additional results, this is the token for the next set
1704
+ # of results.
1705
+ # @return [String]
1706
+ #
1707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListKnowledgeBasesResponse AWS API Documentation
1708
+ #
1709
+ class ListKnowledgeBasesResponse < Struct.new(
1710
+ :knowledge_base_summaries,
1711
+ :next_token)
1712
+ SENSITIVE = []
1713
+ include Aws::Structure
1714
+ end
1715
+
1716
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1717
+ # data as a hash:
1718
+ #
1719
+ # {
1720
+ # resource_arn: "Arn", # required
1721
+ # }
1722
+ #
1723
+ # @!attribute [rw] resource_arn
1724
+ # The Amazon Resource Name (ARN) of the resource.
1725
+ # @return [String]
1726
+ #
1727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListTagsForResourceRequest AWS API Documentation
1728
+ #
1729
+ class ListTagsForResourceRequest < Struct.new(
1730
+ :resource_arn)
1731
+ SENSITIVE = []
1732
+ include Aws::Structure
1733
+ end
1734
+
1735
+ # @!attribute [rw] tags
1736
+ # The tags used to organize, track, or control access for this
1737
+ # resource.
1738
+ # @return [Hash<String,String>]
1739
+ #
1740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListTagsForResourceResponse AWS API Documentation
1741
+ #
1742
+ class ListTagsForResourceResponse < Struct.new(
1743
+ :tags)
1744
+ SENSITIVE = []
1745
+ include Aws::Structure
1746
+ end
1747
+
1748
+ # An error occurred when creating a recommendation.
1749
+ #
1750
+ # @!attribute [rw] message
1751
+ # A recommendation is causing an error.
1752
+ # @return [String]
1753
+ #
1754
+ # @!attribute [rw] recommendation_id
1755
+ # The identifier of the recommendation that is in error.
1756
+ # @return [String]
1757
+ #
1758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedError AWS API Documentation
1759
+ #
1760
+ class NotifyRecommendationsReceivedError < Struct.new(
1761
+ :message,
1762
+ :recommendation_id)
1763
+ SENSITIVE = []
1764
+ include Aws::Structure
1765
+ end
1766
+
1767
+ # @note When making an API call, you may pass NotifyRecommendationsReceivedRequest
1768
+ # data as a hash:
1769
+ #
1770
+ # {
1771
+ # assistant_id: "UuidOrArn", # required
1772
+ # recommendation_ids: ["String"], # required
1773
+ # session_id: "UuidOrArn", # required
1774
+ # }
1775
+ #
1776
+ # @!attribute [rw] assistant_id
1777
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1778
+ # ARN. URLs cannot contain the ARN.
1779
+ # @return [String]
1780
+ #
1781
+ # @!attribute [rw] recommendation_ids
1782
+ # The identifiers of the recommendations.
1783
+ # @return [Array<String>]
1784
+ #
1785
+ # @!attribute [rw] session_id
1786
+ # The identifier of the session. Can be either the ID or the ARN. URLs
1787
+ # cannot contain the ARN.
1788
+ # @return [String]
1789
+ #
1790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedRequest AWS API Documentation
1791
+ #
1792
+ class NotifyRecommendationsReceivedRequest < Struct.new(
1793
+ :assistant_id,
1794
+ :recommendation_ids,
1795
+ :session_id)
1796
+ SENSITIVE = []
1797
+ include Aws::Structure
1798
+ end
1799
+
1800
+ # @!attribute [rw] errors
1801
+ # The identifiers of recommendations that are causing errors.
1802
+ # @return [Array<Types::NotifyRecommendationsReceivedError>]
1803
+ #
1804
+ # @!attribute [rw] recommendation_ids
1805
+ # The identifiers of the recommendations.
1806
+ # @return [Array<String>]
1807
+ #
1808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedResponse AWS API Documentation
1809
+ #
1810
+ class NotifyRecommendationsReceivedResponse < Struct.new(
1811
+ :errors,
1812
+ :recommendation_ids)
1813
+ SENSITIVE = []
1814
+ include Aws::Structure
1815
+ end
1816
+
1817
+ # The provided `revisionId` does not match, indicating the content has
1818
+ # been modified since it was last read.
1819
+ #
1820
+ # @!attribute [rw] message
1821
+ # @return [String]
1822
+ #
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PreconditionFailedException AWS API Documentation
1824
+ #
1825
+ class PreconditionFailedException < Struct.new(
1826
+ :message)
1827
+ SENSITIVE = []
1828
+ include Aws::Structure
1829
+ end
1830
+
1831
+ # @note When making an API call, you may pass QueryAssistantRequest
1832
+ # data as a hash:
1833
+ #
1834
+ # {
1835
+ # assistant_id: "UuidOrArn", # required
1836
+ # max_results: 1,
1837
+ # next_token: "NextToken",
1838
+ # query_text: "QueryText", # required
1839
+ # }
1840
+ #
1841
+ # @!attribute [rw] assistant_id
1842
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1843
+ # ARN. URLs cannot contain the ARN.
1844
+ # @return [String]
1845
+ #
1846
+ # @!attribute [rw] max_results
1847
+ # The maximum number of results to return per page.
1848
+ # @return [Integer]
1849
+ #
1850
+ # @!attribute [rw] next_token
1851
+ # The token for the next set of results. Use the value returned in the
1852
+ # previous response in the next request to retrieve the next set of
1853
+ # results.
1854
+ # @return [String]
1855
+ #
1856
+ # @!attribute [rw] query_text
1857
+ # The text to search for.
1858
+ # @return [String]
1859
+ #
1860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantRequest AWS API Documentation
1861
+ #
1862
+ class QueryAssistantRequest < Struct.new(
1863
+ :assistant_id,
1864
+ :max_results,
1865
+ :next_token,
1866
+ :query_text)
1867
+ SENSITIVE = [:query_text]
1868
+ include Aws::Structure
1869
+ end
1870
+
1871
+ # @!attribute [rw] next_token
1872
+ # If there are additional results, this is the token for the next set
1873
+ # of results.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] results
1877
+ # The results of the query.
1878
+ # @return [Array<Types::ResultData>]
1879
+ #
1880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantResponse AWS API Documentation
1881
+ #
1882
+ class QueryAssistantResponse < Struct.new(
1883
+ :next_token,
1884
+ :results)
1885
+ SENSITIVE = []
1886
+ include Aws::Structure
1887
+ end
1888
+
1889
+ # Information about the recommendation.
1890
+ #
1891
+ # @!attribute [rw] document
1892
+ # The recommended document.
1893
+ # @return [Types::Document]
1894
+ #
1895
+ # @!attribute [rw] recommendation_id
1896
+ # The identifier of the recommendation.
1897
+ # @return [String]
1898
+ #
1899
+ # @!attribute [rw] relevance_level
1900
+ # The relevance level of the recommendation.
1901
+ # @return [String]
1902
+ #
1903
+ # @!attribute [rw] relevance_score
1904
+ # The relevance score of the recommendation.
1905
+ # @return [Float]
1906
+ #
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RecommendationData AWS API Documentation
1908
+ #
1909
+ class RecommendationData < Struct.new(
1910
+ :document,
1911
+ :recommendation_id,
1912
+ :relevance_level,
1913
+ :relevance_score)
1914
+ SENSITIVE = []
1915
+ include Aws::Structure
1916
+ end
1917
+
1918
+ # @note When making an API call, you may pass RemoveKnowledgeBaseTemplateUriRequest
1919
+ # data as a hash:
1920
+ #
1921
+ # {
1922
+ # knowledge_base_id: "UuidOrArn", # required
1923
+ # }
1924
+ #
1925
+ # @!attribute [rw] knowledge_base_id
1926
+ # The the identifier of the knowledge base. Can be either the ID or
1927
+ # the ARN. URLs cannot contain the ARN.
1928
+ # @return [String]
1929
+ #
1930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUriRequest AWS API Documentation
1931
+ #
1932
+ class RemoveKnowledgeBaseTemplateUriRequest < Struct.new(
1933
+ :knowledge_base_id)
1934
+ SENSITIVE = []
1935
+ include Aws::Structure
1936
+ end
1937
+
1938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUriResponse AWS API Documentation
1939
+ #
1940
+ class RemoveKnowledgeBaseTemplateUriResponse < Aws::EmptyStructure; end
1941
+
1942
+ # Information about how to render the content.
1943
+ #
1944
+ # @note When making an API call, you may pass RenderingConfiguration
1945
+ # data as a hash:
1946
+ #
1947
+ # {
1948
+ # template_uri: "Uri",
1949
+ # }
1950
+ #
1951
+ # @!attribute [rw] template_uri
1952
+ # A URI template containing exactly one variable in `$\{variableName\}
1953
+ # `format. This can only be set for `EXTERNAL` knowledge bases. For
1954
+ # Salesforce and ServiceNow, the variable must be one of the
1955
+ # following:
1956
+ #
1957
+ # * Salesforce: `Id`, `ArticleNumber`, `VersionNumber`, `Title`,
1958
+ # `PublishStatus`, or `IsDeleted`
1959
+ #
1960
+ # * ServiceNow: `number`, `short_description`, `sys_mod_count`,
1961
+ # `workflow_state`, or `active`
1962
+ # ^
1963
+ #
1964
+ # <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
1965
+ # @return [String]
1966
+ #
1967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RenderingConfiguration AWS API Documentation
1968
+ #
1969
+ class RenderingConfiguration < Struct.new(
1970
+ :template_uri)
1971
+ SENSITIVE = []
1972
+ include Aws::Structure
1973
+ end
1974
+
1975
+ # The specified resource does not exist.
1976
+ #
1977
+ # @!attribute [rw] message
1978
+ # @return [String]
1979
+ #
1980
+ # @!attribute [rw] resource_name
1981
+ # The specified resource name.
1982
+ # @return [String]
1983
+ #
1984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ResourceNotFoundException AWS API Documentation
1985
+ #
1986
+ class ResourceNotFoundException < Struct.new(
1987
+ :message,
1988
+ :resource_name)
1989
+ SENSITIVE = []
1990
+ include Aws::Structure
1991
+ end
1992
+
1993
+ # Information about the result.
1994
+ #
1995
+ # @!attribute [rw] document
1996
+ # The document.
1997
+ # @return [Types::Document]
1998
+ #
1999
+ # @!attribute [rw] relevance_score
2000
+ # The relevance score of the results.
2001
+ # @return [Float]
2002
+ #
2003
+ # @!attribute [rw] result_id
2004
+ # The identifier of the result data.
2005
+ # @return [String]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ResultData AWS API Documentation
2008
+ #
2009
+ class ResultData < Struct.new(
2010
+ :document,
2011
+ :relevance_score,
2012
+ :result_id)
2013
+ SENSITIVE = []
2014
+ include Aws::Structure
2015
+ end
2016
+
2017
+ # @note When making an API call, you may pass SearchContentRequest
2018
+ # data as a hash:
2019
+ #
2020
+ # {
2021
+ # knowledge_base_id: "UuidOrArn", # required
2022
+ # max_results: 1,
2023
+ # next_token: "NextToken",
2024
+ # search_expression: { # required
2025
+ # filters: [ # required
2026
+ # {
2027
+ # field: "NAME", # required, accepts NAME
2028
+ # operator: "EQUALS", # required, accepts EQUALS
2029
+ # value: "NonEmptyString", # required
2030
+ # },
2031
+ # ],
2032
+ # },
2033
+ # }
2034
+ #
2035
+ # @!attribute [rw] knowledge_base_id
2036
+ # The the identifier of the knowledge base. Can be either the ID or
2037
+ # the ARN. URLs cannot contain the ARN.
2038
+ # @return [String]
2039
+ #
2040
+ # @!attribute [rw] max_results
2041
+ # The maximum number of results to return per page.
2042
+ # @return [Integer]
2043
+ #
2044
+ # @!attribute [rw] next_token
2045
+ # The token for the next set of results. Use the value returned in the
2046
+ # previous response in the next request to retrieve the next set of
2047
+ # results.
2048
+ # @return [String]
2049
+ #
2050
+ # @!attribute [rw] search_expression
2051
+ # The search expression to filter results.
2052
+ # @return [Types::SearchExpression]
2053
+ #
2054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchContentRequest AWS API Documentation
2055
+ #
2056
+ class SearchContentRequest < Struct.new(
2057
+ :knowledge_base_id,
2058
+ :max_results,
2059
+ :next_token,
2060
+ :search_expression)
2061
+ SENSITIVE = []
2062
+ include Aws::Structure
2063
+ end
2064
+
2065
+ # @!attribute [rw] content_summaries
2066
+ # Summary information about the content.
2067
+ # @return [Array<Types::ContentSummary>]
2068
+ #
2069
+ # @!attribute [rw] next_token
2070
+ # If there are additional results, this is the token for the next set
2071
+ # of results.
2072
+ # @return [String]
2073
+ #
2074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchContentResponse AWS API Documentation
2075
+ #
2076
+ class SearchContentResponse < Struct.new(
2077
+ :content_summaries,
2078
+ :next_token)
2079
+ SENSITIVE = []
2080
+ include Aws::Structure
2081
+ end
2082
+
2083
+ # The search expression.
2084
+ #
2085
+ # @note When making an API call, you may pass SearchExpression
2086
+ # data as a hash:
2087
+ #
2088
+ # {
2089
+ # filters: [ # required
2090
+ # {
2091
+ # field: "NAME", # required, accepts NAME
2092
+ # operator: "EQUALS", # required, accepts EQUALS
2093
+ # value: "NonEmptyString", # required
2094
+ # },
2095
+ # ],
2096
+ # }
2097
+ #
2098
+ # @!attribute [rw] filters
2099
+ # The search expression filters.
2100
+ # @return [Array<Types::Filter>]
2101
+ #
2102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchExpression AWS API Documentation
2103
+ #
2104
+ class SearchExpression < Struct.new(
2105
+ :filters)
2106
+ SENSITIVE = []
2107
+ include Aws::Structure
2108
+ end
2109
+
2110
+ # @note When making an API call, you may pass SearchSessionsRequest
2111
+ # data as a hash:
2112
+ #
2113
+ # {
2114
+ # assistant_id: "UuidOrArn", # required
2115
+ # max_results: 1,
2116
+ # next_token: "NextToken",
2117
+ # search_expression: { # required
2118
+ # filters: [ # required
2119
+ # {
2120
+ # field: "NAME", # required, accepts NAME
2121
+ # operator: "EQUALS", # required, accepts EQUALS
2122
+ # value: "NonEmptyString", # required
2123
+ # },
2124
+ # ],
2125
+ # },
2126
+ # }
2127
+ #
2128
+ # @!attribute [rw] assistant_id
2129
+ # The identifier of the Wisdom assistant. Can be either the ID or the
2130
+ # ARN. URLs cannot contain the ARN.
2131
+ # @return [String]
2132
+ #
2133
+ # @!attribute [rw] max_results
2134
+ # The maximum number of results to return per page.
2135
+ # @return [Integer]
2136
+ #
2137
+ # @!attribute [rw] next_token
2138
+ # The token for the next set of results. Use the value returned in the
2139
+ # previous response in the next request to retrieve the next set of
2140
+ # results.
2141
+ # @return [String]
2142
+ #
2143
+ # @!attribute [rw] search_expression
2144
+ # The search expression to filter results.
2145
+ # @return [Types::SearchExpression]
2146
+ #
2147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessionsRequest AWS API Documentation
2148
+ #
2149
+ class SearchSessionsRequest < Struct.new(
2150
+ :assistant_id,
2151
+ :max_results,
2152
+ :next_token,
2153
+ :search_expression)
2154
+ SENSITIVE = []
2155
+ include Aws::Structure
2156
+ end
2157
+
2158
+ # @!attribute [rw] next_token
2159
+ # If there are additional results, this is the token for the next set
2160
+ # of results.
2161
+ # @return [String]
2162
+ #
2163
+ # @!attribute [rw] session_summaries
2164
+ # Summary information about the sessions.
2165
+ # @return [Array<Types::SessionSummary>]
2166
+ #
2167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessionsResponse AWS API Documentation
2168
+ #
2169
+ class SearchSessionsResponse < Struct.new(
2170
+ :next_token,
2171
+ :session_summaries)
2172
+ SENSITIVE = []
2173
+ include Aws::Structure
2174
+ end
2175
+
2176
+ # The KMS key used for encryption.
2177
+ #
2178
+ # @note When making an API call, you may pass ServerSideEncryptionConfiguration
2179
+ # data as a hash:
2180
+ #
2181
+ # {
2182
+ # kms_key_id: "NonEmptyString",
2183
+ # }
2184
+ #
2185
+ # @!attribute [rw] kms_key_id
2186
+ # The KMS key. For information about valid ID values, see [Key
2187
+ # identifiers (KeyId)][1] in the *AWS Key Management Service Developer
2188
+ # Guide*.
2189
+ #
2190
+ #
2191
+ #
2192
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
2193
+ # @return [String]
2194
+ #
2195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ServerSideEncryptionConfiguration AWS API Documentation
2196
+ #
2197
+ class ServerSideEncryptionConfiguration < Struct.new(
2198
+ :kms_key_id)
2199
+ SENSITIVE = []
2200
+ include Aws::Structure
2201
+ end
2202
+
2203
+ # You've exceeded your service quota. To perform the requested action,
2204
+ # remove some of the relevant resources, or use service quotas to
2205
+ # request a service quota increase.
2206
+ #
2207
+ # @!attribute [rw] message
2208
+ # @return [String]
2209
+ #
2210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ServiceQuotaExceededException AWS API Documentation
2211
+ #
2212
+ class ServiceQuotaExceededException < Struct.new(
2213
+ :message)
2214
+ SENSITIVE = []
2215
+ include Aws::Structure
2216
+ end
2217
+
2218
+ # Information about the session.
2219
+ #
2220
+ # @!attribute [rw] description
2221
+ # The description of the session.
2222
+ # @return [String]
2223
+ #
2224
+ # @!attribute [rw] name
2225
+ # The name of the session.
2226
+ # @return [String]
2227
+ #
2228
+ # @!attribute [rw] session_arn
2229
+ # The Amazon Resource Name (ARN) of the session.
2230
+ # @return [String]
2231
+ #
2232
+ # @!attribute [rw] session_id
2233
+ # The identifier of the session.
2234
+ # @return [String]
2235
+ #
2236
+ # @!attribute [rw] tags
2237
+ # The tags used to organize, track, or control access for this
2238
+ # resource.
2239
+ # @return [Hash<String,String>]
2240
+ #
2241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SessionData AWS API Documentation
2242
+ #
2243
+ class SessionData < Struct.new(
2244
+ :description,
2245
+ :name,
2246
+ :session_arn,
2247
+ :session_id,
2248
+ :tags)
2249
+ SENSITIVE = []
2250
+ include Aws::Structure
2251
+ end
2252
+
2253
+ # Summary information about the session.
2254
+ #
2255
+ # @!attribute [rw] assistant_arn
2256
+ # The Amazon Resource Name (ARN) of the Wisdom assistant
2257
+ # @return [String]
2258
+ #
2259
+ # @!attribute [rw] assistant_id
2260
+ # The identifier of the Wisdom assistant.
2261
+ # @return [String]
2262
+ #
2263
+ # @!attribute [rw] session_arn
2264
+ # The Amazon Resource Name (ARN) of the session.
2265
+ # @return [String]
2266
+ #
2267
+ # @!attribute [rw] session_id
2268
+ # The identifier of the session.
2269
+ # @return [String]
2270
+ #
2271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SessionSummary AWS API Documentation
2272
+ #
2273
+ class SessionSummary < Struct.new(
2274
+ :assistant_arn,
2275
+ :assistant_id,
2276
+ :session_arn,
2277
+ :session_id)
2278
+ SENSITIVE = []
2279
+ include Aws::Structure
2280
+ end
2281
+
2282
+ # Configuration information about the external data source.
2283
+ #
2284
+ # @note SourceConfiguration is a union - when making an API calls you must set exactly one of the members.
2285
+ #
2286
+ # @note SourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SourceConfiguration corresponding to the set member.
2287
+ #
2288
+ # @!attribute [rw] app_integrations
2289
+ # Configuration information for Amazon AppIntegrations to
2290
+ # automatically ingest content.
2291
+ # @return [Types::AppIntegrationsConfiguration]
2292
+ #
2293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SourceConfiguration AWS API Documentation
2294
+ #
2295
+ class SourceConfiguration < Struct.new(
2296
+ :app_integrations,
2297
+ :unknown)
2298
+ SENSITIVE = []
2299
+ include Aws::Structure
2300
+ include Aws::Structure::Union
2301
+
2302
+ class AppIntegrations < SourceConfiguration; end
2303
+ class Unknown < SourceConfiguration; end
2304
+ end
2305
+
2306
+ # @note When making an API call, you may pass StartContentUploadRequest
2307
+ # data as a hash:
2308
+ #
2309
+ # {
2310
+ # content_type: "ContentType", # required
2311
+ # knowledge_base_id: "UuidOrArn", # required
2312
+ # }
2313
+ #
2314
+ # @!attribute [rw] content_type
2315
+ # The type of content to upload.
2316
+ # @return [String]
2317
+ #
2318
+ # @!attribute [rw] knowledge_base_id
2319
+ # The the identifier of the knowledge base. Can be either the ID or
2320
+ # the ARN. URLs cannot contain the ARN.
2321
+ # @return [String]
2322
+ #
2323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUploadRequest AWS API Documentation
2324
+ #
2325
+ class StartContentUploadRequest < Struct.new(
2326
+ :content_type,
2327
+ :knowledge_base_id)
2328
+ SENSITIVE = []
2329
+ include Aws::Structure
2330
+ end
2331
+
2332
+ # @!attribute [rw] headers_to_include
2333
+ # The headers to include in the upload.
2334
+ # @return [Hash<String,String>]
2335
+ #
2336
+ # @!attribute [rw] upload_id
2337
+ # The identifier of the upload.
2338
+ # @return [String]
2339
+ #
2340
+ # @!attribute [rw] url
2341
+ # The URL of the upload.
2342
+ # @return [String]
2343
+ #
2344
+ # @!attribute [rw] url_expiry
2345
+ # The expiration time of the URL as an epoch timestamp.
2346
+ # @return [Time]
2347
+ #
2348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUploadResponse AWS API Documentation
2349
+ #
2350
+ class StartContentUploadResponse < Struct.new(
2351
+ :headers_to_include,
2352
+ :upload_id,
2353
+ :url,
2354
+ :url_expiry)
2355
+ SENSITIVE = [:url]
2356
+ include Aws::Structure
2357
+ end
2358
+
2359
+ # @note When making an API call, you may pass TagResourceRequest
2360
+ # data as a hash:
2361
+ #
2362
+ # {
2363
+ # resource_arn: "Arn", # required
2364
+ # tags: { # required
2365
+ # "TagKey" => "TagValue",
2366
+ # },
2367
+ # }
2368
+ #
2369
+ # @!attribute [rw] resource_arn
2370
+ # The Amazon Resource Name (ARN) of the resource.
2371
+ # @return [String]
2372
+ #
2373
+ # @!attribute [rw] tags
2374
+ # The tags used to organize, track, or control access for this
2375
+ # resource.
2376
+ # @return [Hash<String,String>]
2377
+ #
2378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TagResourceRequest AWS API Documentation
2379
+ #
2380
+ class TagResourceRequest < Struct.new(
2381
+ :resource_arn,
2382
+ :tags)
2383
+ SENSITIVE = []
2384
+ include Aws::Structure
2385
+ end
2386
+
2387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TagResourceResponse AWS API Documentation
2388
+ #
2389
+ class TagResourceResponse < Aws::EmptyStructure; end
2390
+
2391
+ # Amazon Connect Wisdom throws this exception if you have too many tags
2392
+ # in your tag set.
2393
+ #
2394
+ # @!attribute [rw] message
2395
+ # @return [String]
2396
+ #
2397
+ # @!attribute [rw] resource_name
2398
+ # The specified resource name.
2399
+ # @return [String]
2400
+ #
2401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TooManyTagsException AWS API Documentation
2402
+ #
2403
+ class TooManyTagsException < Struct.new(
2404
+ :message,
2405
+ :resource_name)
2406
+ SENSITIVE = []
2407
+ include Aws::Structure
2408
+ end
2409
+
2410
+ # @note When making an API call, you may pass UntagResourceRequest
2411
+ # data as a hash:
2412
+ #
2413
+ # {
2414
+ # resource_arn: "Arn", # required
2415
+ # tag_keys: ["TagKey"], # required
2416
+ # }
2417
+ #
2418
+ # @!attribute [rw] resource_arn
2419
+ # The Amazon Resource Name (ARN) of the resource.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] tag_keys
2423
+ # The tag keys.
2424
+ # @return [Array<String>]
2425
+ #
2426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UntagResourceRequest AWS API Documentation
2427
+ #
2428
+ class UntagResourceRequest < Struct.new(
2429
+ :resource_arn,
2430
+ :tag_keys)
2431
+ SENSITIVE = []
2432
+ include Aws::Structure
2433
+ end
2434
+
2435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UntagResourceResponse AWS API Documentation
2436
+ #
2437
+ class UntagResourceResponse < Aws::EmptyStructure; end
2438
+
2439
+ # @note When making an API call, you may pass UpdateContentRequest
2440
+ # data as a hash:
2441
+ #
2442
+ # {
2443
+ # content_id: "UuidOrArn", # required
2444
+ # knowledge_base_id: "UuidOrArn", # required
2445
+ # metadata: {
2446
+ # "NonEmptyString" => "NonEmptyString",
2447
+ # },
2448
+ # override_link_out_uri: "Uri",
2449
+ # remove_override_link_out_uri: false,
2450
+ # revision_id: "NonEmptyString",
2451
+ # title: "ContentTitle",
2452
+ # upload_id: "NonEmptyString",
2453
+ # }
2454
+ #
2455
+ # @!attribute [rw] content_id
2456
+ # The identifier of the content. Can be either the ID or the ARN. URLs
2457
+ # cannot contain the ARN.
2458
+ # @return [String]
2459
+ #
2460
+ # @!attribute [rw] knowledge_base_id
2461
+ # The the identifier of the knowledge base. Can be either the ID or
2462
+ # the ARN
2463
+ # @return [String]
2464
+ #
2465
+ # @!attribute [rw] metadata
2466
+ # A key/value map to store attributes without affecting tagging or
2467
+ # recommendations. For example, when synchronizing data between an
2468
+ # external system and Wisdom, you can store an external version
2469
+ # identifier as metadata to utilize for determining drift.
2470
+ # @return [Hash<String,String>]
2471
+ #
2472
+ # @!attribute [rw] override_link_out_uri
2473
+ # The URI for the article. If the knowledge base has a templateUri,
2474
+ # setting this argument overrides it for this piece of content. To
2475
+ # remove an existing `overrideLinkOurUri`, exclude this argument and
2476
+ # set `removeOverrideLinkOutUri` to true.
2477
+ # @return [String]
2478
+ #
2479
+ # @!attribute [rw] remove_override_link_out_uri
2480
+ # Unset the existing `overrideLinkOutUri` if it exists.
2481
+ # @return [Boolean]
2482
+ #
2483
+ # @!attribute [rw] revision_id
2484
+ # The `revisionId` of the content resource to update, taken from an
2485
+ # earlier call to `GetContent`, `GetContentSummary`, `SearchContent`,
2486
+ # or `ListContents`. If included, this argument acts as an optimistic
2487
+ # lock to ensure content was not modified since it was last read. If
2488
+ # it has been modified, this API throws a
2489
+ # `PreconditionFailedException`.
2490
+ # @return [String]
2491
+ #
2492
+ # @!attribute [rw] title
2493
+ # The title of the content.
2494
+ # @return [String]
2495
+ #
2496
+ # @!attribute [rw] upload_id
2497
+ # A pointer to the uploaded asset. This value is returned by
2498
+ # [StartContentUpload][1].
2499
+ #
2500
+ #
2501
+ #
2502
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
2503
+ # @return [String]
2504
+ #
2505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateContentRequest AWS API Documentation
2506
+ #
2507
+ class UpdateContentRequest < Struct.new(
2508
+ :content_id,
2509
+ :knowledge_base_id,
2510
+ :metadata,
2511
+ :override_link_out_uri,
2512
+ :remove_override_link_out_uri,
2513
+ :revision_id,
2514
+ :title,
2515
+ :upload_id)
2516
+ SENSITIVE = []
2517
+ include Aws::Structure
2518
+ end
2519
+
2520
+ # @!attribute [rw] content
2521
+ # The content.
2522
+ # @return [Types::ContentData]
2523
+ #
2524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateContentResponse AWS API Documentation
2525
+ #
2526
+ class UpdateContentResponse < Struct.new(
2527
+ :content)
2528
+ SENSITIVE = []
2529
+ include Aws::Structure
2530
+ end
2531
+
2532
+ # @note When making an API call, you may pass UpdateKnowledgeBaseTemplateUriRequest
2533
+ # data as a hash:
2534
+ #
2535
+ # {
2536
+ # knowledge_base_id: "UuidOrArn", # required
2537
+ # template_uri: "Uri", # required
2538
+ # }
2539
+ #
2540
+ # @!attribute [rw] knowledge_base_id
2541
+ # The the identifier of the knowledge base. Can be either the ID or
2542
+ # the ARN. URLs cannot contain the ARN.
2543
+ # @return [String]
2544
+ #
2545
+ # @!attribute [rw] template_uri
2546
+ # The template URI to update.
2547
+ # @return [String]
2548
+ #
2549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateKnowledgeBaseTemplateUriRequest AWS API Documentation
2550
+ #
2551
+ class UpdateKnowledgeBaseTemplateUriRequest < Struct.new(
2552
+ :knowledge_base_id,
2553
+ :template_uri)
2554
+ SENSITIVE = []
2555
+ include Aws::Structure
2556
+ end
2557
+
2558
+ # @!attribute [rw] knowledge_base
2559
+ # The knowledge base to update.
2560
+ # @return [Types::KnowledgeBaseData]
2561
+ #
2562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateKnowledgeBaseTemplateUriResponse AWS API Documentation
2563
+ #
2564
+ class UpdateKnowledgeBaseTemplateUriResponse < Struct.new(
2565
+ :knowledge_base)
2566
+ SENSITIVE = []
2567
+ include Aws::Structure
2568
+ end
2569
+
2570
+ # The input fails to satisfy the constraints specified by an AWS
2571
+ # service.
2572
+ #
2573
+ # @!attribute [rw] message
2574
+ # @return [String]
2575
+ #
2576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ValidationException AWS API Documentation
2577
+ #
2578
+ class ValidationException < Struct.new(
2579
+ :message)
2580
+ SENSITIVE = []
2581
+ include Aws::Structure
2582
+ end
2583
+
2584
+ end
2585
+ end