Skip to content

Commit ecf269c

Browse files
author
awstools
committed
feat(client-connect): Supervisor Barge for Chat is now supported through the MonitorContact API.
1 parent e2471e2 commit ecf269c

File tree

9 files changed

+87
-27
lines changed

9 files changed

+87
-27
lines changed

clients/client-connect/src/commands/CreateParticipantCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface CreateParticipantCommandOutput extends CreateParticipantRespons
4141
* ContactId: "STRING_VALUE", // required
4242
* ClientToken: "STRING_VALUE",
4343
* ParticipantDetails: { // ParticipantDetailsToAdd
44-
* ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT",
44+
* ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT" || "SUPERVISOR",
4545
* DisplayName: "STRING_VALUE",
4646
* },
4747
* };

clients/client-connect/src/commands/DescribeInstanceAttributeCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ export interface DescribeInstanceAttributeCommandOutput extends DescribeInstance
3838
* const client = new ConnectClient(config);
3939
* const input = { // DescribeInstanceAttributeRequest
4040
* InstanceId: "STRING_VALUE", // required
41-
* AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING", // required
41+
* AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING" || "ENHANCED_CHAT_MONITORING", // required
4242
* };
4343
* const command = new DescribeInstanceAttributeCommand(input);
4444
* const response = await client.send(command);
4545
* // { // DescribeInstanceAttributeResponse
4646
* // Attribute: { // Attribute
47-
* // AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING",
47+
* // AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING" || "ENHANCED_CHAT_MONITORING",
4848
* // Value: "STRING_VALUE",
4949
* // },
5050
* // };

clients/client-connect/src/commands/ListInstanceAttributesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ListInstanceAttributesCommandOutput extends ListInstanceAttribu
4646
* // { // ListInstanceAttributesResponse
4747
* // Attributes: [ // AttributesList
4848
* // { // Attribute
49-
* // AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING",
49+
* // AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING" || "ENHANCED_CHAT_MONITORING",
5050
* // Value: "STRING_VALUE",
5151
* // },
5252
* // ],

clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export interface ListRealtimeContactAnalysisSegmentsV2CommandOutput
6464
* // Transcript: { // RealTimeContactAnalysisSegmentTranscript
6565
* // Id: "STRING_VALUE", // required
6666
* // ParticipantId: "STRING_VALUE", // required
67-
* // ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT", // required
67+
* // ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT" || "SUPERVISOR", // required
6868
* // DisplayName: "STRING_VALUE",
6969
* // Content: "STRING_VALUE", // required
7070
* // ContentType: "STRING_VALUE",
@@ -116,7 +116,7 @@ export interface ListRealtimeContactAnalysisSegmentsV2CommandOutput
116116
* // Event: { // RealTimeContactAnalysisSegmentEvent
117117
* // Id: "STRING_VALUE", // required
118118
* // ParticipantId: "STRING_VALUE",
119-
* // ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT",
119+
* // ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT" || "SUPERVISOR",
120120
* // DisplayName: "STRING_VALUE",
121121
* // EventType: "STRING_VALUE", // required
122122
* // Time: {// Union: only one key present
@@ -126,7 +126,7 @@ export interface ListRealtimeContactAnalysisSegmentsV2CommandOutput
126126
* // Attachments: { // RealTimeContactAnalysisSegmentAttachments
127127
* // Id: "STRING_VALUE", // required
128128
* // ParticipantId: "STRING_VALUE", // required
129-
* // ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT", // required
129+
* // ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT" || "SUPERVISOR", // required
130130
* // DisplayName: "STRING_VALUE",
131131
* // Attachments: [ // RealTimeContactAnalysisAttachments // required
132132
* // { // RealTimeContactAnalysisAttachment

clients/client-connect/src/commands/SearchContactsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export interface SearchContactsCommandOutput extends SearchContactsResponse, __M
7474
* Transcript: { // Transcript
7575
* Criteria: [ // TranscriptCriteriaList // required
7676
* { // TranscriptCriteria
77-
* ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT", // required
77+
* ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT" || "SUPERVISOR", // required
7878
* SearchText: [ // SearchTextList // required
7979
* "STRING_VALUE",
8080
* ],

clients/client-connect/src/commands/UpdateInstanceAttributeCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface UpdateInstanceAttributeCommandOutput extends __MetadataBearer {
3838
* const client = new ConnectClient(config);
3939
* const input = { // UpdateInstanceAttributeRequest
4040
* InstanceId: "STRING_VALUE", // required
41-
* AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING", // required
41+
* AttributeType: "INBOUND_CALLS" || "OUTBOUND_CALLS" || "CONTACTFLOW_LOGS" || "CONTACT_LENS" || "AUTO_RESOLVE_BEST_VOICES" || "USE_CUSTOM_TTS_VOICES" || "EARLY_MEDIA" || "MULTI_PARTY_CONFERENCE" || "HIGH_VOLUME_OUTBOUND" || "ENHANCED_CONTACT_MONITORING" || "ENHANCED_CHAT_MONITORING", // required
4242
* Value: "STRING_VALUE", // required
4343
* };
4444
* const command = new UpdateInstanceAttributeCommand(input);

clients/client-connect/src/models/models_0.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3076,6 +3076,7 @@ export const ParticipantRole = {
30763076
AGENT: "AGENT",
30773077
CUSTOMER: "CUSTOMER",
30783078
CUSTOM_BOT: "CUSTOM_BOT",
3079+
SUPERVISOR: "SUPERVISOR",
30793080
SYSTEM: "SYSTEM",
30803081
} as const;
30813082

@@ -6423,6 +6424,12 @@ export interface EvaluationNote {
64236424
/**
64246425
* @public
64256426
* <p>The note for an item (section or question) in a contact evaluation.</p>
6427+
* <note>
6428+
* <p>Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the
6429+
* total number of chars for all the notes in the evaluation combined. Assuming there are N
6430+
* questions in the evaluation being submitted, then the max char limit for all notes combined is N
6431+
* x 1024.</p>
6432+
* </note>
64266433
*/
64276434
Value?: string;
64286435
}
@@ -7003,6 +7010,7 @@ export const InstanceAttributeType = {
70037010
CONTACTFLOW_LOGS: "CONTACTFLOW_LOGS",
70047011
CONTACT_LENS: "CONTACT_LENS",
70057012
EARLY_MEDIA: "EARLY_MEDIA",
7013+
ENHANCED_CHAT_MONITORING: "ENHANCED_CHAT_MONITORING",
70067014
ENHANCED_CONTACT_MONITORING: "ENHANCED_CONTACT_MONITORING",
70077015
HIGH_VOLUME_OUTBOUND: "HIGH_VOLUME_OUTBOUND",
70087016
INBOUND_CALLS: "INBOUND_CALLS",

clients/client-connect/src/models/models_1.ts

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2049,10 +2049,15 @@ export interface GetCurrentMetricDataRequest {
20492049
* <li>
20502050
* <p>Channels: 3 (VOICE, CHAT, and TASK channels are supported.)</p>
20512051
* </li>
2052+
* <li>
2053+
* <p>RoutingStepExpressions: 50</p>
2054+
* </li>
20522055
* </ul>
20532056
* <p>Metric data is retrieved only for the resources associated with the queues or routing
20542057
* profiles, and by any channels included in the filter. (You cannot filter by both queue AND
2055-
* routing profile.) You can include both resource IDs and resource ARNs in the same request. </p>
2058+
* routing profile.) You can include both resource IDs and resource ARNs in the same request.</p>
2059+
* <p>When using <code>RoutingStepExpression</code>, you need to pass exactly one
2060+
* <code>QueueId</code>.</p>
20562061
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
20572062
*/
20582063
Filters: Filters | undefined;
@@ -2077,6 +2082,10 @@ export interface GetCurrentMetricDataRequest {
20772082
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
20782083
* returned.</p>
20792084
* </li>
2085+
* <li>
2086+
* <p>When using the <code>RoutingStepExpression</code> filter, group by
2087+
* <code>ROUTING_STEP_EXPRESSION</code> is required.</p>
2088+
* </li>
20802089
* </ul>
20812090
*/
20822091
Groupings?: Grouping[];
@@ -2160,6 +2169,11 @@ export interface GetCurrentMetricDataRequest {
21602169
* <code>\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \}, "Value": 24113.0
21612170
* </code>\}</p>
21622171
* <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p>
2172+
* <p>When the filter <code>RoutingStepExpression</code> is used, this metric is still
2173+
* calculated from enqueue time. For example, if a contact that has been queued under
2174+
* <code><Expression 1></code> for 10 seconds has expired and <code><Expression 2></code>
2175+
* becomes active, then <code>OLDEST_CONTACT_AGE</code> for this queue will be counted starting
2176+
* from 10, not 0.</p>
21632177
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time">Oldest</a>
21642178
* </p>
21652179
* </dd>
@@ -2873,6 +2887,8 @@ export interface GetMetricDataRequest {
28732887
* <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is
28742888
* retrieved only for the resources associated with the queues or channels included in the filter.
28752889
* You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
2890+
* <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
2891+
* GetMetricDataV2 for more up-to-date features.</p>
28762892
* <note>
28772893
* <p>To filter by <code>Queues</code>, enter the queue
28782894
* ID/ARN, not the name of the queue.</p>
@@ -2886,6 +2902,8 @@ export interface GetMetricDataRequest {
28862902
* queue, the metrics returned are grouped by queue. The values returned apply to the metrics for
28872903
* each queue rather than aggregated for all queues.</p>
28882904
* <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
2905+
* <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
2906+
* GetMetricDataV2 for more up-to-date features.</p>
28892907
*/
28902908
Groupings?: Grouping[];
28912909

@@ -3396,6 +3414,9 @@ export interface GetMetricDataV2Request {
33963414
* <li>
33973415
* <p>Feature</p>
33983416
* </li>
3417+
* <li>
3418+
* <p>Routing step expression</p>
3419+
* </li>
33993420
* </ul>
34003421
* <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
34013422
* groups.</p>
@@ -3411,7 +3432,8 @@ export interface GetMetricDataV2Request {
34113432
* <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
34123433
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
34133434
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
3414-
* <code>FEATURE</code> | <code>contact/segmentAttributes/connect:Subtype</code>
3435+
* <code>FEATURE</code> | <code>contact/segmentAttributes/connect:Subtype</code> |
3436+
* <code>ROUTING_STEP_EXPRESSION</code>
34153437
* </p>
34163438
* </li>
34173439
* <li>
@@ -3429,6 +3451,8 @@ export interface GetMetricDataV2Request {
34293451
* <code>connect:Chat</code>, <code>connect:SMS</code>, <code>connect:Telephony</code>, and
34303452
* <code>connect:WebRTC</code> are valid <code>filterValue</code> examples (not exhaustive) for
34313453
* the <code>contact/segmentAttributes/connect:Subtype filter</code> key.</p>
3454+
* <p>ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000
3455+
* length.</p>
34323456
* </li>
34333457
* </ul>
34343458
*/
@@ -3444,7 +3468,8 @@ export interface GetMetricDataV2Request {
34443468
* | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
34453469
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
34463470
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>,
3447-
* <code>contact/segmentAttributes/connect:Subtype</code>
3471+
* <code>contact/segmentAttributes/connect:Subtype</code> |
3472+
* <code>ROUTING_STEP_EXPRESSION</code>
34483473
* </p>
34493474
*/
34503475
Groupings?: string[];
@@ -3572,7 +3597,7 @@ export interface GetMetricDataV2Request {
35723597
* <dd>
35733598
* <p>Unit: Seconds</p>
35743599
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
3575-
* contact/segmentAttributes/connect:Subtype</p>
3600+
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p>
35763601
* <note>
35773602
* <p>Feature is a valid filter but not a valid grouping.</p>
35783603
* </note>
@@ -3685,7 +3710,7 @@ export interface GetMetricDataV2Request {
36853710
* <dd>
36863711
* <p>Unit: Count</p>
36873712
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3688-
* contact/segmentAttributes/connect:Subtype</p>
3713+
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p>
36893714
* </dd>
36903715
* <dt>CONTACTS_CREATED</dt>
36913716
* <dd>
@@ -3705,7 +3730,7 @@ export interface GetMetricDataV2Request {
37053730
* <code>DISCONNECT_REASON</code>
37063731
* </p>
37073732
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
3708-
* contact/segmentAttributes/connect:Subtype</p>
3733+
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p>
37093734
* <note>
37103735
* <p>Feature is a valid filter but not a valid grouping.</p>
37113736
* </note>
@@ -3783,6 +3808,16 @@ export interface GetMetricDataV2Request {
37833808
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
37843809
* contact/segmentAttributes/connect:Subtype</p>
37853810
* </dd>
3811+
* <dt>PERCENT_CONTACTS_STEP_EXPIRED</dt>
3812+
* <dd>
3813+
* <p>Unit: Percent</p>
3814+
* <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
3815+
* </dd>
3816+
* <dt>PERCENT_CONTACTS_STEP_JOINED</dt>
3817+
* <dd>
3818+
* <p>Unit: Percent</p>
3819+
* <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
3820+
* </dd>
37863821
* <dt>PERCENT_NON_TALK_TIME</dt>
37873822
* <dd>
37883823
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -3824,6 +3859,11 @@ export interface GetMetricDataV2Request {
38243859
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
38253860
* "Less than"). </p>
38263861
* </dd>
3862+
* <dt>STEP_CONTACTS_QUEUED</dt>
3863+
* <dd>
3864+
* <p>Unit: Count</p>
3865+
* <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
3866+
* </dd>
38273867
* <dt>SUM_AFTER_CONTACT_WORK_TIME</dt>
38283868
* <dd>
38293869
* <p>Unit: Seconds</p>
@@ -8577,7 +8617,7 @@ export interface MonitorContactRequest {
85778617
/**
85788618
* @public
85798619
* <p>Specify which monitoring actions the user is allowed to take. For example, whether the user
8580-
* is allowed to escalate from silent monitoring to barge.</p>
8620+
* is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.</p>
85818621
*/
85828622
AllowedMonitorCapabilities?: MonitorCapability[];
85838623

0 commit comments

Comments
 (0)