aws-sdk-connect 1.72.0 → 1.73.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +88 -2
- data/lib/aws-sdk-connect/client_api.rb +104 -0
- data/lib/aws-sdk-connect/types.rb +353 -2
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9bfe9fe7c29b4272b1deef88a97bb0d5f53dbb4ae936ddf5a8be1020ee5266a0
|
4
|
+
data.tar.gz: ee7f3ad382277b51fafea5c84e691139d559e39dfd96e463e6d7191f71e22f1f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 60953ce322f59650c946418b7f9966ff59ab83b63ebcebb87eccc843f8251c23d14dbcaf21fe502be08943be2eeefa6680caed1dc10bfddecc1421f7bb78ce88
|
7
|
+
data.tar.gz: 2ce7c8c821fe5f144e6731baa24ff548a55f366df71669a4975a62561865be92deec4d078840c31c90c69012cd06ae1d00978324b6ec6eece3255b6a4c4f4af4
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.73.0 (2022-06-06)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds a new API, GetCurrentUserData, which returns real-time details about users' current activity.
|
8
|
+
|
4
9
|
1.72.0 (2022-06-02)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.73.0
|
@@ -3488,6 +3488,92 @@ module Aws::Connect
|
|
3488
3488
|
req.send_request(options)
|
3489
3489
|
end
|
3490
3490
|
|
3491
|
+
# Gets the real-time active user data from the specified Amazon Connect
|
3492
|
+
# instance.
|
3493
|
+
#
|
3494
|
+
# @option params [required, String] :instance_id
|
3495
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3496
|
+
# instanceId in the ARN of the instance.
|
3497
|
+
#
|
3498
|
+
# @option params [required, Types::UserDataFilters] :filters
|
3499
|
+
# Filters up to 100 `Queues`, or up to 9 `ContactStates`. The user data
|
3500
|
+
# is retrieved only for those users who are associated with the queues
|
3501
|
+
# and have contacts that are in the specified `ContactState`.
|
3502
|
+
#
|
3503
|
+
# @option params [String] :next_token
|
3504
|
+
# The token for the next set of results. Use the value returned in the
|
3505
|
+
# previous response in the next request to retrieve the next set of
|
3506
|
+
# results.
|
3507
|
+
#
|
3508
|
+
# @option params [Integer] :max_results
|
3509
|
+
# The maximum number of results to return per page.
|
3510
|
+
#
|
3511
|
+
# @return [Types::GetCurrentUserDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3512
|
+
#
|
3513
|
+
# * {Types::GetCurrentUserDataResponse#next_token #next_token} => String
|
3514
|
+
# * {Types::GetCurrentUserDataResponse#user_data_list #user_data_list} => Array<Types::UserData>
|
3515
|
+
#
|
3516
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3517
|
+
#
|
3518
|
+
# @example Request syntax with placeholder values
|
3519
|
+
#
|
3520
|
+
# resp = client.get_current_user_data({
|
3521
|
+
# instance_id: "InstanceId", # required
|
3522
|
+
# filters: { # required
|
3523
|
+
# queues: ["QueueId"],
|
3524
|
+
# contact_filter: {
|
3525
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
3526
|
+
# },
|
3527
|
+
# },
|
3528
|
+
# next_token: "NextToken",
|
3529
|
+
# max_results: 1,
|
3530
|
+
# })
|
3531
|
+
#
|
3532
|
+
# @example Response structure
|
3533
|
+
#
|
3534
|
+
# resp.next_token #=> String
|
3535
|
+
# resp.user_data_list #=> Array
|
3536
|
+
# resp.user_data_list[0].user.id #=> String
|
3537
|
+
# resp.user_data_list[0].user.arn #=> String
|
3538
|
+
# resp.user_data_list[0].routing_profile.id #=> String
|
3539
|
+
# resp.user_data_list[0].routing_profile.arn #=> String
|
3540
|
+
# resp.user_data_list[0].hierarchy_path.level_one.id #=> String
|
3541
|
+
# resp.user_data_list[0].hierarchy_path.level_one.arn #=> String
|
3542
|
+
# resp.user_data_list[0].hierarchy_path.level_two.id #=> String
|
3543
|
+
# resp.user_data_list[0].hierarchy_path.level_two.arn #=> String
|
3544
|
+
# resp.user_data_list[0].hierarchy_path.level_three.id #=> String
|
3545
|
+
# resp.user_data_list[0].hierarchy_path.level_three.arn #=> String
|
3546
|
+
# resp.user_data_list[0].hierarchy_path.level_four.id #=> String
|
3547
|
+
# resp.user_data_list[0].hierarchy_path.level_four.arn #=> String
|
3548
|
+
# resp.user_data_list[0].hierarchy_path.level_five.id #=> String
|
3549
|
+
# resp.user_data_list[0].hierarchy_path.level_five.arn #=> String
|
3550
|
+
# resp.user_data_list[0].status.status_start_timestamp #=> Time
|
3551
|
+
# resp.user_data_list[0].status.status_arn #=> String
|
3552
|
+
# resp.user_data_list[0].available_slots_by_channel #=> Hash
|
3553
|
+
# resp.user_data_list[0].available_slots_by_channel["Channel"] #=> Integer
|
3554
|
+
# resp.user_data_list[0].max_slots_by_channel #=> Hash
|
3555
|
+
# resp.user_data_list[0].max_slots_by_channel["Channel"] #=> Integer
|
3556
|
+
# resp.user_data_list[0].active_slots_by_channel #=> Hash
|
3557
|
+
# resp.user_data_list[0].active_slots_by_channel["Channel"] #=> Integer
|
3558
|
+
# resp.user_data_list[0].contacts #=> Array
|
3559
|
+
# resp.user_data_list[0].contacts[0].contact_id #=> String
|
3560
|
+
# resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
3561
|
+
# resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API"
|
3562
|
+
# resp.user_data_list[0].contacts[0].agent_contact_state #=> String, one of "INCOMING", "PENDING", "CONNECTING", "CONNECTED", "CONNECTED_ONHOLD", "MISSED", "ERROR", "ENDED", "REJECTED"
|
3563
|
+
# resp.user_data_list[0].contacts[0].state_start_timestamp #=> Time
|
3564
|
+
# resp.user_data_list[0].contacts[0].connected_to_agent_timestamp #=> Time
|
3565
|
+
# resp.user_data_list[0].contacts[0].queue.id #=> String
|
3566
|
+
# resp.user_data_list[0].contacts[0].queue.arn #=> String
|
3567
|
+
#
|
3568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserData AWS API Documentation
|
3569
|
+
#
|
3570
|
+
# @overload get_current_user_data(params = {})
|
3571
|
+
# @param [Hash] params ({})
|
3572
|
+
def get_current_user_data(params = {}, options = {})
|
3573
|
+
req = build_request(:get_current_user_data, params)
|
3574
|
+
req.send_request(options)
|
3575
|
+
end
|
3576
|
+
|
3491
3577
|
# Retrieves a token for federation.
|
3492
3578
|
#
|
3493
3579
|
# <note markdown="1"> This API doesn't support root users. If you try to invoke
|
@@ -6559,7 +6645,7 @@ module Aws::Connect
|
|
6559
6645
|
# instanceId in the ARN of the instance.
|
6560
6646
|
#
|
6561
6647
|
# @option params [required, String] :contact_id
|
6562
|
-
# The identifier of the contact in this instance of Amazon Connect
|
6648
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
6563
6649
|
#
|
6564
6650
|
# @option params [String] :queue_id
|
6565
6651
|
# The identifier for the queue.
|
@@ -8097,7 +8183,7 @@ module Aws::Connect
|
|
8097
8183
|
params: params,
|
8098
8184
|
config: config)
|
8099
8185
|
context[:gem_name] = 'aws-sdk-connect'
|
8100
|
-
context[:gem_version] = '1.
|
8186
|
+
context[:gem_version] = '1.73.0'
|
8101
8187
|
Seahorse::Client::Request.new(handlers, context)
|
8102
8188
|
end
|
8103
8189
|
|
@@ -16,6 +16,8 @@ module Aws::Connect
|
|
16
16
|
ARN = Shapes::StringShape.new(name: 'ARN')
|
17
17
|
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
18
18
|
AfterContactWorkTimeLimit = Shapes::IntegerShape.new(name: 'AfterContactWorkTimeLimit')
|
19
|
+
AgentContactReference = Shapes::StructureShape.new(name: 'AgentContactReference')
|
20
|
+
AgentContactReferenceList = Shapes::ListShape.new(name: 'AgentContactReferenceList')
|
19
21
|
AgentFirstName = Shapes::StringShape.new(name: 'AgentFirstName')
|
20
22
|
AgentInfo = Shapes::StructureShape.new(name: 'AgentInfo')
|
21
23
|
AgentLastName = Shapes::StringShape.new(name: 'AgentLastName')
|
@@ -25,6 +27,7 @@ module Aws::Connect
|
|
25
27
|
AgentStatusId = Shapes::StringShape.new(name: 'AgentStatusId')
|
26
28
|
AgentStatusName = Shapes::StringShape.new(name: 'AgentStatusName')
|
27
29
|
AgentStatusOrderNumber = Shapes::IntegerShape.new(name: 'AgentStatusOrderNumber')
|
30
|
+
AgentStatusReference = Shapes::StructureShape.new(name: 'AgentStatusReference')
|
28
31
|
AgentStatusState = Shapes::StringShape.new(name: 'AgentStatusState')
|
29
32
|
AgentStatusSummary = Shapes::StructureShape.new(name: 'AgentStatusSummary')
|
30
33
|
AgentStatusSummaryList = Shapes::ListShape.new(name: 'AgentStatusSummaryList')
|
@@ -62,6 +65,7 @@ module Aws::Connect
|
|
62
65
|
BucketName = Shapes::StringShape.new(name: 'BucketName')
|
63
66
|
CampaignId = Shapes::StringShape.new(name: 'CampaignId')
|
64
67
|
Channel = Shapes::StringShape.new(name: 'Channel')
|
68
|
+
ChannelToCountMap = Shapes::MapShape.new(name: 'ChannelToCountMap')
|
65
69
|
Channels = Shapes::ListShape.new(name: 'Channels')
|
66
70
|
ChatContent = Shapes::StringShape.new(name: 'ChatContent')
|
67
71
|
ChatContentType = Shapes::StringShape.new(name: 'ChatContentType')
|
@@ -77,6 +81,7 @@ module Aws::Connect
|
|
77
81
|
Comparison = Shapes::StringShape.new(name: 'Comparison')
|
78
82
|
Concurrency = Shapes::IntegerShape.new(name: 'Concurrency')
|
79
83
|
Contact = Shapes::StructureShape.new(name: 'Contact')
|
84
|
+
ContactFilter = Shapes::StructureShape.new(name: 'ContactFilter')
|
80
85
|
ContactFlow = Shapes::StructureShape.new(name: 'ContactFlow')
|
81
86
|
ContactFlowContent = Shapes::StringShape.new(name: 'ContactFlowContent')
|
82
87
|
ContactFlowDescription = Shapes::StringShape.new(name: 'ContactFlowDescription')
|
@@ -101,6 +106,8 @@ module Aws::Connect
|
|
101
106
|
ContactInitiationMethod = Shapes::StringShape.new(name: 'ContactInitiationMethod')
|
102
107
|
ContactNotFoundException = Shapes::StructureShape.new(name: 'ContactNotFoundException')
|
103
108
|
ContactReferences = Shapes::MapShape.new(name: 'ContactReferences')
|
109
|
+
ContactState = Shapes::StringShape.new(name: 'ContactState')
|
110
|
+
ContactStates = Shapes::ListShape.new(name: 'ContactStates')
|
104
111
|
ControlPlaneTagFilter = Shapes::StructureShape.new(name: 'ControlPlaneTagFilter')
|
105
112
|
CreateAgentStatusRequest = Shapes::StructureShape.new(name: 'CreateAgentStatusRequest')
|
106
113
|
CreateAgentStatusResponse = Shapes::StructureShape.new(name: 'CreateAgentStatusResponse')
|
@@ -222,6 +229,8 @@ module Aws::Connect
|
|
222
229
|
GetContactAttributesResponse = Shapes::StructureShape.new(name: 'GetContactAttributesResponse')
|
223
230
|
GetCurrentMetricDataRequest = Shapes::StructureShape.new(name: 'GetCurrentMetricDataRequest')
|
224
231
|
GetCurrentMetricDataResponse = Shapes::StructureShape.new(name: 'GetCurrentMetricDataResponse')
|
232
|
+
GetCurrentUserDataRequest = Shapes::StructureShape.new(name: 'GetCurrentUserDataRequest')
|
233
|
+
GetCurrentUserDataResponse = Shapes::StructureShape.new(name: 'GetCurrentUserDataResponse')
|
225
234
|
GetFederationTokenRequest = Shapes::StructureShape.new(name: 'GetFederationTokenRequest')
|
226
235
|
GetFederationTokenResponse = Shapes::StructureShape.new(name: 'GetFederationTokenResponse')
|
227
236
|
GetMetricDataRequest = Shapes::StructureShape.new(name: 'GetMetricDataRequest')
|
@@ -237,11 +246,13 @@ module Aws::Connect
|
|
237
246
|
HierarchyGroupName = Shapes::StringShape.new(name: 'HierarchyGroupName')
|
238
247
|
HierarchyGroupSummary = Shapes::StructureShape.new(name: 'HierarchyGroupSummary')
|
239
248
|
HierarchyGroupSummaryList = Shapes::ListShape.new(name: 'HierarchyGroupSummaryList')
|
249
|
+
HierarchyGroupSummaryReference = Shapes::StructureShape.new(name: 'HierarchyGroupSummaryReference')
|
240
250
|
HierarchyLevel = Shapes::StructureShape.new(name: 'HierarchyLevel')
|
241
251
|
HierarchyLevelId = Shapes::StringShape.new(name: 'HierarchyLevelId')
|
242
252
|
HierarchyLevelName = Shapes::StringShape.new(name: 'HierarchyLevelName')
|
243
253
|
HierarchyLevelUpdate = Shapes::StructureShape.new(name: 'HierarchyLevelUpdate')
|
244
254
|
HierarchyPath = Shapes::StructureShape.new(name: 'HierarchyPath')
|
255
|
+
HierarchyPathReference = Shapes::StructureShape.new(name: 'HierarchyPathReference')
|
245
256
|
HierarchyStructure = Shapes::StructureShape.new(name: 'HierarchyStructure')
|
246
257
|
HierarchyStructureUpdate = Shapes::StructureShape.new(name: 'HierarchyStructureUpdate')
|
247
258
|
HistoricalMetric = Shapes::StructureShape.new(name: 'HistoricalMetric')
|
@@ -276,6 +287,7 @@ module Aws::Connect
|
|
276
287
|
InstanceStorageResourceType = Shapes::StringShape.new(name: 'InstanceStorageResourceType')
|
277
288
|
InstanceSummary = Shapes::StructureShape.new(name: 'InstanceSummary')
|
278
289
|
InstanceSummaryList = Shapes::ListShape.new(name: 'InstanceSummaryList')
|
290
|
+
IntegerCount = Shapes::IntegerShape.new(name: 'IntegerCount')
|
279
291
|
IntegrationAssociationId = Shapes::StringShape.new(name: 'IntegrationAssociationId')
|
280
292
|
IntegrationAssociationSummary = Shapes::StructureShape.new(name: 'IntegrationAssociationSummary')
|
281
293
|
IntegrationAssociationSummaryList = Shapes::ListShape.new(name: 'IntegrationAssociationSummaryList')
|
@@ -471,6 +483,7 @@ module Aws::Connect
|
|
471
483
|
RoutingProfileQueueConfigSummaryList = Shapes::ListShape.new(name: 'RoutingProfileQueueConfigSummaryList')
|
472
484
|
RoutingProfileQueueReference = Shapes::StructureShape.new(name: 'RoutingProfileQueueReference')
|
473
485
|
RoutingProfileQueueReferenceList = Shapes::ListShape.new(name: 'RoutingProfileQueueReferenceList')
|
486
|
+
RoutingProfileReference = Shapes::StructureShape.new(name: 'RoutingProfileReference')
|
474
487
|
RoutingProfileSummary = Shapes::StructureShape.new(name: 'RoutingProfileSummary')
|
475
488
|
RoutingProfileSummaryList = Shapes::ListShape.new(name: 'RoutingProfileSummaryList')
|
476
489
|
S3Config = Shapes::StructureShape.new(name: 'S3Config')
|
@@ -610,12 +623,16 @@ module Aws::Connect
|
|
610
623
|
UseCaseSummaryList = Shapes::ListShape.new(name: 'UseCaseSummaryList')
|
611
624
|
UseCaseType = Shapes::StringShape.new(name: 'UseCaseType')
|
612
625
|
User = Shapes::StructureShape.new(name: 'User')
|
626
|
+
UserData = Shapes::StructureShape.new(name: 'UserData')
|
627
|
+
UserDataFilters = Shapes::StructureShape.new(name: 'UserDataFilters')
|
628
|
+
UserDataList = Shapes::ListShape.new(name: 'UserDataList')
|
613
629
|
UserId = Shapes::StringShape.new(name: 'UserId')
|
614
630
|
UserIdentityInfo = Shapes::StructureShape.new(name: 'UserIdentityInfo')
|
615
631
|
UserIdentityInfoLite = Shapes::StructureShape.new(name: 'UserIdentityInfoLite')
|
616
632
|
UserNotFoundException = Shapes::StructureShape.new(name: 'UserNotFoundException')
|
617
633
|
UserPhoneConfig = Shapes::StructureShape.new(name: 'UserPhoneConfig')
|
618
634
|
UserQuickConnectConfig = Shapes::StructureShape.new(name: 'UserQuickConnectConfig')
|
635
|
+
UserReference = Shapes::StructureShape.new(name: 'UserReference')
|
619
636
|
UserSearchConditionList = Shapes::ListShape.new(name: 'UserSearchConditionList')
|
620
637
|
UserSearchCriteria = Shapes::StructureShape.new(name: 'UserSearchCriteria')
|
621
638
|
UserSearchFilter = Shapes::StructureShape.new(name: 'UserSearchFilter')
|
@@ -642,6 +659,17 @@ module Aws::Connect
|
|
642
659
|
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
643
660
|
AccessDeniedException.struct_class = Types::AccessDeniedException
|
644
661
|
|
662
|
+
AgentContactReference.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
663
|
+
AgentContactReference.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "Channel"))
|
664
|
+
AgentContactReference.add_member(:initiation_method, Shapes::ShapeRef.new(shape: ContactInitiationMethod, location_name: "InitiationMethod"))
|
665
|
+
AgentContactReference.add_member(:agent_contact_state, Shapes::ShapeRef.new(shape: ContactState, location_name: "AgentContactState"))
|
666
|
+
AgentContactReference.add_member(:state_start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateStartTimestamp"))
|
667
|
+
AgentContactReference.add_member(:connected_to_agent_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ConnectedToAgentTimestamp"))
|
668
|
+
AgentContactReference.add_member(:queue, Shapes::ShapeRef.new(shape: QueueReference, location_name: "Queue"))
|
669
|
+
AgentContactReference.struct_class = Types::AgentContactReference
|
670
|
+
|
671
|
+
AgentContactReferenceList.member = Shapes::ShapeRef.new(shape: AgentContactReference)
|
672
|
+
|
645
673
|
AgentInfo.add_member(:id, Shapes::ShapeRef.new(shape: AgentResourceId, location_name: "Id"))
|
646
674
|
AgentInfo.add_member(:connected_to_agent_timestamp, Shapes::ShapeRef.new(shape: timestamp, location_name: "ConnectedToAgentTimestamp"))
|
647
675
|
AgentInfo.struct_class = Types::AgentInfo
|
@@ -656,6 +684,10 @@ module Aws::Connect
|
|
656
684
|
AgentStatus.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
657
685
|
AgentStatus.struct_class = Types::AgentStatus
|
658
686
|
|
687
|
+
AgentStatusReference.add_member(:status_start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StatusStartTimestamp"))
|
688
|
+
AgentStatusReference.add_member(:status_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "StatusArn"))
|
689
|
+
AgentStatusReference.struct_class = Types::AgentStatusReference
|
690
|
+
|
659
691
|
AgentStatusSummary.add_member(:id, Shapes::ShapeRef.new(shape: AgentStatusId, location_name: "Id"))
|
660
692
|
AgentStatusSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
661
693
|
AgentStatusSummary.add_member(:name, Shapes::ShapeRef.new(shape: AgentStatusName, location_name: "Name"))
|
@@ -745,6 +777,9 @@ module Aws::Connect
|
|
745
777
|
|
746
778
|
AvailableNumbersList.member = Shapes::ShapeRef.new(shape: AvailableNumberSummary)
|
747
779
|
|
780
|
+
ChannelToCountMap.key = Shapes::ShapeRef.new(shape: Channel)
|
781
|
+
ChannelToCountMap.value = Shapes::ShapeRef.new(shape: IntegerCount)
|
782
|
+
|
748
783
|
Channels.member = Shapes::ShapeRef.new(shape: Channel)
|
749
784
|
|
750
785
|
ChatMessage.add_member(:content_type, Shapes::ShapeRef.new(shape: ChatContentType, required: true, location_name: "ContentType"))
|
@@ -792,6 +827,9 @@ module Aws::Connect
|
|
792
827
|
Contact.add_member(:scheduled_timestamp, Shapes::ShapeRef.new(shape: timestamp, location_name: "ScheduledTimestamp"))
|
793
828
|
Contact.struct_class = Types::Contact
|
794
829
|
|
830
|
+
ContactFilter.add_member(:contact_states, Shapes::ShapeRef.new(shape: ContactStates, location_name: "ContactStates"))
|
831
|
+
ContactFilter.struct_class = Types::ContactFilter
|
832
|
+
|
795
833
|
ContactFlow.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
796
834
|
ContactFlow.add_member(:id, Shapes::ShapeRef.new(shape: ContactFlowId, location_name: "Id"))
|
797
835
|
ContactFlow.add_member(:name, Shapes::ShapeRef.new(shape: ContactFlowName, location_name: "Name"))
|
@@ -840,6 +878,8 @@ module Aws::Connect
|
|
840
878
|
ContactReferences.key = Shapes::ShapeRef.new(shape: ReferenceKey)
|
841
879
|
ContactReferences.value = Shapes::ShapeRef.new(shape: Reference)
|
842
880
|
|
881
|
+
ContactStates.member = Shapes::ShapeRef.new(shape: ContactState)
|
882
|
+
|
843
883
|
ControlPlaneTagFilter.add_member(:or_conditions, Shapes::ShapeRef.new(shape: TagOrConditionList, location_name: "OrConditions"))
|
844
884
|
ControlPlaneTagFilter.add_member(:and_conditions, Shapes::ShapeRef.new(shape: TagAndConditionList, location_name: "AndConditions"))
|
845
885
|
ControlPlaneTagFilter.add_member(:tag_condition, Shapes::ShapeRef.new(shape: TagCondition, location_name: "TagCondition"))
|
@@ -1326,6 +1366,16 @@ module Aws::Connect
|
|
1326
1366
|
GetCurrentMetricDataResponse.add_member(:data_snapshot_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "DataSnapshotTime"))
|
1327
1367
|
GetCurrentMetricDataResponse.struct_class = Types::GetCurrentMetricDataResponse
|
1328
1368
|
|
1369
|
+
GetCurrentUserDataRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
1370
|
+
GetCurrentUserDataRequest.add_member(:filters, Shapes::ShapeRef.new(shape: UserDataFilters, required: true, location_name: "Filters"))
|
1371
|
+
GetCurrentUserDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
1372
|
+
GetCurrentUserDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location_name: "MaxResults", metadata: {"box"=>true}))
|
1373
|
+
GetCurrentUserDataRequest.struct_class = Types::GetCurrentUserDataRequest
|
1374
|
+
|
1375
|
+
GetCurrentUserDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
1376
|
+
GetCurrentUserDataResponse.add_member(:user_data_list, Shapes::ShapeRef.new(shape: UserDataList, location_name: "UserDataList"))
|
1377
|
+
GetCurrentUserDataResponse.struct_class = Types::GetCurrentUserDataResponse
|
1378
|
+
|
1329
1379
|
GetFederationTokenRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
1330
1380
|
GetFederationTokenRequest.struct_class = Types::GetFederationTokenRequest
|
1331
1381
|
|
@@ -1387,6 +1437,10 @@ module Aws::Connect
|
|
1387
1437
|
|
1388
1438
|
HierarchyGroupSummaryList.member = Shapes::ShapeRef.new(shape: HierarchyGroupSummary)
|
1389
1439
|
|
1440
|
+
HierarchyGroupSummaryReference.add_member(:id, Shapes::ShapeRef.new(shape: HierarchyGroupId, location_name: "Id"))
|
1441
|
+
HierarchyGroupSummaryReference.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
1442
|
+
HierarchyGroupSummaryReference.struct_class = Types::HierarchyGroupSummaryReference
|
1443
|
+
|
1390
1444
|
HierarchyLevel.add_member(:id, Shapes::ShapeRef.new(shape: HierarchyLevelId, location_name: "Id"))
|
1391
1445
|
HierarchyLevel.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
1392
1446
|
HierarchyLevel.add_member(:name, Shapes::ShapeRef.new(shape: HierarchyLevelName, location_name: "Name"))
|
@@ -1402,6 +1456,13 @@ module Aws::Connect
|
|
1402
1456
|
HierarchyPath.add_member(:level_five, Shapes::ShapeRef.new(shape: HierarchyGroupSummary, location_name: "LevelFive"))
|
1403
1457
|
HierarchyPath.struct_class = Types::HierarchyPath
|
1404
1458
|
|
1459
|
+
HierarchyPathReference.add_member(:level_one, Shapes::ShapeRef.new(shape: HierarchyGroupSummaryReference, location_name: "LevelOne"))
|
1460
|
+
HierarchyPathReference.add_member(:level_two, Shapes::ShapeRef.new(shape: HierarchyGroupSummaryReference, location_name: "LevelTwo"))
|
1461
|
+
HierarchyPathReference.add_member(:level_three, Shapes::ShapeRef.new(shape: HierarchyGroupSummaryReference, location_name: "LevelThree"))
|
1462
|
+
HierarchyPathReference.add_member(:level_four, Shapes::ShapeRef.new(shape: HierarchyGroupSummaryReference, location_name: "LevelFour"))
|
1463
|
+
HierarchyPathReference.add_member(:level_five, Shapes::ShapeRef.new(shape: HierarchyGroupSummaryReference, location_name: "LevelFive"))
|
1464
|
+
HierarchyPathReference.struct_class = Types::HierarchyPathReference
|
1465
|
+
|
1405
1466
|
HierarchyStructure.add_member(:level_one, Shapes::ShapeRef.new(shape: HierarchyLevel, location_name: "LevelOne"))
|
1406
1467
|
HierarchyStructure.add_member(:level_two, Shapes::ShapeRef.new(shape: HierarchyLevel, location_name: "LevelTwo"))
|
1407
1468
|
HierarchyStructure.add_member(:level_three, Shapes::ShapeRef.new(shape: HierarchyLevel, location_name: "LevelThree"))
|
@@ -2087,6 +2148,10 @@ module Aws::Connect
|
|
2087
2148
|
|
2088
2149
|
RoutingProfileQueueReferenceList.member = Shapes::ShapeRef.new(shape: RoutingProfileQueueReference)
|
2089
2150
|
|
2151
|
+
RoutingProfileReference.add_member(:id, Shapes::ShapeRef.new(shape: RoutingProfileId, location_name: "Id"))
|
2152
|
+
RoutingProfileReference.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
2153
|
+
RoutingProfileReference.struct_class = Types::RoutingProfileReference
|
2154
|
+
|
2090
2155
|
RoutingProfileSummary.add_member(:id, Shapes::ShapeRef.new(shape: RoutingProfileId, location_name: "Id"))
|
2091
2156
|
RoutingProfileSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
2092
2157
|
RoutingProfileSummary.add_member(:name, Shapes::ShapeRef.new(shape: RoutingProfileName, location_name: "Name"))
|
@@ -2581,6 +2646,22 @@ module Aws::Connect
|
|
2581
2646
|
User.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
2582
2647
|
User.struct_class = Types::User
|
2583
2648
|
|
2649
|
+
UserData.add_member(:user, Shapes::ShapeRef.new(shape: UserReference, location_name: "User"))
|
2650
|
+
UserData.add_member(:routing_profile, Shapes::ShapeRef.new(shape: RoutingProfileReference, location_name: "RoutingProfile"))
|
2651
|
+
UserData.add_member(:hierarchy_path, Shapes::ShapeRef.new(shape: HierarchyPathReference, location_name: "HierarchyPath"))
|
2652
|
+
UserData.add_member(:status, Shapes::ShapeRef.new(shape: AgentStatusReference, location_name: "Status"))
|
2653
|
+
UserData.add_member(:available_slots_by_channel, Shapes::ShapeRef.new(shape: ChannelToCountMap, location_name: "AvailableSlotsByChannel"))
|
2654
|
+
UserData.add_member(:max_slots_by_channel, Shapes::ShapeRef.new(shape: ChannelToCountMap, location_name: "MaxSlotsByChannel"))
|
2655
|
+
UserData.add_member(:active_slots_by_channel, Shapes::ShapeRef.new(shape: ChannelToCountMap, location_name: "ActiveSlotsByChannel"))
|
2656
|
+
UserData.add_member(:contacts, Shapes::ShapeRef.new(shape: AgentContactReferenceList, location_name: "Contacts"))
|
2657
|
+
UserData.struct_class = Types::UserData
|
2658
|
+
|
2659
|
+
UserDataFilters.add_member(:queues, Shapes::ShapeRef.new(shape: Queues, location_name: "Queues"))
|
2660
|
+
UserDataFilters.add_member(:contact_filter, Shapes::ShapeRef.new(shape: ContactFilter, location_name: "ContactFilter"))
|
2661
|
+
UserDataFilters.struct_class = Types::UserDataFilters
|
2662
|
+
|
2663
|
+
UserDataList.member = Shapes::ShapeRef.new(shape: UserData)
|
2664
|
+
|
2584
2665
|
UserIdentityInfo.add_member(:first_name, Shapes::ShapeRef.new(shape: AgentFirstName, location_name: "FirstName"))
|
2585
2666
|
UserIdentityInfo.add_member(:last_name, Shapes::ShapeRef.new(shape: AgentLastName, location_name: "LastName"))
|
2586
2667
|
UserIdentityInfo.add_member(:email, Shapes::ShapeRef.new(shape: Email, location_name: "Email"))
|
@@ -2603,6 +2684,10 @@ module Aws::Connect
|
|
2603
2684
|
UserQuickConnectConfig.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId"))
|
2604
2685
|
UserQuickConnectConfig.struct_class = Types::UserQuickConnectConfig
|
2605
2686
|
|
2687
|
+
UserReference.add_member(:id, Shapes::ShapeRef.new(shape: UserId, location_name: "Id"))
|
2688
|
+
UserReference.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
2689
|
+
UserReference.struct_class = Types::UserReference
|
2690
|
+
|
2606
2691
|
UserSearchConditionList.member = Shapes::ShapeRef.new(shape: UserSearchCriteria)
|
2607
2692
|
|
2608
2693
|
UserSearchCriteria.add_member(:or_conditions, Shapes::ShapeRef.new(shape: UserSearchConditionList, location_name: "OrConditions"))
|
@@ -3582,6 +3667,25 @@ module Aws::Connect
|
|
3582
3667
|
)
|
3583
3668
|
end)
|
3584
3669
|
|
3670
|
+
api.add_operation(:get_current_user_data, Seahorse::Model::Operation.new.tap do |o|
|
3671
|
+
o.name = "GetCurrentUserData"
|
3672
|
+
o.http_method = "POST"
|
3673
|
+
o.http_request_uri = "/metrics/userdata/{InstanceId}"
|
3674
|
+
o.input = Shapes::ShapeRef.new(shape: GetCurrentUserDataRequest)
|
3675
|
+
o.output = Shapes::ShapeRef.new(shape: GetCurrentUserDataResponse)
|
3676
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
3677
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
3678
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
3679
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
3680
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
3681
|
+
o[:pager] = Aws::Pager.new(
|
3682
|
+
limit_key: "max_results",
|
3683
|
+
tokens: {
|
3684
|
+
"next_token" => "next_token"
|
3685
|
+
}
|
3686
|
+
)
|
3687
|
+
end)
|
3688
|
+
|
3585
3689
|
api.add_operation(:get_federation_token, Seahorse::Model::Operation.new.tap do |o|
|
3586
3690
|
o.name = "GetFederationToken"
|
3587
3691
|
o.http_method = "GET"
|
@@ -23,6 +23,59 @@ module Aws::Connect
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Information about the [contact][1] associated to the user.
|
27
|
+
#
|
28
|
+
#
|
29
|
+
#
|
30
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html
|
31
|
+
#
|
32
|
+
# @!attribute [rw] contact_id
|
33
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] channel
|
37
|
+
# The channel of the contact.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] initiation_method
|
41
|
+
# How the contact was initiated.
|
42
|
+
# @return [String]
|
43
|
+
#
|
44
|
+
# @!attribute [rw] agent_contact_state
|
45
|
+
# The [state of the contact][1].
|
46
|
+
#
|
47
|
+
#
|
48
|
+
#
|
49
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] state_start_timestamp
|
53
|
+
# The epoch timestamp when the contact state started.
|
54
|
+
# @return [Time]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] connected_to_agent_timestamp
|
57
|
+
# The time at which the contact was connected to an agent.
|
58
|
+
# @return [Time]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] queue
|
61
|
+
# Contains information about a queue resource for which metrics are
|
62
|
+
# returned.
|
63
|
+
# @return [Types::QueueReference]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentContactReference AWS API Documentation
|
66
|
+
#
|
67
|
+
class AgentContactReference < Struct.new(
|
68
|
+
:contact_id,
|
69
|
+
:channel,
|
70
|
+
:initiation_method,
|
71
|
+
:agent_contact_state,
|
72
|
+
:state_start_timestamp,
|
73
|
+
:connected_to_agent_timestamp,
|
74
|
+
:queue)
|
75
|
+
SENSITIVE = []
|
76
|
+
include Aws::Structure
|
77
|
+
end
|
78
|
+
|
26
79
|
# Information about the agent who accepted the contact.
|
27
80
|
#
|
28
81
|
# @!attribute [rw] id
|
@@ -92,6 +145,25 @@ module Aws::Connect
|
|
92
145
|
include Aws::Structure
|
93
146
|
end
|
94
147
|
|
148
|
+
# Information about the agent's status.
|
149
|
+
#
|
150
|
+
# @!attribute [rw] status_start_timestamp
|
151
|
+
# The start timestamp of the agent's status.
|
152
|
+
# @return [Time]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] status_arn
|
155
|
+
# The Amazon Resource Name (ARN) of the agent's status.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatusReference AWS API Documentation
|
159
|
+
#
|
160
|
+
class AgentStatusReference < Struct.new(
|
161
|
+
:status_start_timestamp,
|
162
|
+
:status_arn)
|
163
|
+
SENSITIVE = []
|
164
|
+
include Aws::Structure
|
165
|
+
end
|
166
|
+
|
95
167
|
# Summary information for an agent status.
|
96
168
|
#
|
97
169
|
# @!attribute [rw] id
|
@@ -862,6 +934,36 @@ module Aws::Connect
|
|
862
934
|
include Aws::Structure
|
863
935
|
end
|
864
936
|
|
937
|
+
# Filters user data based on the contact information that is associated
|
938
|
+
# to the users. It contains a list of [contact states][1].
|
939
|
+
#
|
940
|
+
#
|
941
|
+
#
|
942
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
943
|
+
#
|
944
|
+
# @note When making an API call, you may pass ContactFilter
|
945
|
+
# data as a hash:
|
946
|
+
#
|
947
|
+
# {
|
948
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
949
|
+
# }
|
950
|
+
#
|
951
|
+
# @!attribute [rw] contact_states
|
952
|
+
# A list of up to 9 [contact states][1].
|
953
|
+
#
|
954
|
+
#
|
955
|
+
#
|
956
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
957
|
+
# @return [Array<String>]
|
958
|
+
#
|
959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFilter AWS API Documentation
|
960
|
+
#
|
961
|
+
class ContactFilter < Struct.new(
|
962
|
+
:contact_states)
|
963
|
+
SENSITIVE = []
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
865
967
|
# Contains information about a contact flow.
|
866
968
|
#
|
867
969
|
# @!attribute [rw] arn
|
@@ -4149,6 +4251,71 @@ module Aws::Connect
|
|
4149
4251
|
include Aws::Structure
|
4150
4252
|
end
|
4151
4253
|
|
4254
|
+
# @note When making an API call, you may pass GetCurrentUserDataRequest
|
4255
|
+
# data as a hash:
|
4256
|
+
#
|
4257
|
+
# {
|
4258
|
+
# instance_id: "InstanceId", # required
|
4259
|
+
# filters: { # required
|
4260
|
+
# queues: ["QueueId"],
|
4261
|
+
# contact_filter: {
|
4262
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
4263
|
+
# },
|
4264
|
+
# },
|
4265
|
+
# next_token: "NextToken",
|
4266
|
+
# max_results: 1,
|
4267
|
+
# }
|
4268
|
+
#
|
4269
|
+
# @!attribute [rw] instance_id
|
4270
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4271
|
+
# instanceId in the ARN of the instance.
|
4272
|
+
# @return [String]
|
4273
|
+
#
|
4274
|
+
# @!attribute [rw] filters
|
4275
|
+
# Filters up to 100 `Queues`, or up to 9 `ContactStates`. The user
|
4276
|
+
# data is retrieved only for those users who are associated with the
|
4277
|
+
# queues and have contacts that are in the specified `ContactState`.
|
4278
|
+
# @return [Types::UserDataFilters]
|
4279
|
+
#
|
4280
|
+
# @!attribute [rw] next_token
|
4281
|
+
# The token for the next set of results. Use the value returned in the
|
4282
|
+
# previous response in the next request to retrieve the next set of
|
4283
|
+
# results.
|
4284
|
+
# @return [String]
|
4285
|
+
#
|
4286
|
+
# @!attribute [rw] max_results
|
4287
|
+
# The maximum number of results to return per page.
|
4288
|
+
# @return [Integer]
|
4289
|
+
#
|
4290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataRequest AWS API Documentation
|
4291
|
+
#
|
4292
|
+
class GetCurrentUserDataRequest < Struct.new(
|
4293
|
+
:instance_id,
|
4294
|
+
:filters,
|
4295
|
+
:next_token,
|
4296
|
+
:max_results)
|
4297
|
+
SENSITIVE = []
|
4298
|
+
include Aws::Structure
|
4299
|
+
end
|
4300
|
+
|
4301
|
+
# @!attribute [rw] next_token
|
4302
|
+
# If there are additional results, this is the token for the next set
|
4303
|
+
# of results.
|
4304
|
+
# @return [String]
|
4305
|
+
#
|
4306
|
+
# @!attribute [rw] user_data_list
|
4307
|
+
# A list of the user data that is returned.
|
4308
|
+
# @return [Array<Types::UserData>]
|
4309
|
+
#
|
4310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataResponse AWS API Documentation
|
4311
|
+
#
|
4312
|
+
class GetCurrentUserDataResponse < Struct.new(
|
4313
|
+
:next_token,
|
4314
|
+
:user_data_list)
|
4315
|
+
SENSITIVE = []
|
4316
|
+
include Aws::Structure
|
4317
|
+
end
|
4318
|
+
|
4152
4319
|
# @note When making an API call, you may pass GetFederationTokenRequest
|
4153
4320
|
# data as a hash:
|
4154
4321
|
#
|
@@ -4682,6 +4849,25 @@ module Aws::Connect
|
|
4682
4849
|
include Aws::Structure
|
4683
4850
|
end
|
4684
4851
|
|
4852
|
+
# Information about the hierarchy group.
|
4853
|
+
#
|
4854
|
+
# @!attribute [rw] id
|
4855
|
+
# The unique identifier for the hierarchy group.
|
4856
|
+
# @return [String]
|
4857
|
+
#
|
4858
|
+
# @!attribute [rw] arn
|
4859
|
+
# The Amazon Resource Name (ARN) for the hierarchy group.
|
4860
|
+
# @return [String]
|
4861
|
+
#
|
4862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroupSummaryReference AWS API Documentation
|
4863
|
+
#
|
4864
|
+
class HierarchyGroupSummaryReference < Struct.new(
|
4865
|
+
:id,
|
4866
|
+
:arn)
|
4867
|
+
SENSITIVE = []
|
4868
|
+
include Aws::Structure
|
4869
|
+
end
|
4870
|
+
|
4685
4871
|
# Contains information about a hierarchy level.
|
4686
4872
|
#
|
4687
4873
|
# @!attribute [rw] id
|
@@ -4762,6 +4948,40 @@ module Aws::Connect
|
|
4762
4948
|
include Aws::Structure
|
4763
4949
|
end
|
4764
4950
|
|
4951
|
+
# Information about the levels in the hierarchy group.
|
4952
|
+
#
|
4953
|
+
# @!attribute [rw] level_one
|
4954
|
+
# Information about level one.
|
4955
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4956
|
+
#
|
4957
|
+
# @!attribute [rw] level_two
|
4958
|
+
# Information about level two.
|
4959
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4960
|
+
#
|
4961
|
+
# @!attribute [rw] level_three
|
4962
|
+
# Information about level three.
|
4963
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4964
|
+
#
|
4965
|
+
# @!attribute [rw] level_four
|
4966
|
+
# Information about level four.
|
4967
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4968
|
+
#
|
4969
|
+
# @!attribute [rw] level_five
|
4970
|
+
# Information about level five.
|
4971
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4972
|
+
#
|
4973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyPathReference AWS API Documentation
|
4974
|
+
#
|
4975
|
+
class HierarchyPathReference < Struct.new(
|
4976
|
+
:level_one,
|
4977
|
+
:level_two,
|
4978
|
+
:level_three,
|
4979
|
+
:level_four,
|
4980
|
+
:level_five)
|
4981
|
+
SENSITIVE = []
|
4982
|
+
include Aws::Structure
|
4983
|
+
end
|
4984
|
+
|
4765
4985
|
# Contains information about a hierarchy structure.
|
4766
4986
|
#
|
4767
4987
|
# @!attribute [rw] level_one
|
@@ -8345,6 +8565,25 @@ module Aws::Connect
|
|
8345
8565
|
include Aws::Structure
|
8346
8566
|
end
|
8347
8567
|
|
8568
|
+
# Information about the routing profile assigned to the user.
|
8569
|
+
#
|
8570
|
+
# @!attribute [rw] id
|
8571
|
+
# The identifier of the routing profile.
|
8572
|
+
# @return [String]
|
8573
|
+
#
|
8574
|
+
# @!attribute [rw] arn
|
8575
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
8576
|
+
# @return [String]
|
8577
|
+
#
|
8578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileReference AWS API Documentation
|
8579
|
+
#
|
8580
|
+
class RoutingProfileReference < Struct.new(
|
8581
|
+
:id,
|
8582
|
+
:arn)
|
8583
|
+
SENSITIVE = []
|
8584
|
+
include Aws::Structure
|
8585
|
+
end
|
8586
|
+
|
8348
8587
|
# Contains summary information about a routing profile.
|
8349
8588
|
#
|
8350
8589
|
# @!attribute [rw] id
|
@@ -9758,7 +9997,7 @@ module Aws::Connect
|
|
9758
9997
|
# @return [String]
|
9759
9998
|
#
|
9760
9999
|
# @!attribute [rw] contact_id
|
9761
|
-
# The identifier of the contact in this instance of Amazon Connect
|
10000
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9762
10001
|
# @return [String]
|
9763
10002
|
#
|
9764
10003
|
# @!attribute [rw] queue_id
|
@@ -9795,7 +10034,7 @@ module Aws::Connect
|
|
9795
10034
|
end
|
9796
10035
|
|
9797
10036
|
# @!attribute [rw] contact_id
|
9798
|
-
# The identifier of the contact in this instance of Amazon Connect
|
10037
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9799
10038
|
# @return [String]
|
9800
10039
|
#
|
9801
10040
|
# @!attribute [rw] contact_arn
|
@@ -11429,6 +11668,99 @@ module Aws::Connect
|
|
11429
11668
|
include Aws::Structure
|
11430
11669
|
end
|
11431
11670
|
|
11671
|
+
# Data for a user.
|
11672
|
+
#
|
11673
|
+
# @!attribute [rw] user
|
11674
|
+
# Information about the user for the data that is returned. It
|
11675
|
+
# contains resourceId and ARN of the user.
|
11676
|
+
# @return [Types::UserReference]
|
11677
|
+
#
|
11678
|
+
# @!attribute [rw] routing_profile
|
11679
|
+
# Information about the routing profile that is assigned to the user.
|
11680
|
+
# @return [Types::RoutingProfileReference]
|
11681
|
+
#
|
11682
|
+
# @!attribute [rw] hierarchy_path
|
11683
|
+
# Contains information about the levels of a hierarchy group assigned
|
11684
|
+
# to a user.
|
11685
|
+
# @return [Types::HierarchyPathReference]
|
11686
|
+
#
|
11687
|
+
# @!attribute [rw] status
|
11688
|
+
# The status of the agent that they manually set in their Contact
|
11689
|
+
# Control Panel (CCP), or that the supervisor manually changes in the
|
11690
|
+
# real-time metrics report.
|
11691
|
+
# @return [Types::AgentStatusReference]
|
11692
|
+
#
|
11693
|
+
# @!attribute [rw] available_slots_by_channel
|
11694
|
+
# A map of available slots by channel. The key is a channel name. The
|
11695
|
+
# value is an integer: the available number of slots.
|
11696
|
+
# @return [Hash<String,Integer>]
|
11697
|
+
#
|
11698
|
+
# @!attribute [rw] max_slots_by_channel
|
11699
|
+
# A map of maximum slots by channel. The key is a channel name. The
|
11700
|
+
# value is an integer: the maximum number of slots. This is calculated
|
11701
|
+
# from [MediaConcurrency][1] of the RoutingProfile assigned to the
|
11702
|
+
# agent.
|
11703
|
+
#
|
11704
|
+
#
|
11705
|
+
#
|
11706
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html
|
11707
|
+
# @return [Hash<String,Integer>]
|
11708
|
+
#
|
11709
|
+
# @!attribute [rw] active_slots_by_channel
|
11710
|
+
# A map of active slots by channel. The key is a channel name. The
|
11711
|
+
# value is an integer: the number of active slots.
|
11712
|
+
# @return [Hash<String,Integer>]
|
11713
|
+
#
|
11714
|
+
# @!attribute [rw] contacts
|
11715
|
+
# A list of contact reference information.
|
11716
|
+
# @return [Array<Types::AgentContactReference>]
|
11717
|
+
#
|
11718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserData AWS API Documentation
|
11719
|
+
#
|
11720
|
+
class UserData < Struct.new(
|
11721
|
+
:user,
|
11722
|
+
:routing_profile,
|
11723
|
+
:hierarchy_path,
|
11724
|
+
:status,
|
11725
|
+
:available_slots_by_channel,
|
11726
|
+
:max_slots_by_channel,
|
11727
|
+
:active_slots_by_channel,
|
11728
|
+
:contacts)
|
11729
|
+
SENSITIVE = []
|
11730
|
+
include Aws::Structure
|
11731
|
+
end
|
11732
|
+
|
11733
|
+
# A filter for the user data.
|
11734
|
+
#
|
11735
|
+
# @note When making an API call, you may pass UserDataFilters
|
11736
|
+
# data as a hash:
|
11737
|
+
#
|
11738
|
+
# {
|
11739
|
+
# queues: ["QueueId"],
|
11740
|
+
# contact_filter: {
|
11741
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
11742
|
+
# },
|
11743
|
+
# }
|
11744
|
+
#
|
11745
|
+
# @!attribute [rw] queues
|
11746
|
+
# Contains information about a queue resource for which metrics are
|
11747
|
+
# returned.
|
11748
|
+
# @return [Array<String>]
|
11749
|
+
#
|
11750
|
+
# @!attribute [rw] contact_filter
|
11751
|
+
# A filter for the user data based on the contact information that is
|
11752
|
+
# associated to the user. It contains a list of contact states.
|
11753
|
+
# @return [Types::ContactFilter]
|
11754
|
+
#
|
11755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserDataFilters AWS API Documentation
|
11756
|
+
#
|
11757
|
+
class UserDataFilters < Struct.new(
|
11758
|
+
:queues,
|
11759
|
+
:contact_filter)
|
11760
|
+
SENSITIVE = []
|
11761
|
+
include Aws::Structure
|
11762
|
+
end
|
11763
|
+
|
11432
11764
|
# Contains information about the identity of a user.
|
11433
11765
|
#
|
11434
11766
|
# @note When making an API call, you may pass UserIdentityInfo
|
@@ -11566,6 +11898,25 @@ module Aws::Connect
|
|
11566
11898
|
include Aws::Structure
|
11567
11899
|
end
|
11568
11900
|
|
11901
|
+
# Information about the user.
|
11902
|
+
#
|
11903
|
+
# @!attribute [rw] id
|
11904
|
+
# The unique identifier for the user.
|
11905
|
+
# @return [String]
|
11906
|
+
#
|
11907
|
+
# @!attribute [rw] arn
|
11908
|
+
# The Amazon Resource Name (ARN) for the user.
|
11909
|
+
# @return [String]
|
11910
|
+
#
|
11911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserReference AWS API Documentation
|
11912
|
+
#
|
11913
|
+
class UserReference < Struct.new(
|
11914
|
+
:id,
|
11915
|
+
:arn)
|
11916
|
+
SENSITIVE = []
|
11917
|
+
include Aws::Structure
|
11918
|
+
end
|
11919
|
+
|
11569
11920
|
# The search criteria to be used to return users.
|
11570
11921
|
#
|
11571
11922
|
# @note When making an API call, you may pass UserSearchCriteria
|
data/lib/aws-sdk-connect.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.73.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-06-
|
11
|
+
date: 2022-06-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|