@aws-sdk/client-connect 3.577.0 → 3.578.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.
Files changed (5) hide show
  1. package/dist-types/commands/CreatePromptCommand.d.ts +1 -1
  2. package/dist-types/commands/GetMetricDataV2Command.d.ts +1 -1
  3. package/dist-types/models/models_0.d.ts +1 -1
  4. package/dist-types/models/models_1.d.ts +118 -46
  5. package/package.json +1 -1
package/dist-types/commands/CreatePromptCommand.d.ts CHANGED
@@ -27,7 +27,7 @@ declare const CreatePromptCommand_base: {
27
27
  };
28
28
  /**
29
29
  * <p>Creates a prompt. For more information about prompts, such as supported file types and
30
- * maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's
30
+ * maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator
31
31
  * Guide</i>.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
package/dist-types/commands/GetMetricDataV2Command.d.ts CHANGED
@@ -34,7 +34,7 @@ declare const GetMetricDataV2Command_base: {
34
34
  * hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. </p>
35
35
  * <p>For a description of the historical metrics that are supported by
36
36
  * <code>GetMetricDataV2</code> and <code>GetMetricData</code>, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics
37
- * definitions</a> in the <i>Amazon Connect Administrator's Guide</i>.</p>
37
+ * definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
38
38
  * @example
39
39
  * Use a bare-bones client and the command you need to make an API call.
40
40
  * ```javascript
package/dist-types/models/models_0.d.ts CHANGED
@@ -2093,7 +2093,7 @@ export interface CreateContactFlowRequest {
2093
2093
  Content: string | undefined;
2094
2094
  /**
2095
2095
  * <p>Indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
2096
- * <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code>
2096
+ * <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code>
2097
2097
  * status does not initiate validation of the content. <code>SAVED</code> |
2098
2098
  * <code>PUBLISHED</code>.</p>
2099
2099
  * @public
package/dist-types/models/models_1.d.ts CHANGED
@@ -3466,8 +3466,8 @@ export interface MetricFilterV2 {
3466
3466
  * <p>The key to use for filtering data. </p>
3467
3467
  * <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
3468
3468
  * These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
3469
- * in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
3470
- * Guide</i>. </p>
3469
+ * in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator Guide</i>.
3470
+ * </p>
3471
3471
  * @public
3472
3472
  */
3473
3473
  MetricFilterKey?: string;
@@ -3618,45 +3618,49 @@ export interface GetMetricDataV2Request {
3618
3618
  * <p>The filters to apply to returned metrics. You can filter on the following resources:</p>
3619
3619
  * <ul>
3620
3620
  * <li>
3621
- * <p>Queues</p>
3621
+ * <p>Agents</p>
3622
3622
  * </li>
3623
3623
  * <li>
3624
- * <p>Routing profiles</p>
3624
+ * <p>Channels</p>
3625
3625
  * </li>
3626
3626
  * <li>
3627
- * <p>Agents</p>
3627
+ * <p>Feature</p>
3628
3628
  * </li>
3629
3629
  * <li>
3630
- * <p>Channels</p>
3630
+ * <p>Queues</p>
3631
3631
  * </li>
3632
3632
  * <li>
3633
- * <p>User hierarchy groups</p>
3633
+ * <p>Routing profiles</p>
3634
3634
  * </li>
3635
3635
  * <li>
3636
- * <p>Feature</p>
3636
+ * <p>Routing step expression</p>
3637
3637
  * </li>
3638
3638
  * <li>
3639
- * <p>Routing step expression</p>
3639
+ * <p>User hierarchy groups</p>
3640
3640
  * </li>
3641
3641
  * </ul>
3642
3642
  * <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
3643
3643
  * groups.</p>
3644
3644
  * <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
3645
- * metrics report</a> in the <i>Amazon Connect Administrator's
3645
+ * metrics report</a> in the <i>Amazon Connect Administrator
3646
3646
  * Guide</i>.</p>
3647
3647
  * <p>Note the following limits:</p>
3648
3648
  * <ul>
3649
3649
  * <li>
3650
3650
  * <p>
3651
3651
  * <b>Filter keys</b>: A maximum of 5 filter keys are supported in
3652
- * a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
3653
- * <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
3654
- * <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
3655
- * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
3656
- * <code>FEATURE</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
3657
- * <code>contact/segmentAttributes/connect:Subtype</code> | <code>ROUTING_STEP_EXPRESSION</code>
3658
- * | <code>Q_CONNECT_ENABLED</code>
3659
- * </p>
3652
+ * a single request. Valid filter keys: <code>AGENT</code> |
3653
+ * <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> |
3654
+ * <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> |
3655
+ * <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>CASE_TEMPLATE_ARN</code> |
3656
+ * <code>CASE_STATUS</code> | <code>CHANNEL</code> |
3657
+ * <code>contact/segmentAttributes/connect:Subtype</code> | <code>FEATURE</code> |
3658
+ * <code>FLOW_TYPE</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> |
3659
+ * <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> |
3660
+ * <code>FLOWS_RESOURCE_ID</code> | <code>INITIATION_METHOD</code> |
3661
+ * <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
3662
+ * <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> |
3663
+ * </p>
3660
3664
  * </li>
3661
3665
  * <li>
3662
3666
  * <p>
@@ -3699,20 +3703,22 @@ export interface GetMetricDataV2Request {
3699
3703
  * by queue, the metrics returned are grouped by queue. The values that are returned apply to the
3700
3704
  * metrics for each queue. They are not aggregated for all queues.</p>
3701
3705
  * <p>If no grouping is specified, a summary of all metrics is returned.</p>
3702
- * <p>Valid grouping keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> | <code>AGENT</code>
3703
- * | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
3706
+ * <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
3704
3707
  * <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
3705
3708
  * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
3706
- * <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
3707
- * <code>contact/segmentAttributes/connect:Subtype</code> | <code>ROUTING_STEP_EXPRESSION</code> |
3708
- * <code>Q_CONNECT_ENABLED</code>
3709
+ * <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
3710
+ * <code>contact/segmentAttributes/connect:Subtype</code> | <code>FLOWS_RESOURCE_ID</code> |
3711
+ * <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code>
3712
+ * | <code>INITIATION_METHOD</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> |
3713
+ * <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
3714
+ * <code>ROUTING_STEP_EXPRESSION</code>
3709
3715
  * </p>
3710
3716
  * @public
3711
3717
  */
3712
3718
  Groupings?: string[];
3713
3719
  /**
3714
3720
  * <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
3715
- * following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator's
3721
+ * following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator
3716
3722
  * Guide</i>.</p>
3717
3723
  * <dl>
3718
3724
  * <dt>ABANDONMENT_RATE</dt>
@@ -3869,6 +3875,15 @@ export interface GetMetricDataV2Request {
3869
3875
  * <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>
3870
3876
  * </p>
3871
3877
  * </dd>
3878
+ * <dt>AVG_FLOW_TIME</dt>
3879
+ * <dd>
3880
+ * <p>Unit: Seconds</p>
3881
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
3882
+ * resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
3883
+ * resource ID, Initiation method, Resource published timestamp</p>
3884
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical">Average flow time</a>
3885
+ * </p>
3886
+ * </dd>
3872
3887
  * <dt>AVG_GREETING_TIME_AGENT</dt>
3873
3888
  * <dd>
3874
3889
  * <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -4031,11 +4046,42 @@ export interface GetMetricDataV2Request {
4031
4046
  * <dt>CONTACTS_ABANDONED</dt>
4032
4047
  * <dd>
4033
4048
  * <p>Unit: Count</p>
4049
+ * <p>Metric filter: </p>
4050
+ * <ul>
4051
+ * <li>
4052
+ * <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> |
4053
+ * <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>|
4054
+ * <code>Disconnect</code>
4055
+ * </p>
4056
+ * </li>
4057
+ * </ul>
4034
4058
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
4035
4059
  * contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
4036
4060
  * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical">Contact abandoned</a>
4037
4061
  * </p>
4038
4062
  * </dd>
4063
+ * <dt>CONTACTS_ABANDONED_IN_X</dt>
4064
+ * <dd>
4065
+ * <p>Unit: Count</p>
4066
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4067
+ * Q in Connect</p>
4068
+ * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4069
+ * (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4070
+ * "Less than"). </p>
4071
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
4072
+ * </p>
4073
+ * </dd>
4074
+ * <dt>CONTACTS_ANSWERED_IN_X</dt>
4075
+ * <dd>
4076
+ * <p>Unit: Count</p>
4077
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4078
+ * Q in Connect</p>
4079
+ * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4080
+ * (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4081
+ * "Less than"). </p>
4082
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
4083
+ * </p>
4084
+ * </dd>
4039
4085
  * <dt>CONTACTS_CREATED</dt>
4040
4086
  * <dd>
4041
4087
  * <p>Unit: Count</p>
@@ -4178,6 +4224,32 @@ export interface GetMetricDataV2Request {
4178
4224
  * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical">Current cases</a>
4179
4225
  * </p>
4180
4226
  * </dd>
4227
+ * <dt>FLOWS_OUTCOME</dt>
4228
+ * <dd>
4229
+ * <p>Unit: Count</p>
4230
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4231
+ * resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4232
+ * resource ID, Initiation method, Resource published timestamp</p>
4233
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flows outcome</a>
4234
+ * </p>
4235
+ * </dd>
4236
+ * <dt>FLOWS_STARTED</dt>
4237
+ * <dd>
4238
+ * <p>Unit: Count</p>
4239
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4240
+ * resource ID, Flows resource ID, Initiation method, Resource published timestamp</p>
4241
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical">Flows started</a>
4242
+ * </p>
4243
+ * </dd>
4244
+ * <dt>MAX_FLOW_TIME</dt>
4245
+ * <dd>
4246
+ * <p>Unit: Seconds</p>
4247
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4248
+ * resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4249
+ * resource ID, Initiation method, Resource published timestamp</p>
4250
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical">Maximum flow time</a>
4251
+ * </p>
4252
+ * </dd>
4181
4253
  * <dt>MAX_QUEUED_TIME</dt>
4182
4254
  * <dd>
4183
4255
  * <p>Unit: Seconds</p>
@@ -4186,6 +4258,15 @@ export interface GetMetricDataV2Request {
4186
4258
  * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical">Maximum queued time</a>
4187
4259
  * </p>
4188
4260
  * </dd>
4261
+ * <dt>MIN_FLOW_TIME</dt>
4262
+ * <dd>
4263
+ * <p>Unit: Seconds</p>
4264
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4265
+ * resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4266
+ * resource ID, Initiation method, Resource published timestamp</p>
4267
+ * <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>
4268
+ * </p>
4269
+ * </dd>
4189
4270
  * <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt>
4190
4271
  * <dd>
4191
4272
  * <p>Unit: Percent</p>
@@ -4206,6 +4287,19 @@ export interface GetMetricDataV2Request {
4206
4287
  * <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
4207
4288
  * <p>UI name: Not available </p>
4208
4289
  * </dd>
4290
+ * <dt>PERCENT_FLOWS_OUTCOME</dt>
4291
+ * <dd>
4292
+ * <p>Unit: Percent</p>
4293
+ * <p>Valid metric filter key: <code>FLOWS_OUTCOME_TYPE</code>
4294
+ * </p>
4295
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
4296
+ * resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
4297
+ * resource ID, Initiation method, Resource published timestamp</p>
4298
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical">Flows outcome percentage</a>.</p>
4299
+ * <note>
4300
+ * <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p>
4301
+ * </note>
4302
+ * </dd>
4209
4303
  * <dt>PERCENT_NON_TALK_TIME</dt>
4210
4304
  * <dd>
4211
4305
  * <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -4319,28 +4413,6 @@ export interface GetMetricDataV2Request {
4319
4413
  * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical">Agent on contact time</a>
4320
4414
  * </p>
4321
4415
  * </dd>
4322
- * <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
4323
- * <dd>
4324
- * <p>Unit: Count</p>
4325
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4326
- * Q in Connect</p>
4327
- * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4328
- * (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4329
- * "Less than"). </p>
4330
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
4331
- * </p>
4332
- * </dd>
4333
- * <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
4334
- * <dd>
4335
- * <p>Unit: Count</p>
4336
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
4337
- * Q in Connect</p>
4338
- * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4339
- * (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4340
- * "Less than"). </p>
4341
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
4342
- * </p>
4343
- * </dd>
4344
4416
  * <dt>SUM_CONTACTS_DISCONNECTED </dt>
4345
4417
  * <dd>
4346
4418
  * <p>Valid metric filter key: <code>DISCONNECT_REASON</code>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connect",
3
3
  "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
4
- "version": "3.577.0",
4
+ "version": "3.578.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-connect",