aws-sdk-connect 1.144.0 → 1.146.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +597 -3
- data/lib/aws-sdk-connect/client_api.rb +474 -0
- data/lib/aws-sdk-connect/endpoints.rb +168 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +24 -0
- data/lib/aws-sdk-connect/types.rb +990 -8
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -155,6 +155,47 @@ module Aws::Connect
|
|
155
155
|
include Aws::Structure
|
156
156
|
end
|
157
157
|
|
158
|
+
# A structure that defines search criteria for contacts using agent
|
159
|
+
# hierarchy group levels. For more information about agent hierarchies,
|
160
|
+
# see [Set Up Agent Hierarchies][1] in the *Amazon Connect Administrator
|
161
|
+
# Guide*.
|
162
|
+
#
|
163
|
+
#
|
164
|
+
#
|
165
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html
|
166
|
+
#
|
167
|
+
# @!attribute [rw] l1_ids
|
168
|
+
# The identifiers for level 1 hierarchy groups.
|
169
|
+
# @return [Array<String>]
|
170
|
+
#
|
171
|
+
# @!attribute [rw] l2_ids
|
172
|
+
# The identifiers for level 2 hierarchy groups.
|
173
|
+
# @return [Array<String>]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] l3_ids
|
176
|
+
# The identifiers for level 3 hierarchy groups.
|
177
|
+
# @return [Array<String>]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] l4_ids
|
180
|
+
# The identifiers for level 4 hierarchy groups.
|
181
|
+
# @return [Array<String>]
|
182
|
+
#
|
183
|
+
# @!attribute [rw] l5_ids
|
184
|
+
# The identifiers for level 5 hierarchy groups.
|
185
|
+
# @return [Array<String>]
|
186
|
+
#
|
187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentHierarchyGroups AWS API Documentation
|
188
|
+
#
|
189
|
+
class AgentHierarchyGroups < Struct.new(
|
190
|
+
:l1_ids,
|
191
|
+
:l2_ids,
|
192
|
+
:l3_ids,
|
193
|
+
:l4_ids,
|
194
|
+
:l5_ids)
|
195
|
+
SENSITIVE = []
|
196
|
+
include Aws::Structure
|
197
|
+
end
|
198
|
+
|
158
199
|
# Information about the agent who accepted the contact.
|
159
200
|
#
|
160
201
|
# @!attribute [rw] id
|
@@ -832,6 +873,29 @@ module Aws::Connect
|
|
832
873
|
#
|
833
874
|
class AssociateTrafficDistributionGroupUserResponse < Aws::EmptyStructure; end
|
834
875
|
|
876
|
+
# @!attribute [rw] instance_id
|
877
|
+
# The identifier of the Amazon Connect instance. You can find the
|
878
|
+
# instance ID in the Amazon Resource Name (ARN of the instance).
|
879
|
+
# @return [String]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] user_id
|
882
|
+
# The identifier of the user account.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] user_proficiencies
|
886
|
+
# The proficiencies to associate with the user.
|
887
|
+
# @return [Array<Types::UserProficiency>]
|
888
|
+
#
|
889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateUserProficienciesRequest AWS API Documentation
|
890
|
+
#
|
891
|
+
class AssociateUserProficienciesRequest < Struct.new(
|
892
|
+
:instance_id,
|
893
|
+
:user_id,
|
894
|
+
:user_proficiencies)
|
895
|
+
SENSITIVE = []
|
896
|
+
include Aws::Structure
|
897
|
+
end
|
898
|
+
|
835
899
|
# Information about a reference when the `referenceType` is
|
836
900
|
# `ATTACHMENT`. Otherwise, null.
|
837
901
|
#
|
@@ -1583,6 +1647,21 @@ module Aws::Connect
|
|
1583
1647
|
# Information about Amazon Connect Wisdom.
|
1584
1648
|
# @return [Types::WisdomInfo]
|
1585
1649
|
#
|
1650
|
+
# @!attribute [rw] queue_time_adjustment_seconds
|
1651
|
+
# An integer that represents the queue time adjust to be applied to
|
1652
|
+
# the contact, in seconds (longer / larger queue time are routed
|
1653
|
+
# preferentially). Cannot be specified if the QueuePriority is
|
1654
|
+
# specified. Must be statically defined and a valid integer value.
|
1655
|
+
# @return [Integer]
|
1656
|
+
#
|
1657
|
+
# @!attribute [rw] queue_priority
|
1658
|
+
# An integer that represents the queue priority to be applied to the
|
1659
|
+
# contact (lower priorities are routed preferentially). Cannot be
|
1660
|
+
# specified if the QueueTimeAdjustmentSeconds is specified. Must be
|
1661
|
+
# statically defined, must be larger than zero, and a valid integer
|
1662
|
+
# value. Default Value is 5.
|
1663
|
+
# @return [Integer]
|
1664
|
+
#
|
1586
1665
|
# @!attribute [rw] tags
|
1587
1666
|
# Tags associated with the contact. This contains both Amazon Web
|
1588
1667
|
# Services generated and user-defined tags.
|
@@ -1611,11 +1690,29 @@ module Aws::Connect
|
|
1611
1690
|
:scheduled_timestamp,
|
1612
1691
|
:related_contact_id,
|
1613
1692
|
:wisdom_info,
|
1693
|
+
:queue_time_adjustment_seconds,
|
1694
|
+
:queue_priority,
|
1614
1695
|
:tags)
|
1615
1696
|
SENSITIVE = []
|
1616
1697
|
include Aws::Structure
|
1617
1698
|
end
|
1618
1699
|
|
1700
|
+
# A structure that defines search criteria for contacts using analysis
|
1701
|
+
# outputs from Amazon Connect Contact Lens.
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] transcript
|
1704
|
+
# Search criteria based on transcript analyzed by Amazon Connect
|
1705
|
+
# Contact Lens.
|
1706
|
+
# @return [Types::Transcript]
|
1707
|
+
#
|
1708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactAnalysis AWS API Documentation
|
1709
|
+
#
|
1710
|
+
class ContactAnalysis < Struct.new(
|
1711
|
+
:transcript)
|
1712
|
+
SENSITIVE = []
|
1713
|
+
include Aws::Structure
|
1714
|
+
end
|
1715
|
+
|
1619
1716
|
# Request object with information to create a contact.
|
1620
1717
|
#
|
1621
1718
|
# @!attribute [rw] system_endpoint
|
@@ -1897,6 +1994,120 @@ module Aws::Connect
|
|
1897
1994
|
include Aws::Structure
|
1898
1995
|
end
|
1899
1996
|
|
1997
|
+
# Information of returned contact.
|
1998
|
+
#
|
1999
|
+
# @!attribute [rw] arn
|
2000
|
+
# The Amazon Resource Name (ARN) of the contact.
|
2001
|
+
# @return [String]
|
2002
|
+
#
|
2003
|
+
# @!attribute [rw] id
|
2004
|
+
# The identifier of the contact summary.
|
2005
|
+
# @return [String]
|
2006
|
+
#
|
2007
|
+
# @!attribute [rw] initial_contact_id
|
2008
|
+
# If this contact is related to other contacts, this is the ID of the
|
2009
|
+
# initial contact.
|
2010
|
+
# @return [String]
|
2011
|
+
#
|
2012
|
+
# @!attribute [rw] previous_contact_id
|
2013
|
+
# If this contact is not the first contact, this is the ID of the
|
2014
|
+
# previous contact.
|
2015
|
+
# @return [String]
|
2016
|
+
#
|
2017
|
+
# @!attribute [rw] initiation_method
|
2018
|
+
# Indicates how the contact was initiated.
|
2019
|
+
# @return [String]
|
2020
|
+
#
|
2021
|
+
# @!attribute [rw] channel
|
2022
|
+
# How the contact reached your contact center.
|
2023
|
+
# @return [String]
|
2024
|
+
#
|
2025
|
+
# @!attribute [rw] queue_info
|
2026
|
+
# If this contact was queued, this contains information about the
|
2027
|
+
# queue.
|
2028
|
+
# @return [Types::ContactSearchSummaryQueueInfo]
|
2029
|
+
#
|
2030
|
+
# @!attribute [rw] agent_info
|
2031
|
+
# Information about the agent who accepted the contact.
|
2032
|
+
# @return [Types::ContactSearchSummaryAgentInfo]
|
2033
|
+
#
|
2034
|
+
# @!attribute [rw] initiation_timestamp
|
2035
|
+
# The date and time this contact was initiated, in UTC time. For
|
2036
|
+
# `INBOUND`, this is when the contact arrived. For `OUTBOUND`, this is
|
2037
|
+
# when the agent began dialing. For `CALLBACK`, this is when the
|
2038
|
+
# callback contact was created. For `TRANSFER` and `QUEUE_TRANSFER`,
|
2039
|
+
# this is when the transfer was initiated. For API, this is when the
|
2040
|
+
# request arrived. For `EXTERNAL_OUTBOUND`, this is when the agent
|
2041
|
+
# started dialing the external participant. For `MONITOR`, this is
|
2042
|
+
# when the supervisor started listening to a contact.
|
2043
|
+
# @return [Time]
|
2044
|
+
#
|
2045
|
+
# @!attribute [rw] disconnect_timestamp
|
2046
|
+
# The timestamp when the customer endpoint disconnected from Amazon
|
2047
|
+
# Connect.
|
2048
|
+
# @return [Time]
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] scheduled_timestamp
|
2051
|
+
# The timestamp, in Unix epoch time format, at which to start running
|
2052
|
+
# the inbound flow.
|
2053
|
+
# @return [Time]
|
2054
|
+
#
|
2055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummary AWS API Documentation
|
2056
|
+
#
|
2057
|
+
class ContactSearchSummary < Struct.new(
|
2058
|
+
:arn,
|
2059
|
+
:id,
|
2060
|
+
:initial_contact_id,
|
2061
|
+
:previous_contact_id,
|
2062
|
+
:initiation_method,
|
2063
|
+
:channel,
|
2064
|
+
:queue_info,
|
2065
|
+
:agent_info,
|
2066
|
+
:initiation_timestamp,
|
2067
|
+
:disconnect_timestamp,
|
2068
|
+
:scheduled_timestamp)
|
2069
|
+
SENSITIVE = []
|
2070
|
+
include Aws::Structure
|
2071
|
+
end
|
2072
|
+
|
2073
|
+
# Information about the agent who accepted the contact.
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] id
|
2076
|
+
# The identifier of the agent who accepted the contact.
|
2077
|
+
# @return [String]
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] connected_to_agent_timestamp
|
2080
|
+
# The timestamp when the contact was connected to the agent.
|
2081
|
+
# @return [Time]
|
2082
|
+
#
|
2083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummaryAgentInfo AWS API Documentation
|
2084
|
+
#
|
2085
|
+
class ContactSearchSummaryAgentInfo < Struct.new(
|
2086
|
+
:id,
|
2087
|
+
:connected_to_agent_timestamp)
|
2088
|
+
SENSITIVE = []
|
2089
|
+
include Aws::Structure
|
2090
|
+
end
|
2091
|
+
|
2092
|
+
# If this contact was queued, this contains information about the queue.
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] id
|
2095
|
+
# The unique identifier for the queue.
|
2096
|
+
# @return [String]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] enqueue_timestamp
|
2099
|
+
# The timestamp when the contact was added to the queue.
|
2100
|
+
# @return [Time]
|
2101
|
+
#
|
2102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactSearchSummaryQueueInfo AWS API Documentation
|
2103
|
+
#
|
2104
|
+
class ContactSearchSummaryQueueInfo < Struct.new(
|
2105
|
+
:id,
|
2106
|
+
:enqueue_timestamp)
|
2107
|
+
SENSITIVE = []
|
2108
|
+
include Aws::Structure
|
2109
|
+
end
|
2110
|
+
|
1900
2111
|
# An object that can be used to specify Tag conditions inside the
|
1901
2112
|
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
1902
2113
|
# where:
|
@@ -2613,6 +2824,29 @@ module Aws::Connect
|
|
2613
2824
|
include Aws::Structure
|
2614
2825
|
end
|
2615
2826
|
|
2827
|
+
# @!attribute [rw] instance_id
|
2828
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2829
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
2830
|
+
# @return [String]
|
2831
|
+
#
|
2832
|
+
# @!attribute [rw] name
|
2833
|
+
# The name of the predefined attribute.
|
2834
|
+
# @return [String]
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] values
|
2837
|
+
# The values of the predefined attribute.
|
2838
|
+
# @return [Types::PredefinedAttributeValues]
|
2839
|
+
#
|
2840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePredefinedAttributeRequest AWS API Documentation
|
2841
|
+
#
|
2842
|
+
class CreatePredefinedAttributeRequest < Struct.new(
|
2843
|
+
:instance_id,
|
2844
|
+
:name,
|
2845
|
+
:values)
|
2846
|
+
SENSITIVE = []
|
2847
|
+
include Aws::Structure
|
2848
|
+
end
|
2849
|
+
|
2616
2850
|
# @!attribute [rw] instance_id
|
2617
2851
|
# The identifier of the Amazon Connect instance. You can [find the
|
2618
2852
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -4010,6 +4244,24 @@ module Aws::Connect
|
|
4010
4244
|
include Aws::Structure
|
4011
4245
|
end
|
4012
4246
|
|
4247
|
+
# @!attribute [rw] instance_id
|
4248
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4249
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
4250
|
+
# @return [String]
|
4251
|
+
#
|
4252
|
+
# @!attribute [rw] name
|
4253
|
+
# The name of the predefined attribute.
|
4254
|
+
# @return [String]
|
4255
|
+
#
|
4256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeletePredefinedAttributeRequest AWS API Documentation
|
4257
|
+
#
|
4258
|
+
class DeletePredefinedAttributeRequest < Struct.new(
|
4259
|
+
:instance_id,
|
4260
|
+
:name)
|
4261
|
+
SENSITIVE = []
|
4262
|
+
include Aws::Structure
|
4263
|
+
end
|
4264
|
+
|
4013
4265
|
# @!attribute [rw] instance_id
|
4014
4266
|
# The identifier of the Amazon Connect instance. You can [find the
|
4015
4267
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -4723,6 +4975,36 @@ module Aws::Connect
|
|
4723
4975
|
include Aws::Structure
|
4724
4976
|
end
|
4725
4977
|
|
4978
|
+
# @!attribute [rw] instance_id
|
4979
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4980
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
4981
|
+
# @return [String]
|
4982
|
+
#
|
4983
|
+
# @!attribute [rw] name
|
4984
|
+
# The name of the predefined attribute.
|
4985
|
+
# @return [String]
|
4986
|
+
#
|
4987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePredefinedAttributeRequest AWS API Documentation
|
4988
|
+
#
|
4989
|
+
class DescribePredefinedAttributeRequest < Struct.new(
|
4990
|
+
:instance_id,
|
4991
|
+
:name)
|
4992
|
+
SENSITIVE = []
|
4993
|
+
include Aws::Structure
|
4994
|
+
end
|
4995
|
+
|
4996
|
+
# @!attribute [rw] predefined_attribute
|
4997
|
+
# Information about the predefined attribute.
|
4998
|
+
# @return [Types::PredefinedAttribute]
|
4999
|
+
#
|
5000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePredefinedAttributeResponse AWS API Documentation
|
5001
|
+
#
|
5002
|
+
class DescribePredefinedAttributeResponse < Struct.new(
|
5003
|
+
:predefined_attribute)
|
5004
|
+
SENSITIVE = []
|
5005
|
+
include Aws::Structure
|
5006
|
+
end
|
5007
|
+
|
4726
5008
|
# @!attribute [rw] instance_id
|
4727
5009
|
# The identifier of the Amazon Connect instance. You can [find the
|
4728
5010
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -5147,12 +5429,17 @@ module Aws::Connect
|
|
5147
5429
|
# Information about the routing profile assigned to the user.
|
5148
5430
|
# @return [Types::RoutingProfileReference]
|
5149
5431
|
#
|
5432
|
+
# @!attribute [rw] routing_step_expression
|
5433
|
+
# The expression of a step in a routing criteria.
|
5434
|
+
# @return [String]
|
5435
|
+
#
|
5150
5436
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
|
5151
5437
|
#
|
5152
5438
|
class Dimensions < Struct.new(
|
5153
5439
|
:queue,
|
5154
5440
|
:channel,
|
5155
|
-
:routing_profile
|
5441
|
+
:routing_profile,
|
5442
|
+
:routing_step_expression)
|
5156
5443
|
SENSITIVE = []
|
5157
5444
|
include Aws::Structure
|
5158
5445
|
end
|
@@ -5480,6 +5767,29 @@ module Aws::Connect
|
|
5480
5767
|
#
|
5481
5768
|
class DisassociateTrafficDistributionGroupUserResponse < Aws::EmptyStructure; end
|
5482
5769
|
|
5770
|
+
# @!attribute [rw] instance_id
|
5771
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5772
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
5773
|
+
# @return [String]
|
5774
|
+
#
|
5775
|
+
# @!attribute [rw] user_id
|
5776
|
+
# The identifier of the user account.
|
5777
|
+
# @return [String]
|
5778
|
+
#
|
5779
|
+
# @!attribute [rw] user_proficiencies
|
5780
|
+
# The proficiencies to disassociate from the user.
|
5781
|
+
# @return [Array<Types::UserProficiencyDisassociate>]
|
5782
|
+
#
|
5783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateUserProficienciesRequest AWS API Documentation
|
5784
|
+
#
|
5785
|
+
class DisassociateUserProficienciesRequest < Struct.new(
|
5786
|
+
:instance_id,
|
5787
|
+
:user_id,
|
5788
|
+
:user_proficiencies)
|
5789
|
+
SENSITIVE = []
|
5790
|
+
include Aws::Structure
|
5791
|
+
end
|
5792
|
+
|
5483
5793
|
# Contains details about why a contact was disconnected. Only Amazon
|
5484
5794
|
# Connect outbound campaigns can provide this field.
|
5485
5795
|
#
|
@@ -6658,12 +6968,18 @@ module Aws::Connect
|
|
6658
6968
|
# A list of up to 100 routing profile IDs or ARNs.
|
6659
6969
|
# @return [Array<String>]
|
6660
6970
|
#
|
6971
|
+
# @!attribute [rw] routing_step_expressions
|
6972
|
+
# A list of expressions as a filter, in which an expression is an
|
6973
|
+
# object of a step in a routing criteria.
|
6974
|
+
# @return [Array<String>]
|
6975
|
+
#
|
6661
6976
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Filters AWS API Documentation
|
6662
6977
|
#
|
6663
6978
|
class Filters < Struct.new(
|
6664
6979
|
:queues,
|
6665
6980
|
:channels,
|
6666
|
-
:routing_profiles
|
6981
|
+
:routing_profiles,
|
6982
|
+
:routing_step_expressions)
|
6667
6983
|
SENSITIVE = []
|
6668
6984
|
include Aws::Structure
|
6669
6985
|
end
|
@@ -10731,6 +11047,49 @@ module Aws::Connect
|
|
10731
11047
|
include Aws::Structure
|
10732
11048
|
end
|
10733
11049
|
|
11050
|
+
# @!attribute [rw] instance_id
|
11051
|
+
# The identifier of the Amazon Connect instance. You can find the
|
11052
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
11053
|
+
# @return [String]
|
11054
|
+
#
|
11055
|
+
# @!attribute [rw] next_token
|
11056
|
+
# The token for the next set of results. Use the value returned in the
|
11057
|
+
# previous response in the next request to retrieve the next set of
|
11058
|
+
# results.
|
11059
|
+
# @return [String]
|
11060
|
+
#
|
11061
|
+
# @!attribute [rw] max_results
|
11062
|
+
# The maximum number of results to return per page.
|
11063
|
+
# @return [Integer]
|
11064
|
+
#
|
11065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPredefinedAttributesRequest AWS API Documentation
|
11066
|
+
#
|
11067
|
+
class ListPredefinedAttributesRequest < Struct.new(
|
11068
|
+
:instance_id,
|
11069
|
+
:next_token,
|
11070
|
+
:max_results)
|
11071
|
+
SENSITIVE = []
|
11072
|
+
include Aws::Structure
|
11073
|
+
end
|
11074
|
+
|
11075
|
+
# @!attribute [rw] next_token
|
11076
|
+
# If there are additional results, this is the token for the next set
|
11077
|
+
# of results.
|
11078
|
+
# @return [String]
|
11079
|
+
#
|
11080
|
+
# @!attribute [rw] predefined_attribute_summary_list
|
11081
|
+
# Summary of the predefined attributes.
|
11082
|
+
# @return [Array<Types::PredefinedAttributeSummary>]
|
11083
|
+
#
|
11084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPredefinedAttributesResponse AWS API Documentation
|
11085
|
+
#
|
11086
|
+
class ListPredefinedAttributesResponse < Struct.new(
|
11087
|
+
:next_token,
|
11088
|
+
:predefined_attribute_summary_list)
|
11089
|
+
SENSITIVE = []
|
11090
|
+
include Aws::Structure
|
11091
|
+
end
|
11092
|
+
|
10734
11093
|
# @!attribute [rw] instance_id
|
10735
11094
|
# The identifier of the Amazon Connect instance.
|
10736
11095
|
# @return [String]
|
@@ -11715,8 +12074,66 @@ module Aws::Connect
|
|
11715
12074
|
end
|
11716
12075
|
|
11717
12076
|
# @!attribute [rw] instance_id
|
11718
|
-
# The identifier of the Amazon Connect instance. You can
|
11719
|
-
# instance ID
|
12077
|
+
# The identifier of the Amazon Connect instance. You can find the
|
12078
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
12079
|
+
# @return [String]
|
12080
|
+
#
|
12081
|
+
# @!attribute [rw] user_id
|
12082
|
+
# The identifier of the user account.
|
12083
|
+
# @return [String]
|
12084
|
+
#
|
12085
|
+
# @!attribute [rw] next_token
|
12086
|
+
# The token for the next set of results. Use the value returned in the
|
12087
|
+
# previous response in the next request to retrieve the next set of
|
12088
|
+
# results.
|
12089
|
+
# @return [String]
|
12090
|
+
#
|
12091
|
+
# @!attribute [rw] max_results
|
12092
|
+
# The maximum number of results to return per page.
|
12093
|
+
# @return [Integer]
|
12094
|
+
#
|
12095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserProficienciesRequest AWS API Documentation
|
12096
|
+
#
|
12097
|
+
class ListUserProficienciesRequest < Struct.new(
|
12098
|
+
:instance_id,
|
12099
|
+
:user_id,
|
12100
|
+
:next_token,
|
12101
|
+
:max_results)
|
12102
|
+
SENSITIVE = []
|
12103
|
+
include Aws::Structure
|
12104
|
+
end
|
12105
|
+
|
12106
|
+
# @!attribute [rw] next_token
|
12107
|
+
# If there are additional results, this is the token for the next set
|
12108
|
+
# of results.
|
12109
|
+
# @return [String]
|
12110
|
+
#
|
12111
|
+
# @!attribute [rw] user_proficiency_list
|
12112
|
+
# Information about the user proficiencies.
|
12113
|
+
# @return [Array<Types::UserProficiency>]
|
12114
|
+
#
|
12115
|
+
# @!attribute [rw] last_modified_time
|
12116
|
+
# The last time that the user's proficiencies are were modified.
|
12117
|
+
# @return [Time]
|
12118
|
+
#
|
12119
|
+
# @!attribute [rw] last_modified_region
|
12120
|
+
# The region in which a user's proficiencies were last modified.
|
12121
|
+
# @return [String]
|
12122
|
+
#
|
12123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserProficienciesResponse AWS API Documentation
|
12124
|
+
#
|
12125
|
+
class ListUserProficienciesResponse < Struct.new(
|
12126
|
+
:next_token,
|
12127
|
+
:user_proficiency_list,
|
12128
|
+
:last_modified_time,
|
12129
|
+
:last_modified_region)
|
12130
|
+
SENSITIVE = []
|
12131
|
+
include Aws::Structure
|
12132
|
+
end
|
12133
|
+
|
12134
|
+
# @!attribute [rw] instance_id
|
12135
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
12136
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
11720
12137
|
#
|
11721
12138
|
#
|
11722
12139
|
#
|
@@ -12681,6 +13098,114 @@ module Aws::Connect
|
|
12681
13098
|
include Aws::Structure
|
12682
13099
|
end
|
12683
13100
|
|
13101
|
+
# Information about a predefined attribute.
|
13102
|
+
#
|
13103
|
+
# @!attribute [rw] name
|
13104
|
+
# The name of the predefined attribute.
|
13105
|
+
# @return [String]
|
13106
|
+
#
|
13107
|
+
# @!attribute [rw] values
|
13108
|
+
# The values of the predefined attribute.
|
13109
|
+
# @return [Types::PredefinedAttributeValues]
|
13110
|
+
#
|
13111
|
+
# @!attribute [rw] last_modified_time
|
13112
|
+
# Last modified time.
|
13113
|
+
# @return [Time]
|
13114
|
+
#
|
13115
|
+
# @!attribute [rw] last_modified_region
|
13116
|
+
# Last modified region.
|
13117
|
+
# @return [String]
|
13118
|
+
#
|
13119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttribute AWS API Documentation
|
13120
|
+
#
|
13121
|
+
class PredefinedAttribute < Struct.new(
|
13122
|
+
:name,
|
13123
|
+
:values,
|
13124
|
+
:last_modified_time,
|
13125
|
+
:last_modified_region)
|
13126
|
+
SENSITIVE = []
|
13127
|
+
include Aws::Structure
|
13128
|
+
end
|
13129
|
+
|
13130
|
+
# The search criteria to be used to return predefined attributes.
|
13131
|
+
#
|
13132
|
+
# @!attribute [rw] or_conditions
|
13133
|
+
# A list of conditions which would be applied together with an `OR`
|
13134
|
+
# condition.
|
13135
|
+
# @return [Array<Types::PredefinedAttributeSearchCriteria>]
|
13136
|
+
#
|
13137
|
+
# @!attribute [rw] and_conditions
|
13138
|
+
# A list of conditions which would be applied together with an `AND`
|
13139
|
+
# condition.
|
13140
|
+
# @return [Array<Types::PredefinedAttributeSearchCriteria>]
|
13141
|
+
#
|
13142
|
+
# @!attribute [rw] string_condition
|
13143
|
+
# A leaf node condition which can be used to specify a string
|
13144
|
+
# condition.
|
13145
|
+
#
|
13146
|
+
# <note markdown="1"> The currently supported values for `FieldName` are `name` and
|
13147
|
+
# `description`.
|
13148
|
+
#
|
13149
|
+
# </note>
|
13150
|
+
# @return [Types::StringCondition]
|
13151
|
+
#
|
13152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeSearchCriteria AWS API Documentation
|
13153
|
+
#
|
13154
|
+
class PredefinedAttributeSearchCriteria < Struct.new(
|
13155
|
+
:or_conditions,
|
13156
|
+
:and_conditions,
|
13157
|
+
:string_condition)
|
13158
|
+
SENSITIVE = []
|
13159
|
+
include Aws::Structure
|
13160
|
+
end
|
13161
|
+
|
13162
|
+
# Summary of a predefined attribute.
|
13163
|
+
#
|
13164
|
+
# @!attribute [rw] name
|
13165
|
+
# The name of the predefined attribute.
|
13166
|
+
# @return [String]
|
13167
|
+
#
|
13168
|
+
# @!attribute [rw] last_modified_time
|
13169
|
+
# Last modified time.
|
13170
|
+
# @return [Time]
|
13171
|
+
#
|
13172
|
+
# @!attribute [rw] last_modified_region
|
13173
|
+
# Last modified region.
|
13174
|
+
# @return [String]
|
13175
|
+
#
|
13176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeSummary AWS API Documentation
|
13177
|
+
#
|
13178
|
+
class PredefinedAttributeSummary < Struct.new(
|
13179
|
+
:name,
|
13180
|
+
:last_modified_time,
|
13181
|
+
:last_modified_region)
|
13182
|
+
SENSITIVE = []
|
13183
|
+
include Aws::Structure
|
13184
|
+
end
|
13185
|
+
|
13186
|
+
# Information about values of a predefined attribute.
|
13187
|
+
#
|
13188
|
+
# @note PredefinedAttributeValues is a union - when making an API calls you must set exactly one of the members.
|
13189
|
+
#
|
13190
|
+
# @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.
|
13191
|
+
#
|
13192
|
+
# @!attribute [rw] string_list
|
13193
|
+
# Predefined attribute values of type string list.
|
13194
|
+
# @return [Array<String>]
|
13195
|
+
#
|
13196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeValues AWS API Documentation
|
13197
|
+
#
|
13198
|
+
class PredefinedAttributeValues < Struct.new(
|
13199
|
+
:string_list,
|
13200
|
+
:unknown)
|
13201
|
+
SENSITIVE = []
|
13202
|
+
include Aws::Structure
|
13203
|
+
include Aws::Structure::Union
|
13204
|
+
|
13205
|
+
class StringList < PredefinedAttributeValues; end
|
13206
|
+
class Unknown < PredefinedAttributeValues; end
|
13207
|
+
end
|
13208
|
+
|
12684
13209
|
# Information about a problem detail.
|
12685
13210
|
#
|
12686
13211
|
# @!attribute [rw] message
|
@@ -14697,6 +15222,153 @@ module Aws::Connect
|
|
14697
15222
|
include Aws::Structure
|
14698
15223
|
end
|
14699
15224
|
|
15225
|
+
# @!attribute [rw] instance_id
|
15226
|
+
# The identifier of Amazon Connect instance. You can find the instance
|
15227
|
+
# ID in the Amazon Resource Name (ARN) of the instance.
|
15228
|
+
# @return [String]
|
15229
|
+
#
|
15230
|
+
# @!attribute [rw] time_range
|
15231
|
+
# Time range that you want to search results.
|
15232
|
+
# @return [Types::SearchContactsTimeRange]
|
15233
|
+
#
|
15234
|
+
# @!attribute [rw] search_criteria
|
15235
|
+
# The search criteria to be used to return contacts.
|
15236
|
+
# @return [Types::SearchCriteria]
|
15237
|
+
#
|
15238
|
+
# @!attribute [rw] max_results
|
15239
|
+
# The maximum number of results to return per page.
|
15240
|
+
# @return [Integer]
|
15241
|
+
#
|
15242
|
+
# @!attribute [rw] next_token
|
15243
|
+
# The token for the next set of results. Use the value returned in the
|
15244
|
+
# previous response in the next request to retrieve the next set of
|
15245
|
+
# results.
|
15246
|
+
# @return [String]
|
15247
|
+
#
|
15248
|
+
# @!attribute [rw] sort
|
15249
|
+
# Specifies a field to sort by and a sort order.
|
15250
|
+
# @return [Types::Sort]
|
15251
|
+
#
|
15252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactsRequest AWS API Documentation
|
15253
|
+
#
|
15254
|
+
class SearchContactsRequest < Struct.new(
|
15255
|
+
:instance_id,
|
15256
|
+
:time_range,
|
15257
|
+
:search_criteria,
|
15258
|
+
:max_results,
|
15259
|
+
:next_token,
|
15260
|
+
:sort)
|
15261
|
+
SENSITIVE = []
|
15262
|
+
include Aws::Structure
|
15263
|
+
end
|
15264
|
+
|
15265
|
+
# @!attribute [rw] contacts
|
15266
|
+
# Information about the contacts.
|
15267
|
+
# @return [Array<Types::ContactSearchSummary>]
|
15268
|
+
#
|
15269
|
+
# @!attribute [rw] next_token
|
15270
|
+
# If there are additional results, this is the token for the next set
|
15271
|
+
# of results.
|
15272
|
+
# @return [String]
|
15273
|
+
#
|
15274
|
+
# @!attribute [rw] total_count
|
15275
|
+
# The total number of contacts which matched your search query.
|
15276
|
+
# @return [Integer]
|
15277
|
+
#
|
15278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactsResponse AWS API Documentation
|
15279
|
+
#
|
15280
|
+
class SearchContactsResponse < Struct.new(
|
15281
|
+
:contacts,
|
15282
|
+
:next_token,
|
15283
|
+
:total_count)
|
15284
|
+
SENSITIVE = []
|
15285
|
+
include Aws::Structure
|
15286
|
+
end
|
15287
|
+
|
15288
|
+
# A structure of time range that you want to search results.
|
15289
|
+
#
|
15290
|
+
# @!attribute [rw] type
|
15291
|
+
# The type of timestamp to search.
|
15292
|
+
# @return [String]
|
15293
|
+
#
|
15294
|
+
# @!attribute [rw] start_time
|
15295
|
+
# The start time of the time range.
|
15296
|
+
# @return [Time]
|
15297
|
+
#
|
15298
|
+
# @!attribute [rw] end_time
|
15299
|
+
# The end time of the time range.
|
15300
|
+
# @return [Time]
|
15301
|
+
#
|
15302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactsTimeRange AWS API Documentation
|
15303
|
+
#
|
15304
|
+
class SearchContactsTimeRange < Struct.new(
|
15305
|
+
:type,
|
15306
|
+
:start_time,
|
15307
|
+
:end_time)
|
15308
|
+
SENSITIVE = []
|
15309
|
+
include Aws::Structure
|
15310
|
+
end
|
15311
|
+
|
15312
|
+
# A structure of search criteria to be used to return contacts.
|
15313
|
+
#
|
15314
|
+
# @!attribute [rw] agent_ids
|
15315
|
+
# The identifiers of agents who handled the contacts.
|
15316
|
+
# @return [Array<String>]
|
15317
|
+
#
|
15318
|
+
# @!attribute [rw] agent_hierarchy_groups
|
15319
|
+
# The agent hierarchy groups of the agent at the time of handling the
|
15320
|
+
# contact.
|
15321
|
+
# @return [Types::AgentHierarchyGroups]
|
15322
|
+
#
|
15323
|
+
# @!attribute [rw] channels
|
15324
|
+
# The list of channels associated with contacts.
|
15325
|
+
# @return [Array<String>]
|
15326
|
+
#
|
15327
|
+
# @!attribute [rw] contact_analysis
|
15328
|
+
# Search criteria based on analysis outputs from Amazon Connect
|
15329
|
+
# Contact Lens.
|
15330
|
+
# @return [Types::ContactAnalysis]
|
15331
|
+
#
|
15332
|
+
# @!attribute [rw] initiation_methods
|
15333
|
+
# The list of initiation methods associated with contacts.
|
15334
|
+
# @return [Array<String>]
|
15335
|
+
#
|
15336
|
+
# @!attribute [rw] queue_ids
|
15337
|
+
# The list of queue IDs associated with contacts.
|
15338
|
+
# @return [Array<String>]
|
15339
|
+
#
|
15340
|
+
# @!attribute [rw] searchable_contact_attributes
|
15341
|
+
# The search criteria based on user-defined contact attributes that
|
15342
|
+
# have been configured for contact search. For more information, see
|
15343
|
+
# [Search by customer contact attributes][1] in the *Amazon Connect
|
15344
|
+
# Administrator Guide*.
|
15345
|
+
#
|
15346
|
+
# To use `SearchableContactAttributes` in a search request, the
|
15347
|
+
# `GetContactAttributes` action is required to perform an API request.
|
15348
|
+
# For more information, see
|
15349
|
+
# [https://docs.aws.amazon.com/service-authorization/latest/reference/list\_amazonconnect.html#amazonconnect-actions-as-permissions][2]Actions
|
15350
|
+
# defined by Amazon Connect.
|
15351
|
+
#
|
15352
|
+
#
|
15353
|
+
#
|
15354
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html
|
15355
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions
|
15356
|
+
# @return [Types::SearchableContactAttributes]
|
15357
|
+
#
|
15358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchCriteria AWS API Documentation
|
15359
|
+
#
|
15360
|
+
class SearchCriteria < Struct.new(
|
15361
|
+
:agent_ids,
|
15362
|
+
:agent_hierarchy_groups,
|
15363
|
+
:channels,
|
15364
|
+
:contact_analysis,
|
15365
|
+
:initiation_methods,
|
15366
|
+
:queue_ids,
|
15367
|
+
:searchable_contact_attributes)
|
15368
|
+
SENSITIVE = []
|
15369
|
+
include Aws::Structure
|
15370
|
+
end
|
15371
|
+
|
14700
15372
|
# @!attribute [rw] instance_id
|
14701
15373
|
# The identifier of the Amazon Connect instance. You can [find the
|
14702
15374
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -14760,6 +15432,61 @@ module Aws::Connect
|
|
14760
15432
|
include Aws::Structure
|
14761
15433
|
end
|
14762
15434
|
|
15435
|
+
# @!attribute [rw] instance_id
|
15436
|
+
# The identifier of the Amazon Connect instance. You can find the
|
15437
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
15438
|
+
# @return [String]
|
15439
|
+
#
|
15440
|
+
# @!attribute [rw] next_token
|
15441
|
+
# The token for the next set of results. Use the value returned in the
|
15442
|
+
# previous response in the next request to retrieve the next set of
|
15443
|
+
# results.
|
15444
|
+
# @return [String]
|
15445
|
+
#
|
15446
|
+
# @!attribute [rw] max_results
|
15447
|
+
# The maximum number of results to return per page.
|
15448
|
+
# @return [Integer]
|
15449
|
+
#
|
15450
|
+
# @!attribute [rw] search_criteria
|
15451
|
+
# The search criteria to be used to return predefined attributes.
|
15452
|
+
# @return [Types::PredefinedAttributeSearchCriteria]
|
15453
|
+
#
|
15454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchPredefinedAttributesRequest AWS API Documentation
|
15455
|
+
#
|
15456
|
+
class SearchPredefinedAttributesRequest < Struct.new(
|
15457
|
+
:instance_id,
|
15458
|
+
:next_token,
|
15459
|
+
:max_results,
|
15460
|
+
:search_criteria)
|
15461
|
+
SENSITIVE = []
|
15462
|
+
include Aws::Structure
|
15463
|
+
end
|
15464
|
+
|
15465
|
+
# @!attribute [rw] predefined_attributes
|
15466
|
+
# Predefined attributes matched by the search criteria.
|
15467
|
+
# @return [Array<Types::PredefinedAttribute>]
|
15468
|
+
#
|
15469
|
+
# @!attribute [rw] next_token
|
15470
|
+
# The token for the next set of results. Use the value returned in the
|
15471
|
+
# previous response in the next request to retrieve the next set of
|
15472
|
+
# results.
|
15473
|
+
# @return [String]
|
15474
|
+
#
|
15475
|
+
# @!attribute [rw] approximate_total_count
|
15476
|
+
# The approximate number of predefined attributes which matched your
|
15477
|
+
# search query.
|
15478
|
+
# @return [Integer]
|
15479
|
+
#
|
15480
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchPredefinedAttributesResponse AWS API Documentation
|
15481
|
+
#
|
15482
|
+
class SearchPredefinedAttributesResponse < Struct.new(
|
15483
|
+
:predefined_attributes,
|
15484
|
+
:next_token,
|
15485
|
+
:approximate_total_count)
|
15486
|
+
SENSITIVE = []
|
15487
|
+
include Aws::Structure
|
15488
|
+
end
|
15489
|
+
|
14763
15490
|
# @!attribute [rw] instance_id
|
14764
15491
|
# The identifier of the Amazon Connect instance. You can [find the
|
14765
15492
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -15293,6 +16020,49 @@ module Aws::Connect
|
|
15293
16020
|
include Aws::Structure
|
15294
16021
|
end
|
15295
16022
|
|
16023
|
+
# A structure that defines search criteria based on user-defined contact
|
16024
|
+
# attributes that are configured for contact search.
|
16025
|
+
#
|
16026
|
+
# @!attribute [rw] criteria
|
16027
|
+
# The list of criteria based on user-defined contact attributes that
|
16028
|
+
# are configured for contact search.
|
16029
|
+
# @return [Array<Types::SearchableContactAttributesCriteria>]
|
16030
|
+
#
|
16031
|
+
# @!attribute [rw] match_type
|
16032
|
+
# The match type combining search criteria using multiple searchable
|
16033
|
+
# contact attributes.
|
16034
|
+
# @return [String]
|
16035
|
+
#
|
16036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableContactAttributes AWS API Documentation
|
16037
|
+
#
|
16038
|
+
class SearchableContactAttributes < Struct.new(
|
16039
|
+
:criteria,
|
16040
|
+
:match_type)
|
16041
|
+
SENSITIVE = []
|
16042
|
+
include Aws::Structure
|
16043
|
+
end
|
16044
|
+
|
16045
|
+
# The search criteria based on user-defned contact attribute key and
|
16046
|
+
# values to search on.
|
16047
|
+
#
|
16048
|
+
# @!attribute [rw] key
|
16049
|
+
# The key containing a searchable user-defined contact attribute.
|
16050
|
+
# @return [String]
|
16051
|
+
#
|
16052
|
+
# @!attribute [rw] values
|
16053
|
+
# The list of values to search for within a user-defined contact
|
16054
|
+
# attribute.
|
16055
|
+
# @return [Array<String>]
|
16056
|
+
#
|
16057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchableContactAttributesCriteria AWS API Documentation
|
16058
|
+
#
|
16059
|
+
class SearchableContactAttributesCriteria < Struct.new(
|
16060
|
+
:key,
|
16061
|
+
:values)
|
16062
|
+
SENSITIVE = [:key]
|
16063
|
+
include Aws::Structure
|
16064
|
+
end
|
16065
|
+
|
15296
16066
|
# Configuration information of the security key.
|
15297
16067
|
#
|
15298
16068
|
# @!attribute [rw] association_id
|
@@ -15403,6 +16173,11 @@ module Aws::Connect
|
|
15403
16173
|
# @!attribute [rw] string_condition
|
15404
16174
|
# A leaf node condition which can be used to specify a string
|
15405
16175
|
# condition.
|
16176
|
+
#
|
16177
|
+
# <note markdown="1"> The currently supported values for `FieldName` are `name` and
|
16178
|
+
# `description`.
|
16179
|
+
#
|
16180
|
+
# </note>
|
15406
16181
|
# @return [Types::StringCondition]
|
15407
16182
|
#
|
15408
16183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfileSearchCriteria AWS API Documentation
|
@@ -15714,6 +16489,25 @@ module Aws::Connect
|
|
15714
16489
|
include Aws::Structure
|
15715
16490
|
end
|
15716
16491
|
|
16492
|
+
# A structure that defineds the field name to sort by and a sort order.
|
16493
|
+
#
|
16494
|
+
# @!attribute [rw] field_name
|
16495
|
+
# The name of the field on which to sort.
|
16496
|
+
# @return [String]
|
16497
|
+
#
|
16498
|
+
# @!attribute [rw] order
|
16499
|
+
# An ascending or descending sort.
|
16500
|
+
# @return [String]
|
16501
|
+
#
|
16502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Sort AWS API Documentation
|
16503
|
+
#
|
16504
|
+
class Sort < Struct.new(
|
16505
|
+
:field_name,
|
16506
|
+
:order)
|
16507
|
+
SENSITIVE = []
|
16508
|
+
include Aws::Structure
|
16509
|
+
end
|
16510
|
+
|
15717
16511
|
# @!attribute [rw] instance_id
|
15718
16512
|
# The identifier of the Amazon Connect instance. You can [find the
|
15719
16513
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -16544,6 +17338,11 @@ module Aws::Connect
|
|
16544
17338
|
|
16545
17339
|
# A leaf node condition which can be used to specify a string condition.
|
16546
17340
|
#
|
17341
|
+
# <note markdown="1"> The currently supported values for `FieldName` are `name` and
|
17342
|
+
# `description`.
|
17343
|
+
#
|
17344
|
+
# </note>
|
17345
|
+
#
|
16547
17346
|
# @!attribute [rw] field_name
|
16548
17347
|
# The name of the field in the string condition.
|
16549
17348
|
# @return [String]
|
@@ -17268,6 +18067,55 @@ module Aws::Connect
|
|
17268
18067
|
include Aws::Structure
|
17269
18068
|
end
|
17270
18069
|
|
18070
|
+
# A structure that defines search criteria and matching logic to search
|
18071
|
+
# for contacts by matching text with transcripts analyzed by Amazon
|
18072
|
+
# Connect Contact Lens.
|
18073
|
+
#
|
18074
|
+
# @!attribute [rw] criteria
|
18075
|
+
# The list of search criteria based on Contact Lens conversational
|
18076
|
+
# analytics transcript.
|
18077
|
+
# @return [Array<Types::TranscriptCriteria>]
|
18078
|
+
#
|
18079
|
+
# @!attribute [rw] match_type
|
18080
|
+
# The match type combining search criteria using multiple transcript
|
18081
|
+
# criteria.
|
18082
|
+
# @return [String]
|
18083
|
+
#
|
18084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Transcript AWS API Documentation
|
18085
|
+
#
|
18086
|
+
class Transcript < Struct.new(
|
18087
|
+
:criteria,
|
18088
|
+
:match_type)
|
18089
|
+
SENSITIVE = []
|
18090
|
+
include Aws::Structure
|
18091
|
+
end
|
18092
|
+
|
18093
|
+
# A structure that defines search criteria base on words or phrases,
|
18094
|
+
# participants in the Contact Lens conversational analytics transcript.
|
18095
|
+
#
|
18096
|
+
# @!attribute [rw] participant_role
|
18097
|
+
# The participant role in a transcript
|
18098
|
+
# @return [String]
|
18099
|
+
#
|
18100
|
+
# @!attribute [rw] search_text
|
18101
|
+
# The words or phrases used to search within a transcript.
|
18102
|
+
# @return [Array<String>]
|
18103
|
+
#
|
18104
|
+
# @!attribute [rw] match_type
|
18105
|
+
# The match type combining search criteria using multiple search texts
|
18106
|
+
# in a transcript criteria.
|
18107
|
+
# @return [String]
|
18108
|
+
#
|
18109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TranscriptCriteria AWS API Documentation
|
18110
|
+
#
|
18111
|
+
class TranscriptCriteria < Struct.new(
|
18112
|
+
:participant_role,
|
18113
|
+
:search_text,
|
18114
|
+
:match_type)
|
18115
|
+
SENSITIVE = []
|
18116
|
+
include Aws::Structure
|
18117
|
+
end
|
18118
|
+
|
17271
18119
|
# @!attribute [rw] instance_id
|
17272
18120
|
# The identifier of the Amazon Connect instance. You can [find the
|
17273
18121
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -17759,6 +18607,48 @@ module Aws::Connect
|
|
17759
18607
|
#
|
17760
18608
|
class UpdateContactResponse < Aws::EmptyStructure; end
|
17761
18609
|
|
18610
|
+
# @!attribute [rw] instance_id
|
18611
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
18612
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
18613
|
+
#
|
18614
|
+
#
|
18615
|
+
#
|
18616
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
18617
|
+
# @return [String]
|
18618
|
+
#
|
18619
|
+
# @!attribute [rw] contact_id
|
18620
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
18621
|
+
# @return [String]
|
18622
|
+
#
|
18623
|
+
# @!attribute [rw] queue_time_adjustment_seconds
|
18624
|
+
# The number of seconds to add or subtract from the contact's routing
|
18625
|
+
# age. Contacts are routed to agents on a first-come, first-serve
|
18626
|
+
# basis. This means that changing their amount of time in queue
|
18627
|
+
# compared to others also changes their position in queue.
|
18628
|
+
# @return [Integer]
|
18629
|
+
#
|
18630
|
+
# @!attribute [rw] queue_priority
|
18631
|
+
# Priority of the contact in the queue. The default priority for new
|
18632
|
+
# contacts is 5. You can raise the priority of a contact compared to
|
18633
|
+
# other contacts in the queue by assigning them a higher priority,
|
18634
|
+
# such as 1 or 2.
|
18635
|
+
# @return [Integer]
|
18636
|
+
#
|
18637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingDataRequest AWS API Documentation
|
18638
|
+
#
|
18639
|
+
class UpdateContactRoutingDataRequest < Struct.new(
|
18640
|
+
:instance_id,
|
18641
|
+
:contact_id,
|
18642
|
+
:queue_time_adjustment_seconds,
|
18643
|
+
:queue_priority)
|
18644
|
+
SENSITIVE = []
|
18645
|
+
include Aws::Structure
|
18646
|
+
end
|
18647
|
+
|
18648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactRoutingDataResponse AWS API Documentation
|
18649
|
+
#
|
18650
|
+
class UpdateContactRoutingDataResponse < Aws::EmptyStructure; end
|
18651
|
+
|
17762
18652
|
# @!attribute [rw] instance_id
|
17763
18653
|
# The identifier of the Amazon Connect instance. You can [find the
|
17764
18654
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -18138,6 +19028,29 @@ module Aws::Connect
|
|
18138
19028
|
include Aws::Structure
|
18139
19029
|
end
|
18140
19030
|
|
19031
|
+
# @!attribute [rw] instance_id
|
19032
|
+
# The identifier of the Amazon Connect instance. You can find the
|
19033
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
19034
|
+
# @return [String]
|
19035
|
+
#
|
19036
|
+
# @!attribute [rw] name
|
19037
|
+
# The name of the predefined attribute.
|
19038
|
+
# @return [String]
|
19039
|
+
#
|
19040
|
+
# @!attribute [rw] values
|
19041
|
+
# The values of the predefined attribute.
|
19042
|
+
# @return [Types::PredefinedAttributeValues]
|
19043
|
+
#
|
19044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePredefinedAttributeRequest AWS API Documentation
|
19045
|
+
#
|
19046
|
+
class UpdatePredefinedAttributeRequest < Struct.new(
|
19047
|
+
:instance_id,
|
19048
|
+
:name,
|
19049
|
+
:values)
|
19050
|
+
SENSITIVE = []
|
19051
|
+
include Aws::Structure
|
19052
|
+
end
|
19053
|
+
|
18141
19054
|
# @!attribute [rw] instance_id
|
18142
19055
|
# The identifier of the Amazon Connect instance. You can [find the
|
18143
19056
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -18953,6 +19866,31 @@ module Aws::Connect
|
|
18953
19866
|
include Aws::Structure
|
18954
19867
|
end
|
18955
19868
|
|
19869
|
+
# @!attribute [rw] instance_id
|
19870
|
+
# The identifier of the Amazon Connect instance. You can find the
|
19871
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
19872
|
+
# @return [String]
|
19873
|
+
#
|
19874
|
+
# @!attribute [rw] user_id
|
19875
|
+
# The identifier of the user account.
|
19876
|
+
# @return [String]
|
19877
|
+
#
|
19878
|
+
# @!attribute [rw] user_proficiencies
|
19879
|
+
# The proficiencies to be updated for the user. Proficiencies must
|
19880
|
+
# first be associated to the user. You can do this using
|
19881
|
+
# AssociateUserProficiencies API.
|
19882
|
+
# @return [Array<Types::UserProficiency>]
|
19883
|
+
#
|
19884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserProficienciesRequest AWS API Documentation
|
19885
|
+
#
|
19886
|
+
class UpdateUserProficienciesRequest < Struct.new(
|
19887
|
+
:instance_id,
|
19888
|
+
:user_id,
|
19889
|
+
:user_proficiencies)
|
19890
|
+
SENSITIVE = []
|
19891
|
+
include Aws::Structure
|
19892
|
+
end
|
19893
|
+
|
18956
19894
|
# @!attribute [rw] routing_profile_id
|
18957
19895
|
# The identifier of the routing profile for the user.
|
18958
19896
|
# @return [String]
|
@@ -19415,6 +20353,51 @@ module Aws::Connect
|
|
19415
20353
|
include Aws::Structure
|
19416
20354
|
end
|
19417
20355
|
|
20356
|
+
# Information about proficiency of a user.
|
20357
|
+
#
|
20358
|
+
# @!attribute [rw] attribute_name
|
20359
|
+
# The name of user's proficiency. You must use name of predefined
|
20360
|
+
# attribute present in the Amazon Connect instance.
|
20361
|
+
# @return [String]
|
20362
|
+
#
|
20363
|
+
# @!attribute [rw] attribute_value
|
20364
|
+
# The value of user's proficiency. You must use value of predefined
|
20365
|
+
# attribute present in the Amazon Connect instance.
|
20366
|
+
# @return [String]
|
20367
|
+
#
|
20368
|
+
# @!attribute [rw] level
|
20369
|
+
# The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
|
20370
|
+
# @return [Float]
|
20371
|
+
#
|
20372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserProficiency AWS API Documentation
|
20373
|
+
#
|
20374
|
+
class UserProficiency < Struct.new(
|
20375
|
+
:attribute_name,
|
20376
|
+
:attribute_value,
|
20377
|
+
:level)
|
20378
|
+
SENSITIVE = []
|
20379
|
+
include Aws::Structure
|
20380
|
+
end
|
20381
|
+
|
20382
|
+
# Information about proficiency to be disassociated from the user.
|
20383
|
+
#
|
20384
|
+
# @!attribute [rw] attribute_name
|
20385
|
+
# The name of user's proficiency.
|
20386
|
+
# @return [String]
|
20387
|
+
#
|
20388
|
+
# @!attribute [rw] attribute_value
|
20389
|
+
# The value of user's proficiency.
|
20390
|
+
# @return [String]
|
20391
|
+
#
|
20392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserProficiencyDisassociate AWS API Documentation
|
20393
|
+
#
|
20394
|
+
class UserProficiencyDisassociate < Struct.new(
|
20395
|
+
:attribute_name,
|
20396
|
+
:attribute_value)
|
20397
|
+
SENSITIVE = []
|
20398
|
+
include Aws::Structure
|
20399
|
+
end
|
20400
|
+
|
19418
20401
|
# Contains information about the quick connect configuration settings
|
19419
20402
|
# for a user. The contact flow must be of type Transfer to Agent.
|
19420
20403
|
#
|
@@ -19477,10 +20460,9 @@ module Aws::Connect
|
|
19477
20460
|
# A leaf node condition which can be used to specify a string
|
19478
20461
|
# condition.
|
19479
20462
|
#
|
19480
|
-
#
|
19481
|
-
# `
|
19482
|
-
#
|
19483
|
-
# </note>
|
20463
|
+
# The currently supported values for `FieldName` are `username`,
|
20464
|
+
# `firstname`, `lastname`, `resourceId`, `routingProfileId`,
|
20465
|
+
# `securityProfileId`, `agentGroupId`, and `agentGroupPathIds`.
|
19484
20466
|
# @return [Types::StringCondition]
|
19485
20467
|
#
|
19486
20468
|
# @!attribute [rw] hierarchy_group_condition
|