@aws-sdk/client-connect 3.48.0 → 3.52.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.
- package/CHANGELOG.md +35 -0
- package/README.md +2 -3
- package/dist-cjs/Connect.js +90 -0
- package/dist-cjs/commands/AssociateDefaultVocabularyCommand.js +36 -0
- package/dist-cjs/commands/CreateVocabularyCommand.js +36 -0
- package/dist-cjs/commands/DeleteVocabularyCommand.js +36 -0
- package/dist-cjs/commands/DescribeVocabularyCommand.js +36 -0
- package/dist-cjs/commands/ListDefaultVocabulariesCommand.js +36 -0
- package/dist-cjs/commands/SearchVocabulariesCommand.js +36 -0
- package/dist-cjs/commands/StartOutboundVoiceContactCommand.js +3 -3
- package/dist-cjs/commands/StartTaskContactCommand.js +3 -3
- package/dist-cjs/commands/StopContactCommand.js +3 -3
- package/dist-cjs/commands/StopContactRecordingCommand.js +3 -3
- package/dist-cjs/commands/StopContactStreamingCommand.js +3 -3
- package/dist-cjs/commands/SuspendContactRecordingCommand.js +3 -3
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/models/models_0.js +127 -95
- package/dist-cjs/models/models_1.js +91 -1
- package/dist-cjs/pagination/ListDefaultVocabulariesPaginator.js +35 -0
- package/dist-cjs/pagination/SearchVocabulariesPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +796 -7
- package/dist-es/Connect.js +90 -0
- package/dist-es/commands/AssociateDefaultVocabularyCommand.js +39 -0
- package/dist-es/commands/CreateVocabularyCommand.js +39 -0
- package/dist-es/commands/DeleteVocabularyCommand.js +39 -0
- package/dist-es/commands/DescribeVocabularyCommand.js +39 -0
- package/dist-es/commands/ListDefaultVocabulariesCommand.js +39 -0
- package/dist-es/commands/SearchVocabulariesCommand.js +39 -0
- package/dist-es/commands/StartOutboundVoiceContactCommand.js +1 -1
- package/dist-es/commands/StartTaskContactCommand.js +1 -1
- package/dist-es/commands/StopContactCommand.js +1 -1
- package/dist-es/commands/StopContactRecordingCommand.js +1 -1
- package/dist-es/commands/StopContactStreamingCommand.js +1 -1
- package/dist-es/commands/SuspendContactRecordingCommand.js +1 -1
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +91 -61
- package/dist-es/models/models_1.js +61 -0
- package/dist-es/pagination/ListDefaultVocabulariesPaginator.js +74 -0
- package/dist-es/pagination/SearchVocabulariesPaginator.js +74 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +946 -64
- package/dist-types/Connect.d.ts +62 -15
- package/dist-types/ConnectClient.d.ts +10 -5
- package/dist-types/commands/AssociateDefaultVocabularyCommand.d.ts +35 -0
- package/dist-types/commands/CreateVocabularyCommand.d.ts +37 -0
- package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +35 -0
- package/dist-types/commands/DescribeVocabularyCommand.d.ts +35 -0
- package/dist-types/commands/ListBotsCommand.d.ts +2 -2
- package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +35 -0
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +35 -0
- package/dist-types/commands/StartChatContactCommand.d.ts +4 -1
- package/dist-types/commands/StartContactStreamingCommand.d.ts +1 -1
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +4 -3
- package/dist-types/commands/StartTaskContactCommand.d.ts +1 -1
- package/dist-types/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +433 -347
- package/dist-types/models/models_1.d.ts +337 -2
- package/dist-types/pagination/ListDefaultVocabulariesPaginator.d.ts +4 -0
- package/dist-types/pagination/SearchVocabulariesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Connect.d.ts +30 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/AssociateDefaultVocabularyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateVocabularyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeVocabularyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListDefaultVocabulariesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopContactStreamingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendContactRecordingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +236 -182
- package/dist-types/ts3.4/models/models_1.d.ts +184 -1
- package/dist-types/ts3.4/pagination/ListDefaultVocabulariesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/SearchVocabulariesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +18 -0
- package/package.json +40 -34
|
@@ -256,6 +256,59 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
|
|
|
256
256
|
*/
|
|
257
257
|
Message?: string;
|
|
258
258
|
}
|
|
259
|
+
export declare enum VocabularyLanguageCode {
|
|
260
|
+
AR_AE = "ar-AE",
|
|
261
|
+
DE_CH = "de-CH",
|
|
262
|
+
DE_DE = "de-DE",
|
|
263
|
+
EN_AB = "en-AB",
|
|
264
|
+
EN_AU = "en-AU",
|
|
265
|
+
EN_GB = "en-GB",
|
|
266
|
+
EN_IE = "en-IE",
|
|
267
|
+
EN_IN = "en-IN",
|
|
268
|
+
EN_US = "en-US",
|
|
269
|
+
EN_WL = "en-WL",
|
|
270
|
+
ES_ES = "es-ES",
|
|
271
|
+
ES_US = "es-US",
|
|
272
|
+
FR_CA = "fr-CA",
|
|
273
|
+
FR_FR = "fr-FR",
|
|
274
|
+
HI_IN = "hi-IN",
|
|
275
|
+
IT_IT = "it-IT",
|
|
276
|
+
JA_JP = "ja-JP",
|
|
277
|
+
KO_KR = "ko-KR",
|
|
278
|
+
PT_BR = "pt-BR",
|
|
279
|
+
PT_PT = "pt-PT",
|
|
280
|
+
ZH_CN = "zh-CN"
|
|
281
|
+
}
|
|
282
|
+
export interface AssociateDefaultVocabularyRequest {
|
|
283
|
+
/**
|
|
284
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
285
|
+
*/
|
|
286
|
+
InstanceId: string | undefined;
|
|
287
|
+
/**
|
|
288
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
289
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
290
|
+
* </p>
|
|
291
|
+
*/
|
|
292
|
+
LanguageCode: VocabularyLanguageCode | string | undefined;
|
|
293
|
+
/**
|
|
294
|
+
* <p>The identifier of the custom vocabulary. If this is empty, the default is set to none.</p>
|
|
295
|
+
*/
|
|
296
|
+
VocabularyId?: string;
|
|
297
|
+
}
|
|
298
|
+
export declare namespace AssociateDefaultVocabularyRequest {
|
|
299
|
+
/**
|
|
300
|
+
* @internal
|
|
301
|
+
*/
|
|
302
|
+
const filterSensitiveLog: (obj: AssociateDefaultVocabularyRequest) => any;
|
|
303
|
+
}
|
|
304
|
+
export interface AssociateDefaultVocabularyResponse {
|
|
305
|
+
}
|
|
306
|
+
export declare namespace AssociateDefaultVocabularyResponse {
|
|
307
|
+
/**
|
|
308
|
+
* @internal
|
|
309
|
+
*/
|
|
310
|
+
const filterSensitiveLog: (obj: AssociateDefaultVocabularyResponse) => any;
|
|
311
|
+
}
|
|
259
312
|
export declare enum InstanceStorageResourceType {
|
|
260
313
|
AGENT_EVENTS = "AGENT_EVENTS",
|
|
261
314
|
CALL_RECORDINGS = "CALL_RECORDINGS",
|
|
@@ -1232,8 +1285,7 @@ export interface CreateQuickConnectResponse {
|
|
|
1232
1285
|
*/
|
|
1233
1286
|
QuickConnectARN?: string;
|
|
1234
1287
|
/**
|
|
1235
|
-
* <p>The identifier for the quick connect.
|
|
1236
|
-
* </p>
|
|
1288
|
+
* <p>The identifier for the quick connect. </p>
|
|
1237
1289
|
*/
|
|
1238
1290
|
QuickConnectId?: string;
|
|
1239
1291
|
}
|
|
@@ -1590,6 +1642,74 @@ export declare namespace CreateUserHierarchyGroupResponse {
|
|
|
1590
1642
|
*/
|
|
1591
1643
|
const filterSensitiveLog: (obj: CreateUserHierarchyGroupResponse) => any;
|
|
1592
1644
|
}
|
|
1645
|
+
export interface CreateVocabularyRequest {
|
|
1646
|
+
/**
|
|
1647
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1648
|
+
* request. If a create request is received more than once with same client token,
|
|
1649
|
+
* subsequent requests return the previous response without creating a vocabulary again.</p>
|
|
1650
|
+
*/
|
|
1651
|
+
ClientToken?: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
1654
|
+
*/
|
|
1655
|
+
InstanceId: string | undefined;
|
|
1656
|
+
/**
|
|
1657
|
+
* <p>A unique name of the custom vocabulary.</p>
|
|
1658
|
+
*/
|
|
1659
|
+
VocabularyName: string | undefined;
|
|
1660
|
+
/**
|
|
1661
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
1662
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
1663
|
+
* </p>
|
|
1664
|
+
*/
|
|
1665
|
+
LanguageCode: VocabularyLanguageCode | string | undefined;
|
|
1666
|
+
/**
|
|
1667
|
+
* <p>The content of the custom vocabulary in plain-text format with a table of values. Each row
|
|
1668
|
+
* in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>,
|
|
1669
|
+
* <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
|
|
1670
|
+
* characters. The size limit is 50KB. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create a custom
|
|
1671
|
+
* vocabulary using a table</a>.</p>
|
|
1672
|
+
*/
|
|
1673
|
+
Content: string | undefined;
|
|
1674
|
+
/**
|
|
1675
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1676
|
+
*/
|
|
1677
|
+
Tags?: {
|
|
1678
|
+
[key: string]: string;
|
|
1679
|
+
};
|
|
1680
|
+
}
|
|
1681
|
+
export declare namespace CreateVocabularyRequest {
|
|
1682
|
+
/**
|
|
1683
|
+
* @internal
|
|
1684
|
+
*/
|
|
1685
|
+
const filterSensitiveLog: (obj: CreateVocabularyRequest) => any;
|
|
1686
|
+
}
|
|
1687
|
+
export declare enum VocabularyState {
|
|
1688
|
+
ACTIVE = "ACTIVE",
|
|
1689
|
+
CREATION_FAILED = "CREATION_FAILED",
|
|
1690
|
+
CREATION_IN_PROGRESS = "CREATION_IN_PROGRESS",
|
|
1691
|
+
DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS"
|
|
1692
|
+
}
|
|
1693
|
+
export interface CreateVocabularyResponse {
|
|
1694
|
+
/**
|
|
1695
|
+
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
1696
|
+
*/
|
|
1697
|
+
VocabularyArn: string | undefined;
|
|
1698
|
+
/**
|
|
1699
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
1700
|
+
*/
|
|
1701
|
+
VocabularyId: string | undefined;
|
|
1702
|
+
/**
|
|
1703
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
1704
|
+
*/
|
|
1705
|
+
State: VocabularyState | string | undefined;
|
|
1706
|
+
}
|
|
1707
|
+
export declare namespace CreateVocabularyResponse {
|
|
1708
|
+
/**
|
|
1709
|
+
* @internal
|
|
1710
|
+
*/
|
|
1711
|
+
const filterSensitiveLog: (obj: CreateVocabularyResponse) => any;
|
|
1712
|
+
}
|
|
1593
1713
|
export interface DeleteContactFlowRequest {
|
|
1594
1714
|
/**
|
|
1595
1715
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
@@ -1783,6 +1903,42 @@ export declare namespace DeleteUserHierarchyGroupRequest {
|
|
|
1783
1903
|
*/
|
|
1784
1904
|
const filterSensitiveLog: (obj: DeleteUserHierarchyGroupRequest) => any;
|
|
1785
1905
|
}
|
|
1906
|
+
export interface DeleteVocabularyRequest {
|
|
1907
|
+
/**
|
|
1908
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
1909
|
+
*/
|
|
1910
|
+
InstanceId: string | undefined;
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
1913
|
+
*/
|
|
1914
|
+
VocabularyId: string | undefined;
|
|
1915
|
+
}
|
|
1916
|
+
export declare namespace DeleteVocabularyRequest {
|
|
1917
|
+
/**
|
|
1918
|
+
* @internal
|
|
1919
|
+
*/
|
|
1920
|
+
const filterSensitiveLog: (obj: DeleteVocabularyRequest) => any;
|
|
1921
|
+
}
|
|
1922
|
+
export interface DeleteVocabularyResponse {
|
|
1923
|
+
/**
|
|
1924
|
+
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
1925
|
+
*/
|
|
1926
|
+
VocabularyArn: string | undefined;
|
|
1927
|
+
/**
|
|
1928
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
1929
|
+
*/
|
|
1930
|
+
VocabularyId: string | undefined;
|
|
1931
|
+
/**
|
|
1932
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
1933
|
+
*/
|
|
1934
|
+
State: VocabularyState | string | undefined;
|
|
1935
|
+
}
|
|
1936
|
+
export declare namespace DeleteVocabularyResponse {
|
|
1937
|
+
/**
|
|
1938
|
+
* @internal
|
|
1939
|
+
*/
|
|
1940
|
+
const filterSensitiveLog: (obj: DeleteVocabularyResponse) => any;
|
|
1941
|
+
}
|
|
1786
1942
|
export interface DescribeAgentStatusRequest {
|
|
1787
1943
|
/**
|
|
1788
1944
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
@@ -1899,10 +2055,11 @@ export interface Contact {
|
|
|
1899
2055
|
*/
|
|
1900
2056
|
AgentInfo?: AgentInfo;
|
|
1901
2057
|
/**
|
|
1902
|
-
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
|
|
1903
|
-
* contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
|
|
1904
|
-
*
|
|
1905
|
-
*
|
|
2058
|
+
* <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
|
|
2059
|
+
* when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
|
|
2060
|
+
* <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
|
|
2061
|
+
* and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For <code>API</code>,
|
|
2062
|
+
* this is when the request arrived.</p>
|
|
1906
2063
|
*/
|
|
1907
2064
|
InitiationTimestamp?: Date;
|
|
1908
2065
|
/**
|
|
@@ -1914,7 +2071,8 @@ export interface Contact {
|
|
|
1914
2071
|
*/
|
|
1915
2072
|
LastUpdateTimestamp?: Date;
|
|
1916
2073
|
/**
|
|
1917
|
-
* <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
|
|
2074
|
+
* <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
|
|
2075
|
+
* </p>
|
|
1918
2076
|
*/
|
|
1919
2077
|
ScheduledTimestamp?: Date;
|
|
1920
2078
|
}
|
|
@@ -2923,6 +3081,91 @@ export declare namespace DescribeUserHierarchyStructureResponse {
|
|
|
2923
3081
|
*/
|
|
2924
3082
|
const filterSensitiveLog: (obj: DescribeUserHierarchyStructureResponse) => any;
|
|
2925
3083
|
}
|
|
3084
|
+
export interface DescribeVocabularyRequest {
|
|
3085
|
+
/**
|
|
3086
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
3087
|
+
*/
|
|
3088
|
+
InstanceId: string | undefined;
|
|
3089
|
+
/**
|
|
3090
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
3091
|
+
*/
|
|
3092
|
+
VocabularyId: string | undefined;
|
|
3093
|
+
}
|
|
3094
|
+
export declare namespace DescribeVocabularyRequest {
|
|
3095
|
+
/**
|
|
3096
|
+
* @internal
|
|
3097
|
+
*/
|
|
3098
|
+
const filterSensitiveLog: (obj: DescribeVocabularyRequest) => any;
|
|
3099
|
+
}
|
|
3100
|
+
/**
|
|
3101
|
+
* <p>Contains information about a custom vocabulary.</p>
|
|
3102
|
+
*/
|
|
3103
|
+
export interface Vocabulary {
|
|
3104
|
+
/**
|
|
3105
|
+
* <p>A unique name of the custom vocabulary.</p>
|
|
3106
|
+
*/
|
|
3107
|
+
Name: string | undefined;
|
|
3108
|
+
/**
|
|
3109
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
3110
|
+
*/
|
|
3111
|
+
Id: string | undefined;
|
|
3112
|
+
/**
|
|
3113
|
+
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
3114
|
+
*/
|
|
3115
|
+
Arn: string | undefined;
|
|
3116
|
+
/**
|
|
3117
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
3118
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
3119
|
+
* </p>
|
|
3120
|
+
*/
|
|
3121
|
+
LanguageCode: VocabularyLanguageCode | string | undefined;
|
|
3122
|
+
/**
|
|
3123
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
3124
|
+
*/
|
|
3125
|
+
State: VocabularyState | string | undefined;
|
|
3126
|
+
/**
|
|
3127
|
+
* <p>The timestamp when the custom vocabulary was last modified.</p>
|
|
3128
|
+
*/
|
|
3129
|
+
LastModifiedTime: Date | undefined;
|
|
3130
|
+
/**
|
|
3131
|
+
* <p>The reason why the custom vocabulary was not created.</p>
|
|
3132
|
+
*/
|
|
3133
|
+
FailureReason?: string;
|
|
3134
|
+
/**
|
|
3135
|
+
* <p>The content of the custom vocabulary in plain-text format with a table of values. Each row
|
|
3136
|
+
* in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>,
|
|
3137
|
+
* <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
|
|
3138
|
+
* characters. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create a custom
|
|
3139
|
+
* vocabulary using a table</a>.</p>
|
|
3140
|
+
*/
|
|
3141
|
+
Content?: string;
|
|
3142
|
+
/**
|
|
3143
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3144
|
+
*/
|
|
3145
|
+
Tags?: {
|
|
3146
|
+
[key: string]: string;
|
|
3147
|
+
};
|
|
3148
|
+
}
|
|
3149
|
+
export declare namespace Vocabulary {
|
|
3150
|
+
/**
|
|
3151
|
+
* @internal
|
|
3152
|
+
*/
|
|
3153
|
+
const filterSensitiveLog: (obj: Vocabulary) => any;
|
|
3154
|
+
}
|
|
3155
|
+
export interface DescribeVocabularyResponse {
|
|
3156
|
+
/**
|
|
3157
|
+
* <p>A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They
|
|
3158
|
+
* are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or
|
|
3159
|
+
* proper nouns.</p>
|
|
3160
|
+
*/
|
|
3161
|
+
Vocabulary: Vocabulary | undefined;
|
|
3162
|
+
}
|
|
3163
|
+
export declare namespace DescribeVocabularyResponse {
|
|
3164
|
+
/**
|
|
3165
|
+
* @internal
|
|
3166
|
+
*/
|
|
3167
|
+
const filterSensitiveLog: (obj: DescribeVocabularyResponse) => any;
|
|
3168
|
+
}
|
|
2926
3169
|
export interface DisassociateApprovedOriginRequest {
|
|
2927
3170
|
/**
|
|
2928
3171
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
@@ -3146,8 +3389,9 @@ export declare namespace CurrentMetric {
|
|
|
3146
3389
|
*/
|
|
3147
3390
|
export interface Filters {
|
|
3148
3391
|
/**
|
|
3149
|
-
* <p>The queues to use to filter the metrics. You should specify at least one queue, and can
|
|
3150
|
-
* request.
|
|
3392
|
+
* <p>The queues to use to filter the metrics. You should specify at least one queue, and can
|
|
3393
|
+
* specify up to 100 queues per request. The <code>GetCurrentMetricsData</code> API in particular
|
|
3394
|
+
* requires a queue when you include a <code>Filter</code> in your request. </p>
|
|
3151
3395
|
*/
|
|
3152
3396
|
Queues?: string[];
|
|
3153
3397
|
/**
|
|
@@ -3258,11 +3502,11 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3258
3502
|
* <dd>
|
|
3259
3503
|
* <p>Unit: SECONDS</p>
|
|
3260
3504
|
* <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p>
|
|
3261
|
-
* <p>When you do not use groupings, Unit says SECONDS but the Value is returned in
|
|
3262
|
-
* example, if you get a response like this:</p>
|
|
3505
|
+
* <p>When you do not use groupings, Unit says SECONDS but the Value is returned in
|
|
3506
|
+
* MILLISECONDS. For example, if you get a response like this:</p>
|
|
3263
3507
|
* <p>
|
|
3264
3508
|
* <code>{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
|
|
3265
|
-
*
|
|
3509
|
+
* </code>}</p>
|
|
3266
3510
|
* <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p>
|
|
3267
3511
|
*
|
|
3268
3512
|
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time">Oldest</a>
|
|
@@ -4117,7 +4361,8 @@ export declare enum ReferenceStatus {
|
|
|
4117
4361
|
REJECTED = "REJECTED"
|
|
4118
4362
|
}
|
|
4119
4363
|
/**
|
|
4120
|
-
* <p>Information about the attachment reference if the <code>referenceType</code> is
|
|
4364
|
+
* <p>Information about the attachment reference if the <code>referenceType</code> is
|
|
4365
|
+
* <code>ATTACHMENT</code>. Otherwise, null.</p>
|
|
4121
4366
|
*/
|
|
4122
4367
|
export interface AttachmentReference {
|
|
4123
4368
|
/**
|
|
@@ -4159,7 +4404,8 @@ export declare namespace UrlReference {
|
|
|
4159
4404
|
const filterSensitiveLog: (obj: UrlReference) => any;
|
|
4160
4405
|
}
|
|
4161
4406
|
/**
|
|
4162
|
-
* <p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only
|
|
4407
|
+
* <p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only
|
|
4408
|
+
* one non null field between the URL and attachment based on the reference type.</p>
|
|
4163
4409
|
*/
|
|
4164
4410
|
export declare type ReferenceSummary = ReferenceSummary.AttachmentMember | ReferenceSummary.UrlMember | ReferenceSummary.$UnknownMember;
|
|
4165
4411
|
export declare namespace ReferenceSummary {
|
|
@@ -4173,7 +4419,8 @@ export declare namespace ReferenceSummary {
|
|
|
4173
4419
|
$unknown?: never;
|
|
4174
4420
|
}
|
|
4175
4421
|
/**
|
|
4176
|
-
* <p>Information about the attachment reference if the <code>referenceType</code> is
|
|
4422
|
+
* <p>Information about the attachment reference if the <code>referenceType</code> is
|
|
4423
|
+
* <code>ATTACHMENT</code>. Otherwise, null.</p>
|
|
4177
4424
|
*/
|
|
4178
4425
|
interface AttachmentMember {
|
|
4179
4426
|
Url?: never;
|
|
@@ -4215,6 +4462,78 @@ export declare namespace ListContactReferencesResponse {
|
|
|
4215
4462
|
*/
|
|
4216
4463
|
const filterSensitiveLog: (obj: ListContactReferencesResponse) => any;
|
|
4217
4464
|
}
|
|
4465
|
+
export interface ListDefaultVocabulariesRequest {
|
|
4466
|
+
/**
|
|
4467
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
4468
|
+
*/
|
|
4469
|
+
InstanceId: string | undefined;
|
|
4470
|
+
/**
|
|
4471
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
4472
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
4473
|
+
* </p>
|
|
4474
|
+
*/
|
|
4475
|
+
LanguageCode?: VocabularyLanguageCode | string;
|
|
4476
|
+
/**
|
|
4477
|
+
* <p>The maximum number of results to return per page.</p>
|
|
4478
|
+
*/
|
|
4479
|
+
MaxResults?: number;
|
|
4480
|
+
/**
|
|
4481
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
4482
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
4483
|
+
*/
|
|
4484
|
+
NextToken?: string;
|
|
4485
|
+
}
|
|
4486
|
+
export declare namespace ListDefaultVocabulariesRequest {
|
|
4487
|
+
/**
|
|
4488
|
+
* @internal
|
|
4489
|
+
*/
|
|
4490
|
+
const filterSensitiveLog: (obj: ListDefaultVocabulariesRequest) => any;
|
|
4491
|
+
}
|
|
4492
|
+
/**
|
|
4493
|
+
* <p>Contains information about a default vocabulary.</p>
|
|
4494
|
+
*/
|
|
4495
|
+
export interface DefaultVocabulary {
|
|
4496
|
+
/**
|
|
4497
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
4498
|
+
*/
|
|
4499
|
+
InstanceId: string | undefined;
|
|
4500
|
+
/**
|
|
4501
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
4502
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
4503
|
+
* </p>
|
|
4504
|
+
*/
|
|
4505
|
+
LanguageCode: VocabularyLanguageCode | string | undefined;
|
|
4506
|
+
/**
|
|
4507
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
4508
|
+
*/
|
|
4509
|
+
VocabularyId: string | undefined;
|
|
4510
|
+
/**
|
|
4511
|
+
* <p>A unique name of the custom vocabulary.</p>
|
|
4512
|
+
*/
|
|
4513
|
+
VocabularyName: string | undefined;
|
|
4514
|
+
}
|
|
4515
|
+
export declare namespace DefaultVocabulary {
|
|
4516
|
+
/**
|
|
4517
|
+
* @internal
|
|
4518
|
+
*/
|
|
4519
|
+
const filterSensitiveLog: (obj: DefaultVocabulary) => any;
|
|
4520
|
+
}
|
|
4521
|
+
export interface ListDefaultVocabulariesResponse {
|
|
4522
|
+
/**
|
|
4523
|
+
* <p>A list of default vocabularies.</p>
|
|
4524
|
+
*/
|
|
4525
|
+
DefaultVocabularyList: DefaultVocabulary[] | undefined;
|
|
4526
|
+
/**
|
|
4527
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
4528
|
+
*/
|
|
4529
|
+
NextToken?: string;
|
|
4530
|
+
}
|
|
4531
|
+
export declare namespace ListDefaultVocabulariesResponse {
|
|
4532
|
+
/**
|
|
4533
|
+
* @internal
|
|
4534
|
+
*/
|
|
4535
|
+
const filterSensitiveLog: (obj: ListDefaultVocabulariesResponse) => any;
|
|
4536
|
+
}
|
|
4218
4537
|
export interface ListHoursOfOperationsRequest {
|
|
4219
4538
|
/**
|
|
4220
4539
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
@@ -4565,7 +4884,8 @@ export interface ListLexBotsRequest {
|
|
|
4565
4884
|
*/
|
|
4566
4885
|
NextToken?: string;
|
|
4567
4886
|
/**
|
|
4568
|
-
* <p>The maximum number of results to return per page. If no value is specified, the default is 10.
|
|
4887
|
+
* <p>The maximum number of results to return per page. If no value is specified, the default is 10.
|
|
4888
|
+
* </p>
|
|
4569
4889
|
*/
|
|
4570
4890
|
MaxResults?: number;
|
|
4571
4891
|
}
|
|
@@ -5677,6 +5997,98 @@ export declare namespace ResumeContactRecordingResponse {
|
|
|
5677
5997
|
*/
|
|
5678
5998
|
const filterSensitiveLog: (obj: ResumeContactRecordingResponse) => any;
|
|
5679
5999
|
}
|
|
6000
|
+
export interface SearchVocabulariesRequest {
|
|
6001
|
+
/**
|
|
6002
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
6003
|
+
*/
|
|
6004
|
+
InstanceId: string | undefined;
|
|
6005
|
+
/**
|
|
6006
|
+
* <p>The maximum number of results to return per page.</p>
|
|
6007
|
+
*/
|
|
6008
|
+
MaxResults?: number;
|
|
6009
|
+
/**
|
|
6010
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
6011
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
6012
|
+
*/
|
|
6013
|
+
NextToken?: string;
|
|
6014
|
+
/**
|
|
6015
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
6016
|
+
*/
|
|
6017
|
+
State?: VocabularyState | string;
|
|
6018
|
+
/**
|
|
6019
|
+
* <p>The starting pattern of the name of the vocabulary.</p>
|
|
6020
|
+
*/
|
|
6021
|
+
NameStartsWith?: string;
|
|
6022
|
+
/**
|
|
6023
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
6024
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
6025
|
+
* </p>
|
|
6026
|
+
*/
|
|
6027
|
+
LanguageCode?: VocabularyLanguageCode | string;
|
|
6028
|
+
}
|
|
6029
|
+
export declare namespace SearchVocabulariesRequest {
|
|
6030
|
+
/**
|
|
6031
|
+
* @internal
|
|
6032
|
+
*/
|
|
6033
|
+
const filterSensitiveLog: (obj: SearchVocabulariesRequest) => any;
|
|
6034
|
+
}
|
|
6035
|
+
/**
|
|
6036
|
+
* <p>Contains summary information about the custom vocabulary.</p>
|
|
6037
|
+
*/
|
|
6038
|
+
export interface VocabularySummary {
|
|
6039
|
+
/**
|
|
6040
|
+
* <p>A unique name of the custom vocabulary.</p>
|
|
6041
|
+
*/
|
|
6042
|
+
Name: string | undefined;
|
|
6043
|
+
/**
|
|
6044
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
6045
|
+
*/
|
|
6046
|
+
Id: string | undefined;
|
|
6047
|
+
/**
|
|
6048
|
+
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
6049
|
+
*/
|
|
6050
|
+
Arn: string | undefined;
|
|
6051
|
+
/**
|
|
6052
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
6053
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
6054
|
+
* </p>
|
|
6055
|
+
*/
|
|
6056
|
+
LanguageCode: VocabularyLanguageCode | string | undefined;
|
|
6057
|
+
/**
|
|
6058
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
6059
|
+
*/
|
|
6060
|
+
State: VocabularyState | string | undefined;
|
|
6061
|
+
/**
|
|
6062
|
+
* <p>The timestamp when the custom vocabulary was last modified.</p>
|
|
6063
|
+
*/
|
|
6064
|
+
LastModifiedTime: Date | undefined;
|
|
6065
|
+
/**
|
|
6066
|
+
* <p>The reason why the custom vocabulary was not created.</p>
|
|
6067
|
+
*/
|
|
6068
|
+
FailureReason?: string;
|
|
6069
|
+
}
|
|
6070
|
+
export declare namespace VocabularySummary {
|
|
6071
|
+
/**
|
|
6072
|
+
* @internal
|
|
6073
|
+
*/
|
|
6074
|
+
const filterSensitiveLog: (obj: VocabularySummary) => any;
|
|
6075
|
+
}
|
|
6076
|
+
export interface SearchVocabulariesResponse {
|
|
6077
|
+
/**
|
|
6078
|
+
* <p>The list of the available custom vocabularies.</p>
|
|
6079
|
+
*/
|
|
6080
|
+
VocabularySummaryList?: VocabularySummary[];
|
|
6081
|
+
/**
|
|
6082
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
6083
|
+
*/
|
|
6084
|
+
NextToken?: string;
|
|
6085
|
+
}
|
|
6086
|
+
export declare namespace SearchVocabulariesResponse {
|
|
6087
|
+
/**
|
|
6088
|
+
* @internal
|
|
6089
|
+
*/
|
|
6090
|
+
const filterSensitiveLog: (obj: SearchVocabulariesResponse) => any;
|
|
6091
|
+
}
|
|
5680
6092
|
/**
|
|
5681
6093
|
* <p>A chat message.</p>
|
|
5682
6094
|
*/
|
|
@@ -5748,6 +6160,11 @@ export interface StartChatContactRequest {
|
|
|
5748
6160
|
* request.</p>
|
|
5749
6161
|
*/
|
|
5750
6162
|
ClientToken?: string;
|
|
6163
|
+
/**
|
|
6164
|
+
* <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour.
|
|
6165
|
+
* The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
|
|
6166
|
+
*/
|
|
6167
|
+
ChatDurationInMinutes?: number;
|
|
5751
6168
|
}
|
|
5752
6169
|
export declare namespace StartChatContactRequest {
|
|
5753
6170
|
/**
|
|
@@ -5895,334 +6312,3 @@ export interface DestinationNotAllowedException extends __SmithyException, $Meta
|
|
|
5895
6312
|
*/
|
|
5896
6313
|
Message?: string;
|
|
5897
6314
|
}
|
|
5898
|
-
/**
|
|
5899
|
-
* <p>The contact is not permitted.</p>
|
|
5900
|
-
*/
|
|
5901
|
-
export interface OutboundContactNotPermittedException extends __SmithyException, $MetadataBearer {
|
|
5902
|
-
name: "OutboundContactNotPermittedException";
|
|
5903
|
-
$fault: "client";
|
|
5904
|
-
/**
|
|
5905
|
-
* <p>The message about the contact.</p>
|
|
5906
|
-
*/
|
|
5907
|
-
Message?: string;
|
|
5908
|
-
}
|
|
5909
|
-
/**
|
|
5910
|
-
* <p>Configuration of the answering machine detection.</p>
|
|
5911
|
-
*/
|
|
5912
|
-
export interface AnswerMachineDetectionConfig {
|
|
5913
|
-
/**
|
|
5914
|
-
* <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
|
|
5915
|
-
* call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
|
|
5916
|
-
* </p>
|
|
5917
|
-
*/
|
|
5918
|
-
EnableAnswerMachineDetection?: boolean;
|
|
5919
|
-
/**
|
|
5920
|
-
* <p>Wait for the answering machine prompt.</p>
|
|
5921
|
-
*/
|
|
5922
|
-
AwaitAnswerMachinePrompt?: boolean;
|
|
5923
|
-
}
|
|
5924
|
-
export declare namespace AnswerMachineDetectionConfig {
|
|
5925
|
-
/**
|
|
5926
|
-
* @internal
|
|
5927
|
-
*/
|
|
5928
|
-
const filterSensitiveLog: (obj: AnswerMachineDetectionConfig) => any;
|
|
5929
|
-
}
|
|
5930
|
-
export declare enum TrafficType {
|
|
5931
|
-
CAMPAIGN = "CAMPAIGN",
|
|
5932
|
-
GENERAL = "GENERAL"
|
|
5933
|
-
}
|
|
5934
|
-
export interface StartOutboundVoiceContactRequest {
|
|
5935
|
-
/**
|
|
5936
|
-
* <p>The phone number of the customer, in E.164 format.</p>
|
|
5937
|
-
*/
|
|
5938
|
-
DestinationPhoneNumber: string | undefined;
|
|
5939
|
-
/**
|
|
5940
|
-
* <p>The
|
|
5941
|
-
* identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect
|
|
5942
|
-
* console user interface, on the navigation menu go to <b>Routing</b>,
|
|
5943
|
-
* <b>Contact Flows</b>. Choose the contact flow. On the contact flow
|
|
5944
|
-
* page, under the name of the contact flow, choose <b>Show additional flow
|
|
5945
|
-
* information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
|
|
5946
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
5947
|
-
* </p>
|
|
5948
|
-
*/
|
|
5949
|
-
ContactFlowId: string | undefined;
|
|
5950
|
-
/**
|
|
5951
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
5952
|
-
*/
|
|
5953
|
-
InstanceId: string | undefined;
|
|
5954
|
-
/**
|
|
5955
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
5956
|
-
* request. The token is valid for 7 days after creation. If a contact is already started, the
|
|
5957
|
-
* contact ID is returned.
|
|
5958
|
-
* </p>
|
|
5959
|
-
*/
|
|
5960
|
-
ClientToken?: string;
|
|
5961
|
-
/**
|
|
5962
|
-
* <p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify
|
|
5963
|
-
* a source phone number, you must specify a queue.</p>
|
|
5964
|
-
*/
|
|
5965
|
-
SourcePhoneNumber?: string;
|
|
5966
|
-
/**
|
|
5967
|
-
* <p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the
|
|
5968
|
-
* phone number specified in the queue. If you do not specify a queue, the queue defined in the
|
|
5969
|
-
* contact flow is used. If you do not specify a queue, you must specify a source phone
|
|
5970
|
-
* number.</p>
|
|
5971
|
-
*/
|
|
5972
|
-
QueueId?: string;
|
|
5973
|
-
/**
|
|
5974
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect
|
|
5975
|
-
* attributes, and can be accessed in contact flows just like any other contact attributes.</p>
|
|
5976
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
5977
|
-
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
5978
|
-
*/
|
|
5979
|
-
Attributes?: {
|
|
5980
|
-
[key: string]: string;
|
|
5981
|
-
};
|
|
5982
|
-
/**
|
|
5983
|
-
* <p>Configuration of the answering machine detection for this outbound call. </p>
|
|
5984
|
-
*/
|
|
5985
|
-
AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
|
5986
|
-
/**
|
|
5987
|
-
* <p>The campaign identifier of the outbound communication.</p>
|
|
5988
|
-
*/
|
|
5989
|
-
CampaignId?: string;
|
|
5990
|
-
/**
|
|
5991
|
-
* <p>Denotes the class of traffic. Calls with different traffic types are handled differently by
|
|
5992
|
-
* Amazon Connect. The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if
|
|
5993
|
-
* <code>EnableAnswerMachineDetection</code> is set to <code>true</code>. For all other cases, use
|
|
5994
|
-
* <code>GENERAL</code>. </p>
|
|
5995
|
-
*/
|
|
5996
|
-
TrafficType?: TrafficType | string;
|
|
5997
|
-
}
|
|
5998
|
-
export declare namespace StartOutboundVoiceContactRequest {
|
|
5999
|
-
/**
|
|
6000
|
-
* @internal
|
|
6001
|
-
*/
|
|
6002
|
-
const filterSensitiveLog: (obj: StartOutboundVoiceContactRequest) => any;
|
|
6003
|
-
}
|
|
6004
|
-
export interface StartOutboundVoiceContactResponse {
|
|
6005
|
-
/**
|
|
6006
|
-
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
6007
|
-
*/
|
|
6008
|
-
ContactId?: string;
|
|
6009
|
-
}
|
|
6010
|
-
export declare namespace StartOutboundVoiceContactResponse {
|
|
6011
|
-
/**
|
|
6012
|
-
* @internal
|
|
6013
|
-
*/
|
|
6014
|
-
const filterSensitiveLog: (obj: StartOutboundVoiceContactResponse) => any;
|
|
6015
|
-
}
|
|
6016
|
-
/**
|
|
6017
|
-
* <p>A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes
|
|
6018
|
-
* across all references for a contact.</p>
|
|
6019
|
-
*/
|
|
6020
|
-
export interface Reference {
|
|
6021
|
-
/**
|
|
6022
|
-
* <p>A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).</p>
|
|
6023
|
-
*/
|
|
6024
|
-
Value: string | undefined;
|
|
6025
|
-
/**
|
|
6026
|
-
* <p>The type of the reference. Only <code>URL</code> type can be added or updated on a contact.</p>
|
|
6027
|
-
*/
|
|
6028
|
-
Type: ReferenceType | string | undefined;
|
|
6029
|
-
}
|
|
6030
|
-
export declare namespace Reference {
|
|
6031
|
-
/**
|
|
6032
|
-
* @internal
|
|
6033
|
-
*/
|
|
6034
|
-
const filterSensitiveLog: (obj: Reference) => any;
|
|
6035
|
-
}
|
|
6036
|
-
export interface StartTaskContactRequest {
|
|
6037
|
-
/**
|
|
6038
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
6039
|
-
*/
|
|
6040
|
-
InstanceId: string | undefined;
|
|
6041
|
-
/**
|
|
6042
|
-
* <p>The identifier of the previous chat, voice, or task contact. </p>
|
|
6043
|
-
*/
|
|
6044
|
-
PreviousContactId?: string;
|
|
6045
|
-
/**
|
|
6046
|
-
* <p>The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the
|
|
6047
|
-
* Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On
|
|
6048
|
-
* the contact flow page, under the name of the contact flow, choose <b>Show
|
|
6049
|
-
* additional flow information</b>. The ContactFlowId is the last part of the ARN, shown
|
|
6050
|
-
* here in bold: </p>
|
|
6051
|
-
* <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
|
|
6052
|
-
* </p>
|
|
6053
|
-
*/
|
|
6054
|
-
ContactFlowId: string | undefined;
|
|
6055
|
-
/**
|
|
6056
|
-
* <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect
|
|
6057
|
-
* attributes, and can be accessed in contact flows just like any other contact attributes.</p>
|
|
6058
|
-
* <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
|
|
6059
|
-
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
6060
|
-
*/
|
|
6061
|
-
Attributes?: {
|
|
6062
|
-
[key: string]: string;
|
|
6063
|
-
};
|
|
6064
|
-
/**
|
|
6065
|
-
* <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
6066
|
-
*/
|
|
6067
|
-
Name: string | undefined;
|
|
6068
|
-
/**
|
|
6069
|
-
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP).</p>
|
|
6070
|
-
*/
|
|
6071
|
-
References?: {
|
|
6072
|
-
[key: string]: Reference;
|
|
6073
|
-
};
|
|
6074
|
-
/**
|
|
6075
|
-
* <p>A description of the task that is shown to an agent in the Contact Control Panel
|
|
6076
|
-
* (CCP).</p>
|
|
6077
|
-
*/
|
|
6078
|
-
Description?: string;
|
|
6079
|
-
/**
|
|
6080
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6081
|
-
* request.</p>
|
|
6082
|
-
*/
|
|
6083
|
-
ClientToken?: string;
|
|
6084
|
-
/**
|
|
6085
|
-
* <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
|
|
6086
|
-
*/
|
|
6087
|
-
ScheduledTime?: Date;
|
|
6088
|
-
}
|
|
6089
|
-
export declare namespace StartTaskContactRequest {
|
|
6090
|
-
/**
|
|
6091
|
-
* @internal
|
|
6092
|
-
*/
|
|
6093
|
-
const filterSensitiveLog: (obj: StartTaskContactRequest) => any;
|
|
6094
|
-
}
|
|
6095
|
-
export interface StartTaskContactResponse {
|
|
6096
|
-
/**
|
|
6097
|
-
* <p>The identifier of this contact within the Amazon Connect instance.</p>
|
|
6098
|
-
*/
|
|
6099
|
-
ContactId?: string;
|
|
6100
|
-
}
|
|
6101
|
-
export declare namespace StartTaskContactResponse {
|
|
6102
|
-
/**
|
|
6103
|
-
* @internal
|
|
6104
|
-
*/
|
|
6105
|
-
const filterSensitiveLog: (obj: StartTaskContactResponse) => any;
|
|
6106
|
-
}
|
|
6107
|
-
/**
|
|
6108
|
-
* <p>The contact with the specified ID is not active or does not exist.</p>
|
|
6109
|
-
*/
|
|
6110
|
-
export interface ContactNotFoundException extends __SmithyException, $MetadataBearer {
|
|
6111
|
-
name: "ContactNotFoundException";
|
|
6112
|
-
$fault: "client";
|
|
6113
|
-
/**
|
|
6114
|
-
* <p>The message.</p>
|
|
6115
|
-
*/
|
|
6116
|
-
Message?: string;
|
|
6117
|
-
}
|
|
6118
|
-
export interface StopContactRequest {
|
|
6119
|
-
/**
|
|
6120
|
-
* <p>The ID of the contact.</p>
|
|
6121
|
-
*/
|
|
6122
|
-
ContactId: string | undefined;
|
|
6123
|
-
/**
|
|
6124
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
6125
|
-
*/
|
|
6126
|
-
InstanceId: string | undefined;
|
|
6127
|
-
}
|
|
6128
|
-
export declare namespace StopContactRequest {
|
|
6129
|
-
/**
|
|
6130
|
-
* @internal
|
|
6131
|
-
*/
|
|
6132
|
-
const filterSensitiveLog: (obj: StopContactRequest) => any;
|
|
6133
|
-
}
|
|
6134
|
-
export interface StopContactResponse {
|
|
6135
|
-
}
|
|
6136
|
-
export declare namespace StopContactResponse {
|
|
6137
|
-
/**
|
|
6138
|
-
* @internal
|
|
6139
|
-
*/
|
|
6140
|
-
const filterSensitiveLog: (obj: StopContactResponse) => any;
|
|
6141
|
-
}
|
|
6142
|
-
export interface StopContactRecordingRequest {
|
|
6143
|
-
/**
|
|
6144
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
6145
|
-
*/
|
|
6146
|
-
InstanceId: string | undefined;
|
|
6147
|
-
/**
|
|
6148
|
-
* <p>The identifier of the contact.</p>
|
|
6149
|
-
*/
|
|
6150
|
-
ContactId: string | undefined;
|
|
6151
|
-
/**
|
|
6152
|
-
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
6153
|
-
* first interaction with the contact center.</p>
|
|
6154
|
-
*/
|
|
6155
|
-
InitialContactId: string | undefined;
|
|
6156
|
-
}
|
|
6157
|
-
export declare namespace StopContactRecordingRequest {
|
|
6158
|
-
/**
|
|
6159
|
-
* @internal
|
|
6160
|
-
*/
|
|
6161
|
-
const filterSensitiveLog: (obj: StopContactRecordingRequest) => any;
|
|
6162
|
-
}
|
|
6163
|
-
export interface StopContactRecordingResponse {
|
|
6164
|
-
}
|
|
6165
|
-
export declare namespace StopContactRecordingResponse {
|
|
6166
|
-
/**
|
|
6167
|
-
* @internal
|
|
6168
|
-
*/
|
|
6169
|
-
const filterSensitiveLog: (obj: StopContactRecordingResponse) => any;
|
|
6170
|
-
}
|
|
6171
|
-
export interface StopContactStreamingRequest {
|
|
6172
|
-
/**
|
|
6173
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
6174
|
-
*/
|
|
6175
|
-
InstanceId: string | undefined;
|
|
6176
|
-
/**
|
|
6177
|
-
* <p>The identifier of the contact. This is the identifier of the contact that is associated with
|
|
6178
|
-
* the first interaction with the contact center.</p>
|
|
6179
|
-
*/
|
|
6180
|
-
ContactId: string | undefined;
|
|
6181
|
-
/**
|
|
6182
|
-
* <p>The identifier of the streaming configuration enabled. </p>
|
|
6183
|
-
*/
|
|
6184
|
-
StreamingId: string | undefined;
|
|
6185
|
-
}
|
|
6186
|
-
export declare namespace StopContactStreamingRequest {
|
|
6187
|
-
/**
|
|
6188
|
-
* @internal
|
|
6189
|
-
*/
|
|
6190
|
-
const filterSensitiveLog: (obj: StopContactStreamingRequest) => any;
|
|
6191
|
-
}
|
|
6192
|
-
export interface StopContactStreamingResponse {
|
|
6193
|
-
}
|
|
6194
|
-
export declare namespace StopContactStreamingResponse {
|
|
6195
|
-
/**
|
|
6196
|
-
* @internal
|
|
6197
|
-
*/
|
|
6198
|
-
const filterSensitiveLog: (obj: StopContactStreamingResponse) => any;
|
|
6199
|
-
}
|
|
6200
|
-
export interface SuspendContactRecordingRequest {
|
|
6201
|
-
/**
|
|
6202
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
6203
|
-
*/
|
|
6204
|
-
InstanceId: string | undefined;
|
|
6205
|
-
/**
|
|
6206
|
-
* <p>The identifier of the contact.</p>
|
|
6207
|
-
*/
|
|
6208
|
-
ContactId: string | undefined;
|
|
6209
|
-
/**
|
|
6210
|
-
* <p>The identifier of the contact. This is the identifier of the contact associated with the
|
|
6211
|
-
* first interaction with the contact center.</p>
|
|
6212
|
-
*/
|
|
6213
|
-
InitialContactId: string | undefined;
|
|
6214
|
-
}
|
|
6215
|
-
export declare namespace SuspendContactRecordingRequest {
|
|
6216
|
-
/**
|
|
6217
|
-
* @internal
|
|
6218
|
-
*/
|
|
6219
|
-
const filterSensitiveLog: (obj: SuspendContactRecordingRequest) => any;
|
|
6220
|
-
}
|
|
6221
|
-
export interface SuspendContactRecordingResponse {
|
|
6222
|
-
}
|
|
6223
|
-
export declare namespace SuspendContactRecordingResponse {
|
|
6224
|
-
/**
|
|
6225
|
-
* @internal
|
|
6226
|
-
*/
|
|
6227
|
-
const filterSensitiveLog: (obj: SuspendContactRecordingResponse) => any;
|
|
6228
|
-
}
|