aws-sdk-connect 1.169.0 → 1.179.0

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

@@ -15,11 +15,11 @@ module Aws::Connect
         :endpoint_provider,
         doc_type: 'Aws::Connect::EndpointProvider',
         rbs_type: 'untyped',
-        docstring: 'The endpoint provider used to resolve endpoints. Any '\
-                   'object that responds to `#resolve_endpoint(parameters)` '\
-                   'where `parameters` is a Struct similar to '\
-                   '`Aws::Connect::EndpointParameters`'
-      ) do |cfg|
+        docstring: <<~DOCS) do |_cfg|
+The endpoint provider used to resolve endpoints. Any object that responds to
+`#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
+`Aws::Connect::EndpointParameters`.
+        DOCS
         Aws::Connect::EndpointProvider.new
       end
 
@@ -40,11 +40,23 @@ module Aws::Connect
           context[:auth_scheme] =
             Aws::Endpoints.resolve_auth_scheme(context, endpoint)
 
-          @handler.call(context)
+          with_metrics(context) { @handler.call(context) }
         end
 
         private
 
+        def with_metrics(context, &block)
+          metrics = []
+          metrics << 'ENDPOINT_OVERRIDE' unless context.config.regional_endpoint
+          if context[:auth_scheme] && context[:auth_scheme]['name'] == 'sigv4a'
+            metrics << 'SIGV4A_SIGNING'
+          end
+          if context.config.credentials&.credentials&.account_id
+            metrics << 'RESOLVED_ACCOUNT_ID'
+          end
+          Aws::Plugins::UserAgent.metric(*metrics, &block)
+        end
+
         def apply_endpoint_headers(context, headers)
           headers.each do |key, values|
             value = values
@@ -448,6 +460,8 @@ module Aws::Connect
             Aws::Connect::Endpoints::StartContactRecording.build(context)
           when :start_contact_streaming
             Aws::Connect::Endpoints::StartContactStreaming.build(context)
+          when :start_outbound_chat_contact
+            Aws::Connect::Endpoints::StartOutboundChatContact.build(context)
           when :start_outbound_voice_contact
             Aws::Connect::Endpoints::StartOutboundVoiceContact.build(context)
           when :start_task_contact

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

@@ -456,11 +456,11 @@ module Aws::Connect
     end
 
     # Can be used to define a list of preferred agents to target the contact
-    # within the queue. 
 Note that agents must have the queue in their
-    # routing profile in order to be offered the 
 contact.
+    # to within the queue.
 Note that agents must have the queue in their
+    # routing profile in order to be offered the
 contact.
     #
     # @!attribute [rw] agent_ids
-    #   An object to specify a list of agents, by Agent ID.
+    #   An object to specify a list of agents, by user ID.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentsCriteria AWS API Documentation
@@ -959,7 +959,7 @@ module Aws::Connect
     #   @return [String]
     #
     # @!attribute [rw] key
-    #   A valid security key in PEM format.
+    #   A valid security key in PEM format as a String.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKeyRequest AWS API Documentation
@@ -5967,10 +5967,25 @@ module Aws::Connect
     #   The name of the instance.
     #   @return [Types::Instance]
     #
+    # @!attribute [rw] replication_configuration
+    #   Status information about the replication process. This field is
+    #   included only when you are using the [ReplicateInstance][1] API to
+    #   replicate an Amazon Connect instance across Amazon Web Services
+    #   Regions. For information about replicating Amazon Connect instances,
+    #   see [Create a replica of your existing Amazon Connect instance][2]
+    #   in the *Amazon Connect Administrator Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html
+    #   [2]: https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html
+    #   @return [Types::ReplicationConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceResponse AWS API Documentation
     #
     class DescribeInstanceResponse < Struct.new(
-      :instance)
+      :instance,
+      :replication_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -9781,8 +9796,8 @@ module Aws::Connect
     #     Connect
     #
     #     Threshold: For `ThresholdValue`, enter any whole number from 1 to
-    #     604800 (inclusive), in seconds. For `Comparison`, you must enter
-    #     `LT` (for "Less than").
+    #     604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
+    #     (for "Less than") or `LTE` (for "Less than equal").
     #
     #     UI name: [Contacts removed from queue in X seconds][51]
     #
@@ -9794,8 +9809,8 @@ module Aws::Connect
     #     contact/segmentAttributes/connect:Subtype, Q in Connect
     #
     #     Threshold: For `ThresholdValue` enter any whole number from 1 to
-    #     604800 (inclusive), in seconds. For `Comparison`, you must enter
-    #     `LT` (for "Less than").
+    #     604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
+    #     (for "Less than") or `LTE` (for "Less than equal").
     #
     #     UI name: [Contacts resolved in X][52]
     #
@@ -10076,8 +10091,8 @@ module Aws::Connect
     #     Connect
     #
     #     Threshold: For `ThresholdValue`, enter any whole number from 1 to
-    #     604800 (inclusive), in seconds. For `Comparison`, you must enter
-    #     `LT` (for "Less than").
+    #     604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
+    #     (for "Less than") or `LTE` (for "Less than equal").
     #
     #     UI name: [Service level X][72]
     #
@@ -10117,7 +10132,7 @@ module Aws::Connect
     #
     #      </note>
     #
-    #   SUM\_CONTACTS\_ABANDONED
+    #   CONTACTS\_ABANDONED
     #
     #   : Unit: Count
     #
@@ -10142,8 +10157,8 @@ module Aws::Connect
     #     contact/segmentAttributes/connect:Subtype, Q in Connect
     #
     #     Threshold: For `ThresholdValue`, enter any whole number from 1 to
-    #     604800 (inclusive), in seconds. For `Comparison`, you must enter
-    #     `LT` (for "Less than").
+    #     604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
+    #     (for "Less than") or `LTE` (for "Less than equal").
     #
     #     UI name: [Contacts abandoned in X seconds][76]
     #
@@ -10155,8 +10170,8 @@ module Aws::Connect
     #     contact/segmentAttributes/connect:Subtype, Q in Connect
     #
     #     Threshold: For `ThresholdValue`, enter any whole number from 1 to
-    #     604800 (inclusive), in seconds. For `Comparison`, you must enter
-    #     `LT` (for "Less than").
+    #     604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
+    #     (for "Less than") or `LTE` (for "Less than equal").
     #
     #     UI name: [Contacts answered in X seconds][77]
     #
@@ -14313,10 +14328,10 @@ module Aws::Connect
       include Aws::Structure
     end
 
-    # An object to define `AgentsCriteria`.
+    # An object to define AgentsCriteria.
     #
     # @!attribute [rw] agents_criteria
-    #   An object to define `AgentIds`.
+    #   An object to define agentIds.
     #   @return [Types::AgentsCriteria]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MatchCriteria AWS API Documentation
@@ -14499,6 +14514,7 @@ module Aws::Connect
     #
     #   Valid metric filter values for `INITIATION_METHOD`: `INBOUND` \|
     #   `OUTBOUND` \| `TRANSFER` \| `QUEUE_TRANSFER` \| `CALLBACK` \| `API`
+    #   \| `WEBRTC_API` \| `MONITOR` \| `DISCONNECT` \| `EXTERNAL_OUTBOUND`
     #
     #   Valid metric filter values for `DISCONNECT_REASON`:
     #   `CUSTOMER_DISCONNECT` \| `AGENT_DISCONNECT` \|
@@ -14798,7 +14814,7 @@ module Aws::Connect
     #
     # * Duration labels, such as `NON_TALK_TIME`, `CONTACT_DURATION`,
     #   `AGENT_INTERACTION_DURATION`, `CUSTOMER_HOLD_TIME` have a minimum
-    #   value of 0 and maximum value of 28800.
+    #   value of 0 and maximum value of 63072000.
     #
     # * Percentages have a minimum value of 0 and maximum value of 100.
     #
@@ -16594,6 +16610,92 @@ module Aws::Connect
       include Aws::Structure
     end
 
+    # Details about the status of the replication of a source Amazon Connect
+    # instance across Amazon Web Services Regions. Use these details to
+    # understand the general status of a given replication. For information
+    # about why a replication process may fail, see [Why a ReplicateInstance
+    # call fails][1] in the *Create a replica of your existing Amazon
+    # Connect instance* topic in the *Amazon Connect Administrator Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html#why-replicateinstance-fails
+    #
+    # @!attribute [rw] replication_status_summary_list
+    #   A list of replication status summaries. The summaries contain
+    #   details about the replication of configuration information for
+    #   Amazon Connect resources, for each Amazon Web Services Region.
+    #   @return [Array<Types::ReplicationStatusSummary>]
+    #
+    # @!attribute [rw] source_region
+    #   The Amazon Web Services Region where the source Amazon Connect
+    #   instance was created. This is the Region where the
+    #   [ReplicateInstance][1] API was called to start the replication
+    #   process.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html
+    #   @return [String]
+    #
+    # @!attribute [rw] global_sign_in_endpoint
+    #   The URL that is used to sign-in to your Amazon Connect instance
+    #   according to your traffic distribution group configuration. For more
+    #   information about sign-in and traffic distribution groups, see
+    #   [Important things to know][1] in the *Create traffic distribution
+    #   groups* topic in the *Amazon Connect Administrator Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicationConfiguration AWS API Documentation
+    #
+    class ReplicationConfiguration < Struct.new(
+      :replication_status_summary_list,
+      :source_region,
+      :global_sign_in_endpoint)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Status information about the replication process, where you use the
+    # [ReplicateInstance][1] API to create a replica of your Amazon Connect
+    # instance in another Amazon Web Services Region. For more information,
+    # see [Set up Amazon Connect Global Resiliency][2] in the *Amazon
+    # Connect Administrator Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html
+    #
+    # @!attribute [rw] region
+    #   The Amazon Web Services Region. This can be either the source or the
+    #   replica Region, depending where it appears in the summary list.
+    #   @return [String]
+    #
+    # @!attribute [rw] replication_status
+    #   The state of the replication.
+    #   @return [String]
+    #
+    # @!attribute [rw] replication_status_reason
+    #   A description of the replication status. Use this information to
+    #   resolve any issues that are preventing the successful replication of
+    #   your Amazon Connect instance to another Region.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicationStatusSummary AWS API Documentation
+    #
+    class ReplicationStatusSummary < Struct.new(
+      :region,
+      :replication_status,
+      :replication_status_reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Information about a required field.
     #
     # @!attribute [rw] id
@@ -16777,6 +16879,61 @@ module Aws::Connect
       include Aws::Structure
     end
 
+    # An object to define the RoutingCriteria.
+    #
+    # @!attribute [rw] steps
+    #   When Amazon Connect does not find an available agent meeting the
+    #   requirements in a step for
 a given step duration, the routing
+    #   criteria will move on to the next step sequentially until a
 join is
+    #   completed with an agent. When all steps are exhausted, the contact
+    #   will be offered to any agent in the queue.
+    #   @return [Array<Types::RoutingCriteriaInputStep>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingCriteriaInput AWS API Documentation
+    #
+    class RoutingCriteriaInput < Struct.new(
+      :steps)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Step defines the list of agents to be routed or route based on the
+    # agent requirements such as ProficiencyLevel, Name, or Value.
+    #
+    # @!attribute [rw] expiry
+    #   An object to specify the expiration of a routing step.
+    #   @return [Types::RoutingCriteriaInputStepExpiry]
+    #
+    # @!attribute [rw] expression
+    #   A tagged union to specify expression for a routing step.
+    #   @return [Types::Expression]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingCriteriaInputStep AWS API Documentation
+    #
+    class RoutingCriteriaInputStep < Struct.new(
+      :expiry,
+      :expression)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specify whether this routing criteria step should apply for only a
+    # limited amount of time,
 or if it should never expire.
+    #
+    # @!attribute [rw] duration_in_seconds
+    #   The number of seconds that the contact will be routed only to agents
+    #   matching this routing
 step, if expiry was configured for this
+    #   routing step.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingCriteriaInputStepExpiry AWS API Documentation
+    #
+    class RoutingCriteriaInputStepExpiry < Struct.new(
+      :duration_in_seconds)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about a routing profile.
     #
     # @!attribute [rw] instance_id
@@ -19417,6 +19574,140 @@ module Aws::Connect
       include Aws::Structure
     end
 
+    # @!attribute [rw] source_endpoint
+    #   Information about the endpoint.
+    #   @return [Types::Endpoint]
+    #
+    # @!attribute [rw] destination_endpoint
+    #   Information about the endpoint.
+    #   @return [Types::Endpoint]
+    #
+    # @!attribute [rw] instance_id
+    #   The identifier of the Amazon Connect instance. You can find the
+    #   instance ID in the Amazon Resource Name (ARN) of the instance.
+    #   @return [String]
+    #
+    # @!attribute [rw] segment_attributes
+    #   A set of system defined key-value pairs stored on individual contact
+    #   segments using an attribute map. The attributes are standard Amazon
+    #   Connect attributes. They can be accessed in flows.
+    #
+    #   * Attribute keys can include only alphanumeric, `-`, and `_`.
+    #
+    #   * This field can be used to show channel subtype, such as
+    #     `connect:Guide` and `connect:SMS`.
+    #   @return [Hash<String,Types::SegmentAttributeValue>]
+    #
+    # @!attribute [rw] attributes
+    #   A custom key-value pair using an attribute map. The attributes are
+    #   standard Amazon Connect attributes, and can be accessed in flows
+    #   just like any other contact attributes.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] contact_flow_id
+    #   The identifier of the flow for the call. To see the ContactFlowId in
+    #   the Amazon Connect console user interface, on the navigation menu go
+    #   to **Routing, Contact Flows**. Choose the flow. On the flow page,
+    #   under the name of the flow, choose **Show additional flow
+    #   information**. The ContactFlowId is the last part of the ARN, shown
+    #   here in bold:
+    #
+    #   * arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**123ec456-a007-89c0-1234-xxxxxxxxxxxx**
+    #
+    #   ^
+    #   @return [String]
+    #
+    # @!attribute [rw] chat_duration_in_minutes
+    #   The total duration of the newly started chat session. If not
+    #   specified, the chat session duration defaults to 25 hour. The
+    #   minimum configurable time is 60 minutes. The maximum configurable
+    #   time is 10,080 minutes (7 days).
+    #   @return [Integer]
+    #
+    # @!attribute [rw] participant_details
+    #   The customer's details.
+    #   @return [Types::ParticipantDetails]
+    #
+    # @!attribute [rw] initial_system_message
+    #   A chat message.
+    #   @return [Types::ChatMessage]
+    #
+    # @!attribute [rw] related_contact_id
+    #   The unique identifier for an Amazon Connect contact. This identifier
+    #   is related to the contact starting.
+    #   @return [String]
+    #
+    # @!attribute [rw] supported_messaging_content_types
+    #   The supported chat message content types. Supported types are:
+    #
+    #   * `text/plain`
+    #
+    #   * `text/markdown`
+    #
+    #   * `application/json,
+    #     application/vnd.amazonaws.connect.message.interactive`
+    #
+    #   * `application/vnd.amazonaws.connect.message.interactive.response`
+    #
+    #   Content types must always contain `text/plain`. You can then put any
+    #   other supported type in the list. For example, all the following
+    #   lists are valid because they contain `text/plain`:
+    #
+    #   * `[text/plain, text/markdown, application/json]`
+    #
+    #   * `[text/markdown, text/plain]`
+    #
+    #   * `[text/plain, application/json,
+    #     application/vnd.amazonaws.connect.message.interactive.response]`
+    #   @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 AWS SDK populates
+    #   this field. For more information about idempotency, see [Making
+    #   retries safe with idempotent APIs][1]. The token is valid for 7 days
+    #   after creation. If a contact is already started, the contact ID is
+    #   returned.
+    #
+    #   **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/StartOutboundChatContactRequest AWS API Documentation
+    #
+    class StartOutboundChatContactRequest < Struct.new(
+      :source_endpoint,
+      :destination_endpoint,
+      :instance_id,
+      :segment_attributes,
+      :attributes,
+      :contact_flow_id,
+      :chat_duration_in_minutes,
+      :participant_details,
+      :initial_system_message,
+      :related_contact_id,
+      :supported_messaging_content_types,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] contact_id
+    #   The identifier of this contact within the Amazon Connect instance.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundChatContactResponse AWS API Documentation
+    #
+    class StartOutboundChatContactResponse < Struct.new(
+      :contact_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] name
     #   The name of a voice contact that is shown to an agent in the Contact
     #   Control Panel (CCP).
@@ -20453,8 +20744,8 @@ module Aws::Connect
     # Contains information about the threshold for service level metrics.
     #
     # @!attribute [rw] comparison
-    #   The type of comparison. Only "less than" (LT) and "greater than"
-    #   (GT) comparisons are supported.
+    #   The type of comparison. Currently, "less than" (LT), "less than
+    #   equal" (LTE), and "greater than" (GT) comparisons are supported.
     #   @return [String]
     #
     # @!attribute [rw] threshold_value
@@ -21337,13 +21628,19 @@ module Aws::Connect
     #   such as 1 or 2.
     #   @return [Integer]
     #
+    # @!attribute [rw] routing_criteria
+    #   Updates the routing criteria on the contact. These properties can be
+    #   used to change how a
 contact is routed within the queue.
+    #   @return [Types::RoutingCriteriaInput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingDataRequest AWS API Documentation
     #
     class UpdateContactRoutingDataRequest < Struct.new(
       :instance_id,
       :contact_id,
       :queue_time_adjustment_seconds,
-      :queue_priority)
+      :queue_priority,
+      :routing_criteria)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -23795,3 +24092,4 @@ module Aws::Connect
 
   end
 end
+

data/lib/aws-sdk-connect.rb

@@ -11,16 +11,7 @@
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
-require_relative 'aws-sdk-connect/types'
-require_relative 'aws-sdk-connect/client_api'
-require_relative 'aws-sdk-connect/plugins/endpoints.rb'
-require_relative 'aws-sdk-connect/client'
-require_relative 'aws-sdk-connect/errors'
-require_relative 'aws-sdk-connect/resource'
-require_relative 'aws-sdk-connect/endpoint_parameters'
-require_relative 'aws-sdk-connect/endpoint_provider'
-require_relative 'aws-sdk-connect/endpoints'
-require_relative 'aws-sdk-connect/customizations'
+Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
 
 # This module provides support for Amazon Connect Service. This module is available in the
 # `aws-sdk-connect` gem.
@@ -51,7 +42,20 @@ require_relative 'aws-sdk-connect/customizations'
 #
 # @!group service
 module Aws::Connect
+  autoload :Types, 'aws-sdk-connect/types'
+  autoload :ClientApi, 'aws-sdk-connect/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-connect/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-connect/client'
+  autoload :Errors, 'aws-sdk-connect/errors'
+  autoload :Resource, 'aws-sdk-connect/resource'
+  autoload :EndpointParameters, 'aws-sdk-connect/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-connect/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-connect/endpoints'
 
-  GEM_VERSION = '1.169.0'
+  GEM_VERSION = '1.179.0'
 
 end
+
+require_relative 'aws-sdk-connect/customizations'