aws-sdk-connectparticipant 1.66.0 → 1.68.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connectparticipant/client.rb +122 -36
- data/lib/aws-sdk-connectparticipant/client_api.rb +40 -0
- data/lib/aws-sdk-connectparticipant/types.rb +155 -3
- data/lib/aws-sdk-connectparticipant.rb +1 -1
- data/sig/client.rbs +2 -1
- data/sig/types.rbs +41 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 269d92104cf14719f7187269b9457f8f0ee25ab45bfb8acf9ef3359e92c27ef9
|
4
|
+
data.tar.gz: 18117d553e826d775f7545382bf6ea8c2671f497b2f3c577669bc92196f82690
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a63062a04f386865aa02195801bb4ee2e18ba8138fd946cfd3408341a84eab7f1d9119046032b29b3e674fc38a764d3a5892a9f6afaf6467cd14bcc2304d55b
|
7
|
+
data.tar.gz: 393381f4ae6175706318864acc48b6fd0010e464c0c68a4b80bd82e6accd60aa625f56f58395d2966246125e3e9d956776fe27de082ae309f58bf2286d0f3fbc
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.68.0 (2025-08-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Connect Service Feature: Add support to enable multi-user in-app, web, and video calling.
|
8
|
+
|
9
|
+
1.67.0 (2025-08-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.66.0 (2025-07-31)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.68.0
|
@@ -95,8 +95,8 @@ module Aws::ConnectParticipant
|
|
95
95
|
# class name or an instance of a plugin class.
|
96
96
|
#
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
-
# Your AWS credentials used for authentication. This can be
|
99
|
-
# following classes:
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
100
100
|
#
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
102
102
|
# credentials.
|
@@ -124,8 +124,7 @@ module Aws::ConnectParticipant
|
|
124
124
|
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
125
125
|
# from the Cognito Identity service.
|
126
126
|
#
|
127
|
-
# When `:credentials` are not configured directly, the following
|
128
|
-
# locations will be searched for credentials:
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
129
128
|
#
|
130
129
|
# * `Aws.config[:credentials]`
|
131
130
|
#
|
@@ -139,12 +138,10 @@ module Aws::ConnectParticipant
|
|
139
138
|
#
|
140
139
|
# * `~/.aws/config`
|
141
140
|
#
|
142
|
-
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
147
|
-
# to `true`.
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
148
145
|
#
|
149
146
|
# @option options [required, String] :region
|
150
147
|
# The AWS region to connect to. The configured `:region` is
|
@@ -377,8 +374,8 @@ module Aws::ConnectParticipant
|
|
377
374
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
378
375
|
#
|
379
376
|
# @option options [Aws::TokenProvider] :token_provider
|
380
|
-
# Your Bearer token used for authentication. This can be
|
381
|
-
# following classes:
|
377
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
378
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
382
379
|
#
|
383
380
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
384
381
|
# tokens.
|
@@ -487,6 +484,18 @@ module Aws::ConnectParticipant
|
|
487
484
|
#
|
488
485
|
# </note>
|
489
486
|
#
|
487
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
488
|
+
# `ParticipantToken`.
|
489
|
+
#
|
490
|
+
# </note>
|
491
|
+
#
|
492
|
+
# The Amazon Connect Participant Service APIs do not use [Signature
|
493
|
+
# Version 4 authentication][1].
|
494
|
+
#
|
495
|
+
#
|
496
|
+
#
|
497
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
498
|
+
#
|
490
499
|
# @option params [required, String] :session_id
|
491
500
|
# The `sessionId` provided in the `authenticationInitiated` event.
|
492
501
|
#
|
@@ -577,17 +586,24 @@ module Aws::ConnectParticipant
|
|
577
586
|
# For security recommendations, see [Amazon Connect Chat security best
|
578
587
|
# practices][1].
|
579
588
|
#
|
589
|
+
# For WebRTC security recommendations, see [Amazon Connect WebRTC
|
590
|
+
# security best practices][2].
|
591
|
+
#
|
580
592
|
# <note markdown="1"> `ParticipantToken` is used for invoking this API instead of
|
581
593
|
# `ConnectionToken`.
|
582
594
|
#
|
583
595
|
# </note>
|
584
596
|
#
|
585
597
|
# The participant token is valid for the lifetime of the participant –
|
586
|
-
# until they are part of a contact.
|
598
|
+
# until they are part of a contact. For WebRTC participants, if they
|
599
|
+
# leave or are disconnected for 60 seconds, a new participant needs to
|
600
|
+
# be created using the [CreateParticipant][3] API.
|
601
|
+
#
|
602
|
+
# **For `WEBSOCKET` Type**:
|
587
603
|
#
|
588
|
-
# The response URL for
|
589
|
-
#
|
590
|
-
#
|
604
|
+
# The response URL for has a connect expiry timeout of 100s. Clients
|
605
|
+
# must manually connect to the returned websocket URL and subscribe to
|
606
|
+
# the desired topic.
|
591
607
|
#
|
592
608
|
# For chat, you need to publish the following on the established
|
593
609
|
# websocket connection:
|
@@ -598,29 +614,60 @@ module Aws::ConnectParticipant
|
|
598
614
|
# ConnectionExpiry parameter, clients need to call this API again to
|
599
615
|
# obtain a new websocket URL and perform the same steps as before.
|
600
616
|
#
|
617
|
+
# The expiry time for the connection token is different than the
|
618
|
+
# `ChatDurationInMinutes`. Expiry time for the connection token is 1
|
619
|
+
# day.
|
620
|
+
#
|
621
|
+
# **For `WEBRTC_CONNECTION` Type**:
|
622
|
+
#
|
623
|
+
# The response includes connection data required for the client
|
624
|
+
# application to join the call using the Amazon Chime SDK client
|
625
|
+
# libraries. The WebRTCConnection response contains Meeting and Attendee
|
626
|
+
# information needed to establish the media connection.
|
627
|
+
#
|
628
|
+
# The attendee join token in WebRTCConnection response is valid for the
|
629
|
+
# lifetime of the participant in the call. If a participant leaves or is
|
630
|
+
# disconnected for 60 seconds, their participant credentials will no
|
631
|
+
# longer be valid, and a new participant will need to be created to
|
632
|
+
# rejoin the call.
|
633
|
+
#
|
601
634
|
# **Message streaming support**: This API can also be used together with
|
602
|
-
# the [StartContactStreaming][
|
635
|
+
# the [StartContactStreaming][4] API to create a participant connection
|
603
636
|
# for chat contacts that are not using a websocket. For more information
|
604
|
-
# about message streaming, [Enable real-time chat message streaming][
|
637
|
+
# about message streaming, [Enable real-time chat message streaming][5]
|
605
638
|
# in the *Amazon Connect Administrator Guide*.
|
606
639
|
#
|
640
|
+
# **Multi-user web, in-app, video calling support**:
|
641
|
+
#
|
642
|
+
# For WebRTC calls, this API is used in conjunction with the
|
643
|
+
# CreateParticipant API to enable multi-party calling. The
|
644
|
+
# StartWebRTCContact API creates the initial contact and routes it to an
|
645
|
+
# agent, while CreateParticipant adds additional participants to the
|
646
|
+
# ongoing call. For more information about multi-party WebRTC calls, see
|
647
|
+
# [Enable multi-user web, in-app, and video calling][6] in the *Amazon
|
648
|
+
# Connect Administrator Guide*.
|
649
|
+
#
|
607
650
|
# **Feature specifications**: For information about feature
|
608
651
|
# specifications, such as the allowed number of open websocket
|
609
|
-
# connections per participant
|
610
|
-
# *Amazon Connect Administrator
|
652
|
+
# connections per participant or maximum number of WebRTC participants,
|
653
|
+
# see [Feature specifications][7] in the *Amazon Connect Administrator
|
654
|
+
# Guide*.
|
611
655
|
#
|
612
656
|
# <note markdown="1"> The Amazon Connect Participant Service APIs do not use [Signature
|
613
|
-
# Version 4 authentication][
|
657
|
+
# Version 4 authentication][8].
|
614
658
|
#
|
615
659
|
# </note>
|
616
660
|
#
|
617
661
|
#
|
618
662
|
#
|
619
663
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
|
620
|
-
# [2]: https://docs.aws.amazon.com/connect/latest/
|
621
|
-
# [3]: https://docs.aws.amazon.com/connect/latest/
|
622
|
-
# [4]: https://docs.aws.amazon.com/connect/latest/
|
623
|
-
# [5]: https://docs.aws.amazon.com/
|
664
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-webrtc-security
|
665
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateParticipant.html
|
666
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
|
667
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html
|
668
|
+
# [6]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-multiuser-inapp.html
|
669
|
+
# [7]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
|
670
|
+
# [8]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
624
671
|
#
|
625
672
|
# @option params [Array<String>] :type
|
626
673
|
# Type of connection information required. If you need
|
@@ -646,11 +693,12 @@ module Aws::ConnectParticipant
|
|
646
693
|
#
|
647
694
|
# * {Types::CreateParticipantConnectionResponse#websocket #websocket} => Types::Websocket
|
648
695
|
# * {Types::CreateParticipantConnectionResponse#connection_credentials #connection_credentials} => Types::ConnectionCredentials
|
696
|
+
# * {Types::CreateParticipantConnectionResponse#web_rtc_connection #web_rtc_connection} => Types::ConnectionData
|
649
697
|
#
|
650
698
|
# @example Request syntax with placeholder values
|
651
699
|
#
|
652
700
|
# resp = client.create_participant_connection({
|
653
|
-
# type: ["WEBSOCKET"], # accepts WEBSOCKET, CONNECTION_CREDENTIALS
|
701
|
+
# type: ["WEBSOCKET"], # accepts WEBSOCKET, CONNECTION_CREDENTIALS, WEBRTC_CONNECTION
|
654
702
|
# participant_token: "ParticipantToken", # required
|
655
703
|
# connect_participant: false,
|
656
704
|
# })
|
@@ -661,6 +709,16 @@ module Aws::ConnectParticipant
|
|
661
709
|
# resp.websocket.connection_expiry #=> String
|
662
710
|
# resp.connection_credentials.connection_token #=> String
|
663
711
|
# resp.connection_credentials.expiry #=> String
|
712
|
+
# resp.web_rtc_connection.attendee.attendee_id #=> String
|
713
|
+
# resp.web_rtc_connection.attendee.join_token #=> String
|
714
|
+
# resp.web_rtc_connection.meeting.media_region #=> String
|
715
|
+
# resp.web_rtc_connection.meeting.media_placement.audio_host_url #=> String
|
716
|
+
# resp.web_rtc_connection.meeting.media_placement.audio_fallback_url #=> String
|
717
|
+
# resp.web_rtc_connection.meeting.media_placement.signaling_url #=> String
|
718
|
+
# resp.web_rtc_connection.meeting.media_placement.turn_control_url #=> String
|
719
|
+
# resp.web_rtc_connection.meeting.media_placement.event_ingestion_url #=> String
|
720
|
+
# resp.web_rtc_connection.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
|
721
|
+
# resp.web_rtc_connection.meeting.meeting_id #=> String
|
664
722
|
#
|
665
723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnection AWS API Documentation
|
666
724
|
#
|
@@ -777,8 +835,13 @@ module Aws::ConnectParticipant
|
|
777
835
|
# For security recommendations, see [Amazon Connect Chat security best
|
778
836
|
# practices][1].
|
779
837
|
#
|
780
|
-
# <note markdown="1"> `
|
781
|
-
# `
|
838
|
+
# <note markdown="1"> * The participant role `CUSTOM_BOT` is not permitted to access
|
839
|
+
# attachments customers may upload. An `AccessDeniedException` can
|
840
|
+
# indicate that the participant may be a CUSTOM\_BOT, and it doesn't
|
841
|
+
# have access to attachments.
|
842
|
+
#
|
843
|
+
# * `ConnectionToken` is used for invoking this API instead of
|
844
|
+
# `ParticipantToken`.
|
782
845
|
#
|
783
846
|
# </note>
|
784
847
|
#
|
@@ -845,9 +908,18 @@ module Aws::ConnectParticipant
|
|
845
908
|
#
|
846
909
|
# </note>
|
847
910
|
#
|
911
|
+
# <note markdown="1"> `ConnectionToken` is used for invoking this API instead of
|
912
|
+
# `ParticipantToken`.
|
913
|
+
#
|
914
|
+
# </note>
|
915
|
+
#
|
916
|
+
# The Amazon Connect Participant Service APIs do not use [Signature
|
917
|
+
# Version 4 authentication][2].
|
918
|
+
#
|
848
919
|
#
|
849
920
|
#
|
850
921
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
|
922
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
851
923
|
#
|
852
924
|
# @option params [required, String] :session_id
|
853
925
|
# The sessionId provided in the authenticationInitiated event.
|
@@ -896,10 +968,12 @@ module Aws::ConnectParticipant
|
|
896
968
|
# chat that has ended, note that chat transcripts contain the following
|
897
969
|
# event content types if the event has occurred during the chat session:
|
898
970
|
#
|
899
|
-
# * `application/vnd.amazonaws.connect.event.participant.
|
971
|
+
# * `application/vnd.amazonaws.connect.event.participant.invited`
|
900
972
|
#
|
901
973
|
# * `application/vnd.amazonaws.connect.event.participant.joined`
|
902
974
|
#
|
975
|
+
# * `application/vnd.amazonaws.connect.event.participant.left`
|
976
|
+
#
|
903
977
|
# * `application/vnd.amazonaws.connect.event.chat.ended`
|
904
978
|
#
|
905
979
|
# * `application/vnd.amazonaws.connect.event.transfer.succeeded`
|
@@ -1006,9 +1080,9 @@ module Aws::ConnectParticipant
|
|
1006
1080
|
end
|
1007
1081
|
|
1008
1082
|
# <note markdown="1"> The `application/vnd.amazonaws.connect.event.connection.acknowledged`
|
1009
|
-
# ContentType
|
1010
|
-
#
|
1011
|
-
#
|
1083
|
+
# ContentType is no longer maintained since December 31, 2024. This
|
1084
|
+
# event has been migrated to the [CreateParticipantConnection][1] API
|
1085
|
+
# using the `ConnectParticipant` field.
|
1012
1086
|
#
|
1013
1087
|
# </note>
|
1014
1088
|
#
|
@@ -1039,8 +1113,8 @@ module Aws::ConnectParticipant
|
|
1039
1113
|
#
|
1040
1114
|
# * application/vnd.amazonaws.connect.event.typing
|
1041
1115
|
#
|
1042
|
-
# * application/vnd.amazonaws.connect.event.connection.acknowledged
|
1043
|
-
#
|
1116
|
+
# * application/vnd.amazonaws.connect.event.connection.acknowledged (is
|
1117
|
+
# no longer maintained since December 31, 2024)
|
1044
1118
|
#
|
1045
1119
|
# * application/vnd.amazonaws.connect.event.message.delivered
|
1046
1120
|
#
|
@@ -1118,10 +1192,22 @@ module Aws::ConnectParticipant
|
|
1118
1192
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1119
1193
|
#
|
1120
1194
|
# @option params [required, String] :content_type
|
1121
|
-
# The type of the content.
|
1195
|
+
# The type of the content. Possible types are `text/plain`,
|
1122
1196
|
# `text/markdown`, `application/json`, and
|
1123
1197
|
# `application/vnd.amazonaws.connect.message.interactive.response`.
|
1124
1198
|
#
|
1199
|
+
# Supported types on the contact are configured through
|
1200
|
+
# `SupportedMessagingContentTypes` on [StartChatContact][1] and
|
1201
|
+
# [StartOutboundChatContact][2].
|
1202
|
+
#
|
1203
|
+
# For Apple Messages for Business, SMS, and WhatsApp Business Messaging
|
1204
|
+
# contacts, only `text/plain` is supported.
|
1205
|
+
#
|
1206
|
+
#
|
1207
|
+
#
|
1208
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html
|
1209
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html
|
1210
|
+
#
|
1125
1211
|
# @option params [required, String] :content
|
1126
1212
|
# The content of the message.
|
1127
1213
|
#
|
@@ -1280,7 +1366,7 @@ module Aws::ConnectParticipant
|
|
1280
1366
|
tracer: tracer
|
1281
1367
|
)
|
1282
1368
|
context[:gem_name] = 'aws-sdk-connectparticipant'
|
1283
|
-
context[:gem_version] = '1.
|
1369
|
+
context[:gem_version] = '1.68.0'
|
1284
1370
|
Seahorse::Client::Request.new(handlers, context)
|
1285
1371
|
end
|
1286
1372
|
|
@@ -23,6 +23,9 @@ module Aws::ConnectParticipant
|
|
23
23
|
AttachmentName = Shapes::StringShape.new(name: 'AttachmentName')
|
24
24
|
AttachmentSizeInBytes = Shapes::IntegerShape.new(name: 'AttachmentSizeInBytes')
|
25
25
|
Attachments = Shapes::ListShape.new(name: 'Attachments')
|
26
|
+
Attendee = Shapes::StructureShape.new(name: 'Attendee')
|
27
|
+
AttendeeId = Shapes::StringShape.new(name: 'AttendeeId')
|
28
|
+
AudioFeatures = Shapes::StructureShape.new(name: 'AudioFeatures')
|
26
29
|
AuthenticationUrl = Shapes::StringShape.new(name: 'AuthenticationUrl')
|
27
30
|
Bool = Shapes::BooleanShape.new(name: 'Bool')
|
28
31
|
CancelParticipantAuthenticationRequest = Shapes::StructureShape.new(name: 'CancelParticipantAuthenticationRequest')
|
@@ -36,6 +39,7 @@ module Aws::ConnectParticipant
|
|
36
39
|
CompleteAttachmentUploadResponse = Shapes::StructureShape.new(name: 'CompleteAttachmentUploadResponse')
|
37
40
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
38
41
|
ConnectionCredentials = Shapes::StructureShape.new(name: 'ConnectionCredentials')
|
42
|
+
ConnectionData = Shapes::StructureShape.new(name: 'ConnectionData')
|
39
43
|
ConnectionType = Shapes::StringShape.new(name: 'ConnectionType')
|
40
44
|
ConnectionTypeList = Shapes::ListShape.new(name: 'ConnectionTypeList')
|
41
45
|
ContactId = Shapes::StringShape.new(name: 'ContactId')
|
@@ -57,7 +61,14 @@ module Aws::ConnectParticipant
|
|
57
61
|
Instant = Shapes::StringShape.new(name: 'Instant')
|
58
62
|
InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
|
59
63
|
Item = Shapes::StructureShape.new(name: 'Item')
|
64
|
+
JoinToken = Shapes::StringShape.new(name: 'JoinToken')
|
60
65
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
66
|
+
MediaPlacement = Shapes::StructureShape.new(name: 'MediaPlacement')
|
67
|
+
MediaRegion = Shapes::StringShape.new(name: 'MediaRegion')
|
68
|
+
Meeting = Shapes::StructureShape.new(name: 'Meeting')
|
69
|
+
MeetingFeatureStatus = Shapes::StringShape.new(name: 'MeetingFeatureStatus')
|
70
|
+
MeetingFeaturesConfiguration = Shapes::StructureShape.new(name: 'MeetingFeaturesConfiguration')
|
71
|
+
MeetingId = Shapes::StringShape.new(name: 'MeetingId')
|
61
72
|
Message = Shapes::StringShape.new(name: 'Message')
|
62
73
|
MessageMetadata = Shapes::StructureShape.new(name: 'MessageMetadata')
|
63
74
|
MostRecent = Shapes::IntegerShape.new(name: 'MostRecent')
|
@@ -88,6 +99,7 @@ module Aws::ConnectParticipant
|
|
88
99
|
StartPosition = Shapes::StructureShape.new(name: 'StartPosition')
|
89
100
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
90
101
|
Transcript = Shapes::ListShape.new(name: 'Transcript')
|
102
|
+
URI = Shapes::StringShape.new(name: 'URI')
|
91
103
|
URLExpiryInSeconds = Shapes::IntegerShape.new(name: 'URLExpiryInSeconds')
|
92
104
|
UploadMetadata = Shapes::StructureShape.new(name: 'UploadMetadata')
|
93
105
|
UploadMetadataSignedHeaders = Shapes::MapShape.new(name: 'UploadMetadataSignedHeaders')
|
@@ -120,6 +132,13 @@ module Aws::ConnectParticipant
|
|
120
132
|
|
121
133
|
Attachments.member = Shapes::ShapeRef.new(shape: AttachmentItem)
|
122
134
|
|
135
|
+
Attendee.add_member(:attendee_id, Shapes::ShapeRef.new(shape: AttendeeId, location_name: "AttendeeId"))
|
136
|
+
Attendee.add_member(:join_token, Shapes::ShapeRef.new(shape: JoinToken, location_name: "JoinToken"))
|
137
|
+
Attendee.struct_class = Types::Attendee
|
138
|
+
|
139
|
+
AudioFeatures.add_member(:echo_reduction, Shapes::ShapeRef.new(shape: MeetingFeatureStatus, location_name: "EchoReduction"))
|
140
|
+
AudioFeatures.struct_class = Types::AudioFeatures
|
141
|
+
|
123
142
|
CancelParticipantAuthenticationRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, required: true, location_name: "SessionId"))
|
124
143
|
CancelParticipantAuthenticationRequest.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
|
125
144
|
CancelParticipantAuthenticationRequest.struct_class = Types::CancelParticipantAuthenticationRequest
|
@@ -140,6 +159,10 @@ module Aws::ConnectParticipant
|
|
140
159
|
ConnectionCredentials.add_member(:expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "Expiry"))
|
141
160
|
ConnectionCredentials.struct_class = Types::ConnectionCredentials
|
142
161
|
|
162
|
+
ConnectionData.add_member(:attendee, Shapes::ShapeRef.new(shape: Attendee, location_name: "Attendee"))
|
163
|
+
ConnectionData.add_member(:meeting, Shapes::ShapeRef.new(shape: Meeting, location_name: "Meeting"))
|
164
|
+
ConnectionData.struct_class = Types::ConnectionData
|
165
|
+
|
143
166
|
ConnectionTypeList.member = Shapes::ShapeRef.new(shape: ConnectionType)
|
144
167
|
|
145
168
|
CreateParticipantConnectionRequest.add_member(:type, Shapes::ShapeRef.new(shape: ConnectionTypeList, location_name: "Type"))
|
@@ -149,6 +172,7 @@ module Aws::ConnectParticipant
|
|
149
172
|
|
150
173
|
CreateParticipantConnectionResponse.add_member(:websocket, Shapes::ShapeRef.new(shape: Websocket, location_name: "Websocket"))
|
151
174
|
CreateParticipantConnectionResponse.add_member(:connection_credentials, Shapes::ShapeRef.new(shape: ConnectionCredentials, location_name: "ConnectionCredentials"))
|
175
|
+
CreateParticipantConnectionResponse.add_member(:web_rtc_connection, Shapes::ShapeRef.new(shape: ConnectionData, location_name: "WebRTCConnection"))
|
152
176
|
CreateParticipantConnectionResponse.struct_class = Types::CreateParticipantConnectionResponse
|
153
177
|
|
154
178
|
DescribeViewRequest.add_member(:view_token, Shapes::ShapeRef.new(shape: ViewToken, required: true, location: "uri", location_name: "ViewToken"))
|
@@ -213,6 +237,22 @@ module Aws::ConnectParticipant
|
|
213
237
|
Item.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
214
238
|
Item.struct_class = Types::Item
|
215
239
|
|
240
|
+
MediaPlacement.add_member(:audio_host_url, Shapes::ShapeRef.new(shape: URI, location_name: "AudioHostUrl"))
|
241
|
+
MediaPlacement.add_member(:audio_fallback_url, Shapes::ShapeRef.new(shape: URI, location_name: "AudioFallbackUrl"))
|
242
|
+
MediaPlacement.add_member(:signaling_url, Shapes::ShapeRef.new(shape: URI, location_name: "SignalingUrl"))
|
243
|
+
MediaPlacement.add_member(:turn_control_url, Shapes::ShapeRef.new(shape: URI, location_name: "TurnControlUrl"))
|
244
|
+
MediaPlacement.add_member(:event_ingestion_url, Shapes::ShapeRef.new(shape: URI, location_name: "EventIngestionUrl"))
|
245
|
+
MediaPlacement.struct_class = Types::MediaPlacement
|
246
|
+
|
247
|
+
Meeting.add_member(:media_region, Shapes::ShapeRef.new(shape: MediaRegion, location_name: "MediaRegion"))
|
248
|
+
Meeting.add_member(:media_placement, Shapes::ShapeRef.new(shape: MediaPlacement, location_name: "MediaPlacement"))
|
249
|
+
Meeting.add_member(:meeting_features, Shapes::ShapeRef.new(shape: MeetingFeaturesConfiguration, location_name: "MeetingFeatures"))
|
250
|
+
Meeting.add_member(:meeting_id, Shapes::ShapeRef.new(shape: MeetingId, location_name: "MeetingId"))
|
251
|
+
Meeting.struct_class = Types::Meeting
|
252
|
+
|
253
|
+
MeetingFeaturesConfiguration.add_member(:audio, Shapes::ShapeRef.new(shape: AudioFeatures, location_name: "Audio"))
|
254
|
+
MeetingFeaturesConfiguration.struct_class = Types::MeetingFeaturesConfiguration
|
255
|
+
|
216
256
|
MessageMetadata.add_member(:message_id, Shapes::ShapeRef.new(shape: ChatItemId, location_name: "MessageId"))
|
217
257
|
MessageMetadata.add_member(:receipts, Shapes::ShapeRef.new(shape: Receipts, location_name: "Receipts"))
|
218
258
|
MessageMetadata.struct_class = Types::MessageMetadata
|
@@ -59,6 +59,41 @@ module Aws::ConnectParticipant
|
|
59
59
|
include Aws::Structure
|
60
60
|
end
|
61
61
|
|
62
|
+
# The attendee information, including attendee ID and join token.
|
63
|
+
#
|
64
|
+
# @!attribute [rw] attendee_id
|
65
|
+
# The Amazon Chime SDK attendee ID.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] join_token
|
69
|
+
# The join token used by the Amazon Chime SDK attendee.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/Attendee AWS API Documentation
|
73
|
+
#
|
74
|
+
class Attendee < Struct.new(
|
75
|
+
:attendee_id,
|
76
|
+
:join_token)
|
77
|
+
SENSITIVE = [:join_token]
|
78
|
+
include Aws::Structure
|
79
|
+
end
|
80
|
+
|
81
|
+
# Has audio-specific configurations as the operating parameter for Echo
|
82
|
+
# Reduction.
|
83
|
+
#
|
84
|
+
# @!attribute [rw] echo_reduction
|
85
|
+
# Makes echo reduction available to clients who connect to the
|
86
|
+
# meeting.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/AudioFeatures AWS API Documentation
|
90
|
+
#
|
91
|
+
class AudioFeatures < Struct.new(
|
92
|
+
:echo_reduction)
|
93
|
+
SENSITIVE = []
|
94
|
+
include Aws::Structure
|
95
|
+
end
|
96
|
+
|
62
97
|
# @!attribute [rw] session_id
|
63
98
|
# The `sessionId` provided in the `authenticationInitiated` event.
|
64
99
|
# @return [String]
|
@@ -154,6 +189,25 @@ module Aws::ConnectParticipant
|
|
154
189
|
include Aws::Structure
|
155
190
|
end
|
156
191
|
|
192
|
+
# Information required to join the call.
|
193
|
+
#
|
194
|
+
# @!attribute [rw] attendee
|
195
|
+
# The attendee information, including attendee ID and join token.
|
196
|
+
# @return [Types::Attendee]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] meeting
|
199
|
+
# A meeting created using the Amazon Chime SDK.
|
200
|
+
# @return [Types::Meeting]
|
201
|
+
#
|
202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/ConnectionData AWS API Documentation
|
203
|
+
#
|
204
|
+
class ConnectionData < Struct.new(
|
205
|
+
:attendee,
|
206
|
+
:meeting)
|
207
|
+
SENSITIVE = []
|
208
|
+
include Aws::Structure
|
209
|
+
end
|
210
|
+
|
157
211
|
# @!attribute [rw] type
|
158
212
|
# Type of connection information required. If you need
|
159
213
|
# `CONNECTION_CREDENTIALS` along with marking participant as
|
@@ -196,11 +250,18 @@ module Aws::ConnectParticipant
|
|
196
250
|
# authentication token associated with the participant's connection.
|
197
251
|
# @return [Types::ConnectionCredentials]
|
198
252
|
#
|
253
|
+
# @!attribute [rw] web_rtc_connection
|
254
|
+
# Creates the participant's WebRTC connection data required for the
|
255
|
+
# client application (mobile application or website) to connect to the
|
256
|
+
# call.
|
257
|
+
# @return [Types::ConnectionData]
|
258
|
+
#
|
199
259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnectionResponse AWS API Documentation
|
200
260
|
#
|
201
261
|
class CreateParticipantConnectionResponse < Struct.new(
|
202
262
|
:websocket,
|
203
|
-
:connection_credentials
|
263
|
+
:connection_credentials,
|
264
|
+
:web_rtc_connection)
|
204
265
|
SENSITIVE = []
|
205
266
|
include Aws::Structure
|
206
267
|
end
|
@@ -527,6 +588,85 @@ module Aws::ConnectParticipant
|
|
527
588
|
include Aws::Structure
|
528
589
|
end
|
529
590
|
|
591
|
+
# A set of endpoints used by clients to connect to the media service
|
592
|
+
# group for an Amazon Chime SDK meeting.
|
593
|
+
#
|
594
|
+
# @!attribute [rw] audio_host_url
|
595
|
+
# The audio host URL.
|
596
|
+
# @return [String]
|
597
|
+
#
|
598
|
+
# @!attribute [rw] audio_fallback_url
|
599
|
+
# The audio fallback URL.
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] signaling_url
|
603
|
+
# The signaling URL.
|
604
|
+
# @return [String]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] turn_control_url
|
607
|
+
# The turn control URL.
|
608
|
+
# @return [String]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] event_ingestion_url
|
611
|
+
# The event ingestion URL to which you send client meeting events.
|
612
|
+
# @return [String]
|
613
|
+
#
|
614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/MediaPlacement AWS API Documentation
|
615
|
+
#
|
616
|
+
class MediaPlacement < Struct.new(
|
617
|
+
:audio_host_url,
|
618
|
+
:audio_fallback_url,
|
619
|
+
:signaling_url,
|
620
|
+
:turn_control_url,
|
621
|
+
:event_ingestion_url)
|
622
|
+
SENSITIVE = []
|
623
|
+
include Aws::Structure
|
624
|
+
end
|
625
|
+
|
626
|
+
# A meeting created using the Amazon Chime SDK.
|
627
|
+
#
|
628
|
+
# @!attribute [rw] media_region
|
629
|
+
# The Amazon Web Services Region in which you create the meeting.
|
630
|
+
# @return [String]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] media_placement
|
633
|
+
# The media placement for the meeting.
|
634
|
+
# @return [Types::MediaPlacement]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] meeting_features
|
637
|
+
# The configuration settings of the features available to a meeting.
|
638
|
+
# @return [Types::MeetingFeaturesConfiguration]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] meeting_id
|
641
|
+
# The Amazon Chime SDK meeting ID.
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/Meeting AWS API Documentation
|
645
|
+
#
|
646
|
+
class Meeting < Struct.new(
|
647
|
+
:media_region,
|
648
|
+
:media_placement,
|
649
|
+
:meeting_features,
|
650
|
+
:meeting_id)
|
651
|
+
SENSITIVE = []
|
652
|
+
include Aws::Structure
|
653
|
+
end
|
654
|
+
|
655
|
+
# The configuration settings of the features available to a meeting.
|
656
|
+
#
|
657
|
+
# @!attribute [rw] audio
|
658
|
+
# The configuration settings for the audio features available to a
|
659
|
+
# meeting.
|
660
|
+
# @return [Types::AudioFeatures]
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/MeetingFeaturesConfiguration AWS API Documentation
|
663
|
+
#
|
664
|
+
class MeetingFeaturesConfiguration < Struct.new(
|
665
|
+
:audio)
|
666
|
+
SENSITIVE = []
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
530
670
|
# Contains metadata related to a message.
|
531
671
|
#
|
532
672
|
# @!attribute [rw] message_id
|
@@ -601,7 +741,7 @@ module Aws::ConnectParticipant
|
|
601
741
|
# * application/vnd.amazonaws.connect.event.typing
|
602
742
|
#
|
603
743
|
# * application/vnd.amazonaws.connect.event.connection.acknowledged
|
604
|
-
# (
|
744
|
+
# (is no longer maintained since December 31, 2024)
|
605
745
|
#
|
606
746
|
# * application/vnd.amazonaws.connect.event.message.delivered
|
607
747
|
#
|
@@ -668,9 +808,21 @@ module Aws::ConnectParticipant
|
|
668
808
|
end
|
669
809
|
|
670
810
|
# @!attribute [rw] content_type
|
671
|
-
# The type of the content.
|
811
|
+
# The type of the content. Possible types are `text/plain`,
|
672
812
|
# `text/markdown`, `application/json`, and
|
673
813
|
# `application/vnd.amazonaws.connect.message.interactive.response`.
|
814
|
+
#
|
815
|
+
# Supported types on the contact are configured through
|
816
|
+
# `SupportedMessagingContentTypes` on [StartChatContact][1] and
|
817
|
+
# [StartOutboundChatContact][2].
|
818
|
+
#
|
819
|
+
# For Apple Messages for Business, SMS, and WhatsApp Business
|
820
|
+
# Messaging contacts, only `text/plain` is supported.
|
821
|
+
#
|
822
|
+
#
|
823
|
+
#
|
824
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html
|
825
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html
|
674
826
|
# @return [String]
|
675
827
|
#
|
676
828
|
# @!attribute [rw] content
|
data/sig/client.rbs
CHANGED
@@ -103,10 +103,11 @@ module Aws
|
|
103
103
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateParticipantConnectionResponse]
|
104
104
|
def websocket: () -> Types::Websocket
|
105
105
|
def connection_credentials: () -> Types::ConnectionCredentials
|
106
|
+
def web_rtc_connection: () -> Types::ConnectionData
|
106
107
|
end
|
107
108
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectParticipant/Client.html#create_participant_connection-instance_method
|
108
109
|
def create_participant_connection: (
|
109
|
-
?type: Array[("WEBSOCKET" | "CONNECTION_CREDENTIALS")],
|
110
|
+
?type: Array[("WEBSOCKET" | "CONNECTION_CREDENTIALS" | "WEBRTC_CONNECTION")],
|
110
111
|
participant_token: ::String,
|
111
112
|
?connect_participant: bool
|
112
113
|
) -> _CreateParticipantConnectionResponseSuccess
|
data/sig/types.rbs
CHANGED
@@ -21,6 +21,17 @@ module Aws::ConnectParticipant
|
|
21
21
|
SENSITIVE: []
|
22
22
|
end
|
23
23
|
|
24
|
+
class Attendee
|
25
|
+
attr_accessor attendee_id: ::String
|
26
|
+
attr_accessor join_token: ::String
|
27
|
+
SENSITIVE: [:join_token]
|
28
|
+
end
|
29
|
+
|
30
|
+
class AudioFeatures
|
31
|
+
attr_accessor echo_reduction: ("AVAILABLE" | "UNAVAILABLE")
|
32
|
+
SENSITIVE: []
|
33
|
+
end
|
34
|
+
|
24
35
|
class CancelParticipantAuthenticationRequest
|
25
36
|
attr_accessor session_id: ::String
|
26
37
|
attr_accessor connection_token: ::String
|
@@ -51,8 +62,14 @@ module Aws::ConnectParticipant
|
|
51
62
|
SENSITIVE: []
|
52
63
|
end
|
53
64
|
|
65
|
+
class ConnectionData
|
66
|
+
attr_accessor attendee: Types::Attendee
|
67
|
+
attr_accessor meeting: Types::Meeting
|
68
|
+
SENSITIVE: []
|
69
|
+
end
|
70
|
+
|
54
71
|
class CreateParticipantConnectionRequest
|
55
|
-
attr_accessor type: ::Array[("WEBSOCKET" | "CONNECTION_CREDENTIALS")]
|
72
|
+
attr_accessor type: ::Array[("WEBSOCKET" | "CONNECTION_CREDENTIALS" | "WEBRTC_CONNECTION")]
|
56
73
|
attr_accessor participant_token: ::String
|
57
74
|
attr_accessor connect_participant: bool
|
58
75
|
SENSITIVE: []
|
@@ -61,6 +78,7 @@ module Aws::ConnectParticipant
|
|
61
78
|
class CreateParticipantConnectionResponse
|
62
79
|
attr_accessor websocket: Types::Websocket
|
63
80
|
attr_accessor connection_credentials: Types::ConnectionCredentials
|
81
|
+
attr_accessor web_rtc_connection: Types::ConnectionData
|
64
82
|
SENSITIVE: []
|
65
83
|
end
|
66
84
|
|
@@ -149,6 +167,28 @@ module Aws::ConnectParticipant
|
|
149
167
|
SENSITIVE: []
|
150
168
|
end
|
151
169
|
|
170
|
+
class MediaPlacement
|
171
|
+
attr_accessor audio_host_url: ::String
|
172
|
+
attr_accessor audio_fallback_url: ::String
|
173
|
+
attr_accessor signaling_url: ::String
|
174
|
+
attr_accessor turn_control_url: ::String
|
175
|
+
attr_accessor event_ingestion_url: ::String
|
176
|
+
SENSITIVE: []
|
177
|
+
end
|
178
|
+
|
179
|
+
class Meeting
|
180
|
+
attr_accessor media_region: ::String
|
181
|
+
attr_accessor media_placement: Types::MediaPlacement
|
182
|
+
attr_accessor meeting_features: Types::MeetingFeaturesConfiguration
|
183
|
+
attr_accessor meeting_id: ::String
|
184
|
+
SENSITIVE: []
|
185
|
+
end
|
186
|
+
|
187
|
+
class MeetingFeaturesConfiguration
|
188
|
+
attr_accessor audio: Types::AudioFeatures
|
189
|
+
SENSITIVE: []
|
190
|
+
end
|
191
|
+
|
152
192
|
class MessageMetadata
|
153
193
|
attr_accessor message_id: ::String
|
154
194
|
attr_accessor receipts: ::Array[Types::Receipt]
|