@aws-sdk/client-connect 3.699.0 → 3.703.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 (73) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/index.js +123 -49
  3. package/dist-es/commands/CreateContactCommand.js +1 -1
  4. package/dist-es/commands/StartEmailContactCommand.js +1 -1
  5. package/dist-es/commands/StartTaskContactCommand.js +1 -1
  6. package/dist-es/commands/UpdateContactCommand.js +1 -1
  7. package/dist-es/models/models_0.js +6 -5
  8. package/dist-es/models/models_1.js +5 -0
  9. package/dist-es/models/models_2.js +13 -27
  10. package/dist-es/models/models_3.js +23 -0
  11. package/dist-es/protocols/Aws_restJson1.js +64 -8
  12. package/dist-types/Connect.d.ts +1 -1
  13. package/dist-types/ConnectClient.d.ts +1 -1
  14. package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
  15. package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
  16. package/dist-types/commands/CreateContactCommand.d.ts +13 -2
  17. package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -1
  18. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
  19. package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
  20. package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -2
  22. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
  23. package/dist-types/commands/DescribeContactCommand.d.ts +10 -0
  24. package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
  25. package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
  26. package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -1
  28. package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
  29. package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
  30. package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
  31. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +2 -1
  32. package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
  33. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
  34. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
  35. package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
  36. package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -3
  37. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -1
  38. package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
  39. package/dist-types/commands/SendOutboundEmailCommand.d.ts +6 -1
  40. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +3 -1
  41. package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
  42. package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
  43. package/dist-types/commands/StartEmailContactCommand.d.ts +14 -2
  44. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +14 -3
  45. package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +2 -1
  46. package/dist-types/commands/StartTaskContactCommand.d.ts +12 -1
  47. package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
  48. package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
  49. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  50. package/dist-types/commands/UpdateContactCommand.d.ts +33 -1
  51. package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  52. package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  53. package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +2 -1
  54. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +2 -2
  55. package/dist-types/index.d.ts +1 -1
  56. package/dist-types/models/models_0.d.ts +87 -119
  57. package/dist-types/models/models_1.d.ts +238 -89
  58. package/dist-types/models/models_2.d.ts +442 -699
  59. package/dist-types/models/models_3.d.ts +598 -127
  60. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +2 -4
  61. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +4 -2
  63. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
  65. package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
  66. package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
  67. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  68. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  69. package/dist-types/ts3.4/models/models_0.d.ts +11 -21
  70. package/dist-types/ts3.4/models/models_1.d.ts +18 -6
  71. package/dist-types/ts3.4/models/models_2.d.ts +63 -96
  72. package/dist-types/ts3.4/models/models_3.d.ts +99 -27
  73. package/package.json +1 -1
@@ -1,26 +1,6 @@
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 DeleteViewVersionResponse {
8
- }
9
- /**
10
- * @public
11
- */
12
- export interface DeleteVocabularyRequest {
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
- * <p>The identifier of the custom vocabulary.</p>
20
- * @public
21
- */
22
- VocabularyId: string | undefined;
23
- }
24
4
  /**
25
5
  * @public
26
6
  */
@@ -234,22 +214,22 @@ export interface Customer {
234
214
  Capabilities?: ParticipantCapabilities | undefined;
235
215
  }
236
216
  /**
237
- * <p></p>
217
+ * <p>Information about the endpoint.</p>
238
218
  * @public
239
219
  */
240
220
  export interface EndpointInfo {
241
221
  /**
242
- * <p></p>
222
+ * <p>Type of endpoint.</p>
243
223
  * @public
244
224
  */
245
225
  Type?: EndpointType | undefined;
246
226
  /**
247
- * <p></p>
227
+ * <p>Address of the endpoint.</p>
248
228
  * @public
249
229
  */
250
230
  Address?: string | undefined;
251
231
  /**
252
- * <p></p>
232
+ * <p>Display name of the endpoint.</p>
253
233
  * @public
254
234
  */
255
235
  DisplayName?: string | undefined;
@@ -702,7 +682,7 @@ export interface ContactFlow {
702
682
  */
703
683
  State?: ContactFlowState | undefined;
704
684
  /**
705
- * <p>The status of the contact flow.</p>
685
+ * <p>The status of the flow.</p>
706
686
  * @public
707
687
  */
708
688
  Status?: ContactFlowStatus | undefined;
@@ -723,12 +703,6 @@ export interface ContactFlow {
723
703
  * @public
724
704
  */
725
705
  Tags?: Record<string, string> | undefined;
726
- /**
727
- * <p>Amazon Connect includes a set of default flows that have already been published. It uses
728
- * them to power your contact center.</p>
729
- * @public
730
- */
731
- IsDefault?: boolean | undefined;
732
706
  /**
733
707
  * <p>Indicates the checksum value of the flow content.</p>
734
708
  * @public
@@ -745,12 +719,12 @@ export interface ContactFlow {
745
719
  */
746
720
  VersionDescription?: string | undefined;
747
721
  /**
748
- * <p>The time at which the contact flow was last modified.</p>
722
+ * <p>The time at which the flow was last modified.</p>
749
723
  * @public
750
724
  */
751
725
  LastModifiedTime?: Date | undefined;
752
726
  /**
753
- * <p>The region in which the contact flow was last modified</p>
727
+ * <p>The region in which the flow was last modified</p>
754
728
  * @public
755
729
  */
756
730
  LastModifiedRegion?: string | undefined;
@@ -866,12 +840,12 @@ export interface DescribeContactFlowModuleResponse {
866
840
  */
867
841
  export interface DescribeEmailAddressRequest {
868
842
  /**
869
- * <p></p>
843
+ * <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>
870
844
  * @public
871
845
  */
872
846
  InstanceId: string | undefined;
873
847
  /**
874
- * <p></p>
848
+ * <p>The identifier of the email address.</p>
875
849
  * @public
876
850
  */
877
851
  EmailAddressId: string | undefined;
@@ -881,42 +855,42 @@ export interface DescribeEmailAddressRequest {
881
855
  */
882
856
  export interface DescribeEmailAddressResponse {
883
857
  /**
884
- * <p></p>
858
+ * <p>The identifier of the email address.</p>
885
859
  * @public
886
860
  */
887
861
  EmailAddressId?: string | undefined;
888
862
  /**
889
- * <p></p>
863
+ * <p>The Amazon Resource Name (ARN) of the email address.</p>
890
864
  * @public
891
865
  */
892
866
  EmailAddressArn?: string | undefined;
893
867
  /**
894
- * <p></p>
868
+ * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
895
869
  * @public
896
870
  */
897
871
  EmailAddress?: string | undefined;
898
872
  /**
899
- * <p></p>
873
+ * <p>The display name of email address</p>
900
874
  * @public
901
875
  */
902
876
  DisplayName?: string | undefined;
903
877
  /**
904
- * <p></p>
878
+ * <p>The description of the email address.</p>
905
879
  * @public
906
880
  */
907
881
  Description?: string | undefined;
908
882
  /**
909
- * <p></p>
883
+ * <p>The email address creation timestamp in ISO 8601 Datetime.</p>
910
884
  * @public
911
885
  */
912
886
  CreateTimestamp?: string | undefined;
913
887
  /**
914
- * <p></p>
888
+ * <p>The email address last modification timestamp in ISO 8601 Datetime.</p>
915
889
  * @public
916
890
  */
917
891
  ModifiedTimestamp?: string | undefined;
918
892
  /**
919
- * <p></p>
893
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
920
894
  * @public
921
895
  */
922
896
  Tags?: Record<string, string> | undefined;
@@ -1730,8 +1704,8 @@ export interface ClaimedPhoneNumberSummary {
1730
1704
  PhoneNumberStatus?: PhoneNumberStatus | undefined;
1731
1705
  /**
1732
1706
  * <p>The claimed phone number ARN that was previously imported from the external service, such as
1733
- * Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number
1734
- * that was imported from Amazon Pinpoint.</p>
1707
+ * Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number
1708
+ * that was imported from Amazon Web Services End User Messaging.</p>
1735
1709
  * @public
1736
1710
  */
1737
1711
  SourcePhoneNumberArn?: string | undefined;
@@ -1923,7 +1897,7 @@ export interface Queue {
1923
1897
  */
1924
1898
  OutboundCallerConfig?: OutboundCallerConfig | undefined;
1925
1899
  /**
1926
- * <p></p>
1900
+ * <p>The outbound email address ID for a specified queue.</p>
1927
1901
  * @public
1928
1902
  */
1929
1903
  OutboundEmailConfig?: OutboundEmailConfig | undefined;
@@ -2265,7 +2239,7 @@ export interface SecurityProfile {
2265
2239
  */
2266
2240
  OrganizationResourceId?: string | undefined;
2267
2241
  /**
2268
- * <p>The Amazon Resource Name (ARN) for the secruity profile.</p>
2242
+ * <p>The Amazon Resource Name (ARN) for the security profile.</p>
2269
2243
  * @public
2270
2244
  */
2271
2245
  Arn?: string | undefined;
@@ -2936,6 +2910,16 @@ export interface DisassociateFlowRequest {
2936
2910
  InstanceId: string | undefined;
2937
2911
  /**
2938
2912
  * <p>The identifier of the resource.</p>
2913
+ * <ul>
2914
+ * <li>
2915
+ * <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
2916
+ * </p>
2917
+ * </li>
2918
+ * <li>
2919
+ * <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
2920
+ * </p>
2921
+ * </li>
2922
+ * </ul>
2939
2923
  * @public
2940
2924
  */
2941
2925
  ResourceId: string | undefined;
@@ -3170,7 +3154,7 @@ export interface DismissUserContactResponse {
3170
3154
  */
3171
3155
  export interface GetAttachedFileRequest {
3172
3156
  /**
3173
- * <p>The unique identifier of the Connect instance.</p>
3157
+ * <p>The unique identifier of the Amazon Connect instance.</p>
3174
3158
  * @public
3175
3159
  */
3176
3160
  InstanceId: string | undefined;
@@ -3186,8 +3170,8 @@ export interface GetAttachedFileRequest {
3186
3170
  */
3187
3171
  UrlExpiryInSeconds?: number | undefined;
3188
3172
  /**
3189
- * <p>The resource to which the attached file is (being) uploaded to. <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Cases</a> are the only
3190
- * current supported resource.</p>
3173
+ * <p>The resource to which the attached file is (being) uploaded to. The supported resources are
3174
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p>
3191
3175
  * <note>
3192
3176
  * <p>This value must be a valid ARN.</p>
3193
3177
  * </note>
@@ -4038,6 +4022,16 @@ export interface GetFlowAssociationRequest {
4038
4022
  InstanceId: string | undefined;
4039
4023
  /**
4040
4024
  * <p>The identifier of the resource.</p>
4025
+ * <ul>
4026
+ * <li>
4027
+ * <p>Amazon Web Services End User Messaging SMS phone number ARN when using <code>SMS_PHONE_NUMBER</code>
4028
+ * </p>
4029
+ * </li>
4030
+ * <li>
4031
+ * <p>Amazon Web Services End User Messaging Social phone number ARN when using <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
4032
+ * </p>
4033
+ * </li>
4034
+ * </ul>
4041
4035
  * @public
4042
4036
  */
4043
4037
  ResourceId: string | undefined;
@@ -4564,6 +4558,18 @@ export interface MetricFilterV2 {
4564
4558
  * <p>For valid values of the metric-level filter <code>FLOWS_OUTCOME_TYPE</code>, see the
4565
4559
  * 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
4566
4560
  * Guide</i>.</p>
4561
+ * <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see the
4562
+ * description for the
4563
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot conversations completed</a>
4564
+ *
4565
+ * in the <i>Amazon Connect Administrator
4566
+ * Guide</i>.</p>
4567
+ * <p>For valid values of the metric-level filter <code>BOT_INTENT_OUTCOME_TYPE</code>, see the description for
4568
+ * the
4569
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents completed</a>
4570
+ *
4571
+ * metric in the <i>Amazon Connect Administrator
4572
+ * Guide</i>.</p>
4567
4573
  * @public
4568
4574
  */
4569
4575
  MetricFilterValues?: string[] | undefined;
@@ -4740,15 +4746,19 @@ export interface GetMetricDataV2Request {
4740
4746
  * <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> |
4741
4747
  * <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> |
4742
4748
  * <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> |
4743
- * <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>
4744
- * |<code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
4749
+ * <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> |
4750
+ * <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> |
4751
+ * <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> |
4752
+ * <code>CASE_STATUS</code> | <code>CHANNEL</code> |
4745
4753
  * <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
4746
- * <code>FEATURE</code> | <code>FLOW_TYPE</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> |
4754
+ * <code>FEATURE</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> |
4755
+ * <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> |
4747
4756
  * <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> |
4748
4757
  * <code>FLOWS_RESOURCE_ID</code> | <code>INITIATION_METHOD</code> |
4749
- * <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
4750
- * <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> |
4751
- * </p>
4758
+ * <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
4759
+ * <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> |
4760
+ * <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> |
4761
+ * <code>Q_CONNECT_ENABLED</code> | </p>
4752
4762
  * </li>
4753
4763
  * <li>
4754
4764
  * <p>
@@ -4797,12 +4807,15 @@ export interface GetMetricDataV2Request {
4797
4807
  * <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
4798
4808
  * <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
4799
4809
  * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
4800
- * <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>CAMPAIGN</code> |
4801
- * <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CASE_TEMPLATE_ARN</code> |
4802
- * <code>CASE_STATUS</code> | <code>CHANNEL</code> |
4810
+ * <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> |
4811
+ * <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> |
4812
+ * <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |
4813
+ * <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
4803
4814
  * <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
4804
- * <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_TYPE</code>
4805
- * | <code>FLOWS_OUTCOME_TYPE</code> | <code>INITIATION_METHOD</code> |
4815
+ * <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> |
4816
+ * <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code> |
4817
+ * <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> |
4818
+ * <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
4806
4819
  * <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code>
4807
4820
  * | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code>
4808
4821
  * </p>
@@ -4933,6 +4946,27 @@ export interface GetMetricDataV2Request {
4933
4946
  * <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>
4934
4947
  * </p>
4935
4948
  * </dd>
4949
+ * <dt>AVG_BOT_CONVERSATION_TIME</dt>
4950
+ * <dd>
4951
+ * <p>Unit: Seconds</p>
4952
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
4953
+ * version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
4954
+ * Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
4955
+ * resource ID</p>
4956
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time-metric">Average
4957
+ * bot conversation time</a>
4958
+ * </p>
4959
+ * </dd>
4960
+ * <dt>AVG_BOT_CONVERSATION_TURNS</dt>
4961
+ * <dd>
4962
+ * <p>Unit: Count</p>
4963
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
4964
+ * version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
4965
+ * Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
4966
+ * resource ID</p>
4967
+ * <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>
4968
+ * </p>
4969
+ * </dd>
4936
4970
  * <dt>AVG_CASE_RELATED_CONTACTS</dt>
4937
4971
  * <dd>
4938
4972
  * <p>Unit: Count</p>
@@ -5146,6 +5180,28 @@ export interface GetMetricDataV2Request {
5146
5180
  * <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>
5147
5181
  * </p>
5148
5182
  * </dd>
5183
+ * <dt>BOT_CONVERSATIONS_COMPLETED</dt>
5184
+ * <dd>
5185
+ * <p>Unit: Count</p>
5186
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
5187
+ * version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
5188
+ * Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
5189
+ * resource ID</p>
5190
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot
5191
+ * conversations</a>
5192
+ * </p>
5193
+ * </dd>
5194
+ * <dt>BOT_INTENTS_COMPLETED</dt>
5195
+ * <dd>
5196
+ * <p>Unit: Count</p>
5197
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
5198
+ * version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,
5199
+ * Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource
5200
+ * type, Parent flows resource ID</p>
5201
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents
5202
+ * completed</a>
5203
+ * </p>
5204
+ * </dd>
5149
5205
  * <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt>
5150
5206
  * <dd>
5151
5207
  * <p>This metric is available only for outbound campaigns using the agent assisted voice and
@@ -5439,6 +5495,27 @@ export interface GetMetricDataV2Request {
5439
5495
  * <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>
5440
5496
  * </p>
5441
5497
  * </dd>
5498
+ * <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt>
5499
+ * <dd>
5500
+ * <p>Unit: Percent</p>
5501
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
5502
+ * version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
5503
+ * Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
5504
+ * resource ID</p>
5505
+ * <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>
5506
+ * </p>
5507
+ * </dd>
5508
+ * <dt>PERCENT_BOT_INTENTS_OUTCOME</dt>
5509
+ * <dd>
5510
+ * <p>Unit: Percent</p>
5511
+ * <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot
5512
+ * version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,
5513
+ * Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource
5514
+ * type, Parent flows resource ID</p>
5515
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome-metric">Percent
5516
+ * bot intents outcome</a>
5517
+ * </p>
5518
+ * </dd>
5442
5519
  * <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt>
5443
5520
  * <dd>
5444
5521
  * <p>Unit: Percent</p>
@@ -5888,7 +5965,8 @@ export interface GetTaskTemplateResponse {
5888
5965
  */
5889
5966
  ContactFlowId?: string | undefined;
5890
5967
  /**
5891
- * <p></p>
5968
+ * <p>ContactFlowId for the flow that will be run if this template is used to create a
5969
+ * self-assigned task</p>
5892
5970
  * @public
5893
5971
  */
5894
5972
  SelfAssignFlowId?: string | undefined;
@@ -6024,8 +6102,8 @@ export interface ImportPhoneNumberRequest {
6024
6102
  */
6025
6103
  InstanceId: string | undefined;
6026
6104
  /**
6027
- * <p>The claimed phone number ARN being imported from the external service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number to
6028
- * import from Amazon Pinpoint.</p>
6105
+ * <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 like the ARN of the phone number to
6106
+ * import from Amazon Web Services End User Messaging.</p>
6029
6107
  * @public
6030
6108
  */
6031
6109
  SourcePhoneNumberArn: string | undefined;
@@ -6188,73 +6266,76 @@ export interface ListApprovedOriginsResponse {
6188
6266
  */
6189
6267
  export interface ListAssociatedContactsRequest {
6190
6268
  /**
6191
- * <p></p>
6269
+ * <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>
6192
6270
  * @public
6193
6271
  */
6194
6272
  InstanceId: string | undefined;
6195
6273
  /**
6196
- * <p></p>
6274
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
6197
6275
  * @public
6198
6276
  */
6199
6277
  ContactId: string | undefined;
6200
6278
  /**
6201
- * <p></p>
6279
+ * <p>The maximum number of results to return per page.</p>
6280
+ * <p>The maximum number of results to return per page. The default MaxResult size is 25.</p>
6281
+ * <p>Valid Range: Minimum value of 1. Maximum value of 100.</p>
6202
6282
  * @public
6203
6283
  */
6204
6284
  MaxResults?: number | undefined;
6205
6285
  /**
6206
- * <p></p>
6286
+ * <p>The token for the next set of results. Use the value returned in the previous
6287
+ * response in the next request to retrieve the next set of results.</p>
6207
6288
  * @public
6208
6289
  */
6209
6290
  NextToken?: string | undefined;
6210
6291
  }
6211
6292
  /**
6212
- * <p></p>
6293
+ * <p>Contact summary of a contact in contact tree associated with unique identifier.</p>
6213
6294
  * @public
6214
6295
  */
6215
6296
  export interface AssociatedContactSummary {
6216
6297
  /**
6217
- * <p></p>
6298
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
6218
6299
  * @public
6219
6300
  */
6220
6301
  ContactId?: string | undefined;
6221
6302
  /**
6222
- * <p></p>
6303
+ * <p>The Amazon Resource Name (ARN) of the contact</p>
6223
6304
  * @public
6224
6305
  */
6225
6306
  ContactArn?: string | undefined;
6226
6307
  /**
6227
- * <p></p>
6308
+ * <p>The date and time this contact was initiated, in UTC time.</p>
6228
6309
  * @public
6229
6310
  */
6230
6311
  InitiationTimestamp?: Date | undefined;
6231
6312
  /**
6232
- * <p></p>
6313
+ * <p>The timestamp when the customer endpoint disconnected from Amazon Connect.</p>
6233
6314
  * @public
6234
6315
  */
6235
6316
  DisconnectTimestamp?: Date | undefined;
6236
6317
  /**
6237
- * <p></p>
6318
+ * <p>If this contact is related to other contacts, this is the ID of the initial contact.</p>
6238
6319
  * @public
6239
6320
  */
6240
6321
  InitialContactId?: string | undefined;
6241
6322
  /**
6242
- * <p></p>
6323
+ * <p>If this contact is not the first contact, this is the ID of the previous contact.</p>
6243
6324
  * @public
6244
6325
  */
6245
6326
  PreviousContactId?: string | undefined;
6246
6327
  /**
6247
- * <p></p>
6328
+ * <p>The contactId that is related to this contact.</p>
6248
6329
  * @public
6249
6330
  */
6250
6331
  RelatedContactId?: string | undefined;
6251
6332
  /**
6252
- * <p></p>
6333
+ * <p>Indicates how the contact was initiated.</p>
6253
6334
  * @public
6254
6335
  */
6255
6336
  InitiationMethod?: ContactInitiationMethod | undefined;
6256
6337
  /**
6257
- * <p></p>
6338
+ * <p>How the contact reached your contact center.</p>
6258
6339
  * @public
6259
6340
  */
6260
6341
  Channel?: Channel | undefined;
@@ -6264,12 +6345,13 @@ export interface AssociatedContactSummary {
6264
6345
  */
6265
6346
  export interface ListAssociatedContactsResponse {
6266
6347
  /**
6267
- * <p></p>
6348
+ * <p>List of the contact summary for all the contacts in contact tree associated with unique
6349
+ * identifier.</p>
6268
6350
  * @public
6269
6351
  */
6270
6352
  ContactSummaryList?: AssociatedContactSummary[] | undefined;
6271
6353
  /**
6272
- * <p></p>
6354
+ * <p>If there are additional results, this is the token for the next set of results.</p>
6273
6355
  * @public
6274
6356
  */
6275
6357
  NextToken?: string | undefined;
@@ -6641,7 +6723,7 @@ export interface ContactFlowSummary {
6641
6723
  */
6642
6724
  ContactFlowState?: ContactFlowState | undefined;
6643
6725
  /**
6644
- * <p>The status of the contact flow.</p>
6726
+ * <p>The status of the flow.</p>
6645
6727
  * @public
6646
6728
  */
6647
6729
  ContactFlowStatus?: ContactFlowStatus | undefined;
@@ -6688,7 +6770,7 @@ export interface ListContactFlowVersionsRequest {
6688
6770
  MaxResults?: number | undefined;
6689
6771
  }
6690
6772
  /**
6691
- * <p>A summary of a contact flow version's metadata.</p>
6773
+ * <p>A summary of a flow version's metadata.</p>
6692
6774
  * @public
6693
6775
  */
6694
6776
  export interface ContactFlowVersionSummary {
@@ -6775,7 +6857,7 @@ export interface AttachmentReference {
6775
6857
  */
6776
6858
  Status?: ReferenceStatus | undefined;
6777
6859
  /**
6778
- * <p></p>
6860
+ * <p>The Amazon Resource Name (ARN) of the attachment reference.</p>
6779
6861
  * @public
6780
6862
  */
6781
6863
  Arn?: string | undefined;
@@ -6815,17 +6897,18 @@ export interface EmailReference {
6815
6897
  Value?: string | undefined;
6816
6898
  }
6817
6899
  /**
6818
- * <p></p>
6900
+ * <p>Information about the reference when the referenceType is <code>EMAIL_MESSAGE</code>.
6901
+ * Otherwise, null.</p>
6819
6902
  * @public
6820
6903
  */
6821
6904
  export interface EmailMessageReference {
6822
6905
  /**
6823
- * <p></p>
6906
+ * <p>The name of the email message reference</p>
6824
6907
  * @public
6825
6908
  */
6826
6909
  Name?: string | undefined;
6827
6910
  /**
6828
- * <p></p>
6911
+ * <p>The Amazon Resource Name (ARN) of the email message reference</p>
6829
6912
  * @public
6830
6913
  */
6831
6914
  Arn?: string | undefined;
@@ -6921,7 +7004,8 @@ export declare namespace ReferenceSummary {
6921
7004
  $unknown?: never;
6922
7005
  }
6923
7006
  /**
6924
- * <p></p>
7007
+ * <p>Information about the reference when the referenceType is <code>EMAIL_MESSAGE</code>.
7008
+ * Otherwise, null.</p>
6925
7009
  * @public
6926
7010
  */
6927
7011
  interface EmailMessageMember {
@@ -7915,8 +7999,8 @@ export interface ListPhoneNumbersSummary {
7915
7999
  PhoneNumberDescription?: string | undefined;
7916
8000
  /**
7917
8001
  * <p>The claimed phone number ARN that was previously imported from the external service, such as
7918
- * Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like the ARN of the phone number
7919
- * that was imported from Amazon Pinpoint.</p>
8002
+ * Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number
8003
+ * that was imported from Amazon Web Services End User Messaging.</p>
7920
8004
  * @public
7921
8005
  */
7922
8006
  SourcePhoneNumberArn?: string | undefined;
@@ -8710,6 +8794,71 @@ export interface RealTimeContactAnalysisTranscriptItemRedaction {
8710
8794
  */
8711
8795
  CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined;
8712
8796
  }
8797
+ /**
8798
+ * @public
8799
+ * @enum
8800
+ */
8801
+ export declare const RealTimeContactAnalysisSentimentLabel: {
8802
+ readonly NEGATIVE: "NEGATIVE";
8803
+ readonly NEUTRAL: "NEUTRAL";
8804
+ readonly POSITIVE: "POSITIVE";
8805
+ };
8806
+ /**
8807
+ * @public
8808
+ */
8809
+ export type RealTimeContactAnalysisSentimentLabel = (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel];
8810
+ /**
8811
+ * <p>The analyzed transcript segment.</p>
8812
+ * @public
8813
+ */
8814
+ export interface RealTimeContactAnalysisSegmentTranscript {
8815
+ /**
8816
+ * <p>The identifier of the transcript.</p>
8817
+ * @public
8818
+ */
8819
+ Id: string | undefined;
8820
+ /**
8821
+ * <p>The identifier of the participant.</p>
8822
+ * @public
8823
+ */
8824
+ ParticipantId: string | undefined;
8825
+ /**
8826
+ * <p>The role of the participant. For example, is it a customer, agent, or system.</p>
8827
+ * @public
8828
+ */
8829
+ ParticipantRole: ParticipantRole | undefined;
8830
+ /**
8831
+ * <p>The display name of the participant.</p>
8832
+ * @public
8833
+ */
8834
+ DisplayName?: string | undefined;
8835
+ /**
8836
+ * <p>The content of the transcript. Can be redacted.</p>
8837
+ * @public
8838
+ */
8839
+ Content: string | undefined;
8840
+ /**
8841
+ * <p>The type of content of the item. For example, <code>text/plain</code>.</p>
8842
+ * @public
8843
+ */
8844
+ ContentType?: string | undefined;
8845
+ /**
8846
+ * <p>Field describing the time of the event. It can have different representations of time.</p>
8847
+ * @public
8848
+ */
8849
+ Time: RealTimeContactAnalysisTimeData | undefined;
8850
+ /**
8851
+ * <p>Object describing redaction that was applied to the transcript. If transcript has the field
8852
+ * it means part of the transcript was redacted.</p>
8853
+ * @public
8854
+ */
8855
+ Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined;
8856
+ /**
8857
+ * <p>The sentiment detected for this piece of transcript.</p>
8858
+ * @public
8859
+ */
8860
+ Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined;
8861
+ }
8713
8862
  /**
8714
8863
  * @internal
8715
8864
  */