aws-sdk-connect 1.101.0 → 1.102.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1726ff9c191d9464cfe306339becbb2a822ae41de4c758f62d59a5cecb48a742
-  data.tar.gz: 592a3cdf2839854beb6ddced1fe5e077e0814c30b8e9fbedcd8cd18ea09af4c2
+  metadata.gz: 5a29f940033588eb0006159a35001202bd865d1bf957208e53d29139617587d4
+  data.tar.gz: 1aa83b64406d74f85717ef13a96e0fbb43e58746b704543f0c16cf28b8954c8e
 SHA512:
-  metadata.gz: 6218d62f8d77123a39281b416efd8c17f202941142a56844011df7a65e608fdf88212e7c808426a5c41a949fb76f568a83ddc907594b719b2c3cf52a8a579794
-  data.tar.gz: 3c67ec51c87b90589f1a71b57522c9b96261d53448cc755d7a8b99bddbe5431ccc185a6056174c70ed858f86257ea4a0f59173d189c8f2de57c8751df3e25cd5
+  metadata.gz: 7e58534038b1a451ae6e2294945457144ff5ceb1986e8a7cf5291a7be4be405f319de988826e276638fc4c9238ec5c145b3eab8fa32a43cf7584926e471033b1
+  data.tar.gz: a04b0ccb61aa1038cbcacfd32813f3f46a2702996e197b854e08aac844455490def2637a3b8004ee96897cfe191f9ff55e6da3ba1d44d23e7eb25bddcb600b9d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.102.0 (2023-04-21)
+------------------
+
+* Feature - This release adds a new API CreateParticipant. For Amazon Connect Chat, you can use this new API to customize chat flow experiences.
+
 1.101.0 (2023-04-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.101.0
+1.102.0

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

@@ -1303,6 +1303,78 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Adds a new participant into an on-going chat contact. For more
+    # information, see [Customize chat flow experiences by integrating
+    # custom participants][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #
+    # @option params [required, String] :contact_id
+    #   The identifier of the contact in this instance of Amazon Connect. Only
+    #   contacts in the CHAT channel are supported.
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency, see
+    #   [Making retries safe with idempotent APIs][1].
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
+    #
+    # @option params [required, Types::ParticipantDetailsToAdd] :participant_details
+    #   Information identifying the participant.
+    #
+    #   The only Valid value for `ParticipantRole` is `CUSTOM_BOT`.
+    #
+    #    `DisplayName` is **Required**.
+    #
+    # @return [Types::CreateParticipantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateParticipantResponse#participant_credentials #participant_credentials} => Types::ParticipantTokenCredentials
+    #   * {Types::CreateParticipantResponse#participant_id #participant_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_participant({
+    #     instance_id: "InstanceId", # required
+    #     contact_id: "ContactId", # required
+    #     client_token: "ClientToken",
+    #     participant_details: { # required
+    #       participant_role: "AGENT", # accepts AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT
+    #       display_name: "DisplayName",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.participant_credentials.participant_token #=> String
+    #   resp.participant_credentials.expiry #=> String
+    #   resp.participant_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateParticipant AWS API Documentation
+    #
+    # @overload create_participant(params = {})
+    # @param [Hash] params ({})
+    def create_participant(params = {}, options = {})
+      req = build_request(:create_participant, params)
+      req.send_request(options)
+    end
+
     # This API is in preview release for Amazon Connect and is subject to
     # change.
     #
@@ -10790,7 +10862,7 @@ module Aws::Connect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connect'
-      context[:gem_version] = '1.101.0'
+      context[:gem_version] = '1.102.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -132,6 +132,8 @@ module Aws::Connect
     CreateInstanceResponse = Shapes::StructureShape.new(name: 'CreateInstanceResponse')
     CreateIntegrationAssociationRequest = Shapes::StructureShape.new(name: 'CreateIntegrationAssociationRequest')
     CreateIntegrationAssociationResponse = Shapes::StructureShape.new(name: 'CreateIntegrationAssociationResponse')
+    CreateParticipantRequest = Shapes::StructureShape.new(name: 'CreateParticipantRequest')
+    CreateParticipantResponse = Shapes::StructureShape.new(name: 'CreateParticipantResponse')
     CreateQueueRequest = Shapes::StructureShape.new(name: 'CreateQueueRequest')
     CreateQueueResponse = Shapes::StructureShape.new(name: 'CreateQueueResponse')
     CreateQuickConnectRequest = Shapes::StructureShape.new(name: 'CreateQuickConnectRequest')
@@ -321,6 +323,7 @@ module Aws::Connect
     HoursOfOperationSummary = Shapes::StructureShape.new(name: 'HoursOfOperationSummary')
     HoursOfOperationSummaryList = Shapes::ListShape.new(name: 'HoursOfOperationSummaryList')
     HoursOfOperationTimeSlice = Shapes::StructureShape.new(name: 'HoursOfOperationTimeSlice')
+    ISO8601Datetime = Shapes::StringShape.new(name: 'ISO8601Datetime')
     IdempotencyException = Shapes::StructureShape.new(name: 'IdempotencyException')
     InboundCallsEnabled = Shapes::BooleanShape.new(name: 'InboundCallsEnabled')
     Instance = Shapes::StructureShape.new(name: 'Instance')
@@ -468,7 +471,9 @@ module Aws::Connect
     OutboundContactNotPermittedException = Shapes::StructureShape.new(name: 'OutboundContactNotPermittedException')
     PEM = Shapes::StringShape.new(name: 'PEM')
     ParticipantDetails = Shapes::StructureShape.new(name: 'ParticipantDetails')
+    ParticipantDetailsToAdd = Shapes::StructureShape.new(name: 'ParticipantDetailsToAdd')
     ParticipantId = Shapes::StringShape.new(name: 'ParticipantId')
+    ParticipantRole = Shapes::StringShape.new(name: 'ParticipantRole')
     ParticipantTimerAction = Shapes::StringShape.new(name: 'ParticipantTimerAction')
     ParticipantTimerConfigList = Shapes::ListShape.new(name: 'ParticipantTimerConfigList')
     ParticipantTimerConfiguration = Shapes::StructureShape.new(name: 'ParticipantTimerConfiguration')
@@ -476,6 +481,7 @@ module Aws::Connect
     ParticipantTimerType = Shapes::StringShape.new(name: 'ParticipantTimerType')
     ParticipantTimerValue = Shapes::UnionShape.new(name: 'ParticipantTimerValue')
     ParticipantToken = Shapes::StringShape.new(name: 'ParticipantToken')
+    ParticipantTokenCredentials = Shapes::StructureShape.new(name: 'ParticipantTokenCredentials')
     Password = Shapes::StringShape.new(name: 'Password')
     Percentage = Shapes::IntegerShape.new(name: 'Percentage')
     PermissionsList = Shapes::ListShape.new(name: 'PermissionsList')
@@ -1129,6 +1135,16 @@ module Aws::Connect
     CreateIntegrationAssociationResponse.add_member(:integration_association_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "IntegrationAssociationArn"))
     CreateIntegrationAssociationResponse.struct_class = Types::CreateIntegrationAssociationResponse
 
+    CreateParticipantRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
+    CreateParticipantRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
+    CreateParticipantRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
+    CreateParticipantRequest.add_member(:participant_details, Shapes::ShapeRef.new(shape: ParticipantDetailsToAdd, required: true, location_name: "ParticipantDetails"))
+    CreateParticipantRequest.struct_class = Types::CreateParticipantRequest
+
+    CreateParticipantResponse.add_member(:participant_credentials, Shapes::ShapeRef.new(shape: ParticipantTokenCredentials, location_name: "ParticipantCredentials"))
+    CreateParticipantResponse.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
+    CreateParticipantResponse.struct_class = Types::CreateParticipantResponse
+
     CreateQueueRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
     CreateQueueRequest.add_member(:name, Shapes::ShapeRef.new(shape: CommonNameLength127, required: true, location_name: "Name"))
     CreateQueueRequest.add_member(:description, Shapes::ShapeRef.new(shape: QueueDescription, location_name: "Description"))
@@ -2298,6 +2314,10 @@ module Aws::Connect
     ParticipantDetails.add_member(:display_name, Shapes::ShapeRef.new(shape: DisplayName, required: true, location_name: "DisplayName"))
     ParticipantDetails.struct_class = Types::ParticipantDetails
 
+    ParticipantDetailsToAdd.add_member(:participant_role, Shapes::ShapeRef.new(shape: ParticipantRole, location_name: "ParticipantRole"))
+    ParticipantDetailsToAdd.add_member(:display_name, Shapes::ShapeRef.new(shape: DisplayName, location_name: "DisplayName"))
+    ParticipantDetailsToAdd.struct_class = Types::ParticipantDetailsToAdd
+
     ParticipantTimerConfigList.member = Shapes::ShapeRef.new(shape: ParticipantTimerConfiguration)
 
     ParticipantTimerConfiguration.add_member(:participant_role, Shapes::ShapeRef.new(shape: TimerEligibleParticipantRoles, required: true, location_name: "ParticipantRole"))
@@ -2313,6 +2333,10 @@ module Aws::Connect
     ParticipantTimerValue.add_member_subclass(:unknown, Types::ParticipantTimerValue::Unknown)
     ParticipantTimerValue.struct_class = Types::ParticipantTimerValue
 
+    ParticipantTokenCredentials.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ParticipantToken"))
+    ParticipantTokenCredentials.add_member(:expiry, Shapes::ShapeRef.new(shape: ISO8601Datetime, location_name: "Expiry"))
+    ParticipantTokenCredentials.struct_class = Types::ParticipantTokenCredentials
+
     PermissionsList.member = Shapes::ShapeRef.new(shape: SecurityProfilePermission)
 
     PersistentChat.add_member(:rehydration_type, Shapes::ShapeRef.new(shape: RehydrationType, location_name: "RehydrationType"))
@@ -3616,6 +3640,20 @@ module Aws::Connect
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:create_participant, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CreateParticipant"
+        o.http_method = "POST"
+        o.http_request_uri = "/contact/create-participant"
+        o.input = Shapes::ShapeRef.new(shape: CreateParticipantRequest)
+        o.output = Shapes::ShapeRef.new(shape: CreateParticipantResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+      end)
+
       api.add_operation(:create_queue, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateQueue"
         o.http_method = "PUT"

data/lib/aws-sdk-connect/endpoints.rb

@@ -249,6 +249,20 @@ module Aws::Connect
       end
     end
 
+    class CreateParticipant
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Connect::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class CreateQueue
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-connect/plugins/endpoints.rb

@@ -90,6 +90,8 @@ module Aws::Connect
             Aws::Connect::Endpoints::CreateInstance.build(context)
           when :create_integration_association
             Aws::Connect::Endpoints::CreateIntegrationAssociation.build(context)
+          when :create_participant
+            Aws::Connect::Endpoints::CreateParticipant.build(context)
           when :create_queue
             Aws::Connect::Endpoints::CreateQueue.build(context)
           when :create_quick_connect

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

@@ -1570,6 +1570,73 @@ module Aws::Connect
       include Aws::Structure
     end
 
+    # @!attribute [rw] instance_id
+    #   The identifier of the Amazon Connect instance. You can [find the
+    #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
+    #   @return [String]
+    #
+    # @!attribute [rw] contact_id
+    #   The identifier of the contact in this instance of Amazon Connect.
+    #   Only contacts in the CHAT channel are supported.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. If not provided, the Amazon Web Services
+    #   SDK populates this field. For more information about idempotency,
+    #   see [Making retries safe with idempotent APIs][1].
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
+    #   @return [String]
+    #
+    # @!attribute [rw] participant_details
+    #   Information identifying the participant.
+    #
+    #   The only Valid value for `ParticipantRole` is `CUSTOM_BOT`.
+    #
+    #    `DisplayName` is **Required**.
+    #   @return [Types::ParticipantDetailsToAdd]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateParticipantRequest AWS API Documentation
+    #
+    class CreateParticipantRequest < Struct.new(
+      :instance_id,
+      :contact_id,
+      :client_token,
+      :participant_details)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] participant_credentials
+    #   The token used by the chat participant to call
+    #   `CreateParticipantConnection`. The participant token is valid for
+    #   the lifetime of a chat participant.
+    #   @return [Types::ParticipantTokenCredentials]
+    #
+    # @!attribute [rw] participant_id
+    #   The identifier for a chat participant. The participantId for a chat
+    #   participant is the same throughout the chat lifecycle.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateParticipantResponse AWS API Documentation
+    #
+    class CreateParticipantResponse < Struct.new(
+      :participant_credentials,
+      :participant_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] instance_id
     #   The identifier of the Amazon Connect instance. You can [find the
     #   instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -7787,7 +7854,15 @@ module Aws::Connect
     # @!attribute [rw] metric_filter_key
     #   The key to use for filtering data.
     #
-    #   Valid metric filter keys: `INITIATION_METHOD`, `DISCONNECT_REASON`
+    #   Valid metric filter keys: `INITIATION_METHOD`, `DISCONNECT_REASON`.
+    #   These are the same values as the `InitiationMethod` and
+    #   `DisconnectReason` in the contact record. For more information, see
+    #   [ContactTraceRecord][1] in the *Amazon Connect Administrator's
+    #   Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
     #   @return [String]
     #
     # @!attribute [rw] metric_filter_values
@@ -8010,6 +8085,25 @@ module Aws::Connect
       include Aws::Structure
     end
 
+    # The details to add for the participant.
+    #
+    # @!attribute [rw] participant_role
+    #   The role of the participant being added.
+    #   @return [String]
+    #
+    # @!attribute [rw] display_name
+    #   The display name of the participant.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantDetailsToAdd AWS API Documentation
+    #
+    class ParticipantDetailsToAdd < Struct.new(
+      :participant_role,
+      :display_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Configuration information for the timer. After the timer configuration
     # is set, it persists for the duration of the chat. It persists across
     # new contacts in the chain, for example, transfer contacts.
@@ -8085,6 +8179,32 @@ module Aws::Connect
       class Unknown < ParticipantTimerValue; end
     end
 
+    # The credentials used by the participant.
+    #
+    # @!attribute [rw] participant_token
+    #   The token used by the chat participant to call
+    #   [CreateParticipantConnection][1]. The participant token is valid for
+    #   the lifetime of a chat participant.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
+    #   @return [String]
+    #
+    # @!attribute [rw] expiry
+    #   The expiration of the token. It's specified in ISO 8601 format:
+    #   yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantTokenCredentials AWS API Documentation
+    #
+    class ParticipantTokenCredentials < Struct.new(
+      :participant_token,
+      :expiry)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Enable persistent chats. For more information about enabling
     # persistent chat, and for example use cases and how to configure for
     # them, see [Enable persistent chat][1].

data/lib/aws-sdk-connect.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connect/customizations'
 # @!group service
 module Aws::Connect
 
-  GEM_VERSION = '1.101.0'
+  GEM_VERSION = '1.102.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connect
 version: !ruby/object:Gem::Version
-  version: 1.101.0
+  version: 1.102.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core