@aws-sdk/client-connect 3.863.0 → 3.865.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 +8 -0
- package/dist-cjs/index.js +110 -27
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/GetContactMetricsCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_1.js +11 -0
- package/dist-es/models/models_2.js +0 -25
- package/dist-es/models/models_3.js +25 -0
- package/dist-es/protocols/Aws_restJson1.js +51 -0
- package/dist-types/Connect.d.ts +7 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/AssociateQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/CreateAgentStatusCommand.d.ts +1 -2
- package/dist-types/commands/CreateHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +3 -3
- package/dist-types/commands/CreateViewCommand.d.ts +4 -1
- package/dist-types/commands/CreateViewVersionCommand.d.ts +4 -1
- package/dist-types/commands/DeleteHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +4 -1
- package/dist-types/commands/DeleteQueueCommand.d.ts +4 -1
- package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +4 -1
- package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +4 -1
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +4 -1
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +4 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +4 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +4 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +4 -1
- package/dist-types/commands/DescribeAgentStatusCommand.d.ts +1 -2
- package/dist-types/commands/DescribeHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/DescribeQueueCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/GetContactMetricsCommand.d.ts +117 -0
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +37 -0
- package/dist-types/commands/GetMetricDataV2Command.d.ts +37 -0
- package/dist-types/commands/ListAgentStatusesCommand.d.ts +1 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +1 -1
- package/dist-types/commands/ListLexBotsCommand.d.ts +1 -1
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +1 -2
- package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +4 -1
- package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -2
- package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +4 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +4 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueStatusCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +4 -1
- package/dist-types/commands/UpdateViewContentCommand.d.ts +4 -1
- package/dist-types/commands/UpdateViewMetadataCommand.d.ts +4 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +6 -7
- package/dist-types/models/models_1.d.ts +517 -150
- package/dist-types/models/models_2.d.ts +130 -144
- package/dist-types/models/models_3.d.ts +143 -6
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -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/GetContactMetricsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListLambdaFunctionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLexBotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +40 -31
- package/dist-types/ts3.4/models/models_2.d.ts +33 -67
- package/dist-types/ts3.4/models/models_3.d.ts +68 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
|
@@ -109,7 +109,10 @@ declare const CreateViewCommand_base: {
|
|
|
109
109
|
* <p>The request is not valid.</p>
|
|
110
110
|
*
|
|
111
111
|
* @throws {@link ResourceInUseException} (client fault)
|
|
112
|
-
* <p>That resource is already in use
|
|
112
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
113
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
114
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
115
|
+
* and then try again.</p>
|
|
113
116
|
*
|
|
114
117
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
115
118
|
* <p>The specified resource was not found.</p>
|
|
@@ -93,7 +93,10 @@ declare const CreateViewVersionCommand_base: {
|
|
|
93
93
|
* <p>The request is not valid.</p>
|
|
94
94
|
*
|
|
95
95
|
* @throws {@link ResourceInUseException} (client fault)
|
|
96
|
-
* <p>That resource is already in use
|
|
96
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
97
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
98
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
99
|
+
* and then try again.</p>
|
|
97
100
|
*
|
|
98
101
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
99
102
|
* <p>The specified resource was not found.</p>
|
|
@@ -27,8 +27,7 @@ declare const DeleteHoursOfOperationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Deletes an hours of operation.</p>
|
|
30
|
+
* <p>Deletes an hours of operation.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ declare const DeleteHoursOfOperationOverrideCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes an hours of operation override in an Amazon Connect hours of operation
|
|
31
|
-
* resource
|
|
31
|
+
* resource.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -60,7 +60,10 @@ declare const DeletePredefinedAttributeCommand_base: {
|
|
|
60
60
|
* <p>The request is not valid.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ResourceInUseException} (client fault)
|
|
63
|
-
* <p>That resource is already in use
|
|
63
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
64
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
65
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
66
|
+
* and then try again.</p>
|
|
64
67
|
*
|
|
65
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
69
|
* <p>The specified resource was not found.</p>
|
|
@@ -60,7 +60,10 @@ declare const DeleteQueueCommand_base: {
|
|
|
60
60
|
* <p>The request is not valid.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ResourceInUseException} (client fault)
|
|
63
|
-
* <p>That resource is already in use
|
|
63
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
64
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
65
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
66
|
+
* and then try again.</p>
|
|
64
67
|
*
|
|
65
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
69
|
* <p>The specified resource was not found.</p>
|
|
@@ -60,7 +60,10 @@ declare const DeleteRoutingProfileCommand_base: {
|
|
|
60
60
|
* <p>The request is not valid.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ResourceInUseException} (client fault)
|
|
63
|
-
* <p>That resource is already in use
|
|
63
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
64
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
65
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
66
|
+
* and then try again.</p>
|
|
64
67
|
*
|
|
65
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
69
|
* <p>The specified resource was not found.</p>
|
|
@@ -63,7 +63,10 @@ declare const DeleteSecurityProfileCommand_base: {
|
|
|
63
63
|
* <p>The request is not valid.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ResourceInUseException} (client fault)
|
|
66
|
-
* <p>That resource is already in use
|
|
66
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
67
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
68
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
69
|
+
* and then try again.</p>
|
|
67
70
|
*
|
|
68
71
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
72
|
* <p>The specified resource was not found.</p>
|
|
@@ -62,7 +62,10 @@ declare const DeleteTrafficDistributionGroupCommand_base: {
|
|
|
62
62
|
* <p>The request is not valid.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ResourceInUseException} (client fault)
|
|
65
|
-
* <p>That resource is already in use
|
|
65
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
66
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
67
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
68
|
+
* and then try again.</p>
|
|
66
69
|
*
|
|
67
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
68
71
|
* <p>The throttling limit has been exceeded.</p>
|
|
@@ -61,7 +61,10 @@ declare const DeleteUserHierarchyGroupCommand_base: {
|
|
|
61
61
|
* <p>The request is not valid.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ResourceInUseException} (client fault)
|
|
64
|
-
* <p>That resource is already in use
|
|
64
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
65
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
66
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
67
|
+
* and then try again.</p>
|
|
65
68
|
*
|
|
66
69
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
70
|
* <p>The specified resource was not found.</p>
|
|
@@ -64,7 +64,10 @@ declare const DeleteViewCommand_base: {
|
|
|
64
64
|
* <p>The request is not valid.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ResourceInUseException} (client fault)
|
|
67
|
-
* <p>That resource is already in use
|
|
67
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
68
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
69
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
70
|
+
* and then try again.</p>
|
|
68
71
|
*
|
|
69
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
73
|
* <p>The specified resource was not found.</p>
|
|
@@ -64,7 +64,10 @@ declare const DeleteViewVersionCommand_base: {
|
|
|
64
64
|
* <p>The request is not valid.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ResourceInUseException} (client fault)
|
|
67
|
-
* <p>That resource is already in use
|
|
67
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
68
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
69
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
70
|
+
* and then try again.</p>
|
|
68
71
|
*
|
|
69
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
73
|
* <p>The specified resource was not found.</p>
|
|
@@ -64,7 +64,10 @@ declare const DeleteVocabularyCommand_base: {
|
|
|
64
64
|
* <p>The request is not valid.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ResourceInUseException} (client fault)
|
|
67
|
-
* <p>That resource is already in use
|
|
67
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
68
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
69
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
70
|
+
* and then try again.</p>
|
|
68
71
|
*
|
|
69
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
73
|
* <p>The specified resource was not found.</p>
|
|
@@ -27,8 +27,7 @@ declare const DescribeAgentStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Describes an agent status.</p>
|
|
30
|
+
* <p>Describes an agent status.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const DescribeHoursOfOperationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Describes the hours of operation.</p>
|
|
30
|
+
* <p>Describes the hours of operation.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const DescribeQueueCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Describes the specified queue.</p>
|
|
30
|
+
* <p>Describes the specified queue.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const DisassociateQueueQuickConnectsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Disassociates a set of quick connects from a queue.</p>
|
|
30
|
+
* <p>Disassociates a set of quick connects from a queue.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -0,0 +1,117 @@
|
|
|
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 { GetContactMetricsRequest, GetContactMetricsResponse } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetContactMetricsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetContactMetricsCommandInput extends GetContactMetricsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetContactMetricsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetContactMetricsCommandOutput extends GetContactMetricsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetContactMetricsCommand_base: {
|
|
25
|
+
new (input: GetContactMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<GetContactMetricsCommandInput, GetContactMetricsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetContactMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<GetContactMetricsCommandInput, GetContactMetricsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets the real-time metrics of the specified contact.</p>
|
|
31
|
+
* <p>
|
|
32
|
+
* <b>Use cases</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <p>Following are common uses cases for this API:</p>
|
|
35
|
+
* <ul>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>You can use this API to retrieve the position of the contact in the queue.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* </ul>
|
|
40
|
+
* <p>
|
|
41
|
+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
|
|
42
|
+
* quotas</a>.</p>
|
|
43
|
+
* @example
|
|
44
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
45
|
+
* ```javascript
|
|
46
|
+
* import { ConnectClient, GetContactMetricsCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
47
|
+
* // const { ConnectClient, GetContactMetricsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
48
|
+
* const client = new ConnectClient(config);
|
|
49
|
+
* const input = { // GetContactMetricsRequest
|
|
50
|
+
* InstanceId: "STRING_VALUE", // required
|
|
51
|
+
* ContactId: "STRING_VALUE", // required
|
|
52
|
+
* Metrics: [ // ContactMetrics // required
|
|
53
|
+
* { // ContactMetricInfo
|
|
54
|
+
* Name: "POSITION_IN_QUEUE", // required
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* };
|
|
58
|
+
* const command = new GetContactMetricsCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* // { // GetContactMetricsResponse
|
|
61
|
+
* // MetricResults: [ // ContactMetricResults
|
|
62
|
+
* // { // ContactMetricResult
|
|
63
|
+
* // Name: "POSITION_IN_QUEUE", // required
|
|
64
|
+
* // Value: { // ContactMetricValue Union: only one key present
|
|
65
|
+
* // Number: Number("double"),
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // Id: "STRING_VALUE",
|
|
70
|
+
* // Arn: "STRING_VALUE",
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param GetContactMetricsCommandInput - {@link GetContactMetricsCommandInput}
|
|
76
|
+
* @returns {@link GetContactMetricsCommandOutput}
|
|
77
|
+
* @see {@link GetContactMetricsCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link GetContactMetricsCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
85
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
88
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
91
|
+
* <p>The request is not valid.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
+
* <p>The specified resource was not found.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
97
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ConnectServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class GetContactMetricsCommand extends GetContactMetricsCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: GetContactMetricsRequest;
|
|
110
|
+
output: GetContactMetricsResponse;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: GetContactMetricsCommandInput;
|
|
114
|
+
output: GetContactMetricsCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -30,6 +30,43 @@ declare const GetCurrentMetricDataCommand_base: {
|
|
|
30
30
|
* <p>Gets the real-time metric data from the specified Amazon Connect instance.</p>
|
|
31
31
|
* <p>For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the
|
|
32
32
|
* <i>Amazon Connect Administrator Guide</i>.</p>
|
|
33
|
+
* <note>
|
|
34
|
+
* <p>When you make a successful API request, you can expect the following metric values in the response:</p>
|
|
35
|
+
* <ol>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <b>Metric value is null</b>: The calculation cannot be performed due to divide by zero or insufficient data</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <b>Metric value is a number (including 0) of defined type</b>: The number provided is the calculation result</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <b>MetricResult list is empty</b>: The request cannot find any data in the system</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* </ol>
|
|
49
|
+
* <p>The following guidelines can help you work with the API:</p>
|
|
50
|
+
* <ul>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>Each dimension in the metric response must contain a value</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>Each item in MetricResult must include all requested metrics</p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>If the response is slow due to large result sets, try these approaches:</p>
|
|
59
|
+
* <ul>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>Narrow the time range of your request</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>Add filters to reduce the amount of data returned</p>
|
|
65
|
+
* </li>
|
|
66
|
+
* </ul>
|
|
67
|
+
* </li>
|
|
68
|
+
* </ul>
|
|
69
|
+
* </note>
|
|
33
70
|
* @example
|
|
34
71
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
72
|
* ```javascript
|
|
@@ -37,6 +37,43 @@ declare const GetMetricDataV2Command_base: {
|
|
|
37
37
|
* <p>For a description of the historical metrics that are supported by
|
|
38
38
|
* <code>GetMetricDataV2</code> and <code>GetMetricData</code>, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the
|
|
39
39
|
* <i>Amazon Connect Administrator Guide</i>.</p>
|
|
40
|
+
* <note>
|
|
41
|
+
* <p>When you make a successful API request, you can expect the following metric values in the response:</p>
|
|
42
|
+
* <ol>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>
|
|
45
|
+
* <b>Metric value is null</b>: The calculation cannot be performed due to divide by zero or insufficient data</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>
|
|
49
|
+
* <b>Metric value is a number (including 0) of defined type</b>: The number provided is the calculation result</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>
|
|
53
|
+
* <b>MetricResult list is empty</b>: The request cannot find any data in the system</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* </ol>
|
|
56
|
+
* <p>The following guidelines can help you work with the API:</p>
|
|
57
|
+
* <ul>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>Each dimension in the metric response must contain a value</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>Each item in MetricResult must include all requested metrics</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>If the response is slow due to large result sets, try these approaches:</p>
|
|
66
|
+
* <ul>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>Narrow the time range of your request</p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>Add filters to reduce the amount of data returned</p>
|
|
72
|
+
* </li>
|
|
73
|
+
* </ul>
|
|
74
|
+
* </li>
|
|
75
|
+
* </ul>
|
|
76
|
+
* </note>
|
|
40
77
|
* @example
|
|
41
78
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
79
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const ListAgentStatusesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Lists agent statuses.</p>
|
|
30
|
+
* <p>Lists agent statuses.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { ListIntegrationAssociationsRequest
|
|
4
|
+
import { ListIntegrationAssociationsRequest } from "../models/models_1";
|
|
5
|
+
import { ListIntegrationAssociationsResponse } from "../models/models_2";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { ListLambdaFunctionsRequest, ListLambdaFunctionsResponse } from "../models/
|
|
4
|
+
import { ListLambdaFunctionsRequest, ListLambdaFunctionsResponse } from "../models/models_2";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { ListLexBotsRequest, ListLexBotsResponse } from "../models/
|
|
4
|
+
import { ListLexBotsRequest, ListLexBotsResponse } from "../models/models_2";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { ListPhoneNumbersRequest } from "../models/
|
|
5
|
-
import { ListPhoneNumbersResponse } from "../models/models_2";
|
|
4
|
+
import { ListPhoneNumbersRequest, ListPhoneNumbersResponse } from "../models/models_2";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -27,8 +27,7 @@ declare const ListQueueQuickConnectsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Lists the quick connects associated with a queue.</p>
|
|
30
|
+
* <p>Lists the quick connects associated with a queue.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -84,7 +84,10 @@ declare const ReleasePhoneNumberCommand_base: {
|
|
|
84
84
|
* <p>One or more of the specified parameters are not valid.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link ResourceInUseException} (client fault)
|
|
87
|
-
* <p>That resource is already in use
|
|
87
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
88
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
89
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
90
|
+
* and then try again.</p>
|
|
88
91
|
*
|
|
89
92
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
93
|
* <p>The specified resource was not found.</p>
|
|
@@ -27,8 +27,7 @@ declare const UpdateAgentStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates agent status.</p>
|
|
30
|
+
* <p>Updates agent status.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const UpdateHoursOfOperationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates the hours of operation.</p>
|
|
30
|
+
* <p>Updates the hours of operation.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -78,7 +78,10 @@ declare const UpdatePhoneNumberCommand_base: {
|
|
|
78
78
|
* <p>One or more of the specified parameters are not valid.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ResourceInUseException} (client fault)
|
|
81
|
-
* <p>That resource is already in use
|
|
81
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
82
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
83
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
84
|
+
* and then try again.</p>
|
|
82
85
|
*
|
|
83
86
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
87
|
* <p>The specified resource was not found.</p>
|
|
@@ -70,7 +70,10 @@ declare const UpdatePhoneNumberMetadataCommand_base: {
|
|
|
70
70
|
* <p>The request is not valid.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ResourceInUseException} (client fault)
|
|
73
|
-
* <p>That resource is already in use
|
|
73
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
74
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
75
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
76
|
+
* and then try again.</p>
|
|
74
77
|
*
|
|
75
78
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
79
|
* <p>The specified resource was not found.</p>
|
|
@@ -27,8 +27,7 @@ declare const UpdateQueueHoursOfOperationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates the hours of operation for the specified queue.</p>
|
|
30
|
+
* <p>Updates the hours of operation for the specified queue.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const UpdateQueueMaxContactsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates the maximum number of contacts allowed in a queue before it is considered
|
|
30
|
+
* <p>Updates the maximum number of contacts allowed in a queue before it is considered
|
|
32
31
|
* full.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,8 +27,7 @@ declare const UpdateQueueNameCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates the name and description of a queue. At least <code>Name</code> or <code>Description</code> must be provided.</p>
|
|
30
|
+
* <p>Updates the name and description of a queue. At least <code>Name</code> or <code>Description</code> must be provided.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const UpdateQueueOutboundCallerConfigCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates the outbound caller ID name, number, and outbound whisper flow for a specified
|
|
30
|
+
* <p>Updates the outbound caller ID name, number, and outbound whisper flow for a specified
|
|
32
31
|
* queue.</p>
|
|
33
32
|
* <important>
|
|
34
33
|
* <ul>
|
|
@@ -27,8 +27,7 @@ declare const UpdateQueueStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* <p>Updates the status of the queue.</p>
|
|
30
|
+
* <p>Updates the status of the queue.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -76,7 +76,10 @@ declare const UpdateUserHierarchyStructureCommand_base: {
|
|
|
76
76
|
* <p>The request is not valid.</p>
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link ResourceInUseException} (client fault)
|
|
79
|
-
* <p>That resource is already in use
|
|
79
|
+
* <p>That resource is already in use (for example, you're trying to add a record with the same
|
|
80
|
+
* name as an existing record). If you are trying to delete a resource (for example,
|
|
81
|
+
* DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources
|
|
82
|
+
* and then try again.</p>
|
|
80
83
|
*
|
|
81
84
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
85
|
* <p>The specified resource was not found.</p>
|