@aws-sdk/client-connect 3.237.0 → 3.241.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/models/models_0.js +19 -17
- package/dist-cjs/models/models_1.js +15 -7
- package/dist-cjs/protocols/Aws_restJson1.js +58 -0
- package/dist-es/models/models_0.js +12 -9
- package/dist-es/models/models_1.js +7 -1
- package/dist-es/protocols/Aws_restJson1.js +58 -0
- package/dist-types/Connect.d.ts +8 -8
- package/dist-types/commands/ClaimPhoneNumberCommand.d.ts +2 -2
- package/dist-types/commands/CreateRuleCommand.d.ts +2 -2
- package/dist-types/commands/DismissUserContactCommand.d.ts +1 -1
- package/dist-types/commands/MonitorContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +137 -68
- package/dist-types/models/models_1.d.ts +40 -4
- package/dist-types/ts3.4/models/models_0.d.ts +29 -21
- package/dist-types/ts3.4/models/models_1.d.ts +14 -2
- package/package.json +6 -5
|
@@ -9,8 +9,8 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a rule for the specified Amazon Connect instance.</p>
|
|
12
|
-
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to
|
|
13
|
-
*
|
|
12
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule.
|
|
13
|
+
* </p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DismissUserContactCommandOutput extends DismissUserContactRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Dismisses contacts from an agent’s CCP and returns the agent to an available state, which
|
|
12
12
|
* allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a
|
|
13
|
-
*
|
|
13
|
+
* <code>MISSED</code>, <code>ERROR</code>, <code>ENDED</code>, or <code>REJECTED</code> state in
|
|
14
14
|
* the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">Agent
|
|
15
15
|
* Event Stream</a>.</p>
|
|
16
16
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface MonitorContactCommandOutput extends MonitorContactResponse, __M
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user
|
|
12
12
|
* specified by <i>userId</i> will be set to silent monitoring mode on the
|
|
13
|
-
* contact
|
|
13
|
+
* contact.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,8 +9,8 @@ export interface UpdateRuleCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates a rule for the specified Amazon Connect instance.</p>
|
|
12
|
-
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to
|
|
13
|
-
*
|
|
12
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule.
|
|
13
|
+
* </p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -169,6 +169,10 @@ export interface AgentStatusReference {
|
|
|
169
169
|
* <p>The Amazon Resource Name (ARN) of the agent's status.</p>
|
|
170
170
|
*/
|
|
171
171
|
StatusArn?: string;
|
|
172
|
+
/**
|
|
173
|
+
* <p>The name of the agent status.</p>
|
|
174
|
+
*/
|
|
175
|
+
StatusName?: string;
|
|
172
176
|
}
|
|
173
177
|
/**
|
|
174
178
|
* <p>Summary information for an agent status.</p>
|
|
@@ -1259,8 +1263,8 @@ export interface CreateRoutingProfileResponse {
|
|
|
1259
1263
|
}
|
|
1260
1264
|
/**
|
|
1261
1265
|
* <p>This action must be set if <code>TriggerEventSource</code> is one of the following values:
|
|
1262
|
-
*
|
|
1263
|
-
*
|
|
1266
|
+
* <code>OnPostCallAnalysisAvailable</code> | <code>OnRealTimeCallAnalysisAvailable</code> |
|
|
1267
|
+
* <code>OnPostChatAnalysisAvailable</code>. Contact is categorized using the rule name.</p>
|
|
1264
1268
|
* <p>
|
|
1265
1269
|
* <code>RuleName</code> is used as <code>ContactCategory</code>.</p>
|
|
1266
1270
|
*/
|
|
@@ -1385,7 +1389,7 @@ export interface RuleAction {
|
|
|
1385
1389
|
/**
|
|
1386
1390
|
* <p>Information about the task action. This field is required if <code>TriggerEventSource</code>
|
|
1387
1391
|
* is one of the following values: <code>OnZendeskTicketCreate</code> |
|
|
1388
|
-
*
|
|
1392
|
+
* <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code>
|
|
1389
1393
|
* </p>
|
|
1390
1394
|
*/
|
|
1391
1395
|
TaskAction?: TaskActionDefinition;
|
|
@@ -1417,7 +1421,7 @@ export declare enum EventSourceName {
|
|
|
1417
1421
|
/**
|
|
1418
1422
|
* <p>The name of the event source. This field is required if <code>TriggerEventSource</code> is one of the
|
|
1419
1423
|
* following values: <code>OnZendeskTicketCreate</code> | <code>OnZendeskTicketStatusUpdate</code> |
|
|
1420
|
-
*
|
|
1424
|
+
* <code>OnSalesforceCaseCreate</code>
|
|
1421
1425
|
* </p>
|
|
1422
1426
|
*/
|
|
1423
1427
|
export interface RuleTriggerEventSource {
|
|
@@ -1500,8 +1504,8 @@ export interface CreateSecurityProfileRequest {
|
|
|
1500
1504
|
*/
|
|
1501
1505
|
AllowedAccessControlTags?: Record<string, string>;
|
|
1502
1506
|
/**
|
|
1503
|
-
* <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code> |
|
|
1504
|
-
*
|
|
1507
|
+
* <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code> | <code>SecurityProfile</code> | <code>Queue</code> |
|
|
1508
|
+
* <code>RoutingProfile</code>
|
|
1505
1509
|
* </p>
|
|
1506
1510
|
*/
|
|
1507
1511
|
TagRestrictedResources?: string[];
|
|
@@ -3823,10 +3827,34 @@ export interface Filters {
|
|
|
3823
3827
|
* <p>The channel to use to filter the metrics.</p>
|
|
3824
3828
|
*/
|
|
3825
3829
|
Channels?: (Channel | string)[];
|
|
3830
|
+
/**
|
|
3831
|
+
* <p>A list of up to 100 routing profile IDs or ARNs.</p>
|
|
3832
|
+
*/
|
|
3833
|
+
RoutingProfiles?: string[];
|
|
3826
3834
|
}
|
|
3827
3835
|
export declare enum Grouping {
|
|
3828
3836
|
CHANNEL = "CHANNEL",
|
|
3829
|
-
QUEUE = "QUEUE"
|
|
3837
|
+
QUEUE = "QUEUE",
|
|
3838
|
+
ROUTING_PROFILE = "ROUTING_PROFILE"
|
|
3839
|
+
}
|
|
3840
|
+
export declare enum SortOrder {
|
|
3841
|
+
ASCENDING = "ASCENDING",
|
|
3842
|
+
DESCENDING = "DESCENDING"
|
|
3843
|
+
}
|
|
3844
|
+
/**
|
|
3845
|
+
* <p>The way to sort the resulting response based on metrics. By default resources are sorted
|
|
3846
|
+
* based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted
|
|
3847
|
+
* based on the input metrics.</p>
|
|
3848
|
+
*/
|
|
3849
|
+
export interface CurrentMetricSortCriteria {
|
|
3850
|
+
/**
|
|
3851
|
+
* <p>The current metric names.</p>
|
|
3852
|
+
*/
|
|
3853
|
+
SortByMetric?: CurrentMetricName | string;
|
|
3854
|
+
/**
|
|
3855
|
+
* <p>The way to sort.</p>
|
|
3856
|
+
*/
|
|
3857
|
+
SortOrder?: SortOrder | string;
|
|
3830
3858
|
}
|
|
3831
3859
|
export interface GetCurrentMetricDataRequest {
|
|
3832
3860
|
/**
|
|
@@ -3834,9 +3862,21 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3834
3862
|
*/
|
|
3835
3863
|
InstanceId: string | undefined;
|
|
3836
3864
|
/**
|
|
3837
|
-
* <p>The
|
|
3838
|
-
*
|
|
3839
|
-
*
|
|
3865
|
+
* <p>The filters to apply to returned metrics. You can filter up to the following limits:</p>
|
|
3866
|
+
* <ul>
|
|
3867
|
+
* <li>
|
|
3868
|
+
* <p>Queues: 100</p>
|
|
3869
|
+
* </li>
|
|
3870
|
+
* <li>
|
|
3871
|
+
* <p>Routing profiles: 100</p>
|
|
3872
|
+
* </li>
|
|
3873
|
+
* <li>
|
|
3874
|
+
* <p>Channels: 3 (VOICE, CHAT, and TASK channels are supported.)</p>
|
|
3875
|
+
* </li>
|
|
3876
|
+
* </ul>
|
|
3877
|
+
* <p>Metric data is retrieved only for the resources associated with the queues or routing
|
|
3878
|
+
* profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request. </p>
|
|
3879
|
+
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
3840
3880
|
*/
|
|
3841
3881
|
Filters: Filters | undefined;
|
|
3842
3882
|
/**
|
|
@@ -3850,7 +3890,9 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3850
3890
|
* </li>
|
|
3851
3891
|
* <li>
|
|
3852
3892
|
* <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing
|
|
3853
|
-
* profile filter
|
|
3893
|
+
* profile filter. In addition, a routing profile filter is
|
|
3894
|
+
* required for metrics <code>CONTACTS_SCHEDULED</code>, <code>CONTACTS_IN_QUEUE</code>, and
|
|
3895
|
+
* <code> OLDEST_CONTACT_AGE</code>.</p>
|
|
3854
3896
|
* </li>
|
|
3855
3897
|
* <li>
|
|
3856
3898
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
|
|
@@ -3966,6 +4008,18 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3966
4008
|
* <p>The maximum number of results to return per page.</p>
|
|
3967
4009
|
*/
|
|
3968
4010
|
MaxResults?: number;
|
|
4011
|
+
/**
|
|
4012
|
+
* <p>The way to sort the resulting response based on metrics. You can enter one sort criteria. By
|
|
4013
|
+
* default resources are sorted based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The
|
|
4014
|
+
* metric collection is sorted based on the input metrics.</p>
|
|
4015
|
+
* <p>Note the following:</p>
|
|
4016
|
+
* <ul>
|
|
4017
|
+
* <li>
|
|
4018
|
+
* <p>Sorting on <code>SLOTS_ACTIVE</code> and <code>SLOTS_AVAILABLE</code> is not supported.</p>
|
|
4019
|
+
* </li>
|
|
4020
|
+
* </ul>
|
|
4021
|
+
*/
|
|
4022
|
+
SortCriteria?: CurrentMetricSortCriteria[];
|
|
3969
4023
|
}
|
|
3970
4024
|
/**
|
|
3971
4025
|
* <p>Contains the data for a real-time metric.</p>
|
|
@@ -3980,6 +4034,19 @@ export interface CurrentMetricData {
|
|
|
3980
4034
|
*/
|
|
3981
4035
|
Value?: number;
|
|
3982
4036
|
}
|
|
4037
|
+
/**
|
|
4038
|
+
* <p>Information about the routing profile assigned to the user.</p>
|
|
4039
|
+
*/
|
|
4040
|
+
export interface RoutingProfileReference {
|
|
4041
|
+
/**
|
|
4042
|
+
* <p>The identifier of the routing profile.</p>
|
|
4043
|
+
*/
|
|
4044
|
+
Id?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* <p>The Amazon Resource Name (ARN) of the routing profile.</p>
|
|
4047
|
+
*/
|
|
4048
|
+
Arn?: string;
|
|
4049
|
+
}
|
|
3983
4050
|
/**
|
|
3984
4051
|
* <p>Contains information about the dimensions for a set of metrics.</p>
|
|
3985
4052
|
*/
|
|
@@ -3992,6 +4059,10 @@ export interface Dimensions {
|
|
|
3992
4059
|
* <p>The channel used for grouping and filters.</p>
|
|
3993
4060
|
*/
|
|
3994
4061
|
Channel?: Channel | string;
|
|
4062
|
+
/**
|
|
4063
|
+
* <p>Information about the routing profile assigned to the user.</p>
|
|
4064
|
+
*/
|
|
4065
|
+
RoutingProfile?: RoutingProfileReference;
|
|
3995
4066
|
}
|
|
3996
4067
|
/**
|
|
3997
4068
|
* <p>Contains information about a set of real-time metrics.</p>
|
|
@@ -4021,6 +4092,10 @@ export interface GetCurrentMetricDataResponse {
|
|
|
4021
4092
|
* <p>The time at which the metrics were retrieved and cached for pagination.</p>
|
|
4022
4093
|
*/
|
|
4023
4094
|
DataSnapshotTime?: Date;
|
|
4095
|
+
/**
|
|
4096
|
+
* <p>The total count of the result, regardless of the current page size. </p>
|
|
4097
|
+
*/
|
|
4098
|
+
ApproximateTotalCount?: number;
|
|
4024
4099
|
}
|
|
4025
4100
|
/**
|
|
4026
4101
|
* <p>Filters user data based on the contact information that is associated to the users. It
|
|
@@ -4037,7 +4112,7 @@ export interface ContactFilter {
|
|
|
4037
4112
|
*/
|
|
4038
4113
|
export interface UserDataFilters {
|
|
4039
4114
|
/**
|
|
4040
|
-
* <p>
|
|
4115
|
+
* <p>A list of up to 100 queues or ARNs.</p>
|
|
4041
4116
|
*/
|
|
4042
4117
|
Queues?: string[];
|
|
4043
4118
|
/**
|
|
@@ -4045,6 +4120,18 @@ export interface UserDataFilters {
|
|
|
4045
4120
|
* It contains a list of contact states. </p>
|
|
4046
4121
|
*/
|
|
4047
4122
|
ContactFilter?: ContactFilter;
|
|
4123
|
+
/**
|
|
4124
|
+
* <p>A list of up to 100 routing profile IDs or ARNs.</p>
|
|
4125
|
+
*/
|
|
4126
|
+
RoutingProfiles?: string[];
|
|
4127
|
+
/**
|
|
4128
|
+
* <p>A list of up to 100 agent IDs or ARNs.</p>
|
|
4129
|
+
*/
|
|
4130
|
+
Agents?: string[];
|
|
4131
|
+
/**
|
|
4132
|
+
* <p>A UserHierarchyGroup ID or ARN.</p>
|
|
4133
|
+
*/
|
|
4134
|
+
UserHierarchyGroups?: string[];
|
|
4048
4135
|
}
|
|
4049
4136
|
export interface GetCurrentUserDataRequest {
|
|
4050
4137
|
/**
|
|
@@ -4052,9 +4139,28 @@ export interface GetCurrentUserDataRequest {
|
|
|
4052
4139
|
*/
|
|
4053
4140
|
InstanceId: string | undefined;
|
|
4054
4141
|
/**
|
|
4055
|
-
* <p>
|
|
4056
|
-
*
|
|
4057
|
-
*
|
|
4142
|
+
* <p>The filters to apply to returned user data. You can filter up to the following limits:</p>
|
|
4143
|
+
* <ul>
|
|
4144
|
+
* <li>
|
|
4145
|
+
* <p>Queues: 100</p>
|
|
4146
|
+
* </li>
|
|
4147
|
+
* <li>
|
|
4148
|
+
* <p>Routing profiles: 100</p>
|
|
4149
|
+
* </li>
|
|
4150
|
+
* <li>
|
|
4151
|
+
* <p>Agents: 100</p>
|
|
4152
|
+
* </li>
|
|
4153
|
+
* <li>
|
|
4154
|
+
* <p>Contact states: 9</p>
|
|
4155
|
+
* </li>
|
|
4156
|
+
* <li>
|
|
4157
|
+
* <p>User hierarchy groups: 1</p>
|
|
4158
|
+
* </li>
|
|
4159
|
+
* </ul>
|
|
4160
|
+
* <p> The user data is retrieved for only the specified
|
|
4161
|
+
* values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles,
|
|
4162
|
+
* agents, and user hierarchy groups. </p>
|
|
4163
|
+
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
4058
4164
|
*/
|
|
4059
4165
|
Filters: UserDataFilters | undefined;
|
|
4060
4166
|
/**
|
|
@@ -4105,19 +4211,6 @@ export interface HierarchyPathReference {
|
|
|
4105
4211
|
*/
|
|
4106
4212
|
LevelFive?: HierarchyGroupSummaryReference;
|
|
4107
4213
|
}
|
|
4108
|
-
/**
|
|
4109
|
-
* <p>Information about the routing profile assigned to the user.</p>
|
|
4110
|
-
*/
|
|
4111
|
-
export interface RoutingProfileReference {
|
|
4112
|
-
/**
|
|
4113
|
-
* <p>The identifier of the routing profile.</p>
|
|
4114
|
-
*/
|
|
4115
|
-
Id?: string;
|
|
4116
|
-
/**
|
|
4117
|
-
* <p>The Amazon Resource Name (ARN) of the routing profile.</p>
|
|
4118
|
-
*/
|
|
4119
|
-
Arn?: string;
|
|
4120
|
-
}
|
|
4121
4214
|
/**
|
|
4122
4215
|
* <p>Information about the user.</p>
|
|
4123
4216
|
*/
|
|
@@ -4173,6 +4266,10 @@ export interface UserData {
|
|
|
4173
4266
|
* <p>A list of contact reference information.</p>
|
|
4174
4267
|
*/
|
|
4175
4268
|
Contacts?: AgentContactReference[];
|
|
4269
|
+
/**
|
|
4270
|
+
* <p>The Next status of the agent.</p>
|
|
4271
|
+
*/
|
|
4272
|
+
NextStatus?: string;
|
|
4176
4273
|
}
|
|
4177
4274
|
export interface GetCurrentUserDataResponse {
|
|
4178
4275
|
/**
|
|
@@ -4183,6 +4280,10 @@ export interface GetCurrentUserDataResponse {
|
|
|
4183
4280
|
* <p>A list of the user data that is returned.</p>
|
|
4184
4281
|
*/
|
|
4185
4282
|
UserDataList?: UserData[];
|
|
4283
|
+
/**
|
|
4284
|
+
* <p>The total count of the result, regardless of the current page size.</p>
|
|
4285
|
+
*/
|
|
4286
|
+
ApproximateTotalCount?: number;
|
|
4186
4287
|
}
|
|
4187
4288
|
export interface GetFederationTokenRequest {
|
|
4188
4289
|
/**
|
|
@@ -4919,34 +5020,6 @@ export interface DateReference {
|
|
|
4919
5020
|
*/
|
|
4920
5021
|
Value?: string;
|
|
4921
5022
|
}
|
|
4922
|
-
/**
|
|
4923
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
|
|
4924
|
-
* Otherwise, null.</p>
|
|
4925
|
-
*/
|
|
4926
|
-
export interface EmailReference {
|
|
4927
|
-
/**
|
|
4928
|
-
* <p>Identifier of the email reference.</p>
|
|
4929
|
-
*/
|
|
4930
|
-
Name?: string;
|
|
4931
|
-
/**
|
|
4932
|
-
* <p>A valid email address.</p>
|
|
4933
|
-
*/
|
|
4934
|
-
Value?: string;
|
|
4935
|
-
}
|
|
4936
|
-
/**
|
|
4937
|
-
* <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
|
|
4938
|
-
* Otherwise, null.</p>
|
|
4939
|
-
*/
|
|
4940
|
-
export interface NumberReference {
|
|
4941
|
-
/**
|
|
4942
|
-
* <p>Identifier of the number reference.</p>
|
|
4943
|
-
*/
|
|
4944
|
-
Name?: string;
|
|
4945
|
-
/**
|
|
4946
|
-
* <p>A valid number.</p>
|
|
4947
|
-
*/
|
|
4948
|
-
Value?: string;
|
|
4949
|
-
}
|
|
4950
5023
|
/**
|
|
4951
5024
|
* @internal
|
|
4952
5025
|
*/
|
|
@@ -5699,6 +5772,10 @@ export declare const CurrentMetricFilterSensitiveLog: (obj: CurrentMetric) => an
|
|
|
5699
5772
|
* @internal
|
|
5700
5773
|
*/
|
|
5701
5774
|
export declare const FiltersFilterSensitiveLog: (obj: Filters) => any;
|
|
5775
|
+
/**
|
|
5776
|
+
* @internal
|
|
5777
|
+
*/
|
|
5778
|
+
export declare const CurrentMetricSortCriteriaFilterSensitiveLog: (obj: CurrentMetricSortCriteria) => any;
|
|
5702
5779
|
/**
|
|
5703
5780
|
* @internal
|
|
5704
5781
|
*/
|
|
@@ -5707,6 +5784,10 @@ export declare const GetCurrentMetricDataRequestFilterSensitiveLog: (obj: GetCur
|
|
|
5707
5784
|
* @internal
|
|
5708
5785
|
*/
|
|
5709
5786
|
export declare const CurrentMetricDataFilterSensitiveLog: (obj: CurrentMetricData) => any;
|
|
5787
|
+
/**
|
|
5788
|
+
* @internal
|
|
5789
|
+
*/
|
|
5790
|
+
export declare const RoutingProfileReferenceFilterSensitiveLog: (obj: RoutingProfileReference) => any;
|
|
5710
5791
|
/**
|
|
5711
5792
|
* @internal
|
|
5712
5793
|
*/
|
|
@@ -5739,10 +5820,6 @@ export declare const HierarchyGroupSummaryReferenceFilterSensitiveLog: (obj: Hie
|
|
|
5739
5820
|
* @internal
|
|
5740
5821
|
*/
|
|
5741
5822
|
export declare const HierarchyPathReferenceFilterSensitiveLog: (obj: HierarchyPathReference) => any;
|
|
5742
|
-
/**
|
|
5743
|
-
* @internal
|
|
5744
|
-
*/
|
|
5745
|
-
export declare const RoutingProfileReferenceFilterSensitiveLog: (obj: RoutingProfileReference) => any;
|
|
5746
5823
|
/**
|
|
5747
5824
|
* @internal
|
|
5748
5825
|
*/
|
|
@@ -5879,11 +5956,3 @@ export declare const AttachmentReferenceFilterSensitiveLog: (obj: AttachmentRefe
|
|
|
5879
5956
|
* @internal
|
|
5880
5957
|
*/
|
|
5881
5958
|
export declare const DateReferenceFilterSensitiveLog: (obj: DateReference) => any;
|
|
5882
|
-
/**
|
|
5883
|
-
* @internal
|
|
5884
|
-
*/
|
|
5885
|
-
export declare const EmailReferenceFilterSensitiveLog: (obj: EmailReference) => any;
|
|
5886
|
-
/**
|
|
5887
|
-
* @internal
|
|
5888
|
-
*/
|
|
5889
|
-
export declare const NumberReferenceFilterSensitiveLog: (obj: NumberReference) => any;
|
|
@@ -1,6 +1,34 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentStatusState, AttachmentReference, Attribute, Channel, ContactFlowModuleState, ContactFlowState, DateReference, DirectoryType,
|
|
3
|
+
import { ActionSummary, AgentStatusState, AttachmentReference, Attribute, Channel, ContactFlowModuleState, ContactFlowState, DateReference, DirectoryType, EventSourceName, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TelephonyConfig, TrafficDistributionGroupStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
|
|
6
|
+
* Otherwise, null.</p>
|
|
7
|
+
*/
|
|
8
|
+
export interface EmailReference {
|
|
9
|
+
/**
|
|
10
|
+
* <p>Identifier of the email reference.</p>
|
|
11
|
+
*/
|
|
12
|
+
Name?: string;
|
|
13
|
+
/**
|
|
14
|
+
* <p>A valid email address.</p>
|
|
15
|
+
*/
|
|
16
|
+
Value?: string;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
|
|
20
|
+
* Otherwise, null.</p>
|
|
21
|
+
*/
|
|
22
|
+
export interface NumberReference {
|
|
23
|
+
/**
|
|
24
|
+
* <p>Identifier of the number reference.</p>
|
|
25
|
+
*/
|
|
26
|
+
Name?: string;
|
|
27
|
+
/**
|
|
28
|
+
* <p>A valid number.</p>
|
|
29
|
+
*/
|
|
30
|
+
Value?: string;
|
|
31
|
+
}
|
|
4
32
|
/**
|
|
5
33
|
* <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
|
|
6
34
|
* Otherwise, null.</p>
|
|
@@ -2493,8 +2521,8 @@ export interface UpdateContactFlowContentRequest {
|
|
|
2493
2521
|
*/
|
|
2494
2522
|
ContactFlowId: string | undefined;
|
|
2495
2523
|
/**
|
|
2496
|
-
* <p>The JSON string that represents flow's content. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
|
|
2497
|
-
*
|
|
2524
|
+
* <p>The JSON string that represents flow's content. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example contact
|
|
2525
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
2498
2526
|
*/
|
|
2499
2527
|
Content: string | undefined;
|
|
2500
2528
|
}
|
|
@@ -2717,7 +2745,7 @@ export interface ParticipantTimerConfiguration {
|
|
|
2717
2745
|
ParticipantRole: TimerEligibleParticipantRoles | string | undefined;
|
|
2718
2746
|
/**
|
|
2719
2747
|
* <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human chat participant as idle.
|
|
2720
|
-
*
|
|
2748
|
+
* <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to automatically disconnecting a chat participant due to
|
|
2721
2749
|
* idleness.</p>
|
|
2722
2750
|
*/
|
|
2723
2751
|
TimerType: ParticipantTimerType | string | undefined;
|
|
@@ -3488,6 +3516,14 @@ export interface SearchUsersRequest {
|
|
|
3488
3516
|
*/
|
|
3489
3517
|
SearchCriteria?: UserSearchCriteria;
|
|
3490
3518
|
}
|
|
3519
|
+
/**
|
|
3520
|
+
* @internal
|
|
3521
|
+
*/
|
|
3522
|
+
export declare const EmailReferenceFilterSensitiveLog: (obj: EmailReference) => any;
|
|
3523
|
+
/**
|
|
3524
|
+
* @internal
|
|
3525
|
+
*/
|
|
3526
|
+
export declare const NumberReferenceFilterSensitiveLog: (obj: NumberReference) => any;
|
|
3491
3527
|
/**
|
|
3492
3528
|
* @internal
|
|
3493
3529
|
*/
|
|
@@ -80,6 +80,7 @@ export interface AgentStatus {
|
|
|
80
80
|
export interface AgentStatusReference {
|
|
81
81
|
StatusStartTimestamp?: Date;
|
|
82
82
|
StatusArn?: string;
|
|
83
|
+
StatusName?: string;
|
|
83
84
|
}
|
|
84
85
|
export interface AgentStatusSummary {
|
|
85
86
|
Id?: string;
|
|
@@ -1594,10 +1595,20 @@ export interface CurrentMetric {
|
|
|
1594
1595
|
export interface Filters {
|
|
1595
1596
|
Queues?: string[];
|
|
1596
1597
|
Channels?: (Channel | string)[];
|
|
1598
|
+
RoutingProfiles?: string[];
|
|
1597
1599
|
}
|
|
1598
1600
|
export declare enum Grouping {
|
|
1599
1601
|
CHANNEL = "CHANNEL",
|
|
1600
1602
|
QUEUE = "QUEUE",
|
|
1603
|
+
ROUTING_PROFILE = "ROUTING_PROFILE",
|
|
1604
|
+
}
|
|
1605
|
+
export declare enum SortOrder {
|
|
1606
|
+
ASCENDING = "ASCENDING",
|
|
1607
|
+
DESCENDING = "DESCENDING",
|
|
1608
|
+
}
|
|
1609
|
+
export interface CurrentMetricSortCriteria {
|
|
1610
|
+
SortByMetric?: CurrentMetricName | string;
|
|
1611
|
+
SortOrder?: SortOrder | string;
|
|
1601
1612
|
}
|
|
1602
1613
|
export interface GetCurrentMetricDataRequest {
|
|
1603
1614
|
InstanceId: string | undefined;
|
|
@@ -1606,14 +1617,20 @@ export interface GetCurrentMetricDataRequest {
|
|
|
1606
1617
|
CurrentMetrics: CurrentMetric[] | undefined;
|
|
1607
1618
|
NextToken?: string;
|
|
1608
1619
|
MaxResults?: number;
|
|
1620
|
+
SortCriteria?: CurrentMetricSortCriteria[];
|
|
1609
1621
|
}
|
|
1610
1622
|
export interface CurrentMetricData {
|
|
1611
1623
|
Metric?: CurrentMetric;
|
|
1612
1624
|
Value?: number;
|
|
1613
1625
|
}
|
|
1626
|
+
export interface RoutingProfileReference {
|
|
1627
|
+
Id?: string;
|
|
1628
|
+
Arn?: string;
|
|
1629
|
+
}
|
|
1614
1630
|
export interface Dimensions {
|
|
1615
1631
|
Queue?: QueueReference;
|
|
1616
1632
|
Channel?: Channel | string;
|
|
1633
|
+
RoutingProfile?: RoutingProfileReference;
|
|
1617
1634
|
}
|
|
1618
1635
|
export interface CurrentMetricResult {
|
|
1619
1636
|
Dimensions?: Dimensions;
|
|
@@ -1623,6 +1640,7 @@ export interface GetCurrentMetricDataResponse {
|
|
|
1623
1640
|
NextToken?: string;
|
|
1624
1641
|
MetricResults?: CurrentMetricResult[];
|
|
1625
1642
|
DataSnapshotTime?: Date;
|
|
1643
|
+
ApproximateTotalCount?: number;
|
|
1626
1644
|
}
|
|
1627
1645
|
export interface ContactFilter {
|
|
1628
1646
|
ContactStates?: (ContactState | string)[];
|
|
@@ -1630,6 +1648,9 @@ export interface ContactFilter {
|
|
|
1630
1648
|
export interface UserDataFilters {
|
|
1631
1649
|
Queues?: string[];
|
|
1632
1650
|
ContactFilter?: ContactFilter;
|
|
1651
|
+
RoutingProfiles?: string[];
|
|
1652
|
+
Agents?: string[];
|
|
1653
|
+
UserHierarchyGroups?: string[];
|
|
1633
1654
|
}
|
|
1634
1655
|
export interface GetCurrentUserDataRequest {
|
|
1635
1656
|
InstanceId: string | undefined;
|
|
@@ -1648,10 +1669,6 @@ export interface HierarchyPathReference {
|
|
|
1648
1669
|
LevelFour?: HierarchyGroupSummaryReference;
|
|
1649
1670
|
LevelFive?: HierarchyGroupSummaryReference;
|
|
1650
1671
|
}
|
|
1651
|
-
export interface RoutingProfileReference {
|
|
1652
|
-
Id?: string;
|
|
1653
|
-
Arn?: string;
|
|
1654
|
-
}
|
|
1655
1672
|
export interface UserReference {
|
|
1656
1673
|
Id?: string;
|
|
1657
1674
|
Arn?: string;
|
|
@@ -1665,10 +1682,12 @@ export interface UserData {
|
|
|
1665
1682
|
MaxSlotsByChannel?: Record<string, number>;
|
|
1666
1683
|
ActiveSlotsByChannel?: Record<string, number>;
|
|
1667
1684
|
Contacts?: AgentContactReference[];
|
|
1685
|
+
NextStatus?: string;
|
|
1668
1686
|
}
|
|
1669
1687
|
export interface GetCurrentUserDataResponse {
|
|
1670
1688
|
NextToken?: string;
|
|
1671
1689
|
UserDataList?: UserData[];
|
|
1690
|
+
ApproximateTotalCount?: number;
|
|
1672
1691
|
}
|
|
1673
1692
|
export interface GetFederationTokenRequest {
|
|
1674
1693
|
InstanceId: string | undefined;
|
|
@@ -1884,14 +1903,6 @@ export interface DateReference {
|
|
|
1884
1903
|
Name?: string;
|
|
1885
1904
|
Value?: string;
|
|
1886
1905
|
}
|
|
1887
|
-
export interface EmailReference {
|
|
1888
|
-
Name?: string;
|
|
1889
|
-
Value?: string;
|
|
1890
|
-
}
|
|
1891
|
-
export interface NumberReference {
|
|
1892
|
-
Name?: string;
|
|
1893
|
-
Value?: string;
|
|
1894
|
-
}
|
|
1895
1906
|
export declare const ActionSummaryFilterSensitiveLog: (
|
|
1896
1907
|
obj: ActionSummary
|
|
1897
1908
|
) => any;
|
|
@@ -2420,12 +2431,18 @@ export declare const CurrentMetricFilterSensitiveLog: (
|
|
|
2420
2431
|
obj: CurrentMetric
|
|
2421
2432
|
) => any;
|
|
2422
2433
|
export declare const FiltersFilterSensitiveLog: (obj: Filters) => any;
|
|
2434
|
+
export declare const CurrentMetricSortCriteriaFilterSensitiveLog: (
|
|
2435
|
+
obj: CurrentMetricSortCriteria
|
|
2436
|
+
) => any;
|
|
2423
2437
|
export declare const GetCurrentMetricDataRequestFilterSensitiveLog: (
|
|
2424
2438
|
obj: GetCurrentMetricDataRequest
|
|
2425
2439
|
) => any;
|
|
2426
2440
|
export declare const CurrentMetricDataFilterSensitiveLog: (
|
|
2427
2441
|
obj: CurrentMetricData
|
|
2428
2442
|
) => any;
|
|
2443
|
+
export declare const RoutingProfileReferenceFilterSensitiveLog: (
|
|
2444
|
+
obj: RoutingProfileReference
|
|
2445
|
+
) => any;
|
|
2429
2446
|
export declare const DimensionsFilterSensitiveLog: (obj: Dimensions) => any;
|
|
2430
2447
|
export declare const CurrentMetricResultFilterSensitiveLog: (
|
|
2431
2448
|
obj: CurrentMetricResult
|
|
@@ -2448,9 +2465,6 @@ export declare const HierarchyGroupSummaryReferenceFilterSensitiveLog: (
|
|
|
2448
2465
|
export declare const HierarchyPathReferenceFilterSensitiveLog: (
|
|
2449
2466
|
obj: HierarchyPathReference
|
|
2450
2467
|
) => any;
|
|
2451
|
-
export declare const RoutingProfileReferenceFilterSensitiveLog: (
|
|
2452
|
-
obj: RoutingProfileReference
|
|
2453
|
-
) => any;
|
|
2454
2468
|
export declare const UserReferenceFilterSensitiveLog: (
|
|
2455
2469
|
obj: UserReference
|
|
2456
2470
|
) => any;
|
|
@@ -2543,9 +2557,3 @@ export declare const AttachmentReferenceFilterSensitiveLog: (
|
|
|
2543
2557
|
export declare const DateReferenceFilterSensitiveLog: (
|
|
2544
2558
|
obj: DateReference
|
|
2545
2559
|
) => any;
|
|
2546
|
-
export declare const EmailReferenceFilterSensitiveLog: (
|
|
2547
|
-
obj: EmailReference
|
|
2548
|
-
) => any;
|
|
2549
|
-
export declare const NumberReferenceFilterSensitiveLog: (
|
|
2550
|
-
obj: NumberReference
|
|
2551
|
-
) => any;
|
|
@@ -10,7 +10,6 @@ import {
|
|
|
10
10
|
ContactFlowState,
|
|
11
11
|
DateReference,
|
|
12
12
|
DirectoryType,
|
|
13
|
-
EmailReference,
|
|
14
13
|
EventSourceName,
|
|
15
14
|
HierarchyGroupSummary,
|
|
16
15
|
HoursOfOperationConfig,
|
|
@@ -22,7 +21,6 @@ import {
|
|
|
22
21
|
LexBot,
|
|
23
22
|
MediaConcurrency,
|
|
24
23
|
MonitorCapability,
|
|
25
|
-
NumberReference,
|
|
26
24
|
OutboundCallerConfig,
|
|
27
25
|
PhoneNumberCountryCode,
|
|
28
26
|
PhoneNumberType,
|
|
@@ -48,6 +46,14 @@ import {
|
|
|
48
46
|
VocabularyLanguageCode,
|
|
49
47
|
VocabularyState,
|
|
50
48
|
} from "./models_0";
|
|
49
|
+
export interface EmailReference {
|
|
50
|
+
Name?: string;
|
|
51
|
+
Value?: string;
|
|
52
|
+
}
|
|
53
|
+
export interface NumberReference {
|
|
54
|
+
Name?: string;
|
|
55
|
+
Value?: string;
|
|
56
|
+
}
|
|
51
57
|
export interface StringReference {
|
|
52
58
|
Name?: string;
|
|
53
59
|
Value?: string;
|
|
@@ -1197,6 +1203,12 @@ export interface SearchUsersRequest {
|
|
|
1197
1203
|
SearchFilter?: UserSearchFilter;
|
|
1198
1204
|
SearchCriteria?: UserSearchCriteria;
|
|
1199
1205
|
}
|
|
1206
|
+
export declare const EmailReferenceFilterSensitiveLog: (
|
|
1207
|
+
obj: EmailReference
|
|
1208
|
+
) => any;
|
|
1209
|
+
export declare const NumberReferenceFilterSensitiveLog: (
|
|
1210
|
+
obj: NumberReference
|
|
1211
|
+
) => any;
|
|
1200
1212
|
export declare const StringReferenceFilterSensitiveLog: (
|
|
1201
1213
|
obj: StringReference
|
|
1202
1214
|
) => any;
|