@aws-sdk/client-connect 3.701.0 → 3.709.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 +18 -2
- package/dist-cjs/index.js +186 -63
- package/dist-es/Connect.js +4 -0
- package/dist-es/commands/CreateContactCommand.js +1 -1
- package/dist-es/commands/CreatePushNotificationRegistrationCommand.js +22 -0
- package/dist-es/commands/DeletePushNotificationRegistrationCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +11 -0
- package/dist-es/models/models_1.js +0 -16
- package/dist-es/models/models_2.js +24 -5
- package/dist-es/models/models_3.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +62 -0
- package/dist-types/Connect.d.ts +16 -2
- package/dist-types/ConnectClient.d.ts +6 -4
- package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/CreatePushNotificationRegistrationCommand.d.ts +101 -0
- package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +86 -0
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +1 -2
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +2 -3
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +2 -2
- package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -2
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/UpdateContactCommand.d.ts +21 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +142 -81
- package/dist-types/models/models_1.d.ts +202 -171
- package/dist-types/models/models_2.d.ts +215 -400
- package/dist-types/models/models_3.d.ts +430 -3
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Connect.d.ts +46 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreatePushNotificationRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +34 -19
- package/dist-types/ts3.4/models/models_1.d.ts +19 -43
- package/dist-types/ts3.4/models/models_2.d.ts +65 -89
- package/dist-types/ts3.4/models/models_3.d.ts +92 -6
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +35 -35
|
@@ -1,6 +1,85 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
3
|
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, ParticipantCapabilities, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface DeleteUserHierarchyGroupRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The identifier of the hierarchy group.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
HierarchyGroupId: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <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>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
InstanceId: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteViewRequest {
|
|
23
|
+
/**
|
|
24
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
25
|
+
* the instance.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
InstanceId: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
31
|
+
* used.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
ViewId: string | undefined;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export interface DeleteViewResponse {
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export interface DeleteViewVersionRequest {
|
|
45
|
+
/**
|
|
46
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
47
|
+
* the instance.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
InstanceId: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
53
|
+
* used.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
ViewId: string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The version number of the view.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
ViewVersion: number | undefined;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface DeleteViewVersionResponse {
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export interface DeleteVocabularyRequest {
|
|
72
|
+
/**
|
|
73
|
+
* <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>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
InstanceId: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
VocabularyId: string | undefined;
|
|
82
|
+
}
|
|
4
83
|
/**
|
|
5
84
|
* @public
|
|
6
85
|
*/
|
|
@@ -1704,8 +1783,9 @@ export interface ClaimedPhoneNumberSummary {
|
|
|
1704
1783
|
PhoneNumberStatus?: PhoneNumberStatus | undefined;
|
|
1705
1784
|
/**
|
|
1706
1785
|
* <p>The claimed phone number ARN that was previously imported from the external service, such as
|
|
1707
|
-
* Amazon
|
|
1708
|
-
* that was imported from Amazon
|
|
1786
|
+
* Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
|
|
1787
|
+
* looks like the ARN of the phone number that was imported from Amazon Web Services End User
|
|
1788
|
+
* Messaging.</p>
|
|
1709
1789
|
* @public
|
|
1710
1790
|
*/
|
|
1711
1791
|
SourcePhoneNumberArn?: string | undefined;
|
|
@@ -2239,7 +2319,7 @@ export interface SecurityProfile {
|
|
|
2239
2319
|
*/
|
|
2240
2320
|
OrganizationResourceId?: string | undefined;
|
|
2241
2321
|
/**
|
|
2242
|
-
* <p>The Amazon Resource Name (ARN) for the
|
|
2322
|
+
* <p>The Amazon Resource Name (ARN) for the security profile.</p>
|
|
2243
2323
|
* @public
|
|
2244
2324
|
*/
|
|
2245
2325
|
Arn?: string | undefined;
|
|
@@ -2910,6 +2990,18 @@ export interface DisassociateFlowRequest {
|
|
|
2910
2990
|
InstanceId: string | undefined;
|
|
2911
2991
|
/**
|
|
2912
2992
|
* <p>The identifier of the resource.</p>
|
|
2993
|
+
* <ul>
|
|
2994
|
+
* <li>
|
|
2995
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
2996
|
+
* <code>SMS_PHONE_NUMBER</code>
|
|
2997
|
+
* </p>
|
|
2998
|
+
* </li>
|
|
2999
|
+
* <li>
|
|
3000
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
3001
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
3002
|
+
* </p>
|
|
3003
|
+
* </li>
|
|
3004
|
+
* </ul>
|
|
2913
3005
|
* @public
|
|
2914
3006
|
*/
|
|
2915
3007
|
ResourceId: string | undefined;
|
|
@@ -4012,6 +4104,18 @@ export interface GetFlowAssociationRequest {
|
|
|
4012
4104
|
InstanceId: string | undefined;
|
|
4013
4105
|
/**
|
|
4014
4106
|
* <p>The identifier of the resource.</p>
|
|
4107
|
+
* <ul>
|
|
4108
|
+
* <li>
|
|
4109
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
4110
|
+
* <code>SMS_PHONE_NUMBER</code>
|
|
4111
|
+
* </p>
|
|
4112
|
+
* </li>
|
|
4113
|
+
* <li>
|
|
4114
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
4115
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
4116
|
+
* </p>
|
|
4117
|
+
* </li>
|
|
4118
|
+
* </ul>
|
|
4015
4119
|
* @public
|
|
4016
4120
|
*/
|
|
4017
4121
|
ResourceId: string | undefined;
|
|
@@ -4538,6 +4642,14 @@ export interface MetricFilterV2 {
|
|
|
4538
4642
|
* <p>For valid values of the metric-level filter <code>FLOWS_OUTCOME_TYPE</code>, see the
|
|
4539
4643
|
* description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flow outcome</a> metric in the <i>Amazon Connect Administrator
|
|
4540
4644
|
* Guide</i>.</p>
|
|
4645
|
+
* <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see
|
|
4646
|
+
* the description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot
|
|
4647
|
+
* conversations completed</a> in the <i>Amazon Connect Administrator
|
|
4648
|
+
* Guide</i>.</p>
|
|
4649
|
+
* <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the
|
|
4650
|
+
* description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents
|
|
4651
|
+
* completed</a> metric in the <i>Amazon Connect Administrator
|
|
4652
|
+
* Guide</i>.</p>
|
|
4541
4653
|
* @public
|
|
4542
4654
|
*/
|
|
4543
4655
|
MetricFilterValues?: string[] | undefined;
|
|
@@ -4714,15 +4826,19 @@ export interface GetMetricDataV2Request {
|
|
|
4714
4826
|
* <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> |
|
|
4715
4827
|
* <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> |
|
|
4716
4828
|
* <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> |
|
|
4717
|
-
* <code>
|
|
4718
|
-
*
|
|
4829
|
+
* <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> |
|
|
4830
|
+
* <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> |
|
|
4831
|
+
* <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> |
|
|
4832
|
+
* <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
4719
4833
|
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
4720
|
-
* <code>FEATURE</code> | <code>
|
|
4834
|
+
* <code>FEATURE</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> |
|
|
4835
|
+
* <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> |
|
|
4721
4836
|
* <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> |
|
|
4722
4837
|
* <code>FLOWS_RESOURCE_ID</code> | <code>INITIATION_METHOD</code> |
|
|
4723
|
-
* <code>
|
|
4724
|
-
* <code>
|
|
4725
|
-
*
|
|
4838
|
+
* <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
|
|
4839
|
+
* <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> |
|
|
4840
|
+
* <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> |
|
|
4841
|
+
* <code>Q_CONNECT_ENABLED</code> | </p>
|
|
4726
4842
|
* </li>
|
|
4727
4843
|
* <li>
|
|
4728
4844
|
* <p>
|
|
@@ -4771,12 +4887,15 @@ export interface GetMetricDataV2Request {
|
|
|
4771
4887
|
* <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
|
|
4772
4888
|
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
|
|
4773
4889
|
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
|
|
4774
|
-
* <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>
|
|
4775
|
-
* <code>
|
|
4776
|
-
* <code>
|
|
4890
|
+
* <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> |
|
|
4891
|
+
* <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> |
|
|
4892
|
+
* <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |
|
|
4893
|
+
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
4777
4894
|
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
4778
|
-
* <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> |
|
|
4779
|
-
*
|
|
4895
|
+
* <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> |
|
|
4896
|
+
* <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code> |
|
|
4897
|
+
* <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> |
|
|
4898
|
+
* <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
|
|
4780
4899
|
* <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code>
|
|
4781
4900
|
* | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code>
|
|
4782
4901
|
* </p>
|
|
@@ -4907,6 +5026,27 @@ export interface GetMetricDataV2Request {
|
|
|
4907
5026
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical">Average agent pause time</a>
|
|
4908
5027
|
* </p>
|
|
4909
5028
|
* </dd>
|
|
5029
|
+
* <dt>AVG_BOT_CONVERSATION_TIME</dt>
|
|
5030
|
+
* <dd>
|
|
5031
|
+
* <p>Unit: Seconds</p>
|
|
5032
|
+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
|
|
5033
|
+
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5034
|
+
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5035
|
+
* resource ID</p>
|
|
5036
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time-metric">Average
|
|
5037
|
+
* bot conversation time</a>
|
|
5038
|
+
* </p>
|
|
5039
|
+
* </dd>
|
|
5040
|
+
* <dt>AVG_BOT_CONVERSATION_TURNS</dt>
|
|
5041
|
+
* <dd>
|
|
5042
|
+
* <p>Unit: Count</p>
|
|
5043
|
+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
|
|
5044
|
+
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5045
|
+
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5046
|
+
* resource ID</p>
|
|
5047
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns-metric">Average bot conversation turns</a>
|
|
5048
|
+
* </p>
|
|
5049
|
+
* </dd>
|
|
4910
5050
|
* <dt>AVG_CASE_RELATED_CONTACTS</dt>
|
|
4911
5051
|
* <dd>
|
|
4912
5052
|
* <p>Unit: Count</p>
|
|
@@ -5120,6 +5260,28 @@ export interface GetMetricDataV2Request {
|
|
|
5120
5260
|
* <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>
|
|
5121
5261
|
* </p>
|
|
5122
5262
|
* </dd>
|
|
5263
|
+
* <dt>BOT_CONVERSATIONS_COMPLETED</dt>
|
|
5264
|
+
* <dd>
|
|
5265
|
+
* <p>Unit: Count</p>
|
|
5266
|
+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
|
|
5267
|
+
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5268
|
+
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5269
|
+
* resource ID</p>
|
|
5270
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot
|
|
5271
|
+
* conversations</a>
|
|
5272
|
+
* </p>
|
|
5273
|
+
* </dd>
|
|
5274
|
+
* <dt>BOT_INTENTS_COMPLETED</dt>
|
|
5275
|
+
* <dd>
|
|
5276
|
+
* <p>Unit: Count</p>
|
|
5277
|
+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
|
|
5278
|
+
* version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,
|
|
5279
|
+
* Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource
|
|
5280
|
+
* type, Parent flows resource ID</p>
|
|
5281
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents
|
|
5282
|
+
* completed</a>
|
|
5283
|
+
* </p>
|
|
5284
|
+
* </dd>
|
|
5123
5285
|
* <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt>
|
|
5124
5286
|
* <dd>
|
|
5125
5287
|
* <p>This metric is available only for outbound campaigns using the agent assisted voice and
|
|
@@ -5413,6 +5575,27 @@ export interface GetMetricDataV2Request {
|
|
|
5413
5575
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical">Minimum flow time</a>
|
|
5414
5576
|
* </p>
|
|
5415
5577
|
* </dd>
|
|
5578
|
+
* <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt>
|
|
5579
|
+
* <dd>
|
|
5580
|
+
* <p>Unit: Percent</p>
|
|
5581
|
+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
|
|
5582
|
+
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5583
|
+
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5584
|
+
* resource ID</p>
|
|
5585
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome-metric">Percent bot conversations outcome</a>
|
|
5586
|
+
* </p>
|
|
5587
|
+
* </dd>
|
|
5588
|
+
* <dt>PERCENT_BOT_INTENTS_OUTCOME</dt>
|
|
5589
|
+
* <dd>
|
|
5590
|
+
* <p>Unit: Percent</p>
|
|
5591
|
+
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
|
|
5592
|
+
* version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,
|
|
5593
|
+
* Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource
|
|
5594
|
+
* type, Parent flows resource ID</p>
|
|
5595
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome-metric">Percent
|
|
5596
|
+
* bot intents outcome</a>
|
|
5597
|
+
* </p>
|
|
5598
|
+
* </dd>
|
|
5416
5599
|
* <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt>
|
|
5417
5600
|
* <dd>
|
|
5418
5601
|
* <p>Unit: Percent</p>
|
|
@@ -5999,8 +6182,8 @@ export interface ImportPhoneNumberRequest {
|
|
|
5999
6182
|
*/
|
|
6000
6183
|
InstanceId: string | undefined;
|
|
6001
6184
|
/**
|
|
6002
|
-
* <p>The claimed phone number ARN being imported from the external service, such as Amazon
|
|
6003
|
-
* import from Amazon
|
|
6185
|
+
* <p>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks
|
|
6186
|
+
* like the ARN of the phone number to import from Amazon Web Services End User Messaging.</p>
|
|
6004
6187
|
* @public
|
|
6005
6188
|
*/
|
|
6006
6189
|
SourcePhoneNumberArn: string | undefined;
|
|
@@ -7896,8 +8079,9 @@ export interface ListPhoneNumbersSummary {
|
|
|
7896
8079
|
PhoneNumberDescription?: string | undefined;
|
|
7897
8080
|
/**
|
|
7898
8081
|
* <p>The claimed phone number ARN that was previously imported from the external service, such as
|
|
7899
|
-
* Amazon
|
|
7900
|
-
* that was imported from Amazon
|
|
8082
|
+
* Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
|
|
8083
|
+
* looks like the ARN of the phone number that was imported from Amazon Web Services End User
|
|
8084
|
+
* Messaging.</p>
|
|
7901
8085
|
* @public
|
|
7902
8086
|
*/
|
|
7903
8087
|
SourcePhoneNumberArn?: string | undefined;
|
|
@@ -8603,159 +8787,6 @@ export interface RealTimeContactAnalysisSegmentIssues {
|
|
|
8603
8787
|
*/
|
|
8604
8788
|
IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined;
|
|
8605
8789
|
}
|
|
8606
|
-
/**
|
|
8607
|
-
* @public
|
|
8608
|
-
* @enum
|
|
8609
|
-
*/
|
|
8610
|
-
export declare const RealTimeContactAnalysisPostContactSummaryFailureCode: {
|
|
8611
|
-
readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
|
|
8612
|
-
readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
|
|
8613
|
-
readonly INTERNAL_ERROR: "INTERNAL_ERROR";
|
|
8614
|
-
readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
|
|
8615
|
-
readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
|
|
8616
|
-
};
|
|
8617
|
-
/**
|
|
8618
|
-
* @public
|
|
8619
|
-
*/
|
|
8620
|
-
export type RealTimeContactAnalysisPostContactSummaryFailureCode = (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode];
|
|
8621
|
-
/**
|
|
8622
|
-
* @public
|
|
8623
|
-
* @enum
|
|
8624
|
-
*/
|
|
8625
|
-
export declare const RealTimeContactAnalysisPostContactSummaryStatus: {
|
|
8626
|
-
readonly COMPLETED: "COMPLETED";
|
|
8627
|
-
readonly FAILED: "FAILED";
|
|
8628
|
-
};
|
|
8629
|
-
/**
|
|
8630
|
-
* @public
|
|
8631
|
-
*/
|
|
8632
|
-
export type RealTimeContactAnalysisPostContactSummaryStatus = (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus];
|
|
8633
|
-
/**
|
|
8634
|
-
* <p>Information about the post-contact summary for a real-time contact segment.</p>
|
|
8635
|
-
* @public
|
|
8636
|
-
*/
|
|
8637
|
-
export interface RealTimeContactAnalysisSegmentPostContactSummary {
|
|
8638
|
-
/**
|
|
8639
|
-
* <p>The content of the summary.</p>
|
|
8640
|
-
* @public
|
|
8641
|
-
*/
|
|
8642
|
-
Content?: string | undefined;
|
|
8643
|
-
/**
|
|
8644
|
-
* <p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>
|
|
8645
|
-
* @public
|
|
8646
|
-
*/
|
|
8647
|
-
Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
|
|
8648
|
-
/**
|
|
8649
|
-
* <p>If the summary failed to be generated, one of the following failure codes occurs:</p>
|
|
8650
|
-
* <ul>
|
|
8651
|
-
* <li>
|
|
8652
|
-
* <p>
|
|
8653
|
-
* <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service
|
|
8654
|
-
* quota.</p>
|
|
8655
|
-
* </li>
|
|
8656
|
-
* <li>
|
|
8657
|
-
* <p>
|
|
8658
|
-
* <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least
|
|
8659
|
-
* one turn from both the participants in order to generate the summary.</p>
|
|
8660
|
-
* </li>
|
|
8661
|
-
* <li>
|
|
8662
|
-
* <p>
|
|
8663
|
-
* <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it
|
|
8664
|
-
* failed to meet system safety guidelines.</p>
|
|
8665
|
-
* </li>
|
|
8666
|
-
* <li>
|
|
8667
|
-
* <p>
|
|
8668
|
-
* <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're
|
|
8669
|
-
* using a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a> that isn't supported by generative AI-powered post-contact summaries.
|
|
8670
|
-
* </p>
|
|
8671
|
-
* </li>
|
|
8672
|
-
* <li>
|
|
8673
|
-
* <p>
|
|
8674
|
-
* <code>INTERNAL_ERROR</code>: Internal system error.</p>
|
|
8675
|
-
* </li>
|
|
8676
|
-
* </ul>
|
|
8677
|
-
* @public
|
|
8678
|
-
*/
|
|
8679
|
-
FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode | undefined;
|
|
8680
|
-
}
|
|
8681
|
-
/**
|
|
8682
|
-
* <p>Object describing redaction applied to the segment.</p>
|
|
8683
|
-
* @public
|
|
8684
|
-
*/
|
|
8685
|
-
export interface RealTimeContactAnalysisTranscriptItemRedaction {
|
|
8686
|
-
/**
|
|
8687
|
-
* <p>List of character intervals each describing a part of the text that was redacted. For
|
|
8688
|
-
* <code>OutputType.Raw</code>, part of the original text that contains data that can be redacted.
|
|
8689
|
-
* For <code> OutputType.Redacted</code>, part of the string with redaction tag.</p>
|
|
8690
|
-
* @public
|
|
8691
|
-
*/
|
|
8692
|
-
CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined;
|
|
8693
|
-
}
|
|
8694
|
-
/**
|
|
8695
|
-
* @public
|
|
8696
|
-
* @enum
|
|
8697
|
-
*/
|
|
8698
|
-
export declare const RealTimeContactAnalysisSentimentLabel: {
|
|
8699
|
-
readonly NEGATIVE: "NEGATIVE";
|
|
8700
|
-
readonly NEUTRAL: "NEUTRAL";
|
|
8701
|
-
readonly POSITIVE: "POSITIVE";
|
|
8702
|
-
};
|
|
8703
|
-
/**
|
|
8704
|
-
* @public
|
|
8705
|
-
*/
|
|
8706
|
-
export type RealTimeContactAnalysisSentimentLabel = (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel];
|
|
8707
|
-
/**
|
|
8708
|
-
* <p>The analyzed transcript segment.</p>
|
|
8709
|
-
* @public
|
|
8710
|
-
*/
|
|
8711
|
-
export interface RealTimeContactAnalysisSegmentTranscript {
|
|
8712
|
-
/**
|
|
8713
|
-
* <p>The identifier of the transcript.</p>
|
|
8714
|
-
* @public
|
|
8715
|
-
*/
|
|
8716
|
-
Id: string | undefined;
|
|
8717
|
-
/**
|
|
8718
|
-
* <p>The identifier of the participant.</p>
|
|
8719
|
-
* @public
|
|
8720
|
-
*/
|
|
8721
|
-
ParticipantId: string | undefined;
|
|
8722
|
-
/**
|
|
8723
|
-
* <p>The role of the participant. For example, is it a customer, agent, or system.</p>
|
|
8724
|
-
* @public
|
|
8725
|
-
*/
|
|
8726
|
-
ParticipantRole: ParticipantRole | undefined;
|
|
8727
|
-
/**
|
|
8728
|
-
* <p>The display name of the participant.</p>
|
|
8729
|
-
* @public
|
|
8730
|
-
*/
|
|
8731
|
-
DisplayName?: string | undefined;
|
|
8732
|
-
/**
|
|
8733
|
-
* <p>The content of the transcript. Can be redacted.</p>
|
|
8734
|
-
* @public
|
|
8735
|
-
*/
|
|
8736
|
-
Content: string | undefined;
|
|
8737
|
-
/**
|
|
8738
|
-
* <p>The type of content of the item. For example, <code>text/plain</code>.</p>
|
|
8739
|
-
* @public
|
|
8740
|
-
*/
|
|
8741
|
-
ContentType?: string | undefined;
|
|
8742
|
-
/**
|
|
8743
|
-
* <p>Field describing the time of the event. It can have different representations of time.</p>
|
|
8744
|
-
* @public
|
|
8745
|
-
*/
|
|
8746
|
-
Time: RealTimeContactAnalysisTimeData | undefined;
|
|
8747
|
-
/**
|
|
8748
|
-
* <p>Object describing redaction that was applied to the transcript. If transcript has the field
|
|
8749
|
-
* it means part of the transcript was redacted.</p>
|
|
8750
|
-
* @public
|
|
8751
|
-
*/
|
|
8752
|
-
Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined;
|
|
8753
|
-
/**
|
|
8754
|
-
* <p>The sentiment detected for this piece of transcript.</p>
|
|
8755
|
-
* @public
|
|
8756
|
-
*/
|
|
8757
|
-
Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined;
|
|
8758
|
-
}
|
|
8759
8790
|
/**
|
|
8760
8791
|
* @internal
|
|
8761
8792
|
*/
|