@aws-sdk/client-connect 3.388.0 → 3.389.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 (68) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/Connect.js +6 -0
  3. package/dist-cjs/commands/AssociateTrafficDistributionGroupUserCommand.js +46 -0
  4. package/dist-cjs/commands/DisassociateTrafficDistributionGroupUserCommand.js +46 -0
  5. package/dist-cjs/commands/ListTrafficDistributionGroupUsersCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/models/models_0.js +1 -26
  8. package/dist-cjs/models/models_1.js +26 -11
  9. package/dist-cjs/models/models_2.js +11 -0
  10. package/dist-cjs/pagination/ListTrafficDistributionGroupUsersPaginator.js +29 -0
  11. package/dist-cjs/pagination/index.js +1 -0
  12. package/dist-cjs/protocols/Aws_restJson1.js +221 -9
  13. package/dist-es/Connect.js +6 -0
  14. package/dist-es/commands/AssociateTrafficDistributionGroupUserCommand.js +42 -0
  15. package/dist-es/commands/DisassociateTrafficDistributionGroupUserCommand.js +42 -0
  16. package/dist-es/commands/ListTrafficDistributionGroupUsersCommand.js +42 -0
  17. package/dist-es/commands/index.js +3 -0
  18. package/dist-es/models/models_0.js +0 -25
  19. package/dist-es/models/models_1.js +25 -10
  20. package/dist-es/models/models_2.js +10 -1
  21. package/dist-es/pagination/ListTrafficDistributionGroupUsersPaginator.js +25 -0
  22. package/dist-es/pagination/index.js +1 -0
  23. package/dist-es/protocols/Aws_restJson1.js +207 -1
  24. package/dist-types/Connect.d.ts +21 -0
  25. package/dist-types/ConnectClient.d.ts +5 -2
  26. package/dist-types/commands/AssociateTrafficDistributionGroupUserCommand.d.ts +91 -0
  27. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeTrafficDistributionGroupCommand.d.ts +1 -0
  29. package/dist-types/commands/DisassociateTrafficDistributionGroupUserCommand.d.ts +91 -0
  30. package/dist-types/commands/GetContactAttributesCommand.d.ts +2 -1
  31. package/dist-types/commands/GetTrafficDistributionCommand.d.ts +16 -0
  32. package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +12 -0
  33. package/dist-types/commands/ListTrafficDistributionGroupUsersCommand.d.ts +95 -0
  34. package/dist-types/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -0
  35. package/dist-types/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +3 -5
  36. package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +21 -0
  37. package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
  38. package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
  39. package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
  40. package/dist-types/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
  41. package/dist-types/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
  42. package/dist-types/commands/index.d.ts +3 -0
  43. package/dist-types/models/models_0.d.ts +97 -106
  44. package/dist-types/models/models_1.d.ts +213 -339
  45. package/dist-types/models/models_2.d.ts +320 -2
  46. package/dist-types/pagination/ListTrafficDistributionGroupUsersPaginator.d.ts +7 -0
  47. package/dist-types/pagination/index.d.ts +1 -0
  48. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  49. package/dist-types/ts3.4/Connect.d.ts +69 -0
  50. package/dist-types/ts3.4/ConnectClient.d.ts +18 -0
  51. package/dist-types/ts3.4/commands/AssociateTrafficDistributionGroupUserCommand.d.ts +42 -0
  52. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/DisassociateTrafficDistributionGroupUserCommand.d.ts +42 -0
  54. package/dist-types/ts3.4/commands/GetContactAttributesCommand.d.ts +2 -4
  55. package/dist-types/ts3.4/commands/ListTrafficDistributionGroupUsersCommand.d.ts +42 -0
  56. package/dist-types/ts3.4/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  62. package/dist-types/ts3.4/models/models_0.d.ts +20 -41
  63. package/dist-types/ts3.4/models/models_1.d.ts +65 -99
  64. package/dist-types/ts3.4/models/models_2.d.ts +98 -3
  65. package/dist-types/ts3.4/pagination/ListTrafficDistributionGroupUsersPaginator.d.ts +11 -0
  66. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  67. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  68. package/package.json +1 -1
@@ -1,6 +1,105 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentAvailabilityTimer, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CurrentMetric, CurrentMetricName, DirectoryType, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QueueStatus, QuickConnect, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
3
+ import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, DirectoryType, Distribution, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QueueStatus, QuickConnect, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, UseCaseType, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface GetContactAttributesResponse {
8
+ /**
9
+ * @public
10
+ * <p>Information about the attributes.</p>
11
+ */
12
+ Attributes?: Record<string, string>;
13
+ }
14
+ /**
15
+ * @public
16
+ * @enum
17
+ */
18
+ export declare const CurrentMetricName: {
19
+ readonly AGENTS_AFTER_CONTACT_WORK: "AGENTS_AFTER_CONTACT_WORK";
20
+ readonly AGENTS_AVAILABLE: "AGENTS_AVAILABLE";
21
+ readonly AGENTS_ERROR: "AGENTS_ERROR";
22
+ readonly AGENTS_NON_PRODUCTIVE: "AGENTS_NON_PRODUCTIVE";
23
+ readonly AGENTS_ONLINE: "AGENTS_ONLINE";
24
+ readonly AGENTS_ON_CALL: "AGENTS_ON_CALL";
25
+ readonly AGENTS_ON_CONTACT: "AGENTS_ON_CONTACT";
26
+ readonly AGENTS_STAFFED: "AGENTS_STAFFED";
27
+ readonly CONTACTS_IN_QUEUE: "CONTACTS_IN_QUEUE";
28
+ readonly CONTACTS_SCHEDULED: "CONTACTS_SCHEDULED";
29
+ readonly OLDEST_CONTACT_AGE: "OLDEST_CONTACT_AGE";
30
+ readonly SLOTS_ACTIVE: "SLOTS_ACTIVE";
31
+ readonly SLOTS_AVAILABLE: "SLOTS_AVAILABLE";
32
+ };
33
+ /**
34
+ * @public
35
+ */
36
+ export type CurrentMetricName = (typeof CurrentMetricName)[keyof typeof CurrentMetricName];
37
+ /**
38
+ * @public
39
+ * @enum
40
+ */
41
+ export declare const Unit: {
42
+ readonly COUNT: "COUNT";
43
+ readonly PERCENT: "PERCENT";
44
+ readonly SECONDS: "SECONDS";
45
+ };
46
+ /**
47
+ * @public
48
+ */
49
+ export type Unit = (typeof Unit)[keyof typeof Unit];
50
+ /**
51
+ * @public
52
+ * <p>Contains information about a real-time metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator
53
+ * Guide</i>.</p>
54
+ */
55
+ export interface CurrentMetric {
56
+ /**
57
+ * @public
58
+ * <p>The name of the metric.</p>
59
+ */
60
+ Name?: CurrentMetricName | string;
61
+ /**
62
+ * @public
63
+ * <p>The unit for the metric.</p>
64
+ */
65
+ Unit?: Unit | string;
66
+ }
67
+ /**
68
+ * @public
69
+ * <p>Contains the filter to apply when retrieving metrics.</p>
70
+ */
71
+ export interface Filters {
72
+ /**
73
+ * @public
74
+ * <p>The queues to use to filter the metrics. You should specify at least one queue, and can
75
+ * specify up to 100 queues per request. The <code>GetCurrentMetricsData</code> API in particular
76
+ * requires a queue when you include a <code>Filter</code> in your request. </p>
77
+ */
78
+ Queues?: string[];
79
+ /**
80
+ * @public
81
+ * <p>The channel to use to filter the metrics.</p>
82
+ */
83
+ Channels?: (Channel | string)[];
84
+ /**
85
+ * @public
86
+ * <p>A list of up to 100 routing profile IDs or ARNs.</p>
87
+ */
88
+ RoutingProfiles?: string[];
89
+ }
90
+ /**
91
+ * @public
92
+ * @enum
93
+ */
94
+ export declare const Grouping: {
95
+ readonly CHANNEL: "CHANNEL";
96
+ readonly QUEUE: "QUEUE";
97
+ readonly ROUTING_PROFILE: "ROUTING_PROFILE";
98
+ };
99
+ /**
100
+ * @public
101
+ */
102
+ export type Grouping = (typeof Grouping)[keyof typeof Grouping];
4
103
  /**
5
104
  * @public
6
105
  * @enum
@@ -592,7 +691,7 @@ export interface GetFederationTokenResponse {
592
691
  UserArn?: string;
593
692
  /**
594
693
  * @public
595
- * <p>The identifier for the user.</p>
694
+ * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
596
695
  */
597
696
  UserId?: string;
598
697
  }
@@ -1209,7 +1308,7 @@ export interface GetMetricDataV2Request {
1209
1308
  * <p>Unit: Seconds</p>
1210
1309
  * <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
1211
1310
  * supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
1212
- * <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
1311
+ * <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
1213
1312
  * </p>
1214
1313
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1215
1314
  * </dd>
@@ -1228,7 +1327,8 @@ export interface GetMetricDataV2Request {
1228
1327
  * </dd>
1229
1328
  * <dt>AVG_GREETING_TIME_AGENT</dt>
1230
1329
  * <dd>
1231
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1330
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1331
+ * analytics.</p>
1232
1332
  * <p>Unit: Seconds</p>
1233
1333
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1234
1334
  * </dd>
@@ -1271,19 +1371,22 @@ export interface GetMetricDataV2Request {
1271
1371
  * </dd>
1272
1372
  * <dt>AVG_INTERRUPTIONS_AGENT</dt>
1273
1373
  * <dd>
1274
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1374
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1375
+ * analytics.</p>
1275
1376
  * <p>Unit: Count</p>
1276
1377
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1277
1378
  * </dd>
1278
1379
  * <dt>AVG_INTERRUPTION_TIME_AGENT</dt>
1279
1380
  * <dd>
1280
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1381
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1382
+ * analytics.</p>
1281
1383
  * <p>Unit: Seconds</p>
1282
1384
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1283
1385
  * </dd>
1284
1386
  * <dt>AVG_NON_TALK_TIME</dt>
1285
1387
  * <dd>
1286
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1388
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1389
+ * analytics.</p>
1287
1390
  * <p>Unit: Seconds</p>
1288
1391
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1289
1392
  * </dd>
@@ -1297,19 +1400,22 @@ export interface GetMetricDataV2Request {
1297
1400
  * </dd>
1298
1401
  * <dt>AVG_TALK_TIME</dt>
1299
1402
  * <dd>
1300
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1403
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1404
+ * analytics.</p>
1301
1405
  * <p>Unit: Seconds</p>
1302
1406
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1303
1407
  * </dd>
1304
1408
  * <dt>AVG_TALK_TIME_AGENT</dt>
1305
1409
  * <dd>
1306
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1410
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1411
+ * analytics.</p>
1307
1412
  * <p>Unit: Seconds</p>
1308
1413
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1309
1414
  * </dd>
1310
1415
  * <dt>AVG_TALK_TIME_CUSTOMER</dt>
1311
1416
  * <dd>
1312
- * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1417
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational
1418
+ * analytics.</p>
1313
1419
  * <p>Unit: Seconds</p>
1314
1420
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1315
1421
  * </dd>
@@ -1603,19 +1709,30 @@ export interface GetTrafficDistributionRequest {
1603
1709
  }
1604
1710
  /**
1605
1711
  * @public
1606
- * <p>Information about a traffic distribution.</p>
1712
+ * <p>The distribution of sign in traffic between the instance and its replica(s).</p>
1607
1713
  */
1608
- export interface Distribution {
1714
+ export interface SignInDistribution {
1609
1715
  /**
1610
1716
  * @public
1611
- * <p>The Amazon Web Services Region where the traffic is distributed.</p>
1717
+ * <p>The Amazon Web Services Region of the sign in distribution.</p>
1612
1718
  */
1613
1719
  Region: string | undefined;
1614
1720
  /**
1615
1721
  * @public
1616
- * <p>The percentage of the traffic that is distributed, in increments of 10.</p>
1722
+ * <p>Whether sign in distribution is enabled.</p>
1723
+ */
1724
+ Enabled: boolean | undefined;
1725
+ }
1726
+ /**
1727
+ * @public
1728
+ * <p>The distribution of allowing signing in to the instance and its replica(s).</p>
1729
+ */
1730
+ export interface SignInConfig {
1731
+ /**
1732
+ * @public
1733
+ * <p>Information about traffic distributions.</p>
1617
1734
  */
1618
- Percentage: number | undefined;
1735
+ Distributions: SignInDistribution[] | undefined;
1619
1736
  }
1620
1737
  /**
1621
1738
  * @public
@@ -1649,6 +1766,16 @@ export interface GetTrafficDistributionResponse {
1649
1766
  * <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
1650
1767
  */
1651
1768
  Arn?: string;
1769
+ /**
1770
+ * @public
1771
+ * <p>The distribution of allowing signing in to the instance and its replica(s).</p>
1772
+ */
1773
+ SignInConfig?: SignInConfig;
1774
+ /**
1775
+ * @public
1776
+ * <p>The distribution of agents between the instance and its replica(s).</p>
1777
+ */
1778
+ AgentConfig?: AgentConfig;
1652
1779
  }
1653
1780
  /**
1654
1781
  * @public
@@ -3961,6 +4088,14 @@ export interface TrafficDistributionGroupSummary {
3961
4088
  * </ul>
3962
4089
  */
3963
4090
  Status?: TrafficDistributionGroupStatus | string;
4091
+ /**
4092
+ * @public
4093
+ * <p>Whether this is the default traffic distribution group created during instance
4094
+ * replication. The default traffic distribution group cannot be deleted by the
4095
+ * <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
4096
+ * part of the process for deleting a replica.</p>
4097
+ */
4098
+ IsDefault?: boolean;
3964
4099
  }
3965
4100
  /**
3966
4101
  * @public
@@ -3977,6 +4112,55 @@ export interface ListTrafficDistributionGroupsResponse {
3977
4112
  */
3978
4113
  TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[];
3979
4114
  }
4115
+ /**
4116
+ * @public
4117
+ */
4118
+ export interface ListTrafficDistributionGroupUsersRequest {
4119
+ /**
4120
+ * @public
4121
+ * <p>The identifier of the traffic distribution group.
4122
+ * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
4123
+ * The ARN must be provided if the call is from the replicated Region.</p>
4124
+ */
4125
+ TrafficDistributionGroupId: string | undefined;
4126
+ /**
4127
+ * @public
4128
+ * <p>The maximum number of results to return per page.</p>
4129
+ */
4130
+ MaxResults?: number;
4131
+ /**
4132
+ * @public
4133
+ * <p>The token for the next set of results. Use the value returned in the previous
4134
+ * response in the next request to retrieve the next set of results.</p>
4135
+ */
4136
+ NextToken?: string;
4137
+ }
4138
+ /**
4139
+ * @public
4140
+ * <p>Summary information about a traffic distribution group user.</p>
4141
+ */
4142
+ export interface TrafficDistributionGroupUserSummary {
4143
+ /**
4144
+ * @public
4145
+ * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
4146
+ */
4147
+ UserId?: string;
4148
+ }
4149
+ /**
4150
+ * @public
4151
+ */
4152
+ export interface ListTrafficDistributionGroupUsersResponse {
4153
+ /**
4154
+ * @public
4155
+ * <p>If there are additional results, this is the token for the next set of results.</p>
4156
+ */
4157
+ NextToken?: string;
4158
+ /**
4159
+ * @public
4160
+ * <p>A list of traffic distribution group users.</p>
4161
+ */
4162
+ TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[];
4163
+ }
3980
4164
  /**
3981
4165
  * @public
3982
4166
  * <p>Provides summary information about the use cases for the specified integration
@@ -5904,7 +6088,7 @@ export interface TransferContactRequest {
5904
6088
  QueueId?: string;
5905
6089
  /**
5906
6090
  * @public
5907
- * <p>The identifier for the user.</p>
6091
+ * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
5908
6092
  */
5909
6093
  UserId?: string;
5910
6094
  /**
@@ -6801,11 +6985,9 @@ export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
6801
6985
  RoutingProfileId: string | undefined;
6802
6986
  /**
6803
6987
  * @public
6804
- * <p>Whether agents with this routing profile
6805
- * will have their routing order calculated based on
6806
- * <i>time since their last inbound
6807
- * contact</i> or <i>longest idle
6808
- * time</i>. </p>
6988
+ * <p>Whether agents with this routing profile will have their routing order calculated based on
6989
+ * <i>time since their last inbound contact</i> or <i>longest idle
6990
+ * time</i>. </p>
6809
6991
  */
6810
6992
  AgentAvailabilityTimer: AgentAvailabilityTimer | string | undefined;
6811
6993
  }
@@ -7105,6 +7287,16 @@ export interface UpdateTrafficDistributionRequest {
7105
7287
  * <p>The distribution of traffic between the instance and its replica(s).</p>
7106
7288
  */
7107
7289
  TelephonyConfig?: TelephonyConfig;
7290
+ /**
7291
+ * @public
7292
+ * <p>The distribution of allowing signing in to the instance and its replica(s).</p>
7293
+ */
7294
+ SignInConfig?: SignInConfig;
7295
+ /**
7296
+ * @public
7297
+ * <p>The distribution of agents between the instance and its replica(s).</p>
7298
+ */
7299
+ AgentConfig?: AgentConfig;
7108
7300
  }
7109
7301
  /**
7110
7302
  * @public
@@ -7162,324 +7354,6 @@ export interface HierarchyLevelUpdate {
7162
7354
  */
7163
7355
  Name: string | undefined;
7164
7356
  }
7165
- /**
7166
- * @public
7167
- * <p>Contains information about the level hierarchy to update.</p>
7168
- */
7169
- export interface HierarchyStructureUpdate {
7170
- /**
7171
- * @public
7172
- * <p>The
7173
- * update
7174
- * for level one.</p>
7175
- */
7176
- LevelOne?: HierarchyLevelUpdate;
7177
- /**
7178
- * @public
7179
- * <p>The update for level two.</p>
7180
- */
7181
- LevelTwo?: HierarchyLevelUpdate;
7182
- /**
7183
- * @public
7184
- * <p>The update for level three.</p>
7185
- */
7186
- LevelThree?: HierarchyLevelUpdate;
7187
- /**
7188
- * @public
7189
- * <p>The update for level four.</p>
7190
- */
7191
- LevelFour?: HierarchyLevelUpdate;
7192
- /**
7193
- * @public
7194
- * <p>The update for level five.</p>
7195
- */
7196
- LevelFive?: HierarchyLevelUpdate;
7197
- }
7198
- /**
7199
- * @public
7200
- */
7201
- export interface UpdateUserHierarchyStructureRequest {
7202
- /**
7203
- * @public
7204
- * <p>The hierarchy levels to update.</p>
7205
- */
7206
- HierarchyStructure: HierarchyStructureUpdate | undefined;
7207
- /**
7208
- * @public
7209
- * <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>
7210
- */
7211
- InstanceId: string | undefined;
7212
- }
7213
- /**
7214
- * @public
7215
- */
7216
- export interface UpdateUserIdentityInfoRequest {
7217
- /**
7218
- * @public
7219
- * <p>The identity information for the user.</p>
7220
- */
7221
- IdentityInfo: UserIdentityInfo | undefined;
7222
- /**
7223
- * @public
7224
- * <p>The identifier of the user account.</p>
7225
- */
7226
- UserId: string | undefined;
7227
- /**
7228
- * @public
7229
- * <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>
7230
- */
7231
- InstanceId: string | undefined;
7232
- }
7233
- /**
7234
- * @public
7235
- */
7236
- export interface UpdateUserPhoneConfigRequest {
7237
- /**
7238
- * @public
7239
- * <p>Information about phone configuration settings for the user.</p>
7240
- */
7241
- PhoneConfig: UserPhoneConfig | undefined;
7242
- /**
7243
- * @public
7244
- * <p>The identifier of the user account.</p>
7245
- */
7246
- UserId: string | undefined;
7247
- /**
7248
- * @public
7249
- * <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>
7250
- */
7251
- InstanceId: string | undefined;
7252
- }
7253
- /**
7254
- * @public
7255
- */
7256
- export interface UpdateUserRoutingProfileRequest {
7257
- /**
7258
- * @public
7259
- * <p>The identifier of the routing profile for the user.</p>
7260
- */
7261
- RoutingProfileId: string | undefined;
7262
- /**
7263
- * @public
7264
- * <p>The identifier of the user account.</p>
7265
- */
7266
- UserId: string | undefined;
7267
- /**
7268
- * @public
7269
- * <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>
7270
- */
7271
- InstanceId: string | undefined;
7272
- }
7273
- /**
7274
- * @public
7275
- */
7276
- export interface UpdateUserSecurityProfilesRequest {
7277
- /**
7278
- * @public
7279
- * <p>The identifiers of the security profiles for the user.</p>
7280
- */
7281
- SecurityProfileIds: string[] | undefined;
7282
- /**
7283
- * @public
7284
- * <p>The identifier of the user account.</p>
7285
- */
7286
- UserId: string | undefined;
7287
- /**
7288
- * @public
7289
- * <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>
7290
- */
7291
- InstanceId: string | undefined;
7292
- }
7293
- /**
7294
- * @public
7295
- * <p>Information about an item from an evaluation form. The item must be either a section or a
7296
- * question.</p>
7297
- */
7298
- export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember;
7299
- /**
7300
- * @public
7301
- */
7302
- export declare namespace EvaluationFormItem {
7303
- /**
7304
- * @public
7305
- * <p>The information of the section.</p>
7306
- */
7307
- interface SectionMember {
7308
- Section: EvaluationFormSection;
7309
- Question?: never;
7310
- $unknown?: never;
7311
- }
7312
- /**
7313
- * @public
7314
- * <p>The information of the question.</p>
7315
- */
7316
- interface QuestionMember {
7317
- Section?: never;
7318
- Question: EvaluationFormQuestion;
7319
- $unknown?: never;
7320
- }
7321
- /**
7322
- * @public
7323
- */
7324
- interface $UnknownMember {
7325
- Section?: never;
7326
- Question?: never;
7327
- $unknown: [string, any];
7328
- }
7329
- interface Visitor<T> {
7330
- Section: (value: EvaluationFormSection) => T;
7331
- Question: (value: EvaluationFormQuestion) => T;
7332
- _: (name: string, value: any) => T;
7333
- }
7334
- const visit: <T>(value: EvaluationFormItem, visitor: Visitor<T>) => T;
7335
- }
7336
- /**
7337
- * @public
7338
- * <p>Information about a section from an evaluation form. A section can contain sections and/or
7339
- * questions. Evaluation forms can only contain sections and subsections (two level nesting).</p>
7340
- */
7341
- export interface EvaluationFormSection {
7342
- /**
7343
- * @public
7344
- * <p>The title of the section.</p>
7345
- */
7346
- Title: string | undefined;
7347
- /**
7348
- * @public
7349
- * <p>The identifier of the section. An identifier must be unique within the evaluation
7350
- * form.</p>
7351
- */
7352
- RefId: string | undefined;
7353
- /**
7354
- * @public
7355
- * <p>The instructions of the section.</p>
7356
- */
7357
- Instructions?: string;
7358
- /**
7359
- * @public
7360
- * <p>The items of the section.</p>
7361
- */
7362
- Items: EvaluationFormItem[] | undefined;
7363
- /**
7364
- * @public
7365
- * <p>The scoring weight of the section.</p>
7366
- */
7367
- Weight?: number;
7368
- }
7369
- /**
7370
- * @public
7371
- */
7372
- export interface CreateEvaluationFormRequest {
7373
- /**
7374
- * @public
7375
- * <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>
7376
- */
7377
- InstanceId: string | undefined;
7378
- /**
7379
- * @public
7380
- * <p>A title of the evaluation form.</p>
7381
- */
7382
- Title: string | undefined;
7383
- /**
7384
- * @public
7385
- * <p>The description of the evaluation form.</p>
7386
- */
7387
- Description?: string;
7388
- /**
7389
- * @public
7390
- * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
7391
- */
7392
- Items: EvaluationFormItem[] | undefined;
7393
- /**
7394
- * @public
7395
- * <p>A scoring strategy of the evaluation form.</p>
7396
- */
7397
- ScoringStrategy?: EvaluationFormScoringStrategy;
7398
- /**
7399
- * @public
7400
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
7401
- * request. If not provided, the Amazon Web Services
7402
- * SDK populates this field. For more information about idempotency, see
7403
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
7404
- */
7405
- ClientToken?: string;
7406
- }
7407
- /**
7408
- * @public
7409
- * <p>Information about the evaluation form.</p>
7410
- */
7411
- export interface EvaluationForm {
7412
- /**
7413
- * @public
7414
- * <p>The unique identifier for the evaluation form.</p>
7415
- */
7416
- EvaluationFormId: string | undefined;
7417
- /**
7418
- * @public
7419
- * <p>A version of the evaluation form.</p>
7420
- */
7421
- EvaluationFormVersion: number | undefined;
7422
- /**
7423
- * @public
7424
- * <p>The flag indicating whether the evaluation form is locked for changes.</p>
7425
- */
7426
- Locked: boolean | undefined;
7427
- /**
7428
- * @public
7429
- * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
7430
- */
7431
- EvaluationFormArn: string | undefined;
7432
- /**
7433
- * @public
7434
- * <p>A title of the evaluation form.</p>
7435
- */
7436
- Title: string | undefined;
7437
- /**
7438
- * @public
7439
- * <p>The description of the evaluation form.</p>
7440
- */
7441
- Description?: string;
7442
- /**
7443
- * @public
7444
- * <p>The status of the evaluation form.</p>
7445
- */
7446
- Status: EvaluationFormVersionStatus | string | undefined;
7447
- /**
7448
- * @public
7449
- * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
7450
- */
7451
- Items: EvaluationFormItem[] | undefined;
7452
- /**
7453
- * @public
7454
- * <p>A scoring strategy of the evaluation form.</p>
7455
- */
7456
- ScoringStrategy?: EvaluationFormScoringStrategy;
7457
- /**
7458
- * @public
7459
- * <p>The timestamp for when the evaluation form was created.</p>
7460
- */
7461
- CreatedTime: Date | undefined;
7462
- /**
7463
- * @public
7464
- * <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
7465
- */
7466
- CreatedBy: string | undefined;
7467
- /**
7468
- * @public
7469
- * <p>The timestamp for when the evaluation form was last updated.</p>
7470
- */
7471
- LastModifiedTime: Date | undefined;
7472
- /**
7473
- * @public
7474
- * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
7475
- */
7476
- LastModifiedBy: string | undefined;
7477
- /**
7478
- * @public
7479
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
7480
- */
7481
- Tags?: Record<string, string>;
7482
- }
7483
7357
  /**
7484
7358
  * @internal
7485
7359
  */