@aws-sdk/client-connect 3.614.0 → 3.618.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.
- package/README.md +17 -2
- package/dist-cjs/index.js +227 -31
- package/dist-es/Connect.js +4 -0
- package/dist-es/ConnectClient.js +5 -5
- package/dist-es/commands/SearchAgentStatusesCommand.js +24 -0
- package/dist-es/commands/SearchUserHierarchyGroupsCommand.js +24 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +5 -18
- package/dist-es/models/models_1.js +32 -0
- package/dist-es/models/models_2.js +12 -5
- package/dist-es/pagination/SearchAgentStatusesPaginator.js +4 -0
- package/dist-es/pagination/SearchUserHierarchyGroupsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +118 -2
- package/dist-types/Connect.d.ts +16 -3
- package/dist-types/ConnectClient.d.ts +8 -7
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +6 -1
- package/dist-types/commands/ListTrafficDistributionGroupUsersCommand.d.ts +1 -1
- package/dist-types/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListUseCasesCommand.d.ts +1 -1
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +142 -0
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +181 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +32 -4
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +2 -3
- package/dist-types/models/models_0.d.ts +128 -133
- package/dist-types/models/models_1.d.ts +335 -241
- package/dist-types/models/models_2.d.ts +537 -73
- package/dist-types/pagination/SearchAgentStatusesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchUserHierarchyGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/Connect.d.ts +34 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +14 -2
- package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTrafficDistributionGroupUsersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUseCasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +27 -60
- package/dist-types/ts3.4/models/models_1.d.ts +100 -46
- package/dist-types/ts3.4/models/models_2.d.ts +125 -20
- package/dist-types/ts3.4/pagination/SearchAgentStatusesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchUserHierarchyGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +17 -17
|
@@ -1,6 +1,131 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution,
|
|
3
|
+
import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* @enum
|
|
7
|
+
*/
|
|
8
|
+
export declare const RoutingCriteriaStepStatus: {
|
|
9
|
+
readonly ACTIVE: "ACTIVE";
|
|
10
|
+
readonly EXPIRED: "EXPIRED";
|
|
11
|
+
readonly INACTIVE: "INACTIVE";
|
|
12
|
+
readonly JOINED: "JOINED";
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus];
|
|
18
|
+
/**
|
|
19
|
+
* <p>A value for a segment attribute. This is structured as a map where the key is
|
|
20
|
+
* <code>valueString</code> and the value is a string.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export interface SegmentAttributeValue {
|
|
24
|
+
/**
|
|
25
|
+
* <p>The value of a segment attribute.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
ValueString?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* <p>Information about Amazon Connect Wisdom.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export interface WisdomInfo {
|
|
35
|
+
/**
|
|
36
|
+
* <p>The Amazon Resource Name (ARN) of the Wisdom session.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
SessionArn?: string;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export interface DescribeContactEvaluationRequest {
|
|
45
|
+
/**
|
|
46
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
InstanceId: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
EvaluationId: string | undefined;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* <p>Information about answer data for a contact evaluation. Answer data must be either string,
|
|
58
|
+
* numeric, or not applicable.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.$UnknownMember;
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
export declare namespace EvaluationAnswerData {
|
|
66
|
+
/**
|
|
67
|
+
* <p>The string value for an answer in a contact evaluation.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
interface StringValueMember {
|
|
71
|
+
StringValue: string;
|
|
72
|
+
NumericValue?: never;
|
|
73
|
+
NotApplicable?: never;
|
|
74
|
+
$unknown?: never;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* <p>The numeric value for an answer in a contact evaluation.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
interface NumericValueMember {
|
|
81
|
+
StringValue?: never;
|
|
82
|
+
NumericValue: number;
|
|
83
|
+
NotApplicable?: never;
|
|
84
|
+
$unknown?: never;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* <p>The flag to mark the question as not applicable.</p>
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
interface NotApplicableMember {
|
|
91
|
+
StringValue?: never;
|
|
92
|
+
NumericValue?: never;
|
|
93
|
+
NotApplicable: boolean;
|
|
94
|
+
$unknown?: never;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
interface $UnknownMember {
|
|
100
|
+
StringValue?: never;
|
|
101
|
+
NumericValue?: never;
|
|
102
|
+
NotApplicable?: never;
|
|
103
|
+
$unknown: [string, any];
|
|
104
|
+
}
|
|
105
|
+
interface Visitor<T> {
|
|
106
|
+
StringValue: (value: string) => T;
|
|
107
|
+
NumericValue: (value: number) => T;
|
|
108
|
+
NotApplicable: (value: boolean) => T;
|
|
109
|
+
_: (name: string, value: any) => T;
|
|
110
|
+
}
|
|
111
|
+
const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* <p>Information about output answers for a contact evaluation.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export interface EvaluationAnswerOutput {
|
|
118
|
+
/**
|
|
119
|
+
* <p>The value for an answer in a contact evaluation.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
Value?: EvaluationAnswerData;
|
|
123
|
+
/**
|
|
124
|
+
* <p>The system suggested value for an answer in a contact evaluation.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
SystemSuggestedValue?: EvaluationAnswerData;
|
|
128
|
+
}
|
|
4
129
|
/**
|
|
5
130
|
* <p>Information about scores of a contact evaluation item (section or question).</p>
|
|
6
131
|
* @public
|
|
@@ -3885,7 +4010,8 @@ export interface MetricFilterV2 {
|
|
|
3885
4010
|
*/
|
|
3886
4011
|
export interface ThresholdV2 {
|
|
3887
4012
|
/**
|
|
3888
|
-
* <p>The type of comparison. Only "less than" (LT) comparisons are
|
|
4013
|
+
* <p>The type of comparison. Only "less than" (LT) and "greater than" (GT) comparisons are
|
|
4014
|
+
* supported.</p>
|
|
3889
4015
|
* @public
|
|
3890
4016
|
*/
|
|
3891
4017
|
Comparison?: string;
|
|
@@ -4006,6 +4132,9 @@ export interface GetMetricDataV2Request {
|
|
|
4006
4132
|
* <p>Agents</p>
|
|
4007
4133
|
* </li>
|
|
4008
4134
|
* <li>
|
|
4135
|
+
* <p>Campaigns</p>
|
|
4136
|
+
* </li>
|
|
4137
|
+
* <li>
|
|
4009
4138
|
* <p>Channels</p>
|
|
4010
4139
|
* </li>
|
|
4011
4140
|
* <li>
|
|
@@ -4026,6 +4155,8 @@ export interface GetMetricDataV2Request {
|
|
|
4026
4155
|
* </ul>
|
|
4027
4156
|
* <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
|
|
4028
4157
|
* groups.</p>
|
|
4158
|
+
* <p>For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least
|
|
4159
|
+
* one filter requirement.</p>
|
|
4029
4160
|
* <p>To filter by phone number, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html">Create a historical
|
|
4030
4161
|
* metrics report</a> in the <i>Amazon Connect Administrator
|
|
4031
4162
|
* Guide</i>.</p>
|
|
@@ -4037,15 +4168,15 @@ export interface GetMetricDataV2Request {
|
|
|
4037
4168
|
* a single request. Valid filter keys: <code>AGENT</code> |
|
|
4038
4169
|
* <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> |
|
|
4039
4170
|
* <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> |
|
|
4040
|
-
* <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>
|
|
4041
|
-
* <code>
|
|
4042
|
-
* <code>
|
|
4043
|
-
* <code>
|
|
4044
|
-
* <code>
|
|
4045
|
-
* <code>
|
|
4046
|
-
* <code>
|
|
4047
|
-
* <code>
|
|
4048
|
-
*
|
|
4171
|
+
* <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> |
|
|
4172
|
+
* <code>CAMPAIGN</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
|
|
4173
|
+
* <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> |
|
|
4174
|
+
* <code>DISCONNECT_REASON</code> | <code>FEATURE</code> | <code>FLOW_TYPE</code> |
|
|
4175
|
+
* <code>FLOWS_NEXT_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> |
|
|
4176
|
+
* <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> |
|
|
4177
|
+
* <code>INITIATION_METHOD</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> |
|
|
4178
|
+
* <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> |
|
|
4179
|
+
* <code>Q_CONNECT_ENABLED</code> | </p>
|
|
4049
4180
|
* </li>
|
|
4050
4181
|
* <li>
|
|
4051
4182
|
* <p>
|
|
@@ -4078,6 +4209,9 @@ export interface GetMetricDataV2Request {
|
|
|
4078
4209
|
* </li>
|
|
4079
4210
|
* </ul>
|
|
4080
4211
|
* <p>This filter is available only for contact record-driven metrics. </p>
|
|
4212
|
+
* <p>
|
|
4213
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html">Campaign</a> ARNs are valid <code>filterValues</code> for the <code>CAMPAIGN</code>
|
|
4214
|
+
* filter key.</p>
|
|
4081
4215
|
* </li>
|
|
4082
4216
|
* </ul>
|
|
4083
4217
|
* @public
|
|
@@ -4091,12 +4225,13 @@ export interface GetMetricDataV2Request {
|
|
|
4091
4225
|
* <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
|
|
4092
4226
|
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
|
|
4093
4227
|
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
|
|
4228
|
+
* <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>CAMPAIGN</code> |
|
|
4094
4229
|
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
4095
|
-
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>
|
|
4096
|
-
* <code>
|
|
4097
|
-
* | <code>
|
|
4098
|
-
* <code>
|
|
4099
|
-
*
|
|
4230
|
+
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
4231
|
+
* <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_TYPE</code>
|
|
4232
|
+
* | <code>FLOWS_OUTCOME_TYPE</code> | <code>INITIATION_METHOD</code> |
|
|
4233
|
+
* <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code>
|
|
4234
|
+
* | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code>
|
|
4100
4235
|
* </p>
|
|
4101
4236
|
* @public
|
|
4102
4237
|
*/
|
|
@@ -4260,6 +4395,15 @@ export interface GetMetricDataV2Request {
|
|
|
4260
4395
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical">Average conversation duration</a>
|
|
4261
4396
|
* </p>
|
|
4262
4397
|
* </dd>
|
|
4398
|
+
* <dt>AVG_DIALS_PER_MINUTE</dt>
|
|
4399
|
+
* <dd>
|
|
4400
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns
|
|
4401
|
+
* analytics.</p>
|
|
4402
|
+
* <p>Unit: Count</p>
|
|
4403
|
+
* <p>Valid groupings and filters: Campaign, Agent, Queue, Routing Profile</p>
|
|
4404
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-dials-historical">Average dials per minute</a>
|
|
4405
|
+
* </p>
|
|
4406
|
+
* </dd>
|
|
4263
4407
|
* <dt>AVG_FLOW_TIME</dt>
|
|
4264
4408
|
* <dd>
|
|
4265
4409
|
* <p>Unit: Seconds</p>
|
|
@@ -4420,12 +4564,45 @@ export interface GetMetricDataV2Request {
|
|
|
4420
4564
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical">Average customer talk time</a>
|
|
4421
4565
|
* </p>
|
|
4422
4566
|
* </dd>
|
|
4567
|
+
* <dt>AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION</dt>
|
|
4568
|
+
* <dd>
|
|
4569
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns
|
|
4570
|
+
* analytics.</p>
|
|
4571
|
+
* <p>Unit: Seconds</p>
|
|
4572
|
+
* <p>Valid groupings and filters: Campaign</p>
|
|
4573
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical">Average wait time after customer connection</a>
|
|
4574
|
+
* </p>
|
|
4575
|
+
* </dd>
|
|
4576
|
+
* <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt>
|
|
4577
|
+
* <dd>
|
|
4578
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns
|
|
4579
|
+
* analytics.</p>
|
|
4580
|
+
* <p>Unit: Count</p>
|
|
4581
|
+
* <p>Valid groupings and filters: Campaign, Agent </p>
|
|
4582
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
4583
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for
|
|
4584
|
+
* <i>Greater than</i>).</p>
|
|
4585
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-historical">Campaign contacts abandoned after X</a>
|
|
4586
|
+
* </p>
|
|
4587
|
+
* </dd>
|
|
4588
|
+
* <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE</dt>
|
|
4589
|
+
* <dd>
|
|
4590
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns
|
|
4591
|
+
* analytics.</p>
|
|
4592
|
+
* <p>Unit: Percent</p>
|
|
4593
|
+
* <p>Valid groupings and filters: Campaign, Agent </p>
|
|
4594
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
4595
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for
|
|
4596
|
+
* <i>Greater than</i>).</p>
|
|
4597
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-rate-historical">Campaign contacts abandoned after X rate</a>
|
|
4598
|
+
* </p>
|
|
4599
|
+
* </dd>
|
|
4423
4600
|
* <dt>CASES_CREATED</dt>
|
|
4424
4601
|
* <dd>
|
|
4425
4602
|
* <p>Unit: Count</p>
|
|
4426
4603
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
4427
4604
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
4428
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
|
4605
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-created-historical">Cases created</a>
|
|
4429
4606
|
* </p>
|
|
4430
4607
|
* </dd>
|
|
4431
4608
|
* <dt>CONTACTS_CREATED</dt>
|
|
@@ -4531,7 +4708,8 @@ export interface GetMetricDataV2Request {
|
|
|
4531
4708
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
4532
4709
|
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
4533
4710
|
* "Less than").</p>
|
|
4534
|
-
* <p>UI name:
|
|
4711
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical">Contacts removed from queue in X seconds</a>
|
|
4712
|
+
* </p>
|
|
4535
4713
|
* </dd>
|
|
4536
4714
|
* <dt>CONTACTS_RESOLVED_IN_X</dt>
|
|
4537
4715
|
* <dd>
|
|
@@ -4579,6 +4757,35 @@ export interface GetMetricDataV2Request {
|
|
|
4579
4757
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical">Current cases</a>
|
|
4580
4758
|
* </p>
|
|
4581
4759
|
* </dd>
|
|
4760
|
+
* <dt>DELIVERY_ATTEMPTS</dt>
|
|
4761
|
+
* <dd>
|
|
4762
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns
|
|
4763
|
+
* analytics.</p>
|
|
4764
|
+
* <p>Unit: Count</p>
|
|
4765
|
+
* <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>,
|
|
4766
|
+
* <code>DISCONNECT_REASON</code>
|
|
4767
|
+
* </p>
|
|
4768
|
+
* <p>Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status,
|
|
4769
|
+
* Disconnect Reason</p>
|
|
4770
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempts-historical">Delivery attempts</a>
|
|
4771
|
+
* </p>
|
|
4772
|
+
* </dd>
|
|
4773
|
+
* <dt>DELIVERY_ATTEMPT_DISPOSITION_RATE</dt>
|
|
4774
|
+
* <dd>
|
|
4775
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns analytics, and
|
|
4776
|
+
* with the answering machine detection enabled.</p>
|
|
4777
|
+
* <p>Unit: Percent</p>
|
|
4778
|
+
* <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>,
|
|
4779
|
+
* <code>DISCONNECT_REASON</code>
|
|
4780
|
+
* </p>
|
|
4781
|
+
* <p>Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason</p>
|
|
4782
|
+
* <note>
|
|
4783
|
+
* <p>Answering Machine Detection Status and Disconnect Reason are valid filters but not valid
|
|
4784
|
+
* groupings.</p>
|
|
4785
|
+
* </note>
|
|
4786
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempt-disposition-rate-historical">Delivery attempt disposition rate</a>
|
|
4787
|
+
* </p>
|
|
4788
|
+
* </dd>
|
|
4582
4789
|
* <dt>FLOWS_OUTCOME</dt>
|
|
4583
4790
|
* <dd>
|
|
4584
4791
|
* <p>Unit: Count</p>
|
|
@@ -4596,6 +4803,15 @@ export interface GetMetricDataV2Request {
|
|
|
4596
4803
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical">Flows started</a>
|
|
4597
4804
|
* </p>
|
|
4598
4805
|
* </dd>
|
|
4806
|
+
* <dt>HUMAN_ANSWERED_CALLS</dt>
|
|
4807
|
+
* <dd>
|
|
4808
|
+
* <p>This metric is available only for contacts analyzed by outbound campaigns analytics, and
|
|
4809
|
+
* with the answering machine detection enabled.</p>
|
|
4810
|
+
* <p>Unit: Count</p>
|
|
4811
|
+
* <p>Valid groupings and filters: Campaign, Agent</p>
|
|
4812
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#human-answered-historical">Human answered</a>
|
|
4813
|
+
* </p>
|
|
4814
|
+
* </dd>
|
|
4599
4815
|
* <dt>MAX_FLOW_TIME</dt>
|
|
4600
4816
|
* <dd>
|
|
4601
4817
|
* <p>Unit: Seconds</p>
|
|
@@ -7296,6 +7512,7 @@ export declare const RealTimeContactAnalysisSegmentType: {
|
|
|
7296
7512
|
readonly Categories: "Categories";
|
|
7297
7513
|
readonly Event: "Event";
|
|
7298
7514
|
readonly Issues: "Issues";
|
|
7515
|
+
readonly PostContactSummary: "PostContactSummary";
|
|
7299
7516
|
readonly Transcript: "Transcript";
|
|
7300
7517
|
};
|
|
7301
7518
|
/**
|
|
@@ -7615,6 +7832,85 @@ export interface RealTimeContactAnalysisSegmentIssues {
|
|
|
7615
7832
|
*/
|
|
7616
7833
|
IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined;
|
|
7617
7834
|
}
|
|
7835
|
+
/**
|
|
7836
|
+
* @public
|
|
7837
|
+
* @enum
|
|
7838
|
+
*/
|
|
7839
|
+
export declare const RealTimeContactAnalysisPostContactSummaryFailureCode: {
|
|
7840
|
+
readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
|
|
7841
|
+
readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
|
|
7842
|
+
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
7843
|
+
readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
|
|
7844
|
+
readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
|
|
7845
|
+
};
|
|
7846
|
+
/**
|
|
7847
|
+
* @public
|
|
7848
|
+
*/
|
|
7849
|
+
export type RealTimeContactAnalysisPostContactSummaryFailureCode = (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode];
|
|
7850
|
+
/**
|
|
7851
|
+
* @public
|
|
7852
|
+
* @enum
|
|
7853
|
+
*/
|
|
7854
|
+
export declare const RealTimeContactAnalysisPostContactSummaryStatus: {
|
|
7855
|
+
readonly COMPLETED: "COMPLETED";
|
|
7856
|
+
readonly FAILED: "FAILED";
|
|
7857
|
+
};
|
|
7858
|
+
/**
|
|
7859
|
+
* @public
|
|
7860
|
+
*/
|
|
7861
|
+
export type RealTimeContactAnalysisPostContactSummaryStatus = (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus];
|
|
7862
|
+
/**
|
|
7863
|
+
* <p>Information about the post-contact summary for a real-time contact segment.</p>
|
|
7864
|
+
* @public
|
|
7865
|
+
*/
|
|
7866
|
+
export interface RealTimeContactAnalysisSegmentPostContactSummary {
|
|
7867
|
+
/**
|
|
7868
|
+
* <p>The content of the summary.</p>
|
|
7869
|
+
* @public
|
|
7870
|
+
*/
|
|
7871
|
+
Content?: string;
|
|
7872
|
+
/**
|
|
7873
|
+
* <p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>
|
|
7874
|
+
* @public
|
|
7875
|
+
*/
|
|
7876
|
+
Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
|
|
7877
|
+
/**
|
|
7878
|
+
* <p>If the summary failed to be generated, one of the following failure codes
|
|
7879
|
+
* occurs:</p>
|
|
7880
|
+
* <ul>
|
|
7881
|
+
* <li>
|
|
7882
|
+
* <p>
|
|
7883
|
+
* <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached
|
|
7884
|
+
* your service quota.</p>
|
|
7885
|
+
* </li>
|
|
7886
|
+
* <li>
|
|
7887
|
+
* <p>
|
|
7888
|
+
* <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have
|
|
7889
|
+
* at least one turn from both the participants in order to generate the
|
|
7890
|
+
* summary.</p>
|
|
7891
|
+
* </li>
|
|
7892
|
+
* <li>
|
|
7893
|
+
* <p>
|
|
7894
|
+
* <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be
|
|
7895
|
+
* provided because it failed to meet system safety guidelines.</p>
|
|
7896
|
+
* </li>
|
|
7897
|
+
* <li>
|
|
7898
|
+
* <p>
|
|
7899
|
+
* <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for
|
|
7900
|
+
* example, you're using a
|
|
7901
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a>
|
|
7902
|
+
* that isn't supported by generative AI-powered post-contact summaries.
|
|
7903
|
+
* </p>
|
|
7904
|
+
* </li>
|
|
7905
|
+
* <li>
|
|
7906
|
+
* <p>
|
|
7907
|
+
* <code>INTERNAL_ERROR</code>: Internal system error.</p>
|
|
7908
|
+
* </li>
|
|
7909
|
+
* </ul>
|
|
7910
|
+
* @public
|
|
7911
|
+
*/
|
|
7912
|
+
FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode;
|
|
7913
|
+
}
|
|
7618
7914
|
/**
|
|
7619
7915
|
* <p>Object describing redaction applied to the segment.</p>
|
|
7620
7916
|
* @public
|
|
@@ -7697,7 +7993,7 @@ export interface RealTimeContactAnalysisSegmentTranscript {
|
|
|
7697
7993
|
* <p>An analyzed segment for a real-time analysis session.</p>
|
|
7698
7994
|
* @public
|
|
7699
7995
|
*/
|
|
7700
|
-
export type RealtimeContactAnalysisSegment = RealtimeContactAnalysisSegment.AttachmentsMember | RealtimeContactAnalysisSegment.CategoriesMember | RealtimeContactAnalysisSegment.EventMember | RealtimeContactAnalysisSegment.IssuesMember | RealtimeContactAnalysisSegment.TranscriptMember | RealtimeContactAnalysisSegment.$UnknownMember;
|
|
7996
|
+
export type RealtimeContactAnalysisSegment = RealtimeContactAnalysisSegment.AttachmentsMember | RealtimeContactAnalysisSegment.CategoriesMember | RealtimeContactAnalysisSegment.EventMember | RealtimeContactAnalysisSegment.IssuesMember | RealtimeContactAnalysisSegment.PostContactSummaryMember | RealtimeContactAnalysisSegment.TranscriptMember | RealtimeContactAnalysisSegment.$UnknownMember;
|
|
7701
7997
|
/**
|
|
7702
7998
|
* @public
|
|
7703
7999
|
*/
|
|
@@ -7712,6 +8008,7 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7712
8008
|
Issues?: never;
|
|
7713
8009
|
Event?: never;
|
|
7714
8010
|
Attachments?: never;
|
|
8011
|
+
PostContactSummary?: never;
|
|
7715
8012
|
$unknown?: never;
|
|
7716
8013
|
}
|
|
7717
8014
|
/**
|
|
@@ -7724,6 +8021,7 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7724
8021
|
Issues?: never;
|
|
7725
8022
|
Event?: never;
|
|
7726
8023
|
Attachments?: never;
|
|
8024
|
+
PostContactSummary?: never;
|
|
7727
8025
|
$unknown?: never;
|
|
7728
8026
|
}
|
|
7729
8027
|
/**
|
|
@@ -7736,6 +8034,7 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7736
8034
|
Issues: RealTimeContactAnalysisSegmentIssues;
|
|
7737
8035
|
Event?: never;
|
|
7738
8036
|
Attachments?: never;
|
|
8037
|
+
PostContactSummary?: never;
|
|
7739
8038
|
$unknown?: never;
|
|
7740
8039
|
}
|
|
7741
8040
|
/**
|
|
@@ -7748,6 +8047,7 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7748
8047
|
Issues?: never;
|
|
7749
8048
|
Event: RealTimeContactAnalysisSegmentEvent;
|
|
7750
8049
|
Attachments?: never;
|
|
8050
|
+
PostContactSummary?: never;
|
|
7751
8051
|
$unknown?: never;
|
|
7752
8052
|
}
|
|
7753
8053
|
/**
|
|
@@ -7760,6 +8060,20 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7760
8060
|
Issues?: never;
|
|
7761
8061
|
Event?: never;
|
|
7762
8062
|
Attachments: RealTimeContactAnalysisSegmentAttachments;
|
|
8063
|
+
PostContactSummary?: never;
|
|
8064
|
+
$unknown?: never;
|
|
8065
|
+
}
|
|
8066
|
+
/**
|
|
8067
|
+
* <p>Information about the post-contact summary.</p>
|
|
8068
|
+
* @public
|
|
8069
|
+
*/
|
|
8070
|
+
interface PostContactSummaryMember {
|
|
8071
|
+
Transcript?: never;
|
|
8072
|
+
Categories?: never;
|
|
8073
|
+
Issues?: never;
|
|
8074
|
+
Event?: never;
|
|
8075
|
+
Attachments?: never;
|
|
8076
|
+
PostContactSummary: RealTimeContactAnalysisSegmentPostContactSummary;
|
|
7763
8077
|
$unknown?: never;
|
|
7764
8078
|
}
|
|
7765
8079
|
/**
|
|
@@ -7771,6 +8085,7 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7771
8085
|
Issues?: never;
|
|
7772
8086
|
Event?: never;
|
|
7773
8087
|
Attachments?: never;
|
|
8088
|
+
PostContactSummary?: never;
|
|
7774
8089
|
$unknown: [string, any];
|
|
7775
8090
|
}
|
|
7776
8091
|
interface Visitor<T> {
|
|
@@ -7779,6 +8094,7 @@ export declare namespace RealtimeContactAnalysisSegment {
|
|
|
7779
8094
|
Issues: (value: RealTimeContactAnalysisSegmentIssues) => T;
|
|
7780
8095
|
Event: (value: RealTimeContactAnalysisSegmentEvent) => T;
|
|
7781
8096
|
Attachments: (value: RealTimeContactAnalysisSegmentAttachments) => T;
|
|
8097
|
+
PostContactSummary: (value: RealTimeContactAnalysisSegmentPostContactSummary) => T;
|
|
7782
8098
|
_: (name: string, value: any) => T;
|
|
7783
8099
|
}
|
|
7784
8100
|
const visit: <T>(value: RealtimeContactAnalysisSegment, visitor: Visitor<T>) => T;
|
|
@@ -8436,228 +8752,6 @@ export interface ListTaskTemplatesResponse {
|
|
|
8436
8752
|
*/
|
|
8437
8753
|
NextToken?: string;
|
|
8438
8754
|
}
|
|
8439
|
-
/**
|
|
8440
|
-
* @public
|
|
8441
|
-
*/
|
|
8442
|
-
export interface ListTrafficDistributionGroupsRequest {
|
|
8443
|
-
/**
|
|
8444
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8445
|
-
* @public
|
|
8446
|
-
*/
|
|
8447
|
-
MaxResults?: number;
|
|
8448
|
-
/**
|
|
8449
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8450
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8451
|
-
* @public
|
|
8452
|
-
*/
|
|
8453
|
-
NextToken?: string;
|
|
8454
|
-
/**
|
|
8455
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8456
|
-
* @public
|
|
8457
|
-
*/
|
|
8458
|
-
InstanceId?: string;
|
|
8459
|
-
}
|
|
8460
|
-
/**
|
|
8461
|
-
* <p>Information about traffic distribution groups.</p>
|
|
8462
|
-
* @public
|
|
8463
|
-
*/
|
|
8464
|
-
export interface TrafficDistributionGroupSummary {
|
|
8465
|
-
/**
|
|
8466
|
-
* <p>The identifier of the traffic distribution group.
|
|
8467
|
-
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
8468
|
-
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
8469
|
-
* @public
|
|
8470
|
-
*/
|
|
8471
|
-
Id?: string;
|
|
8472
|
-
/**
|
|
8473
|
-
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
8474
|
-
* @public
|
|
8475
|
-
*/
|
|
8476
|
-
Arn?: string;
|
|
8477
|
-
/**
|
|
8478
|
-
* <p>The name of the traffic distribution group.</p>
|
|
8479
|
-
* @public
|
|
8480
|
-
*/
|
|
8481
|
-
Name?: string;
|
|
8482
|
-
/**
|
|
8483
|
-
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
8484
|
-
* @public
|
|
8485
|
-
*/
|
|
8486
|
-
InstanceArn?: string;
|
|
8487
|
-
/**
|
|
8488
|
-
* <p>The status of the traffic distribution group. </p>
|
|
8489
|
-
* <ul>
|
|
8490
|
-
* <li>
|
|
8491
|
-
* <p>
|
|
8492
|
-
* <code>CREATION_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet
|
|
8493
|
-
* completed.</p>
|
|
8494
|
-
* </li>
|
|
8495
|
-
* <li>
|
|
8496
|
-
* <p>
|
|
8497
|
-
* <code>ACTIVE</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has succeeded.</p>
|
|
8498
|
-
* </li>
|
|
8499
|
-
* <li>
|
|
8500
|
-
* <p>
|
|
8501
|
-
* <code>CREATION_FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has failed.</p>
|
|
8502
|
-
* </li>
|
|
8503
|
-
* <li>
|
|
8504
|
-
* <p>
|
|
8505
|
-
* <code>PENDING_DELETION</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet
|
|
8506
|
-
* completed.</p>
|
|
8507
|
-
* </li>
|
|
8508
|
-
* <li>
|
|
8509
|
-
* <p>
|
|
8510
|
-
* <code>DELETION_FAILED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation has failed.</p>
|
|
8511
|
-
* </li>
|
|
8512
|
-
* <li>
|
|
8513
|
-
* <p>
|
|
8514
|
-
* <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html">UpdateTrafficDistributionGroup</a> operation is still in progress and has not yet
|
|
8515
|
-
* completed.</p>
|
|
8516
|
-
* </li>
|
|
8517
|
-
* </ul>
|
|
8518
|
-
* @public
|
|
8519
|
-
*/
|
|
8520
|
-
Status?: TrafficDistributionGroupStatus;
|
|
8521
|
-
/**
|
|
8522
|
-
* <p>Whether this is the default traffic distribution group created during instance
|
|
8523
|
-
* replication. The default traffic distribution group cannot be deleted by the
|
|
8524
|
-
* <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
|
|
8525
|
-
* part of the process for deleting a replica.</p>
|
|
8526
|
-
* @public
|
|
8527
|
-
*/
|
|
8528
|
-
IsDefault?: boolean;
|
|
8529
|
-
}
|
|
8530
|
-
/**
|
|
8531
|
-
* @public
|
|
8532
|
-
*/
|
|
8533
|
-
export interface ListTrafficDistributionGroupsResponse {
|
|
8534
|
-
/**
|
|
8535
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8536
|
-
* @public
|
|
8537
|
-
*/
|
|
8538
|
-
NextToken?: string;
|
|
8539
|
-
/**
|
|
8540
|
-
* <p>A list of traffic distribution groups.</p>
|
|
8541
|
-
* @public
|
|
8542
|
-
*/
|
|
8543
|
-
TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[];
|
|
8544
|
-
}
|
|
8545
|
-
/**
|
|
8546
|
-
* @public
|
|
8547
|
-
*/
|
|
8548
|
-
export interface ListTrafficDistributionGroupUsersRequest {
|
|
8549
|
-
/**
|
|
8550
|
-
* <p>The identifier of the traffic distribution group.
|
|
8551
|
-
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
8552
|
-
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
8553
|
-
* @public
|
|
8554
|
-
*/
|
|
8555
|
-
TrafficDistributionGroupId: string | undefined;
|
|
8556
|
-
/**
|
|
8557
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8558
|
-
* @public
|
|
8559
|
-
*/
|
|
8560
|
-
MaxResults?: number;
|
|
8561
|
-
/**
|
|
8562
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8563
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8564
|
-
* @public
|
|
8565
|
-
*/
|
|
8566
|
-
NextToken?: string;
|
|
8567
|
-
}
|
|
8568
|
-
/**
|
|
8569
|
-
* <p>Summary information about a traffic distribution group user.</p>
|
|
8570
|
-
* @public
|
|
8571
|
-
*/
|
|
8572
|
-
export interface TrafficDistributionGroupUserSummary {
|
|
8573
|
-
/**
|
|
8574
|
-
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
8575
|
-
* @public
|
|
8576
|
-
*/
|
|
8577
|
-
UserId?: string;
|
|
8578
|
-
}
|
|
8579
|
-
/**
|
|
8580
|
-
* @public
|
|
8581
|
-
*/
|
|
8582
|
-
export interface ListTrafficDistributionGroupUsersResponse {
|
|
8583
|
-
/**
|
|
8584
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8585
|
-
* @public
|
|
8586
|
-
*/
|
|
8587
|
-
NextToken?: string;
|
|
8588
|
-
/**
|
|
8589
|
-
* <p>A list of traffic distribution group users.</p>
|
|
8590
|
-
* @public
|
|
8591
|
-
*/
|
|
8592
|
-
TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[];
|
|
8593
|
-
}
|
|
8594
|
-
/**
|
|
8595
|
-
* <p>Provides summary information about the use cases for the specified integration
|
|
8596
|
-
* association.</p>
|
|
8597
|
-
* @public
|
|
8598
|
-
*/
|
|
8599
|
-
export interface ListUseCasesRequest {
|
|
8600
|
-
/**
|
|
8601
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8602
|
-
* @public
|
|
8603
|
-
*/
|
|
8604
|
-
InstanceId: string | undefined;
|
|
8605
|
-
/**
|
|
8606
|
-
* <p>The identifier for the integration association.</p>
|
|
8607
|
-
* @public
|
|
8608
|
-
*/
|
|
8609
|
-
IntegrationAssociationId: string | undefined;
|
|
8610
|
-
/**
|
|
8611
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8612
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8613
|
-
* @public
|
|
8614
|
-
*/
|
|
8615
|
-
NextToken?: string;
|
|
8616
|
-
/**
|
|
8617
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8618
|
-
* @public
|
|
8619
|
-
*/
|
|
8620
|
-
MaxResults?: number;
|
|
8621
|
-
}
|
|
8622
|
-
/**
|
|
8623
|
-
* <p>Contains the
|
|
8624
|
-
* use
|
|
8625
|
-
* case.</p>
|
|
8626
|
-
* @public
|
|
8627
|
-
*/
|
|
8628
|
-
export interface UseCase {
|
|
8629
|
-
/**
|
|
8630
|
-
* <p>The identifier for the use case.</p>
|
|
8631
|
-
* @public
|
|
8632
|
-
*/
|
|
8633
|
-
UseCaseId?: string;
|
|
8634
|
-
/**
|
|
8635
|
-
* <p>The Amazon Resource Name (ARN) for the use case.</p>
|
|
8636
|
-
* @public
|
|
8637
|
-
*/
|
|
8638
|
-
UseCaseArn?: string;
|
|
8639
|
-
/**
|
|
8640
|
-
* <p>The type of use case to associate to the integration association. Each integration
|
|
8641
|
-
* association can have only one of each use case type.</p>
|
|
8642
|
-
* @public
|
|
8643
|
-
*/
|
|
8644
|
-
UseCaseType?: UseCaseType;
|
|
8645
|
-
}
|
|
8646
|
-
/**
|
|
8647
|
-
* @public
|
|
8648
|
-
*/
|
|
8649
|
-
export interface ListUseCasesResponse {
|
|
8650
|
-
/**
|
|
8651
|
-
* <p>The use cases.</p>
|
|
8652
|
-
* @public
|
|
8653
|
-
*/
|
|
8654
|
-
UseCaseSummaryList?: UseCase[];
|
|
8655
|
-
/**
|
|
8656
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8657
|
-
* @public
|
|
8658
|
-
*/
|
|
8659
|
-
NextToken?: string;
|
|
8660
|
-
}
|
|
8661
8755
|
/**
|
|
8662
8756
|
* @internal
|
|
8663
8757
|
*/
|