aws-sdk-connect 1.83.0 → 1.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e116e6b76684c2170720cf42cb56afe06b61943bf486deabf6c65623dbcf2ab5
-  data.tar.gz: fb81daa5f524960bb488654ac932a6bc23e51b13173c06a70f698175b5c3b9a3
+  metadata.gz: b7ffad2a2e497607919e1aef3b44a738dbd7613c9efb716cc9e463d04ba10615
+  data.tar.gz: a993487552d3ea9588c21c2f0eca4aa8684d7b2027e9271bf29333489e5a7131
 SHA512:
-  metadata.gz: 7938100d74a77ed62b9e8d44f631a52284805c2fc051658f7895d3a496d2f030ab9695367d0d2c478e1ec080a571f82e8fbcdffde29deda37987c8f4191b97cb
-  data.tar.gz: 0b117d24aaaf10efceacbc879962019cfdff3ee4747a0745f23d4c4369156dfd3ac03cfce8ff23ae314de678be299bbfdc40654b20801ed53fe584d0d96e9b59
+  metadata.gz: 26f22c8e419b9ef8308f2e3d90c6c17d7a4a14e5d152e7446901bead8b8352833d1b362254441b32f1429c82e2ba9fad761168b5867d44b247321ff80ed0e22c
+  data.tar.gz: 9d51bb40e1577636bf3cd398ae5ad27b4020864380173dccd7ca2c0aa77adf9c3d26ceea8ae9edfcdd25e63fc685ff78f71547cf0394df7423e69167dc623278

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.84.0 (2022-11-16)
+------------------
+
+* Feature - This release adds a new MonitorContact API for initiating monitoring of ongoing Voice and Chat contacts.
+
 1.83.0 (2022-11-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.83.0
+1.84.0

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

@@ -3636,12 +3636,16 @@ module Aws::Connect
     # @option params [Array<String>] :groupings
     #   The grouping applied to the metrics returned. For example, when
     #   grouped by `QUEUE`, the metrics returned apply to each queue rather
-    #   than aggregated for all queues. If you group by `CHANNEL`, you should
-    #   include a Channels filter. VOICE, CHAT, and TASK channels are
-    #   supported.
+    #   than aggregated for all queues.
     #
-    #   If no `Grouping` is included in the request, a summary of metrics is
-    #   returned.
+    #   * If you group by `CHANNEL`, you should include a Channels filter.
+    #     VOICE, CHAT, and TASK channels are supported.
+    #
+    #   * If you group by `ROUTING_PROFILE`, you must include either a queue
+    #     or routing profile filter.
+    #
+    #   * If no `Grouping` is included in the request, a summary of metrics is
+    #     returned.
     #
     # @option params [required, Array<Types::CurrentMetric>] :current_metrics
     #   The metrics to retrieve. Specify the name and unit for each metric.
@@ -6070,6 +6074,67 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Initiates silent monitoring of a contact. The Contact Control Panel
+    # (CCP) of the user specified by *userId* will be set to silent
+    # monitoring mode on the contact.
+    #
+    # @option params [required, String] :instance_id
+    #   The identifier of the Amazon Connect instance. You can find the
+    #   instanceId in the ARN of the instance.
+    #
+    # @option params [required, String] :contact_id
+    #   The identifier of the contact.
+    #
+    # @option params [required, String] :user_id
+    #   The identifier of the user account.
+    #
+    # @option params [Array<String>] :allowed_monitor_capabilities
+    #   Specify which monitoring actions the user is allowed to take. For
+    #   example, whether the user is allowed to escalate from silent
+    #   monitoring to barge.
+    #
+    # @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/
+    #
+    # @return [Types::MonitorContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::MonitorContactResponse#contact_id #contact_id} => String
+    #   * {Types::MonitorContactResponse#contact_arn #contact_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.monitor_contact({
+    #     instance_id: "InstanceId", # required
+    #     contact_id: "ContactId", # required
+    #     user_id: "AgentResourceId", # required
+    #     allowed_monitor_capabilities: ["SILENT_MONITOR"], # accepts SILENT_MONITOR, BARGE
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.contact_id #=> String
+    #   resp.contact_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MonitorContact AWS API Documentation
+    #
+    # @overload monitor_contact(params = {})
+    # @param [Hash] params ({})
+    def monitor_contact(params = {}, options = {})
+      req = build_request(:monitor_contact, params)
+      req.send_request(options)
+    end
+
     # Changes the current status of a user or agent in Amazon Connect. If
     # the agent is currently handling a contact, this sets the agent's next
     # status.
@@ -6344,6 +6409,13 @@ module Aws::Connect
     # @option params [Types::QueueSearchCriteria] :search_criteria
     #   The search criteria to be used to return queues.
     #
+    #   <note markdown="1"> The `name` and `description` fields support "contains" queries with
+    #   a minimum of 2 characters and a maximum of 25 characters. Any queries
+    #   with character lengths outside of this range will throw invalid
+    #   results.
+    #
+    #    </note>
+    #
     # @return [Types::SearchQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::SearchQueuesResponse#queues #queues} => Array&lt;Types::Queue&gt;
@@ -6451,6 +6523,13 @@ module Aws::Connect
     # @option params [Types::RoutingProfileSearchCriteria] :search_criteria
     #   The search criteria to be used to return routing profiles.
     #
+    #   <note markdown="1"> The `name` and `description` fields support "contains" queries with
+    #   a minimum of 2 characters and a maximum of 25 characters. Any queries
+    #   with character lengths outside of this range will throw invalid
+    #   results.
+    #
+    #    </note>
+    #
     # @return [Types::SearchRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::SearchRoutingProfilesResponse#routing_profiles #routing_profiles} => Array&lt;Types::RoutingProfile&gt;
@@ -6555,6 +6634,12 @@ module Aws::Connect
     # @option params [Types::SecurityProfileSearchCriteria] :search_criteria
     #   The search criteria to be used to return security profiles.
     #
+    #   <note markdown="1"> The `name` field support "contains" queries with a minimum of 2
+    #   characters and maximum of 25 characters. Any queries with character
+    #   lengths outside of this range will throw invalid results.
+    #
+    #    </note>
+    #
     #   <note markdown="1"> The currently supported value for `FieldName`\: `name`
     #
     #    </note>
@@ -6663,10 +6748,10 @@ module Aws::Connect
     # @option params [Types::UserSearchCriteria] :search_criteria
     #   The search criteria to be used to return users.
     #
-    #   <note markdown="1"> The `Username`, `Firstname`, and `Lastname` fields support
-    #   "contains" queries with a minimum of 2 characters and a maximum of
-    #   25 characters. Any queries with character lengths outside of this
-    #   range result in empty results.
+    #   <note markdown="1"> The `name` and `description` fields support "contains" queries with
+    #   a minimum of 2 characters and a maximum of 25 characters. Any queries
+    #   with character lengths outside of this range will throw invalid
+    #   results.
     #
     #    </note>
     #
@@ -9153,7 +9238,7 @@ module Aws::Connect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connect'
-      context[:gem_version] = '1.83.0'
+      context[:gem_version] = '1.84.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -35,6 +35,7 @@ module Aws::Connect
     AgentStatusTypes = Shapes::ListShape.new(name: 'AgentStatusTypes')
     AgentUsername = Shapes::StringShape.new(name: 'AgentUsername')
     AliasArn = Shapes::StringShape.new(name: 'AliasArn')
+    AllowedMonitorCapabilities = Shapes::ListShape.new(name: 'AllowedMonitorCapabilities')
     AnswerMachineDetectionConfig = Shapes::StructureShape.new(name: 'AnswerMachineDetectionConfig')
     ApproximateTotalCount = Shapes::IntegerShape.new(name: 'ApproximateTotalCount')
     AssociateApprovedOriginRequest = Shapes::StructureShape.new(name: 'AssociateApprovedOriginRequest')
@@ -403,6 +404,9 @@ module Aws::Connect
     MediaConcurrency = Shapes::StructureShape.new(name: 'MediaConcurrency')
     Message = Shapes::StringShape.new(name: 'Message')
     MinutesLimit60 = Shapes::IntegerShape.new(name: 'MinutesLimit60')
+    MonitorCapability = Shapes::StringShape.new(name: 'MonitorCapability')
+    MonitorContactRequest = Shapes::StructureShape.new(name: 'MonitorContactRequest')
+    MonitorContactResponse = Shapes::StructureShape.new(name: 'MonitorContactResponse')
     Name = Shapes::StringShape.new(name: 'Name')
     Name128 = Shapes::StringShape.new(name: 'Name128')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
@@ -753,6 +757,8 @@ module Aws::Connect
 
     AgentStatusTypes.member = Shapes::ShapeRef.new(shape: AgentStatusType)
 
+    AllowedMonitorCapabilities.member = Shapes::ShapeRef.new(shape: MonitorCapability)
+
     AnswerMachineDetectionConfig.add_member(:enable_answer_machine_detection, Shapes::ShapeRef.new(shape: Boolean, location_name: "EnableAnswerMachineDetection"))
     AnswerMachineDetectionConfig.add_member(:await_answer_machine_prompt, Shapes::ShapeRef.new(shape: Boolean, location_name: "AwaitAnswerMachinePrompt"))
     AnswerMachineDetectionConfig.struct_class = Types::AnswerMachineDetectionConfig
@@ -2039,6 +2045,17 @@ module Aws::Connect
     MediaConcurrency.add_member(:concurrency, Shapes::ShapeRef.new(shape: Concurrency, required: true, location_name: "Concurrency"))
     MediaConcurrency.struct_class = Types::MediaConcurrency
 
+    MonitorContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
+    MonitorContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
+    MonitorContactRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: AgentResourceId, required: true, location_name: "UserId"))
+    MonitorContactRequest.add_member(:allowed_monitor_capabilities, Shapes::ShapeRef.new(shape: AllowedMonitorCapabilities, location_name: "AllowedMonitorCapabilities"))
+    MonitorContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
+    MonitorContactRequest.struct_class = Types::MonitorContactRequest
+
+    MonitorContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
+    MonitorContactResponse.add_member(:contact_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "ContactArn"))
+    MonitorContactResponse.struct_class = Types::MonitorContactResponse
+
     NumberReference.add_member(:name, Shapes::ShapeRef.new(shape: ReferenceKey, location_name: "Name"))
     NumberReference.add_member(:value, Shapes::ShapeRef.new(shape: ReferenceValue, location_name: "Value"))
     NumberReference.struct_class = Types::NumberReference
@@ -4611,6 +4628,21 @@ module Aws::Connect
         )
       end)
 
+      api.add_operation(:monitor_contact, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "MonitorContact"
+        o.http_method = "POST"
+        o.http_request_uri = "/contact/monitor"
+        o.input = Shapes::ShapeRef.new(shape: MonitorContactRequest)
+        o.output = Shapes::ShapeRef.new(shape: MonitorContactResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: IdempotencyException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
+      end)
+
       api.add_operation(:put_user_status, Seahorse::Model::Operation.new.tap do |o|
         o.name = "PutUserStatus"
         o.http_method = "PUT"

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

@@ -1495,6 +1495,20 @@ module Aws::Connect
       end
     end
 
+    class MonitorContact
+      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 PutUserStatus
       def self.build(context)
         unless context.config.regional_endpoint

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

@@ -268,6 +268,8 @@ module Aws::Connect
             Aws::Connect::Endpoints::ListUserHierarchyGroups.build(context)
           when :list_users
             Aws::Connect::Endpoints::ListUsers.build(context)
+          when :monitor_contact
+            Aws::Connect::Endpoints::MonitorContact.build(context)
           when :put_user_status
             Aws::Connect::Endpoints::PutUserStatus.build(context)
           when :release_phone_number

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

@@ -1196,6 +1196,7 @@ module Aws::Connect
     end
 
     # The contact with the specified ID is not active or does not exist.
+    # Applies to Voice calls only, not to Chat, Task, or Voice Callback.
     #
     # @!attribute [rw] message
     #   The message.
@@ -4368,12 +4369,16 @@ module Aws::Connect
     # @!attribute [rw] groupings
     #   The grouping applied to the metrics returned. For example, when
     #   grouped by `QUEUE`, the metrics returned apply to each queue rather
-    #   than aggregated for all queues. If you group by `CHANNEL`, you
-    #   should include a Channels filter. VOICE, CHAT, and TASK channels are
-    #   supported.
+    #   than aggregated for all queues.
     #
-    #   If no `Grouping` is included in the request, a summary of metrics is
-    #   returned.
+    #   * If you group by `CHANNEL`, you should include a Channels filter.
+    #     VOICE, CHAT, and TASK channels are supported.
+    #
+    #   * If you group by `ROUTING_PROFILE`, you must include either a queue
+    #     or routing profile filter.
+    #
+    #   * If no `Grouping` is included in the request, a summary of metrics
+    #     is returned.
     #   @return [Array<String>]
     #
     # @!attribute [rw] current_metrics
@@ -8006,6 +8011,79 @@ module Aws::Connect
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass MonitorContactRequest
+    #   data as a hash:
+    #
+    #       {
+    #         instance_id: "InstanceId", # required
+    #         contact_id: "ContactId", # required
+    #         user_id: "AgentResourceId", # required
+    #         allowed_monitor_capabilities: ["SILENT_MONITOR"], # accepts SILENT_MONITOR, BARGE
+    #         client_token: "ClientToken",
+    #       }
+    #
+    # @!attribute [rw] instance_id
+    #   The identifier of the Amazon Connect instance. You can find the
+    #   instanceId in the ARN of the instance.
+    #   @return [String]
+    #
+    # @!attribute [rw] contact_id
+    #   The identifier of the contact.
+    #   @return [String]
+    #
+    # @!attribute [rw] user_id
+    #   The identifier of the user account.
+    #   @return [String]
+    #
+    # @!attribute [rw] allowed_monitor_capabilities
+    #   Specify which monitoring actions the user is allowed to take. For
+    #   example, whether the user is allowed to escalate from silent
+    #   monitoring to barge.
+    #   @return [Array<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]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MonitorContactRequest AWS API Documentation
+    #
+    class MonitorContactRequest < Struct.new(
+      :instance_id,
+      :contact_id,
+      :user_id,
+      :allowed_monitor_capabilities,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] contact_id
+    #   The identifier of the contact.
+    #   @return [String]
+    #
+    # @!attribute [rw] contact_arn
+    #   The ARN of the contact.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MonitorContactResponse AWS API Documentation
+    #
+    class MonitorContactResponse < Struct.new(
+      :contact_id,
+      :contact_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Information about a reference when the `referenceType` is `NUMBER`.
     # Otherwise, null.
     #
@@ -8434,6 +8512,13 @@ module Aws::Connect
 
     # The search criteria to be used to return queues.
     #
+    # <note markdown="1"> The `name` and `description` fields support "contains" queries with
+    # a minimum of 2 characters and a maximum of 25 characters. Any queries
+    # with character lengths outside of this range will throw invalid
+    # results.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass QueueSearchCriteria
     #   data as a hash:
     #
@@ -9268,6 +9353,13 @@ module Aws::Connect
 
     # The search criteria to be used to return routing profiles.
     #
+    # <note markdown="1"> The `name` and `description` fields support "contains" queries with
+    # a minimum of 2 characters and a maximum of 25 characters. Any queries
+    # with character lengths outside of this range will throw invalid
+    # results.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass RoutingProfileSearchCriteria
     #   data as a hash:
     #
@@ -9589,6 +9681,13 @@ module Aws::Connect
     #
     # @!attribute [rw] search_criteria
     #   The search criteria to be used to return queues.
+    #
+    #   <note markdown="1"> The `name` and `description` fields support "contains" queries
+    #   with a minimum of 2 characters and a maximum of 25 characters. Any
+    #   queries with character lengths outside of this range will throw
+    #   invalid results.
+    #
+    #    </note>
     #   @return [Types::QueueSearchCriteria]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchQueuesRequest AWS API Documentation
@@ -9695,6 +9794,13 @@ module Aws::Connect
     #
     # @!attribute [rw] search_criteria
     #   The search criteria to be used to return routing profiles.
+    #
+    #   <note markdown="1"> The `name` and `description` fields support "contains" queries
+    #   with a minimum of 2 characters and a maximum of 25 characters. Any
+    #   queries with character lengths outside of this range will throw
+    #   invalid results.
+    #
+    #    </note>
     #   @return [Types::RoutingProfileSearchCriteria]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchRoutingProfilesRequest AWS API Documentation
@@ -9799,6 +9905,12 @@ module Aws::Connect
     # @!attribute [rw] search_criteria
     #   The search criteria to be used to return security profiles.
     #
+    #   <note markdown="1"> The `name` field support "contains" queries with a minimum of 2
+    #   characters and maximum of 25 characters. Any queries with character
+    #   lengths outside of this range will throw invalid results.
+    #
+    #    </note>
+    #
     #   <note markdown="1"> The currently supported value for `FieldName`\: `name`
     #
     #    </note>
@@ -9918,10 +10030,10 @@ module Aws::Connect
     # @!attribute [rw] search_criteria
     #   The search criteria to be used to return users.
     #
-    #   <note markdown="1"> The `Username`, `Firstname`, and `Lastname` fields support
-    #   "contains" queries with a minimum of 2 characters and a maximum of
-    #   25 characters. Any queries with character lengths outside of this
-    #   range result in empty results.
+    #   <note markdown="1"> The `name` and `description` fields support "contains" queries
+    #   with a minimum of 2 characters and a maximum of 25 characters. Any
+    #   queries with character lengths outside of this range will throw
+    #   invalid results.
     #
     #    </note>
     #   @return [Types::UserSearchCriteria]
@@ -10105,6 +10217,12 @@ module Aws::Connect
 
     # The search criteria to be used to return security profiles.
     #
+    # <note markdown="1"> The `name` field support "contains" queries with a minimum of 2
+    # characters and maximum of 25 characters. Any queries with character
+    # lengths outside of this range will throw invalid results.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass SecurityProfileSearchCriteria
     #   data as a hash:
     #
@@ -13489,10 +13607,10 @@ module Aws::Connect
 
     # The search criteria to be used to return users.
     #
-    # <note markdown="1"> The `Username`, `Firstname`, and `Lastname` fields support
-    # "contains" queries with a minimum of 2 characters and a maximum of
-    # 25 characters. Any queries with character lengths outside of this
-    # range result in empty results.
+    # <note markdown="1"> The `name` and `description` fields support "contains" queries with
+    # a minimum of 2 characters and a maximum of 25 characters. Any queries
+    # with character lengths outside of this range will throw invalid
+    # results.
     #
     #  </note>
     #

data/lib/aws-sdk-connect.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connect
 version: !ruby/object:Gem::Version
-  version: 1.83.0
+  version: 1.84.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core