Skip to content

Commit 94b32c5

Browse files
author
AWS
committed
CloudWatch Observability Admin Service Update: 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 8565bec commit 94b32c5

File tree

3 files changed

+130
-15
lines changed

3 files changed

+130
-15
lines changed

‎.changes/next-release/feature-CloudWatchObservabilityAdminService-1ed44eb.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "CloudWatch Observability Admin Service",
4+
"contributor": "",
5+
"description": "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."
6+
}

‎services/observabilityadmin/src/main/resources/codegen-resources/endpoint-rule-set.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
"builtIn": "AWS::Region",
66
"required": false,
77
"documentation": "The AWS region used to dispatch the request.",
8-
"type": "String"
8+
"type": "string"
99
},
1010
"UseDualStack": {
1111
"builtIn": "AWS::UseDualStack",
1212
"required": true,
1313
"default": false,
1414
"documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
15-
"type": "Boolean"
15+
"type": "boolean"
1616
},
1717
"UseFIPS": {
1818
"builtIn": "AWS::UseFIPS",
1919
"required": true,
2020
"default": false,
2121
"documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
22-
"type": "Boolean"
22+
"type": "boolean"
2323
},
2424
"Endpoint": {
2525
"builtIn": "SDK::Endpoint",
2626
"required": false,
2727
"documentation": "Override the endpoint used to send this request",
28-
"type": "String"
28+
"type": "string"
2929
}
3030
},
3131
"rules": [

‎services/observabilityadmin/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 120 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,25 @@
137137
{"shape":"ValidationException"},
138138
{"shape":"TooManyRequestsException"}
139139
],
140-
"documentation":"<p>Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.</p>"
140+
"documentation":"<p>Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.</p>",
141+
"readonly":true
142+
},
143+
"GetTelemetryEnrichmentStatus":{
144+
"name":"GetTelemetryEnrichmentStatus",
145+
"http":{
146+
"method":"POST",
147+
"requestUri":"/GetTelemetryEnrichmentStatus",
148+
"responseCode":200
149+
},
150+
"output":{"shape":"GetTelemetryEnrichmentStatusOutput"},
151+
"errors":[
152+
{"shape":"ResourceNotFoundException"},
153+
{"shape":"AccessDeniedException"},
154+
{"shape":"InternalServerException"},
155+
{"shape":"TooManyRequestsException"}
156+
],
157+
"documentation":"<p> Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Amazon Web Services Resource Explorer. </p>",
158+
"readonly":true
141159
},
142160
"GetTelemetryEvaluationStatus":{
143161
"name":"GetTelemetryEvaluationStatus",
@@ -152,7 +170,8 @@
152170
{"shape":"InternalServerException"},
153171
{"shape":"TooManyRequestsException"}
154172
],
155-
"documentation":"<p> Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop. </p>"
173+
"documentation":"<p> Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop. </p>",
174+
"readonly":true
156175
},
157176
"GetTelemetryEvaluationStatusForOrganization":{
158177
"name":"GetTelemetryEvaluationStatusForOrganization",
@@ -168,7 +187,8 @@
168187
{"shape":"ValidationException"},
169188
{"shape":"TooManyRequestsException"}
170189
],
171-
"documentation":"<p> This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config. </p>"
190+
"documentation":"<p> This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config. </p>",
191+
"readonly":true
172192
},
173193
"GetTelemetryRule":{
174194
"name":"GetTelemetryRule",
@@ -186,7 +206,8 @@
186206
{"shape":"ValidationException"},
187207
{"shape":"TooManyRequestsException"}
188208
],
189-
"documentation":"<p> Retrieves the details of a specific telemetry rule in your account. </p>"
209+
"documentation":"<p> Retrieves the details of a specific telemetry rule in your account. </p>",
210+
"readonly":true
190211
},
191212
"GetTelemetryRuleForOrganization":{
192213
"name":"GetTelemetryRuleForOrganization",
@@ -204,7 +225,8 @@
204225
{"shape":"ValidationException"},
205226
{"shape":"TooManyRequestsException"}
206227
],
207-
"documentation":"<p> Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account. </p>"
228+
"documentation":"<p> Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account. </p>",
229+
"readonly":true
208230
},
209231
"ListCentralizationRulesForOrganization":{
210232
"name":"ListCentralizationRulesForOrganization",
@@ -221,7 +243,8 @@
221243
{"shape":"ValidationException"},
222244
{"shape":"TooManyRequestsException"}
223245
],
224-
"documentation":"<p>Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.</p>"
246+
"documentation":"<p>Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.</p>",
247+
"readonly":true
225248
},
226249
"ListResourceTelemetry":{
227250
"name":"ListResourceTelemetry",
@@ -238,7 +261,8 @@
238261
{"shape":"ValidationException"},
239262
{"shape":"TooManyRequestsException"}
240263
],
241-
"documentation":"<p> Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html\">Auditing CloudWatch telemetry configurations</a>. </p>"
264+
"documentation":"<p> Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html\">Auditing CloudWatch telemetry configurations</a>. </p>",
265+
"readonly":true
242266
},
243267
"ListResourceTelemetryForOrganization":{
244268
"name":"ListResourceTelemetryForOrganization",
@@ -255,7 +279,8 @@
255279
{"shape":"ValidationException"},
256280
{"shape":"TooManyRequestsException"}
257281
],
258-
"documentation":"<p> Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization. </p>"
282+
"documentation":"<p> Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization. </p>",
283+
"readonly":true
259284
},
260285
"ListTagsForResource":{
261286
"name":"ListTagsForResource",
@@ -273,7 +298,8 @@
273298
{"shape":"ValidationException"},
274299
{"shape":"TooManyRequestsException"}
275300
],
276-
"documentation":"<p> Lists all tags attached to the specified telemetry rule resource. </p>"
301+
"documentation":"<p> Lists all tags attached to the specified telemetry rule resource. </p>",
302+
"readonly":true
277303
},
278304
"ListTelemetryRules":{
279305
"name":"ListTelemetryRules",
@@ -290,7 +316,8 @@
290316
{"shape":"ValidationException"},
291317
{"shape":"TooManyRequestsException"}
292318
],
293-
"documentation":"<p> Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix. </p>"
319+
"documentation":"<p> Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix. </p>",
320+
"readonly":true
294321
},
295322
"ListTelemetryRulesForOrganization":{
296323
"name":"ListTelemetryRulesForOrganization",
@@ -307,7 +334,24 @@
307334
{"shape":"ValidationException"},
308335
{"shape":"TooManyRequestsException"}
309336
],
310-
"documentation":"<p> Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account. </p>"
337+
"documentation":"<p> Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account. </p>",
338+
"readonly":true
339+
},
340+
"StartTelemetryEnrichment":{
341+
"name":"StartTelemetryEnrichment",
342+
"http":{
343+
"method":"POST",
344+
"requestUri":"/StartTelemetryEnrichment",
345+
"responseCode":202
346+
},
347+
"output":{"shape":"StartTelemetryEnrichmentOutput"},
348+
"errors":[
349+
{"shape":"ConflictException"},
350+
{"shape":"AccessDeniedException"},
351+
{"shape":"InternalServerException"},
352+
{"shape":"TooManyRequestsException"}
353+
],
354+
"documentation":"<p> Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Amazon Web Services Resource Explorer to provide richer context for monitoring and observability. </p>"
311355
},
312356
"StartTelemetryEvaluation":{
313357
"name":"StartTelemetryEvaluation",
@@ -339,6 +383,22 @@
339383
],
340384
"documentation":"<p> This actions begins onboarding the organization and all member accounts to the telemetry config feature. </p>"
341385
},
386+
"StopTelemetryEnrichment":{
387+
"name":"StopTelemetryEnrichment",
388+
"http":{
389+
"method":"POST",
390+
"requestUri":"/StopTelemetryEnrichment",
391+
"responseCode":202
392+
},
393+
"output":{"shape":"StopTelemetryEnrichmentOutput"},
394+
"errors":[
395+
{"shape":"ConflictException"},
396+
{"shape":"AccessDeniedException"},
397+
{"shape":"InternalServerException"},
398+
{"shape":"TooManyRequestsException"}
399+
],
400+
"documentation":"<p> Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata. </p>"
401+
},
342402
"StopTelemetryEvaluation":{
343403
"name":"StopTelemetryEvaluation",
344404
"http":{
@@ -493,6 +553,12 @@
493553
"max":10,
494554
"min":1
495555
},
556+
"AwsResourceExplorerManagedViewArn":{
557+
"type":"string",
558+
"max":2048,
559+
"min":20,
560+
"pattern":"arn:aws([a-z0-9\\-]+)?:resource-explorer-2:([a-z0-9\\-]+)?:([0-9]{12})?:managed-view/(.+)"
561+
},
496562
"Boolean":{
497563
"type":"boolean",
498564
"box":true
@@ -834,6 +900,19 @@
834900
}
835901
}
836902
},
903+
"GetTelemetryEnrichmentStatusOutput":{
904+
"type":"structure",
905+
"members":{
906+
"Status":{
907+
"shape":"TelemetryEnrichmentStatus",
908+
"documentation":"<p> The current status of the resource tags for telemetry feature (<code>Running</code>, <code>Stopped</code>, or <code>Impaired</code>). </p>"
909+
},
910+
"AwsResourceExplorerManagedViewArn":{
911+
"shape":"AwsResourceExplorerManagedViewArn",
912+
"documentation":"<p> The Amazon Resource Name (ARN) of the Amazon Web Services Resource Explorer managed view used for resource tags for telemetry, if the feature is enabled. </p>"
913+
}
914+
}
915+
},
837916
"GetTelemetryEvaluationStatusForOrganizationOutput":{
838917
"type":"structure",
839918
"members":{
@@ -1361,6 +1440,19 @@
13611440
},
13621441
"documentation":"<p>Configuration for selecting and handling source log groups for centralization.</p>"
13631442
},
1443+
"StartTelemetryEnrichmentOutput":{
1444+
"type":"structure",
1445+
"members":{
1446+
"Status":{
1447+
"shape":"TelemetryEnrichmentStatus",
1448+
"documentation":"<p> The status of the resource tags for telemetry feature after the start operation (<code>Running</code>, <code>Stopped</code>, or <code>Impaired</code>). </p>"
1449+
},
1450+
"AwsResourceExplorerManagedViewArn":{
1451+
"shape":"AwsResourceExplorerManagedViewArn",
1452+
"documentation":"<p> The Amazon Resource Name (ARN) of the Amazon Web Services Resource Explorer managed view created for resource tags for telemetry. </p>"
1453+
}
1454+
}
1455+
},
13641456
"Status":{
13651457
"type":"string",
13661458
"enum":[
@@ -1373,6 +1465,15 @@
13731465
"STOPPED"
13741466
]
13751467
},
1468+
"StopTelemetryEnrichmentOutput":{
1469+
"type":"structure",
1470+
"members":{
1471+
"Status":{
1472+
"shape":"TelemetryEnrichmentStatus",
1473+
"documentation":"<p> The status of the resource tags for telemetry feature after the stop operation (<code>Running</code>, <code>Stopped</code>, or <code>Impaired</code>). </p>"
1474+
}
1475+
}
1476+
},
13761477
"String":{"type":"string"},
13771478
"TagKey":{
13781479
"type":"string",
@@ -1482,6 +1583,14 @@
14821583
},
14831584
"documentation":"<p> Configuration specifying where and how telemetry data should be delivered for Amazon Web Services resources. </p>"
14841585
},
1586+
"TelemetryEnrichmentStatus":{
1587+
"type":"string",
1588+
"enum":[
1589+
"Running",
1590+
"Stopped",
1591+
"Impaired"
1592+
]
1593+
},
14851594
"TelemetryRule":{
14861595
"type":"structure",
14871596
"required":["TelemetryType"],

0 commit comments

Comments
 (0)