aws-sdk-connect 1.159.0 → 1.161.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.
@@ -161,6 +161,20 @@ module Aws::Connect
161
161
  include Aws::Structure
162
162
  end
163
163
 
164
+ # Information about an agent hierarchy group.
165
+ #
166
+ # @!attribute [rw] arn
167
+ # The Amazon Resource Name (ARN) of the group.
168
+ # @return [String]
169
+ #
170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentHierarchyGroup AWS API Documentation
171
+ #
172
+ class AgentHierarchyGroup < Struct.new(
173
+ :arn)
174
+ SENSITIVE = []
175
+ include Aws::Structure
176
+ end
177
+
164
178
  # A structure that defines search criteria for contacts using agent
165
179
  # hierarchy group levels. For more information about agent hierarchies,
166
180
  # see [Set Up Agent Hierarchies][1] in the *Amazon Connect Administrator
@@ -216,12 +230,42 @@ module Aws::Connect
216
230
  # Agent pause duration for a contact in seconds.
217
231
  # @return [Integer]
218
232
  #
233
+ # @!attribute [rw] hierarchy_groups
234
+ # The agent hierarchy groups for the agent.
235
+ # @return [Types::HierarchyGroups]
236
+ #
237
+ # @!attribute [rw] device_info
238
+ # Information regarding Agent’s device.
239
+ # @return [Types::DeviceInfo]
240
+ #
241
+ # @!attribute [rw] capabilities
242
+ # The configuration for the allowed capabilities for participants
243
+ # present over the call.
244
+ # @return [Types::ParticipantCapabilities]
245
+ #
219
246
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentInfo AWS API Documentation
220
247
  #
221
248
  class AgentInfo < Struct.new(
222
249
  :id,
223
250
  :connected_to_agent_timestamp,
224
- :agent_pause_duration_in_seconds)
251
+ :agent_pause_duration_in_seconds,
252
+ :hierarchy_groups,
253
+ :device_info,
254
+ :capabilities)
255
+ SENSITIVE = []
256
+ include Aws::Structure
257
+ end
258
+
259
+ # Information about the quality of the Agent's media connection
260
+ #
261
+ # @!attribute [rw] audio
262
+ # Information about the audio quality of the Agent
263
+ # @return [Types::AudioQualityMetricsInfo]
264
+ #
265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentQualityMetrics AWS API Documentation
266
+ #
267
+ class AgentQualityMetrics < Struct.new(
268
+ :audio)
225
269
  SENSITIVE = []
226
270
  include Aws::Structure
227
271
  end
@@ -1104,6 +1148,35 @@ module Aws::Connect
1104
1148
  include Aws::Structure
1105
1149
  end
1106
1150
 
1151
+ # An object to specify the predefined attribute condition.
1152
+ #
1153
+ # @!attribute [rw] name
1154
+ # The name of predefined attribute.
1155
+ # @return [String]
1156
+ #
1157
+ # @!attribute [rw] value
1158
+ # The value of predefined attribute.
1159
+ # @return [String]
1160
+ #
1161
+ # @!attribute [rw] proficiency_level
1162
+ # The proficiency level of the condition.
1163
+ # @return [Float]
1164
+ #
1165
+ # @!attribute [rw] comparison_operator
1166
+ # The operator of the condition.
1167
+ # @return [String]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttributeCondition AWS API Documentation
1170
+ #
1171
+ class AttributeCondition < Struct.new(
1172
+ :name,
1173
+ :value,
1174
+ :proficiency_level,
1175
+ :comparison_operator)
1176
+ SENSITIVE = []
1177
+ include Aws::Structure
1178
+ end
1179
+
1107
1180
  # Has audio-specific configurations as the operating parameter for Echo
1108
1181
  # Reduction.
1109
1182
  #
@@ -1120,6 +1193,30 @@ module Aws::Connect
1120
1193
  include Aws::Structure
1121
1194
  end
1122
1195
 
1196
+ # Contains information for score and potential quality issues for Audio
1197
+ #
1198
+ # @!attribute [rw] quality_score
1199
+ # Number measuring the estimated quality of the media connection.
1200
+ # @return [Float]
1201
+ #
1202
+ # @!attribute [rw] potential_quality_issues
1203
+ # List of potential issues causing degradation of quality on a media
1204
+ # connection. If the service did not detect any potential quality
1205
+ # issues the list is empty.
1206
+ #
1207
+ # Valid values: `HighPacketLoss` \| `HighRoundTripTime` \|
1208
+ # `HighJitterBuffer`
1209
+ # @return [Array<String>]
1210
+ #
1211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AudioQualityMetricsInfo AWS API Documentation
1212
+ #
1213
+ class AudioQualityMetricsInfo < Struct.new(
1214
+ :quality_score,
1215
+ :potential_quality_issues)
1216
+ SENSITIVE = []
1217
+ include Aws::Structure
1218
+ end
1219
+
1123
1220
  # Information about available phone numbers.
1124
1221
  #
1125
1222
  # @!attribute [rw] phone_number
@@ -1899,6 +1996,53 @@ module Aws::Connect
1899
1996
  # Services generated and user-defined tags.
1900
1997
  # @return [Hash<String,String>]
1901
1998
  #
1999
+ # @!attribute [rw] connected_to_system_timestamp
2000
+ # The timestamp when customer endpoint connected to Amazon Connect.
2001
+ # @return [Time]
2002
+ #
2003
+ # @!attribute [rw] routing_criteria
2004
+ # Latest routing criteria on the contact.
2005
+ # @return [Types::RoutingCriteria]
2006
+ #
2007
+ # @!attribute [rw] customer
2008
+ # Information about the Customer on the contact.
2009
+ # @return [Types::Customer]
2010
+ #
2011
+ # @!attribute [rw] campaign
2012
+ # Information associated with a campaign.
2013
+ # @return [Types::Campaign]
2014
+ #
2015
+ # @!attribute [rw] answering_machine_detection_status
2016
+ # Indicates how an [outbound campaign][1] call is actually disposed if
2017
+ # the contact is connected to Amazon Connect.
2018
+ #
2019
+ #
2020
+ #
2021
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html
2022
+ # @return [String]
2023
+ #
2024
+ # @!attribute [rw] customer_voice_activity
2025
+ # Information about customer’s voice activity.
2026
+ # @return [Types::CustomerVoiceActivity]
2027
+ #
2028
+ # @!attribute [rw] quality_metrics
2029
+ # Information about the quality of the participant's media
2030
+ # connection.
2031
+ # @return [Types::QualityMetrics]
2032
+ #
2033
+ # @!attribute [rw] disconnect_details
2034
+ # Information about the call disconnect experience.
2035
+ # @return [Types::DisconnectDetails]
2036
+ #
2037
+ # @!attribute [rw] segment_attributes
2038
+ # A set of system defined key-value pairs stored on individual contact
2039
+ # segments using an attribute map. The attributes are standard Amazon
2040
+ # Connect attributes and can be accessed in flows. Attribute keys can
2041
+ # include only alphanumeric, -, and \_ characters. This field can be
2042
+ # used to show channel subtype. For example, `connect:Guide` or
2043
+ # `connect:SMS`.
2044
+ # @return [Hash<String,Types::SegmentAttributeValue>]
2045
+ #
1902
2046
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Contact AWS API Documentation
1903
2047
  #
1904
2048
  class Contact < Struct.new(
@@ -1924,7 +2068,16 @@ module Aws::Connect
1924
2068
  :wisdom_info,
1925
2069
  :queue_time_adjustment_seconds,
1926
2070
  :queue_priority,
1927
- :tags)
2071
+ :tags,
2072
+ :connected_to_system_timestamp,
2073
+ :routing_criteria,
2074
+ :customer,
2075
+ :campaign,
2076
+ :answering_machine_detection_status,
2077
+ :customer_voice_activity,
2078
+ :quality_metrics,
2079
+ :disconnect_details,
2080
+ :segment_attributes)
1928
2081
  SENSITIVE = [:name, :description]
1929
2082
  include Aws::Structure
1930
2083
  end
@@ -4446,6 +4599,61 @@ module Aws::Connect
4446
4599
  include Aws::Structure
4447
4600
  end
4448
4601
 
4602
+ # Information about the Customer on the contact.
4603
+ #
4604
+ # @!attribute [rw] device_info
4605
+ # Information regarding Customer’s device.
4606
+ # @return [Types::DeviceInfo]
4607
+ #
4608
+ # @!attribute [rw] capabilities
4609
+ # The configuration for the allowed capabilities for participants
4610
+ # present over the call.
4611
+ # @return [Types::ParticipantCapabilities]
4612
+ #
4613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Customer AWS API Documentation
4614
+ #
4615
+ class Customer < Struct.new(
4616
+ :device_info,
4617
+ :capabilities)
4618
+ SENSITIVE = []
4619
+ include Aws::Structure
4620
+ end
4621
+
4622
+ # Information about the quality of the Customer's media connection
4623
+ #
4624
+ # @!attribute [rw] audio
4625
+ # Information about the audio quality of the Customer
4626
+ # @return [Types::AudioQualityMetricsInfo]
4627
+ #
4628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CustomerQualityMetrics AWS API Documentation
4629
+ #
4630
+ class CustomerQualityMetrics < Struct.new(
4631
+ :audio)
4632
+ SENSITIVE = []
4633
+ include Aws::Structure
4634
+ end
4635
+
4636
+ # Information about customer’s voice activity.
4637
+ #
4638
+ # @!attribute [rw] greeting_start_timestamp
4639
+ # Timestamp that measures the beginning of the customer greeting from
4640
+ # an outbound voice call.
4641
+ # @return [Time]
4642
+ #
4643
+ # @!attribute [rw] greeting_end_timestamp
4644
+ # Timestamp that measures the end of the customer greeting from an
4645
+ # outbound voice call.
4646
+ # @return [Time]
4647
+ #
4648
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CustomerVoiceActivity AWS API Documentation
4649
+ #
4650
+ class CustomerVoiceActivity < Struct.new(
4651
+ :greeting_start_timestamp,
4652
+ :greeting_end_timestamp)
4653
+ SENSITIVE = []
4654
+ include Aws::Structure
4655
+ end
4656
+
4449
4657
  # Information about a reference when the `referenceType` is `DATE`.
4450
4658
  # Otherwise, null.
4451
4659
  #
@@ -5928,6 +6136,30 @@ module Aws::Connect
5928
6136
  include Aws::Structure
5929
6137
  end
5930
6138
 
6139
+ # Information regarding the device.
6140
+ #
6141
+ # @!attribute [rw] platform_name
6142
+ # Name of the platform that the participant used for the call.
6143
+ # @return [String]
6144
+ #
6145
+ # @!attribute [rw] platform_version
6146
+ # Version of the platform that the participant used for the call.
6147
+ # @return [String]
6148
+ #
6149
+ # @!attribute [rw] operating_system
6150
+ # Operating system that the participant used for the call.
6151
+ # @return [String]
6152
+ #
6153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeviceInfo AWS API Documentation
6154
+ #
6155
+ class DeviceInfo < Struct.new(
6156
+ :platform_name,
6157
+ :platform_version,
6158
+ :operating_system)
6159
+ SENSITIVE = []
6160
+ include Aws::Structure
6161
+ end
6162
+
5931
6163
  # Contains information about the dimensions for a set of metrics.
5932
6164
  #
5933
6165
  # @!attribute [rw] queue
@@ -6303,6 +6535,21 @@ module Aws::Connect
6303
6535
  include Aws::Structure
6304
6536
  end
6305
6537
 
6538
+ # Information about the call disconnect experience.
6539
+ #
6540
+ # @!attribute [rw] potential_disconnect_issue
6541
+ # Indicates the potential disconnection issues for a call. This field
6542
+ # is not populated if the service does not detect potential issues.
6543
+ # @return [String]
6544
+ #
6545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisconnectDetails AWS API Documentation
6546
+ #
6547
+ class DisconnectDetails < Struct.new(
6548
+ :potential_disconnect_issue)
6549
+ SENSITIVE = []
6550
+ include Aws::Structure
6551
+ end
6552
+
6306
6553
  # Contains details about why a contact was disconnected. Only Amazon
6307
6554
  # Connect outbound campaigns can provide this field.
6308
6555
  #
@@ -7390,6 +7637,49 @@ module Aws::Connect
7390
7637
  include Aws::Structure
7391
7638
  end
7392
7639
 
7640
+ # An object to specify the expiration of a routing step.
7641
+ #
7642
+ # @!attribute [rw] duration_in_seconds
7643
+ # The number of seconds to wait before expiring the routing step.
7644
+ # @return [Integer]
7645
+ #
7646
+ # @!attribute [rw] expiry_timestamp
7647
+ # The timestamp indicating when the routing step expires.
7648
+ # @return [Time]
7649
+ #
7650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Expiry AWS API Documentation
7651
+ #
7652
+ class Expiry < Struct.new(
7653
+ :duration_in_seconds,
7654
+ :expiry_timestamp)
7655
+ SENSITIVE = []
7656
+ include Aws::Structure
7657
+ end
7658
+
7659
+ # A tagged union to specify expression for a routing step.
7660
+ #
7661
+ # @!attribute [rw] attribute_condition
7662
+ # An object to specify the predefined attribute condition.
7663
+ # @return [Types::AttributeCondition]
7664
+ #
7665
+ # @!attribute [rw] and_expression
7666
+ # List of routing expressions which will be AND-ed together.
7667
+ # @return [Array<Types::Expression>]
7668
+ #
7669
+ # @!attribute [rw] or_expression
7670
+ # List of routing expressions which will be OR-ed together.
7671
+ # @return [Array<Types::Expression>]
7672
+ #
7673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Expression AWS API Documentation
7674
+ #
7675
+ class Expression < Struct.new(
7676
+ :attribute_condition,
7677
+ :and_expression,
7678
+ :or_expression)
7679
+ SENSITIVE = []
7680
+ include Aws::Structure
7681
+ end
7682
+
7393
7683
  # Request for which contact failed to be generated.
7394
7684
  #
7395
7685
  # @!attribute [rw] request_identifier
@@ -9975,6 +10265,41 @@ module Aws::Connect
9975
10265
  include Aws::Structure
9976
10266
  end
9977
10267
 
10268
+ # Information about the agent hierarchy. Hierarchies can be configured
10269
+ # with up to five levels.
10270
+ #
10271
+ # @!attribute [rw] level_1
10272
+ # The group at level one of the agent hierarchy.
10273
+ # @return [Types::AgentHierarchyGroup]
10274
+ #
10275
+ # @!attribute [rw] level_2
10276
+ # The group at level two of the agent hierarchy.
10277
+ # @return [Types::AgentHierarchyGroup]
10278
+ #
10279
+ # @!attribute [rw] level_3
10280
+ # The group at level three of the agent hierarchy.
10281
+ # @return [Types::AgentHierarchyGroup]
10282
+ #
10283
+ # @!attribute [rw] level_4
10284
+ # The group at level four of the agent hierarchy.
10285
+ # @return [Types::AgentHierarchyGroup]
10286
+ #
10287
+ # @!attribute [rw] level_5
10288
+ # The group at level five of the agent hierarchy.
10289
+ # @return [Types::AgentHierarchyGroup]
10290
+ #
10291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroups AWS API Documentation
10292
+ #
10293
+ class HierarchyGroups < Struct.new(
10294
+ :level_1,
10295
+ :level_2,
10296
+ :level_3,
10297
+ :level_4,
10298
+ :level_5)
10299
+ SENSITIVE = []
10300
+ include Aws::Structure
10301
+ end
10302
+
9978
10303
  # Contains information about a hierarchy level.
9979
10304
  #
9980
10305
  # @!attribute [rw] id
@@ -14589,6 +14914,25 @@ module Aws::Connect
14589
14914
  #
14590
14915
  class PutUserStatusResponse < Aws::EmptyStructure; end
14591
14916
 
14917
+ # Information about the quality of the participant's media connection.
14918
+ #
14919
+ # @!attribute [rw] agent
14920
+ # Information about the quality of Agent media connection.
14921
+ # @return [Types::AgentQualityMetrics]
14922
+ #
14923
+ # @!attribute [rw] customer
14924
+ # Information about the quality of Customer media connection.
14925
+ # @return [Types::CustomerQualityMetrics]
14926
+ #
14927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QualityMetrics AWS API Documentation
14928
+ #
14929
+ class QualityMetrics < Struct.new(
14930
+ :agent,
14931
+ :customer)
14932
+ SENSITIVE = []
14933
+ include Aws::Structure
14934
+ end
14935
+
14592
14936
  # Contains information about a queue.
14593
14937
  #
14594
14938
  # @!attribute [rw] name
@@ -15755,6 +16099,39 @@ module Aws::Connect
15755
16099
  #
15756
16100
  class ResumeContactResponse < Aws::EmptyStructure; end
15757
16101
 
16102
+ # Latest routing criteria on the contact.
16103
+ #
16104
+ # @!attribute [rw] steps
16105
+ # List of routing steps. When Amazon Connect does not find an
16106
+ # available agent meeting the requirements in a step for a given step
16107
+ # duration, the routing criteria will move on to the next step
16108
+ # sequentially until a join is completed with an agent. When all steps
16109
+ # are exhausted, the contact will be offered to any agent in the
16110
+ # queue.
16111
+ # @return [Array<Types::Step>]
16112
+ #
16113
+ # @!attribute [rw] activation_timestamp
16114
+ # The timestamp indicating when the routing criteria is set to active.
16115
+ # A routing criteria is activated when contact is transferred to a
16116
+ # queue. ActivationTimestamp will be set on routing criteria for
16117
+ # contacts in agent queue even though Routing criteria is never
16118
+ # activated for contacts in agent queue.
16119
+ # @return [Time]
16120
+ #
16121
+ # @!attribute [rw] index
16122
+ # Information about the index of the routing criteria.
16123
+ # @return [Integer]
16124
+ #
16125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingCriteria AWS API Documentation
16126
+ #
16127
+ class RoutingCriteria < Struct.new(
16128
+ :steps,
16129
+ :activation_timestamp,
16130
+ :index)
16131
+ SENSITIVE = []
16132
+ include Aws::Structure
16133
+ end
16134
+
15758
16135
  # Contains information about a routing profile.
15759
16136
  #
15760
16137
  # @!attribute [rw] instance_id
@@ -15825,6 +16202,10 @@ module Aws::Connect
15825
16202
  # Whether this a default routing profile.
15826
16203
  # @return [Boolean]
15827
16204
  #
16205
+ # @!attribute [rw] associated_queue_ids
16206
+ # The IDs of the associated queue.
16207
+ # @return [Array<String>]
16208
+ #
15828
16209
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfile AWS API Documentation
15829
16210
  #
15830
16211
  class RoutingProfile < Struct.new(
@@ -15841,7 +16222,8 @@ module Aws::Connect
15841
16222
  :agent_availability_timer,
15842
16223
  :last_modified_time,
15843
16224
  :last_modified_region,
15844
- :is_default)
16225
+ :is_default,
16226
+ :associated_queue_ids)
15845
16227
  SENSITIVE = []
15846
16228
  include Aws::Structure
15847
16229
  end
@@ -15995,8 +16377,8 @@ module Aws::Connect
15995
16377
  # A leaf node condition which can be used to specify a string
15996
16378
  # condition.
15997
16379
  #
15998
- # <note markdown="1"> The currently supported values for `FieldName` are `name`,
15999
- # `description`, and `resourceID`.
16380
+ # <note markdown="1"> The currently supported values for `FieldName` are
16381
+ # `associatedQueueIds`, `name`, `description`, and `resourceID`.
16000
16382
  #
16001
16383
  # </note>
16002
16384
  # @return [Types::StringCondition]
@@ -18665,6 +19047,30 @@ module Aws::Connect
18665
19047
  include Aws::Structure
18666
19048
  end
18667
19049
 
19050
+ # Step signifies the criteria to be used for routing to an agent
19051
+ #
19052
+ # @!attribute [rw] expiry
19053
+ # An object to specify the expiration of a routing step.
19054
+ # @return [Types::Expiry]
19055
+ #
19056
+ # @!attribute [rw] expression
19057
+ # A tagged union to specify expression for a routing step.
19058
+ # @return [Types::Expression]
19059
+ #
19060
+ # @!attribute [rw] status
19061
+ # Represents status of the Routing step.
19062
+ # @return [String]
19063
+ #
19064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Step AWS API Documentation
19065
+ #
19066
+ class Step < Struct.new(
19067
+ :expiry,
19068
+ :expression,
19069
+ :status)
19070
+ SENSITIVE = []
19071
+ include Aws::Structure
19072
+ end
19073
+
18668
19074
  # @!attribute [rw] instance_id
18669
19075
  # The identifier of the Amazon Connect instance. You can [find the
18670
19076
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connect/customizations'
52
52
  # @!group service
53
53
  module Aws::Connect
54
54
 
55
- GEM_VERSION = '1.159.0'
55
+ GEM_VERSION = '1.161.0'
56
56
 
57
57
  end