@aws-sdk/client-connect 3.607.0 → 3.609.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/README.md +38 -0
- package/dist-cjs/index.js +178 -0
- package/dist-es/Connect.js +6 -0
- package/dist-es/commands/DescribeAuthenticationProfileCommand.js +24 -0
- package/dist-es/commands/ListAuthenticationProfilesCommand.js +24 -0
- package/dist-es/commands/UpdateAuthenticationProfileCommand.js +24 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/pagination/ListAuthenticationProfilesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +115 -0
- package/dist-types/Connect.d.ts +36 -1
- package/dist-types/ConnectClient.d.ts +20 -3
- package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +95 -0
- package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +89 -0
- package/dist-types/commands/ListUserHierarchyGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListUserProficienciesCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersCommand.d.ts +1 -2
- package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts +85 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +15 -1
- package/dist-types/models/models_0.d.ts +114 -69
- package/dist-types/models/models_1.d.ts +143 -141
- package/dist-types/models/models_2.d.ts +194 -6
- package/dist-types/pagination/ListAuthenticationProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/Connect.d.ts +51 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DescribeAuthenticationProfileCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListAuthenticationProfilesCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListUserHierarchyGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUserProficienciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/UpdateAuthenticationProfileCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +21 -14
- package/dist-types/ts3.4/models/models_1.d.ts +31 -37
- package/dist-types/ts3.4/models/models_2.d.ts +44 -2
- package/dist-types/ts3.4/pagination/ListAuthenticationProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +35 -35
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import { UpdateAuthenticationProfileRequest } from "../models/models_2";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateAuthenticationProfileCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateAuthenticationProfileCommandInput extends UpdateAuthenticationProfileRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateAuthenticationProfileCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateAuthenticationProfileCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateAuthenticationProfileCommand_base: {
|
|
25
|
+
new (input: UpdateAuthenticationProfileCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAuthenticationProfileCommandInput, UpdateAuthenticationProfileCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateAuthenticationProfileCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAuthenticationProfileCommandInput, UpdateAuthenticationProfileCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
31
|
+
* request access to this API, contact Amazon Web Services Support.</p>
|
|
32
|
+
* <p>Updates the selected authentication profile.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { ConnectClient, UpdateAuthenticationProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
37
|
+
* // const { ConnectClient, UpdateAuthenticationProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
38
|
+
* const client = new ConnectClient(config);
|
|
39
|
+
* const input = { // UpdateAuthenticationProfileRequest
|
|
40
|
+
* AuthenticationProfileId: "STRING_VALUE", // required
|
|
41
|
+
* InstanceId: "STRING_VALUE", // required
|
|
42
|
+
* Name: "STRING_VALUE",
|
|
43
|
+
* Description: "STRING_VALUE",
|
|
44
|
+
* AllowedIps: [ // IpCidrList
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* BlockedIps: [
|
|
48
|
+
* "STRING_VALUE",
|
|
49
|
+
* ],
|
|
50
|
+
* PeriodicSessionDuration: Number("int"),
|
|
51
|
+
* };
|
|
52
|
+
* const command = new UpdateAuthenticationProfileCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* // {};
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param UpdateAuthenticationProfileCommandInput - {@link UpdateAuthenticationProfileCommandInput}
|
|
59
|
+
* @returns {@link UpdateAuthenticationProfileCommandOutput}
|
|
60
|
+
* @see {@link UpdateAuthenticationProfileCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link UpdateAuthenticationProfileCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
65
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
68
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
71
|
+
* <p>The request is not valid.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The specified resource was not found.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ConnectServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
81
|
+
*
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export declare class UpdateAuthenticationProfileCommand extends UpdateAuthenticationProfileCommand_base {
|
|
85
|
+
}
|
|
@@ -69,6 +69,7 @@ export * from "./DeleteViewCommand";
|
|
|
69
69
|
export * from "./DeleteViewVersionCommand";
|
|
70
70
|
export * from "./DeleteVocabularyCommand";
|
|
71
71
|
export * from "./DescribeAgentStatusCommand";
|
|
72
|
+
export * from "./DescribeAuthenticationProfileCommand";
|
|
72
73
|
export * from "./DescribeContactCommand";
|
|
73
74
|
export * from "./DescribeContactEvaluationCommand";
|
|
74
75
|
export * from "./DescribeContactFlowCommand";
|
|
@@ -121,6 +122,7 @@ export * from "./ImportPhoneNumberCommand";
|
|
|
121
122
|
export * from "./ListAgentStatusesCommand";
|
|
122
123
|
export * from "./ListAnalyticsDataAssociationsCommand";
|
|
123
124
|
export * from "./ListApprovedOriginsCommand";
|
|
125
|
+
export * from "./ListAuthenticationProfilesCommand";
|
|
124
126
|
export * from "./ListBotsCommand";
|
|
125
127
|
export * from "./ListContactEvaluationsCommand";
|
|
126
128
|
export * from "./ListContactFlowModulesCommand";
|
|
@@ -203,6 +205,7 @@ export * from "./TransferContactCommand";
|
|
|
203
205
|
export * from "./UntagContactCommand";
|
|
204
206
|
export * from "./UntagResourceCommand";
|
|
205
207
|
export * from "./UpdateAgentStatusCommand";
|
|
208
|
+
export * from "./UpdateAuthenticationProfileCommand";
|
|
206
209
|
export * from "./UpdateContactAttributesCommand";
|
|
207
210
|
export * from "./UpdateContactCommand";
|
|
208
211
|
export * from "./UpdateContactEvaluationCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <
|
|
2
|
+
* <ul>
|
|
3
|
+
* <li>
|
|
4
|
+
* <p>
|
|
5
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect
|
|
6
|
+
* actions</a>
|
|
7
|
+
* </p>
|
|
8
|
+
* </li>
|
|
9
|
+
* <li>
|
|
10
|
+
* <p>
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html">Amazon Connect
|
|
12
|
+
* data types</a>
|
|
13
|
+
* </p>
|
|
14
|
+
* </li>
|
|
15
|
+
* </ul>
|
|
16
|
+
* <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
|
|
3
17
|
* manage a customer contact center and provide reliable customer engagement at any scale.</p>
|
|
4
18
|
* <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize
|
|
5
19
|
* contact routing. You can also resolve customer issues more efficiently by getting customers in
|
|
@@ -327,7 +327,7 @@ export interface AgentHierarchyGroup {
|
|
|
327
327
|
/**
|
|
328
328
|
* <p>A structure that defines search criteria for contacts using agent hierarchy group levels.
|
|
329
329
|
* For more information about agent hierarchies, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html">Set Up Agent Hierarchies</a> in the
|
|
330
|
-
*
|
|
330
|
+
* <i>Amazon Connect Administrator Guide</i>.</p>
|
|
331
331
|
* @public
|
|
332
332
|
*/
|
|
333
333
|
export interface AgentHierarchyGroups {
|
|
@@ -504,8 +504,8 @@ export interface AgentQualityMetrics {
|
|
|
504
504
|
}
|
|
505
505
|
/**
|
|
506
506
|
* <p>Can be used to define a list of preferred agents to target the contact within the queue.
|
|
507
|
-
*
|
|
508
|
-
*
|
|
507
|
+
* Note that agents must have the queue in their routing profile in order to be offered the
|
|
508
|
+
* contact.</p>
|
|
509
509
|
* @public
|
|
510
510
|
*/
|
|
511
511
|
export interface AgentsCriteria {
|
|
@@ -2064,7 +2064,7 @@ export interface ClaimPhoneNumberResponse {
|
|
|
2064
2064
|
*/
|
|
2065
2065
|
export interface CompleteAttachedFileUploadRequest {
|
|
2066
2066
|
/**
|
|
2067
|
-
* <p>The unique identifier of the Connect instance.</p>
|
|
2067
|
+
* <p>The unique identifier of the Amazon Connect instance.</p>
|
|
2068
2068
|
* @public
|
|
2069
2069
|
*/
|
|
2070
2070
|
InstanceId: string | undefined;
|
|
@@ -5707,6 +5707,116 @@ export interface DescribeAgentStatusResponse {
|
|
|
5707
5707
|
*/
|
|
5708
5708
|
AgentStatus?: AgentStatus;
|
|
5709
5709
|
}
|
|
5710
|
+
/**
|
|
5711
|
+
* @public
|
|
5712
|
+
*/
|
|
5713
|
+
export interface DescribeAuthenticationProfileRequest {
|
|
5714
|
+
/**
|
|
5715
|
+
* <p>A unique identifier for the authentication profile. </p>
|
|
5716
|
+
* @public
|
|
5717
|
+
*/
|
|
5718
|
+
AuthenticationProfileId: string | undefined;
|
|
5719
|
+
/**
|
|
5720
|
+
* <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>
|
|
5721
|
+
* @public
|
|
5722
|
+
*/
|
|
5723
|
+
InstanceId: string | undefined;
|
|
5724
|
+
}
|
|
5725
|
+
/**
|
|
5726
|
+
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
5727
|
+
* request access to this API, contact Amazon Web Services Support.</p>
|
|
5728
|
+
* <p>Information about an authentication profile. An authentication profile is a resource that
|
|
5729
|
+
* stores the authentication settings for users in your contact center. You use authentication
|
|
5730
|
+
* profiles to set up IP address range restrictions and session timeouts. For more information, see
|
|
5731
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html">Set IP address restrictions or session timeouts</a>.
|
|
5732
|
+
* </p>
|
|
5733
|
+
* @public
|
|
5734
|
+
*/
|
|
5735
|
+
export interface AuthenticationProfile {
|
|
5736
|
+
/**
|
|
5737
|
+
* <p>A unique identifier for the authentication profile. </p>
|
|
5738
|
+
* @public
|
|
5739
|
+
*/
|
|
5740
|
+
Id?: string;
|
|
5741
|
+
/**
|
|
5742
|
+
* <p>The Amazon Resource Name (ARN) for the authentication profile.</p>
|
|
5743
|
+
* @public
|
|
5744
|
+
*/
|
|
5745
|
+
Arn?: string;
|
|
5746
|
+
/**
|
|
5747
|
+
* <p>The name for the authentication profile.</p>
|
|
5748
|
+
* @public
|
|
5749
|
+
*/
|
|
5750
|
+
Name?: string;
|
|
5751
|
+
/**
|
|
5752
|
+
* <p>The description for the authentication profile.</p>
|
|
5753
|
+
* @public
|
|
5754
|
+
*/
|
|
5755
|
+
Description?: string;
|
|
5756
|
+
/**
|
|
5757
|
+
* <p>A list of IP address range strings that are allowed to access the Amazon Connect
|
|
5758
|
+
* instance. For more information about how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
|
|
5759
|
+
* IP address based access control</a> in the <i>Amazon Connect Administrator
|
|
5760
|
+
* Guide</i>.</p>
|
|
5761
|
+
* @public
|
|
5762
|
+
*/
|
|
5763
|
+
AllowedIps?: string[];
|
|
5764
|
+
/**
|
|
5765
|
+
* <p>A list of IP address range strings that are blocked from accessing the Amazon Connect
|
|
5766
|
+
* instance. For more information about how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
|
|
5767
|
+
* IP address based access control</a> in the <i>Amazon Connect Administrator
|
|
5768
|
+
* Guide</i>.</p>
|
|
5769
|
+
* @public
|
|
5770
|
+
*/
|
|
5771
|
+
BlockedIps?: string[];
|
|
5772
|
+
/**
|
|
5773
|
+
* <p>Shows whether the authentication profile is the default authentication profile for the
|
|
5774
|
+
* Amazon Connect instance. The default authentication profile applies to all agents in an
|
|
5775
|
+
* Amazon Connect instance, unless overridden by another authentication profile.</p>
|
|
5776
|
+
* @public
|
|
5777
|
+
*/
|
|
5778
|
+
IsDefault?: boolean;
|
|
5779
|
+
/**
|
|
5780
|
+
* <p>The timestamp when the authentication profile was created.</p>
|
|
5781
|
+
* @public
|
|
5782
|
+
*/
|
|
5783
|
+
CreatedTime?: Date;
|
|
5784
|
+
/**
|
|
5785
|
+
* <p>The timestamp when the authentication profile was last modified.</p>
|
|
5786
|
+
* @public
|
|
5787
|
+
*/
|
|
5788
|
+
LastModifiedTime?: Date;
|
|
5789
|
+
/**
|
|
5790
|
+
* <p>The Amazon Web Services Region where the authentication profile was last modified.</p>
|
|
5791
|
+
* @public
|
|
5792
|
+
*/
|
|
5793
|
+
LastModifiedRegion?: string;
|
|
5794
|
+
/**
|
|
5795
|
+
* <p>The short lived session duration configuration for users logged in to Amazon Connect, in
|
|
5796
|
+
* minutes. This value determines the maximum possible time before an agent is authenticated. For
|
|
5797
|
+
* more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure the session duration</a> in the <i>Amazon Connect Administrator
|
|
5798
|
+
* Guide</i>.</p>
|
|
5799
|
+
* @public
|
|
5800
|
+
*/
|
|
5801
|
+
PeriodicSessionDuration?: number;
|
|
5802
|
+
/**
|
|
5803
|
+
* <p>The long lived session duration for users logged in to Amazon Connect, in minutes. After
|
|
5804
|
+
* this time period, users must log in again. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure the session duration</a> in the <i>Amazon Connect Administrator
|
|
5805
|
+
* Guide</i>.</p>
|
|
5806
|
+
* @public
|
|
5807
|
+
*/
|
|
5808
|
+
MaxSessionDuration?: number;
|
|
5809
|
+
}
|
|
5810
|
+
/**
|
|
5811
|
+
* @public
|
|
5812
|
+
*/
|
|
5813
|
+
export interface DescribeAuthenticationProfileResponse {
|
|
5814
|
+
/**
|
|
5815
|
+
* <p>The authentication profile object being described.</p>
|
|
5816
|
+
* @public
|
|
5817
|
+
*/
|
|
5818
|
+
AuthenticationProfile?: AuthenticationProfile;
|
|
5819
|
+
}
|
|
5710
5820
|
/**
|
|
5711
5821
|
* @public
|
|
5712
5822
|
*/
|
|
@@ -6018,71 +6128,6 @@ export interface EvaluationAnswerOutput {
|
|
|
6018
6128
|
*/
|
|
6019
6129
|
SystemSuggestedValue?: EvaluationAnswerData;
|
|
6020
6130
|
}
|
|
6021
|
-
/**
|
|
6022
|
-
* <p>Information about scores of a contact evaluation item (section or question).</p>
|
|
6023
|
-
* @public
|
|
6024
|
-
*/
|
|
6025
|
-
export interface EvaluationScore {
|
|
6026
|
-
/**
|
|
6027
|
-
* <p>The score percentage for an item in a contact evaluation.</p>
|
|
6028
|
-
* @public
|
|
6029
|
-
*/
|
|
6030
|
-
Percentage?: number;
|
|
6031
|
-
/**
|
|
6032
|
-
* <p>The flag to mark the item as not applicable for scoring.</p>
|
|
6033
|
-
* @public
|
|
6034
|
-
*/
|
|
6035
|
-
NotApplicable?: boolean;
|
|
6036
|
-
/**
|
|
6037
|
-
* <p>The flag that marks the item as automatic fail. If the item or a child item gets an
|
|
6038
|
-
* automatic fail answer, this flag will be true.</p>
|
|
6039
|
-
* @public
|
|
6040
|
-
*/
|
|
6041
|
-
AutomaticFail?: boolean;
|
|
6042
|
-
}
|
|
6043
|
-
/**
|
|
6044
|
-
* <p>Metadata information about a contact evaluation.</p>
|
|
6045
|
-
* @public
|
|
6046
|
-
*/
|
|
6047
|
-
export interface EvaluationMetadata {
|
|
6048
|
-
/**
|
|
6049
|
-
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
6050
|
-
* @public
|
|
6051
|
-
*/
|
|
6052
|
-
ContactId: string | undefined;
|
|
6053
|
-
/**
|
|
6054
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
|
|
6055
|
-
* @public
|
|
6056
|
-
*/
|
|
6057
|
-
EvaluatorArn: string | undefined;
|
|
6058
|
-
/**
|
|
6059
|
-
* <p>The identifier of the agent who performed the contact.</p>
|
|
6060
|
-
* @public
|
|
6061
|
-
*/
|
|
6062
|
-
ContactAgentId?: string;
|
|
6063
|
-
/**
|
|
6064
|
-
* <p>The overall score of the contact evaluation.</p>
|
|
6065
|
-
* @public
|
|
6066
|
-
*/
|
|
6067
|
-
Score?: EvaluationScore;
|
|
6068
|
-
}
|
|
6069
|
-
/**
|
|
6070
|
-
* <p>Information about notes for a contact evaluation.</p>
|
|
6071
|
-
* @public
|
|
6072
|
-
*/
|
|
6073
|
-
export interface EvaluationNote {
|
|
6074
|
-
/**
|
|
6075
|
-
* <p>The note for an item (section or question) in a contact evaluation.</p>
|
|
6076
|
-
* <note>
|
|
6077
|
-
* <p>Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the
|
|
6078
|
-
* total number of chars for all the notes in the evaluation combined. Assuming there are N
|
|
6079
|
-
* questions in the evaluation being submitted, then the max char limit for all notes combined is N
|
|
6080
|
-
* x 1024.</p>
|
|
6081
|
-
* </note>
|
|
6082
|
-
* @public
|
|
6083
|
-
*/
|
|
6084
|
-
Value?: string;
|
|
6085
|
-
}
|
|
6086
6131
|
/**
|
|
6087
6132
|
* @internal
|
|
6088
6133
|
*/
|
|
@@ -1,6 +1,71 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EvaluationAnswerOutput,
|
|
3
|
+
import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EvaluationAnswerOutput, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* <p>Information about scores of a contact evaluation item (section or question).</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface EvaluationScore {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The score percentage for an item in a contact evaluation.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
Percentage?: number;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The flag to mark the item as not applicable for scoring.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
NotApplicable?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The flag that marks the item as automatic fail. If the item or a child item gets an
|
|
21
|
+
* automatic fail answer, this flag will be true.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
AutomaticFail?: boolean;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* <p>Metadata information about a contact evaluation.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export interface EvaluationMetadata {
|
|
31
|
+
/**
|
|
32
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
ContactId: string | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
EvaluatorArn: string | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>The identifier of the agent who performed the contact.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
ContactAgentId?: string;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The overall score of the contact evaluation.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
Score?: EvaluationScore;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* <p>Information about notes for a contact evaluation.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface EvaluationNote {
|
|
57
|
+
/**
|
|
58
|
+
* <p>The note for an item (section or question) in a contact evaluation.</p>
|
|
59
|
+
* <note>
|
|
60
|
+
* <p>Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the
|
|
61
|
+
* total number of chars for all the notes in the evaluation combined. Assuming there are N
|
|
62
|
+
* questions in the evaluation being submitted, then the max char limit for all notes combined is N
|
|
63
|
+
* x 1024.</p>
|
|
64
|
+
* </note>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
Value?: string;
|
|
68
|
+
}
|
|
4
69
|
/**
|
|
5
70
|
* @public
|
|
6
71
|
* @enum
|
|
@@ -5296,6 +5361,83 @@ export interface ListApprovedOriginsResponse {
|
|
|
5296
5361
|
*/
|
|
5297
5362
|
NextToken?: string;
|
|
5298
5363
|
}
|
|
5364
|
+
/**
|
|
5365
|
+
* @public
|
|
5366
|
+
*/
|
|
5367
|
+
export interface ListAuthenticationProfilesRequest {
|
|
5368
|
+
/**
|
|
5369
|
+
* <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>
|
|
5370
|
+
* @public
|
|
5371
|
+
*/
|
|
5372
|
+
InstanceId: string | undefined;
|
|
5373
|
+
/**
|
|
5374
|
+
* <p>The maximum number of results to return per page.</p>
|
|
5375
|
+
* @public
|
|
5376
|
+
*/
|
|
5377
|
+
MaxResults?: number;
|
|
5378
|
+
/**
|
|
5379
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5380
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
5381
|
+
* @public
|
|
5382
|
+
*/
|
|
5383
|
+
NextToken?: string;
|
|
5384
|
+
}
|
|
5385
|
+
/**
|
|
5386
|
+
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
5387
|
+
* request access to this API, contact Amazon Web Services Support.</p>
|
|
5388
|
+
* <p>A summary of a given authentication profile.</p>
|
|
5389
|
+
* @public
|
|
5390
|
+
*/
|
|
5391
|
+
export interface AuthenticationProfileSummary {
|
|
5392
|
+
/**
|
|
5393
|
+
* <p>The unique identifier of the authentication profile.</p>
|
|
5394
|
+
* @public
|
|
5395
|
+
*/
|
|
5396
|
+
Id?: string;
|
|
5397
|
+
/**
|
|
5398
|
+
* <p>The Amazon Resource Name (ARN) of the authentication profile summary.</p>
|
|
5399
|
+
* @public
|
|
5400
|
+
*/
|
|
5401
|
+
Arn?: string;
|
|
5402
|
+
/**
|
|
5403
|
+
* <p>The name of the authentication profile summary.</p>
|
|
5404
|
+
* @public
|
|
5405
|
+
*/
|
|
5406
|
+
Name?: string;
|
|
5407
|
+
/**
|
|
5408
|
+
* <p>Shows whether the authentication profile is the default authentication profile for the
|
|
5409
|
+
* Amazon Connect instance. The default authentication profile applies to all agents in an
|
|
5410
|
+
* Amazon Connect instance, unless overridden by another authentication profile.</p>
|
|
5411
|
+
* @public
|
|
5412
|
+
*/
|
|
5413
|
+
IsDefault?: boolean;
|
|
5414
|
+
/**
|
|
5415
|
+
* <p>The timestamp when the authentication profile summary was last modified.</p>
|
|
5416
|
+
* @public
|
|
5417
|
+
*/
|
|
5418
|
+
LastModifiedTime?: Date;
|
|
5419
|
+
/**
|
|
5420
|
+
* <p>The Amazon Web Services Region when the authentication profile summary was last
|
|
5421
|
+
* modified.</p>
|
|
5422
|
+
* @public
|
|
5423
|
+
*/
|
|
5424
|
+
LastModifiedRegion?: string;
|
|
5425
|
+
}
|
|
5426
|
+
/**
|
|
5427
|
+
* @public
|
|
5428
|
+
*/
|
|
5429
|
+
export interface ListAuthenticationProfilesResponse {
|
|
5430
|
+
/**
|
|
5431
|
+
* <p>A summary of a given authentication profile.</p>
|
|
5432
|
+
* @public
|
|
5433
|
+
*/
|
|
5434
|
+
AuthenticationProfileSummaryList?: AuthenticationProfileSummary[];
|
|
5435
|
+
/**
|
|
5436
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5437
|
+
* @public
|
|
5438
|
+
*/
|
|
5439
|
+
NextToken?: string;
|
|
5440
|
+
}
|
|
5299
5441
|
/**
|
|
5300
5442
|
* @public
|
|
5301
5443
|
* @enum
|
|
@@ -8516,146 +8658,6 @@ export interface ListUseCasesResponse {
|
|
|
8516
8658
|
*/
|
|
8517
8659
|
NextToken?: string;
|
|
8518
8660
|
}
|
|
8519
|
-
/**
|
|
8520
|
-
* @public
|
|
8521
|
-
*/
|
|
8522
|
-
export interface ListUserHierarchyGroupsRequest {
|
|
8523
|
-
/**
|
|
8524
|
-
* <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>
|
|
8525
|
-
* @public
|
|
8526
|
-
*/
|
|
8527
|
-
InstanceId: string | undefined;
|
|
8528
|
-
/**
|
|
8529
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8530
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8531
|
-
* @public
|
|
8532
|
-
*/
|
|
8533
|
-
NextToken?: string;
|
|
8534
|
-
/**
|
|
8535
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8536
|
-
* @public
|
|
8537
|
-
*/
|
|
8538
|
-
MaxResults?: number;
|
|
8539
|
-
}
|
|
8540
|
-
/**
|
|
8541
|
-
* @public
|
|
8542
|
-
*/
|
|
8543
|
-
export interface ListUserHierarchyGroupsResponse {
|
|
8544
|
-
/**
|
|
8545
|
-
* <p>Information about the hierarchy groups.</p>
|
|
8546
|
-
* @public
|
|
8547
|
-
*/
|
|
8548
|
-
UserHierarchyGroupSummaryList?: HierarchyGroupSummary[];
|
|
8549
|
-
/**
|
|
8550
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8551
|
-
* @public
|
|
8552
|
-
*/
|
|
8553
|
-
NextToken?: string;
|
|
8554
|
-
}
|
|
8555
|
-
/**
|
|
8556
|
-
* @public
|
|
8557
|
-
*/
|
|
8558
|
-
export interface ListUserProficienciesRequest {
|
|
8559
|
-
/**
|
|
8560
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
8561
|
-
* Name (ARN) of the instance.</p>
|
|
8562
|
-
* @public
|
|
8563
|
-
*/
|
|
8564
|
-
InstanceId: string | undefined;
|
|
8565
|
-
/**
|
|
8566
|
-
* <p>The identifier of the user account.</p>
|
|
8567
|
-
* @public
|
|
8568
|
-
*/
|
|
8569
|
-
UserId: string | undefined;
|
|
8570
|
-
/**
|
|
8571
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
8572
|
-
* the next request to retrieve the next set of results.</p>
|
|
8573
|
-
* @public
|
|
8574
|
-
*/
|
|
8575
|
-
NextToken?: string;
|
|
8576
|
-
/**
|
|
8577
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8578
|
-
* @public
|
|
8579
|
-
*/
|
|
8580
|
-
MaxResults?: number;
|
|
8581
|
-
}
|
|
8582
|
-
/**
|
|
8583
|
-
* @public
|
|
8584
|
-
*/
|
|
8585
|
-
export interface ListUserProficienciesResponse {
|
|
8586
|
-
/**
|
|
8587
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8588
|
-
* @public
|
|
8589
|
-
*/
|
|
8590
|
-
NextToken?: string;
|
|
8591
|
-
/**
|
|
8592
|
-
* <p>Information about the user proficiencies.</p>
|
|
8593
|
-
* @public
|
|
8594
|
-
*/
|
|
8595
|
-
UserProficiencyList?: UserProficiency[];
|
|
8596
|
-
/**
|
|
8597
|
-
* <p>The last time that the user's proficiencies are were modified.</p>
|
|
8598
|
-
* @public
|
|
8599
|
-
*/
|
|
8600
|
-
LastModifiedTime?: Date;
|
|
8601
|
-
/**
|
|
8602
|
-
* <p>The region in which a user's proficiencies were last modified.</p>
|
|
8603
|
-
* @public
|
|
8604
|
-
*/
|
|
8605
|
-
LastModifiedRegion?: string;
|
|
8606
|
-
}
|
|
8607
|
-
/**
|
|
8608
|
-
* @public
|
|
8609
|
-
*/
|
|
8610
|
-
export interface ListUsersRequest {
|
|
8611
|
-
/**
|
|
8612
|
-
* <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>
|
|
8613
|
-
* @public
|
|
8614
|
-
*/
|
|
8615
|
-
InstanceId: string | undefined;
|
|
8616
|
-
/**
|
|
8617
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8618
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8619
|
-
* @public
|
|
8620
|
-
*/
|
|
8621
|
-
NextToken?: string;
|
|
8622
|
-
/**
|
|
8623
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8624
|
-
* @public
|
|
8625
|
-
*/
|
|
8626
|
-
MaxResults?: number;
|
|
8627
|
-
}
|
|
8628
|
-
/**
|
|
8629
|
-
* <p>Contains summary information about a user.</p>
|
|
8630
|
-
* @public
|
|
8631
|
-
*/
|
|
8632
|
-
export interface UserSummary {
|
|
8633
|
-
/**
|
|
8634
|
-
* <p>The identifier of the user account.</p>
|
|
8635
|
-
* @public
|
|
8636
|
-
*/
|
|
8637
|
-
Id?: string;
|
|
8638
|
-
/**
|
|
8639
|
-
* <p>The Amazon Resource Name (ARN) of the user account.</p>
|
|
8640
|
-
* @public
|
|
8641
|
-
*/
|
|
8642
|
-
Arn?: string;
|
|
8643
|
-
/**
|
|
8644
|
-
* <p>The Amazon Connect user name of the user account.</p>
|
|
8645
|
-
* @public
|
|
8646
|
-
*/
|
|
8647
|
-
Username?: string;
|
|
8648
|
-
/**
|
|
8649
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
8650
|
-
* @public
|
|
8651
|
-
*/
|
|
8652
|
-
LastModifiedTime?: Date;
|
|
8653
|
-
/**
|
|
8654
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8655
|
-
* @public
|
|
8656
|
-
*/
|
|
8657
|
-
LastModifiedRegion?: string;
|
|
8658
|
-
}
|
|
8659
8661
|
/**
|
|
8660
8662
|
* @internal
|
|
8661
8663
|
*/
|