@aws-sdk/client-connect 3.863.0 → 3.865.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 (74) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/index.js +110 -27
  3. package/dist-es/Connect.js +2 -0
  4. package/dist-es/commands/GetContactMetricsCommand.js +22 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/models_1.js +11 -0
  7. package/dist-es/models/models_2.js +0 -25
  8. package/dist-es/models/models_3.js +25 -0
  9. package/dist-es/protocols/Aws_restJson1.js +51 -0
  10. package/dist-types/Connect.d.ts +7 -0
  11. package/dist-types/ConnectClient.d.ts +3 -2
  12. package/dist-types/commands/AssociateQueueQuickConnectsCommand.d.ts +1 -2
  13. package/dist-types/commands/CreateAgentStatusCommand.d.ts +1 -2
  14. package/dist-types/commands/CreateHoursOfOperationCommand.d.ts +1 -2
  15. package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateUserCommand.d.ts +3 -3
  17. package/dist-types/commands/CreateViewCommand.d.ts +4 -1
  18. package/dist-types/commands/CreateViewVersionCommand.d.ts +4 -1
  19. package/dist-types/commands/DeleteHoursOfOperationCommand.d.ts +1 -2
  20. package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
  21. package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +4 -1
  22. package/dist-types/commands/DeleteQueueCommand.d.ts +4 -1
  23. package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +4 -1
  24. package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +4 -1
  25. package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +4 -1
  26. package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +4 -1
  27. package/dist-types/commands/DeleteViewCommand.d.ts +4 -1
  28. package/dist-types/commands/DeleteViewVersionCommand.d.ts +4 -1
  29. package/dist-types/commands/DeleteVocabularyCommand.d.ts +4 -1
  30. package/dist-types/commands/DescribeAgentStatusCommand.d.ts +1 -2
  31. package/dist-types/commands/DescribeHoursOfOperationCommand.d.ts +1 -2
  32. package/dist-types/commands/DescribeQueueCommand.d.ts +1 -2
  33. package/dist-types/commands/DisassociateQueueQuickConnectsCommand.d.ts +1 -2
  34. package/dist-types/commands/GetContactMetricsCommand.d.ts +117 -0
  35. package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +37 -0
  36. package/dist-types/commands/GetMetricDataV2Command.d.ts +37 -0
  37. package/dist-types/commands/ListAgentStatusesCommand.d.ts +1 -2
  38. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -1
  39. package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +1 -1
  40. package/dist-types/commands/ListLexBotsCommand.d.ts +1 -1
  41. package/dist-types/commands/ListPhoneNumbersCommand.d.ts +1 -2
  42. package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +1 -2
  43. package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +4 -1
  44. package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -2
  45. package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +1 -2
  46. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +4 -1
  47. package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +4 -1
  48. package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -2
  49. package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -2
  50. package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -2
  51. package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -2
  52. package/dist-types/commands/UpdateQueueStatusCommand.d.ts +1 -2
  53. package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +4 -1
  54. package/dist-types/commands/UpdateViewContentCommand.d.ts +4 -1
  55. package/dist-types/commands/UpdateViewMetadataCommand.d.ts +4 -1
  56. package/dist-types/commands/index.d.ts +1 -0
  57. package/dist-types/models/models_0.d.ts +6 -7
  58. package/dist-types/models/models_1.d.ts +517 -150
  59. package/dist-types/models/models_2.d.ts +130 -144
  60. package/dist-types/models/models_3.d.ts +143 -6
  61. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  62. package/dist-types/ts3.4/Connect.d.ts +17 -0
  63. package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
  64. package/dist-types/ts3.4/commands/GetContactMetricsCommand.d.ts +51 -0
  65. package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +2 -4
  66. package/dist-types/ts3.4/commands/ListLambdaFunctionsCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/ListLexBotsCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +4 -2
  69. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  70. package/dist-types/ts3.4/models/models_1.d.ts +40 -31
  71. package/dist-types/ts3.4/models/models_2.d.ts +33 -67
  72. package/dist-types/ts3.4/models/models_3.d.ts +68 -1
  73. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  74. package/package.json +5 -5
@@ -1,7 +1,133 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, MonitorCapability, ParticipantRole, QuickConnectType, Reference, RehydrationType, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateStatus, UseCaseType, UserPhoneConfig, UserProficiency, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
- import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
3
+ import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, LexBot, MonitorCapability, ParticipantRole, QuickConnectType, Reference, RehydrationType, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateStatus, UseCaseType, UserPhoneConfig, UserProficiency, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
+ import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, IntegrationAssociationSummary, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface ListIntegrationAssociationsResponse {
9
+ /**
10
+ * <p>The associations.</p>
11
+ * @public
12
+ */
13
+ IntegrationAssociationSummaryList?: IntegrationAssociationSummary[] | undefined;
14
+ /**
15
+ * <p>If there are additional results, this is the token for the next set of results.</p>
16
+ * @public
17
+ */
18
+ NextToken?: string | undefined;
19
+ }
20
+ /**
21
+ * @public
22
+ */
23
+ export interface ListLambdaFunctionsRequest {
24
+ /**
25
+ * <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>
26
+ * @public
27
+ */
28
+ InstanceId: string | undefined;
29
+ /**
30
+ * <p>The token for the next set of results. Use the value returned in the previous
31
+ * response in the next request to retrieve the next set of results.</p>
32
+ * @public
33
+ */
34
+ NextToken?: string | undefined;
35
+ /**
36
+ * <p>The maximum number of results to return per page.</p>
37
+ * @public
38
+ */
39
+ MaxResults?: number | undefined;
40
+ }
41
+ /**
42
+ * @public
43
+ */
44
+ export interface ListLambdaFunctionsResponse {
45
+ /**
46
+ * <p>The Lambdafunction ARNs associated with the specified instance.</p>
47
+ * @public
48
+ */
49
+ LambdaFunctions?: string[] | undefined;
50
+ /**
51
+ * <p>If there are additional results, this is the token for the next set of results.</p>
52
+ * @public
53
+ */
54
+ NextToken?: string | undefined;
55
+ }
56
+ /**
57
+ * @public
58
+ */
59
+ export interface ListLexBotsRequest {
60
+ /**
61
+ * <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>
62
+ * @public
63
+ */
64
+ InstanceId: string | undefined;
65
+ /**
66
+ * <p>The token for the next set of results. Use the value returned in the previous
67
+ * response in the next request to retrieve the next set of results.</p>
68
+ * @public
69
+ */
70
+ NextToken?: string | undefined;
71
+ /**
72
+ * <p>The maximum number of results to return per page. If no value is specified, the default is 10.
73
+ * </p>
74
+ * @public
75
+ */
76
+ MaxResults?: number | undefined;
77
+ }
78
+ /**
79
+ * @public
80
+ */
81
+ export interface ListLexBotsResponse {
82
+ /**
83
+ * <p>The names and Amazon Web Services Regions of the Amazon Lex bots associated with the
84
+ * specified instance.</p>
85
+ * @public
86
+ */
87
+ LexBots?: LexBot[] | undefined;
88
+ /**
89
+ * <p>If there are additional results, this is the token for the next set of results.</p>
90
+ * @public
91
+ */
92
+ NextToken?: string | undefined;
93
+ }
94
+ /**
95
+ * @public
96
+ */
97
+ export interface ListPhoneNumbersRequest {
98
+ /**
99
+ * <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>
100
+ * @public
101
+ */
102
+ InstanceId: string | undefined;
103
+ /**
104
+ * <p>The type of phone number.</p>
105
+ * <note>
106
+ * <p>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to
107
+ * return phone number types. While ListPhoneNumbers returns number types <code>UIFN</code>,
108
+ * <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>, it
109
+ * incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>. </p>
110
+ * </note>
111
+ * @public
112
+ */
113
+ PhoneNumberTypes?: PhoneNumberType[] | undefined;
114
+ /**
115
+ * <p>The ISO country code.</p>
116
+ * @public
117
+ */
118
+ PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined;
119
+ /**
120
+ * <p>The token for the next set of results. Use the value returned in the previous
121
+ * response in the next request to retrieve the next set of results.</p>
122
+ * @public
123
+ */
124
+ NextToken?: string | undefined;
125
+ /**
126
+ * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
127
+ * @public
128
+ */
129
+ MaxResults?: number | undefined;
130
+ }
5
131
  /**
6
132
  * <p>Contains summary information about a phone number for a contact center.</p>
7
133
  * @public
@@ -185,7 +311,7 @@ export interface ListPredefinedAttributesRequest {
185
311
  */
186
312
  NextToken?: string | undefined;
187
313
  /**
188
- * <p>The maximum number of results to return per page. </p>
314
+ * <p>The maximum number of results to return per page.</p>
189
315
  * @public
190
316
  */
191
317
  MaxResults?: number | undefined;
@@ -3339,8 +3465,7 @@ export interface SearchHoursOfOperationOverridesResponse {
3339
3465
  HoursOfOperationOverrides?: HoursOfOperationOverride[] | undefined;
3340
3466
  /**
3341
3467
  * <p>The token for the next set of results. Use the value returned in the previous response in
3342
- * the next request to retrieve the next set of results. Length Constraints: Minimum length of 1.
3343
- * Maximum length of 2500.</p>
3468
+ * the next request to retrieve the next set of results. </p>
3344
3469
  * @public
3345
3470
  */
3346
3471
  NextToken?: string | undefined;
@@ -6631,145 +6756,6 @@ export declare const TimerEligibleParticipantRoles: {
6631
6756
  * @public
6632
6757
  */
6633
6758
  export type TimerEligibleParticipantRoles = (typeof TimerEligibleParticipantRoles)[keyof typeof TimerEligibleParticipantRoles];
6634
- /**
6635
- * @public
6636
- * @enum
6637
- */
6638
- export declare const ParticipantTimerType: {
6639
- readonly DISCONNECT_NONCUSTOMER: "DISCONNECT_NONCUSTOMER";
6640
- readonly IDLE: "IDLE";
6641
- };
6642
- /**
6643
- * @public
6644
- */
6645
- export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType];
6646
- /**
6647
- * @public
6648
- * @enum
6649
- */
6650
- export declare const ParticipantTimerAction: {
6651
- readonly Unset: "Unset";
6652
- };
6653
- /**
6654
- * @public
6655
- */
6656
- export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction];
6657
- /**
6658
- * <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or
6659
- * the duration of the timer in minutes. Only one value can be set.</p>
6660
- * <p>For more information about how chat timeouts work, see
6661
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
6662
- * @public
6663
- */
6664
- export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
6665
- /**
6666
- * @public
6667
- */
6668
- export declare namespace ParticipantTimerValue {
6669
- /**
6670
- * <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a
6671
- * timer.</p>
6672
- * @public
6673
- */
6674
- interface ParticipantTimerActionMember {
6675
- ParticipantTimerAction: ParticipantTimerAction;
6676
- ParticipantTimerDurationInMinutes?: never;
6677
- $unknown?: never;
6678
- }
6679
- /**
6680
- * <p>The duration of a timer, in minutes. </p>
6681
- * @public
6682
- */
6683
- interface ParticipantTimerDurationInMinutesMember {
6684
- ParticipantTimerAction?: never;
6685
- ParticipantTimerDurationInMinutes: number;
6686
- $unknown?: never;
6687
- }
6688
- /**
6689
- * @public
6690
- */
6691
- interface $UnknownMember {
6692
- ParticipantTimerAction?: never;
6693
- ParticipantTimerDurationInMinutes?: never;
6694
- $unknown: [string, any];
6695
- }
6696
- interface Visitor<T> {
6697
- ParticipantTimerAction: (value: ParticipantTimerAction) => T;
6698
- ParticipantTimerDurationInMinutes: (value: number) => T;
6699
- _: (name: string, value: any) => T;
6700
- }
6701
- const visit: <T>(value: ParticipantTimerValue, visitor: Visitor<T>) => T;
6702
- }
6703
- /**
6704
- * <p>Configuration information for the timer. After the timer configuration is set, it persists
6705
- * for the duration of the chat. It persists across new contacts in the chain, for example, transfer
6706
- * contacts.</p>
6707
- * <p>For more information about how chat timeouts work, see
6708
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
6709
- * @public
6710
- */
6711
- export interface ParticipantTimerConfiguration {
6712
- /**
6713
- * <p>The role of the participant in the chat conversation.</p>
6714
- * @public
6715
- */
6716
- ParticipantRole: TimerEligibleParticipantRoles | undefined;
6717
- /**
6718
- * <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human
6719
- * chat participant as idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to
6720
- * automatically disconnecting a chat participant due to idleness.</p>
6721
- * @public
6722
- */
6723
- TimerType: ParticipantTimerType | undefined;
6724
- /**
6725
- * <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration
6726
- * of the timer in minutes. Only one value can be set.</p>
6727
- * @public
6728
- */
6729
- TimerValue: ParticipantTimerValue | undefined;
6730
- }
6731
- /**
6732
- * <p>Configuration information for the chat participant role.</p>
6733
- * @public
6734
- */
6735
- export interface ChatParticipantRoleConfig {
6736
- /**
6737
- * <p>A list of participant timers. You can specify any unique combination of role and timer type.
6738
- * Duplicate entries error out the request with a 400.</p>
6739
- * @public
6740
- */
6741
- ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
6742
- }
6743
- /**
6744
- * <p>Configuration information for the chat participant role.</p>
6745
- * @public
6746
- */
6747
- export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember;
6748
- /**
6749
- * @public
6750
- */
6751
- export declare namespace UpdateParticipantRoleConfigChannelInfo {
6752
- /**
6753
- * <p>Configuration information for the chat participant role.</p>
6754
- * @public
6755
- */
6756
- interface ChatMember {
6757
- Chat: ChatParticipantRoleConfig;
6758
- $unknown?: never;
6759
- }
6760
- /**
6761
- * @public
6762
- */
6763
- interface $UnknownMember {
6764
- Chat?: never;
6765
- $unknown: [string, any];
6766
- }
6767
- interface Visitor<T> {
6768
- Chat: (value: ChatParticipantRoleConfig) => T;
6769
- _: (name: string, value: any) => T;
6770
- }
6771
- const visit: <T>(value: UpdateParticipantRoleConfigChannelInfo, visitor: Visitor<T>) => T;
6772
- }
6773
6759
  /**
6774
6760
  * @internal
6775
6761
  */
@@ -1,6 +1,145 @@
1
1
  import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormQuestion, EvaluationFormScoringStrategy, InitiateAs, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, PredefinedAttributeValues, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
2
2
  import { AnsweringMachineDetectionStatus, AttributeCondition, ChatMetrics, ContactDetails, ContactEvaluation, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, QueueStatus, RecordingInfo, RoutingCriteriaStepStatus, SignInConfig, TelephonyConfig, WisdomInfo } from "./models_1";
3
- import { ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UpdateParticipantRoleConfigChannelInfo, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
3
+ import { ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, TimerEligibleParticipantRoles, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
4
+ /**
5
+ * @public
6
+ * @enum
7
+ */
8
+ export declare const ParticipantTimerType: {
9
+ readonly DISCONNECT_NONCUSTOMER: "DISCONNECT_NONCUSTOMER";
10
+ readonly IDLE: "IDLE";
11
+ };
12
+ /**
13
+ * @public
14
+ */
15
+ export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType];
16
+ /**
17
+ * @public
18
+ * @enum
19
+ */
20
+ export declare const ParticipantTimerAction: {
21
+ readonly Unset: "Unset";
22
+ };
23
+ /**
24
+ * @public
25
+ */
26
+ export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction];
27
+ /**
28
+ * <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or
29
+ * the duration of the timer in minutes. Only one value can be set.</p>
30
+ * <p>For more information about how chat timeouts work, see
31
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
32
+ * @public
33
+ */
34
+ export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
35
+ /**
36
+ * @public
37
+ */
38
+ export declare namespace ParticipantTimerValue {
39
+ /**
40
+ * <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a
41
+ * timer.</p>
42
+ * @public
43
+ */
44
+ interface ParticipantTimerActionMember {
45
+ ParticipantTimerAction: ParticipantTimerAction;
46
+ ParticipantTimerDurationInMinutes?: never;
47
+ $unknown?: never;
48
+ }
49
+ /**
50
+ * <p>The duration of a timer, in minutes. </p>
51
+ * @public
52
+ */
53
+ interface ParticipantTimerDurationInMinutesMember {
54
+ ParticipantTimerAction?: never;
55
+ ParticipantTimerDurationInMinutes: number;
56
+ $unknown?: never;
57
+ }
58
+ /**
59
+ * @public
60
+ */
61
+ interface $UnknownMember {
62
+ ParticipantTimerAction?: never;
63
+ ParticipantTimerDurationInMinutes?: never;
64
+ $unknown: [string, any];
65
+ }
66
+ interface Visitor<T> {
67
+ ParticipantTimerAction: (value: ParticipantTimerAction) => T;
68
+ ParticipantTimerDurationInMinutes: (value: number) => T;
69
+ _: (name: string, value: any) => T;
70
+ }
71
+ const visit: <T>(value: ParticipantTimerValue, visitor: Visitor<T>) => T;
72
+ }
73
+ /**
74
+ * <p>Configuration information for the timer. After the timer configuration is set, it persists
75
+ * for the duration of the chat. It persists across new contacts in the chain, for example, transfer
76
+ * contacts.</p>
77
+ * <p>For more information about how chat timeouts work, see
78
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
79
+ * @public
80
+ */
81
+ export interface ParticipantTimerConfiguration {
82
+ /**
83
+ * <p>The role of the participant in the chat conversation.</p>
84
+ * @public
85
+ */
86
+ ParticipantRole: TimerEligibleParticipantRoles | undefined;
87
+ /**
88
+ * <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human
89
+ * chat participant as idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to
90
+ * automatically disconnecting a chat participant due to idleness.</p>
91
+ * @public
92
+ */
93
+ TimerType: ParticipantTimerType | undefined;
94
+ /**
95
+ * <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration
96
+ * of the timer in minutes. Only one value can be set.</p>
97
+ * @public
98
+ */
99
+ TimerValue: ParticipantTimerValue | undefined;
100
+ }
101
+ /**
102
+ * <p>Configuration information for the chat participant role.</p>
103
+ * @public
104
+ */
105
+ export interface ChatParticipantRoleConfig {
106
+ /**
107
+ * <p>A list of participant timers. You can specify any unique combination of role and timer type.
108
+ * Duplicate entries error out the request with a 400.</p>
109
+ * @public
110
+ */
111
+ ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
112
+ }
113
+ /**
114
+ * <p>Configuration information for the chat participant role.</p>
115
+ * @public
116
+ */
117
+ export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember;
118
+ /**
119
+ * @public
120
+ */
121
+ export declare namespace UpdateParticipantRoleConfigChannelInfo {
122
+ /**
123
+ * <p>Configuration information for the chat participant role.</p>
124
+ * @public
125
+ */
126
+ interface ChatMember {
127
+ Chat: ChatParticipantRoleConfig;
128
+ $unknown?: never;
129
+ }
130
+ /**
131
+ * @public
132
+ */
133
+ interface $UnknownMember {
134
+ Chat?: never;
135
+ $unknown: [string, any];
136
+ }
137
+ interface Visitor<T> {
138
+ Chat: (value: ChatParticipantRoleConfig) => T;
139
+ _: (name: string, value: any) => T;
140
+ }
141
+ const visit: <T>(value: UpdateParticipantRoleConfigChannelInfo, visitor: Visitor<T>) => T;
142
+ }
4
143
  /**
5
144
  * @public
6
145
  */
@@ -1862,7 +2001,7 @@ export interface StartEmailContactRequest {
1862
2001
  */
1863
2002
  EmailMessage: InboundEmailContent | undefined;
1864
2003
  /**
1865
- * <p>The addtional recipients address of the email.</p>
2004
+ * <p>The additional recipients address of the email.</p>
1866
2005
  * @public
1867
2006
  */
1868
2007
  AdditionalRecipients?: InboundAdditionalRecipients | undefined;
@@ -2555,14 +2694,12 @@ export interface SearchHoursOfOperationOverridesRequest {
2555
2694
  InstanceId: string | undefined;
2556
2695
  /**
2557
2696
  * <p>The token for the next set of results. Use the value returned in the previous response in
2558
- * the next request to retrieve the next set of results. Length Constraints: Minimum length of 1.
2559
- * Maximum length of 2500.</p>
2697
+ * the next request to retrieve the next set of results. </p>
2560
2698
  * @public
2561
2699
  */
2562
2700
  NextToken?: string | undefined;
2563
2701
  /**
2564
- * <p>The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum
2565
- * value of 100.</p>
2702
+ * <p>The maximum number of results to return per page.</p>
2566
2703
  * @public
2567
2704
  */
2568
2705
  MaxResults?: number | undefined;
@@ -122,6 +122,7 @@ import { DisassociateUserProficienciesCommandInput, DisassociateUserProficiencie
122
122
  import { DismissUserContactCommandInput, DismissUserContactCommandOutput } from "../commands/DismissUserContactCommand";
123
123
  import { GetAttachedFileCommandInput, GetAttachedFileCommandOutput } from "../commands/GetAttachedFileCommand";
124
124
  import { GetContactAttributesCommandInput, GetContactAttributesCommandOutput } from "../commands/GetContactAttributesCommand";
125
+ import { GetContactMetricsCommandInput, GetContactMetricsCommandOutput } from "../commands/GetContactMetricsCommand";
125
126
  import { GetCurrentMetricDataCommandInput, GetCurrentMetricDataCommandOutput } from "../commands/GetCurrentMetricDataCommand";
126
127
  import { GetCurrentUserDataCommandInput, GetCurrentUserDataCommandOutput } from "../commands/GetCurrentUserDataCommand";
127
128
  import { GetEffectiveHoursOfOperationsCommandInput, GetEffectiveHoursOfOperationsCommandOutput } from "../commands/GetEffectiveHoursOfOperationsCommand";
@@ -770,6 +771,10 @@ export declare const se_GetAttachedFileCommand: (input: GetAttachedFileCommandIn
770
771
  * serializeAws_restJson1GetContactAttributesCommand
771
772
  */
772
773
  export declare const se_GetContactAttributesCommand: (input: GetContactAttributesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
774
+ /**
775
+ * serializeAws_restJson1GetContactMetricsCommand
776
+ */
777
+ export declare const se_GetContactMetricsCommand: (input: GetContactMetricsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
773
778
  /**
774
779
  * serializeAws_restJson1GetCurrentMetricDataCommand
775
780
  */
@@ -1898,6 +1903,10 @@ export declare const de_GetAttachedFileCommand: (output: __HttpResponse, context
1898
1903
  * deserializeAws_restJson1GetContactAttributesCommand
1899
1904
  */
1900
1905
  export declare const de_GetContactAttributesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetContactAttributesCommandOutput>;
1906
+ /**
1907
+ * deserializeAws_restJson1GetContactMetricsCommand
1908
+ */
1909
+ export declare const de_GetContactMetricsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetContactMetricsCommandOutput>;
1901
1910
  /**
1902
1911
  * deserializeAws_restJson1GetCurrentMetricDataCommand
1903
1912
  */
@@ -487,6 +487,10 @@ import {
487
487
  GetContactAttributesCommandInput,
488
488
  GetContactAttributesCommandOutput,
489
489
  } from "./commands/GetContactAttributesCommand";
490
+ import {
491
+ GetContactMetricsCommandInput,
492
+ GetContactMetricsCommandOutput,
493
+ } from "./commands/GetContactMetricsCommand";
490
494
  import {
491
495
  GetCurrentMetricDataCommandInput,
492
496
  GetCurrentMetricDataCommandOutput,
@@ -2763,6 +2767,19 @@ export interface Connect {
2763
2767
  options: __HttpHandlerOptions,
2764
2768
  cb: (err: any, data?: GetContactAttributesCommandOutput) => void
2765
2769
  ): void;
2770
+ getContactMetrics(
2771
+ args: GetContactMetricsCommandInput,
2772
+ options?: __HttpHandlerOptions
2773
+ ): Promise<GetContactMetricsCommandOutput>;
2774
+ getContactMetrics(
2775
+ args: GetContactMetricsCommandInput,
2776
+ cb: (err: any, data?: GetContactMetricsCommandOutput) => void
2777
+ ): void;
2778
+ getContactMetrics(
2779
+ args: GetContactMetricsCommandInput,
2780
+ options: __HttpHandlerOptions,
2781
+ cb: (err: any, data?: GetContactMetricsCommandOutput) => void
2782
+ ): void;
2766
2783
  getCurrentMetricData(
2767
2784
  args: GetCurrentMetricDataCommandInput,
2768
2785
  options?: __HttpHandlerOptions
@@ -533,6 +533,10 @@ import {
533
533
  GetContactAttributesCommandInput,
534
534
  GetContactAttributesCommandOutput,
535
535
  } from "./commands/GetContactAttributesCommand";
536
+ import {
537
+ GetContactMetricsCommandInput,
538
+ GetContactMetricsCommandOutput,
539
+ } from "./commands/GetContactMetricsCommand";
536
540
  import {
537
541
  GetCurrentMetricDataCommandInput,
538
542
  GetCurrentMetricDataCommandOutput,
@@ -1303,6 +1307,7 @@ export type ServiceInputTypes =
1303
1307
  | DismissUserContactCommandInput
1304
1308
  | GetAttachedFileCommandInput
1305
1309
  | GetContactAttributesCommandInput
1310
+ | GetContactMetricsCommandInput
1306
1311
  | GetCurrentMetricDataCommandInput
1307
1312
  | GetCurrentUserDataCommandInput
1308
1313
  | GetEffectiveHoursOfOperationsCommandInput
@@ -1586,6 +1591,7 @@ export type ServiceOutputTypes =
1586
1591
  | DismissUserContactCommandOutput
1587
1592
  | GetAttachedFileCommandOutput
1588
1593
  | GetContactAttributesCommandOutput
1594
+ | GetContactMetricsCommandOutput
1589
1595
  | GetCurrentMetricDataCommandOutput
1590
1596
  | GetCurrentUserDataCommandOutput
1591
1597
  | GetEffectiveHoursOfOperationsCommandOutput
@@ -0,0 +1,51 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import {
4
+ ConnectClientResolvedConfig,
5
+ ServiceInputTypes,
6
+ ServiceOutputTypes,
7
+ } from "../ConnectClient";
8
+ import {
9
+ GetContactMetricsRequest,
10
+ GetContactMetricsResponse,
11
+ } from "../models/models_1";
12
+ export { __MetadataBearer };
13
+ export { $Command };
14
+ export interface GetContactMetricsCommandInput
15
+ extends GetContactMetricsRequest {}
16
+ export interface GetContactMetricsCommandOutput
17
+ extends GetContactMetricsResponse,
18
+ __MetadataBearer {}
19
+ declare const GetContactMetricsCommand_base: {
20
+ new (
21
+ input: GetContactMetricsCommandInput
22
+ ): import("@smithy/smithy-client").CommandImpl<
23
+ GetContactMetricsCommandInput,
24
+ GetContactMetricsCommandOutput,
25
+ ConnectClientResolvedConfig,
26
+ ServiceInputTypes,
27
+ ServiceOutputTypes
28
+ >;
29
+ new (
30
+ input: GetContactMetricsCommandInput
31
+ ): import("@smithy/smithy-client").CommandImpl<
32
+ GetContactMetricsCommandInput,
33
+ GetContactMetricsCommandOutput,
34
+ ConnectClientResolvedConfig,
35
+ ServiceInputTypes,
36
+ ServiceOutputTypes
37
+ >;
38
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
39
+ };
40
+ export declare class GetContactMetricsCommand extends GetContactMetricsCommand_base {
41
+ protected static __types: {
42
+ api: {
43
+ input: GetContactMetricsRequest;
44
+ output: GetContactMetricsResponse;
45
+ };
46
+ sdk: {
47
+ input: GetContactMetricsCommandInput;
48
+ output: GetContactMetricsCommandOutput;
49
+ };
50
+ };
51
+ }
@@ -5,10 +5,8 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../ConnectClient";
8
- import {
9
- ListIntegrationAssociationsRequest,
10
- ListIntegrationAssociationsResponse,
11
- } from "../models/models_1";
8
+ import { ListIntegrationAssociationsRequest } from "../models/models_1";
9
+ import { ListIntegrationAssociationsResponse } from "../models/models_2";
12
10
  export { __MetadataBearer };
13
11
  export { $Command };
14
12
  export interface ListIntegrationAssociationsCommandInput
@@ -8,7 +8,7 @@ import {
8
8
  import {
9
9
  ListLambdaFunctionsRequest,
10
10
  ListLambdaFunctionsResponse,
11
- } from "../models/models_1";
11
+ } from "../models/models_2";
12
12
  export { __MetadataBearer };
13
13
  export { $Command };
14
14
  export interface ListLambdaFunctionsCommandInput
@@ -5,7 +5,7 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../ConnectClient";
8
- import { ListLexBotsRequest, ListLexBotsResponse } from "../models/models_1";
8
+ import { ListLexBotsRequest, ListLexBotsResponse } from "../models/models_2";
9
9
  export { __MetadataBearer };
10
10
  export { $Command };
11
11
  export interface ListLexBotsCommandInput extends ListLexBotsRequest {}
@@ -5,8 +5,10 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../ConnectClient";
8
- import { ListPhoneNumbersRequest } from "../models/models_1";
9
- import { ListPhoneNumbersResponse } from "../models/models_2";
8
+ import {
9
+ ListPhoneNumbersRequest,
10
+ ListPhoneNumbersResponse,
11
+ } from "../models/models_2";
10
12
  export { __MetadataBearer };
11
13
  export { $Command };
12
14
  export interface ListPhoneNumbersCommandInput extends ListPhoneNumbersRequest {}
@@ -120,6 +120,7 @@ export * from "./DisassociateUserProficienciesCommand";
120
120
  export * from "./DismissUserContactCommand";
121
121
  export * from "./GetAttachedFileCommand";
122
122
  export * from "./GetContactAttributesCommand";
123
+ export * from "./GetContactMetricsCommand";
123
124
  export * from "./GetCurrentMetricDataCommand";
124
125
  export * from "./GetCurrentUserDataCommand";
125
126
  export * from "./GetEffectiveHoursOfOperationsCommand";