Skip to content

Commit 9a1aa1e

Browse files
author
AWS
committed
Amazon Connect Service Update: This release adds a new API, GetCurrentUserData, which returns real-time details about users' current activity.
1 parent 2e5f4df commit 9a1aa1e

File tree

3 files changed

+282
-2
lines changed

3 files changed

+282
-2
lines changed

‎.changes/next-release/feature-AmazonConnectService-79dcc90.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Connect Service",
4+
"contributor": "",
5+
"description": "This release adds a new API, GetCurrentUserData, which returns real-time details about users' current activity."
6+
}

‎services/connect/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
"limit_key": "MaxResults",
66
"output_token": "NextToken"
77
},
8+
"GetCurrentUserData": {
9+
"input_token": "NextToken",
10+
"limit_key": "MaxResults",
11+
"output_token": "NextToken"
12+
},
813
"GetMetricData": {
914
"input_token": "NextToken",
1015
"limit_key": "MaxResults",

‎services/connect/src/main/resources/codegen-resources/service-2.json

Lines changed: 271 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,6 +1149,23 @@
11491149
],
11501150
"documentation":"<p>Gets the real-time metric data from the specified Amazon Connect instance.</p> <p>For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
11511151
},
1152+
"GetCurrentUserData":{
1153+
"name":"GetCurrentUserData",
1154+
"http":{
1155+
"method":"POST",
1156+
"requestUri":"/metrics/userdata/{InstanceId}"
1157+
},
1158+
"input":{"shape":"GetCurrentUserDataRequest"},
1159+
"output":{"shape":"GetCurrentUserDataResponse"},
1160+
"errors":[
1161+
{"shape":"InvalidRequestException"},
1162+
{"shape":"InvalidParameterException"},
1163+
{"shape":"InternalServiceException"},
1164+
{"shape":"ThrottlingException"},
1165+
{"shape":"ResourceNotFoundException"}
1166+
],
1167+
"documentation":"<p>Gets the real-time active user data from the specified Amazon Connect instance. </p>"
1168+
},
11521169
"GetFederationToken":{
11531170
"name":"GetFederationToken",
11541171
"http":{
@@ -2573,6 +2590,41 @@
25732590
"type":"integer",
25742591
"min":0
25752592
},
2593+
"AgentContactReference":{
2594+
"type":"structure",
2595+
"members":{
2596+
"ContactId":{
2597+
"shape":"ContactId",
2598+
"documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>"
2599+
},
2600+
"Channel":{
2601+
"shape":"Channel",
2602+
"documentation":"<p>The channel of the contact.</p>"
2603+
},
2604+
"InitiationMethod":{
2605+
"shape":"ContactInitiationMethod",
2606+
"documentation":"<p>How the contact was initiated.</p>"
2607+
},
2608+
"AgentContactState":{
2609+
"shape":"ContactState",
2610+
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">state of the contact</a>.</p>"
2611+
},
2612+
"StateStartTimestamp":{
2613+
"shape":"Timestamp",
2614+
"documentation":"<p>The epoch timestamp when the contact state started.</p>"
2615+
},
2616+
"ConnectedToAgentTimestamp":{
2617+
"shape":"Timestamp",
2618+
"documentation":"<p>The time at which the contact was connected to an agent.</p>"
2619+
},
2620+
"Queue":{"shape":"QueueReference"}
2621+
},
2622+
"documentation":"<p>Information about the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html\">contact</a> associated to the user.</p>"
2623+
},
2624+
"AgentContactReferenceList":{
2625+
"type":"list",
2626+
"member":{"shape":"AgentContactReference"}
2627+
},
25762628
"AgentFirstName":{
25772629
"type":"string",
25782630
"max":100,
@@ -2656,6 +2708,20 @@
26562708
"max":50,
26572709
"min":1
26582710
},
2711+
"AgentStatusReference":{
2712+
"type":"structure",
2713+
"members":{
2714+
"StatusStartTimestamp":{
2715+
"shape":"Timestamp",
2716+
"documentation":"<p>The start timestamp of the agent's status.</p>"
2717+
},
2718+
"StatusArn":{
2719+
"shape":"ARN",
2720+
"documentation":"<p>The Amazon Resource Name (ARN) of the agent's status.</p>"
2721+
}
2722+
},
2723+
"documentation":"<p>Information about the agent's status.</p>"
2724+
},
26592725
"AgentStatusState":{
26602726
"type":"string",
26612727
"enum":[
@@ -3070,6 +3136,11 @@
30703136
"TASK"
30713137
]
30723138
},
3139+
"ChannelToCountMap":{
3140+
"type":"map",
3141+
"key":{"shape":"Channel"},
3142+
"value":{"shape":"IntegerCount"}
3143+
},
30733144
"Channels":{
30743145
"type":"list",
30753146
"member":{"shape":"Channel"},
@@ -3289,6 +3360,16 @@
32893360
},
32903361
"documentation":"<p>Contains information about a contact.</p>"
32913362
},
3363+
"ContactFilter":{
3364+
"type":"structure",
3365+
"members":{
3366+
"ContactStates":{
3367+
"shape":"ContactStates",
3368+
"documentation":"<p>A list of up to 9 <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">contact states</a>.</p>"
3369+
}
3370+
},
3371+
"documentation":"<p>Filters user data based on the contact information that is associated to the users. It contains a list of <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html\">contact states</a>.</p>"
3372+
},
32923373
"ContactFlow":{
32933374
"type":"structure",
32943375
"members":{
@@ -3535,6 +3616,25 @@
35353616
"key":{"shape":"ReferenceKey"},
35363617
"value":{"shape":"Reference"}
35373618
},
3619+
"ContactState":{
3620+
"type":"string",
3621+
"enum":[
3622+
"INCOMING",
3623+
"PENDING",
3624+
"CONNECTING",
3625+
"CONNECTED",
3626+
"CONNECTED_ONHOLD",
3627+
"MISSED",
3628+
"ERROR",
3629+
"ENDED",
3630+
"REJECTED"
3631+
]
3632+
},
3633+
"ContactStates":{
3634+
"type":"list",
3635+
"member":{"shape":"ContactState"},
3636+
"max":9
3637+
},
35383638
"ControlPlaneTagFilter":{
35393639
"type":"structure",
35403640
"members":{
@@ -5671,6 +5771,47 @@
56715771
}
56725772
}
56735773
},
5774+
"GetCurrentUserDataRequest":{
5775+
"type":"structure",
5776+
"required":[
5777+
"InstanceId",
5778+
"Filters"
5779+
],
5780+
"members":{
5781+
"InstanceId":{
5782+
"shape":"InstanceId",
5783+
"documentation":"<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
5784+
"location":"uri",
5785+
"locationName":"InstanceId"
5786+
},
5787+
"Filters":{
5788+
"shape":"UserDataFilters",
5789+
"documentation":"<p>Filters up to 100 <code>Queues</code>, or up to 9 <code>ContactStates</code>. The user data is retrieved only for those users who are associated with the queues and have contacts that are in the specified <code>ContactState</code>. </p>"
5790+
},
5791+
"NextToken":{
5792+
"shape":"NextToken",
5793+
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"
5794+
},
5795+
"MaxResults":{
5796+
"shape":"MaxResult100",
5797+
"documentation":"<p>The maximum number of results to return per page.</p>",
5798+
"box":true
5799+
}
5800+
}
5801+
},
5802+
"GetCurrentUserDataResponse":{
5803+
"type":"structure",
5804+
"members":{
5805+
"NextToken":{
5806+
"shape":"NextToken",
5807+
"documentation":"<p>If there are additional results, this is the token for the next set of results.</p>"
5808+
},
5809+
"UserDataList":{
5810+
"shape":"UserDataList",
5811+
"documentation":"<p>A list of the user data that is returned.</p>"
5812+
}
5813+
}
5814+
},
56745815
"GetFederationTokenRequest":{
56755816
"type":"structure",
56765817
"required":["InstanceId"],
@@ -5928,6 +6069,20 @@
59286069
"type":"list",
59296070
"member":{"shape":"HierarchyGroupSummary"}
59306071
},
6072+
"HierarchyGroupSummaryReference":{
6073+
"type":"structure",
6074+
"members":{
6075+
"Id":{
6076+
"shape":"HierarchyGroupId",
6077+
"documentation":"<p>The unique identifier for the hierarchy group.</p>"
6078+
},
6079+
"Arn":{
6080+
"shape":"ARN",
6081+
"documentation":"<p>The Amazon Resource Name (ARN) for the hierarchy group. </p>"
6082+
}
6083+
},
6084+
"documentation":"<p>Information about the hierarchy group.</p>"
6085+
},
59316086
"HierarchyLevel":{
59326087
"type":"structure",
59336088
"members":{
@@ -5985,6 +6140,32 @@
59856140
},
59866141
"documentation":"<p>Contains information about the levels of a hierarchy group.</p>"
59876142
},
6143+
"HierarchyPathReference":{
6144+
"type":"structure",
6145+
"members":{
6146+
"LevelOne":{
6147+
"shape":"HierarchyGroupSummaryReference",
6148+
"documentation":"<p>Information about level one.</p>"
6149+
},
6150+
"LevelTwo":{
6151+
"shape":"HierarchyGroupSummaryReference",
6152+
"documentation":"<p>Information about level two.</p>"
6153+
},
6154+
"LevelThree":{
6155+
"shape":"HierarchyGroupSummaryReference",
6156+
"documentation":"<p>Information about level three.</p>"
6157+
},
6158+
"LevelFour":{
6159+
"shape":"HierarchyGroupSummaryReference",
6160+
"documentation":"<p>Information about level four.</p>"
6161+
},
6162+
"LevelFive":{
6163+
"shape":"HierarchyGroupSummaryReference",
6164+
"documentation":"<p>Information about level five.</p>"
6165+
}
6166+
},
6167+
"documentation":"<p>Information about the levels in the hierarchy group.</p>"
6168+
},
59886169
"HierarchyStructure":{
59896170
"type":"structure",
59906171
"members":{
@@ -6456,6 +6637,10 @@
64566637
"type":"list",
64576638
"member":{"shape":"InstanceSummary"}
64586639
},
6640+
"IntegerCount":{
6641+
"type":"integer",
6642+
"min":0
6643+
},
64596644
"IntegrationAssociationId":{
64606645
"type":"string",
64616646
"max":200,
@@ -9253,6 +9438,20 @@
92539438
"type":"list",
92549439
"member":{"shape":"RoutingProfileQueueReference"}
92559440
},
9441+
"RoutingProfileReference":{
9442+
"type":"structure",
9443+
"members":{
9444+
"Id":{
9445+
"shape":"RoutingProfileId",
9446+
"documentation":"<p>The identifier of the routing profile.</p>"
9447+
},
9448+
"Arn":{
9449+
"shape":"ARN",
9450+
"documentation":"<p>The Amazon Resource Name (ARN) of the routing profile.</p>"
9451+
}
9452+
},
9453+
"documentation":"<p>Information about the routing profile assigned to the user.</p>"
9454+
},
92569455
"RoutingProfileSummary":{
92579456
"type":"structure",
92589457
"members":{
@@ -10277,7 +10476,7 @@
1027710476
},
1027810477
"ContactId":{
1027910478
"shape":"ContactId",
10280-
"documentation":"<p>The identifier of the contact in this instance of Amazon Connect </p>"
10479+
"documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>"
1028110480
},
1028210481
"QueueId":{
1028310482
"shape":"QueueId",
@@ -10303,7 +10502,7 @@
1030310502
"members":{
1030410503
"ContactId":{
1030510504
"shape":"ContactId",
10306-
"documentation":"<p>The identifier of the contact in this instance of Amazon Connect </p>"
10505+
"documentation":"<p>The identifier of the contact in this instance of Amazon Connect. </p>"
1030710506
},
1030810507
"ContactArn":{
1030910508
"shape":"ARN",
@@ -11475,6 +11674,62 @@
1147511674
},
1147611675
"documentation":"<p>Contains information about a user account for a Amazon Connect instance.</p>"
1147711676
},
11677+
"UserData":{
11678+
"type":"structure",
11679+
"members":{
11680+
"User":{
11681+
"shape":"UserReference",
11682+
"documentation":"<p>Information about the user for the data that is returned. It contains resourceId and ARN of the user. </p>"
11683+
},
11684+
"RoutingProfile":{
11685+
"shape":"RoutingProfileReference",
11686+
"documentation":"<p>Information about the routing profile that is assigned to the user.</p>"
11687+
},
11688+
"HierarchyPath":{
11689+
"shape":"HierarchyPathReference",
11690+
"documentation":"<p>Contains information about the levels of a hierarchy group assigned to a user.</p>"
11691+
},
11692+
"Status":{
11693+
"shape":"AgentStatusReference",
11694+
"documentation":"<p>The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.</p>"
11695+
},
11696+
"AvailableSlotsByChannel":{
11697+
"shape":"ChannelToCountMap",
11698+
"documentation":"<p>A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots. </p>"
11699+
},
11700+
"MaxSlotsByChannel":{
11701+
"shape":"ChannelToCountMap",
11702+
"documentation":"<p>A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html\">MediaConcurrency</a> of the RoutingProfile assigned to the agent. </p>"
11703+
},
11704+
"ActiveSlotsByChannel":{
11705+
"shape":"ChannelToCountMap",
11706+
"documentation":"<p> A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots. </p>"
11707+
},
11708+
"Contacts":{
11709+
"shape":"AgentContactReferenceList",
11710+
"documentation":"<p>A list of contact reference information.</p>"
11711+
}
11712+
},
11713+
"documentation":"<p>Data for a user.</p>"
11714+
},
11715+
"UserDataFilters":{
11716+
"type":"structure",
11717+
"members":{
11718+
"Queues":{
11719+
"shape":"Queues",
11720+
"documentation":"<p>Contains information about a queue resource for which metrics are returned.</p>"
11721+
},
11722+
"ContactFilter":{
11723+
"shape":"ContactFilter",
11724+
"documentation":"<p>A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states. </p>"
11725+
}
11726+
},
11727+
"documentation":"<p>A filter for the user data.</p>"
11728+
},
11729+
"UserDataList":{
11730+
"type":"list",
11731+
"member":{"shape":"UserData"}
11732+
},
1147811733
"UserId":{"type":"string"},
1147911734
"UserIdentityInfo":{
1148011735
"type":"structure",
@@ -11558,6 +11813,20 @@
1155811813
},
1155911814
"documentation":"<p>Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.</p>"
1156011815
},
11816+
"UserReference":{
11817+
"type":"structure",
11818+
"members":{
11819+
"Id":{
11820+
"shape":"UserId",
11821+
"documentation":"<p>The unique identifier for the user.</p>"
11822+
},
11823+
"Arn":{
11824+
"shape":"ARN",
11825+
"documentation":"<p>The Amazon Resource Name (ARN) for the user.</p>"
11826+
}
11827+
},
11828+
"documentation":"<p>Information about the user.</p>"
11829+
},
1156111830
"UserSearchConditionList":{
1156211831
"type":"list",
1156311832
"member":{"shape":"UserSearchCriteria"}

0 commit comments

Comments
 (0)