aws-sdk-connect 1.170.0 → 1.171.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e7011582624331258aee22298a41058477a0b2d015584704ea47fbd4a3600c
-  data.tar.gz: ef3a645d770a3edd794c2f442ce00def32266a34a1520a1f447fba8fed7d812e
+  metadata.gz: '00865e37884cedbfcd78ca71b82b193e8c33bde6b0d9484e3995a3f352ebeacb'
+  data.tar.gz: 3f54e0b2f88b7e02f028554b8537e221d9215690894e6c7282c84ec7af1ba6b6
 SHA512:
-  metadata.gz: 28c9c2e7e6e19bb3994f4d00f86a2daff6ff79f3ca628fd9f26ace22eb2ef77b9f14ede5f49975f0d7c267d52a1b2a29df152b983325d0b3f46eeea46ed65340
-  data.tar.gz: 4ad83dca3da8ac700227c94a93a3ea61c9e38661caecf8d7c772664e1a91e99a6b9c1a19cc8072c97fcb475ea870b1cb86d9a6fb1ade2ea27cbdb9195890a1ab
+  metadata.gz: 1ec2d885bcbdd3d769a65276fa810236448a141e8656aef2fb8b4e57137bf978a09972817a8ac4bcf7444fe30e6ec5b79f7442806f97801243a39eb718c663f2
+  data.tar.gz: 69a77a8c6850e27b82a9f28682f9d850534c586e71a53d2b69a17cbee80bcf4639309b8e6c60f913eeb11ea21bd8377986e33b072b4b78112234dbac93c82aae

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.171.0 (2024-08-09)
+------------------
+
+* Feature - This release supports adding RoutingCriteria via UpdateContactRoutingData public API.
+
 1.170.0 (2024-08-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.170.0
+1.171.0

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

@@ -2007,6 +2007,9 @@ module Aws::Connect
     # Service (Amazon S3) or Amazon Kinesis. It also does not allow for any
     # configurations on features, such as Contact Lens for Amazon Connect.
     #
+    # For more information, see [Create an Amazon Connect instance][1] in
+    # the *Amazon Connect Administrator Guide*.
+    #
     # Amazon Connect enforces a limit on the total number of instances that
     # you can create or delete in 30 days. If you exceed this limit, you
     # will get an error message indicating there has been an excessive
@@ -2014,6 +2017,10 @@ module Aws::Connect
     # days before you can restart creating and deleting instances in your
     # account.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html
+    #
     # @option params [String] :client_token
     #   The idempotency token.
     #
@@ -2339,7 +2346,14 @@ module Aws::Connect
     end
 
     # Creates a new predefined attribute for the specified Amazon Connect
-    # instance.
+    # instance. *Predefined attributes* are attributes in an Amazon Connect
+    # instance that can be used to route contacts to an agent or pools of
+    # agents within a queue. For more information, see [Create predefined
+    # attributes for routing contacts to agents][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can find the
@@ -2854,6 +2868,16 @@ module Aws::Connect
 
     # Creates a security profile.
     #
+    # For information about security profiles, see [Security Profiles][1] in
+    # the *Amazon Connect Administrator Guide*. For a mapping of the API
+    # name and user interface name of the security profile permissions, see
+    # [List of security profile permissions][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
+    #
     # @option params [required, String] :security_profile_name
     #   The name of the security profile.
     #
@@ -3883,7 +3907,9 @@ module Aws::Connect
     # This API is in preview release for Amazon Connect and is subject to
     # change.
     #
-    # Deletes the Amazon Connect instance.
+    # Deletes the Amazon Connect instance. For more information, see [Delete
+    # your Amazon Connect instance][1] in the *Amazon Connect Administrator
+    # Guide*.
     #
     # Amazon Connect enforces a limit on the total number of instances that
     # you can create or delete in 30 days. If you exceed this limit, you
@@ -3892,6 +3918,10 @@ module Aws::Connect
     # days before you can restart creating and deleting instances in your
     # account.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.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.
@@ -4009,7 +4039,8 @@ module Aws::Connect
       req.send_request(options)
     end
 
-    # Deletes a queue.
+    # Deletes a queue. It isn't possible to delete a queue by using the
+    # Amazon Connect admin website.
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can [find the
@@ -5242,7 +5273,14 @@ module Aws::Connect
     end
 
     # Describes a predefined attribute for the specified Amazon Connect
-    # instance.
+    # instance. *Predefined attributes* are attributes in an Amazon Connect
+    # instance that can be used to route contacts to an agent or pools of
+    # agents within a queue. For more information, see [Create predefined
+    # attributes for routing contacts to agents][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can find the
@@ -5559,7 +5597,17 @@ module Aws::Connect
       req.send_request(options)
     end
 
-    # Gets basic information about the security profle.
+    # Gets basic information about the security profile.
+    #
+    # For information about security profiles, see [Security Profiles][1] in
+    # the *Amazon Connect Administrator Guide*. For a mapping of the API
+    # name and user interface name of the security profile permissions, see
+    # [List of security profile permissions][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
     #
     # @option params [required, String] :security_profile_id
     #   The identifier for the security profle.
@@ -10477,6 +10525,14 @@ module Aws::Connect
     end
 
     # Lists predefined attributes for the specified Amazon Connect instance.
+    # *Predefined attributes* are attributes in an Amazon Connect instance
+    # that can be used to route contacts to an agent or pools of agents
+    # within a queue. For more information, see [Create predefined
+    # attributes for routing contacts to agents][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can find the
@@ -11181,6 +11237,16 @@ module Aws::Connect
 
     # Lists the permissions granted to a security profile.
     #
+    # For information about security profiles, see [Security Profiles][1] in
+    # the *Amazon Connect Administrator Guide*. For a mapping of the API
+    # name and user interface name of the security profile permissions, see
+    # [List of security profile permissions][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
+    #
     # @option params [required, String] :security_profile_id
     #   The identifier for the security profle.
     #
@@ -11239,11 +11305,14 @@ module Aws::Connect
     # specified Amazon Connect instance.
     #
     # For more information about security profiles, see [Security
-    # Profiles][1] in the *Amazon Connect Administrator Guide*.
+    # Profiles][1] in the *Amazon Connect Administrator Guide*. For a
+    # mapping of the API name and user interface name of the security
+    # profile permissions, see [List of security profile permissions][2].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can [find the
@@ -12809,7 +12878,15 @@ module Aws::Connect
       req.send_request(options)
     end
 
-    # Predefined attributes that meet certain criteria.
+    # Searches predefined attributes that meet certain criteria. *Predefined
+    # attributes* are attributes in an Amazon Connect instance that can be
+    # used to route contacts to an agent or pools of agents within a queue.
+    # For more information, see [Create predefined attributes for routing
+    # contacts to agents][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can find the
@@ -13414,6 +13491,16 @@ module Aws::Connect
     # Searches security profiles in an Amazon Connect instance, with
     # optional filtering.
     #
+    # For information about security profiles, see [Security Profiles][1] in
+    # the *Amazon Connect Administrator Guide*. For a mapping of the API
+    # name and user interface name of the security profile permissions, see
+    # [List of security profile permissions][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.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.
@@ -16091,6 +16178,10 @@ module Aws::Connect
     #   other contacts in the queue by assigning them a higher priority, such
     #   as 1 or 2.
     #
+    # @option params [Types::RoutingCriteriaInput] :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 [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -16100,6 +16191,38 @@ module Aws::Connect
     #     contact_id: "ContactId", # required
     #     queue_time_adjustment_seconds: 1,
     #     queue_priority: 1,
+    #     routing_criteria: {
+    #       steps: [
+    #         {
+    #           expiry: {
+    #             duration_in_seconds: 1,
+    #           },
+    #           expression: {
+    #             attribute_condition: {
+    #               name: "PredefinedAttributeName",
+    #               value: "ProficiencyValue",
+    #               proficiency_level: 1.0,
+    #               match_criteria: {
+    #                 agents_criteria: {
+    #                   agent_ids: ["AgentId"],
+    #                 },
+    #               },
+    #               comparison_operator: "ComparisonOperator",
+    #             },
+    #             and_expression: [
+    #               {
+    #                 # recursive Expression
+    #               },
+    #             ],
+    #             or_expression: [
+    #               {
+    #                 # recursive Expression
+    #               },
+    #             ],
+    #           },
+    #         },
+    #       ],
+    #     },
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingData AWS API Documentation
@@ -16666,7 +16789,14 @@ module Aws::Connect
     end
 
     # Updates a predefined attribute for the specified Amazon Connect
-    # instance.
+    # instance. *Predefined attributes* are attributes in an Amazon Connect
+    # instance that can be used to route contacts to an agent or pools of
+    # agents within a queue. For more information, see [Create predefined
+    # attributes for routing contacts to agents][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
     #
     # @option params [required, String] :instance_id
     #   The identifier of the Amazon Connect instance. You can find the
@@ -17406,6 +17536,16 @@ module Aws::Connect
 
     # Updates a security profile.
     #
+    # For information about security profiles, see [Security Profiles][1] in
+    # the *Amazon Connect Administrator Guide*. For a mapping of the API
+    # name and user interface name of the security profile permissions, see
+    # [List of security profile permissions][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
+    #
     # @option params [String] :description
     #   The description of the security profile.
     #
@@ -18145,7 +18285,7 @@ module Aws::Connect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connect'
-      context[:gem_version] = '1.170.0'
+      context[:gem_version] = '1.171.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -974,6 +974,10 @@ module Aws::Connect
     ResumeContactRequest = Shapes::StructureShape.new(name: 'ResumeContactRequest')
     ResumeContactResponse = Shapes::StructureShape.new(name: 'ResumeContactResponse')
     RoutingCriteria = Shapes::StructureShape.new(name: 'RoutingCriteria')
+    RoutingCriteriaInput = Shapes::StructureShape.new(name: 'RoutingCriteriaInput')
+    RoutingCriteriaInputStep = Shapes::StructureShape.new(name: 'RoutingCriteriaInputStep')
+    RoutingCriteriaInputStepExpiry = Shapes::StructureShape.new(name: 'RoutingCriteriaInputStepExpiry')
+    RoutingCriteriaInputSteps = Shapes::ListShape.new(name: 'RoutingCriteriaInputSteps')
     RoutingCriteriaStepStatus = Shapes::StringShape.new(name: 'RoutingCriteriaStepStatus')
     RoutingExpression = Shapes::StringShape.new(name: 'RoutingExpression')
     RoutingExpressions = Shapes::ListShape.new(name: 'RoutingExpressions')
@@ -4439,6 +4443,18 @@ module Aws::Connect
     RoutingCriteria.add_member(:index, Shapes::ShapeRef.new(shape: Index, location_name: "Index"))
     RoutingCriteria.struct_class = Types::RoutingCriteria
 
+    RoutingCriteriaInput.add_member(:steps, Shapes::ShapeRef.new(shape: RoutingCriteriaInputSteps, location_name: "Steps"))
+    RoutingCriteriaInput.struct_class = Types::RoutingCriteriaInput
+
+    RoutingCriteriaInputStep.add_member(:expiry, Shapes::ShapeRef.new(shape: RoutingCriteriaInputStepExpiry, location_name: "Expiry"))
+    RoutingCriteriaInputStep.add_member(:expression, Shapes::ShapeRef.new(shape: Expression, location_name: "Expression"))
+    RoutingCriteriaInputStep.struct_class = Types::RoutingCriteriaInputStep
+
+    RoutingCriteriaInputStepExpiry.add_member(:duration_in_seconds, Shapes::ShapeRef.new(shape: DurationInSeconds, location_name: "DurationInSeconds"))
+    RoutingCriteriaInputStepExpiry.struct_class = Types::RoutingCriteriaInputStepExpiry
+
+    RoutingCriteriaInputSteps.member = Shapes::ShapeRef.new(shape: RoutingCriteriaInputStep)
+
     RoutingExpressions.member = Shapes::ShapeRef.new(shape: RoutingExpression)
 
     RoutingProfile.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, location_name: "InstanceId"))
@@ -5306,6 +5322,7 @@ module Aws::Connect
     UpdateContactRoutingDataRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location: "uri", location_name: "ContactId"))
     UpdateContactRoutingDataRequest.add_member(:queue_time_adjustment_seconds, Shapes::ShapeRef.new(shape: QueueTimeAdjustmentSeconds, location_name: "QueueTimeAdjustmentSeconds"))
     UpdateContactRoutingDataRequest.add_member(:queue_priority, Shapes::ShapeRef.new(shape: QueuePriority, location_name: "QueuePriority"))
+    UpdateContactRoutingDataRequest.add_member(:routing_criteria, Shapes::ShapeRef.new(shape: RoutingCriteriaInput, location_name: "RoutingCriteria"))
     UpdateContactRoutingDataRequest.struct_class = Types::UpdateContactRoutingDataRequest
 
     UpdateContactRoutingDataResponse.struct_class = Types::UpdateContactRoutingDataResponse

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
@@ -14313,10 +14313,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
@@ -16777,6 +16777,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
@@ -21337,13 +21392,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

data/lib/aws-sdk-connect.rb

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

data/sig/client.rbs

@@ -3800,7 +3800,35 @@ module Aws
                                          instance_id: ::String,
                                          contact_id: ::String,
                                          ?queue_time_adjustment_seconds: ::Integer,
-                                         ?queue_priority: ::Integer
+                                         ?queue_priority: ::Integer,
+                                         ?routing_criteria: {
+                                           steps: Array[
+                                             {
+                                               expiry: {
+                                                 duration_in_seconds: ::Integer?
+                                               }?,
+                                               expression: {
+                                                 attribute_condition: {
+                                                   name: ::String?,
+                                                   value: ::String?,
+                                                   proficiency_level: ::Float?,
+                                                   match_criteria: {
+                                                     agents_criteria: {
+                                                       agent_ids: Array[::String]?
+                                                     }?
+                                                   }?,
+                                                   comparison_operator: ::String?
+                                                 }?,
+                                                 and_expression: Array[
+                                                   untyped,
+                                                 ]?,
+                                                 or_expression: Array[
+                                                   untyped,
+                                                 ]?
+                                               }?
+                                             },
+                                           ]?
+                                         }
                                        ) -> _UpdateContactRoutingDataResponseSuccess
                                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateContactRoutingDataResponseSuccess
 

data/sig/types.rbs

@@ -3942,6 +3942,22 @@ module Aws::Connect
       SENSITIVE: []
     end
 
+    class RoutingCriteriaInput
+      attr_accessor steps: ::Array[Types::RoutingCriteriaInputStep]
+      SENSITIVE: []
+    end
+
+    class RoutingCriteriaInputStep
+      attr_accessor expiry: Types::RoutingCriteriaInputStepExpiry
+      attr_accessor expression: Types::Expression
+      SENSITIVE: []
+    end
+
+    class RoutingCriteriaInputStepExpiry
+      attr_accessor duration_in_seconds: ::Integer
+      SENSITIVE: []
+    end
+
     class RoutingProfile
       attr_accessor instance_id: ::String
       attr_accessor name: ::String
@@ -5004,6 +5020,7 @@ module Aws::Connect
       attr_accessor contact_id: ::String
       attr_accessor queue_time_adjustment_seconds: ::Integer
       attr_accessor queue_priority: ::Integer
+      attr_accessor routing_criteria: Types::RoutingCriteriaInput
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connect
 version: !ruby/object:Gem::Version
-  version: 1.170.0
+  version: 1.171.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-08 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core