aws-sdk-connectparticipant 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e706f07da1c882a50214dabc6b0fe41d4494ab3ee995680a37df22f13c862ee6
-  data.tar.gz: 8d4c3423741cb2979ebe1bce8b0b161dad0564eca45d0c4735f5e91b338c8ff9
+  metadata.gz: 0ce4cd652d939d472b0ffa917426074871fe3d2a8db8de912e9e33133f1e1192
+  data.tar.gz: 679aece11e9d21ff84ef5714cca371410e1d3b3bf98116a05370683b79473d2d
 SHA512:
-  metadata.gz: e9991c03d8d896d00486c5e87b3cbfca644bb8c3f8aa7ef40afac1a6811a2f5529a0a004922b67851a991e8011e58f22a148724e3d8394047f0063ba691d2298
-  data.tar.gz: cb1eab6257cbe8da8258525e35801ba249ea2eda172d81d8b85aa5a2744d8bee9216dcb4b8184c918d8aaff0cf2caff4565124cadcc13cdc9edb1e7516341d7f
+  metadata.gz: 8c4ab099f9c60be454b361ff1009c7f72dbe31d01172408cb918a258ad3dc6c11b0d4cac6caea7649cd02b05de8d2120db185b90334f09e8b2f5338eeb1ce248
+  data.tar.gz: 0e5b29095e331d31426297176c6aa1e8a644729bcc50fb7af65f362d2642fb570b7866fd4ca0cc47afb0d0ce2c56a3303029336b4319db4b4d9fbe6600e207dc

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.16.0 (2021-10-28)
+------------------
+
+* Feature - This release adds a new boolean attribute - Connect Participant - to the CreateParticipantConnection API, which can be used to mark the participant as connected.
+
 1.15.0 (2021-10-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.15.0
+1.16.0

data/lib/aws-sdk-connectparticipant/client.rb

@@ -330,6 +330,13 @@ module Aws::ConnectParticipant
     # Allows you to confirm that the attachment has been uploaded using the
     # pre-signed URL provided in StartAttachmentUpload API.
     #
+    # The Amazon Connect Participant Service APIs do not use [Signature
+    # Version 4 authentication][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
+    #
     # @option params [required, Array<String>] :attachment_ids
     #   A list of unique identifiers for the attachments.
     #
@@ -382,14 +389,28 @@ module Aws::ConnectParticipant
     # ConnectionExpiry parameter, clients need to call this API again to
     # obtain a new websocket URL and perform the same steps as before.
     #
+    # **Message streaming support**\: This API can also be used together
+    # with the [StartContactStreaming][1] API to create a participant
+    # connection for chat contacts that are not using a websocket. For more
+    # information about message streaming, [Enable real-time chat message
+    # streaming][2] in the *Amazon Connect Administrator Guide*.
+    #
+    # **Feature specifications**\: For information about feature
+    # specifications, such as the allowed number of open websocket
+    # connections per participant, see [Feature specifications][3] in the
+    # *Amazon Connect Administrator Guide*.
+    #
     # <note markdown="1"> The Amazon Connect Participant Service APIs do not use [Signature
-    # Version 4 authentication][1].
+    # Version 4 authentication][4].
     #
     #  </note>
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
+    # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html
+    # [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits
+    # [4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     #
     # @option params [required, Array<String>] :type
     #   Type of connection information required.
@@ -397,13 +418,17 @@ module Aws::ConnectParticipant
     # @option params [required, String] :participant_token
     #   This is a header parameter.
     #
-    #   The Participant Token as obtained from [StartChatContact][1] API
+    #   The ParticipantToken as obtained from [StartChatContact][1] API
     #   response.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html
     #
+    # @option params [Boolean] :connect_participant
+    #   Amazon Connect Participant is used to mark the participant as
+    #   connected for message streaming.
+    #
     # @return [Types::CreateParticipantConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateParticipantConnectionResponse#websocket #websocket} => Types::Websocket
@@ -414,6 +439,7 @@ module Aws::ConnectParticipant
     #   resp = client.create_participant_connection({
     #     type: ["WEBSOCKET"], # required, accepts WEBSOCKET, CONNECTION_CREDENTIALS
     #     participant_token: "ParticipantToken", # required
+    #     connect_participant: false,
     #   })
     #
     # @example Response structure
@@ -474,6 +500,13 @@ module Aws::ConnectParticipant
     # Provides a pre-signed URL for download of a completed attachment. This
     # is an asynchronous API for use with active contacts.
     #
+    # The Amazon Connect Participant Service APIs do not use [Signature
+    # Version 4 authentication][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
+    #
     # @option params [required, String] :attachment_id
     #   A unique identifier for the attachment.
     #
@@ -576,7 +609,7 @@ module Aws::ConnectParticipant
     #   resp.transcript[0].content #=> String
     #   resp.transcript[0].content_type #=> String
     #   resp.transcript[0].id #=> String
-    #   resp.transcript[0].type #=> String, one of "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK"
+    #   resp.transcript[0].type #=> String, one of "TYPING", "PARTICIPANT_JOINED", "PARTICIPANT_LEFT", "CHAT_ENDED", "TRANSFER_SUCCEEDED", "TRANSFER_FAILED", "MESSAGE", "EVENT", "ATTACHMENT", "CONNECTION_ACK", "PARTICIPANT_ACTIVE", "PARTICIPANT_INACTIVE", "PARTICIPANT_ENGAGED", "PARTICIPANT_DISENGAGED"
     #   resp.transcript[0].participant_id #=> String
     #   resp.transcript[0].display_name #=> String
     #   resp.transcript[0].participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM"
@@ -659,11 +692,9 @@ module Aws::ConnectParticipant
     # Sends a message. Note that ConnectionToken is used for invoking this
     # API instead of ParticipantToken.
     #
-    # <note markdown="1"> The Amazon Connect Participant Service APIs do not use [Signature
+    # The Amazon Connect Participant Service APIs do not use [Signature
     # Version 4 authentication][1].
     #
-    #  </note>
-    #
     #
     #
     # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
@@ -715,6 +746,13 @@ module Aws::ConnectParticipant
     # Provides a pre-signed Amazon S3 URL in response for uploading the file
     # directly to S3.
     #
+    # The Amazon Connect Participant Service APIs do not use [Signature
+    # Version 4 authentication][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
+    #
     # @option params [required, String] :content_type
     #   Describes the MIME file type of the attachment. For a list of
     #   supported file types, see [Feature specifications][1] in the *Amazon
@@ -785,7 +823,7 @@ module Aws::ConnectParticipant
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connectparticipant'
-      context[:gem_version] = '1.15.0'
+      context[:gem_version] = '1.16.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-connectparticipant/client_api.rb

@@ -21,6 +21,7 @@ module Aws::ConnectParticipant
     AttachmentName = Shapes::StringShape.new(name: 'AttachmentName')
     AttachmentSizeInBytes = Shapes::IntegerShape.new(name: 'AttachmentSizeInBytes')
     Attachments = Shapes::ListShape.new(name: 'Attachments')
+    Bool = Shapes::BooleanShape.new(name: 'Bool')
     ChatContent = Shapes::StringShape.new(name: 'ChatContent')
     ChatContentType = Shapes::StringShape.new(name: 'ChatContentType')
     ChatItemId = Shapes::StringShape.new(name: 'ChatItemId')
@@ -109,6 +110,7 @@ module Aws::ConnectParticipant
 
     CreateParticipantConnectionRequest.add_member(:type, Shapes::ShapeRef.new(shape: ConnectionTypeList, required: true, location_name: "Type"))
     CreateParticipantConnectionRequest.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, required: true, location: "header", location_name: "X-Amz-Bearer"))
+    CreateParticipantConnectionRequest.add_member(:connect_participant, Shapes::ShapeRef.new(shape: Bool, location_name: "ConnectParticipant"))
     CreateParticipantConnectionRequest.struct_class = Types::CreateParticipantConnectionRequest
 
     CreateParticipantConnectionResponse.add_member(:websocket, Shapes::ShapeRef.new(shape: Websocket, location_name: "Websocket"))

data/lib/aws-sdk-connectparticipant/types.rb

@@ -140,6 +140,7 @@ module Aws::ConnectParticipant
     #       {
     #         type: ["WEBSOCKET"], # required, accepts WEBSOCKET, CONNECTION_CREDENTIALS
     #         participant_token: "ParticipantToken", # required
+    #         connect_participant: false,
     #       }
     #
     # @!attribute [rw] type
@@ -149,7 +150,7 @@ module Aws::ConnectParticipant
     # @!attribute [rw] participant_token
     #   This is a header parameter.
     #
-    #   The Participant Token as obtained from [StartChatContact][1] API
+    #   The ParticipantToken as obtained from [StartChatContact][1] API
     #   response.
     #
     #
@@ -157,11 +158,17 @@ module Aws::ConnectParticipant
     #   [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html
     #   @return [String]
     #
+    # @!attribute [rw] connect_participant
+    #   Amazon Connect Participant is used to mark the participant as
+    #   connected for message streaming.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CreateParticipantConnectionRequest AWS API Documentation
     #
     class CreateParticipantConnectionRequest < Struct.new(
       :type,
-      :participant_token)
+      :participant_token,
+      :connect_participant)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -245,8 +252,12 @@ module Aws::ConnectParticipant
     end
 
     # @!attribute [rw] url
-    #   The pre-signed URL using which file would be downloaded from Amazon
-    #   S3 by the API caller.
+    #   This is the pre-signed URL that can be used for uploading the file
+    #   to Amazon S3 when used in response to [StartAttachmentUpload][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html
     #   @return [String]
     #
     # @!attribute [rw] url_expiry
@@ -689,8 +700,12 @@ module Aws::ConnectParticipant
     # Fields to be used while uploading the attachment.
     #
     # @!attribute [rw] url
-    #   The pre-signed URL using which file would be downloaded from Amazon
-    #   S3 by the API caller.
+    #   This is the pre-signed URL that can be used for uploading the file
+    #   to Amazon S3 when used in response to [StartAttachmentUpload][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html
     #   @return [String]
     #
     # @!attribute [rw] url_expiry

data/lib/aws-sdk-connectparticipant.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-connectparticipant/customizations'
 # @!group service
 module Aws::ConnectParticipant
 
-  GEM_VERSION = '1.15.0'
+  GEM_VERSION = '1.16.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectparticipant
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core