aws-sdk-connect 1.282.0 → 1.283.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +64 -8
- data/lib/aws-sdk-connect/client_api.rb +26 -0
- data/lib/aws-sdk-connect/types.rb +118 -9
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +8 -1
- data/sig/types.rbs +17 -0
- 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: 35f7b4911fe0e7bf4e5cc4ec90ec55ff34971a13ca83068bb4c80a562f6ae199
|
|
4
|
+
data.tar.gz: c766aa2cb6110b0aff29fdb55bee6be1b2865ff9b5e11ddce8a8730551747cdb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2509eba4ad6a6ffea3132bed234bd77ca67c10f010280654d20844423c544c2d2cfe1fced38ca08afa43d2b13de5a8918eccdae10d8780134153febaa8043cdc
|
|
7
|
+
data.tar.gz: ef0d1fac526cb2eb0f99d82a558d0361e8c42725d1e382f3753b9b40c79254bc5d5e7abbd7ce5c8dcab0423f929b5772df388668d5b1be9582c4b62b65f0fa49
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.283.0 (2026-09-28)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release adds ConnectionTypes and ChatStreamingConfiguration to StartChatContact, and ConnectionCredentials, Websocket, and StreamingId to its response, so customers can request connection information and chat streaming in the same call that starts the chat.
|
|
8
|
+
|
|
4
9
|
1.282.0 (2026-09-25)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.283.0
|
|
@@ -17009,6 +17009,8 @@ module Aws::Connect
|
|
|
17009
17009
|
# * {Types::ListEvaluationFormAIVersionsResponse#ai_version_summaries #ai_version_summaries} => Array<Types::EvaluationFormAIVersionSummary>
|
|
17010
17010
|
# * {Types::ListEvaluationFormAIVersionsResponse#next_token #next_token} => String
|
|
17011
17011
|
#
|
|
17012
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
17013
|
+
#
|
|
17012
17014
|
# @example Request syntax with placeholder values
|
|
17013
17015
|
#
|
|
17014
17016
|
# resp = client.list_evaluation_form_ai_versions({
|
|
@@ -24587,6 +24589,11 @@ module Aws::Connect
|
|
|
24587
24589
|
# [CreateParticipantConnection][1] with WEBSOCKET and
|
|
24588
24590
|
# CONNECTION\_CREDENTIALS.
|
|
24589
24591
|
#
|
|
24592
|
+
# To receive connection information directly in the response, set
|
|
24593
|
+
# `ConnectionTypes` on the request. To initiate real-time message
|
|
24594
|
+
# streaming when the chat is created, set `ChatStreamingConfiguration`
|
|
24595
|
+
# on the request. Both parameters are optional.
|
|
24596
|
+
#
|
|
24590
24597
|
# A 429 error occurs in the following situations:
|
|
24591
24598
|
#
|
|
24592
24599
|
# * API rate limit is exceeded. API TPS throttling returns a
|
|
@@ -24736,12 +24743,59 @@ module Aws::Connect
|
|
|
24736
24743
|
# customer ends the chat session, allowing them to continue through
|
|
24737
24744
|
# disconnect flows such as surveys or feedback forms.
|
|
24738
24745
|
#
|
|
24746
|
+
# @option params [Array<String>] :connection_types
|
|
24747
|
+
# The types of connection information to return in the response. This
|
|
24748
|
+
# parameter is optional.
|
|
24749
|
+
#
|
|
24750
|
+
# Specify `CONNECTION_CREDENTIALS` to receive a connection token.
|
|
24751
|
+
# Specify `WEBSOCKET` to receive a websocket URL. You can specify both.
|
|
24752
|
+
# No other value returns connection information.
|
|
24753
|
+
#
|
|
24754
|
+
# Request `WEBSOCKET` to get a URL the participant connects to directly.
|
|
24755
|
+
# You do not need to call [CreateParticipantConnection][1] for it.
|
|
24756
|
+
# Request `CONNECTION_CREDENTIALS` on its own and the response returns a
|
|
24757
|
+
# connection token but no websocket URL.
|
|
24758
|
+
#
|
|
24759
|
+
# If you omit this parameter, the response has no connection
|
|
24760
|
+
# information.
|
|
24761
|
+
#
|
|
24762
|
+
# <note markdown="1"> If the information you request cannot be returned, StartChatContact
|
|
24763
|
+
# returns an error rather than a response that omits it.
|
|
24764
|
+
#
|
|
24765
|
+
# </note>
|
|
24766
|
+
#
|
|
24767
|
+
#
|
|
24768
|
+
#
|
|
24769
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
|
24770
|
+
#
|
|
24771
|
+
# @option params [Types::ChatStreamingConfiguration] :chat_streaming_configuration
|
|
24772
|
+
# The streaming configuration, such as the Amazon SNS streaming
|
|
24773
|
+
# endpoint. Use it to initiate real-time message streaming when the chat
|
|
24774
|
+
# is created. This parameter is optional.
|
|
24775
|
+
#
|
|
24776
|
+
# When you set this parameter, the response includes `StreamingId`. You
|
|
24777
|
+
# do not need to call [StartContactStreaming][1].
|
|
24778
|
+
#
|
|
24779
|
+
# <note markdown="1"> This parameter starts message streaming only. The response does not
|
|
24780
|
+
# include connection information, and setting this parameter does not
|
|
24781
|
+
# remove the need to call [CreateParticipantConnection][2].
|
|
24782
|
+
#
|
|
24783
|
+
# </note>
|
|
24784
|
+
#
|
|
24785
|
+
#
|
|
24786
|
+
#
|
|
24787
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
|
|
24788
|
+
# [2]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
|
24789
|
+
#
|
|
24739
24790
|
# @return [Types::StartChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
24740
24791
|
#
|
|
24741
24792
|
# * {Types::StartChatContactResponse#contact_id #contact_id} => String
|
|
24742
24793
|
# * {Types::StartChatContactResponse#participant_id #participant_id} => String
|
|
24743
24794
|
# * {Types::StartChatContactResponse#participant_token #participant_token} => String
|
|
24744
24795
|
# * {Types::StartChatContactResponse#continued_from_contact_id #continued_from_contact_id} => String
|
|
24796
|
+
# * {Types::StartChatContactResponse#connection_credentials #connection_credentials} => Types::ConnectionCredentials
|
|
24797
|
+
# * {Types::StartChatContactResponse#websocket #websocket} => Types::Websocket
|
|
24798
|
+
# * {Types::StartChatContactResponse#streaming_id #streaming_id} => String
|
|
24745
24799
|
#
|
|
24746
24800
|
# @example Request syntax with placeholder values
|
|
24747
24801
|
#
|
|
@@ -24788,6 +24842,10 @@ module Aws::Connect
|
|
|
24788
24842
|
# },
|
|
24789
24843
|
# customer_id: "CustomerIdNonEmpty",
|
|
24790
24844
|
# disconnect_on_customer_exit: ["AGENT"], # accepts AGENT
|
|
24845
|
+
# connection_types: ["WEBSOCKET"], # accepts WEBSOCKET, CONNECTION_CREDENTIALS, AUTHENTICATION_SESSION, WEBRTC_CONNECTION
|
|
24846
|
+
# chat_streaming_configuration: {
|
|
24847
|
+
# streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
|
|
24848
|
+
# },
|
|
24791
24849
|
# })
|
|
24792
24850
|
#
|
|
24793
24851
|
# @example Response structure
|
|
@@ -24796,6 +24854,11 @@ module Aws::Connect
|
|
|
24796
24854
|
# resp.participant_id #=> String
|
|
24797
24855
|
# resp.participant_token #=> String
|
|
24798
24856
|
# resp.continued_from_contact_id #=> String
|
|
24857
|
+
# resp.connection_credentials.connection_token #=> String
|
|
24858
|
+
# resp.connection_credentials.expiry #=> String
|
|
24859
|
+
# resp.websocket.url #=> String
|
|
24860
|
+
# resp.websocket.connection_expiry #=> String
|
|
24861
|
+
# resp.streaming_id #=> String
|
|
24799
24862
|
#
|
|
24800
24863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContact AWS API Documentation
|
|
24801
24864
|
#
|
|
@@ -28908,13 +28971,6 @@ module Aws::Connect
|
|
|
28908
28971
|
#
|
|
28909
28972
|
# </note>
|
|
28910
28973
|
#
|
|
28911
|
-
# <note markdown="1"> If you set the attribute type `AUTO_MUTE_AGENT_ON_HOLD` to `true`, the
|
|
28912
|
-
# system automatically mutes agents while they're on hold and unmutes
|
|
28913
|
-
# them when they resume the contact. Agents can't change their mute
|
|
28914
|
-
# state while on hold.
|
|
28915
|
-
#
|
|
28916
|
-
# </note>
|
|
28917
|
-
#
|
|
28918
28974
|
# @option params [required, String] :value
|
|
28919
28975
|
# The value for the attribute. Maximum character limit is 100.
|
|
28920
28976
|
#
|
|
@@ -31625,7 +31681,7 @@ module Aws::Connect
|
|
|
31625
31681
|
tracer: tracer
|
|
31626
31682
|
)
|
|
31627
31683
|
context[:gem_name] = 'aws-sdk-connect'
|
|
31628
|
-
context[:gem_version] = '1.
|
|
31684
|
+
context[:gem_version] = '1.283.0'
|
|
31629
31685
|
Seahorse::Client::Request.new(handlers, context)
|
|
31630
31686
|
end
|
|
31631
31687
|
|
|
@@ -287,7 +287,10 @@ module Aws::Connect
|
|
|
287
287
|
Conditions = Shapes::ListShape.new(name: 'Conditions')
|
|
288
288
|
ConfigurableNotificationPriority = Shapes::StringShape.new(name: 'ConfigurableNotificationPriority')
|
|
289
289
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
|
290
|
+
ConnectionCredentials = Shapes::StructureShape.new(name: 'ConnectionCredentials')
|
|
290
291
|
ConnectionData = Shapes::StructureShape.new(name: 'ConnectionData')
|
|
292
|
+
ConnectionType = Shapes::StringShape.new(name: 'ConnectionType')
|
|
293
|
+
ConnectionTypeList = Shapes::ListShape.new(name: 'ConnectionTypeList')
|
|
291
294
|
Contact = Shapes::StructureShape.new(name: 'Contact')
|
|
292
295
|
ContactAnalysis = Shapes::StructureShape.new(name: 'ContactAnalysis')
|
|
293
296
|
ContactAnalysisReference = Shapes::StructureShape.new(name: 'ContactAnalysisReference')
|
|
@@ -1538,6 +1541,7 @@ module Aws::Connect
|
|
|
1538
1541
|
PreEvaluationFilterType = Shapes::StringShape.new(name: 'PreEvaluationFilterType')
|
|
1539
1542
|
PreEvaluationFilters = Shapes::StructureShape.new(name: 'PreEvaluationFilters')
|
|
1540
1543
|
PreSignedAttachmentUrl = Shapes::StringShape.new(name: 'PreSignedAttachmentUrl')
|
|
1544
|
+
PreSignedConnectionUrl = Shapes::StringShape.new(name: 'PreSignedConnectionUrl')
|
|
1541
1545
|
PredefinedAttribute = Shapes::StructureShape.new(name: 'PredefinedAttribute')
|
|
1542
1546
|
PredefinedAttributeConfiguration = Shapes::StructureShape.new(name: 'PredefinedAttributeConfiguration')
|
|
1543
1547
|
PredefinedAttributeName = Shapes::StringShape.new(name: 'PredefinedAttributeName')
|
|
@@ -2335,6 +2339,7 @@ module Aws::Connect
|
|
|
2335
2339
|
WebNotificationContent = Shapes::StructureShape.new(name: 'WebNotificationContent')
|
|
2336
2340
|
WebNotificationSource = Shapes::StructureShape.new(name: 'WebNotificationSource')
|
|
2337
2341
|
WebSessionId = Shapes::StringShape.new(name: 'WebSessionId')
|
|
2342
|
+
Websocket = Shapes::StructureShape.new(name: 'Websocket')
|
|
2338
2343
|
WeekdayOccurrenceInteger = Shapes::IntegerShape.new(name: 'WeekdayOccurrenceInteger')
|
|
2339
2344
|
WeekdayOccurrenceList = Shapes::ListShape.new(name: 'WeekdayOccurrenceList')
|
|
2340
2345
|
WidgetDestination = Shapes::StructureShape.new(name: 'WidgetDestination')
|
|
@@ -3155,10 +3160,16 @@ module Aws::Connect
|
|
|
3155
3160
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
|
3156
3161
|
ConflictException.struct_class = Types::ConflictException
|
|
3157
3162
|
|
|
3163
|
+
ConnectionCredentials.add_member(:connection_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ConnectionToken"))
|
|
3164
|
+
ConnectionCredentials.add_member(:expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "Expiry"))
|
|
3165
|
+
ConnectionCredentials.struct_class = Types::ConnectionCredentials
|
|
3166
|
+
|
|
3158
3167
|
ConnectionData.add_member(:attendee, Shapes::ShapeRef.new(shape: Attendee, location_name: "Attendee"))
|
|
3159
3168
|
ConnectionData.add_member(:meeting, Shapes::ShapeRef.new(shape: Meeting, location_name: "Meeting"))
|
|
3160
3169
|
ConnectionData.struct_class = Types::ConnectionData
|
|
3161
3170
|
|
|
3171
|
+
ConnectionTypeList.member = Shapes::ShapeRef.new(shape: ConnectionType)
|
|
3172
|
+
|
|
3162
3173
|
Contact.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
|
3163
3174
|
Contact.add_member(:id, Shapes::ShapeRef.new(shape: ContactId, location_name: "Id"))
|
|
3164
3175
|
Contact.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "InitialContactId"))
|
|
@@ -8813,12 +8824,17 @@ module Aws::Connect
|
|
|
8813
8824
|
StartChatContactRequest.add_member(:segment_attributes, Shapes::ShapeRef.new(shape: SegmentAttributes, location_name: "SegmentAttributes"))
|
|
8814
8825
|
StartChatContactRequest.add_member(:customer_id, Shapes::ShapeRef.new(shape: CustomerIdNonEmpty, location_name: "CustomerId"))
|
|
8815
8826
|
StartChatContactRequest.add_member(:disconnect_on_customer_exit, Shapes::ShapeRef.new(shape: DisconnectOnCustomerExit, location_name: "DisconnectOnCustomerExit"))
|
|
8827
|
+
StartChatContactRequest.add_member(:connection_types, Shapes::ShapeRef.new(shape: ConnectionTypeList, location_name: "ConnectionTypes"))
|
|
8828
|
+
StartChatContactRequest.add_member(:chat_streaming_configuration, Shapes::ShapeRef.new(shape: ChatStreamingConfiguration, location_name: "ChatStreamingConfiguration"))
|
|
8816
8829
|
StartChatContactRequest.struct_class = Types::StartChatContactRequest
|
|
8817
8830
|
|
|
8818
8831
|
StartChatContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
|
8819
8832
|
StartChatContactResponse.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
|
|
8820
8833
|
StartChatContactResponse.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ParticipantToken"))
|
|
8821
8834
|
StartChatContactResponse.add_member(:continued_from_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContinuedFromContactId"))
|
|
8835
|
+
StartChatContactResponse.add_member(:connection_credentials, Shapes::ShapeRef.new(shape: ConnectionCredentials, location_name: "ConnectionCredentials"))
|
|
8836
|
+
StartChatContactResponse.add_member(:websocket, Shapes::ShapeRef.new(shape: Websocket, location_name: "Websocket"))
|
|
8837
|
+
StartChatContactResponse.add_member(:streaming_id, Shapes::ShapeRef.new(shape: StreamingId, location_name: "StreamingId"))
|
|
8822
8838
|
StartChatContactResponse.struct_class = Types::StartChatContactResponse
|
|
8823
8839
|
|
|
8824
8840
|
StartContactConversationalAnalyticsJobRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
|
@@ -10229,6 +10245,10 @@ module Aws::Connect
|
|
|
10229
10245
|
WebNotificationSource.add_member(:source_campaign, Shapes::ShapeRef.new(shape: SourceCampaign, required: true, location_name: "SourceCampaign"))
|
|
10230
10246
|
WebNotificationSource.struct_class = Types::WebNotificationSource
|
|
10231
10247
|
|
|
10248
|
+
Websocket.add_member(:url, Shapes::ShapeRef.new(shape: PreSignedConnectionUrl, location_name: "Url"))
|
|
10249
|
+
Websocket.add_member(:connection_expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "ConnectionExpiry"))
|
|
10250
|
+
Websocket.struct_class = Types::Websocket
|
|
10251
|
+
|
|
10232
10252
|
WeekdayOccurrenceList.member = Shapes::ShapeRef.new(shape: WeekdayOccurrenceInteger)
|
|
10233
10253
|
|
|
10234
10254
|
WidgetDestination.add_member(:widget_id, Shapes::ShapeRef.new(shape: WidgetId, required: true, location_name: "WidgetId"))
|
|
@@ -13432,6 +13452,12 @@ module Aws::Connect
|
|
|
13432
13452
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
13433
13453
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
|
13434
13454
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
|
13455
|
+
o[:pager] = Aws::Pager.new(
|
|
13456
|
+
limit_key: "max_results",
|
|
13457
|
+
tokens: {
|
|
13458
|
+
"next_token" => "next_token"
|
|
13459
|
+
}
|
|
13460
|
+
)
|
|
13435
13461
|
end)
|
|
13436
13462
|
|
|
13437
13463
|
api.add_operation(:list_evaluation_form_versions, Seahorse::Model::Operation.new.tap do |o|
|
|
@@ -3744,6 +3744,28 @@ module Aws::Connect
|
|
|
3744
3744
|
include Aws::Structure
|
|
3745
3745
|
end
|
|
3746
3746
|
|
|
3747
|
+
# The credentials that a chat participant uses to connect to the Connect
|
|
3748
|
+
# Customer Participant Service.
|
|
3749
|
+
#
|
|
3750
|
+
# @!attribute [rw] connection_token
|
|
3751
|
+
# The connection token used by the chat participant to call the
|
|
3752
|
+
# Connect Customer Participant Service.
|
|
3753
|
+
# @return [String]
|
|
3754
|
+
#
|
|
3755
|
+
# @!attribute [rw] expiry
|
|
3756
|
+
# The expiration of the token. It's specified in ISO 8601 format:
|
|
3757
|
+
# yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
|
|
3758
|
+
# @return [String]
|
|
3759
|
+
#
|
|
3760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ConnectionCredentials AWS API Documentation
|
|
3761
|
+
#
|
|
3762
|
+
class ConnectionCredentials < Struct.new(
|
|
3763
|
+
:connection_token,
|
|
3764
|
+
:expiry)
|
|
3765
|
+
SENSITIVE = []
|
|
3766
|
+
include Aws::Structure
|
|
3767
|
+
end
|
|
3768
|
+
|
|
3747
3769
|
# Information required to join the call.
|
|
3748
3770
|
#
|
|
3749
3771
|
# @!attribute [rw] attendee
|
|
@@ -34428,6 +34450,52 @@ module Aws::Connect
|
|
|
34428
34450
|
# disconnect flows such as surveys or feedback forms.
|
|
34429
34451
|
# @return [Array<String>]
|
|
34430
34452
|
#
|
|
34453
|
+
# @!attribute [rw] connection_types
|
|
34454
|
+
# The types of connection information to return in the response. This
|
|
34455
|
+
# parameter is optional.
|
|
34456
|
+
#
|
|
34457
|
+
# Specify `CONNECTION_CREDENTIALS` to receive a connection token.
|
|
34458
|
+
# Specify `WEBSOCKET` to receive a websocket URL. You can specify
|
|
34459
|
+
# both. No other value returns connection information.
|
|
34460
|
+
#
|
|
34461
|
+
# Request `WEBSOCKET` to get a URL the participant connects to
|
|
34462
|
+
# directly. You do not need to call [CreateParticipantConnection][1]
|
|
34463
|
+
# for it. Request `CONNECTION_CREDENTIALS` on its own and the response
|
|
34464
|
+
# returns a connection token but no websocket URL.
|
|
34465
|
+
#
|
|
34466
|
+
# If you omit this parameter, the response has no connection
|
|
34467
|
+
# information.
|
|
34468
|
+
#
|
|
34469
|
+
# <note markdown="1"> If the information you request cannot be returned, StartChatContact
|
|
34470
|
+
# returns an error rather than a response that omits it.
|
|
34471
|
+
#
|
|
34472
|
+
# </note>
|
|
34473
|
+
#
|
|
34474
|
+
#
|
|
34475
|
+
#
|
|
34476
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
|
34477
|
+
# @return [Array<String>]
|
|
34478
|
+
#
|
|
34479
|
+
# @!attribute [rw] chat_streaming_configuration
|
|
34480
|
+
# The streaming configuration, such as the Amazon SNS streaming
|
|
34481
|
+
# endpoint. Use it to initiate real-time message streaming when the
|
|
34482
|
+
# chat is created. This parameter is optional.
|
|
34483
|
+
#
|
|
34484
|
+
# When you set this parameter, the response includes `StreamingId`.
|
|
34485
|
+
# You do not need to call [StartContactStreaming][1].
|
|
34486
|
+
#
|
|
34487
|
+
# <note markdown="1"> This parameter starts message streaming only. The response does not
|
|
34488
|
+
# include connection information, and setting this parameter does not
|
|
34489
|
+
# remove the need to call [CreateParticipantConnection][2].
|
|
34490
|
+
#
|
|
34491
|
+
# </note>
|
|
34492
|
+
#
|
|
34493
|
+
#
|
|
34494
|
+
#
|
|
34495
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
|
|
34496
|
+
# [2]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
|
34497
|
+
# @return [Types::ChatStreamingConfiguration]
|
|
34498
|
+
#
|
|
34431
34499
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactRequest AWS API Documentation
|
|
34432
34500
|
#
|
|
34433
34501
|
class StartChatContactRequest < Struct.new(
|
|
@@ -34444,7 +34512,9 @@ module Aws::Connect
|
|
|
34444
34512
|
:related_contact_id,
|
|
34445
34513
|
:segment_attributes,
|
|
34446
34514
|
:customer_id,
|
|
34447
|
-
:disconnect_on_customer_exit
|
|
34515
|
+
:disconnect_on_customer_exit,
|
|
34516
|
+
:connection_types,
|
|
34517
|
+
:chat_streaming_configuration)
|
|
34448
34518
|
SENSITIVE = [:customer_id]
|
|
34449
34519
|
include Aws::Structure
|
|
34450
34520
|
end
|
|
@@ -34473,13 +34543,37 @@ module Aws::Connect
|
|
|
34473
34543
|
# field is populated only for persistent chats.
|
|
34474
34544
|
# @return [String]
|
|
34475
34545
|
#
|
|
34546
|
+
# @!attribute [rw] connection_credentials
|
|
34547
|
+
# The connection credentials for the chat participant. Returned only
|
|
34548
|
+
# when the request includes `CONNECTION_CREDENTIALS` in
|
|
34549
|
+
# `ConnectionTypes`.
|
|
34550
|
+
# @return [Types::ConnectionCredentials]
|
|
34551
|
+
#
|
|
34552
|
+
# @!attribute [rw] websocket
|
|
34553
|
+
# The websocket for the chat participant. Returned only when the
|
|
34554
|
+
# request includes `WEBSOCKET` in `ConnectionTypes`.
|
|
34555
|
+
# @return [Types::Websocket]
|
|
34556
|
+
#
|
|
34557
|
+
# @!attribute [rw] streaming_id
|
|
34558
|
+
# The identifier of the streaming configuration enabled with the chat.
|
|
34559
|
+
# Returned only when the request sets `ChatStreamingConfiguration`.
|
|
34560
|
+
# Use this value to call [StopContactStreaming][1].
|
|
34561
|
+
#
|
|
34562
|
+
#
|
|
34563
|
+
#
|
|
34564
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StopContactStreaming.html
|
|
34565
|
+
# @return [String]
|
|
34566
|
+
#
|
|
34476
34567
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactResponse AWS API Documentation
|
|
34477
34568
|
#
|
|
34478
34569
|
class StartChatContactResponse < Struct.new(
|
|
34479
34570
|
:contact_id,
|
|
34480
34571
|
:participant_id,
|
|
34481
34572
|
:participant_token,
|
|
34482
|
-
:continued_from_contact_id
|
|
34573
|
+
:continued_from_contact_id,
|
|
34574
|
+
:connection_credentials,
|
|
34575
|
+
:websocket,
|
|
34576
|
+
:streaming_id)
|
|
34483
34577
|
SENSITIVE = []
|
|
34484
34578
|
include Aws::Structure
|
|
34485
34579
|
end
|
|
@@ -38552,13 +38646,6 @@ module Aws::Connect
|
|
|
38552
38646
|
# resource.
|
|
38553
38647
|
#
|
|
38554
38648
|
# </note>
|
|
38555
|
-
#
|
|
38556
|
-
# <note markdown="1"> If you set the attribute type `AUTO_MUTE_AGENT_ON_HOLD` to `true`,
|
|
38557
|
-
# the system automatically mutes agents while they're on hold and
|
|
38558
|
-
# unmutes them when they resume the contact. Agents can't change
|
|
38559
|
-
# their mute state while on hold.
|
|
38560
|
-
#
|
|
38561
|
-
# </note>
|
|
38562
38649
|
# @return [String]
|
|
38563
38650
|
#
|
|
38564
38651
|
# @!attribute [rw] value
|
|
@@ -41845,6 +41932,28 @@ module Aws::Connect
|
|
|
41845
41932
|
include Aws::Structure
|
|
41846
41933
|
end
|
|
41847
41934
|
|
|
41935
|
+
# The websocket that a chat participant uses to receive messages and
|
|
41936
|
+
# events for the chat.
|
|
41937
|
+
#
|
|
41938
|
+
# @!attribute [rw] url
|
|
41939
|
+
# The URL of the websocket.
|
|
41940
|
+
# @return [String]
|
|
41941
|
+
#
|
|
41942
|
+
# @!attribute [rw] connection_expiry
|
|
41943
|
+
# The expiration of the websocket URL. It's specified in ISO 8601
|
|
41944
|
+
# format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
41945
|
+
# 2019-11-08T02:41:28.172Z.
|
|
41946
|
+
# @return [String]
|
|
41947
|
+
#
|
|
41948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Websocket AWS API Documentation
|
|
41949
|
+
#
|
|
41950
|
+
class Websocket < Struct.new(
|
|
41951
|
+
:url,
|
|
41952
|
+
:connection_expiry)
|
|
41953
|
+
SENSITIVE = []
|
|
41954
|
+
include Aws::Structure
|
|
41955
|
+
end
|
|
41956
|
+
|
|
41848
41957
|
# The destination for an outbound web notification, specifying the
|
|
41849
41958
|
# communication widget that delivers the notification and the customer
|
|
41850
41959
|
# profile of the recipient.
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -4658,6 +4658,9 @@ module Aws
|
|
|
4658
4658
|
def participant_id: () -> ::String
|
|
4659
4659
|
def participant_token: () -> ::String
|
|
4660
4660
|
def continued_from_contact_id: () -> ::String
|
|
4661
|
+
def connection_credentials: () -> Types::ConnectionCredentials
|
|
4662
|
+
def websocket: () -> Types::Websocket
|
|
4663
|
+
def streaming_id: () -> ::String
|
|
4661
4664
|
end
|
|
4662
4665
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#start_chat_contact-instance_method
|
|
4663
4666
|
def start_chat_contact: (
|
|
@@ -4684,7 +4687,11 @@ module Aws
|
|
|
4684
4687
|
?related_contact_id: ::String,
|
|
4685
4688
|
?segment_attributes: Hash[::String, Params::segment_attribute_value],
|
|
4686
4689
|
?customer_id: ::String,
|
|
4687
|
-
?disconnect_on_customer_exit: Array[("AGENT")]
|
|
4690
|
+
?disconnect_on_customer_exit: Array[("AGENT")],
|
|
4691
|
+
?connection_types: Array[("WEBSOCKET" | "CONNECTION_CREDENTIALS" | "AUTHENTICATION_SESSION" | "WEBRTC_CONNECTION")],
|
|
4692
|
+
?chat_streaming_configuration: {
|
|
4693
|
+
streaming_endpoint_arn: ::String
|
|
4694
|
+
}
|
|
4688
4695
|
) -> _StartChatContactResponseSuccess
|
|
4689
4696
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartChatContactResponseSuccess
|
|
4690
4697
|
|
data/sig/types.rbs
CHANGED
|
@@ -927,6 +927,12 @@ module Aws::Connect
|
|
|
927
927
|
SENSITIVE: []
|
|
928
928
|
end
|
|
929
929
|
|
|
930
|
+
class ConnectionCredentials
|
|
931
|
+
attr_accessor connection_token: ::String
|
|
932
|
+
attr_accessor expiry: ::String
|
|
933
|
+
SENSITIVE: []
|
|
934
|
+
end
|
|
935
|
+
|
|
930
936
|
class ConnectionData
|
|
931
937
|
attr_accessor attendee: Types::Attendee
|
|
932
938
|
attr_accessor meeting: Types::Meeting
|
|
@@ -8039,6 +8045,8 @@ module Aws::Connect
|
|
|
8039
8045
|
attr_accessor segment_attributes: ::Hash[::String, Types::SegmentAttributeValue]
|
|
8040
8046
|
attr_accessor customer_id: ::String
|
|
8041
8047
|
attr_accessor disconnect_on_customer_exit: ::Array[("AGENT")]
|
|
8048
|
+
attr_accessor connection_types: ::Array[("WEBSOCKET" | "CONNECTION_CREDENTIALS" | "AUTHENTICATION_SESSION" | "WEBRTC_CONNECTION")]
|
|
8049
|
+
attr_accessor chat_streaming_configuration: Types::ChatStreamingConfiguration
|
|
8042
8050
|
SENSITIVE: [:customer_id]
|
|
8043
8051
|
end
|
|
8044
8052
|
|
|
@@ -8047,6 +8055,9 @@ module Aws::Connect
|
|
|
8047
8055
|
attr_accessor participant_id: ::String
|
|
8048
8056
|
attr_accessor participant_token: ::String
|
|
8049
8057
|
attr_accessor continued_from_contact_id: ::String
|
|
8058
|
+
attr_accessor connection_credentials: Types::ConnectionCredentials
|
|
8059
|
+
attr_accessor websocket: Types::Websocket
|
|
8060
|
+
attr_accessor streaming_id: ::String
|
|
8050
8061
|
SENSITIVE: []
|
|
8051
8062
|
end
|
|
8052
8063
|
|
|
@@ -9787,6 +9798,12 @@ module Aws::Connect
|
|
|
9787
9798
|
SENSITIVE: []
|
|
9788
9799
|
end
|
|
9789
9800
|
|
|
9801
|
+
class Websocket
|
|
9802
|
+
attr_accessor url: ::String
|
|
9803
|
+
attr_accessor connection_expiry: ::String
|
|
9804
|
+
SENSITIVE: []
|
|
9805
|
+
end
|
|
9806
|
+
|
|
9790
9807
|
class WidgetDestination
|
|
9791
9808
|
attr_accessor widget_id: ::String
|
|
9792
9809
|
attr_accessor profile_id: ::String
|