aws-sdk-connectparticipant 1.19.0 → 1.36.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +88 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-connectparticipant/client.rb +225 -37
- data/lib/aws-sdk-connectparticipant/client_api.rb +73 -1
- data/lib/aws-sdk-connectparticipant/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-connectparticipant/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-connectparticipant/endpoints.rb +142 -0
- data/lib/aws-sdk-connectparticipant/errors.rb +26 -0
- data/lib/aws-sdk-connectparticipant/plugins/endpoints.rb +86 -0
- data/lib/aws-sdk-connectparticipant/types.rb +249 -101
- data/lib/aws-sdk-connectparticipant.rb +5 -1
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9b22a335b4bd8e2f90b0f37f89a31cf9feb24659e7e554e6cae1bc4bbacad906
|
4
|
+
data.tar.gz: 50099e1e32120b7f1f23926c4e96dd017da007a7ed8423bcac5a7eb0a055759b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f747b6c3cfaa106328677b71b5dc122010a26dcbaaf08bdb9c573fcbaeb901f2b4ffa7bda95bcbd6f60c818bdd6ecd4ac995efa22f5663677e0b5d6f9e7732fd
|
7
|
+
data.tar.gz: ad872596e0436a42634e9a57408f91ae2e3e10fa00dbf706e77e705f16bd1a513abad17a9c5a874602fe4ea429be323164007e5e4fb06b4984321971db76e871
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,93 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.36.0 (2023-09-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.35.0 (2023-08-31)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Connect Participant Service adds the ability to get a view resource using a view token, which is provided in a participant message, with the release of the DescribeView API.
|
13
|
+
|
14
|
+
1.34.0 (2023-07-11)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.33.0 (2023-07-06)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
24
|
+
1.32.0 (2023-06-28)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.31.0 (2023-06-15)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
33
|
+
|
34
|
+
1.30.0 (2023-05-31)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
38
|
+
|
39
|
+
1.29.0 (2023-03-27)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - This release provides an update to the SendMessage API to handle interactive message response content-types.
|
43
|
+
|
44
|
+
1.28.0 (2023-01-31)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Enabled FIPS endpoints for GovCloud (US) regions in SDK.
|
48
|
+
|
49
|
+
1.27.0 (2023-01-19)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Feature - This release updates Amazon Connect Participant's GetTranscript api to provide transcripts of past chats on a persistent chat session.
|
53
|
+
|
54
|
+
1.26.0 (2023-01-18)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
58
|
+
|
59
|
+
* Issue - Replace runtime endpoint resolution approach with generated ruby code.
|
60
|
+
|
61
|
+
1.25.0 (2022-12-23)
|
62
|
+
------------------
|
63
|
+
|
64
|
+
* Feature - Amazon Connect Chat introduces the Message Receipts feature. This feature allows agents and customers to receive message delivered and read receipts after they send a chat message.
|
65
|
+
|
66
|
+
1.24.0 (2022-12-21)
|
67
|
+
------------------
|
68
|
+
|
69
|
+
* Feature - Amazon Connect Chat now allows for JSON (application/json) message types to be sent in the SendMessage API.
|
70
|
+
|
71
|
+
1.23.0 (2022-10-25)
|
72
|
+
------------------
|
73
|
+
|
74
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
75
|
+
|
76
|
+
1.22.0 (2022-02-24)
|
77
|
+
------------------
|
78
|
+
|
79
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
80
|
+
|
81
|
+
1.21.0 (2022-02-03)
|
82
|
+
------------------
|
83
|
+
|
84
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
85
|
+
|
86
|
+
1.20.0 (2021-12-21)
|
87
|
+
------------------
|
88
|
+
|
89
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
90
|
+
|
4
91
|
1.19.0 (2021-11-30)
|
5
92
|
------------------
|
6
93
|
|
@@ -105,4 +192,4 @@ Unreleased Changes
|
|
105
192
|
1.0.0 (2019-11-21)
|
106
193
|
------------------
|
107
194
|
|
108
|
-
* Feature - Initial release of `aws-sdk-connectparticipant`.
|
195
|
+
* Feature - Initial release of `aws-sdk-connectparticipant`.
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.36.0
|
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
-
require 'aws-sdk-core/plugins/
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
31
35
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
36
|
|
33
37
|
Aws::Plugins::GlobalConfiguration.add_identifier(:connectparticipant)
|
@@ -73,8 +77,13 @@ module Aws::ConnectParticipant
|
|
73
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
-
add_plugin(Aws::Plugins::
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
77
85
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
86
|
+
add_plugin(Aws::ConnectParticipant::Plugins::Endpoints)
|
78
87
|
|
79
88
|
# @overload initialize(options)
|
80
89
|
# @param [Hash] options
|
@@ -175,10 +184,18 @@ module Aws::ConnectParticipant
|
|
175
184
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
185
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
186
|
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
178
191
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
192
|
# Set to true to disable SDK automatically adding host prefix
|
180
193
|
# to default service endpoint when available.
|
181
194
|
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
182
199
|
# @option options [String] :endpoint
|
183
200
|
# The client endpoint is normally constructed from the `:region`
|
184
201
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -199,6 +216,10 @@ module Aws::ConnectParticipant
|
|
199
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
200
217
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
201
218
|
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
202
223
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
203
224
|
# The log formatter.
|
204
225
|
#
|
@@ -219,6 +240,11 @@ module Aws::ConnectParticipant
|
|
219
240
|
# Used when loading credentials from the shared credentials file
|
220
241
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
221
242
|
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
222
248
|
# @option options [Proc] :retry_backoff
|
223
249
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
224
250
|
# This option is only used in the `legacy` retry mode.
|
@@ -264,6 +290,11 @@ module Aws::ConnectParticipant
|
|
264
290
|
# in the future.
|
265
291
|
#
|
266
292
|
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
267
298
|
# @option options [String] :secret_access_key
|
268
299
|
#
|
269
300
|
# @option options [String] :session_token
|
@@ -277,6 +308,19 @@ module Aws::ConnectParticipant
|
|
277
308
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
278
309
|
# requests are made, and retries are disabled.
|
279
310
|
#
|
311
|
+
# @option options [Aws::TokenProvider] :token_provider
|
312
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
313
|
+
# following classes:
|
314
|
+
#
|
315
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
316
|
+
# tokens.
|
317
|
+
#
|
318
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
319
|
+
# access token generated from `aws login`.
|
320
|
+
#
|
321
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
322
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
323
|
+
#
|
280
324
|
# @option options [Boolean] :use_dualstack_endpoint
|
281
325
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
326
|
# will be used if available.
|
@@ -290,6 +334,9 @@ module Aws::ConnectParticipant
|
|
290
334
|
# When `true`, request parameters are validated before
|
291
335
|
# sending the request.
|
292
336
|
#
|
337
|
+
# @option options [Aws::ConnectParticipant::EndpointProvider] :endpoint_provider
|
338
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ConnectParticipant::EndpointParameters`
|
339
|
+
#
|
293
340
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
294
341
|
# requests through. Formatted like 'http://proxy.com:123'.
|
295
342
|
#
|
@@ -297,7 +344,7 @@ module Aws::ConnectParticipant
|
|
297
344
|
# seconds to wait when opening a HTTP session before raising a
|
298
345
|
# `Timeout::Error`.
|
299
346
|
#
|
300
|
-
# @option options [
|
347
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
348
|
# number of seconds to wait for response data. This value can
|
302
349
|
# safely be set per-request on the session.
|
303
350
|
#
|
@@ -313,6 +360,9 @@ module Aws::ConnectParticipant
|
|
313
360
|
# disables this behaviour. This value can safely be set per
|
314
361
|
# request on the session.
|
315
362
|
#
|
363
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
364
|
+
# in seconds.
|
365
|
+
#
|
316
366
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
367
|
# HTTP debug output will be sent to the `:logger`.
|
318
368
|
#
|
@@ -341,6 +391,11 @@ module Aws::ConnectParticipant
|
|
341
391
|
# Allows you to confirm that the attachment has been uploaded using the
|
342
392
|
# pre-signed URL provided in StartAttachmentUpload API.
|
343
393
|
#
|
394
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
395
|
+
# `ParticipantToken`.
|
396
|
+
#
|
397
|
+
# </note>
|
398
|
+
#
|
344
399
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
345
400
|
# Version 4 authentication][1].
|
346
401
|
#
|
@@ -353,11 +408,17 @@ module Aws::ConnectParticipant
|
|
353
408
|
#
|
354
409
|
# @option params [required, String] :client_token
|
355
410
|
# A unique, case-sensitive identifier that you provide to ensure the
|
356
|
-
# idempotency of the request.
|
411
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
412
|
+
# SDK populates this field. For more information about idempotency, see
|
413
|
+
# [Making retries safe with idempotent APIs][1].
|
357
414
|
#
|
358
415
|
# **A suitable default value is auto-generated.** You should normally
|
359
416
|
# not need to pass this option.**
|
360
417
|
#
|
418
|
+
#
|
419
|
+
#
|
420
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
421
|
+
#
|
361
422
|
# @option params [required, String] :connection_token
|
362
423
|
# The authentication token associated with the participant's
|
363
424
|
# connection.
|
@@ -381,8 +442,12 @@ module Aws::ConnectParticipant
|
|
381
442
|
req.send_request(options)
|
382
443
|
end
|
383
444
|
|
384
|
-
# Creates the participant's connection.
|
385
|
-
#
|
445
|
+
# Creates the participant's connection.
|
446
|
+
#
|
447
|
+
# <note markdown="1"> `ParticipantToken` is used for invoking this API instead of
|
448
|
+
# `ConnectionToken`.
|
449
|
+
#
|
450
|
+
# </note>
|
386
451
|
#
|
387
452
|
# The participant token is valid for the lifetime of the participant –
|
388
453
|
# until they are part of a contact.
|
@@ -400,13 +465,13 @@ module Aws::ConnectParticipant
|
|
400
465
|
# ConnectionExpiry parameter, clients need to call this API again to
|
401
466
|
# obtain a new websocket URL and perform the same steps as before.
|
402
467
|
#
|
403
|
-
# **Message streaming support
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
468
|
+
# **Message streaming support**: This API can also be used together with
|
469
|
+
# the [StartContactStreaming][1] API to create a participant connection
|
470
|
+
# for chat contacts that are not using a websocket. For more information
|
471
|
+
# about message streaming, [Enable real-time chat message streaming][2]
|
472
|
+
# in the *Amazon Connect Administrator Guide*.
|
408
473
|
#
|
409
|
-
# **Feature specifications
|
474
|
+
# **Feature specifications**: For information about feature
|
410
475
|
# specifications, such as the allowed number of open websocket
|
411
476
|
# connections per participant, see [Feature specifications][3] in the
|
412
477
|
# *Amazon Connect Administrator Guide*.
|
@@ -423,8 +488,10 @@ module Aws::ConnectParticipant
|
|
423
488
|
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
|
424
489
|
# [4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
425
490
|
#
|
426
|
-
# @option params [
|
427
|
-
# Type of connection information required.
|
491
|
+
# @option params [Array<String>] :type
|
492
|
+
# Type of connection information required. If you need
|
493
|
+
# `CONNECTION_CREDENTIALS` along with marking participant as connected,
|
494
|
+
# pass `CONNECTION_CREDENTIALS` in `Type`.
|
428
495
|
#
|
429
496
|
# @option params [required, String] :participant_token
|
430
497
|
# This is a header parameter.
|
@@ -438,7 +505,8 @@ module Aws::ConnectParticipant
|
|
438
505
|
#
|
439
506
|
# @option params [Boolean] :connect_participant
|
440
507
|
# Amazon Connect Participant is used to mark the participant as
|
441
|
-
# connected for message streaming
|
508
|
+
# connected for customer participant in message streaming, as well as
|
509
|
+
# for agent or manager participant in non-streaming chats.
|
442
510
|
#
|
443
511
|
# @return [Types::CreateParticipantConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
444
512
|
#
|
@@ -448,7 +516,7 @@ module Aws::ConnectParticipant
|
|
448
516
|
# @example Request syntax with placeholder values
|
449
517
|
#
|
450
518
|
# resp = client.create_participant_connection({
|
451
|
-
# type: ["WEBSOCKET"], #
|
519
|
+
# type: ["WEBSOCKET"], # accepts WEBSOCKET, CONNECTION_CREDENTIALS
|
452
520
|
# participant_token: "ParticipantToken", # required
|
453
521
|
# connect_participant: false,
|
454
522
|
# })
|
@@ -469,8 +537,52 @@ module Aws::ConnectParticipant
|
|
469
537
|
req.send_request(options)
|
470
538
|
end
|
471
539
|
|
472
|
-
#
|
473
|
-
#
|
540
|
+
# Retrieves the view for the specified view token.
|
541
|
+
#
|
542
|
+
# @option params [required, String] :view_token
|
543
|
+
# An encrypted token originating from the interactive message of a
|
544
|
+
# ShowView block operation. Represents the desired view.
|
545
|
+
#
|
546
|
+
# @option params [required, String] :connection_token
|
547
|
+
# The connection token.
|
548
|
+
#
|
549
|
+
# @return [Types::DescribeViewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
550
|
+
#
|
551
|
+
# * {Types::DescribeViewResponse#view #view} => Types::View
|
552
|
+
#
|
553
|
+
# @example Request syntax with placeholder values
|
554
|
+
#
|
555
|
+
# resp = client.describe_view({
|
556
|
+
# view_token: "ViewToken", # required
|
557
|
+
# connection_token: "ParticipantToken", # required
|
558
|
+
# })
|
559
|
+
#
|
560
|
+
# @example Response structure
|
561
|
+
#
|
562
|
+
# resp.view.id #=> String
|
563
|
+
# resp.view.arn #=> String
|
564
|
+
# resp.view.name #=> String
|
565
|
+
# resp.view.version #=> Integer
|
566
|
+
# resp.view.content.input_schema #=> String
|
567
|
+
# resp.view.content.template #=> String
|
568
|
+
# resp.view.content.actions #=> Array
|
569
|
+
# resp.view.content.actions[0] #=> String
|
570
|
+
#
|
571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/DescribeView AWS API Documentation
|
572
|
+
#
|
573
|
+
# @overload describe_view(params = {})
|
574
|
+
# @param [Hash] params ({})
|
575
|
+
def describe_view(params = {}, options = {})
|
576
|
+
req = build_request(:describe_view, params)
|
577
|
+
req.send_request(options)
|
578
|
+
end
|
579
|
+
|
580
|
+
# Disconnects a participant.
|
581
|
+
#
|
582
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
583
|
+
# `ParticipantToken`.
|
584
|
+
#
|
585
|
+
# </note>
|
474
586
|
#
|
475
587
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
476
588
|
# Version 4 authentication][1].
|
@@ -481,11 +593,17 @@ module Aws::ConnectParticipant
|
|
481
593
|
#
|
482
594
|
# @option params [String] :client_token
|
483
595
|
# A unique, case-sensitive identifier that you provide to ensure the
|
484
|
-
# idempotency of the request.
|
596
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
597
|
+
# SDK populates this field. For more information about idempotency, see
|
598
|
+
# [Making retries safe with idempotent APIs][1].
|
485
599
|
#
|
486
600
|
# **A suitable default value is auto-generated.** You should normally
|
487
601
|
# not need to pass this option.**
|
488
602
|
#
|
603
|
+
#
|
604
|
+
#
|
605
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
606
|
+
#
|
489
607
|
# @option params [required, String] :connection_token
|
490
608
|
# The authentication token associated with the participant's
|
491
609
|
# connection.
|
@@ -511,6 +629,11 @@ module Aws::ConnectParticipant
|
|
511
629
|
# Provides a pre-signed URL for download of a completed attachment. This
|
512
630
|
# is an asynchronous API for use with active contacts.
|
513
631
|
#
|
632
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
633
|
+
# `ParticipantToken`.
|
634
|
+
#
|
635
|
+
# </note>
|
636
|
+
#
|
514
637
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
515
638
|
# Version 4 authentication][1].
|
516
639
|
#
|
@@ -552,15 +675,21 @@ module Aws::ConnectParticipant
|
|
552
675
|
end
|
553
676
|
|
554
677
|
# Retrieves a transcript of the session, including details about any
|
555
|
-
# attachments.
|
556
|
-
#
|
678
|
+
# attachments. For information about accessing past chat contact
|
679
|
+
# transcripts for a persistent chat, see [Enable persistent chat][1].
|
680
|
+
#
|
681
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
682
|
+
# `ParticipantToken`.
|
683
|
+
#
|
684
|
+
# </note>
|
557
685
|
#
|
558
686
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
559
|
-
# Version 4 authentication][
|
687
|
+
# Version 4 authentication][2].
|
560
688
|
#
|
561
689
|
#
|
562
690
|
#
|
563
|
-
# [1]: https://docs.aws.amazon.com/
|
691
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
|
692
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
564
693
|
#
|
565
694
|
# @option params [String] :contact_id
|
566
695
|
# The contactId from the current contact chain for which transcript is
|
@@ -620,15 +749,22 @@ module Aws::ConnectParticipant
|
|
620
749
|
# resp.transcript[0].content #=> String
|
621
750
|
# resp.transcript[0].content_type #=> String
|
622
751
|
# resp.transcript[0].id #=> String
|
623
|
-
# resp.transcript[0].type #=> String, one of "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK"
|
752
|
+
# resp.transcript[0].type #=> String, one of "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK", "MESSAGE_DELIVERED", "MESSAGE_READ"
|
624
753
|
# resp.transcript[0].participant_id #=> String
|
625
754
|
# resp.transcript[0].display_name #=> String
|
626
|
-
# resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM"
|
755
|
+
# resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
|
627
756
|
# resp.transcript[0].attachments #=> Array
|
628
757
|
# resp.transcript[0].attachments[0].content_type #=> String
|
629
758
|
# resp.transcript[0].attachments[0].attachment_id #=> String
|
630
759
|
# resp.transcript[0].attachments[0].attachment_name #=> String
|
631
760
|
# resp.transcript[0].attachments[0].status #=> String, one of "APPROVED", "REJECTED", "IN_PROGRESS"
|
761
|
+
# resp.transcript[0].message_metadata.message_id #=> String
|
762
|
+
# resp.transcript[0].message_metadata.receipts #=> Array
|
763
|
+
# resp.transcript[0].message_metadata.receipts[0].delivered_timestamp #=> String
|
764
|
+
# resp.transcript[0].message_metadata.receipts[0].read_timestamp #=> String
|
765
|
+
# resp.transcript[0].message_metadata.receipts[0].recipient_participant_id #=> String
|
766
|
+
# resp.transcript[0].related_contact_id #=> String
|
767
|
+
# resp.transcript[0].contact_id #=> String
|
632
768
|
# resp.next_token #=> String
|
633
769
|
#
|
634
770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/GetTranscript AWS API Documentation
|
@@ -640,8 +776,12 @@ module Aws::ConnectParticipant
|
|
640
776
|
req.send_request(options)
|
641
777
|
end
|
642
778
|
|
643
|
-
# Sends an event.
|
644
|
-
#
|
779
|
+
# Sends an event.
|
780
|
+
#
|
781
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
782
|
+
# `ParticipantToken`.
|
783
|
+
#
|
784
|
+
# </note>
|
645
785
|
#
|
646
786
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
647
787
|
# Version 4 authentication][1].
|
@@ -657,17 +797,31 @@ module Aws::ConnectParticipant
|
|
657
797
|
#
|
658
798
|
# * application/vnd.amazonaws.connect.event.connection.acknowledged
|
659
799
|
#
|
800
|
+
# * application/vnd.amazonaws.connect.event.message.delivered
|
801
|
+
#
|
802
|
+
# * application/vnd.amazonaws.connect.event.message.read
|
803
|
+
#
|
660
804
|
# @option params [String] :content
|
661
|
-
# The content of the event to be sent (for example, message text).
|
662
|
-
# is
|
805
|
+
# The content of the event to be sent (for example, message text). For
|
806
|
+
# content related to message receipts, this is supported in the form of
|
807
|
+
# a JSON string.
|
808
|
+
#
|
809
|
+
# Sample Content:
|
810
|
+
# "\\\{\\"messageId\\":\\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\\"\\}"
|
663
811
|
#
|
664
812
|
# @option params [String] :client_token
|
665
813
|
# A unique, case-sensitive identifier that you provide to ensure the
|
666
|
-
# idempotency of the request.
|
814
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
815
|
+
# SDK populates this field. For more information about idempotency, see
|
816
|
+
# [Making retries safe with idempotent APIs][1].
|
667
817
|
#
|
668
818
|
# **A suitable default value is auto-generated.** You should normally
|
669
819
|
# not need to pass this option.**
|
670
820
|
#
|
821
|
+
#
|
822
|
+
#
|
823
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
824
|
+
#
|
671
825
|
# @option params [required, String] :connection_token
|
672
826
|
# The authentication token associated with the participant's
|
673
827
|
# connection.
|
@@ -700,8 +854,12 @@ module Aws::ConnectParticipant
|
|
700
854
|
req.send_request(options)
|
701
855
|
end
|
702
856
|
|
703
|
-
# Sends a message.
|
704
|
-
#
|
857
|
+
# Sends a message.
|
858
|
+
#
|
859
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
860
|
+
# `ParticipantToken`.
|
861
|
+
#
|
862
|
+
# </note>
|
705
863
|
#
|
706
864
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
707
865
|
# Version 4 authentication][1].
|
@@ -711,18 +869,36 @@ module Aws::ConnectParticipant
|
|
711
869
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
712
870
|
#
|
713
871
|
# @option params [required, String] :content_type
|
714
|
-
# The type of the content. Supported types are text/plain
|
872
|
+
# The type of the content. Supported types are `text/plain`,
|
873
|
+
# `text/markdown`, `application/json`, and
|
874
|
+
# `application/vnd.amazonaws.connect.message.interactive.response`.
|
715
875
|
#
|
716
876
|
# @option params [required, String] :content
|
717
877
|
# The content of the message.
|
718
878
|
#
|
879
|
+
# * For `text/plain` and `text/markdown`, the Length Constraints are
|
880
|
+
# Minimum of 1, Maximum of 1024.
|
881
|
+
#
|
882
|
+
# * For `application/json`, the Length Constraints are Minimum of 1,
|
883
|
+
# Maximum of 12000.
|
884
|
+
#
|
885
|
+
# * For
|
886
|
+
# `application/vnd.amazonaws.connect.message.interactive.response`,
|
887
|
+
# the Length Constraints are Minimum of 1, Maximum of 12288.
|
888
|
+
#
|
719
889
|
# @option params [String] :client_token
|
720
890
|
# A unique, case-sensitive identifier that you provide to ensure the
|
721
|
-
# idempotency of the request.
|
891
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
892
|
+
# SDK populates this field. For more information about idempotency, see
|
893
|
+
# [Making retries safe with idempotent APIs][1].
|
722
894
|
#
|
723
895
|
# **A suitable default value is auto-generated.** You should normally
|
724
896
|
# not need to pass this option.**
|
725
897
|
#
|
898
|
+
#
|
899
|
+
#
|
900
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
901
|
+
#
|
726
902
|
# @option params [required, String] :connection_token
|
727
903
|
# The authentication token associated with the connection.
|
728
904
|
#
|
@@ -757,6 +933,11 @@ module Aws::ConnectParticipant
|
|
757
933
|
# Provides a pre-signed Amazon S3 URL in response for uploading the file
|
758
934
|
# directly to S3.
|
759
935
|
#
|
936
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
937
|
+
# `ParticipantToken`.
|
938
|
+
#
|
939
|
+
# </note>
|
940
|
+
#
|
760
941
|
# The Amazon Connect Participant Service APIs do not use [Signature
|
761
942
|
# Version 4 authentication][1].
|
762
943
|
#
|
@@ -771,7 +952,7 @@ module Aws::ConnectParticipant
|
|
771
952
|
#
|
772
953
|
#
|
773
954
|
#
|
774
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
955
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html
|
775
956
|
#
|
776
957
|
# @option params [required, Integer] :attachment_size_in_bytes
|
777
958
|
# The size of the attachment in bytes.
|
@@ -780,11 +961,18 @@ module Aws::ConnectParticipant
|
|
780
961
|
# A case-sensitive name of the attachment being uploaded.
|
781
962
|
#
|
782
963
|
# @option params [required, String] :client_token
|
783
|
-
# A unique case
|
964
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
965
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
966
|
+
# SDK populates this field. For more information about idempotency, see
|
967
|
+
# [Making retries safe with idempotent APIs][1].
|
784
968
|
#
|
785
969
|
# **A suitable default value is auto-generated.** You should normally
|
786
970
|
# not need to pass this option.**
|
787
971
|
#
|
972
|
+
#
|
973
|
+
#
|
974
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
975
|
+
#
|
788
976
|
# @option params [required, String] :connection_token
|
789
977
|
# The authentication token associated with the participant's
|
790
978
|
# connection.
|
@@ -834,7 +1022,7 @@ module Aws::ConnectParticipant
|
|
834
1022
|
params: params,
|
835
1023
|
config: config)
|
836
1024
|
context[:gem_name] = 'aws-sdk-connectparticipant'
|
837
|
-
context[:gem_version] = '1.
|
1025
|
+
context[:gem_version] = '1.36.0'
|
838
1026
|
Seahorse::Client::Request.new(handlers, context)
|
839
1027
|
end
|
840
1028
|
|