@aws-sdk/client-connect 3.1155.0 → 3.1157.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 +14 -0
- package/dist-cjs/index.js +193 -73
- package/dist-es/Connect.js +6 -0
- package/dist-es/commands/ListReplicationFindingsCommand.js +4 -0
- package/dist-es/commands/UpdateOutboundEmailContactMessageCommand.js +4 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +4 -0
- package/dist-es/pagination/ListReplicationFindingsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +161 -72
- package/dist-types/Connect.d.ts +21 -0
- package/dist-types/ConnectClient.d.ts +4 -2
- package/dist-types/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/commands/CreateRuleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRuleCommand.d.ts +1 -1
- package/dist-types/commands/GetTrafficDistributionCommand.d.ts +1 -0
- package/dist-types/commands/ListContactReferencesCommand.d.ts +2 -2
- package/dist-types/commands/ListReplicationFindingsCommand.d.ts +117 -0
- package/dist-types/commands/ListViewVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListWorkspaceMediaCommand.d.ts +1 -2
- package/dist-types/commands/StartEmailContactCommand.d.ts +1 -1
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/commands/StartTaskContactCommand.d.ts +1 -1
- package/dist-types/commands/StartWebRTCContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactCommand.d.ts +9 -1
- package/dist-types/commands/UpdateOutboundEmailContactMessageCommand.d.ts +99 -0
- package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +12 -0
- package/dist-types/models/models_2.d.ts +330 -121
- package/dist-types/models/models_3.d.ts +203 -221
- package/dist-types/models/models_4.d.ts +231 -4
- package/dist-types/pagination/ListReplicationFindingsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +12 -0
- package/dist-types/ts3.4/Connect.d.ts +41 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/ListReplicationFindingsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListViewVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListWorkspaceMediaCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/UpdateOutboundEmailContactMessageCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +6 -0
- package/dist-types/ts3.4/models/models_2.d.ts +32 -27
- package/dist-types/ts3.4/models/models_3.d.ts +49 -53
- package/dist-types/ts3.4/models/models_4.d.ts +54 -0
- package/dist-types/ts3.4/pagination/ListReplicationFindingsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
- package/package.json +5 -5
|
@@ -51,7 +51,7 @@ declare const UpdateRuleCommand_base: {
|
|
|
51
51
|
* "<keys>": { // Reference
|
|
52
52
|
* Value: "STRING_VALUE",
|
|
53
53
|
* Type: "URL" || "ATTACHMENT" || "CONTACT_ANALYSIS" || "NUMBER" || "STRING" || "DATE" || "EMAIL" || "EMAIL_MESSAGE" || "EMAIL_MESSAGE_PLAIN_TEXT" || "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" || "EMAIL_MESSAGE_REDACTED", // required
|
|
54
|
-
* Status: "AVAILABLE" || "DELETED" || "APPROVED" || "REJECTED" || "PROCESSING" || "FAILED",
|
|
54
|
+
* Status: "AVAILABLE" || "DELETED" || "APPROVED" || "REJECTED" || "PROCESSING" || "FAILED" || "DRAFTING",
|
|
55
55
|
* Arn: "STRING_VALUE",
|
|
56
56
|
* StatusReason: "STRING_VALUE",
|
|
57
57
|
* },
|
|
@@ -236,6 +236,7 @@ export * from "./ListQueueQuickConnectsCommand";
|
|
|
236
236
|
export * from "./ListQueuesCommand";
|
|
237
237
|
export * from "./ListQuickConnectsCommand";
|
|
238
238
|
export * from "./ListRealtimeContactAnalysisSegmentsV2Command";
|
|
239
|
+
export * from "./ListReplicationFindingsCommand";
|
|
239
240
|
export * from "./ListRoutingProfileManualAssignmentQueuesCommand";
|
|
240
241
|
export * from "./ListRoutingProfileQueuesCommand";
|
|
241
242
|
export * from "./ListRoutingProfilesCommand";
|
|
@@ -360,6 +361,7 @@ export * from "./UpdateInstanceStorageConfigCommand";
|
|
|
360
361
|
export * from "./UpdateMetricContentCommand";
|
|
361
362
|
export * from "./UpdateMetricMetadataCommand";
|
|
362
363
|
export * from "./UpdateNotificationContentCommand";
|
|
364
|
+
export * from "./UpdateOutboundEmailContactMessageCommand";
|
|
363
365
|
export * from "./UpdateParticipantAuthenticationCommand";
|
|
364
366
|
export * from "./UpdateParticipantRoleConfigCommand";
|
|
365
367
|
export * from "./UpdatePhoneNumberCommand";
|
|
@@ -510,6 +510,7 @@ export declare const ReferenceStatus: {
|
|
|
510
510
|
readonly APPROVED: "APPROVED";
|
|
511
511
|
readonly AVAILABLE: "AVAILABLE";
|
|
512
512
|
readonly DELETED: "DELETED";
|
|
513
|
+
readonly DRAFTING: "DRAFTING";
|
|
513
514
|
readonly FAILED: "FAILED";
|
|
514
515
|
readonly PROCESSING: "PROCESSING";
|
|
515
516
|
readonly REJECTED: "REJECTED";
|
|
@@ -3067,6 +3068,17 @@ export declare const MeetingFeatureStatus: {
|
|
|
3067
3068
|
* @public
|
|
3068
3069
|
*/
|
|
3069
3070
|
export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
|
|
3071
|
+
/**
|
|
3072
|
+
* @public
|
|
3073
|
+
* @enum
|
|
3074
|
+
*/
|
|
3075
|
+
export declare const UpdateOutboundEmailMessageSourceType: {
|
|
3076
|
+
readonly RAW: "RAW";
|
|
3077
|
+
};
|
|
3078
|
+
/**
|
|
3079
|
+
* @public
|
|
3080
|
+
*/
|
|
3081
|
+
export type UpdateOutboundEmailMessageSourceType = (typeof UpdateOutboundEmailMessageSourceType)[keyof typeof UpdateOutboundEmailMessageSourceType];
|
|
3070
3082
|
/**
|
|
3071
3083
|
* @public
|
|
3072
3084
|
* @enum
|
|
@@ -2162,8 +2162,9 @@ export interface GetMetricDataV2Request {
|
|
|
2162
2162
|
* <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FORM_VERSION</code> |
|
|
2163
2163
|
* <code>INITIATING_FLOW</code> | <code>INITIATION_METHOD</code> |
|
|
2164
2164
|
* <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
|
|
2165
|
-
* <code>KNOWLEDGE_BASE_NAME</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
|
|
2166
|
-
* <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>
|
|
2165
|
+
* <code>KNOWLEDGE_BASE_NAME</code> | <code>LIFETIME_VALUE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
|
|
2166
|
+
* <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>REPEAT_CALLER</code> |
|
|
2167
|
+
* <code>RESOURCE_PUBLISHED_TIMESTAMP</code> |
|
|
2167
2168
|
* <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>SESSION_ID</code> |
|
|
2168
2169
|
* <code>TEST_CASE</code> | <code>TEST_CASE_EXECUTION_FAILURE_REASON</code> |
|
|
2169
2170
|
* <code>TEST_CASE_EXECUTION_RESULT</code> | <code>TEST_CASE_EXECUTION_STATE</code> |
|
|
@@ -2233,7 +2234,29 @@ export interface GetMetricDataV2Request {
|
|
|
2233
2234
|
* <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 metrics report</a> in
|
|
2234
2235
|
* the <i>Connect Customer Administrator Guide</i>.</p>
|
|
2235
2236
|
* </li>
|
|
2237
|
+
* <li>
|
|
2238
|
+
* <p>
|
|
2239
|
+
* <code>LIFETIME_VALUE</code> filters and groups by customer lifetime value segment (High lifetime value,
|
|
2240
|
+
* Medium lifetime value, Low lifetime value). For more information about the calculated attributes that drive these
|
|
2241
|
+
* segments, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customerprofiles-default-calculated-attributes.html">Default calculated
|
|
2242
|
+
* attributes</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
2243
|
+
* </li>
|
|
2244
|
+
* <li>
|
|
2245
|
+
* <p>
|
|
2246
|
+
* <code>REPEAT_CALLER</code> filters and groups by repeat caller status.</p>
|
|
2247
|
+
* </li>
|
|
2248
|
+
* <li>
|
|
2249
|
+
* <p>The <code>LIFETIME_VALUE</code> and <code>REPEAT_CALLER</code> filters and groupings use customer segment
|
|
2250
|
+
* data from Customer Profiles. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customerprofiles-default-segments.html">Default segments</a> in the
|
|
2251
|
+
* <i>Connect Customer Administrator Guide</i>.</p>
|
|
2252
|
+
* </li>
|
|
2236
2253
|
* </ul>
|
|
2254
|
+
* <note>
|
|
2255
|
+
* <p>To use the <code>LIFETIME_VALUE</code> and <code>REPEAT_CALLER</code> filters and groupings, users must have
|
|
2256
|
+
* the <b>Customer segments - View</b> permission enabled in their security profile. For
|
|
2257
|
+
* more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html#customerprofiles-permissions-list">List
|
|
2258
|
+
* of security profile permissions</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
2259
|
+
* </note>
|
|
2237
2260
|
* @public
|
|
2238
2261
|
*/
|
|
2239
2262
|
Filters: FilterV2[] | undefined;
|
|
@@ -2261,9 +2284,9 @@ export interface GetMetricDataV2Request {
|
|
|
2261
2284
|
* <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> |
|
|
2262
2285
|
* <code>FLOWS_OUTCOME_TYPE</code> | <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> |
|
|
2263
2286
|
* <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
|
|
2264
|
-
* <code>KNOWLEDGE_ARTICLE_NAME</code> | <code>KNOWLEDGE_BASE_NAME</code> |
|
|
2287
|
+
* <code>KNOWLEDGE_ARTICLE_NAME</code> | <code>KNOWLEDGE_BASE_NAME</code> | <code>LIFETIME_VALUE</code> |
|
|
2265
2288
|
* <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> |
|
|
2266
|
-
* <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> |
|
|
2289
|
+
* <code>REPEAT_CALLER</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> |
|
|
2267
2290
|
* <code>SESSION_ID</code> | <code>TEST_CASE</code> | <code>TEST_CASE_EXECUTION_FAILURE_REASON</code> |
|
|
2268
2291
|
* <code>TEST_CASE_INVOCATION_METHOD</code> | <code>WEB_NOTIFICATION_TYPE</code>
|
|
2269
2292
|
* </p>
|
|
@@ -3345,6 +3368,136 @@ export interface GetMetricDataV2Request {
|
|
|
3345
3368
|
* Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p>
|
|
3346
3369
|
* </note>
|
|
3347
3370
|
* </dd>
|
|
3371
|
+
* <dt>EVALUATED_CHURN_PROPENSITY_RATE</dt>
|
|
3372
|
+
* <dd>
|
|
3373
|
+
* <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
|
|
3374
|
+
* form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
3375
|
+
* <p>Unit: Percent</p>
|
|
3376
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
|
|
3377
|
+
* Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
|
|
3378
|
+
* Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
|
|
3379
|
+
* Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
|
|
3380
|
+
* Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
|
|
3381
|
+
* Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
|
|
3382
|
+
* Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
|
|
3383
|
+
* Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
|
|
3384
|
+
* Session ID, Subtype, Telephone Number</p>
|
|
3385
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-churn-propensity-rate">Evaluated churn propensity rate</a>
|
|
3386
|
+
* </p>
|
|
3387
|
+
* <note>
|
|
3388
|
+
* <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
|
|
3389
|
+
* Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
|
|
3390
|
+
* groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
|
|
3391
|
+
* not valid filters.</p>
|
|
3392
|
+
* <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
|
|
3393
|
+
* the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
|
|
3394
|
+
* request.</p>
|
|
3395
|
+
* </note>
|
|
3396
|
+
* </dd>
|
|
3397
|
+
* <dt>EVALUATED_CSAT_PERCENT</dt>
|
|
3398
|
+
* <dd>
|
|
3399
|
+
* <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
|
|
3400
|
+
* form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
3401
|
+
* <p>Unit: Percent</p>
|
|
3402
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
|
|
3403
|
+
* Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
|
|
3404
|
+
* Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
|
|
3405
|
+
* Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
|
|
3406
|
+
* Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
|
|
3407
|
+
* Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
|
|
3408
|
+
* Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
|
|
3409
|
+
* Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
|
|
3410
|
+
* Session ID, Subtype, Telephone Number</p>
|
|
3411
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-csat-percent">Evaluated CSAT percent</a>
|
|
3412
|
+
* </p>
|
|
3413
|
+
* <note>
|
|
3414
|
+
* <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
|
|
3415
|
+
* Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
|
|
3416
|
+
* groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
|
|
3417
|
+
* not valid filters.</p>
|
|
3418
|
+
* <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
|
|
3419
|
+
* the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
|
|
3420
|
+
* request.</p>
|
|
3421
|
+
* </note>
|
|
3422
|
+
* </dd>
|
|
3423
|
+
* <dt>EVALUATED_PARTIAL_SELF_SERVICE_SUCCESS_RATE</dt>
|
|
3424
|
+
* <dd>
|
|
3425
|
+
* <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
|
|
3426
|
+
* form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
3427
|
+
* <p>Unit: Percent</p>
|
|
3428
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
|
|
3429
|
+
* Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
|
|
3430
|
+
* Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
|
|
3431
|
+
* Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
|
|
3432
|
+
* Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
|
|
3433
|
+
* Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
|
|
3434
|
+
* Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
|
|
3435
|
+
* Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
|
|
3436
|
+
* Session ID, Subtype, Telephone Number</p>
|
|
3437
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-partial-self-service-resolution-rate">Evaluated partial self-service resolution rate</a>
|
|
3438
|
+
* </p>
|
|
3439
|
+
* <note>
|
|
3440
|
+
* <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
|
|
3441
|
+
* Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
|
|
3442
|
+
* groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
|
|
3443
|
+
* not valid filters.</p>
|
|
3444
|
+
* <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
|
|
3445
|
+
* the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
|
|
3446
|
+
* request.</p>
|
|
3447
|
+
* </note>
|
|
3448
|
+
* </dd>
|
|
3449
|
+
* <dt>EVALUATED_SELF_SERVICE_SUCCESS_RATE</dt>
|
|
3450
|
+
* <dd>
|
|
3451
|
+
* <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
|
|
3452
|
+
* form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
3453
|
+
* <p>Unit: Percent</p>
|
|
3454
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
|
|
3455
|
+
* Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
|
|
3456
|
+
* Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
|
|
3457
|
+
* Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
|
|
3458
|
+
* Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
|
|
3459
|
+
* Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
|
|
3460
|
+
* Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
|
|
3461
|
+
* Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
|
|
3462
|
+
* Session ID, Subtype, Telephone Number</p>
|
|
3463
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-self-service-resolution-rate">Evaluated self-service resolution rate</a>
|
|
3464
|
+
* </p>
|
|
3465
|
+
* <note>
|
|
3466
|
+
* <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
|
|
3467
|
+
* Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
|
|
3468
|
+
* groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
|
|
3469
|
+
* not valid filters.</p>
|
|
3470
|
+
* <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
|
|
3471
|
+
* the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
|
|
3472
|
+
* request.</p>
|
|
3473
|
+
* </note>
|
|
3474
|
+
* </dd>
|
|
3475
|
+
* <dt>EVALUATED_SUCCESSFUL_SALE_RATE</dt>
|
|
3476
|
+
* <dd>
|
|
3477
|
+
* <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
|
|
3478
|
+
* form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
3479
|
+
* <p>Unit: Percent</p>
|
|
3480
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
|
|
3481
|
+
* Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
|
|
3482
|
+
* Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
|
|
3483
|
+
* Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
|
|
3484
|
+
* Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
|
|
3485
|
+
* Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
|
|
3486
|
+
* Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
|
|
3487
|
+
* Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
|
|
3488
|
+
* Session ID, Subtype, Telephone Number</p>
|
|
3489
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-successful-sale-rate">Evaluated successful sale rate</a>
|
|
3490
|
+
* </p>
|
|
3491
|
+
* <note>
|
|
3492
|
+
* <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
|
|
3493
|
+
* Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
|
|
3494
|
+
* groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
|
|
3495
|
+
* not valid filters.</p>
|
|
3496
|
+
* <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
|
|
3497
|
+
* the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
|
|
3498
|
+
* request.</p>
|
|
3499
|
+
* </note>
|
|
3500
|
+
* </dd>
|
|
3348
3501
|
* <dt>EVALUATIONS_PERFORMED</dt>
|
|
3349
3502
|
* <dd>
|
|
3350
3503
|
* <p>Unit: Count</p>
|
|
@@ -4140,6 +4293,13 @@ export interface GetTrafficDistributionResponse {
|
|
|
4140
4293
|
* @public
|
|
4141
4294
|
*/
|
|
4142
4295
|
AgentConfig?: AgentConfig | undefined;
|
|
4296
|
+
/**
|
|
4297
|
+
* <p>The timestamp of the most recent failover for the traffic distribution group. This value is
|
|
4298
|
+
* updated each time <code>UpdateTrafficDistribution</code> is called to change the traffic
|
|
4299
|
+
* distribution.</p>
|
|
4300
|
+
* @public
|
|
4301
|
+
*/
|
|
4302
|
+
LastFailoverTime?: Date | undefined;
|
|
4143
4303
|
}
|
|
4144
4304
|
/**
|
|
4145
4305
|
* @public
|
|
@@ -8406,6 +8566,172 @@ export interface ListRealtimeContactAnalysisSegmentsV2Response {
|
|
|
8406
8566
|
*/
|
|
8407
8567
|
NextToken?: string | undefined;
|
|
8408
8568
|
}
|
|
8569
|
+
/**
|
|
8570
|
+
* @public
|
|
8571
|
+
*/
|
|
8572
|
+
export interface ListReplicationFindingsRequest {
|
|
8573
|
+
/**
|
|
8574
|
+
* <p>The identifier of the Connect Customer instance. You can provide either the instance ID or
|
|
8575
|
+
* the full instance ARN. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the
|
|
8576
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
8577
|
+
* @public
|
|
8578
|
+
*/
|
|
8579
|
+
InstanceId: string | undefined;
|
|
8580
|
+
/**
|
|
8581
|
+
* <p>The type of resource to list replication findings for. The following values are currently
|
|
8582
|
+
* supported: <code>AGENT</code>, <code>AGENT_GROUP</code>, <code>AGENT_GROUP_LEVEL</code>,
|
|
8583
|
+
* <code>AGENT_STATE</code>, <code>ATTRIBUTE</code>, <code>CONTACT_FLOW</code>,
|
|
8584
|
+
* <code>DATA_TABLE</code>, <code>DATA_TABLE_ATTRIBUTE</code>, <code>DATA_TABLE_RECORD</code>,
|
|
8585
|
+
* <code>DATA_TABLE_VALUE</code>, <code>FLOW_MODULE</code>, <code>FLOW_MODULE_ALIAS</code>,
|
|
8586
|
+
* <code>FLOW_MODULE_VERSION</code>, <code>METRIC</code>, <code>NOTIFICATION</code>,
|
|
8587
|
+
* <code>OPERATING_HOURS</code>, <code>PHONE_NUMBER</code>, <code>PROMPT</code>, <code>QUEUE</code>,
|
|
8588
|
+
* <code>REPORT</code>, <code>ROUTING_PROFILE</code>, <code>SECURITY_PROFILE</code>,
|
|
8589
|
+
* <code>TASK_TEMPLATE</code>, <code>TEST_CASE</code>, <code>TRANSFER_DESTINATION</code>,
|
|
8590
|
+
* <code>VIEW</code>, and <code>WORKSPACE</code>. Additional resource types can be supported over
|
|
8591
|
+
* time. Specifying a value that is not currently supported returns an
|
|
8592
|
+
* <code>InvalidRequestException</code>.</p>
|
|
8593
|
+
* @public
|
|
8594
|
+
*/
|
|
8595
|
+
ResourceType: string | undefined;
|
|
8596
|
+
/**
|
|
8597
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8598
|
+
* @public
|
|
8599
|
+
*/
|
|
8600
|
+
MaxResults?: number | undefined;
|
|
8601
|
+
/**
|
|
8602
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8603
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
8604
|
+
* @public
|
|
8605
|
+
*/
|
|
8606
|
+
NextToken?: string | undefined;
|
|
8607
|
+
}
|
|
8608
|
+
/**
|
|
8609
|
+
* <p>Contains an approximate count of the resources of a given type that are not yet in sync in a
|
|
8610
|
+
* Region, along with the time the count was last calculated.</p>
|
|
8611
|
+
* @public
|
|
8612
|
+
*/
|
|
8613
|
+
export interface ApproximateDriftedResourceCount {
|
|
8614
|
+
/**
|
|
8615
|
+
* <p>The Amazon Web Services Region that the count applies to.</p>
|
|
8616
|
+
* @public
|
|
8617
|
+
*/
|
|
8618
|
+
Region: string | undefined;
|
|
8619
|
+
/**
|
|
8620
|
+
* <p>The approximate number of resources of the requested type that are not yet in sync in the
|
|
8621
|
+
* Region. A value of zero means the resources are in sync.</p>
|
|
8622
|
+
* @public
|
|
8623
|
+
*/
|
|
8624
|
+
Count: number | undefined;
|
|
8625
|
+
/**
|
|
8626
|
+
* <p>The time, in Unix epoch time, when the count was last calculated.</p>
|
|
8627
|
+
* @public
|
|
8628
|
+
*/
|
|
8629
|
+
Timestamp: Date | undefined;
|
|
8630
|
+
}
|
|
8631
|
+
/**
|
|
8632
|
+
* <p>Contains information about a resource that could not be replicated across the Regions of a
|
|
8633
|
+
* Global Resiliency deployment, including the reason and any action required to resolve it.</p>
|
|
8634
|
+
* @public
|
|
8635
|
+
*/
|
|
8636
|
+
export interface ReplicationFinding {
|
|
8637
|
+
/**
|
|
8638
|
+
* <p>The Amazon Resource Name (ARN) of the resource that the finding is for.</p>
|
|
8639
|
+
* @public
|
|
8640
|
+
*/
|
|
8641
|
+
Arn: string | undefined;
|
|
8642
|
+
/**
|
|
8643
|
+
* <p>The identifier of the resource that the finding is for.</p>
|
|
8644
|
+
* @public
|
|
8645
|
+
*/
|
|
8646
|
+
Id: string | undefined;
|
|
8647
|
+
/**
|
|
8648
|
+
* <p>The Amazon Web Services Region that the finding was detected in.</p>
|
|
8649
|
+
* @public
|
|
8650
|
+
*/
|
|
8651
|
+
Region?: string | undefined;
|
|
8652
|
+
/**
|
|
8653
|
+
* <p>The type of resource that the finding is for, such as <code>QUEUE</code> or
|
|
8654
|
+
* <code>ROUTING_PROFILE</code>.</p>
|
|
8655
|
+
* @public
|
|
8656
|
+
*/
|
|
8657
|
+
ResourceType: string | undefined;
|
|
8658
|
+
/**
|
|
8659
|
+
* <p>The name of the resource that the finding is for.</p>
|
|
8660
|
+
* @public
|
|
8661
|
+
*/
|
|
8662
|
+
Name?: string | undefined;
|
|
8663
|
+
/**
|
|
8664
|
+
* <p>The replication operation that produced the finding, such as a create, update, or delete of
|
|
8665
|
+
* the resource.</p>
|
|
8666
|
+
* @public
|
|
8667
|
+
*/
|
|
8668
|
+
Operation?: string | undefined;
|
|
8669
|
+
/**
|
|
8670
|
+
* <p>A stable code that identifies the class of the finding. Use this code to look up the
|
|
8671
|
+
* recommended steps to resolve the finding.</p>
|
|
8672
|
+
* @public
|
|
8673
|
+
*/
|
|
8674
|
+
ReferenceCode?: string | undefined;
|
|
8675
|
+
/**
|
|
8676
|
+
* <p>A human-readable description of the finding and the action, if any, required to resolve
|
|
8677
|
+
* it.</p>
|
|
8678
|
+
* @public
|
|
8679
|
+
*/
|
|
8680
|
+
Message?: string | undefined;
|
|
8681
|
+
}
|
|
8682
|
+
/**
|
|
8683
|
+
* <p>Indicates whether a resource type is being replicated and kept in sync in a specific
|
|
8684
|
+
* Amazon Web Services Region of a Global Resiliency deployment.</p>
|
|
8685
|
+
* @public
|
|
8686
|
+
*/
|
|
8687
|
+
export interface ResourceReplicationStatus {
|
|
8688
|
+
/**
|
|
8689
|
+
* <p>The Amazon Web Services Region that the replication status applies to.</p>
|
|
8690
|
+
* @public
|
|
8691
|
+
*/
|
|
8692
|
+
Region: string | undefined;
|
|
8693
|
+
/**
|
|
8694
|
+
* <p>The replication status of the resource type in the Region, such as <code>ENABLED</code>,
|
|
8695
|
+
* <code>BLOCKED</code>, or <code>DISABLED</code>.</p>
|
|
8696
|
+
* @public
|
|
8697
|
+
*/
|
|
8698
|
+
Status: string | undefined;
|
|
8699
|
+
}
|
|
8700
|
+
/**
|
|
8701
|
+
* @public
|
|
8702
|
+
*/
|
|
8703
|
+
export interface ListReplicationFindingsResponse {
|
|
8704
|
+
/**
|
|
8705
|
+
* <p>A list of replication findings for the requested resource type. Only findings that require
|
|
8706
|
+
* your action are returned, so this list can be empty even when a drift count is nonzero. Results
|
|
8707
|
+
* are paginated.</p>
|
|
8708
|
+
* @public
|
|
8709
|
+
*/
|
|
8710
|
+
ReplicationFindingsList: ReplicationFinding[] | undefined;
|
|
8711
|
+
/**
|
|
8712
|
+
* <p>The approximate number of resources of the requested type that are not yet in sync, reported
|
|
8713
|
+
* per Amazon Web Services Region. This count is independent of <code>ReplicationFindingsList</code>
|
|
8714
|
+
* and can be higher than the number of findings returned. It is eventually consistent and can lag
|
|
8715
|
+
* the current state of the instance. Each entry is the <code>ApproximateDriftedResourceCount</code>
|
|
8716
|
+
* for one Region; a Region appears only when its count has been computed.</p>
|
|
8717
|
+
* @public
|
|
8718
|
+
*/
|
|
8719
|
+
ApproximateDriftedResourceCounts?: ApproximateDriftedResourceCount[] | undefined;
|
|
8720
|
+
/**
|
|
8721
|
+
* <p>If there are additional results, this is the token for retrieving the next page of
|
|
8722
|
+
* <code>ReplicationFindingsList</code>.</p>
|
|
8723
|
+
* @public
|
|
8724
|
+
*/
|
|
8725
|
+
NextToken?: string | undefined;
|
|
8726
|
+
/**
|
|
8727
|
+
* <p>The replication status of the requested resource type in each Amazon Web Services Region
|
|
8728
|
+
* across which the Connect Customer instance is deployed for Global Resiliency, with one entry per
|
|
8729
|
+
* Region. This set describes the overall replication state for the request and is returned in full
|
|
8730
|
+
* on every page of results, so it does not change as you paginate.</p>
|
|
8731
|
+
* @public
|
|
8732
|
+
*/
|
|
8733
|
+
ResourceReplicationStatuses?: ResourceReplicationStatus[] | undefined;
|
|
8734
|
+
}
|
|
8409
8735
|
/**
|
|
8410
8736
|
* @public
|
|
8411
8737
|
*/
|
|
@@ -9993,120 +10319,3 @@ export interface ListViewsResponse {
|
|
|
9993
10319
|
*/
|
|
9994
10320
|
NextToken?: string | undefined;
|
|
9995
10321
|
}
|
|
9996
|
-
/**
|
|
9997
|
-
* @public
|
|
9998
|
-
*/
|
|
9999
|
-
export interface ListViewVersionsRequest {
|
|
10000
|
-
/**
|
|
10001
|
-
* <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
|
|
10002
|
-
* instance.</p>
|
|
10003
|
-
* @public
|
|
10004
|
-
*/
|
|
10005
|
-
InstanceId: string | undefined;
|
|
10006
|
-
/**
|
|
10007
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
|
|
10008
|
-
* @public
|
|
10009
|
-
*/
|
|
10010
|
-
ViewId: string | undefined;
|
|
10011
|
-
/**
|
|
10012
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
10013
|
-
* retrieve the next set of results.</p>
|
|
10014
|
-
* @public
|
|
10015
|
-
*/
|
|
10016
|
-
NextToken?: string | undefined;
|
|
10017
|
-
/**
|
|
10018
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
10019
|
-
* @public
|
|
10020
|
-
*/
|
|
10021
|
-
MaxResults?: number | undefined;
|
|
10022
|
-
}
|
|
10023
|
-
/**
|
|
10024
|
-
* <p>A summary of a view version's metadata.</p>
|
|
10025
|
-
* @public
|
|
10026
|
-
*/
|
|
10027
|
-
export interface ViewVersionSummary {
|
|
10028
|
-
/**
|
|
10029
|
-
* <p>The identifier of the view version.</p>
|
|
10030
|
-
* @public
|
|
10031
|
-
*/
|
|
10032
|
-
Id?: string | undefined;
|
|
10033
|
-
/**
|
|
10034
|
-
* <p>The Amazon Resource Name (ARN) of the view version.</p>
|
|
10035
|
-
* @public
|
|
10036
|
-
*/
|
|
10037
|
-
Arn?: string | undefined;
|
|
10038
|
-
/**
|
|
10039
|
-
* <p>The description of the view version.</p>
|
|
10040
|
-
* @public
|
|
10041
|
-
*/
|
|
10042
|
-
Description?: string | undefined;
|
|
10043
|
-
/**
|
|
10044
|
-
* <p>The name of the view version.</p>
|
|
10045
|
-
* @public
|
|
10046
|
-
*/
|
|
10047
|
-
Name?: string | undefined;
|
|
10048
|
-
/**
|
|
10049
|
-
* <p>The type of the view version.</p>
|
|
10050
|
-
* @public
|
|
10051
|
-
*/
|
|
10052
|
-
Type?: ViewType | undefined;
|
|
10053
|
-
/**
|
|
10054
|
-
* <p>The sequentially incremented version of the view version.</p>
|
|
10055
|
-
* @public
|
|
10056
|
-
*/
|
|
10057
|
-
Version?: number | undefined;
|
|
10058
|
-
/**
|
|
10059
|
-
* <p>The description of the view version.</p>
|
|
10060
|
-
* @public
|
|
10061
|
-
*/
|
|
10062
|
-
VersionDescription?: string | undefined;
|
|
10063
|
-
}
|
|
10064
|
-
/**
|
|
10065
|
-
* @public
|
|
10066
|
-
*/
|
|
10067
|
-
export interface ListViewVersionsResponse {
|
|
10068
|
-
/**
|
|
10069
|
-
* <p>A list of view version summaries.</p>
|
|
10070
|
-
* @public
|
|
10071
|
-
*/
|
|
10072
|
-
ViewVersionSummaryList?: ViewVersionSummary[] | undefined;
|
|
10073
|
-
/**
|
|
10074
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
10075
|
-
* retrieve the next set of results.</p>
|
|
10076
|
-
* @public
|
|
10077
|
-
*/
|
|
10078
|
-
NextToken?: string | undefined;
|
|
10079
|
-
}
|
|
10080
|
-
/**
|
|
10081
|
-
* @public
|
|
10082
|
-
*/
|
|
10083
|
-
export interface ListWorkspaceMediaRequest {
|
|
10084
|
-
/**
|
|
10085
|
-
* <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
|
|
10086
|
-
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
10087
|
-
* @public
|
|
10088
|
-
*/
|
|
10089
|
-
InstanceId: string | undefined;
|
|
10090
|
-
/**
|
|
10091
|
-
* <p>The identifier of the workspace.</p>
|
|
10092
|
-
* @public
|
|
10093
|
-
*/
|
|
10094
|
-
WorkspaceId: string | undefined;
|
|
10095
|
-
}
|
|
10096
|
-
/**
|
|
10097
|
-
* <p>Contains information about a media asset used in a workspace.</p>
|
|
10098
|
-
* @public
|
|
10099
|
-
*/
|
|
10100
|
-
export interface MediaItem {
|
|
10101
|
-
/**
|
|
10102
|
-
* <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
10103
|
-
* <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
|
|
10104
|
-
* @public
|
|
10105
|
-
*/
|
|
10106
|
-
Type?: MediaType | undefined;
|
|
10107
|
-
/**
|
|
10108
|
-
* <p>The source URL or data for the media asset.</p>
|
|
10109
|
-
* @public
|
|
10110
|
-
*/
|
|
10111
|
-
Source?: string | undefined;
|
|
10112
|
-
}
|