aws-sdk-connect 1.144.0 → 1.145.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -155,6 +155,43 @@ module Aws::Connect
155
155
  include Aws::Structure
156
156
  end
157
157
 
158
+ # A structure that defines agent hierarchy group levels which can be
159
+ # used to filter search results. Important: Agent hierarchy group level
160
+ # information in search result is a snapshot, it does not represent
161
+ # current agent hierarchy who handled the contact.
162
+ #
163
+ # @!attribute [rw] l1_ids
164
+ # The identifiers for level 1 hierarchy groups.
165
+ # @return [Array<String>]
166
+ #
167
+ # @!attribute [rw] l2_ids
168
+ # The identifiers for level 2 hierarchy groups.
169
+ # @return [Array<String>]
170
+ #
171
+ # @!attribute [rw] l3_ids
172
+ # The identifiers for level 3 hierarchy groups.
173
+ # @return [Array<String>]
174
+ #
175
+ # @!attribute [rw] l4_ids
176
+ # The identifiers for level 4 hierarchy groups.
177
+ # @return [Array<String>]
178
+ #
179
+ # @!attribute [rw] l5_ids
180
+ # The identifiers for level 5 hierarchy groups.
181
+ # @return [Array<String>]
182
+ #
183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentHierarchyGroups AWS API Documentation
184
+ #
185
+ class AgentHierarchyGroups < Struct.new(
186
+ :l1_ids,
187
+ :l2_ids,
188
+ :l3_ids,
189
+ :l4_ids,
190
+ :l5_ids)
191
+ SENSITIVE = []
192
+ include Aws::Structure
193
+ end
194
+
158
195
  # Information about the agent who accepted the contact.
159
196
  #
160
197
  # @!attribute [rw] id
@@ -832,6 +869,29 @@ module Aws::Connect
832
869
  #
833
870
  class AssociateTrafficDistributionGroupUserResponse < Aws::EmptyStructure; end
834
871
 
872
+ # @!attribute [rw] instance_id
873
+ # The identifier of the Amazon Connect instance. You can find the
874
+ # instance ID in the Amazon Resource Name (ARN of the instance).
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] user_id
878
+ # The identifier of the user account.
879
+ # @return [String]
880
+ #
881
+ # @!attribute [rw] user_proficiencies
882
+ # The proficiencies to associate with the user.
883
+ # @return [Array<Types::UserProficiency>]
884
+ #
885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateUserProficienciesRequest AWS API Documentation
886
+ #
887
+ class AssociateUserProficienciesRequest < Struct.new(
888
+ :instance_id,
889
+ :user_id,
890
+ :user_proficiencies)
891
+ SENSITIVE = []
892
+ include Aws::Structure
893
+ end
894
+
835
895
  # Information about a reference when the `referenceType` is
836
896
  # `ATTACHMENT`. Otherwise, null.
837
897
  #
@@ -1583,6 +1643,21 @@ module Aws::Connect
1583
1643
  # Information about Amazon Connect Wisdom.
1584
1644
  # @return [Types::WisdomInfo]
1585
1645
  #
1646
+ # @!attribute [rw] queue_time_adjustment_seconds
1647
+ # An integer that represents the queue time adjust to be applied to
1648
+ # the contact, in seconds (longer / larger queue time are routed
1649
+ # preferentially). Cannot be specified if the QueuePriority is
1650
+ # specified. Must be statically defined and a valid integer value.
1651
+ # @return [Integer]
1652
+ #
1653
+ # @!attribute [rw] queue_priority
1654
+ # An integer that represents the queue priority to be applied to the
1655
+ # contact (lower priorities are routed preferentially). Cannot be
1656
+ # specified if the QueueTimeAdjustmentSeconds is specified. Must be
1657
+ # statically defined, must be larger than zero, and a valid integer
1658
+ # value. Default Value is 5.
1659
+ # @return [Integer]
1660
+ #
1586
1661
  # @!attribute [rw] tags
1587
1662
  # Tags associated with the contact. This contains both Amazon Web
1588
1663
  # Services generated and user-defined tags.
@@ -1611,11 +1686,29 @@ module Aws::Connect
1611
1686
  :scheduled_timestamp,
1612
1687
  :related_contact_id,
1613
1688
  :wisdom_info,
1689
+ :queue_time_adjustment_seconds,
1690
+ :queue_priority,
1614
1691
  :tags)
1615
1692
  SENSITIVE = []
1616
1693
  include Aws::Structure
1617
1694
  end
1618
1695
 
1696
+ # A structure that defines filters can be used to search within outputs
1697
+ # analyzed by Amazon Connect Contact Lens in a contact.
1698
+ #
1699
+ # @!attribute [rw] transcript
1700
+ # A structure that defines filters can be used to search with text
1701
+ # within an Amazon Connect Contact Lens analyzed transcript.
1702
+ # @return [Types::Transcript]
1703
+ #
1704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactAnalysis AWS API Documentation
1705
+ #
1706
+ class ContactAnalysis < Struct.new(
1707
+ :transcript)
1708
+ SENSITIVE = []
1709
+ include Aws::Structure
1710
+ end
1711
+
1619
1712
  # Request object with information to create a contact.
1620
1713
  #
1621
1714
  # @!attribute [rw] system_endpoint
@@ -1897,6 +1990,120 @@ module Aws::Connect
1897
1990
  include Aws::Structure
1898
1991
  end
1899
1992
 
1993
+ # Information of returned contact.
1994
+ #
1995
+ # @!attribute [rw] arn
1996
+ # The Amazon Resource Name (ARN) of the contact
1997
+ # @return [String]
1998
+ #
1999
+ # @!attribute [rw] id
2000
+ # The identifier of the contact summary.
2001
+ # @return [String]
2002
+ #
2003
+ # @!attribute [rw] initial_contact_id
2004
+ # If this contact is related to other contacts, this is the ID of the
2005
+ # initial contact.
2006
+ # @return [String]
2007
+ #
2008
+ # @!attribute [rw] previous_contact_id
2009
+ # If this contact is not the first contact, this is the ID of the
2010
+ # previous contact.
2011
+ # @return [String]
2012
+ #
2013
+ # @!attribute [rw] initiation_method
2014
+ # Indicates how the contact was initiated.
2015
+ # @return [String]
2016
+ #
2017
+ # @!attribute [rw] channel
2018
+ # How the contact reached your contact center.
2019
+ # @return [String]
2020
+ #
2021
+ # @!attribute [rw] queue_info
2022
+ # If this contact was queued, this contains information about the
2023
+ # queue.
2024
+ # @return [Types::ContactSearchSummaryQueueInfo]
2025
+ #
2026
+ # @!attribute [rw] agent_info
2027
+ # Information about the agent who accepted the contact.
2028
+ # @return [Types::ContactSearchSummaryAgentInfo]
2029
+ #
2030
+ # @!attribute [rw] initiation_timestamp
2031
+ # The date and time this contact was initiated, in UTC time. For
2032
+ # INBOUND, this is when the contact arrived. For OUTBOUND, this is
2033
+ # when the agent began dialing. For CALLBACK, this is when the
2034
+ # callback contact was created. For TRANSFER and QUEUE\_TRANSFER, this
2035
+ # is when the transfer was initiated. For API, this is when the
2036
+ # request arrived. For EXTERNAL\_OUTBOUND, this is when the agent
2037
+ # started dialing the external participant. For MONITOR, this is when
2038
+ # the supervisor started listening to a contact.
2039
+ # @return [Time]
2040
+ #
2041
+ # @!attribute [rw] disconnect_timestamp
2042
+ # The timestamp when the customer endpoint disconnected from Amazon
2043
+ # Connect.
2044
+ # @return [Time]
2045
+ #
2046
+ # @!attribute [rw] scheduled_timestamp
2047
+ # The timestamp, in Unix epoch time format, at which to start running
2048
+ # the inbound flow.
2049
+ # @return [Time]
2050
+ #
2051
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummary AWS API Documentation
2052
+ #
2053
+ class ContactSearchSummary < Struct.new(
2054
+ :arn,
2055
+ :id,
2056
+ :initial_contact_id,
2057
+ :previous_contact_id,
2058
+ :initiation_method,
2059
+ :channel,
2060
+ :queue_info,
2061
+ :agent_info,
2062
+ :initiation_timestamp,
2063
+ :disconnect_timestamp,
2064
+ :scheduled_timestamp)
2065
+ SENSITIVE = []
2066
+ include Aws::Structure
2067
+ end
2068
+
2069
+ # Information about the agent who accepted the contact.
2070
+ #
2071
+ # @!attribute [rw] id
2072
+ # The identifier of the agent who accepted the contact.
2073
+ # @return [String]
2074
+ #
2075
+ # @!attribute [rw] connected_to_agent_timestamp
2076
+ # The timestamp when the contact was connected to the agent.
2077
+ # @return [Time]
2078
+ #
2079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummaryAgentInfo AWS API Documentation
2080
+ #
2081
+ class ContactSearchSummaryAgentInfo < Struct.new(
2082
+ :id,
2083
+ :connected_to_agent_timestamp)
2084
+ SENSITIVE = []
2085
+ include Aws::Structure
2086
+ end
2087
+
2088
+ # If this contact was queued, this contains information about the queue.
2089
+ #
2090
+ # @!attribute [rw] id
2091
+ # The unique identifier for the queue.
2092
+ # @return [String]
2093
+ #
2094
+ # @!attribute [rw] enqueue_timestamp
2095
+ # The timestamp when the contact was added to the queue.
2096
+ # @return [Time]
2097
+ #
2098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummaryQueueInfo AWS API Documentation
2099
+ #
2100
+ class ContactSearchSummaryQueueInfo < Struct.new(
2101
+ :id,
2102
+ :enqueue_timestamp)
2103
+ SENSITIVE = []
2104
+ include Aws::Structure
2105
+ end
2106
+
1900
2107
  # An object that can be used to specify Tag conditions inside the
1901
2108
  # `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
1902
2109
  # where:
@@ -2613,6 +2820,29 @@ module Aws::Connect
2613
2820
  include Aws::Structure
2614
2821
  end
2615
2822
 
2823
+ # @!attribute [rw] instance_id
2824
+ # The identifier of the Amazon Connect instance. You can find the
2825
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
2826
+ # @return [String]
2827
+ #
2828
+ # @!attribute [rw] name
2829
+ # The name of the predefined attribute.
2830
+ # @return [String]
2831
+ #
2832
+ # @!attribute [rw] values
2833
+ # The values of the predefined attribute.
2834
+ # @return [Types::PredefinedAttributeValues]
2835
+ #
2836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePredefinedAttributeRequest AWS API Documentation
2837
+ #
2838
+ class CreatePredefinedAttributeRequest < Struct.new(
2839
+ :instance_id,
2840
+ :name,
2841
+ :values)
2842
+ SENSITIVE = []
2843
+ include Aws::Structure
2844
+ end
2845
+
2616
2846
  # @!attribute [rw] instance_id
2617
2847
  # The identifier of the Amazon Connect instance. You can [find the
2618
2848
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -4010,6 +4240,24 @@ module Aws::Connect
4010
4240
  include Aws::Structure
4011
4241
  end
4012
4242
 
4243
+ # @!attribute [rw] instance_id
4244
+ # The identifier of the Amazon Connect instance. You can find the
4245
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
4246
+ # @return [String]
4247
+ #
4248
+ # @!attribute [rw] name
4249
+ # The name of the predefined attribute.
4250
+ # @return [String]
4251
+ #
4252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeletePredefinedAttributeRequest AWS API Documentation
4253
+ #
4254
+ class DeletePredefinedAttributeRequest < Struct.new(
4255
+ :instance_id,
4256
+ :name)
4257
+ SENSITIVE = []
4258
+ include Aws::Structure
4259
+ end
4260
+
4013
4261
  # @!attribute [rw] instance_id
4014
4262
  # The identifier of the Amazon Connect instance. You can [find the
4015
4263
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -4723,6 +4971,36 @@ module Aws::Connect
4723
4971
  include Aws::Structure
4724
4972
  end
4725
4973
 
4974
+ # @!attribute [rw] instance_id
4975
+ # The identifier of the Amazon Connect instance. You can find the
4976
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
4977
+ # @return [String]
4978
+ #
4979
+ # @!attribute [rw] name
4980
+ # The name of the predefined attribute.
4981
+ # @return [String]
4982
+ #
4983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePredefinedAttributeRequest AWS API Documentation
4984
+ #
4985
+ class DescribePredefinedAttributeRequest < Struct.new(
4986
+ :instance_id,
4987
+ :name)
4988
+ SENSITIVE = []
4989
+ include Aws::Structure
4990
+ end
4991
+
4992
+ # @!attribute [rw] predefined_attribute
4993
+ # Information about the predefined attribute.
4994
+ # @return [Types::PredefinedAttribute]
4995
+ #
4996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePredefinedAttributeResponse AWS API Documentation
4997
+ #
4998
+ class DescribePredefinedAttributeResponse < Struct.new(
4999
+ :predefined_attribute)
5000
+ SENSITIVE = []
5001
+ include Aws::Structure
5002
+ end
5003
+
4726
5004
  # @!attribute [rw] instance_id
4727
5005
  # The identifier of the Amazon Connect instance. You can [find the
4728
5006
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -5147,12 +5425,17 @@ module Aws::Connect
5147
5425
  # Information about the routing profile assigned to the user.
5148
5426
  # @return [Types::RoutingProfileReference]
5149
5427
  #
5428
+ # @!attribute [rw] routing_step_expression
5429
+ # The expression of a step in a routing criteria.
5430
+ # @return [String]
5431
+ #
5150
5432
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
5151
5433
  #
5152
5434
  class Dimensions < Struct.new(
5153
5435
  :queue,
5154
5436
  :channel,
5155
- :routing_profile)
5437
+ :routing_profile,
5438
+ :routing_step_expression)
5156
5439
  SENSITIVE = []
5157
5440
  include Aws::Structure
5158
5441
  end
@@ -5480,6 +5763,29 @@ module Aws::Connect
5480
5763
  #
5481
5764
  class DisassociateTrafficDistributionGroupUserResponse < Aws::EmptyStructure; end
5482
5765
 
5766
+ # @!attribute [rw] instance_id
5767
+ # The identifier of the Amazon Connect instance. You can find the
5768
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
5769
+ # @return [String]
5770
+ #
5771
+ # @!attribute [rw] user_id
5772
+ # The identifier of the user account.
5773
+ # @return [String]
5774
+ #
5775
+ # @!attribute [rw] user_proficiencies
5776
+ # The proficiencies to disassociate from the user.
5777
+ # @return [Array<Types::UserProficiencyDisassociate>]
5778
+ #
5779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateUserProficienciesRequest AWS API Documentation
5780
+ #
5781
+ class DisassociateUserProficienciesRequest < Struct.new(
5782
+ :instance_id,
5783
+ :user_id,
5784
+ :user_proficiencies)
5785
+ SENSITIVE = []
5786
+ include Aws::Structure
5787
+ end
5788
+
5483
5789
  # Contains details about why a contact was disconnected. Only Amazon
5484
5790
  # Connect outbound campaigns can provide this field.
5485
5791
  #
@@ -6658,12 +6964,18 @@ module Aws::Connect
6658
6964
  # A list of up to 100 routing profile IDs or ARNs.
6659
6965
  # @return [Array<String>]
6660
6966
  #
6967
+ # @!attribute [rw] routing_step_expressions
6968
+ # A list of expressions as a filter, in which an expression is an
6969
+ # object of a step in a routing criteria.
6970
+ # @return [Array<String>]
6971
+ #
6661
6972
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Filters AWS API Documentation
6662
6973
  #
6663
6974
  class Filters < Struct.new(
6664
6975
  :queues,
6665
6976
  :channels,
6666
- :routing_profiles)
6977
+ :routing_profiles,
6978
+ :routing_step_expressions)
6667
6979
  SENSITIVE = []
6668
6980
  include Aws::Structure
6669
6981
  end
@@ -10731,6 +11043,49 @@ module Aws::Connect
10731
11043
  include Aws::Structure
10732
11044
  end
10733
11045
 
11046
+ # @!attribute [rw] instance_id
11047
+ # The identifier of the Amazon Connect instance. You can find the
11048
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
11049
+ # @return [String]
11050
+ #
11051
+ # @!attribute [rw] next_token
11052
+ # The token for the next set of results. Use the value returned in the
11053
+ # previous response in the next request to retrieve the next set of
11054
+ # results.
11055
+ # @return [String]
11056
+ #
11057
+ # @!attribute [rw] max_results
11058
+ # The maximum number of results to return per page.
11059
+ # @return [Integer]
11060
+ #
11061
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPredefinedAttributesRequest AWS API Documentation
11062
+ #
11063
+ class ListPredefinedAttributesRequest < Struct.new(
11064
+ :instance_id,
11065
+ :next_token,
11066
+ :max_results)
11067
+ SENSITIVE = []
11068
+ include Aws::Structure
11069
+ end
11070
+
11071
+ # @!attribute [rw] next_token
11072
+ # If there are additional results, this is the token for the next set
11073
+ # of results.
11074
+ # @return [String]
11075
+ #
11076
+ # @!attribute [rw] predefined_attribute_summary_list
11077
+ # Summary of the predefined attributes.
11078
+ # @return [Array<Types::PredefinedAttributeSummary>]
11079
+ #
11080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPredefinedAttributesResponse AWS API Documentation
11081
+ #
11082
+ class ListPredefinedAttributesResponse < Struct.new(
11083
+ :next_token,
11084
+ :predefined_attribute_summary_list)
11085
+ SENSITIVE = []
11086
+ include Aws::Structure
11087
+ end
11088
+
10734
11089
  # @!attribute [rw] instance_id
10735
11090
  # The identifier of the Amazon Connect instance.
10736
11091
  # @return [String]
@@ -11715,12 +12070,12 @@ module Aws::Connect
11715
12070
  end
11716
12071
 
11717
12072
  # @!attribute [rw] instance_id
11718
- # The identifier of the Amazon Connect instance. You can [find the
11719
- # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
11720
- #
11721
- #
12073
+ # The identifier of the Amazon Connect instance. You can find the
12074
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
12075
+ # @return [String]
11722
12076
  #
11723
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
12077
+ # @!attribute [rw] user_id
12078
+ # The identifier of the user account.
11724
12079
  # @return [String]
11725
12080
  #
11726
12081
  # @!attribute [rw] next_token
@@ -11730,8 +12085,66 @@ module Aws::Connect
11730
12085
  # @return [String]
11731
12086
  #
11732
12087
  # @!attribute [rw] max_results
11733
- # The maximum number of results to return per page. The default
11734
- # MaxResult size is 100.
12088
+ # The maximum number of results to return per page.
12089
+ # @return [Integer]
12090
+ #
12091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserProficienciesRequest AWS API Documentation
12092
+ #
12093
+ class ListUserProficienciesRequest < Struct.new(
12094
+ :instance_id,
12095
+ :user_id,
12096
+ :next_token,
12097
+ :max_results)
12098
+ SENSITIVE = []
12099
+ include Aws::Structure
12100
+ end
12101
+
12102
+ # @!attribute [rw] next_token
12103
+ # If there are additional results, this is the token for the next set
12104
+ # of results.
12105
+ # @return [String]
12106
+ #
12107
+ # @!attribute [rw] user_proficiency_list
12108
+ # Information about the user proficiencies.
12109
+ # @return [Array<Types::UserProficiency>]
12110
+ #
12111
+ # @!attribute [rw] last_modified_time
12112
+ # The last time that the user's proficiencies are were modified.
12113
+ # @return [Time]
12114
+ #
12115
+ # @!attribute [rw] last_modified_region
12116
+ # The region in which a user's proficiencies were last modified.
12117
+ # @return [String]
12118
+ #
12119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserProficienciesResponse AWS API Documentation
12120
+ #
12121
+ class ListUserProficienciesResponse < Struct.new(
12122
+ :next_token,
12123
+ :user_proficiency_list,
12124
+ :last_modified_time,
12125
+ :last_modified_region)
12126
+ SENSITIVE = []
12127
+ include Aws::Structure
12128
+ end
12129
+
12130
+ # @!attribute [rw] instance_id
12131
+ # The identifier of the Amazon Connect instance. You can [find the
12132
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
12133
+ #
12134
+ #
12135
+ #
12136
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
12137
+ # @return [String]
12138
+ #
12139
+ # @!attribute [rw] next_token
12140
+ # The token for the next set of results. Use the value returned in the
12141
+ # previous response in the next request to retrieve the next set of
12142
+ # results.
12143
+ # @return [String]
12144
+ #
12145
+ # @!attribute [rw] max_results
12146
+ # The maximum number of results to return per page. The default
12147
+ # MaxResult size is 100.
11735
12148
  # @return [Integer]
11736
12149
  #
11737
12150
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersRequest AWS API Documentation
@@ -12681,6 +13094,114 @@ module Aws::Connect
12681
13094
  include Aws::Structure
12682
13095
  end
12683
13096
 
13097
+ # Information about a predefined attribute.
13098
+ #
13099
+ # @!attribute [rw] name
13100
+ # The name of the predefined attribute.
13101
+ # @return [String]
13102
+ #
13103
+ # @!attribute [rw] values
13104
+ # The values of the predefined attribute.
13105
+ # @return [Types::PredefinedAttributeValues]
13106
+ #
13107
+ # @!attribute [rw] last_modified_time
13108
+ # Last modified time.
13109
+ # @return [Time]
13110
+ #
13111
+ # @!attribute [rw] last_modified_region
13112
+ # Last modified region.
13113
+ # @return [String]
13114
+ #
13115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttribute AWS API Documentation
13116
+ #
13117
+ class PredefinedAttribute < Struct.new(
13118
+ :name,
13119
+ :values,
13120
+ :last_modified_time,
13121
+ :last_modified_region)
13122
+ SENSITIVE = []
13123
+ include Aws::Structure
13124
+ end
13125
+
13126
+ # The search criteria to be used to return predefined attributes.
13127
+ #
13128
+ # @!attribute [rw] or_conditions
13129
+ # A list of conditions which would be applied together with an `OR`
13130
+ # condition.
13131
+ # @return [Array<Types::PredefinedAttributeSearchCriteria>]
13132
+ #
13133
+ # @!attribute [rw] and_conditions
13134
+ # A list of conditions which would be applied together with an `AND`
13135
+ # condition.
13136
+ # @return [Array<Types::PredefinedAttributeSearchCriteria>]
13137
+ #
13138
+ # @!attribute [rw] string_condition
13139
+ # A leaf node condition which can be used to specify a string
13140
+ # condition.
13141
+ #
13142
+ # <note markdown="1"> The currently supported values for `FieldName` are `name` and
13143
+ # `description`.
13144
+ #
13145
+ # </note>
13146
+ # @return [Types::StringCondition]
13147
+ #
13148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeSearchCriteria AWS API Documentation
13149
+ #
13150
+ class PredefinedAttributeSearchCriteria < Struct.new(
13151
+ :or_conditions,
13152
+ :and_conditions,
13153
+ :string_condition)
13154
+ SENSITIVE = []
13155
+ include Aws::Structure
13156
+ end
13157
+
13158
+ # Summary of a predefined attribute.
13159
+ #
13160
+ # @!attribute [rw] name
13161
+ # The name of the predefined attribute.
13162
+ # @return [String]
13163
+ #
13164
+ # @!attribute [rw] last_modified_time
13165
+ # Last modified time.
13166
+ # @return [Time]
13167
+ #
13168
+ # @!attribute [rw] last_modified_region
13169
+ # Last modified region.
13170
+ # @return [String]
13171
+ #
13172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeSummary AWS API Documentation
13173
+ #
13174
+ class PredefinedAttributeSummary < Struct.new(
13175
+ :name,
13176
+ :last_modified_time,
13177
+ :last_modified_region)
13178
+ SENSITIVE = []
13179
+ include Aws::Structure
13180
+ end
13181
+
13182
+ # Information about values of a predefined attribute.
13183
+ #
13184
+ # @note PredefinedAttributeValues is a union - when making an API calls you must set exactly one of the members.
13185
+ #
13186
+ # @note PredefinedAttributeValues is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PredefinedAttributeValues corresponding to the set member.
13187
+ #
13188
+ # @!attribute [rw] string_list
13189
+ # Predefined attribute values of type string list.
13190
+ # @return [Array<String>]
13191
+ #
13192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeValues AWS API Documentation
13193
+ #
13194
+ class PredefinedAttributeValues < Struct.new(
13195
+ :string_list,
13196
+ :unknown)
13197
+ SENSITIVE = []
13198
+ include Aws::Structure
13199
+ include Aws::Structure::Union
13200
+
13201
+ class StringList < PredefinedAttributeValues; end
13202
+ class Unknown < PredefinedAttributeValues; end
13203
+ end
13204
+
12684
13205
  # Information about a problem detail.
12685
13206
  #
12686
13207
  # @!attribute [rw] message
@@ -14697,6 +15218,137 @@ module Aws::Connect
14697
15218
  include Aws::Structure
14698
15219
  end
14699
15220
 
15221
+ # @!attribute [rw] instance_id
15222
+ # The identifier of Amazon Connect instance. You can find the instance
15223
+ # ID in the Amazon Resource Name (ARN) of the instance
15224
+ # @return [String]
15225
+ #
15226
+ # @!attribute [rw] time_range
15227
+ # Time range that you want to search results
15228
+ # @return [Types::SearchContactsTimeRange]
15229
+ #
15230
+ # @!attribute [rw] search_criteria
15231
+ # The search criteria to be used to return contacts.
15232
+ # @return [Types::SearchCriteria]
15233
+ #
15234
+ # @!attribute [rw] max_results
15235
+ # The maximum number of results to return per page.
15236
+ # @return [Integer]
15237
+ #
15238
+ # @!attribute [rw] next_token
15239
+ # The token for the next set of results. Use the value returned in the
15240
+ # previous response in the next request to retrieve the next set of
15241
+ # results.
15242
+ # @return [String]
15243
+ #
15244
+ # @!attribute [rw] sort
15245
+ # Specifies a field to sort by and a sort order
15246
+ # @return [Types::Sort]
15247
+ #
15248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactsRequest AWS API Documentation
15249
+ #
15250
+ class SearchContactsRequest < Struct.new(
15251
+ :instance_id,
15252
+ :time_range,
15253
+ :search_criteria,
15254
+ :max_results,
15255
+ :next_token,
15256
+ :sort)
15257
+ SENSITIVE = []
15258
+ include Aws::Structure
15259
+ end
15260
+
15261
+ # @!attribute [rw] contacts
15262
+ # Information about the contacts.
15263
+ # @return [Array<Types::ContactSearchSummary>]
15264
+ #
15265
+ # @!attribute [rw] next_token
15266
+ # If there are additional results, this is the token for the next set
15267
+ # of results.
15268
+ # @return [String]
15269
+ #
15270
+ # @!attribute [rw] total_count
15271
+ # The total number of contacts which matched your search query.
15272
+ # @return [Integer]
15273
+ #
15274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactsResponse AWS API Documentation
15275
+ #
15276
+ class SearchContactsResponse < Struct.new(
15277
+ :contacts,
15278
+ :next_token,
15279
+ :total_count)
15280
+ SENSITIVE = []
15281
+ include Aws::Structure
15282
+ end
15283
+
15284
+ # A structure of time range that you want to search results
15285
+ #
15286
+ # @!attribute [rw] type
15287
+ # The type of timestamp to search
15288
+ # @return [String]
15289
+ #
15290
+ # @!attribute [rw] start_time
15291
+ # The start time of the time range.
15292
+ # @return [Time]
15293
+ #
15294
+ # @!attribute [rw] end_time
15295
+ # The end time of the time range.
15296
+ # @return [Time]
15297
+ #
15298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactsTimeRange AWS API Documentation
15299
+ #
15300
+ class SearchContactsTimeRange < Struct.new(
15301
+ :type,
15302
+ :start_time,
15303
+ :end_time)
15304
+ SENSITIVE = []
15305
+ include Aws::Structure
15306
+ end
15307
+
15308
+ # A structure of search criteria to be used to return contacts
15309
+ #
15310
+ # @!attribute [rw] agent_ids
15311
+ # The array of agent ids
15312
+ # @return [Array<String>]
15313
+ #
15314
+ # @!attribute [rw] agent_hierarchy_groups
15315
+ # The agent hierarchy groups
15316
+ # @return [Types::AgentHierarchyGroups]
15317
+ #
15318
+ # @!attribute [rw] channels
15319
+ # The array of channels
15320
+ # @return [Array<String>]
15321
+ #
15322
+ # @!attribute [rw] contact_analysis
15323
+ # The ContactAnalysis object used in search criteria
15324
+ # @return [Types::ContactAnalysis]
15325
+ #
15326
+ # @!attribute [rw] initiation_methods
15327
+ # The array of initiaton methods
15328
+ # @return [Array<String>]
15329
+ #
15330
+ # @!attribute [rw] queue_ids
15331
+ # The array of queue ids.
15332
+ # @return [Array<String>]
15333
+ #
15334
+ # @!attribute [rw] searchable_contact_attributes
15335
+ # The SearchableContactAttributes object used in search criteria
15336
+ # @return [Types::SearchableContactAttributes]
15337
+ #
15338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchCriteria AWS API Documentation
15339
+ #
15340
+ class SearchCriteria < Struct.new(
15341
+ :agent_ids,
15342
+ :agent_hierarchy_groups,
15343
+ :channels,
15344
+ :contact_analysis,
15345
+ :initiation_methods,
15346
+ :queue_ids,
15347
+ :searchable_contact_attributes)
15348
+ SENSITIVE = []
15349
+ include Aws::Structure
15350
+ end
15351
+
14700
15352
  # @!attribute [rw] instance_id
14701
15353
  # The identifier of the Amazon Connect instance. You can [find the
14702
15354
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -14760,6 +15412,61 @@ module Aws::Connect
14760
15412
  include Aws::Structure
14761
15413
  end
14762
15414
 
15415
+ # @!attribute [rw] instance_id
15416
+ # The identifier of the Amazon Connect instance. You can find the
15417
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
15418
+ # @return [String]
15419
+ #
15420
+ # @!attribute [rw] next_token
15421
+ # The token for the next set of results. Use the value returned in the
15422
+ # previous response in the next request to retrieve the next set of
15423
+ # results.
15424
+ # @return [String]
15425
+ #
15426
+ # @!attribute [rw] max_results
15427
+ # The maximum number of results to return per page.
15428
+ # @return [Integer]
15429
+ #
15430
+ # @!attribute [rw] search_criteria
15431
+ # The search criteria to be used to return predefined attributes.
15432
+ # @return [Types::PredefinedAttributeSearchCriteria]
15433
+ #
15434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchPredefinedAttributesRequest AWS API Documentation
15435
+ #
15436
+ class SearchPredefinedAttributesRequest < Struct.new(
15437
+ :instance_id,
15438
+ :next_token,
15439
+ :max_results,
15440
+ :search_criteria)
15441
+ SENSITIVE = []
15442
+ include Aws::Structure
15443
+ end
15444
+
15445
+ # @!attribute [rw] predefined_attributes
15446
+ # Predefined attributes matched by the search criteria.
15447
+ # @return [Array<Types::PredefinedAttribute>]
15448
+ #
15449
+ # @!attribute [rw] next_token
15450
+ # The token for the next set of results. Use the value returned in the
15451
+ # previous response in the next request to retrieve the next set of
15452
+ # results.
15453
+ # @return [String]
15454
+ #
15455
+ # @!attribute [rw] approximate_total_count
15456
+ # The approximate number of predefined attributes which matched your
15457
+ # search query.
15458
+ # @return [Integer]
15459
+ #
15460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchPredefinedAttributesResponse AWS API Documentation
15461
+ #
15462
+ class SearchPredefinedAttributesResponse < Struct.new(
15463
+ :predefined_attributes,
15464
+ :next_token,
15465
+ :approximate_total_count)
15466
+ SENSITIVE = []
15467
+ include Aws::Structure
15468
+ end
15469
+
14763
15470
  # @!attribute [rw] instance_id
14764
15471
  # The identifier of the Amazon Connect instance. You can [find the
14765
15472
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -15293,6 +16000,45 @@ module Aws::Connect
15293
16000
  include Aws::Structure
15294
16001
  end
15295
16002
 
16003
+ # A structure that defines searchable contact attributes which can be
16004
+ # used to filter search results.
16005
+ #
16006
+ # @!attribute [rw] criteria
16007
+ # The array of searhale contact attribute criteria
16008
+ # @return [Array<Types::SearchableContactAttributesCriteria>]
16009
+ #
16010
+ # @!attribute [rw] match_type
16011
+ # The match type of multiple searchable contact attributes criteria.
16012
+ # @return [String]
16013
+ #
16014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableContactAttributes AWS API Documentation
16015
+ #
16016
+ class SearchableContactAttributes < Struct.new(
16017
+ :criteria,
16018
+ :match_type)
16019
+ SENSITIVE = []
16020
+ include Aws::Structure
16021
+ end
16022
+
16023
+ # The criteria of searchable contact attributes.
16024
+ #
16025
+ # @!attribute [rw] key
16026
+ # The searchable contact attribute key
16027
+ # @return [String]
16028
+ #
16029
+ # @!attribute [rw] values
16030
+ # The array of contact attribute values used to filter search results.
16031
+ # @return [Array<String>]
16032
+ #
16033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableContactAttributesCriteria AWS API Documentation
16034
+ #
16035
+ class SearchableContactAttributesCriteria < Struct.new(
16036
+ :key,
16037
+ :values)
16038
+ SENSITIVE = [:key]
16039
+ include Aws::Structure
16040
+ end
16041
+
15296
16042
  # Configuration information of the security key.
15297
16043
  #
15298
16044
  # @!attribute [rw] association_id
@@ -15403,6 +16149,11 @@ module Aws::Connect
15403
16149
  # @!attribute [rw] string_condition
15404
16150
  # A leaf node condition which can be used to specify a string
15405
16151
  # condition.
16152
+ #
16153
+ # <note markdown="1"> The currently supported values for `FieldName` are `name` and
16154
+ # `description`.
16155
+ #
16156
+ # </note>
15406
16157
  # @return [Types::StringCondition]
15407
16158
  #
15408
16159
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfileSearchCriteria AWS API Documentation
@@ -15714,6 +16465,25 @@ module Aws::Connect
15714
16465
  include Aws::Structure
15715
16466
  end
15716
16467
 
16468
+ # A structure that defines the sort by and a sort order
16469
+ #
16470
+ # @!attribute [rw] field_name
16471
+ # The name of the field on which to sort.
16472
+ # @return [String]
16473
+ #
16474
+ # @!attribute [rw] order
16475
+ # An ascending or descending sort.
16476
+ # @return [String]
16477
+ #
16478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Sort AWS API Documentation
16479
+ #
16480
+ class Sort < Struct.new(
16481
+ :field_name,
16482
+ :order)
16483
+ SENSITIVE = []
16484
+ include Aws::Structure
16485
+ end
16486
+
15717
16487
  # @!attribute [rw] instance_id
15718
16488
  # The identifier of the Amazon Connect instance. You can [find the
15719
16489
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -16544,6 +17314,11 @@ module Aws::Connect
16544
17314
 
16545
17315
  # A leaf node condition which can be used to specify a string condition.
16546
17316
  #
17317
+ # <note markdown="1"> The currently supported values for `FieldName` are `name` and
17318
+ # `description`.
17319
+ #
17320
+ # </note>
17321
+ #
16547
17322
  # @!attribute [rw] field_name
16548
17323
  # The name of the field in the string condition.
16549
17324
  # @return [String]
@@ -17268,6 +18043,49 @@ module Aws::Connect
17268
18043
  include Aws::Structure
17269
18044
  end
17270
18045
 
18046
+ # The transcript object used to search results.
18047
+ #
18048
+ # @!attribute [rw] criteria
18049
+ # The array of transcript search criteria
18050
+ # @return [Array<Types::TranscriptCriteria>]
18051
+ #
18052
+ # @!attribute [rw] match_type
18053
+ # The match type of multiple transcript criteira
18054
+ # @return [String]
18055
+ #
18056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Transcript AWS API Documentation
18057
+ #
18058
+ class Transcript < Struct.new(
18059
+ :criteria,
18060
+ :match_type)
18061
+ SENSITIVE = []
18062
+ include Aws::Structure
18063
+ end
18064
+
18065
+ # The transcript criteria used to search
18066
+ #
18067
+ # @!attribute [rw] participant_role
18068
+ # The participant role in a transcript
18069
+ # @return [String]
18070
+ #
18071
+ # @!attribute [rw] search_text
18072
+ # The words or phrases used to search within a transcript.
18073
+ # @return [Array<String>]
18074
+ #
18075
+ # @!attribute [rw] match_type
18076
+ # The match type of search texts in a transcript criteria.
18077
+ # @return [String]
18078
+ #
18079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TranscriptCriteria AWS API Documentation
18080
+ #
18081
+ class TranscriptCriteria < Struct.new(
18082
+ :participant_role,
18083
+ :search_text,
18084
+ :match_type)
18085
+ SENSITIVE = []
18086
+ include Aws::Structure
18087
+ end
18088
+
17271
18089
  # @!attribute [rw] instance_id
17272
18090
  # The identifier of the Amazon Connect instance. You can [find the
17273
18091
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -17759,6 +18577,48 @@ module Aws::Connect
17759
18577
  #
17760
18578
  class UpdateContactResponse < Aws::EmptyStructure; end
17761
18579
 
18580
+ # @!attribute [rw] instance_id
18581
+ # The identifier of the Amazon Connect instance. You can [find the
18582
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
18583
+ #
18584
+ #
18585
+ #
18586
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
18587
+ # @return [String]
18588
+ #
18589
+ # @!attribute [rw] contact_id
18590
+ # The identifier of the contact in this instance of Amazon Connect.
18591
+ # @return [String]
18592
+ #
18593
+ # @!attribute [rw] queue_time_adjustment_seconds
18594
+ # The number of seconds to add or subtract from the contact's routing
18595
+ # age. Contacts are routed to agents on a first-come, first-serve
18596
+ # basis. This means that changing their amount of time in queue
18597
+ # compared to others also changes their position in queue.
18598
+ # @return [Integer]
18599
+ #
18600
+ # @!attribute [rw] queue_priority
18601
+ # Priority of the contact in the queue. The default priority for new
18602
+ # contacts is 5. You can raise the priority of a contact compared to
18603
+ # other contacts in the queue by assigning them a higher priority,
18604
+ # such as 1 or 2.
18605
+ # @return [Integer]
18606
+ #
18607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingDataRequest AWS API Documentation
18608
+ #
18609
+ class UpdateContactRoutingDataRequest < Struct.new(
18610
+ :instance_id,
18611
+ :contact_id,
18612
+ :queue_time_adjustment_seconds,
18613
+ :queue_priority)
18614
+ SENSITIVE = []
18615
+ include Aws::Structure
18616
+ end
18617
+
18618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingDataResponse AWS API Documentation
18619
+ #
18620
+ class UpdateContactRoutingDataResponse < Aws::EmptyStructure; end
18621
+
17762
18622
  # @!attribute [rw] instance_id
17763
18623
  # The identifier of the Amazon Connect instance. You can [find the
17764
18624
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -18138,6 +18998,29 @@ module Aws::Connect
18138
18998
  include Aws::Structure
18139
18999
  end
18140
19000
 
19001
+ # @!attribute [rw] instance_id
19002
+ # The identifier of the Amazon Connect instance. You can find the
19003
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
19004
+ # @return [String]
19005
+ #
19006
+ # @!attribute [rw] name
19007
+ # The name of the predefined attribute.
19008
+ # @return [String]
19009
+ #
19010
+ # @!attribute [rw] values
19011
+ # The values of the predefined attribute.
19012
+ # @return [Types::PredefinedAttributeValues]
19013
+ #
19014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePredefinedAttributeRequest AWS API Documentation
19015
+ #
19016
+ class UpdatePredefinedAttributeRequest < Struct.new(
19017
+ :instance_id,
19018
+ :name,
19019
+ :values)
19020
+ SENSITIVE = []
19021
+ include Aws::Structure
19022
+ end
19023
+
18141
19024
  # @!attribute [rw] instance_id
18142
19025
  # The identifier of the Amazon Connect instance. You can [find the
18143
19026
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -18953,6 +19836,31 @@ module Aws::Connect
18953
19836
  include Aws::Structure
18954
19837
  end
18955
19838
 
19839
+ # @!attribute [rw] instance_id
19840
+ # The identifier of the Amazon Connect instance. You can find the
19841
+ # instance ID in the Amazon Resource Name (ARN) of the instance.
19842
+ # @return [String]
19843
+ #
19844
+ # @!attribute [rw] user_id
19845
+ # The identifier of the user account.
19846
+ # @return [String]
19847
+ #
19848
+ # @!attribute [rw] user_proficiencies
19849
+ # The proficiencies to be updated for the user. Proficiencies must
19850
+ # first be associated to the user. You can do this using
19851
+ # AssociateUserProficiencies API.
19852
+ # @return [Array<Types::UserProficiency>]
19853
+ #
19854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserProficienciesRequest AWS API Documentation
19855
+ #
19856
+ class UpdateUserProficienciesRequest < Struct.new(
19857
+ :instance_id,
19858
+ :user_id,
19859
+ :user_proficiencies)
19860
+ SENSITIVE = []
19861
+ include Aws::Structure
19862
+ end
19863
+
18956
19864
  # @!attribute [rw] routing_profile_id
18957
19865
  # The identifier of the routing profile for the user.
18958
19866
  # @return [String]
@@ -19415,6 +20323,51 @@ module Aws::Connect
19415
20323
  include Aws::Structure
19416
20324
  end
19417
20325
 
20326
+ # Information about proficiency of a user.
20327
+ #
20328
+ # @!attribute [rw] attribute_name
20329
+ # The name of user's proficiency. You must use name of predefined
20330
+ # attribute present in the Amazon Connect instance.
20331
+ # @return [String]
20332
+ #
20333
+ # @!attribute [rw] attribute_value
20334
+ # The value of user's proficiency. You must use value of predefined
20335
+ # attribute present in the Amazon Connect instance.
20336
+ # @return [String]
20337
+ #
20338
+ # @!attribute [rw] level
20339
+ # The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
20340
+ # @return [Float]
20341
+ #
20342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserProficiency AWS API Documentation
20343
+ #
20344
+ class UserProficiency < Struct.new(
20345
+ :attribute_name,
20346
+ :attribute_value,
20347
+ :level)
20348
+ SENSITIVE = []
20349
+ include Aws::Structure
20350
+ end
20351
+
20352
+ # Information about proficiency to be disassociated from the user.
20353
+ #
20354
+ # @!attribute [rw] attribute_name
20355
+ # The name of user's proficiency.
20356
+ # @return [String]
20357
+ #
20358
+ # @!attribute [rw] attribute_value
20359
+ # The value of user's proficiency.
20360
+ # @return [String]
20361
+ #
20362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserProficiencyDisassociate AWS API Documentation
20363
+ #
20364
+ class UserProficiencyDisassociate < Struct.new(
20365
+ :attribute_name,
20366
+ :attribute_value)
20367
+ SENSITIVE = []
20368
+ include Aws::Structure
20369
+ end
20370
+
19418
20371
  # Contains information about the quick connect configuration settings
19419
20372
  # for a user. The contact flow must be of type Transfer to Agent.
19420
20373
  #