@aws-sdk/client-connect 3.947.0 → 3.951.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/dist-cjs/index.js +7 -1
- package/dist-es/models/enums.js +3 -0
- package/dist-es/schemas/schemas_0.js +4 -1
- package/dist-types/commands/AssociateWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/BatchCreateDataTableValueCommand.d.ts +6 -1
- package/dist-types/commands/BatchDeleteDataTableValueCommand.d.ts +3 -1
- package/dist-types/commands/BatchDescribeDataTableValueCommand.d.ts +3 -1
- package/dist-types/commands/BatchUpdateDataTableValueCommand.d.ts +3 -1
- package/dist-types/commands/CreateDataTableAttributeCommand.d.ts +4 -1
- package/dist-types/commands/CreateDataTableCommand.d.ts +3 -1
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDataTableCommand.d.ts +5 -1
- package/dist-types/commands/DeleteWorkspacePageCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDataTableAttributeCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDataTableCommand.d.ts +3 -1
- package/dist-types/commands/EvaluateDataTableValuesCommand.d.ts +5 -1
- package/dist-types/commands/ListDataTableAttributesCommand.d.ts +3 -1
- package/dist-types/commands/ListDataTablePrimaryValuesCommand.d.ts +2 -1
- package/dist-types/commands/ListDataTableValuesCommand.d.ts +2 -1
- package/dist-types/commands/ListDataTablesCommand.d.ts +2 -1
- package/dist-types/commands/SearchDataTablesCommand.d.ts +3 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +3 -0
- package/dist-types/commands/UpdateDataTableAttributeCommand.d.ts +4 -1
- package/dist-types/commands/UpdateDataTableMetadataCommand.d.ts +3 -1
- package/dist-types/commands/UpdateDataTablePrimaryValuesCommand.d.ts +3 -1
- package/dist-types/commands/UpdateWorkspaceVisibilityCommand.d.ts +2 -1
- package/dist-types/models/enums.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +108 -49
- package/dist-types/models/models_1.d.ts +50 -23
- package/dist-types/models/models_2.d.ts +55 -44
- package/dist-types/models/models_3.d.ts +62 -27
- package/dist-types/schemas/schemas_0.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +5 -0
- package/dist-types/ts3.4/models/models_3.d.ts +4 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +1 -0
- package/package.json +3 -3
|
@@ -613,7 +613,7 @@ export interface CommonAttributeAndCondition {
|
|
|
613
613
|
}
|
|
614
614
|
/**
|
|
615
615
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
|
|
616
|
-
* <code>OR</code> or <code>AND</code> (List of List) input where
|
|
616
|
+
* <code>OR</code> or <code>AND</code> (List of List) input where:</p>
|
|
617
617
|
* <ul>
|
|
618
618
|
* <li>
|
|
619
619
|
* <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p>
|
|
@@ -1567,7 +1567,8 @@ export interface AssociateUserProficienciesRequest {
|
|
|
1567
1567
|
*/
|
|
1568
1568
|
export interface AssociateWorkspaceRequest {
|
|
1569
1569
|
/**
|
|
1570
|
-
* <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
|
|
1570
|
+
* <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
|
|
1571
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
1571
1572
|
* @public
|
|
1572
1573
|
*/
|
|
1573
1574
|
InstanceId: string | undefined;
|
|
@@ -1577,7 +1578,8 @@ export interface AssociateWorkspaceRequest {
|
|
|
1577
1578
|
*/
|
|
1578
1579
|
WorkspaceId: string | undefined;
|
|
1579
1580
|
/**
|
|
1580
|
-
* <p>The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are
|
|
1581
|
+
* <p>The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are
|
|
1582
|
+
* users and routing profiles.</p>
|
|
1581
1583
|
* @public
|
|
1582
1584
|
*/
|
|
1583
1585
|
ResourceArns: string[] | undefined;
|
|
@@ -1604,7 +1606,8 @@ export interface FailedBatchAssociationSummary {
|
|
|
1604
1606
|
ErrorMessage?: string | undefined;
|
|
1605
1607
|
}
|
|
1606
1608
|
/**
|
|
1607
|
-
* <p>Contains information about a resource that was successfully associated with a workspace in a batch
|
|
1609
|
+
* <p>Contains information about a resource that was successfully associated with a workspace in a batch
|
|
1610
|
+
* operation.</p>
|
|
1608
1611
|
* @public
|
|
1609
1612
|
*/
|
|
1610
1613
|
export interface SuccessfulBatchAssociationSummary {
|
|
@@ -1719,33 +1722,41 @@ export interface BatchAssociateAnalyticsDataSetResponse {
|
|
|
1719
1722
|
Errors?: ErrorResult[] | undefined;
|
|
1720
1723
|
}
|
|
1721
1724
|
/**
|
|
1722
|
-
* <p>Contains lock version information for different levels of a data table hierarchy. Used for optimistic locking to
|
|
1725
|
+
* <p>Contains lock version information for different levels of a data table hierarchy. Used for optimistic locking to
|
|
1726
|
+
* prevent concurrent modification conflicts. Each component has its own lock version that changes when that component
|
|
1727
|
+
* is modified.</p>
|
|
1723
1728
|
* @public
|
|
1724
1729
|
*/
|
|
1725
1730
|
export interface DataTableLockVersion {
|
|
1726
1731
|
/**
|
|
1727
|
-
* <p>The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each
|
|
1732
|
+
* <p>The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each
|
|
1733
|
+
* update to the table's metadata or structure.</p>
|
|
1728
1734
|
* @public
|
|
1729
1735
|
*/
|
|
1730
1736
|
DataTable?: string | undefined;
|
|
1731
1737
|
/**
|
|
1732
|
-
* <p>The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any
|
|
1738
|
+
* <p>The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any
|
|
1739
|
+
* value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly
|
|
1740
|
+
* updated.</p>
|
|
1733
1741
|
* @public
|
|
1734
1742
|
*/
|
|
1735
1743
|
Attribute?: string | undefined;
|
|
1736
1744
|
/**
|
|
1737
|
-
* <p>The lock version for a specific set of primary values (record). This includes the default record even if the
|
|
1745
|
+
* <p>The lock version for a specific set of primary values (record). This includes the default record even if the
|
|
1746
|
+
* table does not have any primary attributes. Used for record-level locking.</p>
|
|
1738
1747
|
* @public
|
|
1739
1748
|
*/
|
|
1740
1749
|
PrimaryValues?: string | undefined;
|
|
1741
1750
|
/**
|
|
1742
|
-
* <p>The lock version for a specific value. Changes each time the individual value is modified. Used for the
|
|
1751
|
+
* <p>The lock version for a specific value. Changes each time the individual value is modified. Used for the
|
|
1752
|
+
* finest-grained locking control.</p>
|
|
1743
1753
|
* @public
|
|
1744
1754
|
*/
|
|
1745
1755
|
Value?: string | undefined;
|
|
1746
1756
|
}
|
|
1747
1757
|
/**
|
|
1748
|
-
* <p>Represents a primary key value used to identify a specific record in a data table. Primary values are used in
|
|
1758
|
+
* <p>Represents a primary key value used to identify a specific record in a data table. Primary values are used in
|
|
1759
|
+
* combination to create unique record identifiers when a table has multiple primary attributes.</p>
|
|
1749
1760
|
* @public
|
|
1750
1761
|
*/
|
|
1751
1762
|
export interface PrimaryValue {
|
|
@@ -1755,7 +1766,8 @@ export interface PrimaryValue {
|
|
|
1755
1766
|
*/
|
|
1756
1767
|
AttributeName: string | undefined;
|
|
1757
1768
|
/**
|
|
1758
|
-
* <p>The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value
|
|
1769
|
+
* <p>The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value
|
|
1770
|
+
* type. Primary values cannot be expressions and must be explicitly specified.</p>
|
|
1759
1771
|
* @public
|
|
1760
1772
|
*/
|
|
1761
1773
|
Value: string | undefined;
|
|
@@ -1806,12 +1818,14 @@ export interface BatchCreateDataTableValueRequest {
|
|
|
1806
1818
|
*/
|
|
1807
1819
|
InstanceId: string | undefined;
|
|
1808
1820
|
/**
|
|
1809
|
-
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no
|
|
1821
|
+
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no
|
|
1822
|
+
* alias is provided, the default behavior is identical to providing the $LATEST alias.</p>
|
|
1810
1823
|
* @public
|
|
1811
1824
|
*/
|
|
1812
1825
|
DataTableId: string | undefined;
|
|
1813
1826
|
/**
|
|
1814
|
-
* <p>A list of values to create. Each value must specify the attribute name and optionally primary values if the
|
|
1827
|
+
* <p>A list of values to create. Each value must specify the attribute name and optionally primary values if the
|
|
1828
|
+
* table has primary attributes.</p>
|
|
1815
1829
|
* @public
|
|
1816
1830
|
*/
|
|
1817
1831
|
Values: DataTableValue[] | undefined;
|
|
@@ -1914,7 +1928,8 @@ export interface BatchDeleteDataTableValueRequest {
|
|
|
1914
1928
|
*/
|
|
1915
1929
|
DataTableId: string | undefined;
|
|
1916
1930
|
/**
|
|
1917
|
-
* <p>A list of value identifiers to delete, each specifying primary values, attribute name, and lock version
|
|
1931
|
+
* <p>A list of value identifiers to delete, each specifying primary values, attribute name, and lock version
|
|
1932
|
+
* information.</p>
|
|
1918
1933
|
* @public
|
|
1919
1934
|
*/
|
|
1920
1935
|
Values: DataTableDeleteValueIdentifier[] | undefined;
|
|
@@ -3129,32 +3144,40 @@ export interface CreateDataTableRequest {
|
|
|
3129
3144
|
*/
|
|
3130
3145
|
InstanceId: string | undefined;
|
|
3131
3146
|
/**
|
|
3132
|
-
* <p>The name for the data table. Must conform to Connect human readable string specification and have 1-127
|
|
3147
|
+
* <p>The name for the data table. Must conform to Connect human readable string specification and have 1-127
|
|
3148
|
+
* characters. Whitespace must be trimmed first. Must not start with the reserved case insensitive values 'connect:' and
|
|
3149
|
+
* 'aws:'. Must be unique for the instance using case-insensitive comparison.</p>
|
|
3133
3150
|
* @public
|
|
3134
3151
|
*/
|
|
3135
3152
|
Name: string | undefined;
|
|
3136
3153
|
/**
|
|
3137
|
-
* <p>An optional description for the data table. Must conform to Connect human readable string specification and have
|
|
3154
|
+
* <p>An optional description for the data table. Must conform to Connect human readable string specification and have
|
|
3155
|
+
* 0-250 characters. Whitespace must be trimmed first.</p>
|
|
3138
3156
|
* @public
|
|
3139
3157
|
*/
|
|
3140
3158
|
Description?: string | undefined;
|
|
3141
3159
|
/**
|
|
3142
|
-
* <p>The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time slices
|
|
3160
|
+
* <p>The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time slices
|
|
3161
|
+
* are specified.</p>
|
|
3143
3162
|
* @public
|
|
3144
3163
|
*/
|
|
3145
3164
|
TimeZone: string | undefined;
|
|
3146
3165
|
/**
|
|
3147
|
-
* <p>The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE,
|
|
3166
|
+
* <p>The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE,
|
|
3167
|
+
* and NONE. NONE is the default if unspecified. This determines how concurrent edits are handled when multiple users
|
|
3168
|
+
* attempt to modify values simultaneously.</p>
|
|
3148
3169
|
* @public
|
|
3149
3170
|
*/
|
|
3150
3171
|
ValueLockLevel: DataTableLockLevel | undefined;
|
|
3151
3172
|
/**
|
|
3152
|
-
* <p>The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial state of
|
|
3173
|
+
* <p>The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial state of
|
|
3174
|
+
* the table.</p>
|
|
3153
3175
|
* @public
|
|
3154
3176
|
*/
|
|
3155
3177
|
Status: DataTableStatus | undefined;
|
|
3156
3178
|
/**
|
|
3157
|
-
* <p>Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data table for
|
|
3179
|
+
* <p>Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data table for
|
|
3180
|
+
* organization and access control purposes.</p>
|
|
3158
3181
|
* @public
|
|
3159
3182
|
*/
|
|
3160
3183
|
Tags?: Record<string, string> | undefined;
|
|
@@ -3174,84 +3197,104 @@ export interface CreateDataTableResponse {
|
|
|
3174
3197
|
*/
|
|
3175
3198
|
Arn: string | undefined;
|
|
3176
3199
|
/**
|
|
3177
|
-
* <p>The lock version information for the created data table, used for optimistic locking and table
|
|
3200
|
+
* <p>The lock version information for the created data table, used for optimistic locking and table
|
|
3201
|
+
* versioning.</p>
|
|
3178
3202
|
* @public
|
|
3179
3203
|
*/
|
|
3180
3204
|
LockVersion: DataTableLockVersion | undefined;
|
|
3181
3205
|
}
|
|
3182
3206
|
/**
|
|
3183
|
-
* <p>Defines enumeration validation for attribute values. Allows specifying a list of permitted values and whether
|
|
3207
|
+
* <p>Defines enumeration validation for attribute values. Allows specifying a list of permitted values and whether
|
|
3208
|
+
* custom values beyond the enumerated list are allowed.</p>
|
|
3184
3209
|
* @public
|
|
3185
3210
|
*/
|
|
3186
3211
|
export interface ValidationEnum {
|
|
3187
3212
|
/**
|
|
3188
|
-
* <p>Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false,
|
|
3213
|
+
* <p>Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false,
|
|
3214
|
+
* custom values beyond the enumerated list are permitted.</p>
|
|
3189
3215
|
* @public
|
|
3190
3216
|
*/
|
|
3191
3217
|
Strict?: boolean | undefined;
|
|
3192
3218
|
/**
|
|
3193
|
-
* <p>A list of predefined values that are allowed for this attribute. These values are always permitted regardless of
|
|
3219
|
+
* <p>A list of predefined values that are allowed for this attribute. These values are always permitted regardless of
|
|
3220
|
+
* the Strict setting.</p>
|
|
3194
3221
|
* @public
|
|
3195
3222
|
*/
|
|
3196
3223
|
Values?: string[] | undefined;
|
|
3197
3224
|
}
|
|
3198
3225
|
/**
|
|
3199
|
-
* <p>Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional
|
|
3226
|
+
* <p>Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional
|
|
3227
|
+
* Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.</p>
|
|
3200
3228
|
* @public
|
|
3201
3229
|
*/
|
|
3202
3230
|
export interface Validation {
|
|
3203
3231
|
/**
|
|
3204
|
-
* <p>The minimum number of characters a text value can contain. Applies to TEXT value type and values within a
|
|
3232
|
+
* <p>The minimum number of characters a text value can contain. Applies to TEXT value type and values within a
|
|
3233
|
+
* TEXT_LIST. Must be less than or equal to MaxLength.</p>
|
|
3205
3234
|
* @public
|
|
3206
3235
|
*/
|
|
3207
3236
|
MinLength?: number | undefined;
|
|
3208
3237
|
/**
|
|
3209
|
-
* <p>The maximum number of characters a text value can contain. Applies to TEXT value type and values within a
|
|
3238
|
+
* <p>The maximum number of characters a text value can contain. Applies to TEXT value type and values within a
|
|
3239
|
+
* TEXT_LIST. Must be greater than or equal to MinLength.</p>
|
|
3210
3240
|
* @public
|
|
3211
3241
|
*/
|
|
3212
3242
|
MaxLength?: number | undefined;
|
|
3213
3243
|
/**
|
|
3214
|
-
* <p>The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to
|
|
3244
|
+
* <p>The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to
|
|
3245
|
+
* MaxValues. Applies to all list types.</p>
|
|
3215
3246
|
* @public
|
|
3216
3247
|
*/
|
|
3217
3248
|
MinValues?: number | undefined;
|
|
3218
3249
|
/**
|
|
3219
|
-
* <p>The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal
|
|
3250
|
+
* <p>The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal
|
|
3251
|
+
* to MinValues. Applies to all list types.</p>
|
|
3220
3252
|
* @public
|
|
3221
3253
|
*/
|
|
3222
3254
|
MaxValues?: number | undefined;
|
|
3223
3255
|
/**
|
|
3224
|
-
* <p>Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces
|
|
3256
|
+
* <p>Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces
|
|
3257
|
+
* case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.</p>
|
|
3225
3258
|
* @public
|
|
3226
3259
|
*/
|
|
3227
3260
|
IgnoreCase?: boolean | undefined;
|
|
3228
3261
|
/**
|
|
3229
|
-
* <p>The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also
|
|
3262
|
+
* <p>The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also
|
|
3263
|
+
* provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within
|
|
3264
|
+
* NUMBER_LIST.</p>
|
|
3230
3265
|
* @public
|
|
3231
3266
|
*/
|
|
3232
3267
|
Minimum?: number | undefined;
|
|
3233
3268
|
/**
|
|
3234
|
-
* <p>The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both
|
|
3269
|
+
* <p>The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both
|
|
3270
|
+
* operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER
|
|
3271
|
+
* and values within NUMBER_LIST.</p>
|
|
3235
3272
|
* @public
|
|
3236
3273
|
*/
|
|
3237
3274
|
Maximum?: number | undefined;
|
|
3238
3275
|
/**
|
|
3239
|
-
* <p>The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate
|
|
3276
|
+
* <p>The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate
|
|
3277
|
+
* independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within
|
|
3278
|
+
* NUMBER_LIST.</p>
|
|
3240
3279
|
* @public
|
|
3241
3280
|
*/
|
|
3242
3281
|
ExclusiveMinimum?: number | undefined;
|
|
3243
3282
|
/**
|
|
3244
|
-
* <p>The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate
|
|
3283
|
+
* <p>The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate
|
|
3284
|
+
* independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within
|
|
3285
|
+
* NUMBER_LIST.</p>
|
|
3245
3286
|
* @public
|
|
3246
3287
|
*/
|
|
3247
3288
|
ExclusiveMaximum?: number | undefined;
|
|
3248
3289
|
/**
|
|
3249
|
-
* <p>Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a
|
|
3290
|
+
* <p>Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a
|
|
3291
|
+
* value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.</p>
|
|
3250
3292
|
* @public
|
|
3251
3293
|
*/
|
|
3252
3294
|
MultipleOf?: number | undefined;
|
|
3253
3295
|
/**
|
|
3254
|
-
* <p>Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom
|
|
3296
|
+
* <p>Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom
|
|
3297
|
+
* values are permitted beyond the enumerated list.</p>
|
|
3255
3298
|
* @public
|
|
3256
3299
|
*/
|
|
3257
3300
|
Enum?: ValidationEnum | undefined;
|
|
@@ -3266,32 +3309,41 @@ export interface CreateDataTableAttributeRequest {
|
|
|
3266
3309
|
*/
|
|
3267
3310
|
InstanceId: string | undefined;
|
|
3268
3311
|
/**
|
|
3269
|
-
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the
|
|
3312
|
+
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the
|
|
3313
|
+
* version is provided as part of the identifier or ARN, the version must be one of the two available system managed
|
|
3314
|
+
* aliases, $SAVED or $LATEST.</p>
|
|
3270
3315
|
* @public
|
|
3271
3316
|
*/
|
|
3272
3317
|
DataTableId: string | undefined;
|
|
3273
3318
|
/**
|
|
3274
|
-
* <p>The name for the attribute. Must conform to Connect human readable string specification and have 1-127
|
|
3319
|
+
* <p>The name for the attribute. Must conform to Connect human readable string specification and have 1-127
|
|
3320
|
+
* characters. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Whitespace trimmed before
|
|
3321
|
+
* persisting. Must be unique for the data table using case-insensitive comparison.</p>
|
|
3275
3322
|
* @public
|
|
3276
3323
|
*/
|
|
3277
3324
|
Name: string | undefined;
|
|
3278
3325
|
/**
|
|
3279
|
-
* <p>The type of value allowed or the resultant type after the value's expression is evaluated. Must be one of TEXT,
|
|
3326
|
+
* <p>The type of value allowed or the resultant type after the value's expression is evaluated. Must be one of TEXT,
|
|
3327
|
+
* TEXT_LIST, NUMBER, NUMBER_LIST, and BOOLEAN.</p>
|
|
3280
3328
|
* @public
|
|
3281
3329
|
*/
|
|
3282
3330
|
ValueType: DataTableAttributeValueType | undefined;
|
|
3283
3331
|
/**
|
|
3284
|
-
* <p>An optional description for the attribute. Must conform to Connect human readable string specification and have
|
|
3332
|
+
* <p>An optional description for the attribute. Must conform to Connect human readable string specification and have
|
|
3333
|
+
* 0-250 characters. Whitespace trimmed before persisting.</p>
|
|
3285
3334
|
* @public
|
|
3286
3335
|
*/
|
|
3287
3336
|
Description?: string | undefined;
|
|
3288
3337
|
/**
|
|
3289
|
-
* <p>Optional boolean that defaults to false. Determines if the value is used to identify a record in the table.
|
|
3338
|
+
* <p>Optional boolean that defaults to false. Determines if the value is used to identify a record in the table.
|
|
3339
|
+
* Values for primary attributes must not be expressions.</p>
|
|
3290
3340
|
* @public
|
|
3291
3341
|
*/
|
|
3292
3342
|
Primary?: boolean | undefined;
|
|
3293
3343
|
/**
|
|
3294
|
-
* <p>Optional validation rules for the attribute. Borrows heavily from JSON Schema - Draft 2020-12. The maximum
|
|
3344
|
+
* <p>Optional validation rules for the attribute. Borrows heavily from JSON Schema - Draft 2020-12. The maximum
|
|
3345
|
+
* length of arrays within validations and depth of validations is 5. There are default limits that apply to all types.
|
|
3346
|
+
* Customer specified limits in excess of the default limits are not permitted.</p>
|
|
3295
3347
|
* @public
|
|
3296
3348
|
*/
|
|
3297
3349
|
Validation?: Validation | undefined;
|
|
@@ -3301,7 +3353,8 @@ export interface CreateDataTableAttributeRequest {
|
|
|
3301
3353
|
*/
|
|
3302
3354
|
export interface CreateDataTableAttributeResponse {
|
|
3303
3355
|
/**
|
|
3304
|
-
* <p>The name of the created attribute since it also serves as the identifier. This could be different than the
|
|
3356
|
+
* <p>The name of the created attribute since it also serves as the identifier. This could be different than the
|
|
3357
|
+
* parameter passed in since it will be trimmed for whitespace.</p>
|
|
3305
3358
|
* @public
|
|
3306
3359
|
*/
|
|
3307
3360
|
Name: string | undefined;
|
|
@@ -3311,7 +3364,8 @@ export interface CreateDataTableAttributeResponse {
|
|
|
3311
3364
|
*/
|
|
3312
3365
|
AttributeId?: string | undefined;
|
|
3313
3366
|
/**
|
|
3314
|
-
* <p>The lock version information for the data table and attribute, used for optimistic locking and
|
|
3367
|
+
* <p>The lock version information for the data table and attribute, used for optimistic locking and
|
|
3368
|
+
* versioning.</p>
|
|
3315
3369
|
* @public
|
|
3316
3370
|
*/
|
|
3317
3371
|
LockVersion: DataTableLockVersion | undefined;
|
|
@@ -5512,7 +5566,8 @@ export interface DataTableAccessControlConfiguration {
|
|
|
5512
5566
|
PrimaryAttributeAccessControlConfiguration?: PrimaryAttributeAccessControlConfigurationItem | undefined;
|
|
5513
5567
|
}
|
|
5514
5568
|
/**
|
|
5515
|
-
* <p>Contains granular access control configuration for security profiles, including data table access
|
|
5569
|
+
* <p>Contains granular access control configuration for security profiles, including data table access
|
|
5570
|
+
* permissions.</p>
|
|
5516
5571
|
* @public
|
|
5517
5572
|
*/
|
|
5518
5573
|
export interface GranularAccessControlConfiguration {
|
|
@@ -6618,7 +6673,8 @@ export interface WorkspaceTheme {
|
|
|
6618
6673
|
*/
|
|
6619
6674
|
export interface CreateWorkspaceRequest {
|
|
6620
6675
|
/**
|
|
6621
|
-
* <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
|
|
6676
|
+
* <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
|
|
6677
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
6622
6678
|
* @public
|
|
6623
6679
|
*/
|
|
6624
6680
|
InstanceId: string | undefined;
|
|
@@ -6643,7 +6699,8 @@ export interface CreateWorkspaceRequest {
|
|
|
6643
6699
|
*/
|
|
6644
6700
|
Title?: string | undefined;
|
|
6645
6701
|
/**
|
|
6646
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags":
|
|
6702
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags":
|
|
6703
|
+
* \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
|
|
6647
6704
|
* @public
|
|
6648
6705
|
*/
|
|
6649
6706
|
Tags?: Record<string, string> | undefined;
|
|
@@ -6668,7 +6725,8 @@ export interface CreateWorkspaceResponse {
|
|
|
6668
6725
|
*/
|
|
6669
6726
|
export interface CreateWorkspacePageRequest {
|
|
6670
6727
|
/**
|
|
6671
|
-
* <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
|
|
6728
|
+
* <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
|
|
6729
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
6672
6730
|
* @public
|
|
6673
6731
|
*/
|
|
6674
6732
|
InstanceId: string | undefined;
|
|
@@ -6683,7 +6741,8 @@ export interface CreateWorkspacePageRequest {
|
|
|
6683
6741
|
*/
|
|
6684
6742
|
ResourceArn: string | undefined;
|
|
6685
6743
|
/**
|
|
6686
|
-
* <p>The page identifier. Valid system pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>. Custom
|
|
6744
|
+
* <p>The page identifier. Valid system pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>. Custom
|
|
6745
|
+
* pages cannot use the <code>aws:</code> or <code>connect:</code> prefixes.</p>
|
|
6687
6746
|
* @public
|
|
6688
6747
|
*/
|
|
6689
6748
|
Page: string | undefined;
|
|
@@ -85,7 +85,8 @@ export interface DeleteDataTableRequest {
|
|
|
85
85
|
*/
|
|
86
86
|
InstanceId: string | undefined;
|
|
87
87
|
/**
|
|
88
|
-
* <p>The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error if the
|
|
88
|
+
* <p>The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error if the
|
|
89
|
+
* version is provided and is not $LATEST.</p>
|
|
89
90
|
* @public
|
|
90
91
|
*/
|
|
91
92
|
DataTableId: string | undefined;
|
|
@@ -538,7 +539,8 @@ export interface DeleteVocabularyResponse {
|
|
|
538
539
|
*/
|
|
539
540
|
export interface DeleteWorkspaceRequest {
|
|
540
541
|
/**
|
|
541
|
-
* <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
|
|
542
|
+
* <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
|
|
543
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
542
544
|
* @public
|
|
543
545
|
*/
|
|
544
546
|
InstanceId: string | undefined;
|
|
@@ -558,7 +560,8 @@ export interface DeleteWorkspaceResponse {
|
|
|
558
560
|
*/
|
|
559
561
|
export interface DeleteWorkspaceMediaRequest {
|
|
560
562
|
/**
|
|
561
|
-
* <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
|
|
563
|
+
* <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
|
|
564
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
562
565
|
* @public
|
|
563
566
|
*/
|
|
564
567
|
InstanceId: string | undefined;
|
|
@@ -568,7 +571,8 @@ export interface DeleteWorkspaceMediaRequest {
|
|
|
568
571
|
*/
|
|
569
572
|
WorkspaceId: string | undefined;
|
|
570
573
|
/**
|
|
571
|
-
* <p>The type of media to delete. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
574
|
+
* <p>The type of media to delete. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
575
|
+
* <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
|
|
572
576
|
* @public
|
|
573
577
|
*/
|
|
574
578
|
MediaType: MediaType | undefined;
|
|
@@ -583,7 +587,8 @@ export interface DeleteWorkspaceMediaResponse {
|
|
|
583
587
|
*/
|
|
584
588
|
export interface DeleteWorkspacePageRequest {
|
|
585
589
|
/**
|
|
586
|
-
* <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
|
|
590
|
+
* <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
|
|
591
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
587
592
|
* @public
|
|
588
593
|
*/
|
|
589
594
|
InstanceId: string | undefined;
|
|
@@ -2112,18 +2117,23 @@ export interface DescribeDataTableRequest {
|
|
|
2112
2117
|
*/
|
|
2113
2118
|
InstanceId: string | undefined;
|
|
2114
2119
|
/**
|
|
2115
|
-
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no
|
|
2120
|
+
* <p>The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no
|
|
2121
|
+
* alias is provided, the default behavior is identical to providing the $LATEST alias.</p>
|
|
2116
2122
|
* @public
|
|
2117
2123
|
*/
|
|
2118
2124
|
DataTableId: string | undefined;
|
|
2119
2125
|
}
|
|
2120
2126
|
/**
|
|
2121
|
-
* <p>Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and
|
|
2127
|
+
* <p>Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and
|
|
2128
|
+
* values are dynamically set by customers. Customers can reference table values within call flows, applications, views,
|
|
2129
|
+
* and workspaces to pinpoint dynamic configuration that changes their contact center's behavior in a predetermined and
|
|
2130
|
+
* safe way.</p>
|
|
2122
2131
|
* @public
|
|
2123
2132
|
*/
|
|
2124
2133
|
export interface DataTable {
|
|
2125
2134
|
/**
|
|
2126
|
-
* <p>The human-readable name of the data table. Must be unique within the instance and conform to Connect naming
|
|
2135
|
+
* <p>The human-readable name of the data table. Must be unique within the instance and conform to Connect naming
|
|
2136
|
+
* standards.</p>
|
|
2127
2137
|
* @public
|
|
2128
2138
|
*/
|
|
2129
2139
|
Name: string | undefined;
|
|
@@ -2138,7 +2148,8 @@ export interface DataTable {
|
|
|
2138
2148
|
*/
|
|
2139
2149
|
Arn: string | undefined;
|
|
2140
2150
|
/**
|
|
2141
|
-
* <p>The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are
|
|
2151
|
+
* <p>The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are
|
|
2152
|
+
* specified.</p>
|
|
2142
2153
|
* @public
|
|
2143
2154
|
*/
|
|
2144
2155
|
TimeZone: string | undefined;
|
|
@@ -2148,12 +2159,15 @@ export interface DataTable {
|
|
|
2148
2159
|
*/
|
|
2149
2160
|
Description?: string | undefined;
|
|
2150
2161
|
/**
|
|
2151
|
-
* <p>The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE,
|
|
2162
|
+
* <p>The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE,
|
|
2163
|
+
* and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values
|
|
2164
|
+
* simultaneously.</p>
|
|
2152
2165
|
* @public
|
|
2153
2166
|
*/
|
|
2154
2167
|
ValueLockLevel?: DataTableLockLevel | undefined;
|
|
2155
2168
|
/**
|
|
2156
|
-
* <p>The lock version information used for optimistic locking and table versioning. Changes with each update to
|
|
2169
|
+
* <p>The lock version information used for optimistic locking and table versioning. Changes with each update to
|
|
2170
|
+
* prevent concurrent modification conflicts.</p>
|
|
2157
2171
|
* @public
|
|
2158
2172
|
*/
|
|
2159
2173
|
LockVersion?: DataTableLockVersion | undefined;
|
|
@@ -2224,7 +2238,9 @@ export interface DescribeDataTableAttributeRequest {
|
|
|
2224
2238
|
AttributeName: string | undefined;
|
|
2225
2239
|
}
|
|
2226
2240
|
/**
|
|
2227
|
-
* <p>Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values
|
|
2241
|
+
* <p>Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values
|
|
2242
|
+
* that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a
|
|
2243
|
+
* primary key for record identification.</p>
|
|
2228
2244
|
* @public
|
|
2229
2245
|
*/
|
|
2230
2246
|
export interface DataTableAttribute {
|
|
@@ -2234,12 +2250,14 @@ export interface DataTableAttribute {
|
|
|
2234
2250
|
*/
|
|
2235
2251
|
AttributeId?: string | undefined;
|
|
2236
2252
|
/**
|
|
2237
|
-
* <p>The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming
|
|
2253
|
+
* <p>The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming
|
|
2254
|
+
* standards.</p>
|
|
2238
2255
|
* @public
|
|
2239
2256
|
*/
|
|
2240
2257
|
Name: string | undefined;
|
|
2241
2258
|
/**
|
|
2242
|
-
* <p>The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN.
|
|
2259
|
+
* <p>The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN.
|
|
2260
|
+
* Determines how values are validated and processed.</p>
|
|
2243
2261
|
* @public
|
|
2244
2262
|
*/
|
|
2245
2263
|
ValueType: DataTableAttributeValueType | undefined;
|
|
@@ -2259,7 +2277,8 @@ export interface DataTableAttribute {
|
|
|
2259
2277
|
*/
|
|
2260
2278
|
DataTableArn?: string | undefined;
|
|
2261
2279
|
/**
|
|
2262
|
-
* <p>Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes
|
|
2280
|
+
* <p>Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes
|
|
2281
|
+
* must have unique value combinations and cannot contain expressions.</p>
|
|
2263
2282
|
* @public
|
|
2264
2283
|
*/
|
|
2265
2284
|
Primary?: boolean | undefined;
|
|
@@ -2269,7 +2288,8 @@ export interface DataTableAttribute {
|
|
|
2269
2288
|
*/
|
|
2270
2289
|
Version?: string | undefined;
|
|
2271
2290
|
/**
|
|
2272
|
-
* <p>The lock version for this attribute, used for optimistic locking to prevent concurrent modification
|
|
2291
|
+
* <p>The lock version for this attribute, used for optimistic locking to prevent concurrent modification
|
|
2292
|
+
* conflicts.</p>
|
|
2273
2293
|
* @public
|
|
2274
2294
|
*/
|
|
2275
2295
|
LockVersion?: DataTableLockVersion | undefined;
|
|
@@ -2284,7 +2304,8 @@ export interface DataTableAttribute {
|
|
|
2284
2304
|
*/
|
|
2285
2305
|
LastModifiedRegion?: string | undefined;
|
|
2286
2306
|
/**
|
|
2287
|
-
* <p>The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional
|
|
2307
|
+
* <p>The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional
|
|
2308
|
+
* Connect-specific validations for data integrity.</p>
|
|
2288
2309
|
* @public
|
|
2289
2310
|
*/
|
|
2290
2311
|
Validation?: Validation | undefined;
|
|
@@ -4061,7 +4082,8 @@ export interface DescribeVocabularyResponse {
|
|
|
4061
4082
|
*/
|
|
4062
4083
|
export interface DescribeWorkspaceRequest {
|
|
4063
4084
|
/**
|
|
4064
|
-
* <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
|
|
4085
|
+
* <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
|
|
4086
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
4065
4087
|
* @public
|
|
4066
4088
|
*/
|
|
4067
4089
|
InstanceId: string | undefined;
|
|
@@ -4077,7 +4099,8 @@ export interface DescribeWorkspaceRequest {
|
|
|
4077
4099
|
*/
|
|
4078
4100
|
export interface Workspace {
|
|
4079
4101
|
/**
|
|
4080
|
-
* <p>Controls who can access the workspace. Valid values are: <code>ALL</code> (all users), <code>ASSIGNED</code>
|
|
4102
|
+
* <p>Controls who can access the workspace. Valid values are: <code>ALL</code> (all users), <code>ASSIGNED</code>
|
|
4103
|
+
* (only assigned users and routing profiles), and <code>NONE</code> (not visible).</p>
|
|
4081
4104
|
* @public
|
|
4082
4105
|
*/
|
|
4083
4106
|
Visibility?: Visibility | undefined;
|
|
@@ -4535,7 +4558,8 @@ export interface DisassociateUserProficienciesRequest {
|
|
|
4535
4558
|
*/
|
|
4536
4559
|
export interface DisassociateWorkspaceRequest {
|
|
4537
4560
|
/**
|
|
4538
|
-
* <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
|
|
4561
|
+
* <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
|
|
4562
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
4539
4563
|
* @public
|
|
4540
4564
|
*/
|
|
4541
4565
|
InstanceId: string | undefined;
|
|
@@ -4626,7 +4650,8 @@ export interface EvaluateDataTableValuesRequest {
|
|
|
4626
4650
|
*/
|
|
4627
4651
|
Values: DataTableValueEvaluationSet[] | undefined;
|
|
4628
4652
|
/**
|
|
4629
|
-
* <p>Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table
|
|
4653
|
+
* <p>Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table
|
|
4654
|
+
* time zone if not provided.</p>
|
|
4630
4655
|
* @public
|
|
4631
4656
|
*/
|
|
4632
4657
|
TimeZone?: string | undefined;
|
|
@@ -8394,7 +8419,8 @@ export interface ImportPhoneNumberResponse {
|
|
|
8394
8419
|
*/
|
|
8395
8420
|
export interface ImportWorkspaceMediaRequest {
|
|
8396
8421
|
/**
|
|
8397
|
-
* <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
|
|
8422
|
+
* <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
|
|
8423
|
+
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
8398
8424
|
* @public
|
|
8399
8425
|
*/
|
|
8400
8426
|
InstanceId: string | undefined;
|
|
@@ -8404,7 +8430,8 @@ export interface ImportWorkspaceMediaRequest {
|
|
|
8404
8430
|
*/
|
|
8405
8431
|
WorkspaceId: string | undefined;
|
|
8406
8432
|
/**
|
|
8407
|
-
* <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
8433
|
+
* <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
|
|
8434
|
+
* <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
|
|
8408
8435
|
* @public
|
|
8409
8436
|
*/
|
|
8410
8437
|
MediaType: MediaType | undefined;
|