@aws-sdk/client-connect 3.568.0 → 3.569.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/index.js +391 -81
  3. package/dist-es/Connect.js +10 -0
  4. package/dist-es/commands/BatchGetAttachedFileMetadataCommand.js +24 -0
  5. package/dist-es/commands/CompleteAttachedFileUploadCommand.js +24 -0
  6. package/dist-es/commands/DeleteAttachedFileCommand.js +24 -0
  7. package/dist-es/commands/DescribeInstanceCommand.js +1 -1
  8. package/dist-es/commands/GetAttachedFileCommand.js +24 -0
  9. package/dist-es/commands/ReplicateInstanceCommand.js +1 -1
  10. package/dist-es/commands/StartAttachedFileUploadCommand.js +24 -0
  11. package/dist-es/commands/index.js +5 -0
  12. package/dist-es/models/models_0.js +33 -26
  13. package/dist-es/models/models_1.js +26 -42
  14. package/dist-es/models/models_2.js +42 -1
  15. package/dist-es/protocols/Aws_restJson1.js +163 -0
  16. package/dist-types/Connect.d.ts +35 -0
  17. package/dist-types/ConnectClient.d.ts +7 -2
  18. package/dist-types/commands/BatchGetAttachedFileMetadataCommand.d.ts +105 -0
  19. package/dist-types/commands/CompleteAttachedFileUploadCommand.d.ts +75 -0
  20. package/dist-types/commands/DeleteAttachedFileCommand.d.ts +78 -0
  21. package/dist-types/commands/DescribeHoursOfOperationCommand.d.ts +2 -1
  22. package/dist-types/commands/DescribeInstanceAttributeCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeInstanceCommand.d.ts +1 -1
  24. package/dist-types/commands/DescribeInstanceStorageConfigCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -2
  26. package/dist-types/commands/GetAttachedFileCommand.d.ts +97 -0
  27. package/dist-types/commands/ReplicateInstanceCommand.d.ts +2 -1
  28. package/dist-types/commands/ResumeContactCommand.d.ts +1 -1
  29. package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -1
  30. package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +1 -1
  31. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +108 -0
  32. package/dist-types/commands/index.d.ts +5 -0
  33. package/dist-types/models/models_0.d.ts +308 -239
  34. package/dist-types/models/models_1.d.ts +356 -344
  35. package/dist-types/models/models_2.d.ts +472 -2
  36. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  37. package/dist-types/ts3.4/Connect.d.ts +85 -0
  38. package/dist-types/ts3.4/ConnectClient.d.ts +30 -0
  39. package/dist-types/ts3.4/commands/BatchGetAttachedFileMetadataCommand.d.ts +39 -0
  40. package/dist-types/ts3.4/commands/CompleteAttachedFileUploadCommand.d.ts +39 -0
  41. package/dist-types/ts3.4/commands/DeleteAttachedFileCommand.d.ts +39 -0
  42. package/dist-types/ts3.4/commands/DescribeHoursOfOperationCommand.d.ts +2 -4
  43. package/dist-types/ts3.4/commands/DescribeInstanceAttributeCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/DescribeInstanceCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/DescribeInstanceStorageConfigCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/DescribePhoneNumberCommand.d.ts +4 -2
  47. package/dist-types/ts3.4/commands/GetAttachedFileCommand.d.ts +38 -0
  48. package/dist-types/ts3.4/commands/ReplicateInstanceCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/ResumeContactCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/ResumeContactRecordingCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/SearchAvailablePhoneNumbersCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/StartAttachedFileUploadCommand.d.ts +39 -0
  53. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +109 -74
  55. package/dist-types/ts3.4/models/models_1.d.ts +101 -99
  56. package/dist-types/ts3.4/models/models_2.d.ts +127 -3
  57. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  58. package/package.json +4 -2
@@ -1,6 +1,232 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentHierarchyGroups, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactState, DirectoryType, Distribution, EvaluationFormVersionStatus, EvaluationScore, EvaluationStatus, EventSourceName, FlowAssociationResourceType, FlowAssociationSummary, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
3
+ import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EvaluationFormVersionStatus, EvaluationScore, EvaluationStatus, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperation, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface DescribeHoursOfOperationResponse {
8
+ /**
9
+ * <p>The hours of operation.</p>
10
+ * @public
11
+ */
12
+ HoursOfOperation?: HoursOfOperation;
13
+ }
14
+ /**
15
+ * @public
16
+ */
17
+ export interface DescribeInstanceRequest {
18
+ /**
19
+ * <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>
20
+ * @public
21
+ */
22
+ InstanceId: string | undefined;
23
+ }
24
+ /**
25
+ * @public
26
+ * @enum
27
+ */
28
+ export declare const InstanceStatus: {
29
+ readonly ACTIVE: "ACTIVE";
30
+ readonly CREATION_FAILED: "CREATION_FAILED";
31
+ readonly CREATION_IN_PROGRESS: "CREATION_IN_PROGRESS";
32
+ };
33
+ /**
34
+ * @public
35
+ */
36
+ export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus];
37
+ /**
38
+ * <p>Relevant
39
+ * details why the instance was not successfully created.</p>
40
+ * @public
41
+ */
42
+ export interface InstanceStatusReason {
43
+ /**
44
+ * <p>The message.</p>
45
+ * @public
46
+ */
47
+ Message?: string;
48
+ }
49
+ /**
50
+ * <p>The Amazon Connect instance.</p>
51
+ * @public
52
+ */
53
+ export interface Instance {
54
+ /**
55
+ * <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>
56
+ * @public
57
+ */
58
+ Id?: string;
59
+ /**
60
+ * <p>The Amazon Resource Name (ARN) of the instance.</p>
61
+ * @public
62
+ */
63
+ Arn?: string;
64
+ /**
65
+ * <p>The identity management type.</p>
66
+ * @public
67
+ */
68
+ IdentityManagementType?: DirectoryType;
69
+ /**
70
+ * <p>The alias of instance.</p>
71
+ * @public
72
+ */
73
+ InstanceAlias?: string;
74
+ /**
75
+ * <p>When the instance was created.</p>
76
+ * @public
77
+ */
78
+ CreatedTime?: Date;
79
+ /**
80
+ * <p>The service role of the instance.</p>
81
+ * @public
82
+ */
83
+ ServiceRole?: string;
84
+ /**
85
+ * <p>The state of the instance.</p>
86
+ * @public
87
+ */
88
+ InstanceStatus?: InstanceStatus;
89
+ /**
90
+ * <p>Relevant
91
+ * details why the instance was not successfully created. </p>
92
+ * @public
93
+ */
94
+ StatusReason?: InstanceStatusReason;
95
+ /**
96
+ * <p>Whether inbound calls are enabled.</p>
97
+ * @public
98
+ */
99
+ InboundCallsEnabled?: boolean;
100
+ /**
101
+ * <p>Whether outbound calls are enabled.</p>
102
+ * @public
103
+ */
104
+ OutboundCallsEnabled?: boolean;
105
+ /**
106
+ * <p>This URL allows contact center users to access the Amazon Connect admin website.</p>
107
+ * @public
108
+ */
109
+ InstanceAccessUrl?: string;
110
+ /**
111
+ * <p>The tags of an instance.</p>
112
+ * @public
113
+ */
114
+ Tags?: Record<string, string>;
115
+ }
116
+ /**
117
+ * @public
118
+ */
119
+ export interface DescribeInstanceResponse {
120
+ /**
121
+ * <p>The name of the instance.</p>
122
+ * @public
123
+ */
124
+ Instance?: Instance;
125
+ }
126
+ /**
127
+ * @public
128
+ * @enum
129
+ */
130
+ export declare const InstanceAttributeType: {
131
+ readonly AUTO_RESOLVE_BEST_VOICES: "AUTO_RESOLVE_BEST_VOICES";
132
+ readonly CONTACTFLOW_LOGS: "CONTACTFLOW_LOGS";
133
+ readonly CONTACT_LENS: "CONTACT_LENS";
134
+ readonly EARLY_MEDIA: "EARLY_MEDIA";
135
+ readonly ENHANCED_CHAT_MONITORING: "ENHANCED_CHAT_MONITORING";
136
+ readonly ENHANCED_CONTACT_MONITORING: "ENHANCED_CONTACT_MONITORING";
137
+ readonly HIGH_VOLUME_OUTBOUND: "HIGH_VOLUME_OUTBOUND";
138
+ readonly INBOUND_CALLS: "INBOUND_CALLS";
139
+ readonly MULTI_PARTY_CONFERENCE: "MULTI_PARTY_CONFERENCE";
140
+ readonly OUTBOUND_CALLS: "OUTBOUND_CALLS";
141
+ readonly USE_CUSTOM_TTS_VOICES: "USE_CUSTOM_TTS_VOICES";
142
+ };
143
+ /**
144
+ * @public
145
+ */
146
+ export type InstanceAttributeType = (typeof InstanceAttributeType)[keyof typeof InstanceAttributeType];
147
+ /**
148
+ * @public
149
+ */
150
+ export interface DescribeInstanceAttributeRequest {
151
+ /**
152
+ * <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>
153
+ * @public
154
+ */
155
+ InstanceId: string | undefined;
156
+ /**
157
+ * <p>The type of attribute.</p>
158
+ * @public
159
+ */
160
+ AttributeType: InstanceAttributeType | undefined;
161
+ }
162
+ /**
163
+ * <p>A toggle for an individual feature at the instance level.</p>
164
+ * @public
165
+ */
166
+ export interface Attribute {
167
+ /**
168
+ * <p>The type of attribute.</p>
169
+ * @public
170
+ */
171
+ AttributeType?: InstanceAttributeType;
172
+ /**
173
+ * <p>The value of the attribute.</p>
174
+ * @public
175
+ */
176
+ Value?: string;
177
+ }
178
+ /**
179
+ * @public
180
+ */
181
+ export interface DescribeInstanceAttributeResponse {
182
+ /**
183
+ * <p>The
184
+ * type
185
+ * of attribute.</p>
186
+ * @public
187
+ */
188
+ Attribute?: Attribute;
189
+ }
190
+ /**
191
+ * @public
192
+ */
193
+ export interface DescribeInstanceStorageConfigRequest {
194
+ /**
195
+ * <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>
196
+ * @public
197
+ */
198
+ InstanceId: string | undefined;
199
+ /**
200
+ * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
201
+ * @public
202
+ */
203
+ AssociationId: string | undefined;
204
+ /**
205
+ * <p>A valid resource type.</p>
206
+ * @public
207
+ */
208
+ ResourceType: InstanceStorageResourceType | undefined;
209
+ }
210
+ /**
211
+ * @public
212
+ */
213
+ export interface DescribeInstanceStorageConfigResponse {
214
+ /**
215
+ * <p>A valid storage type.</p>
216
+ * @public
217
+ */
218
+ StorageConfig?: InstanceStorageConfig;
219
+ }
220
+ /**
221
+ * @public
222
+ */
223
+ export interface DescribePhoneNumberRequest {
224
+ /**
225
+ * <p>A unique identifier for the phone number.</p>
226
+ * @public
227
+ */
228
+ PhoneNumberId: string | undefined;
229
+ }
4
230
  /**
5
231
  * @public
6
232
  * @enum
@@ -1825,6 +2051,121 @@ export interface DismissUserContactRequest {
1825
2051
  */
1826
2052
  export interface DismissUserContactResponse {
1827
2053
  }
2054
+ /**
2055
+ * Request to GetAttachedFile API.
2056
+ * @public
2057
+ */
2058
+ export interface GetAttachedFileRequest {
2059
+ /**
2060
+ * <p>The unique identifier of the Connect instance.</p>
2061
+ * @public
2062
+ */
2063
+ InstanceId: string | undefined;
2064
+ /**
2065
+ * <p>The unique identifier of the attached file resource.</p>
2066
+ * @public
2067
+ */
2068
+ FileId: string | undefined;
2069
+ /**
2070
+ * <p>Optional override for the expiry of the pre-signed S3 URL in seconds.</p>
2071
+ * @public
2072
+ */
2073
+ UrlExpiryInSeconds?: number;
2074
+ /**
2075
+ * <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
2076
+ * current supported resource.</p>
2077
+ * <note>
2078
+ * <p>This value must be a valid ARN.</p>
2079
+ * </note>
2080
+ * @public
2081
+ */
2082
+ AssociatedResourceArn: string | undefined;
2083
+ }
2084
+ /**
2085
+ * <p>Metadata used to download the attached file.</p>
2086
+ * @public
2087
+ */
2088
+ export interface DownloadUrlMetadata {
2089
+ /**
2090
+ * <p>A pre-signed URL that should be used to download the attached file. </p>
2091
+ * @public
2092
+ */
2093
+ Url?: string;
2094
+ /**
2095
+ * <p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
2096
+ * yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>
2097
+ * @public
2098
+ */
2099
+ UrlExpiry?: string;
2100
+ }
2101
+ /**
2102
+ * Response from GetAttachedFile API.
2103
+ * @public
2104
+ */
2105
+ export interface GetAttachedFileResponse {
2106
+ /**
2107
+ * <p>The unique identifier of the attached file resource (ARN).</p>
2108
+ * @public
2109
+ */
2110
+ FileArn?: string;
2111
+ /**
2112
+ * <p>The unique identifier of the attached file resource.</p>
2113
+ * @public
2114
+ */
2115
+ FileId?: string;
2116
+ /**
2117
+ * <p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601
2118
+ * format: <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example,
2119
+ * <code>2024-05-03T02:41:28.172Z</code>.</p>
2120
+ * @public
2121
+ */
2122
+ CreationTime?: string;
2123
+ /**
2124
+ * <p>The current status of the attached file.</p>
2125
+ * @public
2126
+ */
2127
+ FileStatus?: FileStatusType;
2128
+ /**
2129
+ * <p>A case-sensitive name of the attached file being uploaded.</p>
2130
+ * @public
2131
+ */
2132
+ FileName?: string;
2133
+ /**
2134
+ * <p>The size of the attached file in bytes.</p>
2135
+ * @public
2136
+ */
2137
+ FileSizeInBytes: number | undefined;
2138
+ /**
2139
+ * <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
2140
+ * current supported resource.</p>
2141
+ * <note>
2142
+ * <p>This value must be a valid ARN.</p>
2143
+ * </note>
2144
+ * @public
2145
+ */
2146
+ AssociatedResourceArn?: string;
2147
+ /**
2148
+ * <p>The use case for the file.</p>
2149
+ * @public
2150
+ */
2151
+ FileUseCaseType?: FileUseCaseType;
2152
+ /**
2153
+ * <p>Represents the identity that created the file.</p>
2154
+ * @public
2155
+ */
2156
+ CreatedBy?: CreatedByInfo;
2157
+ /**
2158
+ * <p>URL and expiry to be used when downloading the attached file. </p>
2159
+ * @public
2160
+ */
2161
+ DownloadUrlMetadata?: DownloadUrlMetadata;
2162
+ /**
2163
+ * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{
2164
+ * "Tags": \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
2165
+ * @public
2166
+ */
2167
+ Tags?: Record<string, string>;
2168
+ }
1828
2169
  /**
1829
2170
  * @public
1830
2171
  */
@@ -3474,7 +3815,7 @@ export interface GetMetricDataV2Request {
3474
3815
  * <p>Unit: Seconds</p>
3475
3816
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3476
3817
  * contact/segmentAttributes/connect:Subtype</p>
3477
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical">Average greeting time agent </a>
3818
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical">Average agent greeting time</a>
3478
3819
  * </p>
3479
3820
  * </dd>
3480
3821
  * <dt>AVG_HANDLE_TIME</dt>
@@ -3546,7 +3887,7 @@ export interface GetMetricDataV2Request {
3546
3887
  * <p>Unit: Count</p>
3547
3888
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3548
3889
  * contact/segmentAttributes/connect:Subtype</p>
3549
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical">Average interruptions agent </a>
3890
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical">Average agent interruptions</a>
3550
3891
  * </p>
3551
3892
  * </dd>
3552
3893
  * <dt>AVG_INTERRUPTION_TIME_AGENT</dt>
@@ -3556,7 +3897,7 @@ export interface GetMetricDataV2Request {
3556
3897
  * <p>Unit: Seconds</p>
3557
3898
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3558
3899
  * contact/segmentAttributes/connect:Subtype</p>
3559
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical">Average interruption time agent</a>
3900
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical">Average agent interruption time</a>
3560
3901
  * </p>
3561
3902
  * </dd>
3562
3903
  * <dt>AVG_NON_TALK_TIME</dt>
@@ -3605,7 +3946,7 @@ export interface GetMetricDataV2Request {
3605
3946
  * <p>Unit: Seconds</p>
3606
3947
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3607
3948
  * contact/segmentAttributes/connect:Subtype</p>
3608
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical">Average talk time agent</a>
3949
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical">Average agent talk time</a>
3609
3950
  * </p>
3610
3951
  * </dd>
3611
3952
  * <dt>AVG_TALK_TIME_CUSTOMER</dt>
@@ -3615,7 +3956,7 @@ export interface GetMetricDataV2Request {
3615
3956
  * <p>Unit: Seconds</p>
3616
3957
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3617
3958
  * contact/segmentAttributes/connect:Subtype</p>
3618
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical">Average talk time customer</a>
3959
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical">Average customer talk time</a>
3619
3960
  * </p>
3620
3961
  * </dd>
3621
3962
  * <dt>CASES_CREATED</dt>
@@ -3668,7 +4009,7 @@ export interface GetMetricDataV2Request {
3668
4009
  * </p>
3669
4010
  * <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
3670
4011
  * contact/segmentAttributes/connect:Subtype</p>
3671
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical">Contacts handled by Connected to agent</a>
4012
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical">Contacts handled (connected to agent timestamp)</a>
3672
4013
  * </p>
3673
4014
  * </dd>
3674
4015
  * <dt>CONTACTS_HOLD_ABANDONS</dt>
@@ -3727,7 +4068,7 @@ export interface GetMetricDataV2Request {
3727
4068
  * <p>Unit: Count</p>
3728
4069
  * <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
3729
4070
  * contact/segmentAttributes/connect:Subtype</p>
3730
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical">Contacts queued by Enqueue</a>
4071
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical">Contacts queued (enqueue timestamp)</a>
3731
4072
  * </p>
3732
4073
  * </dd>
3733
4074
  * <dt>CONTACTS_RESOLVED_IN_X</dt>
@@ -3833,8 +4174,8 @@ export interface GetMetricDataV2Request {
3833
4174
  * <p>Unit: Percentage</p>
3834
4175
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3835
4176
  * contact/segmentAttributes/connect:Subtype</p>
3836
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical">Talk
3837
- * time agent percent</a>
4177
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical">Agent
4178
+ * talk time percent</a>
3838
4179
  * </p>
3839
4180
  * </dd>
3840
4181
  * <dt>PERCENT_TALK_TIME_CUSTOMER</dt>
@@ -3844,7 +4185,7 @@ export interface GetMetricDataV2Request {
3844
4185
  * <p>Unit: Percentage</p>
3845
4186
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
3846
4187
  * contact/segmentAttributes/connect:Subtype</p>
3847
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical">Talk time customer percent</a>
4188
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical">Customer talk time percent</a>
3848
4189
  * </p>
3849
4190
  * </dd>
3850
4191
  * <dt>REOPENED_CASE_ACTIONS</dt>
@@ -8188,318 +8529,13 @@ export interface ReplicateInstanceRequest {
8188
8529
  ReplicaAlias: string | undefined;
8189
8530
  }
8190
8531
  /**
8191
- * @public
8192
- */
8193
- export interface ReplicateInstanceResponse {
8194
- /**
8195
- * <p>The identifier of the replicated instance. You can find the <code>instanceId</code> in the
8196
- * ARN of the instance. The replicated instance has the same identifier as the instance it was
8197
- * replicated from.</p>
8198
- * @public
8199
- */
8200
- Id?: string;
8201
- /**
8202
- * <p>The Amazon Resource Name (ARN) of the replicated instance.</p>
8203
- * @public
8204
- */
8205
- Arn?: string;
8206
- }
8207
- /**
8208
- * @public
8209
- */
8210
- export interface ResumeContactRequest {
8211
- /**
8212
- * <p>The identifier of the contact.</p>
8213
- * @public
8214
- */
8215
- ContactId: string | undefined;
8216
- /**
8217
- * <p>The identifier of the Amazon Connect instance. You can find the <code>instanceId</code> in the ARN of
8218
- * the instance.</p>
8219
- * @public
8220
- */
8221
- InstanceId: string | undefined;
8222
- /**
8223
- * <p>The identifier of the flow.</p>
8224
- * @public
8225
- */
8226
- ContactFlowId?: string;
8227
- }
8228
- /**
8229
- * @public
8230
- */
8231
- export interface ResumeContactResponse {
8232
- }
8233
- /**
8234
- * @public
8235
- */
8236
- export interface ResumeContactRecordingRequest {
8237
- /**
8238
- * <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>
8239
- * @public
8240
- */
8241
- InstanceId: string | undefined;
8242
- /**
8243
- * <p>The identifier of the contact.</p>
8244
- * @public
8245
- */
8246
- ContactId: string | undefined;
8247
- /**
8248
- * <p>The identifier of the contact. This is the identifier of the contact associated with the
8249
- * first interaction with the contact center.</p>
8250
- * @public
8251
- */
8252
- InitialContactId: string | undefined;
8253
- }
8254
- /**
8255
- * @public
8256
- */
8257
- export interface ResumeContactRecordingResponse {
8258
- }
8259
- /**
8260
- * @public
8261
- */
8262
- export interface SearchAvailablePhoneNumbersRequest {
8263
- /**
8264
- * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
8265
- * @public
8266
- */
8267
- TargetArn?: string;
8268
- /**
8269
- * <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
8270
- * can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
8271
- * instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
8272
- * @public
8273
- */
8274
- InstanceId?: string;
8275
- /**
8276
- * <p>The ISO country code.</p>
8277
- * @public
8278
- */
8279
- PhoneNumberCountryCode: PhoneNumberCountryCode | undefined;
8280
- /**
8281
- * <p>The type of phone number.</p>
8282
- * @public
8283
- */
8284
- PhoneNumberType: PhoneNumberType | undefined;
8285
- /**
8286
- * <p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>
8287
- * @public
8288
- */
8289
- PhoneNumberPrefix?: string;
8290
- /**
8291
- * <p>The maximum number of results to return per page.</p>
8292
- * @public
8293
- */
8294
- MaxResults?: number;
8295
- /**
8296
- * <p>The token for the next set of results. Use the value returned in the previous
8297
- * response in the next request to retrieve the next set of results.</p>
8298
- * @public
8299
- */
8300
- NextToken?: string;
8301
- }
8302
- /**
8303
- * <p>Information about available phone numbers.</p>
8304
- * @public
8305
- */
8306
- export interface AvailableNumberSummary {
8307
- /**
8308
- * <p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
8309
- * @public
8310
- */
8311
- PhoneNumber?: string;
8312
- /**
8313
- * <p>The ISO country code.</p>
8314
- * @public
8315
- */
8316
- PhoneNumberCountryCode?: PhoneNumberCountryCode;
8317
- /**
8318
- * <p>The type of phone number.</p>
8319
- * @public
8320
- */
8321
- PhoneNumberType?: PhoneNumberType;
8322
- }
8323
- /**
8324
- * @public
8325
- */
8326
- export interface SearchAvailablePhoneNumbersResponse {
8327
- /**
8328
- * <p>If there are additional results, this is the token for the next set of results.</p>
8329
- * @public
8330
- */
8331
- NextToken?: string;
8332
- /**
8333
- * <p>A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.</p>
8334
- * @public
8335
- */
8336
- AvailableNumbersList?: AvailableNumberSummary[];
8337
- }
8338
- /**
8339
- * @public
8340
- * @enum
8341
- */
8342
- export declare const SearchContactsMatchType: {
8343
- readonly MATCH_ALL: "MATCH_ALL";
8344
- readonly MATCH_ANY: "MATCH_ANY";
8345
- };
8346
- /**
8347
- * @public
8348
- */
8349
- export type SearchContactsMatchType = (typeof SearchContactsMatchType)[keyof typeof SearchContactsMatchType];
8350
- /**
8351
- * <p>A structure that defines search criteria base on words or phrases, participants in the
8352
- * Contact Lens conversational analytics transcript.</p>
8353
- * @public
8354
- */
8355
- export interface TranscriptCriteria {
8356
- /**
8357
- * <p>The participant role in a transcript</p>
8358
- * @public
8359
- */
8360
- ParticipantRole: ParticipantRole | undefined;
8361
- /**
8362
- * <p>The words or phrases used to search within a transcript.</p>
8363
- * @public
8364
- */
8365
- SearchText: string[] | undefined;
8366
- /**
8367
- * <p>The match type combining search criteria using multiple search texts in a transcript
8368
- * criteria.</p>
8369
- * @public
8370
- */
8371
- MatchType: SearchContactsMatchType | undefined;
8372
- }
8373
- /**
8374
- * <p>A structure that defines search criteria and matching logic to search for contacts by
8375
- * matching text with transcripts analyzed by Amazon Connect Contact Lens.</p>
8376
- * @public
8377
- */
8378
- export interface Transcript {
8379
- /**
8380
- * <p>The list of search criteria based on Contact Lens conversational analytics
8381
- * transcript.</p>
8382
- * @public
8383
- */
8384
- Criteria: TranscriptCriteria[] | undefined;
8385
- /**
8386
- * <p>The match type combining search criteria using multiple transcript criteria.</p>
8387
- * @public
8388
- */
8389
- MatchType?: SearchContactsMatchType;
8390
- }
8391
- /**
8392
- * <p>A structure that defines search criteria for contacts using analysis outputs from Amazon
8393
- * Connect Contact Lens.</p>
8394
- * @public
8395
- */
8396
- export interface ContactAnalysis {
8397
- /**
8398
- * <p>Search criteria based on transcript analyzed by Amazon Connect Contact Lens.</p>
8399
- * @public
8400
- */
8401
- Transcript?: Transcript;
8402
- }
8403
- /**
8404
- * <p>The search criteria based on user-defned contact attribute key and values to search
8405
- * on.</p>
8406
- * @public
8407
- */
8408
- export interface SearchableContactAttributesCriteria {
8409
- /**
8410
- * <p>The key containing a searchable user-defined contact attribute.</p>
8411
- * @public
8412
- */
8413
- Key: string | undefined;
8414
- /**
8415
- * <p>The list of values to search for within a user-defined contact attribute.</p>
8416
- * @public
8417
- */
8418
- Values: string[] | undefined;
8419
- }
8420
- /**
8421
- * <p>A structure that defines search criteria based on user-defined contact attributes that are
8422
- * configured for contact search.</p>
8423
- * @public
8424
- */
8425
- export interface SearchableContactAttributes {
8426
- /**
8427
- * <p>The list of criteria based on user-defined contact attributes that are configured for
8428
- * contact search.</p>
8429
- * @public
8430
- */
8431
- Criteria: SearchableContactAttributesCriteria[] | undefined;
8432
- /**
8433
- * <p>The match type combining search criteria using multiple searchable contact
8434
- * attributes.</p>
8435
- * @public
8436
- */
8437
- MatchType?: SearchContactsMatchType;
8438
- }
8439
- /**
8440
- * <p>A structure of search criteria to be used to return contacts.</p>
8441
- * @public
8442
- */
8443
- export interface SearchCriteria {
8444
- /**
8445
- * <p>The identifiers of agents who handled the contacts.</p>
8446
- * @public
8447
- */
8448
- AgentIds?: string[];
8449
- /**
8450
- * <p>The agent hierarchy groups of the agent at the time of handling the contact.</p>
8451
- * @public
8452
- */
8453
- AgentHierarchyGroups?: AgentHierarchyGroups;
8454
- /**
8455
- * <p>The list of channels associated with contacts.</p>
8456
- * @public
8457
- */
8458
- Channels?: Channel[];
8459
- /**
8460
- * <p>Search criteria based on analysis outputs from Amazon Connect Contact Lens.</p>
8461
- * @public
8462
- */
8463
- ContactAnalysis?: ContactAnalysis;
8464
- /**
8465
- * <p>The list of initiation methods associated with contacts.</p>
8466
- * @public
8467
- */
8468
- InitiationMethods?: ContactInitiationMethod[];
8469
- /**
8470
- * <p>The list of queue IDs associated with contacts.</p>
8471
- * @public
8472
- */
8473
- QueueIds?: string[];
8474
- /**
8475
- * <p>The search criteria based on user-defined contact attributes that have been configured for
8476
- * contact search. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html">Search by customer contact
8477
- * attributes</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
8478
- * <important>
8479
- * <p>To use <code>SearchableContactAttributes</code> in a search request, the
8480
- * <code>GetContactAttributes</code> action is required to perform an API request. For more
8481
- * information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions">https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions</a>Actions defined by Amazon Connect.</p>
8482
- * </important>
8483
- * @public
8484
- */
8485
- SearchableContactAttributes?: SearchableContactAttributes;
8486
- }
8487
- /**
8488
- * @public
8489
- * @enum
8532
+ * @internal
8490
8533
  */
8491
- export declare const SortableFieldName: {
8492
- readonly CHANNEL: "CHANNEL";
8493
- readonly CONNECTED_TO_AGENT_TIMESTAMP: "CONNECTED_TO_AGENT_TIMESTAMP";
8494
- readonly DISCONNECT_TIMESTAMP: "DISCONNECT_TIMESTAMP";
8495
- readonly INITIATION_METHOD: "INITIATION_METHOD";
8496
- readonly INITIATION_TIMESTAMP: "INITIATION_TIMESTAMP";
8497
- readonly SCHEDULED_TIMESTAMP: "SCHEDULED_TIMESTAMP";
8498
- };
8534
+ export declare const InstanceFilterSensitiveLog: (obj: Instance) => any;
8499
8535
  /**
8500
- * @public
8536
+ * @internal
8501
8537
  */
8502
- export type SortableFieldName = (typeof SortableFieldName)[keyof typeof SortableFieldName];
8538
+ export declare const DescribeInstanceResponseFilterSensitiveLog: (obj: DescribeInstanceResponse) => any;
8503
8539
  /**
8504
8540
  * @internal
8505
8541
  */
@@ -8548,27 +8584,3 @@ export declare const ListViewVersionsResponseFilterSensitiveLog: (obj: ListViewV
8548
8584
  * @internal
8549
8585
  */
8550
8586
  export declare const ReplicateInstanceRequestFilterSensitiveLog: (obj: ReplicateInstanceRequest) => any;
8551
- /**
8552
- * @internal
8553
- */
8554
- export declare const TranscriptCriteriaFilterSensitiveLog: (obj: TranscriptCriteria) => any;
8555
- /**
8556
- * @internal
8557
- */
8558
- export declare const TranscriptFilterSensitiveLog: (obj: Transcript) => any;
8559
- /**
8560
- * @internal
8561
- */
8562
- export declare const ContactAnalysisFilterSensitiveLog: (obj: ContactAnalysis) => any;
8563
- /**
8564
- * @internal
8565
- */
8566
- export declare const SearchableContactAttributesCriteriaFilterSensitiveLog: (obj: SearchableContactAttributesCriteria) => any;
8567
- /**
8568
- * @internal
8569
- */
8570
- export declare const SearchableContactAttributesFilterSensitiveLog: (obj: SearchableContactAttributes) => any;
8571
- /**
8572
- * @internal
8573
- */
8574
- export declare const SearchCriteriaFilterSensitiveLog: (obj: SearchCriteria) => any;