aws-sdk-qconnect 1.22.0 → 1.24.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.
@@ -471,6 +471,74 @@ module Aws::QConnect
471
471
  include Aws::Structure
472
472
  end
473
473
 
474
+ # @!attribute [rw] knowledge_base_id
475
+ # The identifier of the knowledge base. Can be either the ID or the
476
+ # ARN. URLs cannot contain the ARN.
477
+ # @return [String]
478
+ #
479
+ # @!attribute [rw] message_template_id
480
+ # The identifier of the message template. Can be either the ID or the
481
+ # ARN. It cannot contain any qualifier.
482
+ # @return [String]
483
+ #
484
+ # @!attribute [rw] version_number
485
+ # The version number of the message template version to activate.
486
+ # @return [Integer]
487
+ #
488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ActivateMessageTemplateRequest AWS API Documentation
489
+ #
490
+ class ActivateMessageTemplateRequest < Struct.new(
491
+ :knowledge_base_id,
492
+ :message_template_id,
493
+ :version_number)
494
+ SENSITIVE = []
495
+ include Aws::Structure
496
+ end
497
+
498
+ # @!attribute [rw] message_template_arn
499
+ # The Amazon Resource Name (ARN) of the message template.
500
+ # @return [String]
501
+ #
502
+ # @!attribute [rw] message_template_id
503
+ # The identifier of the message template.
504
+ # @return [String]
505
+ #
506
+ # @!attribute [rw] version_number
507
+ # The version number of the message template version that is
508
+ # activated.
509
+ # @return [Integer]
510
+ #
511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ActivateMessageTemplateResponse AWS API Documentation
512
+ #
513
+ class ActivateMessageTemplateResponse < Struct.new(
514
+ :message_template_arn,
515
+ :message_template_id,
516
+ :version_number)
517
+ SENSITIVE = []
518
+ include Aws::Structure
519
+ end
520
+
521
+ # Information about an agent.
522
+ #
523
+ # @!attribute [rw] first_name
524
+ # The agent’s first name as entered in their Amazon Connect user
525
+ # account.
526
+ # @return [String]
527
+ #
528
+ # @!attribute [rw] last_name
529
+ # The agent’s last name as entered in their Amazon Connect user
530
+ # account.
531
+ # @return [String]
532
+ #
533
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AgentAttributes AWS API Documentation
534
+ #
535
+ class AgentAttributes < Struct.new(
536
+ :first_name,
537
+ :last_name)
538
+ SENSITIVE = [:first_name, :last_name]
539
+ include Aws::Structure
540
+ end
541
+
474
542
  # Content association data for a [step-by-step guide][1].
475
543
  #
476
544
  #
@@ -1502,9 +1570,9 @@ module Aws::QConnect
1502
1570
  #
1503
1571
  # @!attribute [rw] client_token
1504
1572
  # A unique, case-sensitive identifier that you provide to ensure the
1505
- # idempotency of the request. If not provided, the AWS SDK populates
1506
- # this field. For more information about idempotency, see [Making
1507
- # retries safe with idempotent APIs][1].
1573
+ # idempotency of the request. If not provided, the Amazon Web Services
1574
+ # SDK populates this field. For more information about idempotency,
1575
+ # see [Making retries safe with idempotent APIs][1]..
1508
1576
  #
1509
1577
  # **A suitable default value is auto-generated.** You should normally
1510
1578
  # not need to pass this option.
@@ -1577,9 +1645,9 @@ module Aws::QConnect
1577
1645
  #
1578
1646
  # @!attribute [rw] client_token
1579
1647
  # A unique, case-sensitive identifier that you provide to ensure the
1580
- # idempotency of the request. If not provided, the AWS SDK populates
1581
- # this field. For more information about idempotency, see [Making
1582
- # retries safe with idempotent APIs][1].
1648
+ # idempotency of the request. If not provided, the Amazon Web Services
1649
+ # SDK populates this field. For more information about idempotency,
1650
+ # see [Making retries safe with idempotent APIs][1]..
1583
1651
  #
1584
1652
  # **A suitable default value is auto-generated.** You should normally
1585
1653
  # not need to pass this option.
@@ -1638,9 +1706,9 @@ module Aws::QConnect
1638
1706
  #
1639
1707
  # @!attribute [rw] client_token
1640
1708
  # A unique, case-sensitive identifier that you provide to ensure the
1641
- # idempotency of the request. If not provided, the AWS SDK populates
1642
- # this field. For more information about idempotency, see [Making
1643
- # retries safe with idempotent APIs][1].
1709
+ # idempotency of the request. If not provided, the Amazon Web Services
1710
+ # SDK populates this field. For more information about idempotency,
1711
+ # see [Making retries safe with idempotent APIs][1]..
1644
1712
  #
1645
1713
  # **A suitable default value is auto-generated.** You should normally
1646
1714
  # not need to pass this option.
@@ -1725,16 +1793,16 @@ module Aws::QConnect
1725
1793
  #
1726
1794
  # @!attribute [rw] client_token
1727
1795
  # A unique, case-sensitive identifier that you provide to ensure the
1728
- # idempotency of the request. If not provided, the AWS SDK populates
1729
- # this field. For more information about idempotency, see [Making
1730
- # retries safe with idempotent APIs][1].
1796
+ # idempotency of the request. If not provided, the Amazon Web Services
1797
+ # SDK populates this field. For more information about idempotency,
1798
+ # see [Making retries safe with idempotent APIs][1]..
1731
1799
  #
1732
1800
  # **A suitable default value is auto-generated.** You should normally
1733
1801
  # not need to pass this option.
1734
1802
  #
1735
1803
  #
1736
1804
  #
1737
- # [1]: http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1805
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1738
1806
  # @return [String]
1739
1807
  #
1740
1808
  # @!attribute [rw] modified_time
@@ -1793,7 +1861,7 @@ module Aws::QConnect
1793
1861
  #
1794
1862
  #
1795
1863
  #
1796
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1864
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1797
1865
  # @return [String]
1798
1866
  #
1799
1867
  # @!attribute [rw] tags
@@ -1836,7 +1904,7 @@ module Aws::QConnect
1836
1904
  #
1837
1905
  #
1838
1906
  #
1839
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1907
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1840
1908
  # @return [String]
1841
1909
  #
1842
1910
  # @!attribute [rw] description
@@ -1921,7 +1989,7 @@ module Aws::QConnect
1921
1989
  #
1922
1990
  #
1923
1991
  #
1924
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1992
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1925
1993
  # @return [String]
1926
1994
  #
1927
1995
  # @!attribute [rw] content_id
@@ -1974,7 +2042,7 @@ module Aws::QConnect
1974
2042
  #
1975
2043
  #
1976
2044
  #
1977
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2045
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1978
2046
  # @return [String]
1979
2047
  #
1980
2048
  # @!attribute [rw] knowledge_base_id
@@ -2064,7 +2132,7 @@ module Aws::QConnect
2064
2132
  #
2065
2133
  #
2066
2134
  #
2067
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2135
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2068
2136
  # @return [String]
2069
2137
  #
2070
2138
  # @!attribute [rw] description
@@ -2106,7 +2174,7 @@ module Aws::QConnect
2106
2174
  #
2107
2175
  # @!attribute [rw] source_configuration
2108
2176
  # The source of the knowledge base content. Only set this argument for
2109
- # EXTERNAL knowledge bases.
2177
+ # EXTERNAL or Managed knowledge bases.
2110
2178
  # @return [Types::SourceConfiguration]
2111
2179
  #
2112
2180
  # @!attribute [rw] tags
@@ -2146,6 +2214,197 @@ module Aws::QConnect
2146
2214
  include Aws::Structure
2147
2215
  end
2148
2216
 
2217
+ # @!attribute [rw] body
2218
+ # The body of the attachment file being uploaded. It should be encoded
2219
+ # using base64 encoding.
2220
+ # @return [String]
2221
+ #
2222
+ # @!attribute [rw] client_token
2223
+ # A unique, case-sensitive identifier that you provide to ensure the
2224
+ # idempotency of the request. If not provided, the Amazon Web Services
2225
+ # SDK populates this field. For more information about idempotency,
2226
+ # see [Making retries safe with idempotent APIs][1].
2227
+ #
2228
+ #
2229
+ #
2230
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2231
+ # @return [String]
2232
+ #
2233
+ # @!attribute [rw] content_disposition
2234
+ # The presentation information for the attachment file.
2235
+ # @return [String]
2236
+ #
2237
+ # @!attribute [rw] knowledge_base_id
2238
+ # The identifier of the knowledge base. Can be either the ID or the
2239
+ # ARN. URLs cannot contain the ARN.
2240
+ # @return [String]
2241
+ #
2242
+ # @!attribute [rw] message_template_id
2243
+ # The identifier of the message template. Can be either the ID or the
2244
+ # ARN. It cannot contain any qualifier.
2245
+ # @return [String]
2246
+ #
2247
+ # @!attribute [rw] name
2248
+ # The name of the attachment file being uploaded. The name should
2249
+ # include the file extension.
2250
+ # @return [String]
2251
+ #
2252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateAttachmentRequest AWS API Documentation
2253
+ #
2254
+ class CreateMessageTemplateAttachmentRequest < Struct.new(
2255
+ :body,
2256
+ :client_token,
2257
+ :content_disposition,
2258
+ :knowledge_base_id,
2259
+ :message_template_id,
2260
+ :name)
2261
+ SENSITIVE = [:body, :name]
2262
+ include Aws::Structure
2263
+ end
2264
+
2265
+ # @!attribute [rw] attachment
2266
+ # The message template attachment.
2267
+ # @return [Types::MessageTemplateAttachment]
2268
+ #
2269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateAttachmentResponse AWS API Documentation
2270
+ #
2271
+ class CreateMessageTemplateAttachmentResponse < Struct.new(
2272
+ :attachment)
2273
+ SENSITIVE = []
2274
+ include Aws::Structure
2275
+ end
2276
+
2277
+ # @!attribute [rw] channel_subtype
2278
+ # The channel subtype this message template applies to.
2279
+ # @return [String]
2280
+ #
2281
+ # @!attribute [rw] client_token
2282
+ # A unique, case-sensitive identifier that you provide to ensure the
2283
+ # idempotency of the request. If not provided, the Amazon Web Services
2284
+ # SDK populates this field. For more information about idempotency,
2285
+ # see [Making retries safe with idempotent APIs][1].
2286
+ #
2287
+ # **A suitable default value is auto-generated.** You should normally
2288
+ # not need to pass this option.
2289
+ #
2290
+ #
2291
+ #
2292
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] content
2296
+ # The content of the message template.
2297
+ # @return [Types::MessageTemplateContentProvider]
2298
+ #
2299
+ # @!attribute [rw] default_attributes
2300
+ # An object that specifies the default values to use for variables in
2301
+ # the message template. This object contains different categories of
2302
+ # key-value pairs. Each key defines a variable or placeholder in the
2303
+ # message template. The corresponding value defines the default value
2304
+ # for that variable.
2305
+ # @return [Types::MessageTemplateAttributes]
2306
+ #
2307
+ # @!attribute [rw] description
2308
+ # The description of the message template.
2309
+ # @return [String]
2310
+ #
2311
+ # @!attribute [rw] grouping_configuration
2312
+ # The configuration information of the grouping of Amazon Q in Connect
2313
+ # users.
2314
+ # @return [Types::GroupingConfiguration]
2315
+ #
2316
+ # @!attribute [rw] knowledge_base_id
2317
+ # The identifier of the knowledge base. Can be either the ID or the
2318
+ # ARN. URLs cannot contain the ARN.
2319
+ # @return [String]
2320
+ #
2321
+ # @!attribute [rw] language
2322
+ # The language code value for the language in which the quick response
2323
+ # is written. The supported language codes include `de_DE`, `en_US`,
2324
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
2325
+ # `zh_CN`, `zh_TW`
2326
+ # @return [String]
2327
+ #
2328
+ # @!attribute [rw] name
2329
+ # The name of the message template.
2330
+ # @return [String]
2331
+ #
2332
+ # @!attribute [rw] tags
2333
+ # The tags used to organize, track, or control access for this
2334
+ # resource.
2335
+ # @return [Hash<String,String>]
2336
+ #
2337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateRequest AWS API Documentation
2338
+ #
2339
+ class CreateMessageTemplateRequest < Struct.new(
2340
+ :channel_subtype,
2341
+ :client_token,
2342
+ :content,
2343
+ :default_attributes,
2344
+ :description,
2345
+ :grouping_configuration,
2346
+ :knowledge_base_id,
2347
+ :language,
2348
+ :name,
2349
+ :tags)
2350
+ SENSITIVE = []
2351
+ include Aws::Structure
2352
+ end
2353
+
2354
+ # @!attribute [rw] message_template
2355
+ # The message template.
2356
+ # @return [Types::MessageTemplateData]
2357
+ #
2358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateResponse AWS API Documentation
2359
+ #
2360
+ class CreateMessageTemplateResponse < Struct.new(
2361
+ :message_template)
2362
+ SENSITIVE = []
2363
+ include Aws::Structure
2364
+ end
2365
+
2366
+ # @!attribute [rw] knowledge_base_id
2367
+ # The identifier of the knowledge base. Can be either the ID or the
2368
+ # ARN. URLs cannot contain the ARN.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] message_template_content_sha_256
2372
+ # The checksum value of the message template content that is
2373
+ # referenced by the `$LATEST` qualifier. It can be returned in
2374
+ # `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
2375
+ # calculated by content, language, `defaultAttributes` and
2376
+ # `Attachments` of the message template. If not supplied, the message
2377
+ # template version will be created based on the message template
2378
+ # content that is referenced by the `$LATEST` qualifier by default.
2379
+ # @return [String]
2380
+ #
2381
+ # @!attribute [rw] message_template_id
2382
+ # The identifier of the message template. Can be either the ID or the
2383
+ # ARN. It cannot contain any qualifier.
2384
+ # @return [String]
2385
+ #
2386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateVersionRequest AWS API Documentation
2387
+ #
2388
+ class CreateMessageTemplateVersionRequest < Struct.new(
2389
+ :knowledge_base_id,
2390
+ :message_template_content_sha_256,
2391
+ :message_template_id)
2392
+ SENSITIVE = []
2393
+ include Aws::Structure
2394
+ end
2395
+
2396
+ # @!attribute [rw] message_template
2397
+ # The message template.
2398
+ # @return [Types::ExtendedMessageTemplateData]
2399
+ #
2400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateVersionResponse AWS API Documentation
2401
+ #
2402
+ class CreateMessageTemplateVersionResponse < Struct.new(
2403
+ :message_template)
2404
+ SENSITIVE = []
2405
+ include Aws::Structure
2406
+ end
2407
+
2149
2408
  # @!attribute [rw] channels
2150
2409
  # The Amazon Connect channels this quick response applies to.
2151
2410
  # @return [Array<String>]
@@ -2161,7 +2420,7 @@ module Aws::QConnect
2161
2420
  #
2162
2421
  #
2163
2422
  #
2164
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2423
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2165
2424
  # @return [String]
2166
2425
  #
2167
2426
  # @!attribute [rw] content
@@ -2270,7 +2529,7 @@ module Aws::QConnect
2270
2529
  #
2271
2530
  #
2272
2531
  #
2273
- # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2532
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2274
2533
  # @return [String]
2275
2534
  #
2276
2535
  # @!attribute [rw] description
@@ -2316,91 +2575,440 @@ module Aws::QConnect
2316
2575
  include Aws::Structure
2317
2576
  end
2318
2577
 
2319
- # Details about the data.
2578
+ # The customer profile attributes that are used with the message
2579
+ # template.
2320
2580
  #
2321
- # @note DataDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataDetails corresponding to the set member.
2581
+ # @!attribute [rw] account_number
2582
+ # A unique account number that you have given to the customer.
2583
+ # @return [String]
2322
2584
  #
2323
- # @!attribute [rw] content_data
2324
- # Details about the content data.
2325
- # @return [Types::ContentDataDetails]
2585
+ # @!attribute [rw] additional_information
2586
+ # Any additional information relevant to the customer's profile.
2587
+ # @return [String]
2326
2588
  #
2327
- # @!attribute [rw] generative_data
2328
- # Details about the generative data.
2329
- # @return [Types::GenerativeDataDetails]
2589
+ # @!attribute [rw] address1
2590
+ # The first line of a customer address.
2591
+ # @return [String]
2330
2592
  #
2331
- # @!attribute [rw] intent_detected_data
2332
- # Details about the intent data.
2333
- # @return [Types::IntentDetectedDataDetails]
2593
+ # @!attribute [rw] address2
2594
+ # The second line of a customer address.
2595
+ # @return [String]
2334
2596
  #
2335
- # @!attribute [rw] source_content_data
2336
- # Details about the content data.
2337
- # @return [Types::SourceContentDataDetails]
2597
+ # @!attribute [rw] address3
2598
+ # The third line of a customer address.
2599
+ # @return [String]
2338
2600
  #
2339
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataDetails AWS API Documentation
2601
+ # @!attribute [rw] address4
2602
+ # The fourth line of a customer address.
2603
+ # @return [String]
2340
2604
  #
2341
- class DataDetails < Struct.new(
2342
- :content_data,
2343
- :generative_data,
2344
- :intent_detected_data,
2345
- :source_content_data,
2346
- :unknown)
2347
- SENSITIVE = []
2348
- include Aws::Structure
2349
- include Aws::Structure::Union
2350
-
2351
- class ContentData < DataDetails; end
2352
- class GenerativeData < DataDetails; end
2353
- class IntentDetectedData < DataDetails; end
2354
- class SourceContentData < DataDetails; end
2355
- class Unknown < DataDetails; end
2356
- end
2357
-
2358
- # Reference data.
2605
+ # @!attribute [rw] billing_address_1
2606
+ # The first line of a customer’s billing address.
2607
+ # @return [String]
2359
2608
  #
2360
- # @note DataReference is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataReference corresponding to the set member.
2609
+ # @!attribute [rw] billing_address_2
2610
+ # The second line of a customer’s billing address.
2611
+ # @return [String]
2361
2612
  #
2362
- # @!attribute [rw] content_reference
2363
- # Reference information about the content.
2364
- # @return [Types::ContentReference]
2613
+ # @!attribute [rw] billing_address_3
2614
+ # The third line of a customer’s billing address.
2615
+ # @return [String]
2365
2616
  #
2366
- # @!attribute [rw] generative_reference
2367
- # Reference information about the generative content.
2368
- # @return [Types::GenerativeReference]
2617
+ # @!attribute [rw] billing_address_4
2618
+ # The fourth line of a customer’s billing address.
2619
+ # @return [String]
2369
2620
  #
2370
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataReference AWS API Documentation
2621
+ # @!attribute [rw] billing_city
2622
+ # The city of a customer’s billing address.
2623
+ # @return [String]
2371
2624
  #
2372
- class DataReference < Struct.new(
2373
- :content_reference,
2374
- :generative_reference,
2375
- :unknown)
2376
- SENSITIVE = []
2377
- include Aws::Structure
2378
- include Aws::Structure::Union
2379
-
2380
- class ContentReference < DataReference; end
2381
- class GenerativeReference < DataReference; end
2382
- class Unknown < DataReference; end
2383
- end
2384
-
2385
- # Summary of the data.
2625
+ # @!attribute [rw] billing_country
2626
+ # The country of a customer’s billing address.
2627
+ # @return [String]
2386
2628
  #
2387
- # @!attribute [rw] details
2388
- # Details about the data.
2389
- # @return [Types::DataDetails]
2629
+ # @!attribute [rw] billing_county
2630
+ # The county of a customer’s billing address.
2631
+ # @return [String]
2390
2632
  #
2391
- # @!attribute [rw] reference
2392
- # Reference information about the content.
2393
- # @return [Types::DataReference]
2633
+ # @!attribute [rw] billing_postal_code
2634
+ # The postal code of a customer’s billing address.
2635
+ # @return [String]
2394
2636
  #
2395
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataSummary AWS API Documentation
2637
+ # @!attribute [rw] billing_province
2638
+ # The province of a customer’s billing address.
2639
+ # @return [String]
2396
2640
  #
2397
- class DataSummary < Struct.new(
2398
- :details,
2641
+ # @!attribute [rw] billing_state
2642
+ # The state of a customer’s billing address.
2643
+ # @return [String]
2644
+ #
2645
+ # @!attribute [rw] birth_date
2646
+ # The customer's birth date.
2647
+ # @return [String]
2648
+ #
2649
+ # @!attribute [rw] business_email_address
2650
+ # The customer's business email address.
2651
+ # @return [String]
2652
+ #
2653
+ # @!attribute [rw] business_name
2654
+ # The name of the customer's business.
2655
+ # @return [String]
2656
+ #
2657
+ # @!attribute [rw] business_phone_number
2658
+ # The customer's business phone number.
2659
+ # @return [String]
2660
+ #
2661
+ # @!attribute [rw] city
2662
+ # The city in which a customer lives.
2663
+ # @return [String]
2664
+ #
2665
+ # @!attribute [rw] country
2666
+ # The country in which a customer lives.
2667
+ # @return [String]
2668
+ #
2669
+ # @!attribute [rw] county
2670
+ # The county in which a customer lives.
2671
+ # @return [String]
2672
+ #
2673
+ # @!attribute [rw] custom
2674
+ # The custom attributes in customer profile attributes.
2675
+ # @return [Hash<String,String>]
2676
+ #
2677
+ # @!attribute [rw] email_address
2678
+ # The customer's email address, which has not been specified as a
2679
+ # personal or business address.
2680
+ # @return [String]
2681
+ #
2682
+ # @!attribute [rw] first_name
2683
+ # The customer's first name.
2684
+ # @return [String]
2685
+ #
2686
+ # @!attribute [rw] gender
2687
+ # The customer's gender.
2688
+ # @return [String]
2689
+ #
2690
+ # @!attribute [rw] home_phone_number
2691
+ # The customer's mobile phone number.
2692
+ # @return [String]
2693
+ #
2694
+ # @!attribute [rw] last_name
2695
+ # The customer's last name.
2696
+ # @return [String]
2697
+ #
2698
+ # @!attribute [rw] mailing_address_1
2699
+ # The first line of a customer’s mailing address.
2700
+ # @return [String]
2701
+ #
2702
+ # @!attribute [rw] mailing_address_2
2703
+ # The second line of a customer’s mailing address.
2704
+ # @return [String]
2705
+ #
2706
+ # @!attribute [rw] mailing_address_3
2707
+ # The third line of a customer’s mailing address.
2708
+ # @return [String]
2709
+ #
2710
+ # @!attribute [rw] mailing_address_4
2711
+ # The fourth line of a customer’s mailing address.
2712
+ # @return [String]
2713
+ #
2714
+ # @!attribute [rw] mailing_city
2715
+ # The city of a customer’s mailing address.
2716
+ # @return [String]
2717
+ #
2718
+ # @!attribute [rw] mailing_country
2719
+ # The country of a customer’s mailing address.
2720
+ # @return [String]
2721
+ #
2722
+ # @!attribute [rw] mailing_county
2723
+ # The county of a customer’s mailing address.
2724
+ # @return [String]
2725
+ #
2726
+ # @!attribute [rw] mailing_postal_code
2727
+ # The postal code of a customer’s mailing address.
2728
+ # @return [String]
2729
+ #
2730
+ # @!attribute [rw] mailing_province
2731
+ # The province of a customer’s mailing address.
2732
+ # @return [String]
2733
+ #
2734
+ # @!attribute [rw] mailing_state
2735
+ # The state of a customer’s mailing address.
2736
+ # @return [String]
2737
+ #
2738
+ # @!attribute [rw] middle_name
2739
+ # The customer's middle name.
2740
+ # @return [String]
2741
+ #
2742
+ # @!attribute [rw] mobile_phone_number
2743
+ # The customer's mobile phone number.
2744
+ # @return [String]
2745
+ #
2746
+ # @!attribute [rw] party_type
2747
+ # The customer's party type.
2748
+ # @return [String]
2749
+ #
2750
+ # @!attribute [rw] phone_number
2751
+ # The customer's phone number, which has not been specified as a
2752
+ # mobile, home, or business number.
2753
+ # @return [String]
2754
+ #
2755
+ # @!attribute [rw] postal_code
2756
+ # The postal code of a customer address.
2757
+ # @return [String]
2758
+ #
2759
+ # @!attribute [rw] profile_arn
2760
+ # The ARN of a customer profile.
2761
+ # @return [String]
2762
+ #
2763
+ # @!attribute [rw] profile_id
2764
+ # The unique identifier of a customer profile.
2765
+ # @return [String]
2766
+ #
2767
+ # @!attribute [rw] province
2768
+ # The province in which a customer lives.
2769
+ # @return [String]
2770
+ #
2771
+ # @!attribute [rw] shipping_address_1
2772
+ # The first line of a customer’s shipping address.
2773
+ # @return [String]
2774
+ #
2775
+ # @!attribute [rw] shipping_address_2
2776
+ # The second line of a customer’s shipping address.
2777
+ # @return [String]
2778
+ #
2779
+ # @!attribute [rw] shipping_address_3
2780
+ # The third line of a customer’s shipping address.
2781
+ # @return [String]
2782
+ #
2783
+ # @!attribute [rw] shipping_address_4
2784
+ # The fourth line of a customer’s shipping address.
2785
+ # @return [String]
2786
+ #
2787
+ # @!attribute [rw] shipping_city
2788
+ # The city of a customer’s shipping address.
2789
+ # @return [String]
2790
+ #
2791
+ # @!attribute [rw] shipping_country
2792
+ # The country of a customer’s shipping address.
2793
+ # @return [String]
2794
+ #
2795
+ # @!attribute [rw] shipping_county
2796
+ # The county of a customer’s shipping address.
2797
+ # @return [String]
2798
+ #
2799
+ # @!attribute [rw] shipping_postal_code
2800
+ # The postal code of a customer’s shipping address.
2801
+ # @return [String]
2802
+ #
2803
+ # @!attribute [rw] shipping_province
2804
+ # The province of a customer’s shipping address.
2805
+ # @return [String]
2806
+ #
2807
+ # @!attribute [rw] shipping_state
2808
+ # The state of a customer’s shipping address.
2809
+ # @return [String]
2810
+ #
2811
+ # @!attribute [rw] state
2812
+ # The state in which a customer lives.
2813
+ # @return [String]
2814
+ #
2815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CustomerProfileAttributes AWS API Documentation
2816
+ #
2817
+ class CustomerProfileAttributes < Struct.new(
2818
+ :account_number,
2819
+ :additional_information,
2820
+ :address1,
2821
+ :address2,
2822
+ :address3,
2823
+ :address4,
2824
+ :billing_address_1,
2825
+ :billing_address_2,
2826
+ :billing_address_3,
2827
+ :billing_address_4,
2828
+ :billing_city,
2829
+ :billing_country,
2830
+ :billing_county,
2831
+ :billing_postal_code,
2832
+ :billing_province,
2833
+ :billing_state,
2834
+ :birth_date,
2835
+ :business_email_address,
2836
+ :business_name,
2837
+ :business_phone_number,
2838
+ :city,
2839
+ :country,
2840
+ :county,
2841
+ :custom,
2842
+ :email_address,
2843
+ :first_name,
2844
+ :gender,
2845
+ :home_phone_number,
2846
+ :last_name,
2847
+ :mailing_address_1,
2848
+ :mailing_address_2,
2849
+ :mailing_address_3,
2850
+ :mailing_address_4,
2851
+ :mailing_city,
2852
+ :mailing_country,
2853
+ :mailing_county,
2854
+ :mailing_postal_code,
2855
+ :mailing_province,
2856
+ :mailing_state,
2857
+ :middle_name,
2858
+ :mobile_phone_number,
2859
+ :party_type,
2860
+ :phone_number,
2861
+ :postal_code,
2862
+ :profile_arn,
2863
+ :profile_id,
2864
+ :province,
2865
+ :shipping_address_1,
2866
+ :shipping_address_2,
2867
+ :shipping_address_3,
2868
+ :shipping_address_4,
2869
+ :shipping_city,
2870
+ :shipping_country,
2871
+ :shipping_county,
2872
+ :shipping_postal_code,
2873
+ :shipping_province,
2874
+ :shipping_state,
2875
+ :state)
2876
+ SENSITIVE = [:account_number, :additional_information, :address1, :address2, :address3, :address4, :billing_address_1, :billing_address_2, :billing_address_3, :billing_address_4, :billing_city, :billing_country, :billing_county, :billing_postal_code, :billing_province, :billing_state, :birth_date, :business_email_address, :business_name, :business_phone_number, :city, :country, :county, :custom, :email_address, :first_name, :gender, :home_phone_number, :last_name, :mailing_address_1, :mailing_address_2, :mailing_address_3, :mailing_address_4, :mailing_city, :mailing_country, :mailing_county, :mailing_postal_code, :mailing_province, :mailing_state, :middle_name, :mobile_phone_number, :party_type, :phone_number, :postal_code, :profile_arn, :profile_id, :province, :shipping_address_1, :shipping_address_2, :shipping_address_3, :shipping_address_4, :shipping_city, :shipping_country, :shipping_county, :shipping_postal_code, :shipping_province, :shipping_state, :state]
2877
+ include Aws::Structure
2878
+ end
2879
+
2880
+ # Details about the data.
2881
+ #
2882
+ # @note DataDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataDetails corresponding to the set member.
2883
+ #
2884
+ # @!attribute [rw] content_data
2885
+ # Details about the content data.
2886
+ # @return [Types::ContentDataDetails]
2887
+ #
2888
+ # @!attribute [rw] generative_data
2889
+ # Details about the generative data.
2890
+ # @return [Types::GenerativeDataDetails]
2891
+ #
2892
+ # @!attribute [rw] intent_detected_data
2893
+ # Details about the intent data.
2894
+ # @return [Types::IntentDetectedDataDetails]
2895
+ #
2896
+ # @!attribute [rw] source_content_data
2897
+ # Details about the content data.
2898
+ # @return [Types::SourceContentDataDetails]
2899
+ #
2900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataDetails AWS API Documentation
2901
+ #
2902
+ class DataDetails < Struct.new(
2903
+ :content_data,
2904
+ :generative_data,
2905
+ :intent_detected_data,
2906
+ :source_content_data,
2907
+ :unknown)
2908
+ SENSITIVE = []
2909
+ include Aws::Structure
2910
+ include Aws::Structure::Union
2911
+
2912
+ class ContentData < DataDetails; end
2913
+ class GenerativeData < DataDetails; end
2914
+ class IntentDetectedData < DataDetails; end
2915
+ class SourceContentData < DataDetails; end
2916
+ class Unknown < DataDetails; end
2917
+ end
2918
+
2919
+ # Reference data.
2920
+ #
2921
+ # @note DataReference is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataReference corresponding to the set member.
2922
+ #
2923
+ # @!attribute [rw] content_reference
2924
+ # Reference information about the content.
2925
+ # @return [Types::ContentReference]
2926
+ #
2927
+ # @!attribute [rw] generative_reference
2928
+ # Reference information about the generative content.
2929
+ # @return [Types::GenerativeReference]
2930
+ #
2931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataReference AWS API Documentation
2932
+ #
2933
+ class DataReference < Struct.new(
2934
+ :content_reference,
2935
+ :generative_reference,
2936
+ :unknown)
2937
+ SENSITIVE = []
2938
+ include Aws::Structure
2939
+ include Aws::Structure::Union
2940
+
2941
+ class ContentReference < DataReference; end
2942
+ class GenerativeReference < DataReference; end
2943
+ class Unknown < DataReference; end
2944
+ end
2945
+
2946
+ # Summary of the data.
2947
+ #
2948
+ # @!attribute [rw] details
2949
+ # Details about the data.
2950
+ # @return [Types::DataDetails]
2951
+ #
2952
+ # @!attribute [rw] reference
2953
+ # Reference information about the content.
2954
+ # @return [Types::DataReference]
2955
+ #
2956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataSummary AWS API Documentation
2957
+ #
2958
+ class DataSummary < Struct.new(
2959
+ :details,
2399
2960
  :reference)
2400
2961
  SENSITIVE = []
2401
2962
  include Aws::Structure
2402
2963
  end
2403
2964
 
2965
+ # @!attribute [rw] knowledge_base_id
2966
+ # The identifier of the knowledge base. Can be either the ID or the
2967
+ # ARN. URLs cannot contain the ARN.
2968
+ # @return [String]
2969
+ #
2970
+ # @!attribute [rw] message_template_id
2971
+ # The identifier of the message template. Can be either the ID or the
2972
+ # ARN. It cannot contain any qualifier.
2973
+ # @return [String]
2974
+ #
2975
+ # @!attribute [rw] version_number
2976
+ # The version number of the message template version to deactivate.
2977
+ # @return [Integer]
2978
+ #
2979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeactivateMessageTemplateRequest AWS API Documentation
2980
+ #
2981
+ class DeactivateMessageTemplateRequest < Struct.new(
2982
+ :knowledge_base_id,
2983
+ :message_template_id,
2984
+ :version_number)
2985
+ SENSITIVE = []
2986
+ include Aws::Structure
2987
+ end
2988
+
2989
+ # @!attribute [rw] message_template_arn
2990
+ # The Amazon Resource Name (ARN) of the message template.
2991
+ # @return [String]
2992
+ #
2993
+ # @!attribute [rw] message_template_id
2994
+ # The identifier of the message template.
2995
+ # @return [String]
2996
+ #
2997
+ # @!attribute [rw] version_number
2998
+ # The version number of the message template version that has been
2999
+ # deactivated.
3000
+ # @return [Integer]
3001
+ #
3002
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeactivateMessageTemplateResponse AWS API Documentation
3003
+ #
3004
+ class DeactivateMessageTemplateResponse < Struct.new(
3005
+ :message_template_arn,
3006
+ :message_template_id,
3007
+ :version_number)
3008
+ SENSITIVE = []
3009
+ include Aws::Structure
3010
+ end
3011
+
2404
3012
  # @!attribute [rw] ai_agent_id
2405
3013
  # The identifier of the Amazon Q in Connect AI Agent. Can be either
2406
3014
  # the ID or the ARN. URLs cannot contain the ARN.
@@ -2630,6 +3238,57 @@ module Aws::QConnect
2630
3238
  #
2631
3239
  class DeleteKnowledgeBaseResponse < Aws::EmptyStructure; end
2632
3240
 
3241
+ # @!attribute [rw] attachment_id
3242
+ # The identifier of the attachment file.
3243
+ # @return [String]
3244
+ #
3245
+ # @!attribute [rw] knowledge_base_id
3246
+ # The identifier of the knowledge base. Can be either the ID or the
3247
+ # ARN. URLs cannot contain the ARN.
3248
+ # @return [String]
3249
+ #
3250
+ # @!attribute [rw] message_template_id
3251
+ # The identifier of the message template. Can be either the ID or the
3252
+ # ARN. It cannot contain any qualifier.
3253
+ # @return [String]
3254
+ #
3255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateAttachmentRequest AWS API Documentation
3256
+ #
3257
+ class DeleteMessageTemplateAttachmentRequest < Struct.new(
3258
+ :attachment_id,
3259
+ :knowledge_base_id,
3260
+ :message_template_id)
3261
+ SENSITIVE = []
3262
+ include Aws::Structure
3263
+ end
3264
+
3265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateAttachmentResponse AWS API Documentation
3266
+ #
3267
+ class DeleteMessageTemplateAttachmentResponse < Aws::EmptyStructure; end
3268
+
3269
+ # @!attribute [rw] knowledge_base_id
3270
+ # The identifier of the knowledge base. Can be either the ID or the
3271
+ # ARN. URLs cannot contain the ARN.
3272
+ # @return [String]
3273
+ #
3274
+ # @!attribute [rw] message_template_id
3275
+ # The identifier of the message template. Can be either the ID or the
3276
+ # ARN.
3277
+ # @return [String]
3278
+ #
3279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateRequest AWS API Documentation
3280
+ #
3281
+ class DeleteMessageTemplateRequest < Struct.new(
3282
+ :knowledge_base_id,
3283
+ :message_template_id)
3284
+ SENSITIVE = []
3285
+ include Aws::Structure
3286
+ end
3287
+
3288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateResponse AWS API Documentation
3289
+ #
3290
+ class DeleteMessageTemplateResponse < Aws::EmptyStructure; end
3291
+
2633
3292
  # @!attribute [rw] knowledge_base_id
2634
3293
  # The knowledge base from which the quick response is deleted. The
2635
3294
  # identifier of the knowledge base.
@@ -2695,34 +3354,227 @@ module Aws::QConnect
2695
3354
  include Aws::Structure
2696
3355
  end
2697
3356
 
2698
- # The configuration information of the external data source.
3357
+ # The email header to include in email messages.
2699
3358
  #
2700
- # @!attribute [rw] configuration
2701
- # The configuration information of the external data source.
2702
- # @return [Types::Configuration]
3359
+ # @!attribute [rw] name
3360
+ # The name of the email header.
3361
+ # @return [String]
2703
3362
  #
2704
- # @!attribute [rw] source
2705
- # The type of the external data source.
3363
+ # @!attribute [rw] value
3364
+ # The value of the email header.
2706
3365
  # @return [String]
2707
3366
  #
2708
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExternalSourceConfiguration AWS API Documentation
3367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailHeader AWS API Documentation
2709
3368
  #
2710
- class ExternalSourceConfiguration < Struct.new(
2711
- :configuration,
2712
- :source)
2713
- SENSITIVE = []
3369
+ class EmailHeader < Struct.new(
3370
+ :name,
3371
+ :value)
3372
+ SENSITIVE = [:value]
2714
3373
  include Aws::Structure
2715
3374
  end
2716
3375
 
2717
- # A search filter.
3376
+ # The content of the message template that applies to the email channel
3377
+ # subtype.
2718
3378
  #
2719
- # @!attribute [rw] field
2720
- # The field on which to filter.
2721
- # @return [String]
3379
+ # @!attribute [rw] body
3380
+ # The body to use in email messages.
3381
+ # @return [Types::EmailMessageTemplateContentBody]
2722
3382
  #
2723
- # @!attribute [rw] operator
2724
- # The operator to use for comparing the field’s value with the
2725
- # provided value.
3383
+ # @!attribute [rw] headers
3384
+ # The email headers to include in email messages.
3385
+ # @return [Array<Types::EmailHeader>]
3386
+ #
3387
+ # @!attribute [rw] subject
3388
+ # The subject line, or title, to use in email messages.
3389
+ # @return [String]
3390
+ #
3391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailMessageTemplateContent AWS API Documentation
3392
+ #
3393
+ class EmailMessageTemplateContent < Struct.new(
3394
+ :body,
3395
+ :headers,
3396
+ :subject)
3397
+ SENSITIVE = [:subject]
3398
+ include Aws::Structure
3399
+ end
3400
+
3401
+ # The body to use in email messages.
3402
+ #
3403
+ # @!attribute [rw] html
3404
+ # The message body, in HTML format, to use in email messages that are
3405
+ # based on the message template. We recommend using HTML format for
3406
+ # email clients that render HTML content. You can include links,
3407
+ # formatted text, and more in an HTML message.
3408
+ # @return [Types::MessageTemplateBodyContentProvider]
3409
+ #
3410
+ # @!attribute [rw] plain_text
3411
+ # The message body, in plain text format, to use in email messages
3412
+ # that are based on the message template. We recommend using plain
3413
+ # text format for email clients that don't render HTML content and
3414
+ # clients that are connected to high-latency networks, such as mobile
3415
+ # devices.
3416
+ # @return [Types::MessageTemplateBodyContentProvider]
3417
+ #
3418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailMessageTemplateContentBody AWS API Documentation
3419
+ #
3420
+ class EmailMessageTemplateContentBody < Struct.new(
3421
+ :html,
3422
+ :plain_text)
3423
+ SENSITIVE = []
3424
+ include Aws::Structure
3425
+ end
3426
+
3427
+ # The extended data of a message template.
3428
+ #
3429
+ # @!attribute [rw] attachments
3430
+ # The message template attachments.
3431
+ # @return [Array<Types::MessageTemplateAttachment>]
3432
+ #
3433
+ # @!attribute [rw] attribute_types
3434
+ # The types of attributes contain the message template.
3435
+ # @return [Array<String>]
3436
+ #
3437
+ # @!attribute [rw] channel_subtype
3438
+ # The channel subtype this message template applies to.
3439
+ # @return [String]
3440
+ #
3441
+ # @!attribute [rw] content
3442
+ # The content of the message template.
3443
+ # @return [Types::MessageTemplateContentProvider]
3444
+ #
3445
+ # @!attribute [rw] created_time
3446
+ # The timestamp when the message template was created.
3447
+ # @return [Time]
3448
+ #
3449
+ # @!attribute [rw] default_attributes
3450
+ # An object that specifies the default values to use for variables in
3451
+ # the message template. This object contains different categories of
3452
+ # key-value pairs. Each key defines a variable or placeholder in the
3453
+ # message template. The corresponding value defines the default value
3454
+ # for that variable.
3455
+ # @return [Types::MessageTemplateAttributes]
3456
+ #
3457
+ # @!attribute [rw] description
3458
+ # The description of the message template.
3459
+ # @return [String]
3460
+ #
3461
+ # @!attribute [rw] grouping_configuration
3462
+ # The configuration information of the grouping of Amazon Q in Connect
3463
+ # users.
3464
+ # @return [Types::GroupingConfiguration]
3465
+ #
3466
+ # @!attribute [rw] is_active
3467
+ # Whether the version of the message template is activated.
3468
+ # @return [Boolean]
3469
+ #
3470
+ # @!attribute [rw] knowledge_base_arn
3471
+ # The Amazon Resource Name (ARN) of the knowledge base.
3472
+ # @return [String]
3473
+ #
3474
+ # @!attribute [rw] knowledge_base_id
3475
+ # The identifier of the knowledge base.
3476
+ # @return [String]
3477
+ #
3478
+ # @!attribute [rw] language
3479
+ # The language code value for the language in which the quick response
3480
+ # is written. The supported language codes include `de_DE`, `en_US`,
3481
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
3482
+ # `zh_CN`, `zh_TW`
3483
+ # @return [String]
3484
+ #
3485
+ # @!attribute [rw] last_modified_by
3486
+ # The Amazon Resource Name (ARN) of the user who last updated the
3487
+ # message template data.
3488
+ # @return [String]
3489
+ #
3490
+ # @!attribute [rw] last_modified_time
3491
+ # The timestamp when the message template data was last modified.
3492
+ # @return [Time]
3493
+ #
3494
+ # @!attribute [rw] message_template_arn
3495
+ # The Amazon Resource Name (ARN) of the message template.
3496
+ # @return [String]
3497
+ #
3498
+ # @!attribute [rw] message_template_content_sha_256
3499
+ # The checksum value of the message template content that is
3500
+ # referenced by the `$LATEST` qualifier. It can be returned in
3501
+ # `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
3502
+ # calculated by content, language, `defaultAttributes` and
3503
+ # `Attachments` of the message template.
3504
+ # @return [String]
3505
+ #
3506
+ # @!attribute [rw] message_template_id
3507
+ # The identifier of the message template.
3508
+ # @return [String]
3509
+ #
3510
+ # @!attribute [rw] name
3511
+ # The name of the message template.
3512
+ # @return [String]
3513
+ #
3514
+ # @!attribute [rw] tags
3515
+ # The tags used to organize, track, or control access for this
3516
+ # resource.
3517
+ # @return [Hash<String,String>]
3518
+ #
3519
+ # @!attribute [rw] version_number
3520
+ # The version number of the message template version.
3521
+ # @return [Integer]
3522
+ #
3523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExtendedMessageTemplateData AWS API Documentation
3524
+ #
3525
+ class ExtendedMessageTemplateData < Struct.new(
3526
+ :attachments,
3527
+ :attribute_types,
3528
+ :channel_subtype,
3529
+ :content,
3530
+ :created_time,
3531
+ :default_attributes,
3532
+ :description,
3533
+ :grouping_configuration,
3534
+ :is_active,
3535
+ :knowledge_base_arn,
3536
+ :knowledge_base_id,
3537
+ :language,
3538
+ :last_modified_by,
3539
+ :last_modified_time,
3540
+ :message_template_arn,
3541
+ :message_template_content_sha_256,
3542
+ :message_template_id,
3543
+ :name,
3544
+ :tags,
3545
+ :version_number)
3546
+ SENSITIVE = []
3547
+ include Aws::Structure
3548
+ end
3549
+
3550
+ # The configuration information of the external data source.
3551
+ #
3552
+ # @!attribute [rw] configuration
3553
+ # The configuration information of the external data source.
3554
+ # @return [Types::Configuration]
3555
+ #
3556
+ # @!attribute [rw] source
3557
+ # The type of the external data source.
3558
+ # @return [String]
3559
+ #
3560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExternalSourceConfiguration AWS API Documentation
3561
+ #
3562
+ class ExternalSourceConfiguration < Struct.new(
3563
+ :configuration,
3564
+ :source)
3565
+ SENSITIVE = []
3566
+ include Aws::Structure
3567
+ end
3568
+
3569
+ # A search filter.
3570
+ #
3571
+ # @!attribute [rw] field
3572
+ # The field on which to filter.
3573
+ # @return [String]
3574
+ #
3575
+ # @!attribute [rw] operator
3576
+ # The operator to use for comparing the field’s value with the
3577
+ # provided value.
2726
3578
  # @return [String]
2727
3579
  #
2728
3580
  # @!attribute [rw] value
@@ -3101,6 +3953,37 @@ module Aws::QConnect
3101
3953
  include Aws::Structure
3102
3954
  end
3103
3955
 
3956
+ # @!attribute [rw] knowledge_base_id
3957
+ # The identifier of the knowledge base. Can be either the ID or the
3958
+ # ARN. URLs cannot contain the ARN.
3959
+ # @return [String]
3960
+ #
3961
+ # @!attribute [rw] message_template_id
3962
+ # The identifier of the message template. Can be either the ID or the
3963
+ # ARN.
3964
+ # @return [String]
3965
+ #
3966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetMessageTemplateRequest AWS API Documentation
3967
+ #
3968
+ class GetMessageTemplateRequest < Struct.new(
3969
+ :knowledge_base_id,
3970
+ :message_template_id)
3971
+ SENSITIVE = []
3972
+ include Aws::Structure
3973
+ end
3974
+
3975
+ # @!attribute [rw] message_template
3976
+ # The message template.
3977
+ # @return [Types::ExtendedMessageTemplateData]
3978
+ #
3979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetMessageTemplateResponse AWS API Documentation
3980
+ #
3981
+ class GetMessageTemplateResponse < Struct.new(
3982
+ :message_template)
3983
+ SENSITIVE = []
3984
+ include Aws::Structure
3985
+ end
3986
+
3104
3987
  # @!attribute [rw] knowledge_base_id
3105
3988
  # The identifier of the knowledge base. This should be a
3106
3989
  # QUICK\_RESPONSES type knowledge base.
@@ -4182,6 +5065,98 @@ module Aws::QConnect
4182
5065
  include Aws::Structure
4183
5066
  end
4184
5067
 
5068
+ # @!attribute [rw] knowledge_base_id
5069
+ # The identifier of the knowledge base. Can be either the ID or the
5070
+ # ARN. URLs cannot contain the ARN.
5071
+ # @return [String]
5072
+ #
5073
+ # @!attribute [rw] max_results
5074
+ # The maximum number of results to return per page.
5075
+ # @return [Integer]
5076
+ #
5077
+ # @!attribute [rw] message_template_id
5078
+ # The identifier of the message template. Can be either the ID or the
5079
+ # ARN. It cannot contain any qualifier.
5080
+ # @return [String]
5081
+ #
5082
+ # @!attribute [rw] next_token
5083
+ # The token for the next set of results. Use the value returned in the
5084
+ # previous response in the next request to retrieve the next set of
5085
+ # results.
5086
+ # @return [String]
5087
+ #
5088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplateVersionsRequest AWS API Documentation
5089
+ #
5090
+ class ListMessageTemplateVersionsRequest < Struct.new(
5091
+ :knowledge_base_id,
5092
+ :max_results,
5093
+ :message_template_id,
5094
+ :next_token)
5095
+ SENSITIVE = []
5096
+ include Aws::Structure
5097
+ end
5098
+
5099
+ # @!attribute [rw] message_template_version_summaries
5100
+ # Summary information about the versions of a message template.
5101
+ # @return [Array<Types::MessageTemplateVersionSummary>]
5102
+ #
5103
+ # @!attribute [rw] next_token
5104
+ # If there are additional results, this is the token for the next set
5105
+ # of results.
5106
+ # @return [String]
5107
+ #
5108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplateVersionsResponse AWS API Documentation
5109
+ #
5110
+ class ListMessageTemplateVersionsResponse < Struct.new(
5111
+ :message_template_version_summaries,
5112
+ :next_token)
5113
+ SENSITIVE = []
5114
+ include Aws::Structure
5115
+ end
5116
+
5117
+ # @!attribute [rw] knowledge_base_id
5118
+ # The identifier of the knowledge base. Can be either the ID or the
5119
+ # ARN. URLs cannot contain the ARN.
5120
+ # @return [String]
5121
+ #
5122
+ # @!attribute [rw] max_results
5123
+ # The maximum number of results to return per page.
5124
+ # @return [Integer]
5125
+ #
5126
+ # @!attribute [rw] next_token
5127
+ # The token for the next set of results. Use the value returned in the
5128
+ # previous response in the next request to retrieve the next set of
5129
+ # results.
5130
+ # @return [String]
5131
+ #
5132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplatesRequest AWS API Documentation
5133
+ #
5134
+ class ListMessageTemplatesRequest < Struct.new(
5135
+ :knowledge_base_id,
5136
+ :max_results,
5137
+ :next_token)
5138
+ SENSITIVE = []
5139
+ include Aws::Structure
5140
+ end
5141
+
5142
+ # @!attribute [rw] message_template_summaries
5143
+ # Summary information about the message template.
5144
+ # @return [Array<Types::MessageTemplateSummary>]
5145
+ #
5146
+ # @!attribute [rw] next_token
5147
+ # If there are additional results, this is the token for the next set
5148
+ # of results.
5149
+ # @return [String]
5150
+ #
5151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplatesResponse AWS API Documentation
5152
+ #
5153
+ class ListMessageTemplatesResponse < Struct.new(
5154
+ :message_template_summaries,
5155
+ :next_token)
5156
+ SENSITIVE = []
5157
+ include Aws::Structure
5158
+ end
5159
+
4185
5160
  # @!attribute [rw] knowledge_base_id
4186
5161
  # The identifier of the knowledge base. Can be either the ID or the
4187
5162
  # ARN. URLs cannot contain the ARN.
@@ -4213,84 +5188,692 @@ module Aws::QConnect
4213
5188
  # results.
4214
5189
  # @return [String]
4215
5190
  #
4216
- # @!attribute [rw] quick_response_summaries
4217
- # Summary information about the quick responses.
4218
- # @return [Array<Types::QuickResponseSummary>]
5191
+ # @!attribute [rw] quick_response_summaries
5192
+ # Summary information about the quick responses.
5193
+ # @return [Array<Types::QuickResponseSummary>]
5194
+ #
5195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponsesResponse AWS API Documentation
5196
+ #
5197
+ class ListQuickResponsesResponse < Struct.new(
5198
+ :next_token,
5199
+ :quick_response_summaries)
5200
+ SENSITIVE = []
5201
+ include Aws::Structure
5202
+ end
5203
+
5204
+ # @!attribute [rw] resource_arn
5205
+ # The Amazon Resource Name (ARN) of the resource.
5206
+ # @return [String]
5207
+ #
5208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceRequest AWS API Documentation
5209
+ #
5210
+ class ListTagsForResourceRequest < Struct.new(
5211
+ :resource_arn)
5212
+ SENSITIVE = []
5213
+ include Aws::Structure
5214
+ end
5215
+
5216
+ # @!attribute [rw] tags
5217
+ # The tags used to organize, track, or control access for this
5218
+ # resource.
5219
+ # @return [Hash<String,String>]
5220
+ #
5221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceResponse AWS API Documentation
5222
+ #
5223
+ class ListTagsForResourceResponse < Struct.new(
5224
+ :tags)
5225
+ SENSITIVE = []
5226
+ include Aws::Structure
5227
+ end
5228
+
5229
+ # Source configuration for managed resources.
5230
+ #
5231
+ # @note ManagedSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
5232
+ #
5233
+ # @note ManagedSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ManagedSourceConfiguration corresponding to the set member.
5234
+ #
5235
+ # @!attribute [rw] web_crawler_configuration
5236
+ # Configuration data for web crawler data source.
5237
+ # @return [Types::WebCrawlerConfiguration]
5238
+ #
5239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManagedSourceConfiguration AWS API Documentation
5240
+ #
5241
+ class ManagedSourceConfiguration < Struct.new(
5242
+ :web_crawler_configuration,
5243
+ :unknown)
5244
+ SENSITIVE = []
5245
+ include Aws::Structure
5246
+ include Aws::Structure::Union
5247
+
5248
+ class WebCrawlerConfiguration < ManagedSourceConfiguration; end
5249
+ class Unknown < ManagedSourceConfiguration; end
5250
+ end
5251
+
5252
+ # The configuration for the `MANUAL_SEARCH` AI Agent type.
5253
+ #
5254
+ # @!attribute [rw] answer_generation_ai_prompt_id
5255
+ # The AI Prompt identifier for the Answer Generation prompt used by
5256
+ # the MANUAL\_SEARCH AI Agent.
5257
+ # @return [String]
5258
+ #
5259
+ # @!attribute [rw] association_configurations
5260
+ # The association configurations for overriding behavior on this AI
5261
+ # Agent.
5262
+ # @return [Array<Types::AssociationConfiguration>]
5263
+ #
5264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManualSearchAIAgentConfiguration AWS API Documentation
5265
+ #
5266
+ class ManualSearchAIAgentConfiguration < Struct.new(
5267
+ :answer_generation_ai_prompt_id,
5268
+ :association_configurations)
5269
+ SENSITIVE = []
5270
+ include Aws::Structure
5271
+ end
5272
+
5273
+ # Information about the message template attachment.
5274
+ #
5275
+ # @!attribute [rw] attachment_id
5276
+ # The identifier of the attachment file.
5277
+ # @return [String]
5278
+ #
5279
+ # @!attribute [rw] content_disposition
5280
+ # The presentation information for the attachment file.
5281
+ # @return [String]
5282
+ #
5283
+ # @!attribute [rw] name
5284
+ # The name of the attachment file being uploaded. The name should
5285
+ # include the file extension.
5286
+ # @return [String]
5287
+ #
5288
+ # @!attribute [rw] uploaded_time
5289
+ # The timestamp when the attachment file was uploaded.
5290
+ # @return [Time]
5291
+ #
5292
+ # @!attribute [rw] url
5293
+ # A pre-signed Amazon S3 URL that can be used to download the
5294
+ # attachment file.
5295
+ # @return [String]
5296
+ #
5297
+ # @!attribute [rw] url_expiry
5298
+ # The expiration time of the pre-signed Amazon S3 URL.
5299
+ # @return [Time]
5300
+ #
5301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateAttachment AWS API Documentation
5302
+ #
5303
+ class MessageTemplateAttachment < Struct.new(
5304
+ :attachment_id,
5305
+ :content_disposition,
5306
+ :name,
5307
+ :uploaded_time,
5308
+ :url,
5309
+ :url_expiry)
5310
+ SENSITIVE = [:name, :url]
5311
+ include Aws::Structure
5312
+ end
5313
+
5314
+ # The attributes that are used with the message template.
5315
+ #
5316
+ # @!attribute [rw] agent_attributes
5317
+ # The agent attributes that are used with the message template.
5318
+ # @return [Types::AgentAttributes]
5319
+ #
5320
+ # @!attribute [rw] custom_attributes
5321
+ # The custom attributes that are used with the message template.
5322
+ # @return [Hash<String,String>]
5323
+ #
5324
+ # @!attribute [rw] customer_profile_attributes
5325
+ # The customer profile attributes that are used with the message
5326
+ # template.
5327
+ # @return [Types::CustomerProfileAttributes]
5328
+ #
5329
+ # @!attribute [rw] system_attributes
5330
+ # The system attributes that are used with the message template.
5331
+ # @return [Types::SystemAttributes]
5332
+ #
5333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateAttributes AWS API Documentation
5334
+ #
5335
+ class MessageTemplateAttributes < Struct.new(
5336
+ :agent_attributes,
5337
+ :custom_attributes,
5338
+ :customer_profile_attributes,
5339
+ :system_attributes)
5340
+ SENSITIVE = [:custom_attributes]
5341
+ include Aws::Structure
5342
+ end
5343
+
5344
+ # The container of the message template body.
5345
+ #
5346
+ # @note MessageTemplateBodyContentProvider is a union - when making an API calls you must set exactly one of the members.
5347
+ #
5348
+ # @note MessageTemplateBodyContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateBodyContentProvider corresponding to the set member.
5349
+ #
5350
+ # @!attribute [rw] content
5351
+ # The content of the message template.
5352
+ # @return [String]
5353
+ #
5354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateBodyContentProvider AWS API Documentation
5355
+ #
5356
+ class MessageTemplateBodyContentProvider < Struct.new(
5357
+ :content,
5358
+ :unknown)
5359
+ SENSITIVE = [:content]
5360
+ include Aws::Structure
5361
+ include Aws::Structure::Union
5362
+
5363
+ class Content < MessageTemplateBodyContentProvider; end
5364
+ class Unknown < MessageTemplateBodyContentProvider; end
5365
+ end
5366
+
5367
+ # The container of message template content.
5368
+ #
5369
+ # @note MessageTemplateContentProvider is a union - when making an API calls you must set exactly one of the members.
5370
+ #
5371
+ # @note MessageTemplateContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateContentProvider corresponding to the set member.
5372
+ #
5373
+ # @!attribute [rw] email
5374
+ # The content of the message template that applies to the email
5375
+ # channel subtype.
5376
+ # @return [Types::EmailMessageTemplateContent]
5377
+ #
5378
+ # @!attribute [rw] sms
5379
+ # The content of the message template that applies to the SMS channel
5380
+ # subtype.
5381
+ # @return [Types::SMSMessageTemplateContent]
5382
+ #
5383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateContentProvider AWS API Documentation
5384
+ #
5385
+ class MessageTemplateContentProvider < Struct.new(
5386
+ :email,
5387
+ :sms,
5388
+ :unknown)
5389
+ SENSITIVE = []
5390
+ include Aws::Structure
5391
+ include Aws::Structure::Union
5392
+
5393
+ class Email < MessageTemplateContentProvider; end
5394
+ class Sms < MessageTemplateContentProvider; end
5395
+ class Unknown < MessageTemplateContentProvider; end
5396
+ end
5397
+
5398
+ # The data of a message template.
5399
+ #
5400
+ # @!attribute [rw] attribute_types
5401
+ # The types of attributes that the message template contains.
5402
+ # @return [Array<String>]
5403
+ #
5404
+ # @!attribute [rw] channel_subtype
5405
+ # The channel subtype this message template applies to.
5406
+ # @return [String]
5407
+ #
5408
+ # @!attribute [rw] content
5409
+ # The content of the message template.
5410
+ # @return [Types::MessageTemplateContentProvider]
5411
+ #
5412
+ # @!attribute [rw] created_time
5413
+ # The timestamp when the message template was created.
5414
+ # @return [Time]
5415
+ #
5416
+ # @!attribute [rw] default_attributes
5417
+ # An object that specifies the default values to use for variables in
5418
+ # the message template. This object contains different categories of
5419
+ # key-value pairs. Each key defines a variable or placeholder in the
5420
+ # message template. The corresponding value defines the default value
5421
+ # for that variable.
5422
+ # @return [Types::MessageTemplateAttributes]
5423
+ #
5424
+ # @!attribute [rw] description
5425
+ # The description of the message template.
5426
+ # @return [String]
5427
+ #
5428
+ # @!attribute [rw] grouping_configuration
5429
+ # The configuration information of the grouping of Amazon Q in Connect
5430
+ # users.
5431
+ # @return [Types::GroupingConfiguration]
5432
+ #
5433
+ # @!attribute [rw] knowledge_base_arn
5434
+ # The Amazon Resource Name (ARN) of the knowledge base.
5435
+ # @return [String]
5436
+ #
5437
+ # @!attribute [rw] knowledge_base_id
5438
+ # The identifier of the knowledge base.
5439
+ # @return [String]
5440
+ #
5441
+ # @!attribute [rw] language
5442
+ # The language code value for the language in which the quick response
5443
+ # is written. The supported language codes include `de_DE`, `en_US`,
5444
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
5445
+ # `zh_CN`, `zh_TW`
5446
+ # @return [String]
5447
+ #
5448
+ # @!attribute [rw] last_modified_by
5449
+ # The Amazon Resource Name (ARN) of the user who last updated the
5450
+ # message template data.
5451
+ # @return [String]
5452
+ #
5453
+ # @!attribute [rw] last_modified_time
5454
+ # The timestamp when the message template data was last modified.
5455
+ # @return [Time]
5456
+ #
5457
+ # @!attribute [rw] message_template_arn
5458
+ # The Amazon Resource Name (ARN) of the message template.
5459
+ # @return [String]
5460
+ #
5461
+ # @!attribute [rw] message_template_content_sha_256
5462
+ # The checksum value of the message template content that is
5463
+ # referenced by the `$LATEST` qualifier. It can be returned in
5464
+ # `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
5465
+ # calculated by content, language, `defaultAttributes` and
5466
+ # `Attachments` of the message template.
5467
+ # @return [String]
5468
+ #
5469
+ # @!attribute [rw] message_template_id
5470
+ # The identifier of the message template.
5471
+ # @return [String]
5472
+ #
5473
+ # @!attribute [rw] name
5474
+ # The name of the message template.
5475
+ # @return [String]
5476
+ #
5477
+ # @!attribute [rw] tags
5478
+ # The tags used to organize, track, or control access for this
5479
+ # resource.
5480
+ # @return [Hash<String,String>]
5481
+ #
5482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateData AWS API Documentation
5483
+ #
5484
+ class MessageTemplateData < Struct.new(
5485
+ :attribute_types,
5486
+ :channel_subtype,
5487
+ :content,
5488
+ :created_time,
5489
+ :default_attributes,
5490
+ :description,
5491
+ :grouping_configuration,
5492
+ :knowledge_base_arn,
5493
+ :knowledge_base_id,
5494
+ :language,
5495
+ :last_modified_by,
5496
+ :last_modified_time,
5497
+ :message_template_arn,
5498
+ :message_template_content_sha_256,
5499
+ :message_template_id,
5500
+ :name,
5501
+ :tags)
5502
+ SENSITIVE = []
5503
+ include Aws::Structure
5504
+ end
5505
+
5506
+ # The message template fields to filter the message template query
5507
+ # results by. The following is the list of supported field names:
5508
+ #
5509
+ # * name
5510
+ #
5511
+ # * description
5512
+ #
5513
+ # * channel
5514
+ #
5515
+ # * channelSubtype
5516
+ #
5517
+ # * language
5518
+ #
5519
+ # * qualifier
5520
+ #
5521
+ # * createdTime
5522
+ #
5523
+ # * lastModifiedTime
5524
+ #
5525
+ # * lastModifiedBy
5526
+ #
5527
+ # * groupingConfiguration.criteria
5528
+ #
5529
+ # * groupingConfiguration.values
5530
+ #
5531
+ # @!attribute [rw] include_no_existence
5532
+ # Whether to treat null value as a match for the attribute field.
5533
+ # @return [Boolean]
5534
+ #
5535
+ # @!attribute [rw] name
5536
+ # The name of the attribute field to filter the message templates by.
5537
+ # @return [String]
5538
+ #
5539
+ # @!attribute [rw] operator
5540
+ # The operator to use for filtering.
5541
+ # @return [String]
5542
+ #
5543
+ # @!attribute [rw] values
5544
+ # The values of attribute field to filter the message template by.
5545
+ # @return [Array<String>]
5546
+ #
5547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateFilterField AWS API Documentation
5548
+ #
5549
+ class MessageTemplateFilterField < Struct.new(
5550
+ :include_no_existence,
5551
+ :name,
5552
+ :operator,
5553
+ :values)
5554
+ SENSITIVE = []
5555
+ include Aws::Structure
5556
+ end
5557
+
5558
+ # The message template fields to order the message template query
5559
+ # results by. The following is the list of supported field names:
5560
+ #
5561
+ # * name
5562
+ #
5563
+ # * description
5564
+ #
5565
+ # * channel
5566
+ #
5567
+ # * channelSubtype
5568
+ #
5569
+ # * language
5570
+ #
5571
+ # * qualifier
5572
+ #
5573
+ # * createdTime
5574
+ #
5575
+ # * lastModifiedTime
5576
+ #
5577
+ # * lastModifiedBy
5578
+ #
5579
+ # * groupingConfiguration.criteria
5580
+ #
5581
+ # * groupingConfiguration.values
5582
+ #
5583
+ # @!attribute [rw] name
5584
+ # The name of the message template.
5585
+ # @return [String]
5586
+ #
5587
+ # @!attribute [rw] order
5588
+ # The order at which the message templates are sorted by.
5589
+ # @return [String]
5590
+ #
5591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateOrderField AWS API Documentation
5592
+ #
5593
+ class MessageTemplateOrderField < Struct.new(
5594
+ :name,
5595
+ :order)
5596
+ SENSITIVE = []
5597
+ include Aws::Structure
5598
+ end
5599
+
5600
+ # The message template fields to query message templates by. The
5601
+ # following is the list of supported field names:
5602
+ #
5603
+ # * name
5604
+ #
5605
+ # * description
5606
+ #
5607
+ # @!attribute [rw] allow_fuzziness
5608
+ # Whether the query expects only exact matches on the attribute field
5609
+ # values. The results of the query will only include exact matches if
5610
+ # this parameter is set to false.
5611
+ # @return [Boolean]
5612
+ #
5613
+ # @!attribute [rw] name
5614
+ # The name of the attribute to query the message templates by.
5615
+ # @return [String]
5616
+ #
5617
+ # @!attribute [rw] operator
5618
+ # The operator to use for matching attribute field values in the
5619
+ # query.
5620
+ # @return [String]
5621
+ #
5622
+ # @!attribute [rw] priority
5623
+ # The importance of the attribute field when calculating query result
5624
+ # relevancy scores. The value set for this parameter affects the
5625
+ # ordering of search results.
5626
+ # @return [String]
5627
+ #
5628
+ # @!attribute [rw] values
5629
+ # The values of the attribute to query the message templates by.
5630
+ # @return [Array<String>]
5631
+ #
5632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateQueryField AWS API Documentation
5633
+ #
5634
+ class MessageTemplateQueryField < Struct.new(
5635
+ :allow_fuzziness,
5636
+ :name,
5637
+ :operator,
5638
+ :priority,
5639
+ :values)
5640
+ SENSITIVE = []
5641
+ include Aws::Structure
5642
+ end
5643
+
5644
+ # The search expression of the message template.
5645
+ #
5646
+ # @!attribute [rw] filters
5647
+ # The configuration of filtering rules applied to message template
5648
+ # query results.
5649
+ # @return [Array<Types::MessageTemplateFilterField>]
5650
+ #
5651
+ # @!attribute [rw] order_on_field
5652
+ # The message template attribute fields on which the query results are
5653
+ # ordered.
5654
+ # @return [Types::MessageTemplateOrderField]
5655
+ #
5656
+ # @!attribute [rw] queries
5657
+ # The message template query expressions.
5658
+ # @return [Array<Types::MessageTemplateQueryField>]
5659
+ #
5660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSearchExpression AWS API Documentation
5661
+ #
5662
+ class MessageTemplateSearchExpression < Struct.new(
5663
+ :filters,
5664
+ :order_on_field,
5665
+ :queries)
5666
+ SENSITIVE = []
5667
+ include Aws::Structure
5668
+ end
5669
+
5670
+ # The result of message template search.
5671
+ #
5672
+ # @!attribute [rw] channel_subtype
5673
+ # The channel subtype this message template applies to.
5674
+ # @return [String]
5675
+ #
5676
+ # @!attribute [rw] created_time
5677
+ # The timestamp when the message template was created.
5678
+ # @return [Time]
5679
+ #
5680
+ # @!attribute [rw] description
5681
+ # The description of the message template.
5682
+ # @return [String]
5683
+ #
5684
+ # @!attribute [rw] grouping_configuration
5685
+ # The configuration information of the grouping of Amazon Q in Connect
5686
+ # users.
5687
+ # @return [Types::GroupingConfiguration]
5688
+ #
5689
+ # @!attribute [rw] is_active
5690
+ # Whether the version of the message template is activated.
5691
+ # @return [Boolean]
5692
+ #
5693
+ # @!attribute [rw] knowledge_base_arn
5694
+ # The Amazon Resource Name (ARN) of the knowledge base.
5695
+ # @return [String]
5696
+ #
5697
+ # @!attribute [rw] knowledge_base_id
5698
+ # The identifier of the knowledge base.
5699
+ # @return [String]
5700
+ #
5701
+ # @!attribute [rw] language
5702
+ # The language code value for the language in which the quick response
5703
+ # is written. The supported language codes include `de_DE`, `en_US`,
5704
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
5705
+ # `zh_CN`, `zh_TW`
5706
+ # @return [String]
5707
+ #
5708
+ # @!attribute [rw] last_modified_by
5709
+ # The Amazon Resource Name (ARN) of the user who last updated the
5710
+ # message template data.
5711
+ # @return [String]
5712
+ #
5713
+ # @!attribute [rw] last_modified_time
5714
+ # The timestamp when the message template data was last modified.
5715
+ # @return [Time]
5716
+ #
5717
+ # @!attribute [rw] message_template_arn
5718
+ # The Amazon Resource Name (ARN) of the message template.
5719
+ # @return [String]
5720
+ #
5721
+ # @!attribute [rw] message_template_id
5722
+ # The identifier of the message template.
5723
+ # @return [String]
5724
+ #
5725
+ # @!attribute [rw] name
5726
+ # The name of the message template.
5727
+ # @return [String]
5728
+ #
5729
+ # @!attribute [rw] tags
5730
+ # The tags used to organize, track, or control access for this
5731
+ # resource.
5732
+ # @return [Hash<String,String>]
5733
+ #
5734
+ # @!attribute [rw] version_number
5735
+ # The version number of the message template version.
5736
+ # @return [Integer]
5737
+ #
5738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSearchResultData AWS API Documentation
5739
+ #
5740
+ class MessageTemplateSearchResultData < Struct.new(
5741
+ :channel_subtype,
5742
+ :created_time,
5743
+ :description,
5744
+ :grouping_configuration,
5745
+ :is_active,
5746
+ :knowledge_base_arn,
5747
+ :knowledge_base_id,
5748
+ :language,
5749
+ :last_modified_by,
5750
+ :last_modified_time,
5751
+ :message_template_arn,
5752
+ :message_template_id,
5753
+ :name,
5754
+ :tags,
5755
+ :version_number)
5756
+ SENSITIVE = []
5757
+ include Aws::Structure
5758
+ end
5759
+
5760
+ # The summary of the message template.
5761
+ #
5762
+ # @!attribute [rw] active_version_number
5763
+ # The version number of the message template version that is
5764
+ # activated.
5765
+ # @return [Integer]
5766
+ #
5767
+ # @!attribute [rw] channel_subtype
5768
+ # The channel subtype this message template applies to.
5769
+ # @return [String]
5770
+ #
5771
+ # @!attribute [rw] created_time
5772
+ # The timestamp when the message template was created.
5773
+ # @return [Time]
5774
+ #
5775
+ # @!attribute [rw] description
5776
+ # The description of the message template.
5777
+ # @return [String]
5778
+ #
5779
+ # @!attribute [rw] knowledge_base_arn
5780
+ # The Amazon Resource Name (ARN) of the knowledge base.
5781
+ # @return [String]
5782
+ #
5783
+ # @!attribute [rw] knowledge_base_id
5784
+ # The identifier of the knowledge base.
5785
+ # @return [String]
5786
+ #
5787
+ # @!attribute [rw] last_modified_by
5788
+ # The Amazon Resource Name (ARN) of the user who last updated the
5789
+ # message template data.
5790
+ # @return [String]
5791
+ #
5792
+ # @!attribute [rw] last_modified_time
5793
+ # The timestamp when the message template data was last modified.
5794
+ # @return [Time]
4219
5795
  #
4220
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponsesResponse AWS API Documentation
5796
+ # @!attribute [rw] message_template_arn
5797
+ # The Amazon Resource Name (ARN) of the message template.
5798
+ # @return [String]
4221
5799
  #
4222
- class ListQuickResponsesResponse < Struct.new(
4223
- :next_token,
4224
- :quick_response_summaries)
4225
- SENSITIVE = []
4226
- include Aws::Structure
4227
- end
4228
-
4229
- # @!attribute [rw] resource_arn
4230
- # The Amazon Resource Name (ARN) of the resource.
5800
+ # @!attribute [rw] message_template_id
5801
+ # The identifier of the message template.
4231
5802
  # @return [String]
4232
5803
  #
4233
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceRequest AWS API Documentation
5804
+ # @!attribute [rw] name
5805
+ # The name of the message template.
5806
+ # @return [String]
4234
5807
  #
4235
- class ListTagsForResourceRequest < Struct.new(
4236
- :resource_arn)
4237
- SENSITIVE = []
4238
- include Aws::Structure
4239
- end
4240
-
4241
5808
  # @!attribute [rw] tags
4242
5809
  # The tags used to organize, track, or control access for this
4243
5810
  # resource.
4244
5811
  # @return [Hash<String,String>]
4245
5812
  #
4246
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceResponse AWS API Documentation
5813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSummary AWS API Documentation
4247
5814
  #
4248
- class ListTagsForResourceResponse < Struct.new(
5815
+ class MessageTemplateSummary < Struct.new(
5816
+ :active_version_number,
5817
+ :channel_subtype,
5818
+ :created_time,
5819
+ :description,
5820
+ :knowledge_base_arn,
5821
+ :knowledge_base_id,
5822
+ :last_modified_by,
5823
+ :last_modified_time,
5824
+ :message_template_arn,
5825
+ :message_template_id,
5826
+ :name,
4249
5827
  :tags)
4250
5828
  SENSITIVE = []
4251
5829
  include Aws::Structure
4252
5830
  end
4253
5831
 
4254
- # Source configuration for managed resources.
5832
+ # The summary of the message template version.
4255
5833
  #
4256
- # @note ManagedSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
5834
+ # @!attribute [rw] channel_subtype
5835
+ # The channel subtype this message template applies to.
5836
+ # @return [String]
4257
5837
  #
4258
- # @note ManagedSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ManagedSourceConfiguration corresponding to the set member.
5838
+ # @!attribute [rw] is_active
5839
+ # Whether the version of the message template is activated.
5840
+ # @return [Boolean]
4259
5841
  #
4260
- # @!attribute [rw] web_crawler_configuration
4261
- # Configuration data for web crawler data source.
4262
- # @return [Types::WebCrawlerConfiguration]
5842
+ # @!attribute [rw] knowledge_base_arn
5843
+ # The Amazon Resource Name (ARN) of the knowledge base.
5844
+ # @return [String]
4263
5845
  #
4264
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManagedSourceConfiguration AWS API Documentation
5846
+ # @!attribute [rw] knowledge_base_id
5847
+ # The identifier of the knowledge base.
5848
+ # @return [String]
4265
5849
  #
4266
- class ManagedSourceConfiguration < Struct.new(
4267
- :web_crawler_configuration,
4268
- :unknown)
4269
- SENSITIVE = []
4270
- include Aws::Structure
4271
- include Aws::Structure::Union
4272
-
4273
- class WebCrawlerConfiguration < ManagedSourceConfiguration; end
4274
- class Unknown < ManagedSourceConfiguration; end
4275
- end
4276
-
4277
- # The configuration for the `MANUAL_SEARCH` AI Agent type.
5850
+ # @!attribute [rw] message_template_arn
5851
+ # The Amazon Resource Name (ARN) of the message template.
5852
+ # @return [String]
4278
5853
  #
4279
- # @!attribute [rw] answer_generation_ai_prompt_id
4280
- # The AI Prompt identifier for the Answer Generation prompt used by
4281
- # the MANUAL\_SEARCH AI Agent.
5854
+ # @!attribute [rw] message_template_id
5855
+ # The identifier of the message template.
4282
5856
  # @return [String]
4283
5857
  #
4284
- # @!attribute [rw] association_configurations
4285
- # The association configurations for overriding behavior on this AI
4286
- # Agent.
4287
- # @return [Array<Types::AssociationConfiguration>]
5858
+ # @!attribute [rw] name
5859
+ # The name of the message template.
5860
+ # @return [String]
4288
5861
  #
4289
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManualSearchAIAgentConfiguration AWS API Documentation
5862
+ # @!attribute [rw] version_number
5863
+ # The version number of the message template version.
5864
+ # @return [Integer]
4290
5865
  #
4291
- class ManualSearchAIAgentConfiguration < Struct.new(
4292
- :answer_generation_ai_prompt_id,
4293
- :association_configurations)
5866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateVersionSummary AWS API Documentation
5867
+ #
5868
+ class MessageTemplateVersionSummary < Struct.new(
5869
+ :channel_subtype,
5870
+ :is_active,
5871
+ :knowledge_base_arn,
5872
+ :knowledge_base_id,
5873
+ :message_template_arn,
5874
+ :message_template_id,
5875
+ :name,
5876
+ :version_number)
4294
5877
  SENSITIVE = []
4295
5878
  include Aws::Structure
4296
5879
  end
@@ -4757,7 +6340,9 @@ module Aws::QConnect
4757
6340
  #
4758
6341
  # @!attribute [rw] language
4759
6342
  # The language code value for the language in which the quick response
4760
- # is written.
6343
+ # is written. The supported language codes include `de_DE`, `en_US`,
6344
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
6345
+ # `zh_CN`, `zh_TW`
4761
6346
  # @return [String]
4762
6347
  #
4763
6348
  # @!attribute [rw] last_modified_by
@@ -5393,10 +6978,60 @@ module Aws::QConnect
5393
6978
  #
5394
6979
  class RemoveKnowledgeBaseTemplateUriResponse < Aws::EmptyStructure; end
5395
6980
 
6981
+ # @!attribute [rw] attributes
6982
+ # An object that specifies the values to use for variables in the
6983
+ # message template. This object contains different categories of
6984
+ # key-value pairs. Each key defines a variable or placeholder in the
6985
+ # message template. The corresponding value defines the value for that
6986
+ # variable.
6987
+ # @return [Types::MessageTemplateAttributes]
6988
+ #
6989
+ # @!attribute [rw] knowledge_base_id
6990
+ # The identifier of the knowledge base. Can be either the ID or the
6991
+ # ARN. URLs cannot contain the ARN.
6992
+ # @return [String]
6993
+ #
6994
+ # @!attribute [rw] message_template_id
6995
+ # The identifier of the message template. Can be either the ID or the
6996
+ # ARN.
6997
+ # @return [String]
6998
+ #
6999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderMessageTemplateRequest AWS API Documentation
7000
+ #
7001
+ class RenderMessageTemplateRequest < Struct.new(
7002
+ :attributes,
7003
+ :knowledge_base_id,
7004
+ :message_template_id)
7005
+ SENSITIVE = []
7006
+ include Aws::Structure
7007
+ end
7008
+
7009
+ # @!attribute [rw] attachments
7010
+ # The message template attachments.
7011
+ # @return [Array<Types::MessageTemplateAttachment>]
7012
+ #
7013
+ # @!attribute [rw] attributes_not_interpolated
7014
+ # The attribute keys that are not resolved.
7015
+ # @return [Array<String>]
7016
+ #
7017
+ # @!attribute [rw] content
7018
+ # The content of the message template.
7019
+ # @return [Types::MessageTemplateContentProvider]
7020
+ #
7021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderMessageTemplateResponse AWS API Documentation
7022
+ #
7023
+ class RenderMessageTemplateResponse < Struct.new(
7024
+ :attachments,
7025
+ :attributes_not_interpolated,
7026
+ :content)
7027
+ SENSITIVE = [:attributes_not_interpolated]
7028
+ include Aws::Structure
7029
+ end
7030
+
5396
7031
  # Information about how to render the content.
5397
7032
  #
5398
7033
  # @!attribute [rw] template_uri
5399
- # A URI template containing exactly one variable in `$\{variableName\}
7034
+ # A URI template containing exactly one variable in `${variableName}
5400
7035
  # `format. This can only be set for `EXTERNAL` knowledge bases. For
5401
7036
  # Salesforce, ServiceNow, and Zendesk, the variable must be one of the
5402
7037
  # following:
@@ -5535,6 +7170,35 @@ module Aws::QConnect
5535
7170
  class Unknown < RuntimeSessionDataValue; end
5536
7171
  end
5537
7172
 
7173
+ # The content of the message template that applies to the SMS channel
7174
+ # subtype.
7175
+ #
7176
+ # @!attribute [rw] body
7177
+ # The body to use in SMS messages.
7178
+ # @return [Types::SMSMessageTemplateContentBody]
7179
+ #
7180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SMSMessageTemplateContent AWS API Documentation
7181
+ #
7182
+ class SMSMessageTemplateContent < Struct.new(
7183
+ :body)
7184
+ SENSITIVE = []
7185
+ include Aws::Structure
7186
+ end
7187
+
7188
+ # The body to use in SMS messages.
7189
+ #
7190
+ # @!attribute [rw] plain_text
7191
+ # The message body to use in SMS messages.
7192
+ # @return [Types::MessageTemplateBodyContentProvider]
7193
+ #
7194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SMSMessageTemplateContentBody AWS API Documentation
7195
+ #
7196
+ class SMSMessageTemplateContentBody < Struct.new(
7197
+ :plain_text)
7198
+ SENSITIVE = []
7199
+ include Aws::Structure
7200
+ end
7201
+
5538
7202
  # @!attribute [rw] knowledge_base_id
5539
7203
  # The identifier of the knowledge base. This should not be a
5540
7204
  # QUICK\_RESPONSES type knowledge base. Can be either the ID or the
@@ -5598,6 +7262,54 @@ module Aws::QConnect
5598
7262
  include Aws::Structure
5599
7263
  end
5600
7264
 
7265
+ # @!attribute [rw] knowledge_base_id
7266
+ # The identifier of the knowledge base. Can be either the ID or the
7267
+ # ARN. URLs cannot contain the ARN.
7268
+ # @return [String]
7269
+ #
7270
+ # @!attribute [rw] max_results
7271
+ # The maximum number of results to return per page.
7272
+ # @return [Integer]
7273
+ #
7274
+ # @!attribute [rw] next_token
7275
+ # The token for the next set of results. Use the value returned in the
7276
+ # previous response in the next request to retrieve the next set of
7277
+ # results.
7278
+ # @return [String]
7279
+ #
7280
+ # @!attribute [rw] search_expression
7281
+ # The search expression for querying the message template.
7282
+ # @return [Types::MessageTemplateSearchExpression]
7283
+ #
7284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchMessageTemplatesRequest AWS API Documentation
7285
+ #
7286
+ class SearchMessageTemplatesRequest < Struct.new(
7287
+ :knowledge_base_id,
7288
+ :max_results,
7289
+ :next_token,
7290
+ :search_expression)
7291
+ SENSITIVE = []
7292
+ include Aws::Structure
7293
+ end
7294
+
7295
+ # @!attribute [rw] next_token
7296
+ # If there are additional results, this is the token for the next set
7297
+ # of results.
7298
+ # @return [String]
7299
+ #
7300
+ # @!attribute [rw] results
7301
+ # The results of the message template search.
7302
+ # @return [Array<Types::MessageTemplateSearchResultData>]
7303
+ #
7304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchMessageTemplatesResponse AWS API Documentation
7305
+ #
7306
+ class SearchMessageTemplatesResponse < Struct.new(
7307
+ :next_token,
7308
+ :results)
7309
+ SENSITIVE = []
7310
+ include Aws::Structure
7311
+ end
7312
+
5601
7313
  # @!attribute [rw] attributes
5602
7314
  # The [user-defined Amazon Connect contact attributes][1] to be
5603
7315
  # resolved when search results are returned.
@@ -6067,6 +7779,47 @@ module Aws::QConnect
6067
7779
  include Aws::Structure
6068
7780
  end
6069
7781
 
7782
+ # The system attributes that are used with the message template.
7783
+ #
7784
+ # @!attribute [rw] customer_endpoint
7785
+ # The CustomerEndpoint attribute.
7786
+ # @return [Types::SystemEndpointAttributes]
7787
+ #
7788
+ # @!attribute [rw] name
7789
+ # The name of the task.
7790
+ # @return [String]
7791
+ #
7792
+ # @!attribute [rw] system_endpoint
7793
+ # The SystemEndpoint attribute.
7794
+ # @return [Types::SystemEndpointAttributes]
7795
+ #
7796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SystemAttributes AWS API Documentation
7797
+ #
7798
+ class SystemAttributes < Struct.new(
7799
+ :customer_endpoint,
7800
+ :name,
7801
+ :system_endpoint)
7802
+ SENSITIVE = [:name]
7803
+ include Aws::Structure
7804
+ end
7805
+
7806
+ # The system endpoint attributes that are used with the message
7807
+ # template.
7808
+ #
7809
+ # @!attribute [rw] address
7810
+ # The customer's phone number if used with `customerEndpoint`, or the
7811
+ # number the customer dialed to call your contact center if used with
7812
+ # `systemEndpoint`.
7813
+ # @return [String]
7814
+ #
7815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SystemEndpointAttributes AWS API Documentation
7816
+ #
7817
+ class SystemEndpointAttributes < Struct.new(
7818
+ :address)
7819
+ SENSITIVE = [:address]
7820
+ include Aws::Structure
7821
+ end
7822
+
6070
7823
  # A leaf node condition which can be used to specify a tag condition.
6071
7824
  #
6072
7825
  # @!attribute [rw] key
@@ -6243,9 +7996,9 @@ module Aws::QConnect
6243
7996
  #
6244
7997
  # @!attribute [rw] client_token
6245
7998
  # A unique, case-sensitive identifier that you provide to ensure the
6246
- # idempotency of the request. If not provided, the AWS SDK populates
6247
- # this field. For more information about idempotency, see [Making
6248
- # retries safe with idempotent APIs][1].
7999
+ # idempotency of the request. If not provided, the Amazon Web Services
8000
+ # SDK populates this field. For more information about idempotency,
8001
+ # see [Making retries safe with idempotent APIs][1]..
6249
8002
  #
6250
8003
  # **A suitable default value is auto-generated.** You should normally
6251
8004
  # not need to pass this option.
@@ -6303,16 +8056,16 @@ module Aws::QConnect
6303
8056
  #
6304
8057
  # @!attribute [rw] client_token
6305
8058
  # A unique, case-sensitive identifier that you provide to ensure the
6306
- # idempotency of the request. If not provided, the AWS SDK populates
6307
- # this field. For more information about idempotency, see [Making
6308
- # retries safe with idempotent APIs][1].
8059
+ # idempotency of the request. If not provided, the Amazon Web Services
8060
+ # SDK populates this field. For more information about idempotency,
8061
+ # see [Making retries safe with idempotent APIs][1]..
6309
8062
  #
6310
8063
  # **A suitable default value is auto-generated.** You should normally
6311
8064
  # not need to pass this option.
6312
8065
  #
6313
8066
  #
6314
8067
  #
6315
- # [1]: http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
8068
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
6316
8069
  # @return [String]
6317
8070
  #
6318
8071
  # @!attribute [rw] description
@@ -6498,6 +8251,106 @@ module Aws::QConnect
6498
8251
  include Aws::Structure
6499
8252
  end
6500
8253
 
8254
+ # @!attribute [rw] description
8255
+ # The description of the message template.
8256
+ # @return [String]
8257
+ #
8258
+ # @!attribute [rw] grouping_configuration
8259
+ # The configuration information of the grouping of Amazon Q in Connect
8260
+ # users.
8261
+ # @return [Types::GroupingConfiguration]
8262
+ #
8263
+ # @!attribute [rw] knowledge_base_id
8264
+ # The identifier of the knowledge base. Can be either the ID or the
8265
+ # ARN. URLs cannot contain the ARN.
8266
+ # @return [String]
8267
+ #
8268
+ # @!attribute [rw] message_template_id
8269
+ # The identifier of the message template. Can be either the ID or the
8270
+ # ARN. It cannot contain any qualifier.
8271
+ # @return [String]
8272
+ #
8273
+ # @!attribute [rw] name
8274
+ # The name of the message template.
8275
+ # @return [String]
8276
+ #
8277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateMetadataRequest AWS API Documentation
8278
+ #
8279
+ class UpdateMessageTemplateMetadataRequest < Struct.new(
8280
+ :description,
8281
+ :grouping_configuration,
8282
+ :knowledge_base_id,
8283
+ :message_template_id,
8284
+ :name)
8285
+ SENSITIVE = []
8286
+ include Aws::Structure
8287
+ end
8288
+
8289
+ # @!attribute [rw] message_template
8290
+ # The message template.
8291
+ # @return [Types::MessageTemplateData]
8292
+ #
8293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateMetadataResponse AWS API Documentation
8294
+ #
8295
+ class UpdateMessageTemplateMetadataResponse < Struct.new(
8296
+ :message_template)
8297
+ SENSITIVE = []
8298
+ include Aws::Structure
8299
+ end
8300
+
8301
+ # @!attribute [rw] content
8302
+ # The content of the message template.
8303
+ # @return [Types::MessageTemplateContentProvider]
8304
+ #
8305
+ # @!attribute [rw] default_attributes
8306
+ # An object that specifies the default values to use for variables in
8307
+ # the message template. This object contains different categories of
8308
+ # key-value pairs. Each key defines a variable or placeholder in the
8309
+ # message template. The corresponding value defines the default value
8310
+ # for that variable.
8311
+ # @return [Types::MessageTemplateAttributes]
8312
+ #
8313
+ # @!attribute [rw] knowledge_base_id
8314
+ # The identifier of the knowledge base. Can be either the ID or the
8315
+ # ARN. URLs cannot contain the ARN.
8316
+ # @return [String]
8317
+ #
8318
+ # @!attribute [rw] language
8319
+ # The language code value for the language in which the quick response
8320
+ # is written. The supported language codes include `de_DE`, `en_US`,
8321
+ # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
8322
+ # `zh_CN`, `zh_TW`
8323
+ # @return [String]
8324
+ #
8325
+ # @!attribute [rw] message_template_id
8326
+ # The identifier of the message template. Can be either the ID or the
8327
+ # ARN. It cannot contain any qualifier.
8328
+ # @return [String]
8329
+ #
8330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateRequest AWS API Documentation
8331
+ #
8332
+ class UpdateMessageTemplateRequest < Struct.new(
8333
+ :content,
8334
+ :default_attributes,
8335
+ :knowledge_base_id,
8336
+ :language,
8337
+ :message_template_id)
8338
+ SENSITIVE = []
8339
+ include Aws::Structure
8340
+ end
8341
+
8342
+ # @!attribute [rw] message_template
8343
+ # The message template.
8344
+ # @return [Types::MessageTemplateData]
8345
+ #
8346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateResponse AWS API Documentation
8347
+ #
8348
+ class UpdateMessageTemplateResponse < Struct.new(
8349
+ :message_template)
8350
+ SENSITIVE = []
8351
+ include Aws::Structure
8352
+ end
8353
+
6501
8354
  # @!attribute [rw] channels
6502
8355
  # The Amazon Connect contact channels this quick response applies to.
6503
8356
  # The supported contact channel types include `Chat`.