Skip to content

Commit e043e0c

Browse files
author
AWS
committed
Amazon CloudWatch Application Signals Update: This release adds support for adding, removing, and listing SLO time exclusion windows with the BatchUpdateExclusionWindows and ListServiceLevelObjectiveExclusionWindows APIs.
1 parent 168d4a2 commit e043e0c

File tree

3 files changed

+227
-0
lines changed

3 files changed

+227
-0
lines changed

‎.changes/next-release/feature-AmazonCloudWatchApplicationSignals-970bcd9.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": "Amazon CloudWatch Application Signals",
4+
"contributor": "",
5+
"description": "This release adds support for adding, removing, and listing SLO time exclusion windows with the BatchUpdateExclusionWindows and ListServiceLevelObjectiveExclusionWindows APIs."
6+
}

‎services/applicationsignals/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
"limit_key": "MaxResults",
1313
"result_key": "ServiceDependents"
1414
},
15+
"ListServiceLevelObjectiveExclusionWindows": {
16+
"input_token": "NextToken",
17+
"output_token": "NextToken",
18+
"limit_key": "MaxResults",
19+
"result_key": "ExclusionWindows"
20+
},
1521
"ListServiceLevelObjectives": {
1622
"input_token": "NextToken",
1723
"output_token": "NextToken",

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

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,22 @@
2828
],
2929
"documentation":"<p>Use this operation to retrieve one or more <i>service level objective (SLO) budget reports</i>.</p> <p>An <i>error budget</i> is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.</p> <p>Budget reports include a health indicator, the attainment value, and remaining budget.</p> <p>For more information about SLO error budgets, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-concepts\"> SLO concepts</a>.</p>"
3030
},
31+
"BatchUpdateExclusionWindows":{
32+
"name":"BatchUpdateExclusionWindows",
33+
"http":{
34+
"method":"PATCH",
35+
"requestUri":"/exclusion-windows",
36+
"responseCode":200
37+
},
38+
"input":{"shape":"BatchUpdateExclusionWindowsInput"},
39+
"output":{"shape":"BatchUpdateExclusionWindowsOutput"},
40+
"errors":[
41+
{"shape":"ValidationException"},
42+
{"shape":"ResourceNotFoundException"},
43+
{"shape":"ThrottlingException"}
44+
],
45+
"documentation":"<p>Add or remove time window exclusions for one or more Service Level Objectives (SLOs).</p>"
46+
},
3147
"CreateServiceLevelObjective":{
3248
"name":"CreateServiceLevelObjective",
3349
"http":{
@@ -124,6 +140,22 @@
124140
],
125141
"documentation":"<p>Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.</p>"
126142
},
143+
"ListServiceLevelObjectiveExclusionWindows":{
144+
"name":"ListServiceLevelObjectiveExclusionWindows",
145+
"http":{
146+
"method":"GET",
147+
"requestUri":"/slo/{Id}/exclusion-windows",
148+
"responseCode":200
149+
},
150+
"input":{"shape":"ListServiceLevelObjectiveExclusionWindowsInput"},
151+
"output":{"shape":"ListServiceLevelObjectiveExclusionWindowsOutput"},
152+
"errors":[
153+
{"shape":"ValidationException"},
154+
{"shape":"ResourceNotFoundException"},
155+
{"shape":"ThrottlingException"}
156+
],
157+
"documentation":"<p>Retrieves all exclusion windows configured for a specific SLO.</p>"
158+
},
127159
"ListServiceLevelObjectives":{
128160
"name":"ListServiceLevelObjectives",
129161
"http":{
@@ -338,6 +370,70 @@
338370
}
339371
}
340372
},
373+
"BatchUpdateExclusionWindowsError":{
374+
"type":"structure",
375+
"required":[
376+
"SloId",
377+
"ErrorCode",
378+
"ErrorMessage"
379+
],
380+
"members":{
381+
"SloId":{
382+
"shape":"ServiceLevelObjectiveId",
383+
"documentation":"<p>The SLO ID in the error.</p>"
384+
},
385+
"ErrorCode":{
386+
"shape":"ExclusionWindowErrorCode",
387+
"documentation":"<p>The error code.</p>"
388+
},
389+
"ErrorMessage":{
390+
"shape":"ExclusionWindowErrorMessage",
391+
"documentation":"<p>The error message.</p>"
392+
}
393+
},
394+
"documentation":"<p>An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.</p>"
395+
},
396+
"BatchUpdateExclusionWindowsErrors":{
397+
"type":"list",
398+
"member":{"shape":"BatchUpdateExclusionWindowsError"},
399+
"max":10,
400+
"min":0
401+
},
402+
"BatchUpdateExclusionWindowsInput":{
403+
"type":"structure",
404+
"required":["SloIds"],
405+
"members":{
406+
"SloIds":{
407+
"shape":"ServiceLevelObjectiveIds",
408+
"documentation":"<p>The list of SLO IDs to add or remove exclusion windows from.</p>"
409+
},
410+
"AddExclusionWindows":{
411+
"shape":"ExclusionWindows",
412+
"documentation":"<p>A list of exclusion windows to add to the specified SLOs. You can add up to 10 exclusion windows per SLO.</p>"
413+
},
414+
"RemoveExclusionWindows":{
415+
"shape":"ExclusionWindows",
416+
"documentation":"<p>A list of exclusion windows to remove from the specified SLOs. The window configuration must match an existing exclusion window.</p>"
417+
}
418+
}
419+
},
420+
"BatchUpdateExclusionWindowsOutput":{
421+
"type":"structure",
422+
"required":[
423+
"SloIds",
424+
"Errors"
425+
],
426+
"members":{
427+
"SloIds":{
428+
"shape":"ServiceLevelObjectiveIds",
429+
"documentation":"<p>The list of SLO IDs that were successfully processed.</p>"
430+
},
431+
"Errors":{
432+
"shape":"BatchUpdateExclusionWindowsErrors",
433+
"documentation":"<p>A list of errors that occurred while processing the request.</p>"
434+
}
435+
}
436+
},
341437
"Boolean":{
342438
"type":"boolean",
343439
"box":true
@@ -525,6 +621,52 @@
525621
"RequestBased"
526622
]
527623
},
624+
"ExclusionDuration":{
625+
"type":"integer",
626+
"box":true,
627+
"min":1
628+
},
629+
"ExclusionReason":{
630+
"type":"string",
631+
"max":1024,
632+
"min":1
633+
},
634+
"ExclusionWindow":{
635+
"type":"structure",
636+
"required":["Window"],
637+
"members":{
638+
"Window":{
639+
"shape":"Window",
640+
"documentation":"<p>The SLO time window exclusion .</p>"
641+
},
642+
"StartTime":{
643+
"shape":"Timestamp",
644+
"documentation":"<p>The start of the SLO time window exclusion. Defaults to current time if not specified.</p>"
645+
},
646+
"RecurrenceRule":{
647+
"shape":"RecurrenceRule",
648+
"documentation":"<p>The recurrence rule for the SLO time window exclusion. Supports both cron and rate expressions.</p>"
649+
},
650+
"Reason":{
651+
"shape":"ExclusionReason",
652+
"documentation":"<p>A description explaining why this time period should be excluded from SLO calculations.</p>"
653+
}
654+
},
655+
"documentation":"<p>The core SLO time window exclusion object that includes Window, StartTime, RecurrenceRule, and Reason.</p>"
656+
},
657+
"ExclusionWindowErrorCode":{"type":"string"},
658+
"ExclusionWindowErrorMessage":{"type":"string"},
659+
"ExclusionWindows":{
660+
"type":"list",
661+
"member":{"shape":"ExclusionWindow"},
662+
"max":10,
663+
"min":0
664+
},
665+
"Expression":{
666+
"type":"string",
667+
"max":1024,
668+
"min":1
669+
},
528670
"FaultDescription":{"type":"string"},
529671
"GetServiceInput":{
530672
"type":"structure",
@@ -783,6 +925,50 @@
783925
}
784926
}
785927
},
928+
"ListServiceLevelObjectiveExclusionWindowsInput":{
929+
"type":"structure",
930+
"required":["Id"],
931+
"members":{
932+
"Id":{
933+
"shape":"ServiceLevelObjectiveId",
934+
"documentation":"<p>The ID of the SLO to list exclusion windows for.</p>",
935+
"location":"uri",
936+
"locationName":"Id"
937+
},
938+
"MaxResults":{
939+
"shape":"ListServiceLevelObjectiveExclusionWindowsMaxResults",
940+
"documentation":"<p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. <pre><code> &lt;/p&gt; </code></pre>",
941+
"location":"querystring",
942+
"locationName":"MaxResults"
943+
},
944+
"NextToken":{
945+
"shape":"NextToken",
946+
"documentation":"<p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives. <pre><code> &lt;/p&gt; </code></pre>",
947+
"location":"querystring",
948+
"locationName":"NextToken"
949+
}
950+
}
951+
},
952+
"ListServiceLevelObjectiveExclusionWindowsMaxResults":{
953+
"type":"integer",
954+
"box":true,
955+
"max":10,
956+
"min":1
957+
},
958+
"ListServiceLevelObjectiveExclusionWindowsOutput":{
959+
"type":"structure",
960+
"required":["ExclusionWindows"],
961+
"members":{
962+
"ExclusionWindows":{
963+
"shape":"ExclusionWindows",
964+
"documentation":"<p>A list of exclusion windows configured for the SLO.</p>"
965+
},
966+
"NextToken":{
967+
"shape":"NextToken",
968+
"documentation":"<p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives. <pre><code> &lt;/p&gt; </code></pre>"
969+
}
970+
}
971+
},
786972
"ListServiceLevelObjectivesInput":{
787973
"type":"structure",
788974
"members":{
@@ -1184,6 +1370,17 @@
11841370
"box":true,
11851371
"min":1
11861372
},
1373+
"RecurrenceRule":{
1374+
"type":"structure",
1375+
"required":["Expression"],
1376+
"members":{
1377+
"Expression":{
1378+
"shape":"Expression",
1379+
"documentation":"<p>A cron or rate expression that specifies the schedule for the exclusion window.</p>"
1380+
}
1381+
},
1382+
"documentation":"<p>The recurrence rule for the SLO time window exclusion .</p>"
1383+
},
11871384
"RequestBasedServiceLevelIndicator":{
11881385
"type":"structure",
11891386
"required":["RequestBasedSliMetric"],
@@ -2040,6 +2237,24 @@
20402237
"WarningThreshold":{
20412238
"type":"double",
20422239
"box":true
2240+
},
2241+
"Window":{
2242+
"type":"structure",
2243+
"required":[
2244+
"DurationUnit",
2245+
"Duration"
2246+
],
2247+
"members":{
2248+
"DurationUnit":{
2249+
"shape":"DurationUnit",
2250+
"documentation":"<p>The unit of time for the exclusion window duration. Valid values: MINUTE, HOUR, DAY, MONTH.</p>"
2251+
},
2252+
"Duration":{
2253+
"shape":"ExclusionDuration",
2254+
"documentation":"<p>The number of time units for the exclusion window length.</p>"
2255+
}
2256+
},
2257+
"documentation":"<p>The object that defines the time length of an exclusion window.</p>"
20432258
}
20442259
},
20452260
"documentation":"<p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.</p> <p>Application Signals provides the following benefits:</p> <ul> <li> <p>Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors. </p> </li> <li> <p>Create and monitor service level objectives (SLOs). </p> </li> <li> <p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p> </li> </ul> <p>Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.</p>"

0 commit comments

Comments
 (0)