@aws-sdk/client-connect 3.329.0 → 3.335.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 (58) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/Connect.js +10 -0
  3. package/dist-cjs/commands/CreatePromptCommand.js +45 -0
  4. package/dist-cjs/commands/DeletePromptCommand.js +45 -0
  5. package/dist-cjs/commands/DescribePromptCommand.js +45 -0
  6. package/dist-cjs/commands/GetPromptFileCommand.js +45 -0
  7. package/dist-cjs/commands/UpdatePromptCommand.js +45 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/protocols/Aws_restJson1.js +344 -9
  10. package/dist-es/Connect.js +10 -0
  11. package/dist-es/commands/CreatePromptCommand.js +41 -0
  12. package/dist-es/commands/DeletePromptCommand.js +41 -0
  13. package/dist-es/commands/DescribePromptCommand.js +41 -0
  14. package/dist-es/commands/GetPromptFileCommand.js +41 -0
  15. package/dist-es/commands/UpdatePromptCommand.js +41 -0
  16. package/dist-es/commands/index.js +5 -0
  17. package/dist-es/protocols/Aws_restJson1.js +326 -1
  18. package/dist-types/Connect.d.ts +35 -0
  19. package/dist-types/ConnectClient.d.ts +10 -4
  20. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +4 -3
  21. package/dist-types/commands/CreateParticipantCommand.d.ts +1 -1
  22. package/dist-types/commands/CreatePromptCommand.d.ts +94 -0
  23. package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +2 -2
  24. package/dist-types/commands/DeletePromptCommand.d.ts +83 -0
  25. package/dist-types/commands/DescribePromptCommand.d.ts +93 -0
  26. package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -1
  27. package/dist-types/commands/GetMetricDataV2Command.d.ts +1 -1
  28. package/dist-types/commands/GetPromptFileCommand.d.ts +85 -0
  29. package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +4 -3
  30. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +4 -0
  31. package/dist-types/commands/UpdatePromptCommand.d.ts +89 -0
  32. package/dist-types/commands/index.d.ts +5 -0
  33. package/dist-types/endpoint/EndpointParameters.d.ts +2 -1
  34. package/dist-types/models/models_0.d.ts +107 -102
  35. package/dist-types/models/models_1.d.ts +166 -7
  36. package/dist-types/protocols/Aws_restJson1.d.ts +47 -2
  37. package/dist-types/runtimeConfig.browser.d.ts +12 -12
  38. package/dist-types/runtimeConfig.d.ts +9 -9
  39. package/dist-types/runtimeConfig.native.d.ts +13 -13
  40. package/dist-types/runtimeConfig.shared.d.ts +4 -4
  41. package/dist-types/ts3.4/Connect.d.ts +85 -0
  42. package/dist-types/ts3.4/ConnectClient.d.ts +37 -5
  43. package/dist-types/ts3.4/commands/CreatePromptCommand.d.ts +34 -0
  44. package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +32 -0
  45. package/dist-types/ts3.4/commands/DescribePromptCommand.d.ts +37 -0
  46. package/dist-types/ts3.4/commands/GetCurrentMetricDataCommand.d.ts +2 -4
  47. package/dist-types/ts3.4/commands/GetPromptFileCommand.d.ts +37 -0
  48. package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +34 -0
  49. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  50. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -2
  51. package/dist-types/ts3.4/models/models_0.d.ts +29 -26
  52. package/dist-types/ts3.4/models/models_1.d.ts +47 -3
  53. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +62 -2
  54. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +18 -15
  55. package/dist-types/ts3.4/runtimeConfig.d.ts +12 -12
  56. package/dist-types/ts3.4/runtimeConfig.native.d.ts +20 -15
  57. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +4 -4
  58. package/package.json +7 -6
@@ -0,0 +1,89 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
+ import { UpdatePromptRequest, UpdatePromptResponse } from "../models/models_1";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link UpdatePromptCommand}.
10
+ */
11
+ export interface UpdatePromptCommandInput extends UpdatePromptRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link UpdatePromptCommand}.
17
+ */
18
+ export interface UpdatePromptCommandOutput extends UpdatePromptResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Updates a prompt.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { ConnectClient, UpdatePromptCommand } from "@aws-sdk/client-connect"; // ES Modules import
27
+ * // const { ConnectClient, UpdatePromptCommand } = require("@aws-sdk/client-connect"); // CommonJS import
28
+ * const client = new ConnectClient(config);
29
+ * const input = { // UpdatePromptRequest
30
+ * InstanceId: "STRING_VALUE", // required
31
+ * PromptId: "STRING_VALUE", // required
32
+ * Name: "STRING_VALUE",
33
+ * Description: "STRING_VALUE",
34
+ * S3Uri: "STRING_VALUE",
35
+ * };
36
+ * const command = new UpdatePromptCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // UpdatePromptResponse
39
+ * // PromptARN: "STRING_VALUE",
40
+ * // PromptId: "STRING_VALUE",
41
+ * // };
42
+ *
43
+ * ```
44
+ *
45
+ * @param UpdatePromptCommandInput - {@link UpdatePromptCommandInput}
46
+ * @returns {@link UpdatePromptCommandOutput}
47
+ * @see {@link UpdatePromptCommandInput} for command's `input` shape.
48
+ * @see {@link UpdatePromptCommandOutput} for command's `response` shape.
49
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
50
+ *
51
+ * @throws {@link InternalServiceException} (server fault)
52
+ * <p>Request processing failed because of an error or failure with the service.</p>
53
+ *
54
+ * @throws {@link InvalidParameterException} (client fault)
55
+ * <p>One or more of the specified parameters are not valid.</p>
56
+ *
57
+ * @throws {@link InvalidRequestException} (client fault)
58
+ * <p>The request is not valid.</p>
59
+ *
60
+ * @throws {@link ResourceNotFoundException} (client fault)
61
+ * <p>The specified resource was not found.</p>
62
+ *
63
+ * @throws {@link ThrottlingException} (client fault)
64
+ * <p>The throttling limit has been exceeded.</p>
65
+ *
66
+ * @throws {@link ConnectServiceException}
67
+ * <p>Base exception class for all service exceptions from Connect service.</p>
68
+ *
69
+ */
70
+ export declare class UpdatePromptCommand extends $Command<UpdatePromptCommandInput, UpdatePromptCommandOutput, ConnectClientResolvedConfig> {
71
+ readonly input: UpdatePromptCommandInput;
72
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
76
+ constructor(input: UpdatePromptCommandInput);
77
+ /**
78
+ * @internal
79
+ */
80
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePromptCommandInput, UpdatePromptCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
84
+ private serialize;
85
+ /**
86
+ * @internal
87
+ */
88
+ private deserialize;
89
+ }
@@ -18,6 +18,7 @@ export * from "./CreateHoursOfOperationCommand";
18
18
  export * from "./CreateInstanceCommand";
19
19
  export * from "./CreateIntegrationAssociationCommand";
20
20
  export * from "./CreateParticipantCommand";
21
+ export * from "./CreatePromptCommand";
21
22
  export * from "./CreateQueueCommand";
22
23
  export * from "./CreateQuickConnectCommand";
23
24
  export * from "./CreateRoutingProfileCommand";
@@ -37,6 +38,7 @@ export * from "./DeleteEvaluationFormCommand";
37
38
  export * from "./DeleteHoursOfOperationCommand";
38
39
  export * from "./DeleteInstanceCommand";
39
40
  export * from "./DeleteIntegrationAssociationCommand";
41
+ export * from "./DeletePromptCommand";
40
42
  export * from "./DeleteQuickConnectCommand";
41
43
  export * from "./DeleteRuleCommand";
42
44
  export * from "./DeleteSecurityProfileCommand";
@@ -57,6 +59,7 @@ export * from "./DescribeInstanceAttributeCommand";
57
59
  export * from "./DescribeInstanceCommand";
58
60
  export * from "./DescribeInstanceStorageConfigCommand";
59
61
  export * from "./DescribePhoneNumberCommand";
62
+ export * from "./DescribePromptCommand";
60
63
  export * from "./DescribeQueueCommand";
61
64
  export * from "./DescribeQuickConnectCommand";
62
65
  export * from "./DescribeRoutingProfileCommand";
@@ -83,6 +86,7 @@ export * from "./GetCurrentUserDataCommand";
83
86
  export * from "./GetFederationTokenCommand";
84
87
  export * from "./GetMetricDataCommand";
85
88
  export * from "./GetMetricDataV2Command";
89
+ export * from "./GetPromptFileCommand";
86
90
  export * from "./GetTaskTemplateCommand";
87
91
  export * from "./GetTrafficDistributionCommand";
88
92
  export * from "./ListAgentStatusesCommand";
@@ -161,6 +165,7 @@ export * from "./UpdateInstanceAttributeCommand";
161
165
  export * from "./UpdateInstanceStorageConfigCommand";
162
166
  export * from "./UpdateParticipantRoleConfigCommand";
163
167
  export * from "./UpdatePhoneNumberCommand";
168
+ export * from "./UpdatePromptCommand";
164
169
  export * from "./UpdateQueueHoursOfOperationCommand";
165
170
  export * from "./UpdateQueueMaxContactsCommand";
166
171
  export * from "./UpdateQueueNameCommand";
@@ -1,4 +1,5 @@
1
- import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@aws-sdk/types";
1
+ import { EndpointParameters as __EndpointParameters, EndpointV2 } from "@aws-sdk/types";
2
+ import { Endpoint, Provider } from "@smithy/types";
2
3
  export interface ClientInputEndpointParameters {
3
4
  region?: string | Provider<string>;
4
5
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -50,8 +50,8 @@ export interface ActivateEvaluationFormRequest {
50
50
  */
51
51
  EvaluationFormId: string | undefined;
52
52
  /**
53
- * <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the
54
- * evaluation form is activated.</p>
53
+ * <p>The version of the evaluation form to activate. If the version property is not provided, the
54
+ * latest version of the evaluation form is activated.</p>
55
55
  */
56
56
  EvaluationFormVersion: number | undefined;
57
57
  }
@@ -1260,10 +1260,10 @@ export interface SingleSelectQuestionRuleCategoryAutomation {
1260
1260
  */
1261
1261
  Category: string | undefined;
1262
1262
  /**
1263
- * <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>, then the
1264
- * option is applied when the contact data includes the category. Similarly, if the condition is
1265
- * <code>NOT_PRESENT</code>, then the option is applied when the contact data does not include the
1266
- * category.</p>
1263
+ * <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,
1264
+ * then the option is applied when the contact data includes the category. Similarly, if the
1265
+ * condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not
1266
+ * include the category.</p>
1267
1267
  */
1268
1268
  Condition: SingleSelectQuestionRuleCategoryAutomationCondition | string | undefined;
1269
1269
  /**
@@ -1795,8 +1795,8 @@ export interface ParticipantTokenCredentials {
1795
1795
  */
1796
1796
  export interface CreateParticipantResponse {
1797
1797
  /**
1798
- * <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
1799
- * token is valid for the lifetime of a chat participant.</p>
1798
+ * <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
1799
+ * participant token is valid for the lifetime of a chat participant.</p>
1800
1800
  */
1801
1801
  ParticipantCredentials?: ParticipantTokenCredentials;
1802
1802
  /**
@@ -1805,6 +1805,44 @@ export interface CreateParticipantResponse {
1805
1805
  */
1806
1806
  ParticipantId?: string;
1807
1807
  }
1808
+ /**
1809
+ * @public
1810
+ */
1811
+ export interface CreatePromptRequest {
1812
+ /**
1813
+ * <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>
1814
+ */
1815
+ InstanceId: string | undefined;
1816
+ /**
1817
+ * <p>The name of the prompt.</p>
1818
+ */
1819
+ Name: string | undefined;
1820
+ /**
1821
+ * <p>The description of the prompt.</p>
1822
+ */
1823
+ Description?: string;
1824
+ /**
1825
+ * <p>The URI for the S3 bucket where the prompt is stored.</p>
1826
+ */
1827
+ S3Uri: string | undefined;
1828
+ /**
1829
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
1830
+ */
1831
+ Tags?: Record<string, string>;
1832
+ }
1833
+ /**
1834
+ * @public
1835
+ */
1836
+ export interface CreatePromptResponse {
1837
+ /**
1838
+ * <p>The Amazon Resource Name (ARN) of the prompt.</p>
1839
+ */
1840
+ PromptARN?: string;
1841
+ /**
1842
+ * <p>A unique identifier for the prompt.</p>
1843
+ */
1844
+ PromptId?: string;
1845
+ }
1808
1846
  /**
1809
1847
  * @public
1810
1848
  * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
@@ -3135,6 +3173,19 @@ export interface DeleteIntegrationAssociationRequest {
3135
3173
  */
3136
3174
  IntegrationAssociationId: string | undefined;
3137
3175
  }
3176
+ /**
3177
+ * @public
3178
+ */
3179
+ export interface DeletePromptRequest {
3180
+ /**
3181
+ * <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>
3182
+ */
3183
+ InstanceId: string | undefined;
3184
+ /**
3185
+ * <p>A unique identifier for the prompt.</p>
3186
+ */
3187
+ PromptId: string | undefined;
3188
+ }
3138
3189
  /**
3139
3190
  * @public
3140
3191
  */
@@ -4478,6 +4529,54 @@ export interface DescribePhoneNumberResponse {
4478
4529
  */
4479
4530
  ClaimedPhoneNumberSummary?: ClaimedPhoneNumberSummary;
4480
4531
  }
4532
+ /**
4533
+ * @public
4534
+ */
4535
+ export interface DescribePromptRequest {
4536
+ /**
4537
+ * <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>
4538
+ */
4539
+ InstanceId: string | undefined;
4540
+ /**
4541
+ * <p>A unique identifier for the prompt.</p>
4542
+ */
4543
+ PromptId: string | undefined;
4544
+ }
4545
+ /**
4546
+ * @public
4547
+ * <p>Information about a prompt.</p>
4548
+ */
4549
+ export interface Prompt {
4550
+ /**
4551
+ * <p>The Amazon Resource Name (ARN) of the prompt.</p>
4552
+ */
4553
+ PromptARN?: string;
4554
+ /**
4555
+ * <p>A unique identifier for the prompt.</p>
4556
+ */
4557
+ PromptId?: string;
4558
+ /**
4559
+ * <p>The name of the prompt.</p>
4560
+ */
4561
+ Name?: string;
4562
+ /**
4563
+ * <p>A description for the prompt.</p>
4564
+ */
4565
+ Description?: string;
4566
+ /**
4567
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4568
+ */
4569
+ Tags?: Record<string, string>;
4570
+ }
4571
+ /**
4572
+ * @public
4573
+ */
4574
+ export interface DescribePromptResponse {
4575
+ /**
4576
+ * <p>Information about the prompt.</p>
4577
+ */
4578
+ Prompt?: Prompt;
4579
+ }
4481
4580
  /**
4482
4581
  * @public
4483
4582
  */
@@ -5671,100 +5770,6 @@ export interface GetCurrentMetricDataRequest {
5671
5770
  */
5672
5771
  SortCriteria?: CurrentMetricSortCriteria[];
5673
5772
  }
5674
- /**
5675
- * @public
5676
- * <p>Contains the data for a real-time metric.</p>
5677
- */
5678
- export interface CurrentMetricData {
5679
- /**
5680
- * <p>Information about the metric.</p>
5681
- */
5682
- Metric?: CurrentMetric;
5683
- /**
5684
- * <p>The value of the metric.</p>
5685
- */
5686
- Value?: number;
5687
- }
5688
- /**
5689
- * @public
5690
- * <p>Information about the routing profile assigned to the user.</p>
5691
- */
5692
- export interface RoutingProfileReference {
5693
- /**
5694
- * <p>The identifier of the routing profile.</p>
5695
- */
5696
- Id?: string;
5697
- /**
5698
- * <p>The Amazon Resource Name (ARN) of the routing profile.</p>
5699
- */
5700
- Arn?: string;
5701
- }
5702
- /**
5703
- * @public
5704
- * <p>Contains information about the dimensions for a set of metrics.</p>
5705
- */
5706
- export interface Dimensions {
5707
- /**
5708
- * <p>Information about the queue for which metrics are returned.</p>
5709
- */
5710
- Queue?: QueueReference;
5711
- /**
5712
- * <p>The channel used for grouping and filters.</p>
5713
- */
5714
- Channel?: Channel | string;
5715
- /**
5716
- * <p>Information about the routing profile assigned to the user.</p>
5717
- */
5718
- RoutingProfile?: RoutingProfileReference;
5719
- }
5720
- /**
5721
- * @public
5722
- * <p>Contains information about a set of real-time metrics.</p>
5723
- */
5724
- export interface CurrentMetricResult {
5725
- /**
5726
- * <p>The dimensions for the metrics.</p>
5727
- */
5728
- Dimensions?: Dimensions;
5729
- /**
5730
- * <p>The set of metrics.</p>
5731
- */
5732
- Collections?: CurrentMetricData[];
5733
- }
5734
- /**
5735
- * @public
5736
- */
5737
- export interface GetCurrentMetricDataResponse {
5738
- /**
5739
- * <p>If there are additional results, this is the token for the next set of results.</p>
5740
- * <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
5741
- * the token must use the same request parameters as the request that generated the token.</p>
5742
- */
5743
- NextToken?: string;
5744
- /**
5745
- * <p>Information about the real-time metrics.</p>
5746
- */
5747
- MetricResults?: CurrentMetricResult[];
5748
- /**
5749
- * <p>The time at which the metrics were retrieved and cached for pagination.</p>
5750
- */
5751
- DataSnapshotTime?: Date;
5752
- /**
5753
- * <p>The total count of the result, regardless of the current page size. </p>
5754
- */
5755
- ApproximateTotalCount?: number;
5756
- }
5757
- /**
5758
- * @public
5759
- * <p>Filters user data based on the contact information that is associated to the users. It
5760
- * contains a list of <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
5761
- */
5762
- export interface ContactFilter {
5763
- /**
5764
- * <p>A list of up to 9 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
5765
- */
5766
- ContactStates?: (ContactState | string)[];
5767
- }
5768
5773
  /**
5769
5774
  * @internal
5770
5775
  */
@@ -1,6 +1,100 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFilter, ContactFlowModuleState, ContactFlowState, ContactFlowType, Dimensions, DirectoryType, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RoutingProfileReference, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
3
+ import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CurrentMetric, DirectoryType, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueReference, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
+ /**
5
+ * @public
6
+ * <p>Contains the data for a real-time metric.</p>
7
+ */
8
+ export interface CurrentMetricData {
9
+ /**
10
+ * <p>Information about the metric.</p>
11
+ */
12
+ Metric?: CurrentMetric;
13
+ /**
14
+ * <p>The value of the metric.</p>
15
+ */
16
+ Value?: number;
17
+ }
18
+ /**
19
+ * @public
20
+ * <p>Information about the routing profile assigned to the user.</p>
21
+ */
22
+ export interface RoutingProfileReference {
23
+ /**
24
+ * <p>The identifier of the routing profile.</p>
25
+ */
26
+ Id?: string;
27
+ /**
28
+ * <p>The Amazon Resource Name (ARN) of the routing profile.</p>
29
+ */
30
+ Arn?: string;
31
+ }
32
+ /**
33
+ * @public
34
+ * <p>Contains information about the dimensions for a set of metrics.</p>
35
+ */
36
+ export interface Dimensions {
37
+ /**
38
+ * <p>Information about the queue for which metrics are returned.</p>
39
+ */
40
+ Queue?: QueueReference;
41
+ /**
42
+ * <p>The channel used for grouping and filters.</p>
43
+ */
44
+ Channel?: Channel | string;
45
+ /**
46
+ * <p>Information about the routing profile assigned to the user.</p>
47
+ */
48
+ RoutingProfile?: RoutingProfileReference;
49
+ }
50
+ /**
51
+ * @public
52
+ * <p>Contains information about a set of real-time metrics.</p>
53
+ */
54
+ export interface CurrentMetricResult {
55
+ /**
56
+ * <p>The dimensions for the metrics.</p>
57
+ */
58
+ Dimensions?: Dimensions;
59
+ /**
60
+ * <p>The set of metrics.</p>
61
+ */
62
+ Collections?: CurrentMetricData[];
63
+ }
64
+ /**
65
+ * @public
66
+ */
67
+ export interface GetCurrentMetricDataResponse {
68
+ /**
69
+ * <p>If there are additional results, this is the token for the next set of results.</p>
70
+ * <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
71
+ * the token must use the same request parameters as the request that generated the token.</p>
72
+ */
73
+ NextToken?: string;
74
+ /**
75
+ * <p>Information about the real-time metrics.</p>
76
+ */
77
+ MetricResults?: CurrentMetricResult[];
78
+ /**
79
+ * <p>The time at which the metrics were retrieved and cached for pagination.</p>
80
+ */
81
+ DataSnapshotTime?: Date;
82
+ /**
83
+ * <p>The total count of the result, regardless of the current page size. </p>
84
+ */
85
+ ApproximateTotalCount?: number;
86
+ }
87
+ /**
88
+ * @public
89
+ * <p>Filters user data based on the contact information that is associated to the users. It
90
+ * contains a list of <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
91
+ */
92
+ export interface ContactFilter {
93
+ /**
94
+ * <p>A list of up to 9 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
95
+ */
96
+ ContactStates?: (ContactState | string)[];
97
+ }
4
98
  /**
5
99
  * @public
6
100
  * <p>A filter for the user data.</p>
@@ -617,7 +711,8 @@ export interface MetricFilterV2 {
617
711
  * <p>The key to use for filtering data. </p>
618
712
  * <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
619
713
  * These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
620
- * 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 Guide</i>. </p>
714
+ * 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
715
+ * Guide</i>. </p>
621
716
  */
622
717
  MetricFilterKey?: string;
623
718
  /**
@@ -656,6 +751,9 @@ export interface ThresholdV2 {
656
751
  export interface MetricV2 {
657
752
  /**
658
753
  * <p>The name of the metric.</p>
754
+ * <important>
755
+ * <p>This parameter is required. The following Required = No is incorrect.</p>
756
+ * </important>
659
757
  */
660
758
  Name?: string;
661
759
  /**
@@ -680,7 +778,7 @@ export interface GetMetricDataV2Request {
680
778
  * <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
681
779
  * retrieval of historical metrics data. The time must be before the end time timestamp. The time
682
780
  * range between the start and end time must be less than 24 hours. The start time cannot be earlier
683
- * than 14 days before the time of the request. Historical metrics are available for 14 days.</p>
781
+ * than 35 days before the time of the request. Historical metrics are available for 35 days.</p>
684
782
  */
685
783
  StartTime: Date | undefined;
686
784
  /**
@@ -967,6 +1065,29 @@ export interface GetMetricDataV2Response {
967
1065
  */
968
1066
  MetricResults?: MetricResultV2[];
969
1067
  }
1068
+ /**
1069
+ * @public
1070
+ */
1071
+ export interface GetPromptFileRequest {
1072
+ /**
1073
+ * <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>
1074
+ */
1075
+ InstanceId: string | undefined;
1076
+ /**
1077
+ * <p>A unique identifier for the prompt.</p>
1078
+ */
1079
+ PromptId: string | undefined;
1080
+ }
1081
+ /**
1082
+ * @public
1083
+ */
1084
+ export interface GetPromptFileResponse {
1085
+ /**
1086
+ * <p>A generated URL to the prompt that can be given to an unauthorized user so they can access
1087
+ * the prompt in S3.</p>
1088
+ */
1089
+ PromptPresignedUrl?: string;
1090
+ }
970
1091
  /**
971
1092
  * @public
972
1093
  */
@@ -3239,8 +3360,8 @@ export interface ListUsersResponse {
3239
3360
  */
3240
3361
  export interface MonitorContactRequest {
3241
3362
  /**
3242
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
3243
- * instance.</p>
3363
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
3364
+ * the instance.</p>
3244
3365
  */
3245
3366
  InstanceId: string | undefined;
3246
3367
  /**
@@ -4034,8 +4155,8 @@ export interface StartChatContactRequest {
4034
4155
  */
4035
4156
  PersistentChat?: PersistentChat;
4036
4157
  /**
4037
- * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the chat
4038
- * starting.</p>
4158
+ * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
4159
+ * chat starting.</p>
4039
4160
  * <note>
4040
4161
  * <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
4041
4162
  * </note>
@@ -5181,6 +5302,44 @@ export interface UpdatePhoneNumberResponse {
5181
5302
  */
5182
5303
  PhoneNumberArn?: string;
5183
5304
  }
5305
+ /**
5306
+ * @public
5307
+ */
5308
+ export interface UpdatePromptRequest {
5309
+ /**
5310
+ * <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>
5311
+ */
5312
+ InstanceId: string | undefined;
5313
+ /**
5314
+ * <p>A unique identifier for the prompt.</p>
5315
+ */
5316
+ PromptId: string | undefined;
5317
+ /**
5318
+ * <p>The name of the prompt.</p>
5319
+ */
5320
+ Name?: string;
5321
+ /**
5322
+ * <p>A description of the prompt.</p>
5323
+ */
5324
+ Description?: string;
5325
+ /**
5326
+ * <p>The URI for the S3 bucket where the prompt is stored.</p>
5327
+ */
5328
+ S3Uri?: string;
5329
+ }
5330
+ /**
5331
+ * @public
5332
+ */
5333
+ export interface UpdatePromptResponse {
5334
+ /**
5335
+ * <p>The Amazon Resource Name (ARN) of the prompt.</p>
5336
+ */
5337
+ PromptARN?: string;
5338
+ /**
5339
+ * <p>A unique identifier for the prompt.</p>
5340
+ */
5341
+ PromptId?: string;
5342
+ }
5184
5343
  /**
5185
5344
  * @public
5186
5345
  */