@aws-sdk/client-cloudwatch 3.1139.0 → 3.1141.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 +35 -0
- package/dist-cjs/index.js +186 -12
- package/dist-es/CloudWatch.js +10 -0
- package/dist-es/commands/CreateResourceMetricsConfigurationCommand.js +4 -0
- package/dist-es/commands/DeleteResourceMetricsConfigurationCommand.js +4 -0
- package/dist-es/commands/GetResourceMetricsConfigurationCommand.js +4 -0
- package/dist-es/commands/UpdateOTelEnrichmentCommand.js +4 -0
- package/dist-es/commands/UpdateResourceMetricsConfigurationCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/schemas/schemas_0.js +131 -12
- package/dist-types/CloudWatch.d.ts +36 -0
- package/dist-types/CloudWatchClient.d.ts +7 -2
- package/dist-types/commands/CreateResourceMetricsConfigurationCommand.d.ts +108 -0
- package/dist-types/commands/DeleteResourceMetricsConfigurationCommand.d.ts +82 -0
- package/dist-types/commands/GetDashboardCommand.d.ts +7 -0
- package/dist-types/commands/GetMetricDataCommand.d.ts +4 -2
- package/dist-types/commands/GetOTelEnrichmentCommand.d.ts +18 -0
- package/dist-types/commands/GetResourceMetricsConfigurationCommand.d.ts +93 -0
- package/dist-types/commands/ListDashboardsCommand.d.ts +7 -0
- package/dist-types/commands/StartOTelEnrichmentCommand.d.ts +49 -4
- package/dist-types/commands/UpdateOTelEnrichmentCommand.d.ts +118 -0
- package/dist-types/commands/UpdateResourceMetricsConfigurationCommand.d.ts +104 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/errors.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +301 -0
- package/dist-types/schemas/schemas_0.d.ts +19 -0
- package/dist-types/ts3.4/CloudWatch.d.ts +86 -0
- package/dist-types/ts3.4/CloudWatchClient.d.ts +32 -2
- package/dist-types/ts3.4/commands/CreateResourceMetricsConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteResourceMetricsConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetResourceMetricsConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartOTelEnrichmentCommand.d.ts +2 -2
- package/dist-types/ts3.4/commands/UpdateOTelEnrichmentCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateResourceMetricsConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/errors.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +61 -2
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
- package/package.json +1 -1
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DeleteResourceMetricsConfigurationInput, DeleteResourceMetricsConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DeleteResourceMetricsConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DeleteResourceMetricsConfigurationCommandInput extends DeleteResourceMetricsConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DeleteResourceMetricsConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DeleteResourceMetricsConfigurationCommandOutput extends DeleteResourceMetricsConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DeleteResourceMetricsConfigurationCommand_base: {
|
|
22
|
+
new (input: DeleteResourceMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl<DeleteResourceMetricsConfigurationCommandInput, DeleteResourceMetricsConfigurationCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DeleteResourceMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl<DeleteResourceMetricsConfigurationCommandInput, DeleteResourceMetricsConfigurationCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Deletes the resource metrics configuration for an Amazon Web Services resource. After
|
|
28
|
+
* you delete the configuration, Amazon CloudWatch stops collecting detailed metrics
|
|
29
|
+
* for the resource. Metric data that Amazon CloudWatch already collected for the
|
|
30
|
+
* resource is not deleted.</p>
|
|
31
|
+
* <p>This operation returns a <code>ResourceNotFoundException</code> if no resource metrics
|
|
32
|
+
* configuration exists for the specified resource ARN. Verify that the resource ARN is
|
|
33
|
+
* correct.</p>
|
|
34
|
+
* <p>To delete a resource metrics configuration, you must have the
|
|
35
|
+
* <code>cloudwatch:DeleteResourceMetricsConfiguration</code> permission. For information about scoping
|
|
36
|
+
* this permission to specific resources, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-resource-arn.html">Condition keys for resource metrics configuration access</a> in the
|
|
37
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { CloudWatchClient, DeleteResourceMetricsConfigurationCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
42
|
+
* // const { CloudWatchClient, DeleteResourceMetricsConfigurationCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
43
|
+
* // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
|
|
44
|
+
* const config = {}; // type is CloudWatchClientConfig
|
|
45
|
+
* const client = new CloudWatchClient(config);
|
|
46
|
+
* const input = { // DeleteResourceMetricsConfigurationInput
|
|
47
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
48
|
+
* };
|
|
49
|
+
* const command = new DeleteResourceMetricsConfigurationCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param DeleteResourceMetricsConfigurationCommandInput - {@link DeleteResourceMetricsConfigurationCommandInput}
|
|
56
|
+
* @returns {@link DeleteResourceMetricsConfigurationCommandOutput}
|
|
57
|
+
* @see {@link DeleteResourceMetricsConfigurationCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link DeleteResourceMetricsConfigurationCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
+
* <p>The named resource does not exist.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link CloudWatchServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from CloudWatch service.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
export declare class DeleteResourceMetricsConfigurationCommand extends DeleteResourceMetricsConfigurationCommand_base {
|
|
71
|
+
/** @internal type navigation helper, not in runtime. */
|
|
72
|
+
protected static __types: {
|
|
73
|
+
api: {
|
|
74
|
+
input: DeleteResourceMetricsConfigurationInput;
|
|
75
|
+
output: {};
|
|
76
|
+
};
|
|
77
|
+
sdk: {
|
|
78
|
+
input: DeleteResourceMetricsConfigurationCommandInput;
|
|
79
|
+
output: DeleteResourceMetricsConfigurationCommandOutput;
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
}
|
|
@@ -28,6 +28,13 @@ declare const GetDashboardCommand_base: {
|
|
|
28
28
|
* <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data
|
|
29
29
|
* returned within <code>DashboardBody</code> as the template for the new dashboard when
|
|
30
30
|
* you call <code>PutDashboard</code> to create the copy.</p>
|
|
31
|
+
* <p>You might have recently enabled an <a href="https://docs.aws.amazon.com/glossary/latest/reference/glos-chap.html#optinregion">opt-in Region (Region that is disabled by default)</a> for your account. In
|
|
32
|
+
* that Region, <code>GetDashboard</code> can return an access denied error for up to 24
|
|
33
|
+
* hours after you enable the Region. This delay occurs while dashboard data propagates.
|
|
34
|
+
* The error does not
|
|
35
|
+
* indicate a problem with your permissions. Because dashboards are global, you can call
|
|
36
|
+
* <code>GetDashboard</code> in any other enabled Region, or retry after propagation
|
|
37
|
+
* completes.</p>
|
|
31
38
|
* @example
|
|
32
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
40
|
* ```javascript
|
|
@@ -37,8 +37,10 @@ declare const GetMetricDataCommand_base: {
|
|
|
37
37
|
* Guide</i>.</p>
|
|
38
38
|
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can
|
|
39
39
|
* include only one query. But the same <code>GetMetricData</code> operation can also
|
|
40
|
-
* retrieve other metrics. Metrics Insights queries can query
|
|
41
|
-
*
|
|
40
|
+
* retrieve other metrics. Metrics Insights queries can query the most recent two weeks of
|
|
41
|
+
* metric data. For alarm condition evaluations, Metrics Insights queries can query only
|
|
42
|
+
* the most recent three hours of metric data. For more information about Metrics Insights,
|
|
43
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html">Query your metrics with CloudWatch Metrics Insights</a>.</p>
|
|
42
44
|
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
|
|
43
45
|
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
|
|
44
46
|
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
@@ -40,6 +40,24 @@ declare const GetOTelEnrichmentCommand_base: {
|
|
|
40
40
|
* const response = await client.send(command);
|
|
41
41
|
* // { // GetOTelEnrichmentOutput
|
|
42
42
|
* // Status: "Running" || "Stopped", // required
|
|
43
|
+
* // IncludeFilters: [ // OTelEnrichmentMetricSelectorList
|
|
44
|
+
* // { // OTelEnrichmentMetricSelector
|
|
45
|
+
* // Namespace: "STRING_VALUE", // required
|
|
46
|
+
* // MetricNames: [ // OTelEnrichmentMetricNameList
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // ExcludeFilters: [
|
|
52
|
+
* // {
|
|
53
|
+
* // Namespace: "STRING_VALUE", // required
|
|
54
|
+
* // MetricNames: [
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
60
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
43
61
|
* // };
|
|
44
62
|
*
|
|
45
63
|
* ```
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { GetResourceMetricsConfigurationInput, GetResourceMetricsConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link GetResourceMetricsConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface GetResourceMetricsConfigurationCommandInput extends GetResourceMetricsConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link GetResourceMetricsConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface GetResourceMetricsConfigurationCommandOutput extends GetResourceMetricsConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const GetResourceMetricsConfigurationCommand_base: {
|
|
22
|
+
new (input: GetResourceMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl<GetResourceMetricsConfigurationCommandInput, GetResourceMetricsConfigurationCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: GetResourceMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl<GetResourceMetricsConfigurationCommandInput, GetResourceMetricsConfigurationCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves the current resource metrics configuration for an Amazon Web Services
|
|
28
|
+
* resource. The response includes the resource ARN, any metric selections, and the times
|
|
29
|
+
* at which the configuration was created and last updated.</p>
|
|
30
|
+
* <p>This operation returns a <code>ResourceNotFoundException</code> if no resource metrics
|
|
31
|
+
* configuration exists for the specified resource ARN. To create a configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_CreateResourceMetricsConfiguration.html">CreateResourceMetricsConfiguration</a>.</p>
|
|
32
|
+
* <p>To retrieve a resource metrics configuration, you must have the
|
|
33
|
+
* <code>cloudwatch:GetResourceMetricsConfiguration</code> permission. For information
|
|
34
|
+
* about scoping this permission to specific resources, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-resource-arn.html">Condition keys for resource metrics configuration access</a> in the
|
|
35
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { CloudWatchClient, GetResourceMetricsConfigurationCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
40
|
+
* // const { CloudWatchClient, GetResourceMetricsConfigurationCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
41
|
+
* // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
|
|
42
|
+
* const config = {}; // type is CloudWatchClientConfig
|
|
43
|
+
* const client = new CloudWatchClient(config);
|
|
44
|
+
* const input = { // GetResourceMetricsConfigurationInput
|
|
45
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
46
|
+
* };
|
|
47
|
+
* const command = new GetResourceMetricsConfigurationCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // GetResourceMetricsConfigurationOutput
|
|
50
|
+
* // ResourceMetricsConfiguration: { // ResourceMetricsConfiguration
|
|
51
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
52
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // UpdatedAt: new Date("TIMESTAMP"), // required
|
|
54
|
+
* // MetricSelections: [ // ResourceMetricSelectionList
|
|
55
|
+
* // { // ResourceMetricSelection
|
|
56
|
+
* // IncludeMetrics: [ // MetricNameList // required
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // },
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param GetResourceMetricsConfigurationCommandInput - {@link GetResourceMetricsConfigurationCommandInput}
|
|
67
|
+
* @returns {@link GetResourceMetricsConfigurationCommandOutput}
|
|
68
|
+
* @see {@link GetResourceMetricsConfigurationCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link GetResourceMetricsConfigurationCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p>The named resource does not exist.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link CloudWatchServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from CloudWatch service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class GetResourceMetricsConfigurationCommand extends GetResourceMetricsConfigurationCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: GetResourceMetricsConfigurationInput;
|
|
86
|
+
output: GetResourceMetricsConfigurationOutput;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: GetResourceMetricsConfigurationCommandInput;
|
|
90
|
+
output: GetResourceMetricsConfigurationCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -32,6 +32,13 @@ declare const ListDashboardsCommand_base: {
|
|
|
32
32
|
* more than 1000 dashboards, you can call <code>ListDashboards</code> again and include
|
|
33
33
|
* the value you received for <code>NextToken</code> in the first call, to receive the next
|
|
34
34
|
* 1000 results.</p>
|
|
35
|
+
* <p>You might have recently enabled an <a href="https://docs.aws.amazon.com/glossary/latest/reference/glos-chap.html#optinregion">opt-in Region (Region that is disabled by default)</a> for your account. In
|
|
36
|
+
* that Region, <code>ListDashboards</code> can return an access denied error for up to 24
|
|
37
|
+
* hours after you enable the Region. This delay occurs while dashboard data propagates.
|
|
38
|
+
* The error does not
|
|
39
|
+
* indicate a problem with your permissions. Because dashboards are global, you can call
|
|
40
|
+
* <code>ListDashboards</code> in any other enabled Region, or retry after propagation
|
|
41
|
+
* completes.</p>
|
|
35
42
|
* @example
|
|
36
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
44
|
* ```javascript
|
|
@@ -31,6 +31,11 @@ declare const StartOTelEnrichmentCommand_base: {
|
|
|
31
31
|
* <p>Before calling this operation, you must enable resource tags on telemetry for your
|
|
32
32
|
* account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/EnableResourceTagsOnTelemetry.html">Enable
|
|
33
33
|
* resource tags on telemetry</a>.</p>
|
|
34
|
+
* <p>Optionally, <code>IncludeFilters</code> and <code>ExcludeFilters</code> limit
|
|
35
|
+
* enrichment to a subset of the account's metrics. These filters are stored only when this
|
|
36
|
+
* operation starts enrichment. Calling <code>StartOTelEnrichment</code> for an account
|
|
37
|
+
* where enrichment is already running has no effect and does not modify the filters that
|
|
38
|
+
* are applied. To change them, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UpdateOTelEnrichment.html">UpdateOTelEnrichment</a>.</p>
|
|
34
39
|
* @example
|
|
35
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
41
|
* ```javascript
|
|
@@ -39,10 +44,46 @@ declare const StartOTelEnrichmentCommand_base: {
|
|
|
39
44
|
* // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
|
|
40
45
|
* const config = {}; // type is CloudWatchClientConfig
|
|
41
46
|
* const client = new CloudWatchClient(config);
|
|
42
|
-
* const input = {
|
|
47
|
+
* const input = { // StartOTelEnrichmentInput
|
|
48
|
+
* IncludeFilters: [ // OTelEnrichmentMetricSelectorList
|
|
49
|
+
* { // OTelEnrichmentMetricSelector
|
|
50
|
+
* Namespace: "STRING_VALUE", // required
|
|
51
|
+
* MetricNames: [ // OTelEnrichmentMetricNameList
|
|
52
|
+
* "STRING_VALUE",
|
|
53
|
+
* ],
|
|
54
|
+
* },
|
|
55
|
+
* ],
|
|
56
|
+
* ExcludeFilters: [
|
|
57
|
+
* {
|
|
58
|
+
* Namespace: "STRING_VALUE", // required
|
|
59
|
+
* MetricNames: [
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* };
|
|
43
65
|
* const command = new StartOTelEnrichmentCommand(input);
|
|
44
66
|
* const response = await client.send(command);
|
|
45
|
-
* // {
|
|
67
|
+
* // { // StartOTelEnrichmentOutput
|
|
68
|
+
* // IncludeFilters: [ // OTelEnrichmentMetricSelectorList
|
|
69
|
+
* // { // OTelEnrichmentMetricSelector
|
|
70
|
+
* // Namespace: "STRING_VALUE", // required
|
|
71
|
+
* // MetricNames: [ // OTelEnrichmentMetricNameList
|
|
72
|
+
* // "STRING_VALUE",
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // ExcludeFilters: [
|
|
77
|
+
* // {
|
|
78
|
+
* // Namespace: "STRING_VALUE", // required
|
|
79
|
+
* // MetricNames: [
|
|
80
|
+
* // "STRING_VALUE",
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
85
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
86
|
+
* // };
|
|
46
87
|
*
|
|
47
88
|
* ```
|
|
48
89
|
*
|
|
@@ -52,6 +93,10 @@ declare const StartOTelEnrichmentCommand_base: {
|
|
|
52
93
|
* @see {@link StartOTelEnrichmentCommandOutput} for command's `response` shape.
|
|
53
94
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
54
95
|
*
|
|
96
|
+
* @throws {@link ValidationException} (client fault)
|
|
97
|
+
* <p>The request failed validation. One or more input parameters do not satisfy the
|
|
98
|
+
* constraints that the operation requires.</p>
|
|
99
|
+
*
|
|
55
100
|
* @throws {@link CloudWatchServiceException}
|
|
56
101
|
* <p>Base exception class for all service exceptions from CloudWatch service.</p>
|
|
57
102
|
*
|
|
@@ -62,8 +107,8 @@ export declare class StartOTelEnrichmentCommand extends StartOTelEnrichmentComma
|
|
|
62
107
|
/** @internal type navigation helper, not in runtime. */
|
|
63
108
|
protected static __types: {
|
|
64
109
|
api: {
|
|
65
|
-
input:
|
|
66
|
-
output:
|
|
110
|
+
input: StartOTelEnrichmentInput;
|
|
111
|
+
output: StartOTelEnrichmentOutput;
|
|
67
112
|
};
|
|
68
113
|
sdk: {
|
|
69
114
|
input: StartOTelEnrichmentCommandInput;
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateOTelEnrichmentInput, UpdateOTelEnrichmentOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateOTelEnrichmentCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateOTelEnrichmentCommandInput extends UpdateOTelEnrichmentInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateOTelEnrichmentCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateOTelEnrichmentCommandOutput extends UpdateOTelEnrichmentOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateOTelEnrichmentCommand_base: {
|
|
22
|
+
new (input: UpdateOTelEnrichmentCommandInput): import("@smithy/core/client").CommandImpl<UpdateOTelEnrichmentCommandInput, UpdateOTelEnrichmentCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [UpdateOTelEnrichmentCommandInput]): import("@smithy/core/client").CommandImpl<UpdateOTelEnrichmentCommandInput, UpdateOTelEnrichmentCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Replaces the filters that determine which CloudWatch vended metrics are enriched
|
|
28
|
+
* with resource ARN and resource tag labels for the account. Enrichment must already be
|
|
29
|
+
* running for the account. If it is not, this operation returns a
|
|
30
|
+
* <code>ResourceNotFoundException</code>. To start enrichment, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_StartOTelEnrichment.html">StartOTelEnrichment</a>.</p>
|
|
31
|
+
* <p>The filters in the request completely replace the stored filters; they are not
|
|
32
|
+
* merged with them. <code>IncludeFilters</code> and <code>ExcludeFilters</code> are
|
|
33
|
+
* replaced as a pair, so a request that specifies only <code>IncludeFilters</code> also
|
|
34
|
+
* clears the stored <code>ExcludeFilters</code>, and a request that specifies neither
|
|
35
|
+
* clears both.</p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { CloudWatchClient, UpdateOTelEnrichmentCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
40
|
+
* // const { CloudWatchClient, UpdateOTelEnrichmentCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
41
|
+
* // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
|
|
42
|
+
* const config = {}; // type is CloudWatchClientConfig
|
|
43
|
+
* const client = new CloudWatchClient(config);
|
|
44
|
+
* const input = { // UpdateOTelEnrichmentInput
|
|
45
|
+
* IncludeFilters: [ // OTelEnrichmentMetricSelectorList
|
|
46
|
+
* { // OTelEnrichmentMetricSelector
|
|
47
|
+
* Namespace: "STRING_VALUE", // required
|
|
48
|
+
* MetricNames: [ // OTelEnrichmentMetricNameList
|
|
49
|
+
* "STRING_VALUE",
|
|
50
|
+
* ],
|
|
51
|
+
* },
|
|
52
|
+
* ],
|
|
53
|
+
* ExcludeFilters: [
|
|
54
|
+
* {
|
|
55
|
+
* Namespace: "STRING_VALUE", // required
|
|
56
|
+
* MetricNames: [
|
|
57
|
+
* "STRING_VALUE",
|
|
58
|
+
* ],
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* };
|
|
62
|
+
* const command = new UpdateOTelEnrichmentCommand(input);
|
|
63
|
+
* const response = await client.send(command);
|
|
64
|
+
* // { // UpdateOTelEnrichmentOutput
|
|
65
|
+
* // IncludeFilters: [ // OTelEnrichmentMetricSelectorList
|
|
66
|
+
* // { // OTelEnrichmentMetricSelector
|
|
67
|
+
* // Namespace: "STRING_VALUE", // required
|
|
68
|
+
* // MetricNames: [ // OTelEnrichmentMetricNameList
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // ExcludeFilters: [
|
|
74
|
+
* // {
|
|
75
|
+
* // Namespace: "STRING_VALUE", // required
|
|
76
|
+
* // MetricNames: [
|
|
77
|
+
* // "STRING_VALUE",
|
|
78
|
+
* // ],
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
82
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
83
|
+
* // };
|
|
84
|
+
*
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
87
|
+
* @param UpdateOTelEnrichmentCommandInput - {@link UpdateOTelEnrichmentCommandInput}
|
|
88
|
+
* @returns {@link UpdateOTelEnrichmentCommandOutput}
|
|
89
|
+
* @see {@link UpdateOTelEnrichmentCommandInput} for command's `input` shape.
|
|
90
|
+
* @see {@link UpdateOTelEnrichmentCommandOutput} for command's `response` shape.
|
|
91
|
+
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
+
* <p>The named resource does not exist.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ValidationException} (client fault)
|
|
97
|
+
* <p>The request failed validation. One or more input parameters do not satisfy the
|
|
98
|
+
* constraints that the operation requires.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link CloudWatchServiceException}
|
|
101
|
+
* <p>Base exception class for all service exceptions from CloudWatch service.</p>
|
|
102
|
+
*
|
|
103
|
+
*
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export declare class UpdateOTelEnrichmentCommand extends UpdateOTelEnrichmentCommand_base {
|
|
107
|
+
/** @internal type navigation helper, not in runtime. */
|
|
108
|
+
protected static __types: {
|
|
109
|
+
api: {
|
|
110
|
+
input: UpdateOTelEnrichmentInput;
|
|
111
|
+
output: UpdateOTelEnrichmentOutput;
|
|
112
|
+
};
|
|
113
|
+
sdk: {
|
|
114
|
+
input: UpdateOTelEnrichmentCommandInput;
|
|
115
|
+
output: UpdateOTelEnrichmentCommandOutput;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateResourceMetricsConfigurationInput, UpdateResourceMetricsConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateResourceMetricsConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateResourceMetricsConfigurationCommandInput extends UpdateResourceMetricsConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateResourceMetricsConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateResourceMetricsConfigurationCommandOutput extends UpdateResourceMetricsConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateResourceMetricsConfigurationCommand_base: {
|
|
22
|
+
new (input: UpdateResourceMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl<UpdateResourceMetricsConfigurationCommandInput, UpdateResourceMetricsConfigurationCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateResourceMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl<UpdateResourceMetricsConfigurationCommandInput, UpdateResourceMetricsConfigurationCommandOutput, import("..").CloudWatchClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates the resource metrics configuration for an Amazon Web Services resource. The
|
|
28
|
+
* <code>MetricSelections</code> value that you provide replaces any existing metric
|
|
29
|
+
* selections for the resource; it is not merged with them.</p>
|
|
30
|
+
* <p>If you omit <code>MetricSelections</code>, Amazon CloudWatch removes any existing
|
|
31
|
+
* metric selection filter and collects all available detailed metrics for the
|
|
32
|
+
* resource.</p>
|
|
33
|
+
* <p>This operation returns a <code>ResourceNotFoundException</code> if no resource metrics
|
|
34
|
+
* configuration exists for the specified resource ARN. To create a configuration, use
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_CreateResourceMetricsConfiguration.html">CreateResourceMetricsConfiguration</a>.</p>
|
|
36
|
+
* <p>To update a resource metrics configuration, you must have the
|
|
37
|
+
* <code>cloudwatch:UpdateResourceMetricsConfiguration</code> permission. For information about scoping
|
|
38
|
+
* this permission to specific resources, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/iam-cw-condition-keys-resource-arn.html">Condition keys for resource metrics configuration access</a> in the
|
|
39
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
40
|
+
* @example
|
|
41
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
42
|
+
* ```javascript
|
|
43
|
+
* import { CloudWatchClient, UpdateResourceMetricsConfigurationCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
44
|
+
* // const { CloudWatchClient, UpdateResourceMetricsConfigurationCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
45
|
+
* // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
|
|
46
|
+
* const config = {}; // type is CloudWatchClientConfig
|
|
47
|
+
* const client = new CloudWatchClient(config);
|
|
48
|
+
* const input = { // UpdateResourceMetricsConfigurationInput
|
|
49
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
50
|
+
* MetricSelections: [ // ResourceMetricSelectionList
|
|
51
|
+
* { // ResourceMetricSelection
|
|
52
|
+
* IncludeMetrics: [ // MetricNameList // required
|
|
53
|
+
* "STRING_VALUE",
|
|
54
|
+
* ],
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* };
|
|
58
|
+
* const command = new UpdateResourceMetricsConfigurationCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* // { // UpdateResourceMetricsConfigurationOutput
|
|
61
|
+
* // ResourceMetricsConfiguration: { // ResourceMetricsConfiguration
|
|
62
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
63
|
+
* // CreatedAt: new Date("TIMESTAMP"), // required
|
|
64
|
+
* // UpdatedAt: new Date("TIMESTAMP"), // required
|
|
65
|
+
* // MetricSelections: [ // ResourceMetricSelectionList
|
|
66
|
+
* // { // ResourceMetricSelection
|
|
67
|
+
* // IncludeMetrics: [ // MetricNameList // required
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param UpdateResourceMetricsConfigurationCommandInput - {@link UpdateResourceMetricsConfigurationCommandInput}
|
|
78
|
+
* @returns {@link UpdateResourceMetricsConfigurationCommandOutput}
|
|
79
|
+
* @see {@link UpdateResourceMetricsConfigurationCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link UpdateResourceMetricsConfigurationCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The named resource does not exist.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link CloudWatchServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from CloudWatch service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class UpdateResourceMetricsConfigurationCommand extends UpdateResourceMetricsConfigurationCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: UpdateResourceMetricsConfigurationInput;
|
|
97
|
+
output: UpdateResourceMetricsConfigurationOutput;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: UpdateResourceMetricsConfigurationCommandInput;
|
|
101
|
+
output: UpdateResourceMetricsConfigurationCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
export * from "./AssociateDatasetKmsKeyCommand";
|
|
2
|
+
export * from "./CreateResourceMetricsConfigurationCommand";
|
|
2
3
|
export * from "./DeleteAlarmMuteRuleCommand";
|
|
3
4
|
export * from "./DeleteAlarmsCommand";
|
|
4
5
|
export * from "./DeleteAnomalyDetectorCommand";
|
|
5
6
|
export * from "./DeleteDashboardsCommand";
|
|
6
7
|
export * from "./DeleteInsightRulesCommand";
|
|
7
8
|
export * from "./DeleteMetricStreamCommand";
|
|
9
|
+
export * from "./DeleteResourceMetricsConfigurationCommand";
|
|
8
10
|
export * from "./DescribeAlarmContributorsCommand";
|
|
9
11
|
export * from "./DescribeAlarmHistoryCommand";
|
|
10
12
|
export * from "./DescribeAlarmsCommand";
|
|
@@ -25,6 +27,7 @@ export * from "./GetMetricStatisticsCommand";
|
|
|
25
27
|
export * from "./GetMetricStreamCommand";
|
|
26
28
|
export * from "./GetMetricWidgetImageCommand";
|
|
27
29
|
export * from "./GetOTelEnrichmentCommand";
|
|
30
|
+
export * from "./GetResourceMetricsConfigurationCommand";
|
|
28
31
|
export * from "./ListAlarmMuteRulesCommand";
|
|
29
32
|
export * from "./ListDashboardsCommand";
|
|
30
33
|
export * from "./ListManagedInsightRulesCommand";
|
|
@@ -48,3 +51,5 @@ export * from "./StopMetricStreamsCommand";
|
|
|
48
51
|
export * from "./StopOTelEnrichmentCommand";
|
|
49
52
|
export * from "./TagResourceCommand";
|
|
50
53
|
export * from "./UntagResourceCommand";
|
|
54
|
+
export * from "./UpdateOTelEnrichmentCommand";
|
|
55
|
+
export * from "./UpdateResourceMetricsConfigurationCommand";
|
|
@@ -245,3 +245,16 @@ export declare class InvalidFormatFault extends __BaseException {
|
|
|
245
245
|
*/
|
|
246
246
|
constructor(opts: __ExceptionOptionType<InvalidFormatFault, __BaseException>);
|
|
247
247
|
}
|
|
248
|
+
/**
|
|
249
|
+
* <p>The request failed validation. One or more input parameters do not satisfy the
|
|
250
|
+
* constraints that the operation requires.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export declare class ValidationException extends __BaseException {
|
|
254
|
+
readonly name: "ValidationException";
|
|
255
|
+
readonly $fault: "client";
|
|
256
|
+
/**
|
|
257
|
+
* @internal
|
|
258
|
+
*/
|
|
259
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
260
|
+
}
|