@aws-sdk/client-connect 3.236.0 → 3.238.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/Connect.js +15 -0
- package/dist-cjs/commands/UpdateParticipantRoleConfigCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +19 -17
- package/dist-cjs/models/models_1.js +86 -6
- package/dist-cjs/protocols/Aws_restJson1.js +171 -5
- package/dist-es/Connect.js +15 -0
- package/dist-es/commands/UpdateParticipantRoleConfigCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +12 -9
- package/dist-es/models/models_1.js +72 -1
- package/dist-es/protocols/Aws_restJson1.js +165 -1
- package/dist-types/Connect.d.ts +24 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +54 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +135 -66
- package/dist-types/models/models_1.d.ts +196 -5
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/Connect.d.ts +17 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +29 -21
- package/dist-types/ts3.4/models/models_1.d.ts +105 -2
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -4
|
@@ -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 {
|
|
@@ -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>
|
|
@@ -1923,11 +1951,21 @@ export interface SearchVocabulariesResponse {
|
|
|
1923
1951
|
*/
|
|
1924
1952
|
export interface ChatMessage {
|
|
1925
1953
|
/**
|
|
1926
|
-
* <p>The type of the content. Supported types are <code>text/plain</code>.</p>
|
|
1954
|
+
* <p>The type of the content. Supported types are <code>text/plain</code>, <code>text/markdown</code>, and <code>application/json</code>.</p>
|
|
1927
1955
|
*/
|
|
1928
1956
|
ContentType: string | undefined;
|
|
1929
1957
|
/**
|
|
1930
|
-
* <p>The content of the chat message
|
|
1958
|
+
* <p>The content of the chat message. </p>
|
|
1959
|
+
* <ul>
|
|
1960
|
+
* <li>
|
|
1961
|
+
* <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are
|
|
1962
|
+
* Minimum of 1, Maximum of 1024. </p>
|
|
1963
|
+
* </li>
|
|
1964
|
+
* <li>
|
|
1965
|
+
* <p>For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of
|
|
1966
|
+
* 12000. </p>
|
|
1967
|
+
* </li>
|
|
1968
|
+
* </ul>
|
|
1931
1969
|
*/
|
|
1932
1970
|
Content: string | undefined;
|
|
1933
1971
|
}
|
|
@@ -1985,8 +2023,10 @@ export interface StartChatContactRequest {
|
|
|
1985
2023
|
*/
|
|
1986
2024
|
ChatDurationInMinutes?: number;
|
|
1987
2025
|
/**
|
|
1988
|
-
* <p>The supported chat message content types. Content types
|
|
1989
|
-
*
|
|
2026
|
+
* <p>The supported chat message content types. Content types must always contain <code>text/plain</code>. You
|
|
2027
|
+
* can then put any other supported type in the list. For example, all the following lists are valid
|
|
2028
|
+
* because they contain <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>, <code>[text/markdown,
|
|
2029
|
+
* text/plain]</code>, <code>[text/plain, application/json]</code>.</p>
|
|
1990
2030
|
*/
|
|
1991
2031
|
SupportedMessagingContentTypes?: string[];
|
|
1992
2032
|
}
|
|
@@ -2644,6 +2684,125 @@ export interface UpdateInstanceStorageConfigRequest {
|
|
|
2644
2684
|
*/
|
|
2645
2685
|
StorageConfig: InstanceStorageConfig | undefined;
|
|
2646
2686
|
}
|
|
2687
|
+
export declare enum TimerEligibleParticipantRoles {
|
|
2688
|
+
AGENT = "AGENT",
|
|
2689
|
+
CUSTOMER = "CUSTOMER"
|
|
2690
|
+
}
|
|
2691
|
+
export declare enum ParticipantTimerType {
|
|
2692
|
+
DISCONNECT_NONCUSTOMER = "DISCONNECT_NONCUSTOMER",
|
|
2693
|
+
IDLE = "IDLE"
|
|
2694
|
+
}
|
|
2695
|
+
export declare enum ParticipantTimerAction {
|
|
2696
|
+
Unset = "Unset"
|
|
2697
|
+
}
|
|
2698
|
+
/**
|
|
2699
|
+
* <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or
|
|
2700
|
+
* the duration of the timer in minutes. Only one value can be set.</p>
|
|
2701
|
+
* <p>For more information about how chat timeouts work, see
|
|
2702
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
|
|
2703
|
+
*/
|
|
2704
|
+
export declare type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
|
|
2705
|
+
export declare namespace ParticipantTimerValue {
|
|
2706
|
+
/**
|
|
2707
|
+
* <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a timer.</p>
|
|
2708
|
+
*/
|
|
2709
|
+
interface ParticipantTimerActionMember {
|
|
2710
|
+
ParticipantTimerAction: ParticipantTimerAction | string;
|
|
2711
|
+
ParticipantTimerDurationInMinutes?: never;
|
|
2712
|
+
$unknown?: never;
|
|
2713
|
+
}
|
|
2714
|
+
/**
|
|
2715
|
+
* <p>The duration of a timer, in minutes. </p>
|
|
2716
|
+
*/
|
|
2717
|
+
interface ParticipantTimerDurationInMinutesMember {
|
|
2718
|
+
ParticipantTimerAction?: never;
|
|
2719
|
+
ParticipantTimerDurationInMinutes: number;
|
|
2720
|
+
$unknown?: never;
|
|
2721
|
+
}
|
|
2722
|
+
interface $UnknownMember {
|
|
2723
|
+
ParticipantTimerAction?: never;
|
|
2724
|
+
ParticipantTimerDurationInMinutes?: never;
|
|
2725
|
+
$unknown: [string, any];
|
|
2726
|
+
}
|
|
2727
|
+
interface Visitor<T> {
|
|
2728
|
+
ParticipantTimerAction: (value: ParticipantTimerAction | string) => T;
|
|
2729
|
+
ParticipantTimerDurationInMinutes: (value: number) => T;
|
|
2730
|
+
_: (name: string, value: any) => T;
|
|
2731
|
+
}
|
|
2732
|
+
const visit: <T>(value: ParticipantTimerValue, visitor: Visitor<T>) => T;
|
|
2733
|
+
}
|
|
2734
|
+
/**
|
|
2735
|
+
* <p>Configuration information for the timer. After the timer configuration is set, it persists
|
|
2736
|
+
* for the duration of the chat. It persists across new contacts in the chain, for example, transfer
|
|
2737
|
+
* contacts.</p>
|
|
2738
|
+
* <p>For more information about how chat timeouts work, see
|
|
2739
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
|
|
2740
|
+
*/
|
|
2741
|
+
export interface ParticipantTimerConfiguration {
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>The role of the participant in the chat conversation.</p>
|
|
2744
|
+
*/
|
|
2745
|
+
ParticipantRole: TimerEligibleParticipantRoles | string | undefined;
|
|
2746
|
+
/**
|
|
2747
|
+
* <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human chat participant as idle.
|
|
2748
|
+
* <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to automatically disconnecting a chat participant due to
|
|
2749
|
+
* idleness.</p>
|
|
2750
|
+
*/
|
|
2751
|
+
TimerType: ParticipantTimerType | string | undefined;
|
|
2752
|
+
/**
|
|
2753
|
+
* <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration
|
|
2754
|
+
* of the timer in minutes. Only one value can be set.</p>
|
|
2755
|
+
*/
|
|
2756
|
+
TimerValue: ParticipantTimerValue | undefined;
|
|
2757
|
+
}
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>Configuration information for the chat participant role.</p>
|
|
2760
|
+
*/
|
|
2761
|
+
export interface ChatParticipantRoleConfig {
|
|
2762
|
+
/**
|
|
2763
|
+
* <p>A list of participant timers. You can specify any unique combination of role and timer type.
|
|
2764
|
+
* Duplicate entries error out the request with a 400.</p>
|
|
2765
|
+
*/
|
|
2766
|
+
ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
|
|
2767
|
+
}
|
|
2768
|
+
/**
|
|
2769
|
+
* <p>Configuration information for the chat participant role.</p>
|
|
2770
|
+
*/
|
|
2771
|
+
export declare type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember;
|
|
2772
|
+
export declare namespace UpdateParticipantRoleConfigChannelInfo {
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>Configuration information for the chat participant role.</p>
|
|
2775
|
+
*/
|
|
2776
|
+
interface ChatMember {
|
|
2777
|
+
Chat: ChatParticipantRoleConfig;
|
|
2778
|
+
$unknown?: never;
|
|
2779
|
+
}
|
|
2780
|
+
interface $UnknownMember {
|
|
2781
|
+
Chat?: never;
|
|
2782
|
+
$unknown: [string, any];
|
|
2783
|
+
}
|
|
2784
|
+
interface Visitor<T> {
|
|
2785
|
+
Chat: (value: ChatParticipantRoleConfig) => T;
|
|
2786
|
+
_: (name: string, value: any) => T;
|
|
2787
|
+
}
|
|
2788
|
+
const visit: <T>(value: UpdateParticipantRoleConfigChannelInfo, visitor: Visitor<T>) => T;
|
|
2789
|
+
}
|
|
2790
|
+
export interface UpdateParticipantRoleConfigRequest {
|
|
2791
|
+
/**
|
|
2792
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
2793
|
+
*/
|
|
2794
|
+
InstanceId: string | undefined;
|
|
2795
|
+
/**
|
|
2796
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
2797
|
+
*/
|
|
2798
|
+
ContactId: string | undefined;
|
|
2799
|
+
/**
|
|
2800
|
+
* <p>The Amazon Connect channel you want to configure.</p>
|
|
2801
|
+
*/
|
|
2802
|
+
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
|
|
2803
|
+
}
|
|
2804
|
+
export interface UpdateParticipantRoleConfigResponse {
|
|
2805
|
+
}
|
|
2647
2806
|
export interface UpdatePhoneNumberRequest {
|
|
2648
2807
|
/**
|
|
2649
2808
|
* <p>A unique identifier for the phone number.</p>
|
|
@@ -3357,6 +3516,14 @@ export interface SearchUsersRequest {
|
|
|
3357
3516
|
*/
|
|
3358
3517
|
SearchCriteria?: UserSearchCriteria;
|
|
3359
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;
|
|
3360
3527
|
/**
|
|
3361
3528
|
* @internal
|
|
3362
3529
|
*/
|
|
@@ -3949,6 +4116,30 @@ export declare const UpdateInstanceAttributeRequestFilterSensitiveLog: (obj: Upd
|
|
|
3949
4116
|
* @internal
|
|
3950
4117
|
*/
|
|
3951
4118
|
export declare const UpdateInstanceStorageConfigRequestFilterSensitiveLog: (obj: UpdateInstanceStorageConfigRequest) => any;
|
|
4119
|
+
/**
|
|
4120
|
+
* @internal
|
|
4121
|
+
*/
|
|
4122
|
+
export declare const ParticipantTimerValueFilterSensitiveLog: (obj: ParticipantTimerValue) => any;
|
|
4123
|
+
/**
|
|
4124
|
+
* @internal
|
|
4125
|
+
*/
|
|
4126
|
+
export declare const ParticipantTimerConfigurationFilterSensitiveLog: (obj: ParticipantTimerConfiguration) => any;
|
|
4127
|
+
/**
|
|
4128
|
+
* @internal
|
|
4129
|
+
*/
|
|
4130
|
+
export declare const ChatParticipantRoleConfigFilterSensitiveLog: (obj: ChatParticipantRoleConfig) => any;
|
|
4131
|
+
/**
|
|
4132
|
+
* @internal
|
|
4133
|
+
*/
|
|
4134
|
+
export declare const UpdateParticipantRoleConfigChannelInfoFilterSensitiveLog: (obj: UpdateParticipantRoleConfigChannelInfo) => any;
|
|
4135
|
+
/**
|
|
4136
|
+
* @internal
|
|
4137
|
+
*/
|
|
4138
|
+
export declare const UpdateParticipantRoleConfigRequestFilterSensitiveLog: (obj: UpdateParticipantRoleConfigRequest) => any;
|
|
4139
|
+
/**
|
|
4140
|
+
* @internal
|
|
4141
|
+
*/
|
|
4142
|
+
export declare const UpdateParticipantRoleConfigResponseFilterSensitiveLog: (obj: UpdateParticipantRoleConfigResponse) => any;
|
|
3952
4143
|
/**
|
|
3953
4144
|
* @internal
|
|
3954
4145
|
*/
|
|
@@ -145,6 +145,7 @@ import { UpdateContactScheduleCommandInput, UpdateContactScheduleCommandOutput }
|
|
|
145
145
|
import { UpdateHoursOfOperationCommandInput, UpdateHoursOfOperationCommandOutput } from "../commands/UpdateHoursOfOperationCommand";
|
|
146
146
|
import { UpdateInstanceAttributeCommandInput, UpdateInstanceAttributeCommandOutput } from "../commands/UpdateInstanceAttributeCommand";
|
|
147
147
|
import { UpdateInstanceStorageConfigCommandInput, UpdateInstanceStorageConfigCommandOutput } from "../commands/UpdateInstanceStorageConfigCommand";
|
|
148
|
+
import { UpdateParticipantRoleConfigCommandInput, UpdateParticipantRoleConfigCommandOutput } from "../commands/UpdateParticipantRoleConfigCommand";
|
|
148
149
|
import { UpdatePhoneNumberCommandInput, UpdatePhoneNumberCommandOutput } from "../commands/UpdatePhoneNumberCommand";
|
|
149
150
|
import { UpdateQueueHoursOfOperationCommandInput, UpdateQueueHoursOfOperationCommandOutput } from "../commands/UpdateQueueHoursOfOperationCommand";
|
|
150
151
|
import { UpdateQueueMaxContactsCommandInput, UpdateQueueMaxContactsCommandOutput } from "../commands/UpdateQueueMaxContactsCommand";
|
|
@@ -313,6 +314,7 @@ export declare const serializeAws_restJson1UpdateContactScheduleCommand: (input:
|
|
|
313
314
|
export declare const serializeAws_restJson1UpdateHoursOfOperationCommand: (input: UpdateHoursOfOperationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
314
315
|
export declare const serializeAws_restJson1UpdateInstanceAttributeCommand: (input: UpdateInstanceAttributeCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
315
316
|
export declare const serializeAws_restJson1UpdateInstanceStorageConfigCommand: (input: UpdateInstanceStorageConfigCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
317
|
+
export declare const serializeAws_restJson1UpdateParticipantRoleConfigCommand: (input: UpdateParticipantRoleConfigCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
316
318
|
export declare const serializeAws_restJson1UpdatePhoneNumberCommand: (input: UpdatePhoneNumberCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
317
319
|
export declare const serializeAws_restJson1UpdateQueueHoursOfOperationCommand: (input: UpdateQueueHoursOfOperationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
318
320
|
export declare const serializeAws_restJson1UpdateQueueMaxContactsCommand: (input: UpdateQueueMaxContactsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
@@ -481,6 +483,7 @@ export declare const deserializeAws_restJson1UpdateContactScheduleCommand: (outp
|
|
|
481
483
|
export declare const deserializeAws_restJson1UpdateHoursOfOperationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateHoursOfOperationCommandOutput>;
|
|
482
484
|
export declare const deserializeAws_restJson1UpdateInstanceAttributeCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateInstanceAttributeCommandOutput>;
|
|
483
485
|
export declare const deserializeAws_restJson1UpdateInstanceStorageConfigCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateInstanceStorageConfigCommandOutput>;
|
|
486
|
+
export declare const deserializeAws_restJson1UpdateParticipantRoleConfigCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateParticipantRoleConfigCommandOutput>;
|
|
484
487
|
export declare const deserializeAws_restJson1UpdatePhoneNumberCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdatePhoneNumberCommandOutput>;
|
|
485
488
|
export declare const deserializeAws_restJson1UpdateQueueHoursOfOperationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateQueueHoursOfOperationCommandOutput>;
|
|
486
489
|
export declare const deserializeAws_restJson1UpdateQueueMaxContactsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateQueueMaxContactsCommandOutput>;
|
|
@@ -579,6 +579,10 @@ import {
|
|
|
579
579
|
UpdateInstanceStorageConfigCommandInput,
|
|
580
580
|
UpdateInstanceStorageConfigCommandOutput,
|
|
581
581
|
} from "./commands/UpdateInstanceStorageConfigCommand";
|
|
582
|
+
import {
|
|
583
|
+
UpdateParticipantRoleConfigCommandInput,
|
|
584
|
+
UpdateParticipantRoleConfigCommandOutput,
|
|
585
|
+
} from "./commands/UpdateParticipantRoleConfigCommand";
|
|
582
586
|
import {
|
|
583
587
|
UpdatePhoneNumberCommandInput,
|
|
584
588
|
UpdatePhoneNumberCommandOutput,
|
|
@@ -2570,6 +2574,19 @@ export declare class Connect extends ConnectClient {
|
|
|
2570
2574
|
options: __HttpHandlerOptions,
|
|
2571
2575
|
cb: (err: any, data?: UpdateInstanceStorageConfigCommandOutput) => void
|
|
2572
2576
|
): void;
|
|
2577
|
+
updateParticipantRoleConfig(
|
|
2578
|
+
args: UpdateParticipantRoleConfigCommandInput,
|
|
2579
|
+
options?: __HttpHandlerOptions
|
|
2580
|
+
): Promise<UpdateParticipantRoleConfigCommandOutput>;
|
|
2581
|
+
updateParticipantRoleConfig(
|
|
2582
|
+
args: UpdateParticipantRoleConfigCommandInput,
|
|
2583
|
+
cb: (err: any, data?: UpdateParticipantRoleConfigCommandOutput) => void
|
|
2584
|
+
): void;
|
|
2585
|
+
updateParticipantRoleConfig(
|
|
2586
|
+
args: UpdateParticipantRoleConfigCommandInput,
|
|
2587
|
+
options: __HttpHandlerOptions,
|
|
2588
|
+
cb: (err: any, data?: UpdateParticipantRoleConfigCommandOutput) => void
|
|
2589
|
+
): void;
|
|
2573
2590
|
updatePhoneNumber(
|
|
2574
2591
|
args: UpdatePhoneNumberCommandInput,
|
|
2575
2592
|
options?: __HttpHandlerOptions
|
|
@@ -623,6 +623,10 @@ import {
|
|
|
623
623
|
UpdateInstanceStorageConfigCommandInput,
|
|
624
624
|
UpdateInstanceStorageConfigCommandOutput,
|
|
625
625
|
} from "./commands/UpdateInstanceStorageConfigCommand";
|
|
626
|
+
import {
|
|
627
|
+
UpdateParticipantRoleConfigCommandInput,
|
|
628
|
+
UpdateParticipantRoleConfigCommandOutput,
|
|
629
|
+
} from "./commands/UpdateParticipantRoleConfigCommand";
|
|
626
630
|
import {
|
|
627
631
|
UpdatePhoneNumberCommandInput,
|
|
628
632
|
UpdatePhoneNumberCommandOutput,
|
|
@@ -866,6 +870,7 @@ export declare type ServiceInputTypes =
|
|
|
866
870
|
| UpdateHoursOfOperationCommandInput
|
|
867
871
|
| UpdateInstanceAttributeCommandInput
|
|
868
872
|
| UpdateInstanceStorageConfigCommandInput
|
|
873
|
+
| UpdateParticipantRoleConfigCommandInput
|
|
869
874
|
| UpdatePhoneNumberCommandInput
|
|
870
875
|
| UpdateQueueHoursOfOperationCommandInput
|
|
871
876
|
| UpdateQueueMaxContactsCommandInput
|
|
@@ -1035,6 +1040,7 @@ export declare type ServiceOutputTypes =
|
|
|
1035
1040
|
| UpdateHoursOfOperationCommandOutput
|
|
1036
1041
|
| UpdateInstanceAttributeCommandOutput
|
|
1037
1042
|
| UpdateInstanceStorageConfigCommandOutput
|
|
1043
|
+
| UpdateParticipantRoleConfigCommandOutput
|
|
1038
1044
|
| UpdatePhoneNumberCommandOutput
|
|
1039
1045
|
| UpdateQueueHoursOfOperationCommandOutput
|
|
1040
1046
|
| UpdateQueueMaxContactsCommandOutput
|