@aws-sdk/client-connect 3.1107.0 → 3.1109.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 +49 -0
- package/dist-cjs/index.js +390 -46
- package/dist-es/Connect.js +18 -0
- package/dist-es/commands/CreateMetricCommand.js +4 -0
- package/dist-es/commands/DeleteMetricCommand.js +4 -0
- package/dist-es/commands/DescribeMetricCommand.js +4 -0
- package/dist-es/commands/ListMetricsCommand.js +4 -0
- package/dist-es/commands/SearchMetricsCommand.js +4 -0
- package/dist-es/commands/UpdateMetricContentCommand.js +4 -0
- package/dist-es/commands/UpdateMetricMetadataCommand.js +4 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/enums.js +41 -0
- package/dist-es/pagination/ListMetricsPaginator.js +4 -0
- package/dist-es/pagination/SearchMetricsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +268 -45
- package/dist-types/Connect.d.ts +63 -0
- package/dist-types/ConnectClient.d.ts +9 -2
- package/dist-types/commands/CreateMetricCommand.d.ts +137 -0
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserHierarchyGroupCommand.d.ts +1 -2
- package/dist-types/commands/DeleteMetricCommand.d.ts +93 -0
- package/dist-types/commands/DescribeMetricCommand.d.ts +165 -0
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +2 -1
- package/dist-types/commands/GetEffectiveHoursOfOperationsCommand.d.ts +1 -1
- package/dist-types/commands/GetEvaluationFormValidationCommand.d.ts +1 -1
- package/dist-types/commands/GetFederationTokenCommand.d.ts +1 -1
- package/dist-types/commands/ListMetricsCommand.d.ts +103 -0
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/commands/SearchMetricsCommand.d.ts +223 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMetricContentCommand.d.ts +121 -0
- package/dist-types/commands/UpdateMetricMetadataCommand.d.ts +93 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/enums.d.ts +113 -0
- package/dist-types/models/models_0.d.ts +185 -285
- package/dist-types/models/models_1.d.ts +526 -349
- package/dist-types/models/models_2.d.ts +394 -355
- package/dist-types/models/models_3.d.ts +469 -663
- package/dist-types/models/models_4.d.ts +715 -5
- package/dist-types/pagination/ListMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +32 -0
- package/dist-types/ts3.4/Connect.d.ts +130 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateMetricCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateUserHierarchyGroupCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteMetricCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeMetricCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetEffectiveHoursOfOperationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetEvaluationFormValidationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMetricsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchMetricsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateMetricContentCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateMetricMetadataCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/enums.d.ts +53 -0
- package/dist-types/ts3.4/models/models_0.d.ts +49 -55
- package/dist-types/ts3.4/models/models_1.d.ts +108 -82
- package/dist-types/ts3.4/models/models_2.d.ts +99 -86
- package/dist-types/ts3.4/models/models_3.d.ts +121 -153
- package/dist-types/ts3.4/models/models_4.d.ts +174 -21
- package/dist-types/ts3.4/pagination/ListMetricsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/SearchMetricsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +32 -0
- package/package.json +6 -6
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeMetricRequest, DescribeMetricResponse } from "../models/models_1";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeMetricCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeMetricCommandInput extends DescribeMetricRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeMetricCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeMetricCommandOutput extends DescribeMetricResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeMetricCommand_base: {
|
|
22
|
+
new (input: DescribeMetricCommandInput): import("@smithy/core/client").CommandImpl<DescribeMetricCommandInput, DescribeMetricCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeMetricCommandInput): import("@smithy/core/client").CommandImpl<DescribeMetricCommandInput, DescribeMetricCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the full definition of an existing metric from the specified Connect Customer instance.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ConnectClient, DescribeMetricCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
32
|
+
* // const { ConnectClient, DescribeMetricCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
33
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
34
|
+
* const config = {}; // type is ConnectClientConfig
|
|
35
|
+
* const client = new ConnectClient(config);
|
|
36
|
+
* const input = { // DescribeMetricRequest
|
|
37
|
+
* InstanceId: "STRING_VALUE", // required
|
|
38
|
+
* MetricId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeMetricCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeMetricResponse
|
|
43
|
+
* // Metric: { // MetricDefinition
|
|
44
|
+
* // Arn: "STRING_VALUE", // required
|
|
45
|
+
* // Id: "STRING_VALUE", // required
|
|
46
|
+
* // Name: "STRING_VALUE", // required
|
|
47
|
+
* // Description: "STRING_VALUE",
|
|
48
|
+
* // MetricCalculation: { // MetricCalculation
|
|
49
|
+
* // CalculationComponents: [ // CalculationComponentList // required
|
|
50
|
+
* // { // CalculationComponent
|
|
51
|
+
* // Alias: "STRING_VALUE", // required
|
|
52
|
+
* // MetricName: "STRING_VALUE",
|
|
53
|
+
* // MetricId: "STRING_VALUE",
|
|
54
|
+
* // MetricFilters: [ // MetricFilterList
|
|
55
|
+
* // { // MetricFilter
|
|
56
|
+
* // MetricFilterKey: "STRING_VALUE", // required
|
|
57
|
+
* // Negate: true || false,
|
|
58
|
+
* // NumberCondition: { // MetricFilterNumberCondition
|
|
59
|
+
* // Comparison: "LESSER" || "LESSER_OR_EQUAL" || "GREATER" || "GREATER_OR_EQUAL", // required
|
|
60
|
+
* // Values: [ // NumberValueList // required
|
|
61
|
+
* // Number("double"),
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // StringCondition: { // MetricFilterStringCondition
|
|
65
|
+
* // Comparison: "MATCHES_ANY" || "MATCHES_NONE", // required
|
|
66
|
+
* // Values: [ // StringValueList // required
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // },
|
|
70
|
+
* // BooleanCondition: { // MetricFilterBooleanCondition
|
|
71
|
+
* // Comparison: "IS_TRUE" || "IS_FALSE", // required
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // Calculation: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // CreationMethod: "SERVICE_LEVEL_BUILDER" || "METRIC_BUILDER",
|
|
80
|
+
* // Status: "PUBLISHED" || "SAVED",
|
|
81
|
+
* // Type: "AWS_MANAGED" || "CUSTOMER_MANAGED", // required
|
|
82
|
+
* // Unit: "INTEGER" || "DOUBLE" || "PERCENT" || "SECONDS", // required
|
|
83
|
+
* // PositiveTrendIndicator: "POSITIVE" || "NEGATIVE" || "NEUTRAL",
|
|
84
|
+
* // Groupings: [ // MetricGroupingList // required
|
|
85
|
+
* // "STRING_VALUE",
|
|
86
|
+
* // ],
|
|
87
|
+
* // Filters: [ // AvailableFilterList // required
|
|
88
|
+
* // { // AvailableFilter
|
|
89
|
+
* // Id: "STRING_VALUE",
|
|
90
|
+
* // Type: "METRIC_LEVEL" || "RESOURCE_LEVEL",
|
|
91
|
+
* // },
|
|
92
|
+
* // ],
|
|
93
|
+
* // EffectiveTime: new Date("TIMESTAMP"),
|
|
94
|
+
* // RefreshRate: Number("long"),
|
|
95
|
+
* // Category: "STRING_VALUE", // required
|
|
96
|
+
* // SupportedStats: [ // SupportedStatsList
|
|
97
|
+
* // "STRING_VALUE",
|
|
98
|
+
* // ],
|
|
99
|
+
* // DefaultStat: "STRING_VALUE",
|
|
100
|
+
* // SupportsPreaggregateCalculation: true || false, // required
|
|
101
|
+
* // SupportsCustomCalculation: true || false, // required
|
|
102
|
+
* // PrimaryEventSource: "STRING_VALUE",
|
|
103
|
+
* // PrimaryEventSourceEffectiveTimestampType: "STRING_VALUE",
|
|
104
|
+
* // CreatedTime: new Date("TIMESTAMP"),
|
|
105
|
+
* // CreatedUser: { // CreatedByInfo Union: only one key present
|
|
106
|
+
* // ConnectUserArn: "STRING_VALUE",
|
|
107
|
+
* // AWSIdentityArn: "STRING_VALUE",
|
|
108
|
+
* // },
|
|
109
|
+
* // LastModifiedRegion: "STRING_VALUE",
|
|
110
|
+
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
111
|
+
* // LastModifiedUser: {// Union: only one key present
|
|
112
|
+
* // ConnectUserArn: "STRING_VALUE",
|
|
113
|
+
* // AWSIdentityArn: "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // Tags: { // TagMap
|
|
116
|
+
* // "<keys>": "STRING_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // },
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param DescribeMetricCommandInput - {@link DescribeMetricCommandInput}
|
|
124
|
+
* @returns {@link DescribeMetricCommandOutput}
|
|
125
|
+
* @see {@link DescribeMetricCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link DescribeMetricCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
130
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
133
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
136
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
139
|
+
* <p>The request is not valid.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
142
|
+
* <p>The specified resource was not found.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
145
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ConnectServiceException}
|
|
148
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
149
|
+
*
|
|
150
|
+
*
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export declare class DescribeMetricCommand extends DescribeMetricCommand_base {
|
|
154
|
+
/** @internal type navigation helper, not in runtime. */
|
|
155
|
+
protected static __types: {
|
|
156
|
+
api: {
|
|
157
|
+
input: DescribeMetricRequest;
|
|
158
|
+
output: DescribeMetricResponse;
|
|
159
|
+
};
|
|
160
|
+
sdk: {
|
|
161
|
+
input: DescribeMetricCommandInput;
|
|
162
|
+
output: DescribeMetricCommandOutput;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { GetCurrentUserDataRequest
|
|
2
|
+
import type { GetCurrentUserDataRequest } from "../models/models_1";
|
|
3
|
+
import type { GetCurrentUserDataResponse } from "../models/models_2";
|
|
3
4
|
/**
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { GetEffectiveHoursOfOperationsRequest, GetEffectiveHoursOfOperationsResponse } from "../models/
|
|
2
|
+
import type { GetEffectiveHoursOfOperationsRequest, GetEffectiveHoursOfOperationsResponse } from "../models/models_2";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { GetEvaluationFormValidationRequest, GetEvaluationFormValidationResponse } from "../models/
|
|
2
|
+
import type { GetEvaluationFormValidationRequest, GetEvaluationFormValidationResponse } from "../models/models_2";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { GetFederationTokenRequest, GetFederationTokenResponse } from "../models/
|
|
2
|
+
import type { GetFederationTokenRequest, GetFederationTokenResponse } from "../models/models_2";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListMetricsRequest, ListMetricsResponse } from "../models/models_2";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListMetricsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListMetricsCommandInput extends ListMetricsRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListMetricsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListMetricsCommandOutput extends ListMetricsResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListMetricsCommand_base: {
|
|
22
|
+
new (input: ListMetricsCommandInput): import("@smithy/core/client").CommandImpl<ListMetricsCommandInput, ListMetricsCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ListMetricsCommandInput): import("@smithy/core/client").CommandImpl<ListMetricsCommandInput, ListMetricsCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ConnectClient, ListMetricsCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
32
|
+
* // const { ConnectClient, ListMetricsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
33
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
34
|
+
* const config = {}; // type is ConnectClientConfig
|
|
35
|
+
* const client = new ConnectClient(config);
|
|
36
|
+
* const input = { // ListMetricsRequest
|
|
37
|
+
* InstanceId: "STRING_VALUE", // required
|
|
38
|
+
* Type: "AWS_MANAGED" || "CUSTOMER_MANAGED",
|
|
39
|
+
* MaxResults: Number("int"),
|
|
40
|
+
* NextToken: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListMetricsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListMetricsResponse
|
|
45
|
+
* // MetricSummaryList: [ // MetricSummaryList // required
|
|
46
|
+
* // { // MetricSummary
|
|
47
|
+
* // Arn: "STRING_VALUE", // required
|
|
48
|
+
* // Id: "STRING_VALUE", // required
|
|
49
|
+
* // Name: "STRING_VALUE", // required
|
|
50
|
+
* // Status: "PUBLISHED" || "SAVED", // required
|
|
51
|
+
* // Type: "AWS_MANAGED" || "CUSTOMER_MANAGED", // required
|
|
52
|
+
* // LastModifiedRegion: "STRING_VALUE",
|
|
53
|
+
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // NextToken: "STRING_VALUE",
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param ListMetricsCommandInput - {@link ListMetricsCommandInput}
|
|
62
|
+
* @returns {@link ListMetricsCommandOutput}
|
|
63
|
+
* @see {@link ListMetricsCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link ListMetricsCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
71
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
77
|
+
* <p>The request is not valid.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
80
|
+
* <p>The specified resource was not found.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ConnectServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class ListMetricsCommand extends ListMetricsCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: ListMetricsRequest;
|
|
96
|
+
output: ListMetricsResponse;
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: ListMetricsCommandInput;
|
|
100
|
+
output: ListMetricsCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
2
|
import type { SearchAgentStatusesResponse } from "../models/models_2";
|
|
3
|
-
import type { SearchAgentStatusesRequest } from "../models/
|
|
3
|
+
import type { SearchAgentStatusesRequest } from "../models/models_4";
|
|
4
4
|
/**
|
|
5
5
|
* @public
|
|
6
6
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
2
|
import type { SearchContactEvaluationsResponse } from "../models/models_2";
|
|
3
|
-
import type { SearchContactEvaluationsRequest } from "../models/
|
|
3
|
+
import type { SearchContactEvaluationsRequest } from "../models/models_4";
|
|
4
4
|
/**
|
|
5
5
|
* @public
|
|
6
6
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
2
|
import type { SearchContactFlowModulesResponse } from "../models/models_2";
|
|
3
|
-
import type { SearchContactFlowModulesRequest } from "../models/
|
|
3
|
+
import type { SearchContactFlowModulesRequest } from "../models/models_4";
|
|
4
4
|
/**
|
|
5
5
|
* @public
|
|
6
6
|
*/
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { SearchMetricsResponse } from "../models/models_3";
|
|
3
|
+
import type { SearchMetricsRequest } from "../models/models_4";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export type { __MetadataBearer };
|
|
8
|
+
/**
|
|
9
|
+
* @public
|
|
10
|
+
*
|
|
11
|
+
* The input for {@link SearchMetricsCommand}.
|
|
12
|
+
*/
|
|
13
|
+
export interface SearchMetricsCommandInput extends SearchMetricsRequest {
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
*
|
|
18
|
+
* The output of {@link SearchMetricsCommand}.
|
|
19
|
+
*/
|
|
20
|
+
export interface SearchMetricsCommandOutput extends SearchMetricsResponse, __MetadataBearer {
|
|
21
|
+
}
|
|
22
|
+
declare const SearchMetricsCommand_base: {
|
|
23
|
+
new (input: SearchMetricsCommandInput): import("@smithy/core/client").CommandImpl<SearchMetricsCommandInput, SearchMetricsCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
new (input: SearchMetricsCommandInput): import("@smithy/core/client").CommandImpl<SearchMetricsCommandInput, SearchMetricsCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
25
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* <p>Searches for metrics in the specified Connect Customer instance using search criteria and optional tag-based filters. Use pagination to ensure that the operation returns quickly and successfully.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { ConnectClient, SearchMetricsCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
33
|
+
* // const { ConnectClient, SearchMetricsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
34
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
35
|
+
* const config = {}; // type is ConnectClientConfig
|
|
36
|
+
* const client = new ConnectClient(config);
|
|
37
|
+
* const input = { // SearchMetricsRequest
|
|
38
|
+
* InstanceId: "STRING_VALUE", // required
|
|
39
|
+
* NextToken: "STRING_VALUE",
|
|
40
|
+
* MaxResults: Number("int"),
|
|
41
|
+
* SearchFilter: { // MetricSearchFilter
|
|
42
|
+
* TagFilter: { // ControlPlaneTagFilter
|
|
43
|
+
* OrConditions: [ // TagOrConditionList
|
|
44
|
+
* [ // TagAndConditionList
|
|
45
|
+
* { // TagCondition
|
|
46
|
+
* TagKey: "STRING_VALUE",
|
|
47
|
+
* TagValue: "STRING_VALUE",
|
|
48
|
+
* },
|
|
49
|
+
* ],
|
|
50
|
+
* ],
|
|
51
|
+
* AndConditions: [
|
|
52
|
+
* {
|
|
53
|
+
* TagKey: "STRING_VALUE",
|
|
54
|
+
* TagValue: "STRING_VALUE",
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* TagCondition: "<TagCondition>",
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* SearchCriteria: { // MetricSearchCriteria
|
|
61
|
+
* OrConditions: [ // MetricSearchConditionList
|
|
62
|
+
* {
|
|
63
|
+
* OrConditions: [
|
|
64
|
+
* "<MetricSearchCriteria>",
|
|
65
|
+
* ],
|
|
66
|
+
* AndConditions: [
|
|
67
|
+
* "<MetricSearchCriteria>",
|
|
68
|
+
* ],
|
|
69
|
+
* StringCondition: { // StringCondition
|
|
70
|
+
* FieldName: "STRING_VALUE",
|
|
71
|
+
* Value: "STRING_VALUE",
|
|
72
|
+
* ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
|
|
73
|
+
* },
|
|
74
|
+
* BooleanCondition: { // BooleanCondition
|
|
75
|
+
* FieldName: "STRING_VALUE",
|
|
76
|
+
* ComparisonType: "IS_TRUE" || "IS_FALSE",
|
|
77
|
+
* },
|
|
78
|
+
* },
|
|
79
|
+
* ],
|
|
80
|
+
* AndConditions: [
|
|
81
|
+
* "<MetricSearchCriteria>",
|
|
82
|
+
* ],
|
|
83
|
+
* StringCondition: {
|
|
84
|
+
* FieldName: "STRING_VALUE",
|
|
85
|
+
* Value: "STRING_VALUE",
|
|
86
|
+
* ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
|
|
87
|
+
* },
|
|
88
|
+
* BooleanCondition: {
|
|
89
|
+
* FieldName: "STRING_VALUE",
|
|
90
|
+
* ComparisonType: "IS_TRUE" || "IS_FALSE",
|
|
91
|
+
* },
|
|
92
|
+
* },
|
|
93
|
+
* };
|
|
94
|
+
* const command = new SearchMetricsCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* // { // SearchMetricsResponse
|
|
97
|
+
* // Metrics: [ // MetricSearchSummaryList
|
|
98
|
+
* // { // MetricDefinition
|
|
99
|
+
* // Arn: "STRING_VALUE", // required
|
|
100
|
+
* // Id: "STRING_VALUE", // required
|
|
101
|
+
* // Name: "STRING_VALUE", // required
|
|
102
|
+
* // Description: "STRING_VALUE",
|
|
103
|
+
* // MetricCalculation: { // MetricCalculation
|
|
104
|
+
* // CalculationComponents: [ // CalculationComponentList // required
|
|
105
|
+
* // { // CalculationComponent
|
|
106
|
+
* // Alias: "STRING_VALUE", // required
|
|
107
|
+
* // MetricName: "STRING_VALUE",
|
|
108
|
+
* // MetricId: "STRING_VALUE",
|
|
109
|
+
* // MetricFilters: [ // MetricFilterList
|
|
110
|
+
* // { // MetricFilter
|
|
111
|
+
* // MetricFilterKey: "STRING_VALUE", // required
|
|
112
|
+
* // Negate: true || false,
|
|
113
|
+
* // NumberCondition: { // MetricFilterNumberCondition
|
|
114
|
+
* // Comparison: "LESSER" || "LESSER_OR_EQUAL" || "GREATER" || "GREATER_OR_EQUAL", // required
|
|
115
|
+
* // Values: [ // NumberValueList // required
|
|
116
|
+
* // Number("double"),
|
|
117
|
+
* // ],
|
|
118
|
+
* // },
|
|
119
|
+
* // StringCondition: { // MetricFilterStringCondition
|
|
120
|
+
* // Comparison: "MATCHES_ANY" || "MATCHES_NONE", // required
|
|
121
|
+
* // Values: [ // StringValueList // required
|
|
122
|
+
* // "STRING_VALUE",
|
|
123
|
+
* // ],
|
|
124
|
+
* // },
|
|
125
|
+
* // BooleanCondition: { // MetricFilterBooleanCondition
|
|
126
|
+
* // Comparison: "IS_TRUE" || "IS_FALSE", // required
|
|
127
|
+
* // },
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // Calculation: "STRING_VALUE", // required
|
|
133
|
+
* // },
|
|
134
|
+
* // CreationMethod: "SERVICE_LEVEL_BUILDER" || "METRIC_BUILDER",
|
|
135
|
+
* // Status: "PUBLISHED" || "SAVED",
|
|
136
|
+
* // Type: "AWS_MANAGED" || "CUSTOMER_MANAGED", // required
|
|
137
|
+
* // Unit: "INTEGER" || "DOUBLE" || "PERCENT" || "SECONDS", // required
|
|
138
|
+
* // PositiveTrendIndicator: "POSITIVE" || "NEGATIVE" || "NEUTRAL",
|
|
139
|
+
* // Groupings: [ // MetricGroupingList // required
|
|
140
|
+
* // "STRING_VALUE",
|
|
141
|
+
* // ],
|
|
142
|
+
* // Filters: [ // AvailableFilterList // required
|
|
143
|
+
* // { // AvailableFilter
|
|
144
|
+
* // Id: "STRING_VALUE",
|
|
145
|
+
* // Type: "METRIC_LEVEL" || "RESOURCE_LEVEL",
|
|
146
|
+
* // },
|
|
147
|
+
* // ],
|
|
148
|
+
* // EffectiveTime: new Date("TIMESTAMP"),
|
|
149
|
+
* // RefreshRate: Number("long"),
|
|
150
|
+
* // Category: "STRING_VALUE", // required
|
|
151
|
+
* // SupportedStats: [ // SupportedStatsList
|
|
152
|
+
* // "STRING_VALUE",
|
|
153
|
+
* // ],
|
|
154
|
+
* // DefaultStat: "STRING_VALUE",
|
|
155
|
+
* // SupportsPreaggregateCalculation: true || false, // required
|
|
156
|
+
* // SupportsCustomCalculation: true || false, // required
|
|
157
|
+
* // PrimaryEventSource: "STRING_VALUE",
|
|
158
|
+
* // PrimaryEventSourceEffectiveTimestampType: "STRING_VALUE",
|
|
159
|
+
* // CreatedTime: new Date("TIMESTAMP"),
|
|
160
|
+
* // CreatedUser: { // CreatedByInfo Union: only one key present
|
|
161
|
+
* // ConnectUserArn: "STRING_VALUE",
|
|
162
|
+
* // AWSIdentityArn: "STRING_VALUE",
|
|
163
|
+
* // },
|
|
164
|
+
* // LastModifiedRegion: "STRING_VALUE",
|
|
165
|
+
* // LastModifiedTime: new Date("TIMESTAMP"),
|
|
166
|
+
* // LastModifiedUser: {// Union: only one key present
|
|
167
|
+
* // ConnectUserArn: "STRING_VALUE",
|
|
168
|
+
* // AWSIdentityArn: "STRING_VALUE",
|
|
169
|
+
* // },
|
|
170
|
+
* // Tags: { // TagMap
|
|
171
|
+
* // "<keys>": "STRING_VALUE",
|
|
172
|
+
* // },
|
|
173
|
+
* // },
|
|
174
|
+
* // ],
|
|
175
|
+
* // NextToken: "STRING_VALUE",
|
|
176
|
+
* // ApproximateTotalCount: Number("long"),
|
|
177
|
+
* // };
|
|
178
|
+
*
|
|
179
|
+
* ```
|
|
180
|
+
*
|
|
181
|
+
* @param SearchMetricsCommandInput - {@link SearchMetricsCommandInput}
|
|
182
|
+
* @returns {@link SearchMetricsCommandOutput}
|
|
183
|
+
* @see {@link SearchMetricsCommandInput} for command's `input` shape.
|
|
184
|
+
* @see {@link SearchMetricsCommandOutput} for command's `response` shape.
|
|
185
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
186
|
+
*
|
|
187
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
188
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
189
|
+
*
|
|
190
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
191
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
192
|
+
*
|
|
193
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
194
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
195
|
+
*
|
|
196
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
197
|
+
* <p>The request is not valid.</p>
|
|
198
|
+
*
|
|
199
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
200
|
+
* <p>The specified resource was not found.</p>
|
|
201
|
+
*
|
|
202
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
203
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
204
|
+
*
|
|
205
|
+
* @throws {@link ConnectServiceException}
|
|
206
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
207
|
+
*
|
|
208
|
+
*
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
export declare class SearchMetricsCommand extends SearchMetricsCommand_base {
|
|
212
|
+
/** @internal type navigation helper, not in runtime. */
|
|
213
|
+
protected static __types: {
|
|
214
|
+
api: {
|
|
215
|
+
input: SearchMetricsRequest;
|
|
216
|
+
output: SearchMetricsResponse;
|
|
217
|
+
};
|
|
218
|
+
sdk: {
|
|
219
|
+
input: SearchMetricsCommandInput;
|
|
220
|
+
output: SearchMetricsCommandOutput;
|
|
221
|
+
};
|
|
222
|
+
};
|
|
223
|
+
}
|
|
@@ -26,7 +26,7 @@ declare const TagResourceCommand_base: {
|
|
|
26
26
|
/**
|
|
27
27
|
* <p>Adds the specified tags to the specified resource.</p>
|
|
28
28
|
* <p>Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent
|
|
29
|
-
* statuses, hours of operation, phone numbers, security profiles, and
|
|
29
|
+
* statuses, hours of operation, phone numbers, security profiles, task templates, and custom metrics. For a complete list, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html">Tagging resources in Connect Customer</a>.</p>
|
|
30
30
|
* <p>For sample policies that use tags, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html">Connect Customer Identity-Based Policy
|
|
31
31
|
* Examples</a> in the <i>Connect Customer Administrator Guide</i>.</p>
|
|
32
32
|
* @example
|