Skip to content

Commit f74cc08

Browse files
author
awstools
committed
feat(client-observabilityadmin): CloudWatch Observability Admin adds the ability to enable Resource tags for telemetry in a customer account. The release introduces new APIs to enable, disable and describe the status of Resource tags for telemetry feature. This new capability simplifies monitoring AWS resources using tags.
1 parent ef2d3c3 commit f74cc08

38 files changed

+1212
-906
lines changed

clients/client-observabilityadmin/README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@
66

77
AWS SDK for JavaScript ObservabilityAdmin Client for Node.js, Browser and React Native.
88

9-
<p>
10-
You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment.
11-
For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p>
12-
<p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
9+
<p> You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p> <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
1310

1411
## Installing
1512

@@ -261,6 +258,14 @@ GetCentralizationRuleForOrganization
261258

262259
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/observabilityadmin/command/GetCentralizationRuleForOrganizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/GetCentralizationRuleForOrganizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/GetCentralizationRuleForOrganizationCommandOutput/)
263260

261+
</details>
262+
<details>
263+
<summary>
264+
GetTelemetryEnrichmentStatus
265+
</summary>
266+
267+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/observabilityadmin/command/GetTelemetryEnrichmentStatusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/GetTelemetryEnrichmentStatusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/GetTelemetryEnrichmentStatusCommandOutput/)
268+
264269
</details>
265270
<details>
266271
<summary>
@@ -341,6 +346,14 @@ ListTelemetryRulesForOrganization
341346

342347
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/observabilityadmin/command/ListTelemetryRulesForOrganizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/ListTelemetryRulesForOrganizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/ListTelemetryRulesForOrganizationCommandOutput/)
343348

349+
</details>
350+
<details>
351+
<summary>
352+
StartTelemetryEnrichment
353+
</summary>
354+
355+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/observabilityadmin/command/StartTelemetryEnrichmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/StartTelemetryEnrichmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/StartTelemetryEnrichmentCommandOutput/)
356+
344357
</details>
345358
<details>
346359
<summary>
@@ -357,6 +370,14 @@ StartTelemetryEvaluationForOrganization
357370

358371
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/observabilityadmin/command/StartTelemetryEvaluationForOrganizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/StartTelemetryEvaluationForOrganizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/StartTelemetryEvaluationForOrganizationCommandOutput/)
359372

373+
</details>
374+
<details>
375+
<summary>
376+
StopTelemetryEnrichment
377+
</summary>
378+
379+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/observabilityadmin/command/StopTelemetryEnrichmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/StopTelemetryEnrichmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-observabilityadmin/Interface/StopTelemetryEnrichmentCommandOutput/)
380+
360381
</details>
361382
<details>
362383
<summary>

clients/client-observabilityadmin/src/ObservabilityAdmin.ts

Lines changed: 73 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ import {
3737
GetCentralizationRuleForOrganizationCommandInput,
3838
GetCentralizationRuleForOrganizationCommandOutput,
3939
} from "./commands/GetCentralizationRuleForOrganizationCommand";
40+
import {
41+
GetTelemetryEnrichmentStatusCommand,
42+
GetTelemetryEnrichmentStatusCommandInput,
43+
GetTelemetryEnrichmentStatusCommandOutput,
44+
} from "./commands/GetTelemetryEnrichmentStatusCommand";
4045
import {
4146
GetTelemetryEvaluationStatusCommand,
4247
GetTelemetryEvaluationStatusCommandInput,
@@ -87,6 +92,11 @@ import {
8792
ListTelemetryRulesForOrganizationCommandInput,
8893
ListTelemetryRulesForOrganizationCommandOutput,
8994
} from "./commands/ListTelemetryRulesForOrganizationCommand";
95+
import {
96+
StartTelemetryEnrichmentCommand,
97+
StartTelemetryEnrichmentCommandInput,
98+
StartTelemetryEnrichmentCommandOutput,
99+
} from "./commands/StartTelemetryEnrichmentCommand";
90100
import {
91101
StartTelemetryEvaluationCommand,
92102
StartTelemetryEvaluationCommandInput,
@@ -97,6 +107,11 @@ import {
97107
StartTelemetryEvaluationForOrganizationCommandInput,
98108
StartTelemetryEvaluationForOrganizationCommandOutput,
99109
} from "./commands/StartTelemetryEvaluationForOrganizationCommand";
110+
import {
111+
StopTelemetryEnrichmentCommand,
112+
StopTelemetryEnrichmentCommandInput,
113+
StopTelemetryEnrichmentCommandOutput,
114+
} from "./commands/StopTelemetryEnrichmentCommand";
100115
import {
101116
StopTelemetryEvaluationCommand,
102117
StopTelemetryEvaluationCommandInput,
@@ -138,6 +153,7 @@ const commands = {
138153
DeleteTelemetryRuleCommand,
139154
DeleteTelemetryRuleForOrganizationCommand,
140155
GetCentralizationRuleForOrganizationCommand,
156+
GetTelemetryEnrichmentStatusCommand,
141157
GetTelemetryEvaluationStatusCommand,
142158
GetTelemetryEvaluationStatusForOrganizationCommand,
143159
GetTelemetryRuleCommand,
@@ -148,8 +164,10 @@ const commands = {
148164
ListTagsForResourceCommand,
149165
ListTelemetryRulesCommand,
150166
ListTelemetryRulesForOrganizationCommand,
167+
StartTelemetryEnrichmentCommand,
151168
StartTelemetryEvaluationCommand,
152169
StartTelemetryEvaluationForOrganizationCommand,
170+
StopTelemetryEnrichmentCommand,
153171
StopTelemetryEvaluationCommand,
154172
StopTelemetryEvaluationForOrganizationCommand,
155173
TagResourceCommand,
@@ -279,6 +297,24 @@ export interface ObservabilityAdmin {
279297
cb: (err: any, data?: GetCentralizationRuleForOrganizationCommandOutput) => void
280298
): void;
281299

300+
/**
301+
* @see {@link GetTelemetryEnrichmentStatusCommand}
302+
*/
303+
getTelemetryEnrichmentStatus(): Promise<GetTelemetryEnrichmentStatusCommandOutput>;
304+
getTelemetryEnrichmentStatus(
305+
args: GetTelemetryEnrichmentStatusCommandInput,
306+
options?: __HttpHandlerOptions
307+
): Promise<GetTelemetryEnrichmentStatusCommandOutput>;
308+
getTelemetryEnrichmentStatus(
309+
args: GetTelemetryEnrichmentStatusCommandInput,
310+
cb: (err: any, data?: GetTelemetryEnrichmentStatusCommandOutput) => void
311+
): void;
312+
getTelemetryEnrichmentStatus(
313+
args: GetTelemetryEnrichmentStatusCommandInput,
314+
options: __HttpHandlerOptions,
315+
cb: (err: any, data?: GetTelemetryEnrichmentStatusCommandOutput) => void
316+
): void;
317+
282318
/**
283319
* @see {@link GetTelemetryEvaluationStatusCommand}
284320
*/
@@ -456,6 +492,24 @@ export interface ObservabilityAdmin {
456492
cb: (err: any, data?: ListTelemetryRulesForOrganizationCommandOutput) => void
457493
): void;
458494

495+
/**
496+
* @see {@link StartTelemetryEnrichmentCommand}
497+
*/
498+
startTelemetryEnrichment(): Promise<StartTelemetryEnrichmentCommandOutput>;
499+
startTelemetryEnrichment(
500+
args: StartTelemetryEnrichmentCommandInput,
501+
options?: __HttpHandlerOptions
502+
): Promise<StartTelemetryEnrichmentCommandOutput>;
503+
startTelemetryEnrichment(
504+
args: StartTelemetryEnrichmentCommandInput,
505+
cb: (err: any, data?: StartTelemetryEnrichmentCommandOutput) => void
506+
): void;
507+
startTelemetryEnrichment(
508+
args: StartTelemetryEnrichmentCommandInput,
509+
options: __HttpHandlerOptions,
510+
cb: (err: any, data?: StartTelemetryEnrichmentCommandOutput) => void
511+
): void;
512+
459513
/**
460514
* @see {@link StartTelemetryEvaluationCommand}
461515
*/
@@ -492,6 +546,24 @@ export interface ObservabilityAdmin {
492546
cb: (err: any, data?: StartTelemetryEvaluationForOrganizationCommandOutput) => void
493547
): void;
494548

549+
/**
550+
* @see {@link StopTelemetryEnrichmentCommand}
551+
*/
552+
stopTelemetryEnrichment(): Promise<StopTelemetryEnrichmentCommandOutput>;
553+
stopTelemetryEnrichment(
554+
args: StopTelemetryEnrichmentCommandInput,
555+
options?: __HttpHandlerOptions
556+
): Promise<StopTelemetryEnrichmentCommandOutput>;
557+
stopTelemetryEnrichment(
558+
args: StopTelemetryEnrichmentCommandInput,
559+
cb: (err: any, data?: StopTelemetryEnrichmentCommandOutput) => void
560+
): void;
561+
stopTelemetryEnrichment(
562+
args: StopTelemetryEnrichmentCommandInput,
563+
options: __HttpHandlerOptions,
564+
cb: (err: any, data?: StopTelemetryEnrichmentCommandOutput) => void
565+
): void;
566+
495567
/**
496568
* @see {@link StopTelemetryEvaluationCommand}
497569
*/
@@ -603,10 +675,7 @@ export interface ObservabilityAdmin {
603675
}
604676

605677
/**
606-
* <p>
607-
* You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment.
608-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p>
609-
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
678+
* <p> You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p> <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
610679
* @public
611680
*/
612681
export class ObservabilityAdmin extends ObservabilityAdminClient implements ObservabilityAdmin {}

clients/client-observabilityadmin/src/ObservabilityAdminClient.ts

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ import {
8181
GetCentralizationRuleForOrganizationCommandInput,
8282
GetCentralizationRuleForOrganizationCommandOutput,
8383
} from "./commands/GetCentralizationRuleForOrganizationCommand";
84+
import {
85+
GetTelemetryEnrichmentStatusCommandInput,
86+
GetTelemetryEnrichmentStatusCommandOutput,
87+
} from "./commands/GetTelemetryEnrichmentStatusCommand";
8488
import {
8589
GetTelemetryEvaluationStatusCommandInput,
8690
GetTelemetryEvaluationStatusCommandOutput,
@@ -115,6 +119,10 @@ import {
115119
ListTelemetryRulesForOrganizationCommandInput,
116120
ListTelemetryRulesForOrganizationCommandOutput,
117121
} from "./commands/ListTelemetryRulesForOrganizationCommand";
122+
import {
123+
StartTelemetryEnrichmentCommandInput,
124+
StartTelemetryEnrichmentCommandOutput,
125+
} from "./commands/StartTelemetryEnrichmentCommand";
118126
import {
119127
StartTelemetryEvaluationCommandInput,
120128
StartTelemetryEvaluationCommandOutput,
@@ -123,6 +131,10 @@ import {
123131
StartTelemetryEvaluationForOrganizationCommandInput,
124132
StartTelemetryEvaluationForOrganizationCommandOutput,
125133
} from "./commands/StartTelemetryEvaluationForOrganizationCommand";
134+
import {
135+
StopTelemetryEnrichmentCommandInput,
136+
StopTelemetryEnrichmentCommandOutput,
137+
} from "./commands/StopTelemetryEnrichmentCommand";
126138
import {
127139
StopTelemetryEvaluationCommandInput,
128140
StopTelemetryEvaluationCommandOutput,
@@ -167,6 +179,7 @@ export type ServiceInputTypes =
167179
| DeleteTelemetryRuleCommandInput
168180
| DeleteTelemetryRuleForOrganizationCommandInput
169181
| GetCentralizationRuleForOrganizationCommandInput
182+
| GetTelemetryEnrichmentStatusCommandInput
170183
| GetTelemetryEvaluationStatusCommandInput
171184
| GetTelemetryEvaluationStatusForOrganizationCommandInput
172185
| GetTelemetryRuleCommandInput
@@ -177,8 +190,10 @@ export type ServiceInputTypes =
177190
| ListTagsForResourceCommandInput
178191
| ListTelemetryRulesCommandInput
179192
| ListTelemetryRulesForOrganizationCommandInput
193+
| StartTelemetryEnrichmentCommandInput
180194
| StartTelemetryEvaluationCommandInput
181195
| StartTelemetryEvaluationForOrganizationCommandInput
196+
| StopTelemetryEnrichmentCommandInput
182197
| StopTelemetryEvaluationCommandInput
183198
| StopTelemetryEvaluationForOrganizationCommandInput
184199
| TagResourceCommandInput
@@ -198,6 +213,7 @@ export type ServiceOutputTypes =
198213
| DeleteTelemetryRuleCommandOutput
199214
| DeleteTelemetryRuleForOrganizationCommandOutput
200215
| GetCentralizationRuleForOrganizationCommandOutput
216+
| GetTelemetryEnrichmentStatusCommandOutput
201217
| GetTelemetryEvaluationStatusCommandOutput
202218
| GetTelemetryEvaluationStatusForOrganizationCommandOutput
203219
| GetTelemetryRuleCommandOutput
@@ -208,8 +224,10 @@ export type ServiceOutputTypes =
208224
| ListTagsForResourceCommandOutput
209225
| ListTelemetryRulesCommandOutput
210226
| ListTelemetryRulesForOrganizationCommandOutput
227+
| StartTelemetryEnrichmentCommandOutput
211228
| StartTelemetryEvaluationCommandOutput
212229
| StartTelemetryEvaluationForOrganizationCommandOutput
230+
| StopTelemetryEnrichmentCommandOutput
213231
| StopTelemetryEvaluationCommandOutput
214232
| StopTelemetryEvaluationForOrganizationCommandOutput
215233
| TagResourceCommandOutput
@@ -409,10 +427,7 @@ export type ObservabilityAdminClientResolvedConfigType = __SmithyResolvedConfigu
409427
export interface ObservabilityAdminClientResolvedConfig extends ObservabilityAdminClientResolvedConfigType {}
410428

411429
/**
412-
* <p>
413-
* You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment.
414-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p>
415-
* <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
430+
* <p> You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p> <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
416431
* @public
417432
*/
418433
export class ObservabilityAdminClient extends __Client<

0 commit comments

Comments
 (0)