@aws-sdk/client-application-signals 3.896.0 → 3.900.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 +41 -19
- package/dist-cjs/index.js +373 -0
- package/dist-es/ApplicationSignals.js +10 -0
- package/dist-es/commands/DeleteGroupingConfigurationCommand.js +22 -0
- package/dist-es/commands/ListAuditFindingsCommand.js +22 -0
- package/dist-es/commands/ListGroupingAttributeDefinitionsCommand.js +22 -0
- package/dist-es/commands/ListServiceStatesCommand.js +22 -0
- package/dist-es/commands/PutGroupingConfigurationCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +26 -0
- package/dist-es/pagination/ListServiceStatesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +250 -0
- package/dist-types/ApplicationSignals.d.ts +38 -19
- package/dist-types/ApplicationSignalsClient.d.ts +8 -21
- package/dist-types/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.d.ts +1 -11
- package/dist-types/commands/CreateServiceLevelObjectiveCommand.d.ts +2 -90
- package/dist-types/commands/DeleteGroupingConfigurationCommand.d.ts +79 -0
- package/dist-types/commands/GetServiceCommand.d.ts +8 -0
- package/dist-types/commands/ListAuditFindingsCommand.d.ts +181 -0
- package/dist-types/commands/ListGroupingAttributeDefinitionsCommand.d.ts +93 -0
- package/dist-types/commands/ListServiceDependenciesCommand.d.ts +1 -4
- package/dist-types/commands/ListServiceDependentsCommand.d.ts +1 -2
- package/dist-types/commands/ListServiceLevelObjectivesCommand.d.ts +2 -2
- package/dist-types/commands/ListServiceOperationsCommand.d.ts +1 -2
- package/dist-types/commands/ListServiceStatesCommand.d.ts +124 -0
- package/dist-types/commands/ListServicesCommand.d.ts +9 -3
- package/dist-types/commands/PutGroupingConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/StartDiscoveryCommand.d.ts +1 -44
- package/dist-types/commands/TagResourceCommand.d.ts +1 -10
- package/dist-types/commands/UpdateServiceLevelObjectiveCommand.d.ts +2 -4
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +1 -19
- package/dist-types/models/models_0.d.ts +812 -1114
- package/dist-types/pagination/ListServiceStatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/ApplicationSignals.d.ts +87 -0
- package/dist-types/ts3.4/ApplicationSignalsClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/DeleteGroupingConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAuditFindingsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListGroupingAttributeDefinitionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListServiceStatesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutGroupingConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +193 -1
- package/dist-types/ts3.4/pagination/ListServiceStatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +11 -11
|
@@ -29,9 +29,7 @@ export interface BatchGetServiceLevelObjectiveBudgetReportInput {
|
|
|
29
29
|
SloIds: string[] | undefined;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* <p>A structure containing information about one error that occurred during a
|
|
33
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_BatchGetServiceLevelObjectiveBudgetReport.html">BatchGetServiceLevelObjectiveBudgetReport</a>
|
|
34
|
-
* operation.</p>
|
|
32
|
+
* <p>A structure containing information about one error that occurred during a <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_BatchGetServiceLevelObjectiveBudgetReport.html">BatchGetServiceLevelObjectiveBudgetReport</a> operation.</p>
|
|
35
33
|
* @public
|
|
36
34
|
*/
|
|
37
35
|
export interface ServiceLevelObjectiveBudgetReportError {
|
|
@@ -102,13 +100,7 @@ export type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
|
|
|
102
100
|
*/
|
|
103
101
|
export interface CalendarInterval {
|
|
104
102
|
/**
|
|
105
|
-
* <p>The date and time when you want the first interval to start. Be sure to choose a time that configures the
|
|
106
|
-
* intervals the way that you want. For example, if you want weekly intervals
|
|
107
|
-
* starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.</p>
|
|
108
|
-
* <p>When used in a raw HTTP Query API, it is formatted as
|
|
109
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
110
|
-
* </p>
|
|
111
|
-
* <p>As soon as one calendar interval ends, another automatically begins.</p>
|
|
103
|
+
* <p>The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.</p> <p>When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>As soon as one calendar interval ends, another automatically begins.</p>
|
|
112
104
|
* @public
|
|
113
105
|
*/
|
|
114
106
|
StartTime: Date | undefined;
|
|
@@ -118,8 +110,7 @@ export interface CalendarInterval {
|
|
|
118
110
|
*/
|
|
119
111
|
DurationUnit: DurationUnit | undefined;
|
|
120
112
|
/**
|
|
121
|
-
* <p>Specifies the duration of each calendar interval. For example, if <code>Duration</code> is <code>1</code> and
|
|
122
|
-
* <code>DurationUnit</code> is <code>MONTH</code>, each interval is one month, aligned with the calendar.</p>
|
|
113
|
+
* <p>Specifies the duration of each calendar interval. For example, if <code>Duration</code> is <code>1</code> and <code>DurationUnit</code> is <code>MONTH</code>, each interval is one month, aligned with the calendar.</p>
|
|
123
114
|
* @public
|
|
124
115
|
*/
|
|
125
116
|
Duration: number | undefined;
|
|
@@ -135,8 +126,7 @@ export interface RollingInterval {
|
|
|
135
126
|
*/
|
|
136
127
|
DurationUnit: DurationUnit | undefined;
|
|
137
128
|
/**
|
|
138
|
-
* <p>Specifies the duration of each rolling interval. For example, if <code>Duration</code> is <code>7</code> and
|
|
139
|
-
* <code>DurationUnit</code> is <code>DAY</code>, each rolling interval is seven days.</p>
|
|
129
|
+
* <p>Specifies the duration of each rolling interval. For example, if <code>Duration</code> is <code>7</code> and <code>DurationUnit</code> is <code>DAY</code>, each rolling interval is seven days.</p>
|
|
140
130
|
* @public
|
|
141
131
|
*/
|
|
142
132
|
Duration: number | undefined;
|
|
@@ -184,33 +174,22 @@ export declare namespace Interval {
|
|
|
184
174
|
const visit: <T>(value: Interval, visitor: Visitor<T>) => T;
|
|
185
175
|
}
|
|
186
176
|
/**
|
|
187
|
-
* <p>This structure contains the attributes that determine the goal of an SLO. This includes
|
|
188
|
-
* the time period for evaluation and the attainment threshold.</p>
|
|
177
|
+
* <p>This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.</p>
|
|
189
178
|
* @public
|
|
190
179
|
*/
|
|
191
180
|
export interface Goal {
|
|
192
181
|
/**
|
|
193
|
-
* <p>The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.</p>
|
|
194
|
-
* <p>If you omit this parameter, a rolling interval of 7 days is used.</p>
|
|
182
|
+
* <p>The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.</p> <p>If you omit this parameter, a rolling interval of 7 days is used.</p>
|
|
195
183
|
* @public
|
|
196
184
|
*/
|
|
197
185
|
Interval?: Interval | undefined;
|
|
198
186
|
/**
|
|
199
|
-
* <p>The threshold that determines if the goal is being met.</p>
|
|
200
|
-
* <p>If this is a period-based SLO, the attainment goal is the
|
|
201
|
-
* percentage of good periods that meet the threshold requirements to the total periods within the interval.
|
|
202
|
-
* For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the
|
|
203
|
-
* periods to be in healthy state.</p>
|
|
204
|
-
* <p>If this is a request-based SLO, the attainment goal is the percentage of requests that must be
|
|
205
|
-
* successful to meet the attainment goal.</p>
|
|
206
|
-
* <p>If you omit this parameter, 99 is used
|
|
207
|
-
* to represent 99% as the attainment goal.</p>
|
|
187
|
+
* <p>The threshold that determines if the goal is being met.</p> <p>If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.</p> <p>If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.</p> <p>If you omit this parameter, 99 is used to represent 99% as the attainment goal.</p>
|
|
208
188
|
* @public
|
|
209
189
|
*/
|
|
210
190
|
AttainmentGoal?: number | undefined;
|
|
211
191
|
/**
|
|
212
|
-
* <p>The percentage of remaining budget over total budget that you want to get warnings for.
|
|
213
|
-
* If you omit this parameter, the default of 50.0 is used. </p>
|
|
192
|
+
* <p>The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used. </p>
|
|
214
193
|
* @public
|
|
215
194
|
*/
|
|
216
195
|
WarningThreshold?: number | undefined;
|
|
@@ -230,41 +209,12 @@ export declare const ServiceLevelIndicatorComparisonOperator: {
|
|
|
230
209
|
*/
|
|
231
210
|
export type ServiceLevelIndicatorComparisonOperator = (typeof ServiceLevelIndicatorComparisonOperator)[keyof typeof ServiceLevelIndicatorComparisonOperator];
|
|
232
211
|
/**
|
|
233
|
-
* <p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>.</p>
|
|
234
|
-
* <p>When creating a service dependency SLO, you must specify the <code>KeyAttributes</code> of the service, and the <code>DependencyConfig</code> for the dependency. You can specify the <code>OperationName</code> of the service, from which it calls the dependency. Alternatively,
|
|
235
|
-
* you can exclude <code>OperationName</code> and the SLO will monitor all of the service's operations that call the dependency.</p>
|
|
212
|
+
* <p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>.</p> <p>When creating a service dependency SLO, you must specify the <code>KeyAttributes</code> of the service, and the <code>DependencyConfig</code> for the dependency. You can specify the <code>OperationName</code> of the service, from which it calls the dependency. Alternatively, you can exclude <code>OperationName</code> and the SLO will monitor all of the service's operations that call the dependency.</p>
|
|
236
213
|
* @public
|
|
237
214
|
*/
|
|
238
215
|
export interface DependencyConfig {
|
|
239
216
|
/**
|
|
240
|
-
* <p>This is a string-to-string map. It can
|
|
241
|
-
* include the following fields.</p>
|
|
242
|
-
* <ul>
|
|
243
|
-
* <li>
|
|
244
|
-
* <p>
|
|
245
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
246
|
-
* </li>
|
|
247
|
-
* <li>
|
|
248
|
-
* <p>
|
|
249
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
250
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
251
|
-
* </li>
|
|
252
|
-
* <li>
|
|
253
|
-
* <p>
|
|
254
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
255
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
256
|
-
* </li>
|
|
257
|
-
* <li>
|
|
258
|
-
* <p>
|
|
259
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
260
|
-
* This is used only if the value of the <code>Type</code> field
|
|
261
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
262
|
-
* </li>
|
|
263
|
-
* <li>
|
|
264
|
-
* <p>
|
|
265
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
266
|
-
* </li>
|
|
267
|
-
* </ul>
|
|
217
|
+
* <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
268
218
|
* @public
|
|
269
219
|
*/
|
|
270
220
|
DependencyKeyAttributes: Record<string, string> | undefined;
|
|
@@ -287,27 +237,17 @@ export declare const ServiceLevelIndicatorMetricType: {
|
|
|
287
237
|
*/
|
|
288
238
|
export type ServiceLevelIndicatorMetricType = (typeof ServiceLevelIndicatorMetricType)[keyof typeof ServiceLevelIndicatorMetricType];
|
|
289
239
|
/**
|
|
290
|
-
* <p>A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique
|
|
291
|
-
* identifier for a metric, whenever you add a unique name/value pair to one of
|
|
292
|
-
* your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish
|
|
293
|
-
* <code>InstanceId</code> as a dimension name, and the actual instance ID as the value for that dimension.</p>
|
|
294
|
-
* <p>You
|
|
295
|
-
* can assign up to 30 dimensions to a metric.</p>
|
|
240
|
+
* <p>A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish <code>InstanceId</code> as a dimension name, and the actual instance ID as the value for that dimension.</p> <p>You can assign up to 30 dimensions to a metric.</p>
|
|
296
241
|
* @public
|
|
297
242
|
*/
|
|
298
243
|
export interface Dimension {
|
|
299
244
|
/**
|
|
300
|
-
* <p>The name of the dimension. Dimension names must contain only ASCII characters, must include
|
|
301
|
-
* at least one non-whitespace character, and cannot start with a colon (<code>:</code>).
|
|
302
|
-
* ASCII
|
|
303
|
-
* control characters are not supported as part of dimension names.</p>
|
|
245
|
+
* <p>The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (<code>:</code>). ASCII control characters are not supported as part of dimension names.</p>
|
|
304
246
|
* @public
|
|
305
247
|
*/
|
|
306
248
|
Name: string | undefined;
|
|
307
249
|
/**
|
|
308
|
-
* <p>The value of the dimension. Dimension values must contain only ASCII characters and must include
|
|
309
|
-
* at least one non-whitespace character. ASCII
|
|
310
|
-
* control characters are not supported as part of dimension values.</p>
|
|
250
|
+
* <p>The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.</p>
|
|
311
251
|
* @public
|
|
312
252
|
*/
|
|
313
253
|
Value: string | undefined;
|
|
@@ -318,8 +258,7 @@ export interface Dimension {
|
|
|
318
258
|
*/
|
|
319
259
|
export interface Metric {
|
|
320
260
|
/**
|
|
321
|
-
* <p>The namespace of the metric. For more information, see
|
|
322
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace">Namespaces</a>.</p>
|
|
261
|
+
* <p>The namespace of the metric. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace">Namespaces</a>.</p>
|
|
323
262
|
* @public
|
|
324
263
|
*/
|
|
325
264
|
Namespace?: string | undefined;
|
|
@@ -329,9 +268,7 @@ export interface Metric {
|
|
|
329
268
|
*/
|
|
330
269
|
MetricName?: string | undefined;
|
|
331
270
|
/**
|
|
332
|
-
* <p>An array of one or more dimensions to use to define the metric that you want to use.
|
|
333
|
-
* For more information, see
|
|
334
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">Dimensions</a>.</p>
|
|
271
|
+
* <p>An array of one or more dimensions to use to define the metric that you want to use. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">Dimensions</a>.</p>
|
|
335
272
|
* @public
|
|
336
273
|
*/
|
|
337
274
|
Dimensions?: Dimension[] | undefined;
|
|
@@ -384,123 +321,64 @@ export interface MetricStat {
|
|
|
384
321
|
*/
|
|
385
322
|
Metric: Metric | undefined;
|
|
386
323
|
/**
|
|
387
|
-
* <p>The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can
|
|
388
|
-
* be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
|
|
389
|
-
* at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
|
|
390
|
-
* are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
|
|
324
|
+
* <p>The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
|
|
391
325
|
* @public
|
|
392
326
|
*/
|
|
393
327
|
Period: number | undefined;
|
|
394
328
|
/**
|
|
395
|
-
* <p>The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics,
|
|
396
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
|
|
329
|
+
* <p>The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
|
|
397
330
|
* @public
|
|
398
331
|
*/
|
|
399
332
|
Stat: string | undefined;
|
|
400
333
|
/**
|
|
401
|
-
* <p>If you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified
|
|
402
|
-
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
|
|
403
|
-
* If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
|
|
334
|
+
* <p>If you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
|
|
404
335
|
* @public
|
|
405
336
|
*/
|
|
406
337
|
Unit?: StandardUnit | undefined;
|
|
407
338
|
}
|
|
408
339
|
/**
|
|
409
|
-
* <p>Use this structure to define a metric or metric math expression that you want to use as for a service level objective. </p>
|
|
410
|
-
* <p>Each <code>MetricDataQuery</code> in the <code>MetricDataQueries</code> array specifies either a metric to retrieve, or a metric math expression
|
|
411
|
-
* to be performed on retrieved metrics. A single <code>MetricDataQueries</code> array can include as many as 20 <code>MetricDataQuery</code> structures in the array.
|
|
412
|
-
* The 20 structures can include as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a metric, and as many as 10 structures that
|
|
413
|
-
* contain the <code>Expression</code> parameter to perform a math expression. Of those <code>Expression</code> structures,
|
|
414
|
-
* exactly one must have true as the value for <code>ReturnData</code>. The result of this expression used for the SLO.</p>
|
|
415
|
-
* <p>For more information about metric math expressions, see
|
|
416
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html">CloudWatchUse metric math</a>.</p>
|
|
417
|
-
* <p>Within each <code>MetricDataQuery</code> object, you must specify either
|
|
418
|
-
* <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
340
|
+
* <p>Use this structure to define a metric or metric math expression that you want to use as for a service level objective. </p> <p>Each <code>MetricDataQuery</code> in the <code>MetricDataQueries</code> array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single <code>MetricDataQueries</code> array can include as many as 20 <code>MetricDataQuery</code> structures in the array. The 20 structures can include as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a metric, and as many as 10 structures that contain the <code>Expression</code> parameter to perform a math expression. Of those <code>Expression</code> structures, exactly one must have true as the value for <code>ReturnData</code>. The result of this expression used for the SLO.</p> <p>For more information about metric math expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html">CloudWatchUse metric math</a>.</p> <p>Within each <code>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
419
341
|
* @public
|
|
420
342
|
*/
|
|
421
343
|
export interface MetricDataQuery {
|
|
422
344
|
/**
|
|
423
|
-
* <p>A short name used to tie this object to the results in the response. This <code>Id</code> must be unique
|
|
424
|
-
* within a <code>MetricDataQueries</code> array. If you are performing math expressions on this set of data,
|
|
425
|
-
* this name represents that data and can serve as a variable in the metric math expression. The valid characters
|
|
426
|
-
* are letters, numbers, and underscore. The first character must be a lowercase letter.</p>
|
|
345
|
+
* <p>A short name used to tie this object to the results in the response. This <code>Id</code> must be unique within a <code>MetricDataQueries</code> array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.</p>
|
|
427
346
|
* @public
|
|
428
347
|
*/
|
|
429
348
|
Id: string | undefined;
|
|
430
349
|
/**
|
|
431
|
-
* <p>A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.</p>
|
|
432
|
-
* <p>Within one <code>MetricDataQuery</code> object, you must specify either
|
|
433
|
-
* <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
350
|
+
* <p>A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.</p> <p>Within one <code>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
434
351
|
* @public
|
|
435
352
|
*/
|
|
436
353
|
MetricStat?: MetricStat | undefined;
|
|
437
354
|
/**
|
|
438
|
-
* <p>This field can contain a metric math expression to be performed on the other metrics that
|
|
439
|
-
* you are retrieving within this <code>MetricDataQueries</code> structure. </p>
|
|
440
|
-
* <p>A math expression
|
|
441
|
-
* can use the <code>Id</code> of the other metrics or queries to refer to those metrics, and can also use
|
|
442
|
-
* the <code>Id</code> of other
|
|
443
|
-
* expressions to use the result of those expressions. For more information about metric math expressions, see
|
|
444
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the
|
|
445
|
-
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
446
|
-
* <p>Within each <code>MetricDataQuery</code> object, you must specify either
|
|
447
|
-
* <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
355
|
+
* <p>This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this <code>MetricDataQueries</code> structure. </p> <p>A math expression can use the <code>Id</code> of the other metrics or queries to refer to those metrics, and can also use the <code>Id</code> of other expressions to use the result of those expressions. For more information about metric math expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Within each <code>MetricDataQuery</code> object, you must specify either <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
448
356
|
* @public
|
|
449
357
|
*/
|
|
450
358
|
Expression?: string | undefined;
|
|
451
359
|
/**
|
|
452
|
-
* <p>A human-readable label for this metric or expression. This is especially useful
|
|
453
|
-
* if this is an expression, so that you know
|
|
454
|
-
* what the value represents. If the metric or expression is shown in a
|
|
455
|
-
* CloudWatch dashboard widget, the label is shown. If <code>Label</code> is omitted, CloudWatch
|
|
456
|
-
* generates a default.</p>
|
|
457
|
-
* <p>You can put dynamic expressions into a label, so that it is more descriptive.
|
|
458
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
|
|
360
|
+
* <p>A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If <code>Label</code> is omitted, CloudWatch generates a default.</p> <p>You can put dynamic expressions into a label, so that it is more descriptive. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
|
|
459
361
|
* @public
|
|
460
362
|
*/
|
|
461
363
|
Label?: string | undefined;
|
|
462
364
|
/**
|
|
463
|
-
* <p>Use this only if you are using a metric math expression for the SLO.
|
|
464
|
-
* Specify <code>true</code> for <code>ReturnData</code> for only the one expression result to use as the alarm. For all
|
|
465
|
-
* other metrics and expressions in the same <code>CreateServiceLevelObjective</code> operation, specify <code>ReturnData</code> as <code>false</code>.</p>
|
|
365
|
+
* <p>Use this only if you are using a metric math expression for the SLO. Specify <code>true</code> for <code>ReturnData</code> for only the one expression result to use as the alarm. For all other metrics and expressions in the same <code>CreateServiceLevelObjective</code> operation, specify <code>ReturnData</code> as <code>false</code>.</p>
|
|
466
366
|
* @public
|
|
467
367
|
*/
|
|
468
368
|
ReturnData?: boolean | undefined;
|
|
469
369
|
/**
|
|
470
|
-
* <p>The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can
|
|
471
|
-
* be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
|
|
472
|
-
* at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
|
|
473
|
-
* are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
|
|
474
|
-
* <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
|
|
475
|
-
* 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p>
|
|
476
|
-
* <ul>
|
|
477
|
-
* <li>
|
|
478
|
-
* <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p>
|
|
479
|
-
* </li>
|
|
480
|
-
* <li>
|
|
481
|
-
* <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p>
|
|
482
|
-
* </li>
|
|
483
|
-
* <li>
|
|
484
|
-
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
|
|
485
|
-
* </li>
|
|
486
|
-
* </ul>
|
|
370
|
+
* <p>The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p> <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p> <ul> <li> <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p> </li> <li> <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p> </li> <li> <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p> </li> </ul>
|
|
487
371
|
* @public
|
|
488
372
|
*/
|
|
489
373
|
Period?: number | undefined;
|
|
490
374
|
/**
|
|
491
|
-
* <p>The ID of the account where this metric is located.
|
|
492
|
-
* use this to specify which source account to retrieve this metric from.</p>
|
|
375
|
+
* <p>The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.</p>
|
|
493
376
|
* @public
|
|
494
377
|
*/
|
|
495
378
|
AccountId?: string | undefined;
|
|
496
379
|
}
|
|
497
380
|
/**
|
|
498
|
-
* <p>This structure defines the metric that is used as the "good request" or "bad request"
|
|
499
|
-
* value for a request-based SLO.
|
|
500
|
-
* This value observed for the metric defined in
|
|
501
|
-
* <code>TotalRequestCountMetric</code> is divided by the number found for
|
|
502
|
-
* <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that
|
|
503
|
-
* this SLO tracks.</p>
|
|
381
|
+
* <p>This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in <code>TotalRequestCountMetric</code> is divided by the number found for <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that this SLO tracks.</p>
|
|
504
382
|
* @public
|
|
505
383
|
*/
|
|
506
384
|
export type MonitoredRequestCountMetricDataQueries = MonitoredRequestCountMetricDataQueries.BadCountMetricMember | MonitoredRequestCountMetricDataQueries.GoodCountMetricMember | MonitoredRequestCountMetricDataQueries.$UnknownMember;
|
|
@@ -509,8 +387,7 @@ export type MonitoredRequestCountMetricDataQueries = MonitoredRequestCountMetric
|
|
|
509
387
|
*/
|
|
510
388
|
export declare namespace MonitoredRequestCountMetricDataQueries {
|
|
511
389
|
/**
|
|
512
|
-
* <p>If you want to count "good requests" to determine the percentage of successful requests for this
|
|
513
|
-
* request-based SLO, specify the metric to use as "good requests" in this structure.</p>
|
|
390
|
+
* <p>If you want to count "good requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "good requests" in this structure.</p>
|
|
514
391
|
* @public
|
|
515
392
|
*/
|
|
516
393
|
interface GoodCountMetricMember {
|
|
@@ -519,8 +396,7 @@ export declare namespace MonitoredRequestCountMetricDataQueries {
|
|
|
519
396
|
$unknown?: never;
|
|
520
397
|
}
|
|
521
398
|
/**
|
|
522
|
-
* <p>If you want to count "bad requests" to determine the percentage of successful requests for this
|
|
523
|
-
* request-based SLO, specify the metric to use as "bad requests" in this structure.</p>
|
|
399
|
+
* <p>If you want to count "bad requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "bad requests" in this structure.</p>
|
|
524
400
|
* @public
|
|
525
401
|
*/
|
|
526
402
|
interface BadCountMetricMember {
|
|
@@ -549,34 +425,7 @@ export declare namespace MonitoredRequestCountMetricDataQueries {
|
|
|
549
425
|
*/
|
|
550
426
|
export interface RequestBasedServiceLevelIndicatorMetric {
|
|
551
427
|
/**
|
|
552
|
-
* <p>This is a string-to-string map that contains information about the type of object that this SLO is related to. It can
|
|
553
|
-
* include the following fields.</p>
|
|
554
|
-
* <ul>
|
|
555
|
-
* <li>
|
|
556
|
-
* <p>
|
|
557
|
-
* <code>Type</code> designates the type of object that this SLO is related to.</p>
|
|
558
|
-
* </li>
|
|
559
|
-
* <li>
|
|
560
|
-
* <p>
|
|
561
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
562
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
563
|
-
* </li>
|
|
564
|
-
* <li>
|
|
565
|
-
* <p>
|
|
566
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
567
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
568
|
-
* </li>
|
|
569
|
-
* <li>
|
|
570
|
-
* <p>
|
|
571
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
572
|
-
* This is used only if the value of the <code>Type</code> field
|
|
573
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
574
|
-
* </li>
|
|
575
|
-
* <li>
|
|
576
|
-
* <p>
|
|
577
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
578
|
-
* </li>
|
|
579
|
-
* </ul>
|
|
428
|
+
* <p>This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object that this SLO is related to.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
580
429
|
* @public
|
|
581
430
|
*/
|
|
582
431
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -586,26 +435,17 @@ export interface RequestBasedServiceLevelIndicatorMetric {
|
|
|
586
435
|
*/
|
|
587
436
|
OperationName?: string | undefined;
|
|
588
437
|
/**
|
|
589
|
-
* <p>If the SLO monitors either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals
|
|
590
|
-
* collects, this field displays which of those metrics is used.</p>
|
|
438
|
+
* <p>If the SLO monitors either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals collects, this field displays which of those metrics is used.</p>
|
|
591
439
|
* @public
|
|
592
440
|
*/
|
|
593
441
|
MetricType?: ServiceLevelIndicatorMetricType | undefined;
|
|
594
442
|
/**
|
|
595
|
-
* <p>This structure defines the metric that is used as the "total requests" number for a request-based SLO.
|
|
596
|
-
* The number observed for this metric is divided by the number of "good requests" or "bad requests" that is
|
|
597
|
-
* observed for the metric defined in
|
|
598
|
-
* <code>MonitoredRequestCountMetric</code>.</p>
|
|
443
|
+
* <p>This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in <code>MonitoredRequestCountMetric</code>.</p>
|
|
599
444
|
* @public
|
|
600
445
|
*/
|
|
601
446
|
TotalRequestCountMetric: MetricDataQuery[] | undefined;
|
|
602
447
|
/**
|
|
603
|
-
* <p>This structure defines the metric that is used as the "good request" or "bad request"
|
|
604
|
-
* value for a request-based SLO.
|
|
605
|
-
* This value observed for the metric defined in
|
|
606
|
-
* <code>TotalRequestCountMetric</code> is divided by the number found for
|
|
607
|
-
* <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that
|
|
608
|
-
* this SLO tracks.</p>
|
|
448
|
+
* <p>This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in <code>TotalRequestCountMetric</code> is divided by the number found for <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that this SLO tracks.</p>
|
|
609
449
|
* @public
|
|
610
450
|
*/
|
|
611
451
|
MonitoredRequestCountMetric: MonitoredRequestCountMetricDataQueries | undefined;
|
|
@@ -626,14 +466,12 @@ export interface RequestBasedServiceLevelIndicator {
|
|
|
626
466
|
*/
|
|
627
467
|
RequestBasedSliMetric: RequestBasedServiceLevelIndicatorMetric | undefined;
|
|
628
468
|
/**
|
|
629
|
-
* <p>This value is the threshold that
|
|
630
|
-
* the observed metric values of the SLI metric are compared to.</p>
|
|
469
|
+
* <p>This value is the threshold that the observed metric values of the SLI metric are compared to.</p>
|
|
631
470
|
* @public
|
|
632
471
|
*/
|
|
633
472
|
MetricThreshold?: number | undefined;
|
|
634
473
|
/**
|
|
635
|
-
* <p>The arithmetic operation used when comparing the specified metric to the
|
|
636
|
-
* threshold.</p>
|
|
474
|
+
* <p>The arithmetic operation used when comparing the specified metric to the threshold.</p>
|
|
637
475
|
* @public
|
|
638
476
|
*/
|
|
639
477
|
ComparisonOperator?: ServiceLevelIndicatorComparisonOperator | undefined;
|
|
@@ -644,34 +482,7 @@ export interface RequestBasedServiceLevelIndicator {
|
|
|
644
482
|
*/
|
|
645
483
|
export interface ServiceLevelIndicatorMetric {
|
|
646
484
|
/**
|
|
647
|
-
* <p>This is a string-to-string map that contains information about the type of object that this SLO is related to. It can
|
|
648
|
-
* include the following fields.</p>
|
|
649
|
-
* <ul>
|
|
650
|
-
* <li>
|
|
651
|
-
* <p>
|
|
652
|
-
* <code>Type</code> designates the type of object that this SLO is related to.</p>
|
|
653
|
-
* </li>
|
|
654
|
-
* <li>
|
|
655
|
-
* <p>
|
|
656
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
657
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
658
|
-
* </li>
|
|
659
|
-
* <li>
|
|
660
|
-
* <p>
|
|
661
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
662
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
663
|
-
* </li>
|
|
664
|
-
* <li>
|
|
665
|
-
* <p>
|
|
666
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
667
|
-
* This is used only if the value of the <code>Type</code> field
|
|
668
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
669
|
-
* </li>
|
|
670
|
-
* <li>
|
|
671
|
-
* <p>
|
|
672
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
673
|
-
* </li>
|
|
674
|
-
* </ul>
|
|
485
|
+
* <p>This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object that this SLO is related to.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
675
486
|
* @public
|
|
676
487
|
*/
|
|
677
488
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -681,14 +492,12 @@ export interface ServiceLevelIndicatorMetric {
|
|
|
681
492
|
*/
|
|
682
493
|
OperationName?: string | undefined;
|
|
683
494
|
/**
|
|
684
|
-
* <p>If the SLO monitors either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals
|
|
685
|
-
* collects, this field displays which of those metrics is used.</p>
|
|
495
|
+
* <p>If the SLO monitors either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals collects, this field displays which of those metrics is used.</p>
|
|
686
496
|
* @public
|
|
687
497
|
*/
|
|
688
498
|
MetricType?: ServiceLevelIndicatorMetricType | undefined;
|
|
689
499
|
/**
|
|
690
|
-
* <p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression,
|
|
691
|
-
* this structure includes the information about that metric or expression. </p>
|
|
500
|
+
* <p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression. </p>
|
|
692
501
|
* @public
|
|
693
502
|
*/
|
|
694
503
|
MetricDataQueries: MetricDataQuery[] | undefined;
|
|
@@ -714,8 +523,7 @@ export interface ServiceLevelIndicator {
|
|
|
714
523
|
*/
|
|
715
524
|
MetricThreshold: number | undefined;
|
|
716
525
|
/**
|
|
717
|
-
* <p>The arithmetic operation used when comparing the specified metric to the
|
|
718
|
-
* threshold.</p>
|
|
526
|
+
* <p>The arithmetic operation used when comparing the specified metric to the threshold.</p>
|
|
719
527
|
* @public
|
|
720
528
|
*/
|
|
721
529
|
ComparisonOperator: ServiceLevelIndicatorComparisonOperator | undefined;
|
|
@@ -741,72 +549,32 @@ export interface ServiceLevelObjectiveBudgetReport {
|
|
|
741
549
|
*/
|
|
742
550
|
EvaluationType?: EvaluationType | undefined;
|
|
743
551
|
/**
|
|
744
|
-
* <p>The status of this SLO, as it relates to the error budget for the entire time interval.</p>
|
|
745
|
-
* <ul>
|
|
746
|
-
* <li>
|
|
747
|
-
* <p>
|
|
748
|
-
* <code>OK</code> means that the SLO had remaining budget above the warning threshold,
|
|
749
|
-
* as of the time that you specified in <code>TimeStamp</code>.</p>
|
|
750
|
-
* </li>
|
|
751
|
-
* <li>
|
|
752
|
-
* <p>
|
|
753
|
-
* <code>WARNING</code> means that the SLO's remaining budget was below the warning threshold,
|
|
754
|
-
* as of the time that you specified in <code>TimeStamp</code>.</p>
|
|
755
|
-
* </li>
|
|
756
|
-
* <li>
|
|
757
|
-
* <p>
|
|
758
|
-
* <code>BREACHED</code> means that the SLO's budget was exhausted,
|
|
759
|
-
* as of the time that you specified in <code>TimeStamp</code>.</p>
|
|
760
|
-
* </li>
|
|
761
|
-
* <li>
|
|
762
|
-
* <p>
|
|
763
|
-
* <code>INSUFFICIENT_DATA</code> means that the specified start and end times were before the
|
|
764
|
-
* SLO was created, or that attainment data is missing.</p>
|
|
765
|
-
* </li>
|
|
766
|
-
* </ul>
|
|
552
|
+
* <p>The status of this SLO, as it relates to the error budget for the entire time interval.</p> <ul> <li> <p> <code>OK</code> means that the SLO had remaining budget above the warning threshold, as of the time that you specified in <code>TimeStamp</code>.</p> </li> <li> <p> <code>WARNING</code> means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in <code>TimeStamp</code>.</p> </li> <li> <p> <code>BREACHED</code> means that the SLO's budget was exhausted, as of the time that you specified in <code>TimeStamp</code>.</p> </li> <li> <p> <code>INSUFFICIENT_DATA</code> means that the specified start and end times were before the SLO was created, or that attainment data is missing.</p> </li> </ul>
|
|
767
553
|
* @public
|
|
768
554
|
*/
|
|
769
555
|
BudgetStatus: ServiceLevelObjectiveBudgetStatus | undefined;
|
|
770
556
|
/**
|
|
771
|
-
* <p>A number between 0 and 100 that represents the success percentage of your application compared
|
|
772
|
-
* to the goal set by the SLO.</p>
|
|
773
|
-
* <p>If this is a period-based SLO, the number is the percentage of time periods that the service has
|
|
774
|
-
* attained the SLO's attainment goal, as of the time of the request.</p>
|
|
775
|
-
* <p>If this is a request-based SLO, the number is the number of successful requests divided
|
|
776
|
-
* by the number of total requests, multiplied by 100, during the time range that you specified in your request.</p>
|
|
557
|
+
* <p>A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.</p> <p>If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.</p> <p>If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.</p>
|
|
777
558
|
* @public
|
|
778
559
|
*/
|
|
779
560
|
Attainment?: number | undefined;
|
|
780
561
|
/**
|
|
781
|
-
* <p>The total number of seconds in the error budget for the interval. This field is included only
|
|
782
|
-
* if the SLO is a period-based SLO.</p>
|
|
562
|
+
* <p>The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.</p>
|
|
783
563
|
* @public
|
|
784
564
|
*/
|
|
785
565
|
TotalBudgetSeconds?: number | undefined;
|
|
786
566
|
/**
|
|
787
|
-
* <p>The budget amount remaining before the SLO status becomes <code>BREACHING</code>, at the time specified in
|
|
788
|
-
* the
|
|
789
|
-
* <code>Timestemp</code> parameter of the request. If this value is negative, then the SLO is already in <code>BREACHING</code>
|
|
790
|
-
* status.</p>
|
|
791
|
-
* <p> This field is included only
|
|
792
|
-
* if the SLO is a period-based SLO.</p>
|
|
567
|
+
* <p>The budget amount remaining before the SLO status becomes <code>BREACHING</code>, at the time specified in the <code>Timestemp</code> parameter of the request. If this value is negative, then the SLO is already in <code>BREACHING</code> status.</p> <p> This field is included only if the SLO is a period-based SLO.</p>
|
|
793
568
|
* @public
|
|
794
569
|
*/
|
|
795
570
|
BudgetSecondsRemaining?: number | undefined;
|
|
796
571
|
/**
|
|
797
|
-
* <p>This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the
|
|
798
|
-
* interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred,
|
|
799
|
-
* and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then
|
|
800
|
-
* this SLO is currently breaching.</p>
|
|
801
|
-
* <p>This number can go up and down between reports with different time stamps, based on both how many total requests occur.</p>
|
|
572
|
+
* <p>This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.</p> <p>This number can go up and down between reports with different time stamps, based on both how many total requests occur.</p>
|
|
802
573
|
* @public
|
|
803
574
|
*/
|
|
804
575
|
TotalBudgetRequests?: number | undefined;
|
|
805
576
|
/**
|
|
806
|
-
* <p>This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur,
|
|
807
|
-
* and still have the application meet its SLO goal.</p>
|
|
808
|
-
* <p>This number can go up and down between different reports, based on both how many successful requests and how many failed
|
|
809
|
-
* requests occur in that time.</p>
|
|
577
|
+
* <p>This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.</p> <p>This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.</p>
|
|
810
578
|
* @public
|
|
811
579
|
*/
|
|
812
580
|
BudgetRequestsRemaining?: number | undefined;
|
|
@@ -821,8 +589,7 @@ export interface ServiceLevelObjectiveBudgetReport {
|
|
|
821
589
|
*/
|
|
822
590
|
RequestBasedSli?: RequestBasedServiceLevelIndicator | undefined;
|
|
823
591
|
/**
|
|
824
|
-
* <p>This structure contains the attributes that determine the goal of an SLO. This includes
|
|
825
|
-
* the time period for evaluation and the attainment threshold.</p>
|
|
592
|
+
* <p>This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.</p>
|
|
826
593
|
* @public
|
|
827
594
|
*/
|
|
828
595
|
Goal?: Goal | undefined;
|
|
@@ -842,8 +609,7 @@ export interface BatchGetServiceLevelObjectiveBudgetReportOutput {
|
|
|
842
609
|
*/
|
|
843
610
|
Reports: ServiceLevelObjectiveBudgetReport[] | undefined;
|
|
844
611
|
/**
|
|
845
|
-
* <p>An array of structures, where each structure includes an error indicating that one
|
|
846
|
-
* of the requests in the array was not valid.</p>
|
|
612
|
+
* <p>An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.</p>
|
|
847
613
|
* @public
|
|
848
614
|
*/
|
|
849
615
|
Errors: ServiceLevelObjectiveBudgetReportError[] | undefined;
|
|
@@ -1005,70 +771,38 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1005
771
|
*/
|
|
1006
772
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1007
773
|
}
|
|
774
|
+
/**
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
export interface DeleteGroupingConfigurationOutput {
|
|
778
|
+
}
|
|
1008
779
|
/**
|
|
1009
780
|
* @public
|
|
1010
781
|
*/
|
|
1011
782
|
export interface GetServiceInput {
|
|
1012
783
|
/**
|
|
1013
|
-
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1014
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1015
|
-
* </p>
|
|
1016
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
784
|
+
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1017
785
|
* @public
|
|
1018
786
|
*/
|
|
1019
787
|
StartTime: Date | undefined;
|
|
1020
788
|
/**
|
|
1021
|
-
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1022
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1023
|
-
* </p>
|
|
1024
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
789
|
+
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1025
790
|
* @public
|
|
1026
791
|
*/
|
|
1027
792
|
EndTime: Date | undefined;
|
|
1028
793
|
/**
|
|
1029
|
-
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>,
|
|
1030
|
-
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
1031
|
-
* <p>This is a string-to-string map. It can
|
|
1032
|
-
* include the following fields.</p>
|
|
1033
|
-
* <ul>
|
|
1034
|
-
* <li>
|
|
1035
|
-
* <p>
|
|
1036
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1037
|
-
* </li>
|
|
1038
|
-
* <li>
|
|
1039
|
-
* <p>
|
|
1040
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1041
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1042
|
-
* </li>
|
|
1043
|
-
* <li>
|
|
1044
|
-
* <p>
|
|
1045
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1046
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1047
|
-
* </li>
|
|
1048
|
-
* <li>
|
|
1049
|
-
* <p>
|
|
1050
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1051
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1052
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1053
|
-
* </li>
|
|
1054
|
-
* <li>
|
|
1055
|
-
* <p>
|
|
1056
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1057
|
-
* </li>
|
|
1058
|
-
* </ul>
|
|
794
|
+
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1059
795
|
* @public
|
|
1060
796
|
*/
|
|
1061
797
|
KeyAttributes: Record<string, string> | undefined;
|
|
1062
798
|
}
|
|
1063
799
|
/**
|
|
1064
|
-
* <p>This structure contains information about one CloudWatch metric associated with this entity discovered
|
|
1065
|
-
* by Application Signals.</p>
|
|
800
|
+
* <p>This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.</p>
|
|
1066
801
|
* @public
|
|
1067
802
|
*/
|
|
1068
803
|
export interface MetricReference {
|
|
1069
804
|
/**
|
|
1070
|
-
* <p>The namespace of the metric. For more information, see
|
|
1071
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace">CloudWatchNamespaces</a>.</p>
|
|
805
|
+
* <p>The namespace of the metric. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace">CloudWatchNamespaces</a>.</p>
|
|
1072
806
|
* @public
|
|
1073
807
|
*/
|
|
1074
808
|
Namespace: string | undefined;
|
|
@@ -1078,9 +812,7 @@ export interface MetricReference {
|
|
|
1078
812
|
*/
|
|
1079
813
|
MetricType: string | undefined;
|
|
1080
814
|
/**
|
|
1081
|
-
* <p>An array of one or more dimensions that further define the metric.
|
|
1082
|
-
* For more information, see
|
|
1083
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">CloudWatchDimensions</a>.</p>
|
|
815
|
+
* <p>An array of one or more dimensions that further define the metric. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">CloudWatchDimensions</a>.</p>
|
|
1084
816
|
* @public
|
|
1085
817
|
*/
|
|
1086
818
|
Dimensions?: Dimension[] | undefined;
|
|
@@ -1096,142 +828,58 @@ export interface MetricReference {
|
|
|
1096
828
|
AccountId?: string | undefined;
|
|
1097
829
|
}
|
|
1098
830
|
/**
|
|
1099
|
-
* <p>
|
|
1100
|
-
*
|
|
831
|
+
* <p>A structure that represents a logical grouping of services based on shared attributes such as business unit, environment, or entry point.</p>
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
834
|
+
export interface ServiceGroup {
|
|
835
|
+
/**
|
|
836
|
+
* <p>The name of the grouping attribute, such as <code>BusinessUnit</code> or <code>Environment</code>.</p>
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
GroupName: string | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <p>The value of the grouping attribute for this service, such as <code>Payments</code> or <code>Production</code>.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
GroupValue: string | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The source of the grouping attribute, such as <code>TAG</code>, <code>OTEL</code>, or <code>DEFAULT</code>.</p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
GroupSource: string | undefined;
|
|
850
|
+
/**
|
|
851
|
+
* <p>A unique identifier for this grouping attribute value, used for filtering and API operations.</p>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
GroupIdentifier: string | undefined;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* <p>This structure contains information about one of your services that was discovered by Application Signals. </p>
|
|
1101
858
|
* @public
|
|
1102
859
|
*/
|
|
1103
860
|
export interface Service {
|
|
1104
861
|
/**
|
|
1105
|
-
* <p>This is a string-to-string map. It can
|
|
1106
|
-
* include the following fields.</p>
|
|
1107
|
-
* <ul>
|
|
1108
|
-
* <li>
|
|
1109
|
-
* <p>
|
|
1110
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1111
|
-
* </li>
|
|
1112
|
-
* <li>
|
|
1113
|
-
* <p>
|
|
1114
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1115
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1116
|
-
* </li>
|
|
1117
|
-
* <li>
|
|
1118
|
-
* <p>
|
|
1119
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1120
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1121
|
-
* </li>
|
|
1122
|
-
* <li>
|
|
1123
|
-
* <p>
|
|
1124
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1125
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1126
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1127
|
-
* </li>
|
|
1128
|
-
* <li>
|
|
1129
|
-
* <p>
|
|
1130
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1131
|
-
* </li>
|
|
1132
|
-
* </ul>
|
|
862
|
+
* <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1133
863
|
* @public
|
|
1134
864
|
*/
|
|
1135
865
|
KeyAttributes: Record<string, string> | undefined;
|
|
1136
866
|
/**
|
|
1137
|
-
* <p>This structure contains one or more string-to-string maps that help identify this service. It can include <i>platform attributes</i>, <i>application attributes</i>, and <i>telemetry attributes</i>.</p>
|
|
1138
|
-
* <p>Platform attributes contain information the service's platform.</p>
|
|
1139
|
-
* <ul>
|
|
1140
|
-
* <li>
|
|
1141
|
-
* <p>
|
|
1142
|
-
* <code>PlatformType</code> defines the hosted-in platform.</p>
|
|
1143
|
-
* </li>
|
|
1144
|
-
* <li>
|
|
1145
|
-
* <p>
|
|
1146
|
-
* <code>EKS.Cluster</code> is the name of the Amazon EKS cluster.</p>
|
|
1147
|
-
* </li>
|
|
1148
|
-
* <li>
|
|
1149
|
-
* <p>
|
|
1150
|
-
* <code>K8s.Cluster</code> is the name of the self-hosted Kubernetes cluster.</p>
|
|
1151
|
-
* </li>
|
|
1152
|
-
* <li>
|
|
1153
|
-
* <p>
|
|
1154
|
-
* <code>K8s.Namespace</code> is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.</p>
|
|
1155
|
-
* </li>
|
|
1156
|
-
* <li>
|
|
1157
|
-
* <p>
|
|
1158
|
-
* <code>K8s.Workload</code> is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.</p>
|
|
1159
|
-
* </li>
|
|
1160
|
-
* <li>
|
|
1161
|
-
* <p>
|
|
1162
|
-
* <code>K8s.Node</code> is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.</p>
|
|
1163
|
-
* </li>
|
|
1164
|
-
* <li>
|
|
1165
|
-
* <p>
|
|
1166
|
-
* <code>K8s.Pod</code> is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.</p>
|
|
1167
|
-
* </li>
|
|
1168
|
-
* <li>
|
|
1169
|
-
* <p>
|
|
1170
|
-
* <code>EC2.AutoScalingGroup</code> is the name of the Amazon EC2 Auto Scaling group.</p>
|
|
1171
|
-
* </li>
|
|
1172
|
-
* <li>
|
|
1173
|
-
* <p>
|
|
1174
|
-
* <code>EC2.InstanceId</code> is the ID of the Amazon EC2 instance.</p>
|
|
1175
|
-
* </li>
|
|
1176
|
-
* <li>
|
|
1177
|
-
* <p>
|
|
1178
|
-
* <code>Host</code> is the name of the host, for all platform types.</p>
|
|
1179
|
-
* </li>
|
|
1180
|
-
* </ul>
|
|
1181
|
-
* <p>Application attributes contain information about the application.</p>
|
|
1182
|
-
* <ul>
|
|
1183
|
-
* <li>
|
|
1184
|
-
* <p>
|
|
1185
|
-
* <code>AWS.Application</code> is the application's name in Amazon Web Services Service Catalog AppRegistry.</p>
|
|
1186
|
-
* </li>
|
|
1187
|
-
* <li>
|
|
1188
|
-
* <p>
|
|
1189
|
-
* <code>AWS.Application.ARN</code> is the application's ARN in Amazon Web Services Service Catalog AppRegistry.</p>
|
|
1190
|
-
* </li>
|
|
1191
|
-
* </ul>
|
|
1192
|
-
* <p>Telemetry attributes contain telemetry information.</p>
|
|
1193
|
-
* <ul>
|
|
1194
|
-
* <li>
|
|
1195
|
-
* <p>
|
|
1196
|
-
* <code>Telemetry.SDK</code> is the fingerprint of the OpenTelemetry SDK version for instrumented services.</p>
|
|
1197
|
-
* </li>
|
|
1198
|
-
* <li>
|
|
1199
|
-
* <p>
|
|
1200
|
-
* <code>Telemetry.Agent</code> is the fingerprint of the agent used to collect and send telemetry data.</p>
|
|
1201
|
-
* </li>
|
|
1202
|
-
* <li>
|
|
1203
|
-
* <p>
|
|
1204
|
-
* <code>Telemetry.Source</code> Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.</p>
|
|
1205
|
-
* </li>
|
|
1206
|
-
* </ul>
|
|
867
|
+
* <p>This structure contains one or more string-to-string maps that help identify this service. It can include <i>platform attributes</i>, <i>application attributes</i>, and <i>telemetry attributes</i>.</p> <p>Platform attributes contain information the service's platform.</p> <ul> <li> <p> <code>PlatformType</code> defines the hosted-in platform.</p> </li> <li> <p> <code>EKS.Cluster</code> is the name of the Amazon EKS cluster.</p> </li> <li> <p> <code>K8s.Cluster</code> is the name of the self-hosted Kubernetes cluster.</p> </li> <li> <p> <code>K8s.Namespace</code> is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>K8s.Workload</code> is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>K8s.Node</code> is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>K8s.Pod</code> is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>EC2.AutoScalingGroup</code> is the name of the Amazon EC2 Auto Scaling group.</p> </li> <li> <p> <code>EC2.InstanceId</code> is the ID of the Amazon EC2 instance.</p> </li> <li> <p> <code>Host</code> is the name of the host, for all platform types.</p> </li> </ul> <p>Application attributes contain information about the application.</p> <ul> <li> <p> <code>AWS.Application</code> is the application's name in Amazon Web Services Service Catalog AppRegistry.</p> </li> <li> <p> <code>AWS.Application.ARN</code> is the application's ARN in Amazon Web Services Service Catalog AppRegistry.</p> </li> </ul> <p>Telemetry attributes contain telemetry information.</p> <ul> <li> <p> <code>Telemetry.SDK</code> is the fingerprint of the OpenTelemetry SDK version for instrumented services.</p> </li> <li> <p> <code>Telemetry.Agent</code> is the fingerprint of the agent used to collect and send telemetry data.</p> </li> <li> <p> <code>Telemetry.Source</code> Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.</p> </li> </ul>
|
|
1207
868
|
* @public
|
|
1208
869
|
*/
|
|
1209
870
|
AttributeMaps?: Record<string, string>[] | undefined;
|
|
871
|
+
/**
|
|
872
|
+
* <p>An array of service groups that this service belongs to, based on the configured grouping attributes.</p>
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
ServiceGroups?: ServiceGroup[] | undefined;
|
|
1210
876
|
/**
|
|
1211
877
|
* <p>An array of structures that each contain information about one metric associated with this service.</p>
|
|
1212
878
|
* @public
|
|
1213
879
|
*/
|
|
1214
880
|
MetricReferences: MetricReference[] | undefined;
|
|
1215
881
|
/**
|
|
1216
|
-
* <p>An array of string-to-string maps that each contain information about one log group associated with this service. Each
|
|
1217
|
-
* string-to-string map includes the following fields:</p>
|
|
1218
|
-
* <ul>
|
|
1219
|
-
* <li>
|
|
1220
|
-
* <p>
|
|
1221
|
-
* <code>"Type": "AWS::Resource"</code>
|
|
1222
|
-
* </p>
|
|
1223
|
-
* </li>
|
|
1224
|
-
* <li>
|
|
1225
|
-
* <p>
|
|
1226
|
-
* <code>"ResourceType": "AWS::Logs::LogGroup"</code>
|
|
1227
|
-
* </p>
|
|
1228
|
-
* </li>
|
|
1229
|
-
* <li>
|
|
1230
|
-
* <p>
|
|
1231
|
-
* <code>"Identifier": "<i>name-of-log-group</i>"</code>
|
|
1232
|
-
* </p>
|
|
1233
|
-
* </li>
|
|
1234
|
-
* </ul>
|
|
882
|
+
* <p>An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:</p> <ul> <li> <p> <code>"Type": "AWS::Resource"</code> </p> </li> <li> <p> <code>"ResourceType": "AWS::Logs::LogGroup"</code> </p> </li> <li> <p> <code>"Identifier": "<i>name-of-log-group</i>"</code> </p> </li> </ul>
|
|
1235
883
|
* @public
|
|
1236
884
|
*/
|
|
1237
885
|
LogGroupReferences?: Record<string, string>[] | undefined;
|
|
@@ -1246,102 +894,466 @@ export interface GetServiceOutput {
|
|
|
1246
894
|
*/
|
|
1247
895
|
Service: Service | undefined;
|
|
1248
896
|
/**
|
|
1249
|
-
* <p>The start time of the data included in the response. In a raw HTTP Query API, it is formatted as
|
|
1250
|
-
* be epoch time in seconds. For example: <code>1698778057</code>.</p>
|
|
1251
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1252
|
-
* it was rounded to the nearest hour.</p>
|
|
897
|
+
* <p>The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code>.</p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1253
898
|
* @public
|
|
1254
899
|
*/
|
|
1255
900
|
StartTime: Date | undefined;
|
|
1256
901
|
/**
|
|
1257
|
-
* <p>The end time of the data included in the response. In a raw HTTP Query API, it is formatted as
|
|
1258
|
-
* be epoch time in seconds. For example: <code>1698778057</code>.</p>
|
|
1259
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1260
|
-
* it was rounded to the nearest hour.</p>
|
|
902
|
+
* <p>The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code>.</p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1261
903
|
* @public
|
|
1262
904
|
*/
|
|
1263
905
|
EndTime: Date | undefined;
|
|
1264
906
|
/**
|
|
1265
|
-
* <p>An array of string-to-string maps that each contain information about one log group associated with this service. Each
|
|
1266
|
-
* string-to-string map includes the following fields:</p>
|
|
1267
|
-
* <ul>
|
|
1268
|
-
* <li>
|
|
1269
|
-
* <p>
|
|
1270
|
-
* <code>"Type": "AWS::Resource"</code>
|
|
1271
|
-
* </p>
|
|
1272
|
-
* </li>
|
|
1273
|
-
* <li>
|
|
1274
|
-
* <p>
|
|
1275
|
-
* <code>"ResourceType": "AWS::Logs::LogGroup"</code>
|
|
1276
|
-
* </p>
|
|
1277
|
-
* </li>
|
|
1278
|
-
* <li>
|
|
1279
|
-
* <p>
|
|
1280
|
-
* <code>"Identifier": "<i>name-of-log-group</i>"</code>
|
|
1281
|
-
* </p>
|
|
1282
|
-
* </li>
|
|
1283
|
-
* </ul>
|
|
907
|
+
* <p>An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:</p> <ul> <li> <p> <code>"Type": "AWS::Resource"</code> </p> </li> <li> <p> <code>"ResourceType": "AWS::Logs::LogGroup"</code> </p> </li> <li> <p> <code>"Identifier": "<i>name-of-log-group</i>"</code> </p> </li> </ul>
|
|
1284
908
|
* @public
|
|
1285
909
|
*/
|
|
1286
910
|
LogGroupReferences?: Record<string, string>[] | undefined;
|
|
1287
911
|
}
|
|
912
|
+
/**
|
|
913
|
+
* <p>A structure that contains identifying information for a service entity.</p>
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
export interface ServiceEntity {
|
|
917
|
+
/**
|
|
918
|
+
* <p>The type of the service entity.</p>
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
Type?: string | undefined;
|
|
922
|
+
/**
|
|
923
|
+
* <p>The name of the service.</p>
|
|
924
|
+
* @public
|
|
925
|
+
*/
|
|
926
|
+
Name?: string | undefined;
|
|
927
|
+
/**
|
|
928
|
+
* <p>The environment where the service is deployed.</p>
|
|
929
|
+
* @public
|
|
930
|
+
*/
|
|
931
|
+
Environment?: string | undefined;
|
|
932
|
+
/**
|
|
933
|
+
* <p>The Amazon Web Services account ID where the service is located. Provide this value only for cross-account access.</p>
|
|
934
|
+
* @public
|
|
935
|
+
*/
|
|
936
|
+
AwsAccountId?: string | undefined;
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* <p>A structure that contains identifying information for a service operation entity.</p>
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
export interface ServiceOperationEntity {
|
|
943
|
+
/**
|
|
944
|
+
* <p>The service entity that contains this operation.</p>
|
|
945
|
+
* @public
|
|
946
|
+
*/
|
|
947
|
+
Service?: ServiceEntity | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>The name of the operation.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
Operation?: string | undefined;
|
|
953
|
+
/**
|
|
954
|
+
* <p>The type of metric associated with this service operation.</p>
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
MetricType?: string | undefined;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* <p>A structure that contains identifying information for a service level objective entity.</p>
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
export interface ServiceLevelObjectiveEntity {
|
|
964
|
+
/**
|
|
965
|
+
* <p>The name of the service level objective.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
SloName?: string | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* <p>The ARN of the service level objective. The SLO must be provided with ARN for cross-account access.</p>
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
SloArn?: string | undefined;
|
|
974
|
+
}
|
|
975
|
+
/**
|
|
976
|
+
* <p>A union structure that contains the specific entity information for different types of audit targets.</p>
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export type AuditTargetEntity = AuditTargetEntity.ServiceMember | AuditTargetEntity.ServiceOperationMember | AuditTargetEntity.SloMember | AuditTargetEntity.$UnknownMember;
|
|
980
|
+
/**
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
export declare namespace AuditTargetEntity {
|
|
984
|
+
/**
|
|
985
|
+
* <p>Service entity information when the audit target is a service.</p>
|
|
986
|
+
* @public
|
|
987
|
+
*/
|
|
988
|
+
interface ServiceMember {
|
|
989
|
+
Service: ServiceEntity;
|
|
990
|
+
Slo?: never;
|
|
991
|
+
ServiceOperation?: never;
|
|
992
|
+
$unknown?: never;
|
|
993
|
+
}
|
|
994
|
+
/**
|
|
995
|
+
* <p>SLO entity information when the audit target is a service level objective.</p>
|
|
996
|
+
* @public
|
|
997
|
+
*/
|
|
998
|
+
interface SloMember {
|
|
999
|
+
Service?: never;
|
|
1000
|
+
Slo: ServiceLevelObjectiveEntity;
|
|
1001
|
+
ServiceOperation?: never;
|
|
1002
|
+
$unknown?: never;
|
|
1003
|
+
}
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>Service operation entity information when the audit target is a specific service operation.</p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
interface ServiceOperationMember {
|
|
1009
|
+
Service?: never;
|
|
1010
|
+
Slo?: never;
|
|
1011
|
+
ServiceOperation: ServiceOperationEntity;
|
|
1012
|
+
$unknown?: never;
|
|
1013
|
+
}
|
|
1014
|
+
/**
|
|
1015
|
+
* @public
|
|
1016
|
+
*/
|
|
1017
|
+
interface $UnknownMember {
|
|
1018
|
+
Service?: never;
|
|
1019
|
+
Slo?: never;
|
|
1020
|
+
ServiceOperation?: never;
|
|
1021
|
+
$unknown: [string, any];
|
|
1022
|
+
}
|
|
1023
|
+
interface Visitor<T> {
|
|
1024
|
+
Service: (value: ServiceEntity) => T;
|
|
1025
|
+
Slo: (value: ServiceLevelObjectiveEntity) => T;
|
|
1026
|
+
ServiceOperation: (value: ServiceOperationEntity) => T;
|
|
1027
|
+
_: (name: string, value: any) => T;
|
|
1028
|
+
}
|
|
1029
|
+
const visit: <T>(value: AuditTargetEntity, visitor: Visitor<T>) => T;
|
|
1030
|
+
}
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>A structure that specifies the target entity for audit analysis, such as a <code>service</code>, <code>SLO</code>, or <code>service_operation</code>.</p>
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
export interface AuditTarget {
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The type of entity being audited, such as <code>Service</code>, <code>SLO</code>, or <code>ServiceOperation</code>.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
Type: string | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>The specific data identifying the audit target entity.</p>
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
Data: AuditTargetEntity | undefined;
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
export interface ListAuditFindingsInput {
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>The start of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code> </p>
|
|
1053
|
+
* @public
|
|
1054
|
+
*/
|
|
1055
|
+
StartTime: Date | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* <p>The end of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code> </p>
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
EndTime: Date | undefined;
|
|
1061
|
+
/**
|
|
1062
|
+
* <p>A list of auditor names to filter the findings by. Only findings generated by the specified auditors will be returned.</p> <p>The following auditors are available for configuration:</p> <ul> <li> <p> <code>slo</code> - SloAuditor: Identifies SLO violations and detects breached thresholds during the Assessment phase.</p> </li> <li> <p> <code>operation_metric</code> - OperationMetricAuditor: Detects anomalies in service operation metrics from Application Signals RED metrics during the Assessment phase</p> </li> <li> <p> <code>service_quota</code> - ServiceQuotaAuditor: Monitors resource utilization against service quotas during the Assessment phase</p> </li> <li> <p> <code>trace</code> - TraceAuditor: Performs deep-dive analysis of distributed traces, correlating traces with breached SLOs or abnormal RED metrics during the Analysis phase</p> </li> <li> <p> <code>dependency_metric</code> - CriticalPathAuditor: Analyzes service dependency impacts and maps dependency relationships from Application Signals RED metrics during the Analysis phase</p> </li> <li> <p> <code>top_contributor</code> - TopContributorAuditor: Identifies infrastructure-level contributors to issues by analyzing EMF logs of Application Signals RED metrics during the Analysis phase</p> </li> <li> <p> <code>log</code> - LogAuditor: Extracts insights from application logs, categorizing error types and ranking severity by frequency during the Analysis phase</p> </li> </ul> <note> <p> <code>InitAuditor</code> and <code>Summarizer</code> auditors are not configurable as they are automatically triggered during the audit process.</p> </note>
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
Auditors?: string[] | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>A list of audit targets to filter the findings by. You can specify services, SLOs, or service operations to limit the audit findings to specific entities.</p>
|
|
1068
|
+
* @public
|
|
1069
|
+
*/
|
|
1070
|
+
AuditTargets: AuditTarget[] | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of audit findings.</p>
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
NextToken?: string | undefined;
|
|
1076
|
+
/**
|
|
1077
|
+
* <p>The maximum number of audit findings to return in one operation. If you omit this parameter, the default of 10 is used.</p>
|
|
1078
|
+
* @public
|
|
1079
|
+
*/
|
|
1080
|
+
MaxResults?: number | undefined;
|
|
1081
|
+
}
|
|
1082
|
+
/**
|
|
1083
|
+
* @public
|
|
1084
|
+
* @enum
|
|
1085
|
+
*/
|
|
1086
|
+
export declare const Severity: {
|
|
1087
|
+
readonly CRITICAL: "CRITICAL";
|
|
1088
|
+
readonly HIGH: "HIGH";
|
|
1089
|
+
readonly LOW: "LOW";
|
|
1090
|
+
readonly MEDIUM: "MEDIUM";
|
|
1091
|
+
readonly NONE: "NONE";
|
|
1092
|
+
};
|
|
1093
|
+
/**
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
1096
|
+
export type Severity = (typeof Severity)[keyof typeof Severity];
|
|
1097
|
+
/**
|
|
1098
|
+
* <p>A structure that contains the result of an automated audit analysis, including the auditor name, description of findings, and severity level.</p>
|
|
1099
|
+
* @public
|
|
1100
|
+
*/
|
|
1101
|
+
export interface AuditorResult {
|
|
1102
|
+
/**
|
|
1103
|
+
* <p>The name of the auditor algorithm that generated this result.</p>
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
Auditor?: string | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>A detailed description of the audit finding, explaining what was observed and potential implications.</p>
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
Description?: string | undefined;
|
|
1112
|
+
/**
|
|
1113
|
+
* <p>The severity level of this audit finding, indicating the importance and potential impact of the issue.</p>
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
Severity?: Severity | undefined;
|
|
1117
|
+
}
|
|
1118
|
+
/**
|
|
1119
|
+
* @public
|
|
1120
|
+
* @enum
|
|
1121
|
+
*/
|
|
1122
|
+
export declare const ConnectionType: {
|
|
1123
|
+
readonly DIRECT: "DIRECT";
|
|
1124
|
+
readonly INDIRECT: "INDIRECT";
|
|
1125
|
+
};
|
|
1126
|
+
/**
|
|
1127
|
+
* @public
|
|
1128
|
+
*/
|
|
1129
|
+
export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
|
|
1130
|
+
/**
|
|
1131
|
+
* <p>A structure that represents a connection between two nodes in a dependency graph, showing the relationship and characteristics of the connection.</p>
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
export interface Edge {
|
|
1135
|
+
/**
|
|
1136
|
+
* <p>The identifier of the source node in this edge connection.</p>
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
SourceNodeId?: string | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The identifier of the destination node in this edge connection.</p>
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
DestinationNodeId?: string | undefined;
|
|
1145
|
+
/**
|
|
1146
|
+
* <p>The duration or latency associated with this connection, if applicable.</p>
|
|
1147
|
+
* @public
|
|
1148
|
+
*/
|
|
1149
|
+
Duration?: number | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* <p>The type of connection between the nodes, indicating the nature of the relationship.</p>
|
|
1152
|
+
* @public
|
|
1153
|
+
*/
|
|
1154
|
+
ConnectionType?: ConnectionType | undefined;
|
|
1155
|
+
}
|
|
1156
|
+
/**
|
|
1157
|
+
* <p>A structure that represents a node in a dependency graph, containing information about a service, resource, or other entity and its characteristics.</p>
|
|
1158
|
+
* @public
|
|
1159
|
+
*/
|
|
1160
|
+
export interface Node {
|
|
1161
|
+
/**
|
|
1162
|
+
* <p>The key attributes that identify this node, including Type, Name, and Environment information.</p>
|
|
1163
|
+
* @public
|
|
1164
|
+
*/
|
|
1165
|
+
KeyAttributes: Record<string, string> | undefined;
|
|
1166
|
+
/**
|
|
1167
|
+
* <p>The name of the entity represented by this node.</p>
|
|
1168
|
+
* @public
|
|
1169
|
+
*/
|
|
1170
|
+
Name: string | undefined;
|
|
1171
|
+
/**
|
|
1172
|
+
* <p>A unique identifier for this node within the dependency graph.</p>
|
|
1173
|
+
* @public
|
|
1174
|
+
*/
|
|
1175
|
+
NodeId: string | undefined;
|
|
1176
|
+
/**
|
|
1177
|
+
* <p>The operation associated with this node, if applicable.</p>
|
|
1178
|
+
* @public
|
|
1179
|
+
*/
|
|
1180
|
+
Operation?: string | undefined;
|
|
1181
|
+
/**
|
|
1182
|
+
* <p>The type of entity represented by this node, such as <code>Service</code> or <code>Resource</code>.</p>
|
|
1183
|
+
* @public
|
|
1184
|
+
*/
|
|
1185
|
+
Type?: string | undefined;
|
|
1186
|
+
/**
|
|
1187
|
+
* <p>The duration or processing time associated with this node, if applicable.</p>
|
|
1188
|
+
* @public
|
|
1189
|
+
*/
|
|
1190
|
+
Duration?: number | undefined;
|
|
1191
|
+
/**
|
|
1192
|
+
* <p>The status of the entity represented by this node.</p>
|
|
1193
|
+
* @public
|
|
1194
|
+
*/
|
|
1195
|
+
Status?: string | undefined;
|
|
1196
|
+
}
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>A structure that represents the dependency relationships relevant to an audit finding, containing nodes and edges that show how services and resources are connected.</p>
|
|
1199
|
+
* @public
|
|
1200
|
+
*/
|
|
1201
|
+
export interface DependencyGraph {
|
|
1202
|
+
/**
|
|
1203
|
+
* <p>An array of nodes representing the services, resources, or other entities in the dependency graph.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
Nodes?: Node[] | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>An array of edges representing the connections and relationships between the nodes in the dependency graph.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
Edges?: Edge[] | undefined;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* <p>A structure that contains metric data queries and time range information that provides context for audit findings through relevant performance metrics.</p>
|
|
1215
|
+
* @public
|
|
1216
|
+
*/
|
|
1217
|
+
export interface MetricGraph {
|
|
1218
|
+
/**
|
|
1219
|
+
* <p>An array of metric data queries that define the metrics to be retrieved and analyzed as part of the audit finding context.</p>
|
|
1220
|
+
* @public
|
|
1221
|
+
*/
|
|
1222
|
+
MetricDataQueries?: MetricDataQuery[] | undefined;
|
|
1223
|
+
/**
|
|
1224
|
+
* <p>The start time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1225
|
+
* @public
|
|
1226
|
+
*/
|
|
1227
|
+
StartTime?: Date | undefined;
|
|
1228
|
+
/**
|
|
1229
|
+
* <p>The end time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1230
|
+
* @public
|
|
1231
|
+
*/
|
|
1232
|
+
EndTime?: Date | undefined;
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* <p>A structure that contains information about an audit finding, which represents an automated analysis result about service behavior, performance issues, or potential problems identified through heuristic algorithms.</p>
|
|
1236
|
+
* @public
|
|
1237
|
+
*/
|
|
1238
|
+
export interface AuditFinding {
|
|
1239
|
+
/**
|
|
1240
|
+
* <p>The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.</p>
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
KeyAttributes: Record<string, string> | undefined;
|
|
1244
|
+
/**
|
|
1245
|
+
* <p>An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.</p>
|
|
1246
|
+
* @public
|
|
1247
|
+
*/
|
|
1248
|
+
AuditorResults?: AuditorResult[] | undefined;
|
|
1249
|
+
/**
|
|
1250
|
+
* <p>The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.</p>
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
Operation?: string | undefined;
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.</p>
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
MetricGraph?: MetricGraph | undefined;
|
|
1259
|
+
/**
|
|
1260
|
+
* <p>A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.</p>
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
DependencyGraph?: DependencyGraph | undefined;
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>The type of audit finding.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
Type?: string | undefined;
|
|
1269
|
+
}
|
|
1270
|
+
/**
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
export interface ListAuditFindingsOutput {
|
|
1274
|
+
/**
|
|
1275
|
+
* <p>An array of structures, where each structure contains information about one audit finding, including the auditor results, severity, and associated metric and dependency graphs.</p>
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
AuditFindings: AuditFinding[] | undefined;
|
|
1279
|
+
/**
|
|
1280
|
+
* <p>Include this value in your next use of this API to get the next set of audit findings.</p>
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
NextToken?: string | undefined;
|
|
1284
|
+
}
|
|
1285
|
+
/**
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
export interface ListGroupingAttributeDefinitionsInput {
|
|
1289
|
+
/**
|
|
1290
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.</p>
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1293
|
+
NextToken?: string | undefined;
|
|
1294
|
+
}
|
|
1295
|
+
/**
|
|
1296
|
+
* <p>A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.</p>
|
|
1297
|
+
* @public
|
|
1298
|
+
*/
|
|
1299
|
+
export interface GroupingAttributeDefinition {
|
|
1300
|
+
/**
|
|
1301
|
+
* <p>The friendly name for this grouping attribute, such as <code>BusinessUnit</code> or <code>Environment</code>. This name is used to identify the grouping in the console and APIs.</p>
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
GroupingName: string | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, ["business_unit", "team"] would look for values in those fields.</p>
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
GroupingSourceKeys?: string[] | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.</p>
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
DefaultGroupingValue?: string | undefined;
|
|
1315
|
+
}
|
|
1316
|
+
/**
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
export interface ListGroupingAttributeDefinitionsOutput {
|
|
1320
|
+
/**
|
|
1321
|
+
* <p>An array of structures, where each structure contains information about one grouping attribute definition, including the grouping name, source keys, and default values.</p>
|
|
1322
|
+
* @public
|
|
1323
|
+
*/
|
|
1324
|
+
GroupingAttributeDefinitions: GroupingAttributeDefinition[] | undefined;
|
|
1325
|
+
/**
|
|
1326
|
+
* <p>The timestamp when the grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
UpdatedAt?: Date | undefined;
|
|
1330
|
+
/**
|
|
1331
|
+
* <p>Include this value in your next use of this API to get the next set of grouping attribute definitions.</p>
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
NextToken?: string | undefined;
|
|
1335
|
+
}
|
|
1288
1336
|
/**
|
|
1289
1337
|
* @public
|
|
1290
1338
|
*/
|
|
1291
1339
|
export interface ListServiceDependenciesInput {
|
|
1292
1340
|
/**
|
|
1293
|
-
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1294
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1295
|
-
* </p>
|
|
1296
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1341
|
+
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1297
1342
|
* @public
|
|
1298
1343
|
*/
|
|
1299
1344
|
StartTime: Date | undefined;
|
|
1300
1345
|
/**
|
|
1301
|
-
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1302
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1303
|
-
* </p>
|
|
1304
|
-
* <p>Your requested end time will be rounded to the nearest hour.</p>
|
|
1346
|
+
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested end time will be rounded to the nearest hour.</p>
|
|
1305
1347
|
* @public
|
|
1306
1348
|
*/
|
|
1307
1349
|
EndTime: Date | undefined;
|
|
1308
1350
|
/**
|
|
1309
|
-
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>,
|
|
1310
|
-
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
1311
|
-
* <p>This is a string-to-string map. It can
|
|
1312
|
-
* include the following fields.</p>
|
|
1313
|
-
* <ul>
|
|
1314
|
-
* <li>
|
|
1315
|
-
* <p>
|
|
1316
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1317
|
-
* </li>
|
|
1318
|
-
* <li>
|
|
1319
|
-
* <p>
|
|
1320
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1321
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1322
|
-
* </li>
|
|
1323
|
-
* <li>
|
|
1324
|
-
* <p>
|
|
1325
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1326
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1327
|
-
* </li>
|
|
1328
|
-
* <li>
|
|
1329
|
-
* <p>
|
|
1330
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1331
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1332
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1333
|
-
* </li>
|
|
1334
|
-
* <li>
|
|
1335
|
-
* <p>
|
|
1336
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1337
|
-
* </li>
|
|
1338
|
-
* </ul>
|
|
1351
|
+
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1339
1352
|
* @public
|
|
1340
1353
|
*/
|
|
1341
1354
|
KeyAttributes: Record<string, string> | undefined;
|
|
1342
1355
|
/**
|
|
1343
|
-
* <p>The maximum number of results to return in one operation. If you omit this
|
|
1344
|
-
* parameter, the default of 50 is used.</p>
|
|
1356
|
+
* <p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p>
|
|
1345
1357
|
* @public
|
|
1346
1358
|
*/
|
|
1347
1359
|
MaxResults?: number | undefined;
|
|
@@ -1352,8 +1364,7 @@ export interface ListServiceDependenciesInput {
|
|
|
1352
1364
|
NextToken?: string | undefined;
|
|
1353
1365
|
}
|
|
1354
1366
|
/**
|
|
1355
|
-
* <p>This structure contains information about one dependency
|
|
1356
|
-
* of this service.</p>
|
|
1367
|
+
* <p>This structure contains information about one dependency of this service.</p>
|
|
1357
1368
|
* @public
|
|
1358
1369
|
*/
|
|
1359
1370
|
export interface ServiceDependency {
|
|
@@ -1363,34 +1374,7 @@ export interface ServiceDependency {
|
|
|
1363
1374
|
*/
|
|
1364
1375
|
OperationName: string | undefined;
|
|
1365
1376
|
/**
|
|
1366
|
-
* <p>This is a string-to-string map. It can
|
|
1367
|
-
* include the following fields.</p>
|
|
1368
|
-
* <ul>
|
|
1369
|
-
* <li>
|
|
1370
|
-
* <p>
|
|
1371
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1372
|
-
* </li>
|
|
1373
|
-
* <li>
|
|
1374
|
-
* <p>
|
|
1375
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1376
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1377
|
-
* </li>
|
|
1378
|
-
* <li>
|
|
1379
|
-
* <p>
|
|
1380
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1381
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1382
|
-
* </li>
|
|
1383
|
-
* <li>
|
|
1384
|
-
* <p>
|
|
1385
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1386
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1387
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1388
|
-
* </li>
|
|
1389
|
-
* <li>
|
|
1390
|
-
* <p>
|
|
1391
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1392
|
-
* </li>
|
|
1393
|
-
* </ul>
|
|
1377
|
+
* <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1394
1378
|
* @public
|
|
1395
1379
|
*/
|
|
1396
1380
|
DependencyKeyAttributes: Record<string, string> | undefined;
|
|
@@ -1400,9 +1384,7 @@ export interface ServiceDependency {
|
|
|
1400
1384
|
*/
|
|
1401
1385
|
DependencyOperationName: string | undefined;
|
|
1402
1386
|
/**
|
|
1403
|
-
* <p>An array of structures that each contain information about one metric associated with this service dependency
|
|
1404
|
-
* that was discovered by
|
|
1405
|
-
* Application Signals.</p>
|
|
1387
|
+
* <p>An array of structures that each contain information about one metric associated with this service dependency that was discovered by Application Signals.</p>
|
|
1406
1388
|
* @public
|
|
1407
1389
|
*/
|
|
1408
1390
|
MetricReferences: MetricReference[] | undefined;
|
|
@@ -1412,20 +1394,12 @@ export interface ServiceDependency {
|
|
|
1412
1394
|
*/
|
|
1413
1395
|
export interface ListServiceDependenciesOutput {
|
|
1414
1396
|
/**
|
|
1415
|
-
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1416
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1417
|
-
* </p>
|
|
1418
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1419
|
-
* it was rounded to the nearest hour.</p>
|
|
1397
|
+
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1420
1398
|
* @public
|
|
1421
1399
|
*/
|
|
1422
1400
|
StartTime: Date | undefined;
|
|
1423
1401
|
/**
|
|
1424
|
-
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1425
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1426
|
-
* </p>
|
|
1427
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1428
|
-
* it was rounded to the nearest hour.</p>
|
|
1402
|
+
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1429
1403
|
* @public
|
|
1430
1404
|
*/
|
|
1431
1405
|
EndTime: Date | undefined;
|
|
@@ -1435,8 +1409,7 @@ export interface ListServiceDependenciesOutput {
|
|
|
1435
1409
|
*/
|
|
1436
1410
|
ServiceDependencies: ServiceDependency[] | undefined;
|
|
1437
1411
|
/**
|
|
1438
|
-
* <p>Include this value in your next use of this API to get next set
|
|
1439
|
-
* of service dependencies.</p>
|
|
1412
|
+
* <p>Include this value in your next use of this API to get next set of service dependencies.</p>
|
|
1440
1413
|
* @public
|
|
1441
1414
|
*/
|
|
1442
1415
|
NextToken?: string | undefined;
|
|
@@ -1446,58 +1419,22 @@ export interface ListServiceDependenciesOutput {
|
|
|
1446
1419
|
*/
|
|
1447
1420
|
export interface ListServiceDependentsInput {
|
|
1448
1421
|
/**
|
|
1449
|
-
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1450
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1451
|
-
* </p>
|
|
1452
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1422
|
+
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1453
1423
|
* @public
|
|
1454
1424
|
*/
|
|
1455
1425
|
StartTime: Date | undefined;
|
|
1456
1426
|
/**
|
|
1457
|
-
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1458
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1459
|
-
* </p>
|
|
1460
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1427
|
+
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1461
1428
|
* @public
|
|
1462
1429
|
*/
|
|
1463
1430
|
EndTime: Date | undefined;
|
|
1464
1431
|
/**
|
|
1465
|
-
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>,
|
|
1466
|
-
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
1467
|
-
* <p>This is a string-to-string map. It can
|
|
1468
|
-
* include the following fields.</p>
|
|
1469
|
-
* <ul>
|
|
1470
|
-
* <li>
|
|
1471
|
-
* <p>
|
|
1472
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1473
|
-
* </li>
|
|
1474
|
-
* <li>
|
|
1475
|
-
* <p>
|
|
1476
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1477
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1478
|
-
* </li>
|
|
1479
|
-
* <li>
|
|
1480
|
-
* <p>
|
|
1481
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1482
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1483
|
-
* </li>
|
|
1484
|
-
* <li>
|
|
1485
|
-
* <p>
|
|
1486
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1487
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1488
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1489
|
-
* </li>
|
|
1490
|
-
* <li>
|
|
1491
|
-
* <p>
|
|
1492
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1493
|
-
* </li>
|
|
1494
|
-
* </ul>
|
|
1432
|
+
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1495
1433
|
* @public
|
|
1496
1434
|
*/
|
|
1497
1435
|
KeyAttributes: Record<string, string> | undefined;
|
|
1498
1436
|
/**
|
|
1499
|
-
* <p>The maximum number of results to return in one operation. If you omit this
|
|
1500
|
-
* parameter, the default of 50 is used.</p>
|
|
1437
|
+
* <p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p>
|
|
1501
1438
|
* @public
|
|
1502
1439
|
*/
|
|
1503
1440
|
MaxResults?: number | undefined;
|
|
@@ -1508,9 +1445,7 @@ export interface ListServiceDependentsInput {
|
|
|
1508
1445
|
NextToken?: string | undefined;
|
|
1509
1446
|
}
|
|
1510
1447
|
/**
|
|
1511
|
-
* <p>This structure contains information about a service dependent that was discovered by Application Signals. A
|
|
1512
|
-
* dependent is an entity that invoked the specified service during the provided time range. Dependents include
|
|
1513
|
-
* other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.</p>
|
|
1448
|
+
* <p>This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity 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>
|
|
1514
1449
|
* @public
|
|
1515
1450
|
*/
|
|
1516
1451
|
export interface ServiceDependent {
|
|
@@ -1520,47 +1455,17 @@ export interface ServiceDependent {
|
|
|
1520
1455
|
*/
|
|
1521
1456
|
OperationName?: string | undefined;
|
|
1522
1457
|
/**
|
|
1523
|
-
* <p>This is a string-to-string map. It can
|
|
1524
|
-
* include the following fields.</p>
|
|
1525
|
-
* <ul>
|
|
1526
|
-
* <li>
|
|
1527
|
-
* <p>
|
|
1528
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1529
|
-
* </li>
|
|
1530
|
-
* <li>
|
|
1531
|
-
* <p>
|
|
1532
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1533
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1534
|
-
* </li>
|
|
1535
|
-
* <li>
|
|
1536
|
-
* <p>
|
|
1537
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1538
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1539
|
-
* </li>
|
|
1540
|
-
* <li>
|
|
1541
|
-
* <p>
|
|
1542
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1543
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1544
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1545
|
-
* </li>
|
|
1546
|
-
* <li>
|
|
1547
|
-
* <p>
|
|
1548
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1549
|
-
* </li>
|
|
1550
|
-
* </ul>
|
|
1458
|
+
* <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1551
1459
|
* @public
|
|
1552
1460
|
*/
|
|
1553
1461
|
DependentKeyAttributes: Record<string, string> | undefined;
|
|
1554
1462
|
/**
|
|
1555
|
-
* <p>If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation
|
|
1556
|
-
* is displayed here.</p>
|
|
1463
|
+
* <p>If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.</p>
|
|
1557
1464
|
* @public
|
|
1558
1465
|
*/
|
|
1559
1466
|
DependentOperationName?: string | undefined;
|
|
1560
1467
|
/**
|
|
1561
|
-
* <p>An array of structures that each contain information about one metric associated with this service dependent
|
|
1562
|
-
* that was discovered by
|
|
1563
|
-
* Application Signals.</p>
|
|
1468
|
+
* <p>An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.</p>
|
|
1564
1469
|
* @public
|
|
1565
1470
|
*/
|
|
1566
1471
|
MetricReferences: MetricReference[] | undefined;
|
|
@@ -1570,20 +1475,12 @@ export interface ServiceDependent {
|
|
|
1570
1475
|
*/
|
|
1571
1476
|
export interface ListServiceDependentsOutput {
|
|
1572
1477
|
/**
|
|
1573
|
-
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1574
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1575
|
-
* </p>
|
|
1576
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1577
|
-
* it was rounded to the nearest hour.</p>
|
|
1478
|
+
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1578
1479
|
* @public
|
|
1579
1480
|
*/
|
|
1580
1481
|
StartTime: Date | undefined;
|
|
1581
1482
|
/**
|
|
1582
|
-
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1583
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1584
|
-
* </p>
|
|
1585
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1586
|
-
* it was rounded to the nearest hour.</p>
|
|
1483
|
+
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1587
1484
|
* @public
|
|
1588
1485
|
*/
|
|
1589
1486
|
EndTime: Date | undefined;
|
|
@@ -1593,8 +1490,7 @@ export interface ListServiceDependentsOutput {
|
|
|
1593
1490
|
*/
|
|
1594
1491
|
ServiceDependents: ServiceDependent[] | undefined;
|
|
1595
1492
|
/**
|
|
1596
|
-
* <p>Include this value in your next use of this API to get next set
|
|
1597
|
-
* of service dependents.</p>
|
|
1493
|
+
* <p>Include this value in your next use of this API to get next set of service dependents.</p>
|
|
1598
1494
|
* @public
|
|
1599
1495
|
*/
|
|
1600
1496
|
NextToken?: string | undefined;
|
|
@@ -1609,16 +1505,12 @@ export interface ListServiceLevelObjectiveExclusionWindowsInput {
|
|
|
1609
1505
|
*/
|
|
1610
1506
|
Id: string | undefined;
|
|
1611
1507
|
/**
|
|
1612
|
-
* <p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
|
|
1613
|
-
*
|
|
1614
|
-
* </p>
|
|
1508
|
+
* <p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. </p>
|
|
1615
1509
|
* @public
|
|
1616
1510
|
*/
|
|
1617
1511
|
MaxResults?: number | undefined;
|
|
1618
1512
|
/**
|
|
1619
|
-
* <p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
|
|
1620
|
-
*
|
|
1621
|
-
* </p>
|
|
1513
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives. </p>
|
|
1622
1514
|
* @public
|
|
1623
1515
|
*/
|
|
1624
1516
|
NextToken?: string | undefined;
|
|
@@ -1633,9 +1525,7 @@ export interface ListServiceLevelObjectiveExclusionWindowsOutput {
|
|
|
1633
1525
|
*/
|
|
1634
1526
|
ExclusionWindows: ExclusionWindow[] | undefined;
|
|
1635
1527
|
/**
|
|
1636
|
-
* <p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
|
|
1637
|
-
*
|
|
1638
|
-
* </p>
|
|
1528
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives. </p>
|
|
1639
1529
|
* @public
|
|
1640
1530
|
*/
|
|
1641
1531
|
NextToken?: string | undefined;
|
|
@@ -1645,58 +1535,22 @@ export interface ListServiceLevelObjectiveExclusionWindowsOutput {
|
|
|
1645
1535
|
*/
|
|
1646
1536
|
export interface ListServiceOperationsInput {
|
|
1647
1537
|
/**
|
|
1648
|
-
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1649
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1650
|
-
* </p>
|
|
1651
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1538
|
+
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1652
1539
|
* @public
|
|
1653
1540
|
*/
|
|
1654
1541
|
StartTime: Date | undefined;
|
|
1655
1542
|
/**
|
|
1656
|
-
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1657
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1658
|
-
* </p>
|
|
1659
|
-
* <p>Your requested end time will be rounded to the nearest hour.</p>
|
|
1543
|
+
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested end time will be rounded to the nearest hour.</p>
|
|
1660
1544
|
* @public
|
|
1661
1545
|
*/
|
|
1662
1546
|
EndTime: Date | undefined;
|
|
1663
1547
|
/**
|
|
1664
|
-
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>,
|
|
1665
|
-
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
1666
|
-
* <p>This is a string-to-string map. It can
|
|
1667
|
-
* include the following fields.</p>
|
|
1668
|
-
* <ul>
|
|
1669
|
-
* <li>
|
|
1670
|
-
* <p>
|
|
1671
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1672
|
-
* </li>
|
|
1673
|
-
* <li>
|
|
1674
|
-
* <p>
|
|
1675
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1676
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1677
|
-
* </li>
|
|
1678
|
-
* <li>
|
|
1679
|
-
* <p>
|
|
1680
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1681
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1682
|
-
* </li>
|
|
1683
|
-
* <li>
|
|
1684
|
-
* <p>
|
|
1685
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1686
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1687
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1688
|
-
* </li>
|
|
1689
|
-
* <li>
|
|
1690
|
-
* <p>
|
|
1691
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1692
|
-
* </li>
|
|
1693
|
-
* </ul>
|
|
1548
|
+
* <p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1694
1549
|
* @public
|
|
1695
1550
|
*/
|
|
1696
1551
|
KeyAttributes: Record<string, string> | undefined;
|
|
1697
1552
|
/**
|
|
1698
|
-
* <p>The maximum number of results to return in one operation. If you omit this
|
|
1699
|
-
* parameter, the default of 50 is used.</p>
|
|
1553
|
+
* <p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p>
|
|
1700
1554
|
* @public
|
|
1701
1555
|
*/
|
|
1702
1556
|
MaxResults?: number | undefined;
|
|
@@ -1707,10 +1561,7 @@ export interface ListServiceOperationsInput {
|
|
|
1707
1561
|
NextToken?: string | undefined;
|
|
1708
1562
|
}
|
|
1709
1563
|
/**
|
|
1710
|
-
* <p>This structure contains information about an operation discovered by Application Signals. An operation
|
|
1711
|
-
* is a specific function performed by a service that was discovered by Application Signals, and is often an API
|
|
1712
|
-
* that is called by an upstream dependent.
|
|
1713
|
-
* </p>
|
|
1564
|
+
* <p>This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent. </p>
|
|
1714
1565
|
* @public
|
|
1715
1566
|
*/
|
|
1716
1567
|
export interface ServiceOperation {
|
|
@@ -1720,9 +1571,7 @@ export interface ServiceOperation {
|
|
|
1720
1571
|
*/
|
|
1721
1572
|
Name: string | undefined;
|
|
1722
1573
|
/**
|
|
1723
|
-
* <p>An array of structures that each contain information about one metric associated with this service operation
|
|
1724
|
-
* that was discovered by
|
|
1725
|
-
* Application Signals.</p>
|
|
1574
|
+
* <p>An array of structures that each contain information about one metric associated with this service operation that was discovered by Application Signals.</p>
|
|
1726
1575
|
* @public
|
|
1727
1576
|
*/
|
|
1728
1577
|
MetricReferences: MetricReference[] | undefined;
|
|
@@ -1732,20 +1581,12 @@ export interface ServiceOperation {
|
|
|
1732
1581
|
*/
|
|
1733
1582
|
export interface ListServiceOperationsOutput {
|
|
1734
1583
|
/**
|
|
1735
|
-
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1736
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1737
|
-
* </p>
|
|
1738
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1739
|
-
* it was rounded to the nearest hour.</p>
|
|
1584
|
+
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1740
1585
|
* @public
|
|
1741
1586
|
*/
|
|
1742
1587
|
StartTime: Date | undefined;
|
|
1743
1588
|
/**
|
|
1744
|
-
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1745
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1746
|
-
* </p>
|
|
1747
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1748
|
-
* it was rounded to the nearest hour.</p>
|
|
1589
|
+
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1749
1590
|
* @public
|
|
1750
1591
|
*/
|
|
1751
1592
|
EndTime: Date | undefined;
|
|
@@ -1755,8 +1596,7 @@ export interface ListServiceOperationsOutput {
|
|
|
1755
1596
|
*/
|
|
1756
1597
|
ServiceOperations: ServiceOperation[] | undefined;
|
|
1757
1598
|
/**
|
|
1758
|
-
* <p>Include this value in your next use of this API to get next set
|
|
1759
|
-
* of service operations.</p>
|
|
1599
|
+
* <p>Include this value in your next use of this API to get next set of service operations.</p>
|
|
1760
1600
|
* @public
|
|
1761
1601
|
*/
|
|
1762
1602
|
NextToken?: string | undefined;
|
|
@@ -1766,30 +1606,17 @@ export interface ListServiceOperationsOutput {
|
|
|
1766
1606
|
*/
|
|
1767
1607
|
export interface ListServicesInput {
|
|
1768
1608
|
/**
|
|
1769
|
-
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1770
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1771
|
-
* </p>
|
|
1772
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1609
|
+
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1773
1610
|
* @public
|
|
1774
1611
|
*/
|
|
1775
1612
|
StartTime: Date | undefined;
|
|
1776
1613
|
/**
|
|
1777
|
-
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
|
|
1778
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1779
|
-
* </p>
|
|
1780
|
-
* <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1614
|
+
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>
|
|
1781
1615
|
* @public
|
|
1782
1616
|
*/
|
|
1783
1617
|
EndTime: Date | undefined;
|
|
1784
1618
|
/**
|
|
1785
|
-
* <p>
|
|
1786
|
-
* The maximum number
|
|
1787
|
-
* of results
|
|
1788
|
-
* to return
|
|
1789
|
-
* in one operation.
|
|
1790
|
-
* If you omit this parameter,
|
|
1791
|
-
* the default of 50 is used.
|
|
1792
|
-
* </p>
|
|
1619
|
+
* <p> The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used. </p>
|
|
1793
1620
|
* @public
|
|
1794
1621
|
*/
|
|
1795
1622
|
MaxResults?: number | undefined;
|
|
@@ -1799,9 +1626,7 @@ export interface ListServicesInput {
|
|
|
1799
1626
|
*/
|
|
1800
1627
|
NextToken?: string | undefined;
|
|
1801
1628
|
/**
|
|
1802
|
-
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include services from source accounts in the returned data.
|
|
1803
|
-
*
|
|
1804
|
-
* </p>
|
|
1629
|
+
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include services from source accounts in the returned data. </p>
|
|
1805
1630
|
* @public
|
|
1806
1631
|
*/
|
|
1807
1632
|
IncludeLinkedAccounts?: boolean | undefined;
|
|
@@ -1812,114 +1637,17 @@ export interface ListServicesInput {
|
|
|
1812
1637
|
AwsAccountId?: string | undefined;
|
|
1813
1638
|
}
|
|
1814
1639
|
/**
|
|
1815
|
-
* <p>This structure contains information about one of your services that
|
|
1816
|
-
* was discovered by Application Signals</p>
|
|
1640
|
+
* <p>This structure contains information about one of your services that was discovered by Application Signals</p>
|
|
1817
1641
|
* @public
|
|
1818
1642
|
*/
|
|
1819
1643
|
export interface ServiceSummary {
|
|
1820
1644
|
/**
|
|
1821
|
-
* <p>This is a string-to-string map that help identify the objects discovered by Application Signals. It can
|
|
1822
|
-
* include the following fields.</p>
|
|
1823
|
-
* <ul>
|
|
1824
|
-
* <li>
|
|
1825
|
-
* <p>
|
|
1826
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
1827
|
-
* </li>
|
|
1828
|
-
* <li>
|
|
1829
|
-
* <p>
|
|
1830
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1831
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1832
|
-
* </li>
|
|
1833
|
-
* <li>
|
|
1834
|
-
* <p>
|
|
1835
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1836
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1837
|
-
* </li>
|
|
1838
|
-
* <li>
|
|
1839
|
-
* <p>
|
|
1840
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1841
|
-
* This is used only if the value of the <code>Type</code> field
|
|
1842
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1843
|
-
* </li>
|
|
1844
|
-
* <li>
|
|
1845
|
-
* <p>
|
|
1846
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1847
|
-
* </li>
|
|
1848
|
-
* </ul>
|
|
1645
|
+
* <p>This is a string-to-string map that help identify the objects discovered by Application Signals. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
1849
1646
|
* @public
|
|
1850
1647
|
*/
|
|
1851
1648
|
KeyAttributes: Record<string, string> | undefined;
|
|
1852
1649
|
/**
|
|
1853
|
-
* <p>This structure contains one or more string-to-string maps that help identify this service. It can include <i>platform attributes</i>, <i>application attributes</i>, and <i>telemetry attributes</i>.</p>
|
|
1854
|
-
* <p>Platform attributes contain information the service's platform.</p>
|
|
1855
|
-
* <ul>
|
|
1856
|
-
* <li>
|
|
1857
|
-
* <p>
|
|
1858
|
-
* <code>PlatformType</code> defines the hosted-in platform.</p>
|
|
1859
|
-
* </li>
|
|
1860
|
-
* <li>
|
|
1861
|
-
* <p>
|
|
1862
|
-
* <code>EKS.Cluster</code> is the name of the Amazon EKS cluster.</p>
|
|
1863
|
-
* </li>
|
|
1864
|
-
* <li>
|
|
1865
|
-
* <p>
|
|
1866
|
-
* <code>K8s.Cluster</code> is the name of the self-hosted Kubernetes cluster.</p>
|
|
1867
|
-
* </li>
|
|
1868
|
-
* <li>
|
|
1869
|
-
* <p>
|
|
1870
|
-
* <code>K8s.Namespace</code> is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.</p>
|
|
1871
|
-
* </li>
|
|
1872
|
-
* <li>
|
|
1873
|
-
* <p>
|
|
1874
|
-
* <code>K8s.Workload</code> is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.</p>
|
|
1875
|
-
* </li>
|
|
1876
|
-
* <li>
|
|
1877
|
-
* <p>
|
|
1878
|
-
* <code>K8s.Node</code> is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.</p>
|
|
1879
|
-
* </li>
|
|
1880
|
-
* <li>
|
|
1881
|
-
* <p>
|
|
1882
|
-
* <code>K8s.Pod</code> is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.</p>
|
|
1883
|
-
* </li>
|
|
1884
|
-
* <li>
|
|
1885
|
-
* <p>
|
|
1886
|
-
* <code>EC2.AutoScalingGroup</code> is the name of the Amazon EC2 Auto Scaling group.</p>
|
|
1887
|
-
* </li>
|
|
1888
|
-
* <li>
|
|
1889
|
-
* <p>
|
|
1890
|
-
* <code>EC2.InstanceId</code> is the ID of the Amazon EC2 instance.</p>
|
|
1891
|
-
* </li>
|
|
1892
|
-
* <li>
|
|
1893
|
-
* <p>
|
|
1894
|
-
* <code>Host</code> is the name of the host, for all platform types.</p>
|
|
1895
|
-
* </li>
|
|
1896
|
-
* </ul>
|
|
1897
|
-
* <p>Application attributes contain information about the application.</p>
|
|
1898
|
-
* <ul>
|
|
1899
|
-
* <li>
|
|
1900
|
-
* <p>
|
|
1901
|
-
* <code>AWS.Application</code> is the application's name in Amazon Web Services Service Catalog AppRegistry.</p>
|
|
1902
|
-
* </li>
|
|
1903
|
-
* <li>
|
|
1904
|
-
* <p>
|
|
1905
|
-
* <code>AWS.Application.ARN</code> is the application's ARN in Amazon Web Services Service Catalog AppRegistry.</p>
|
|
1906
|
-
* </li>
|
|
1907
|
-
* </ul>
|
|
1908
|
-
* <p>Telemetry attributes contain telemetry information.</p>
|
|
1909
|
-
* <ul>
|
|
1910
|
-
* <li>
|
|
1911
|
-
* <p>
|
|
1912
|
-
* <code>Telemetry.SDK</code> is the fingerprint of the OpenTelemetry SDK version for instrumented services.</p>
|
|
1913
|
-
* </li>
|
|
1914
|
-
* <li>
|
|
1915
|
-
* <p>
|
|
1916
|
-
* <code>Telemetry.Agent</code> is the fingerprint of the agent used to collect and send telemetry data.</p>
|
|
1917
|
-
* </li>
|
|
1918
|
-
* <li>
|
|
1919
|
-
* <p>
|
|
1920
|
-
* <code>Telemetry.Source</code> Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.</p>
|
|
1921
|
-
* </li>
|
|
1922
|
-
* </ul>
|
|
1650
|
+
* <p>This structure contains one or more string-to-string maps that help identify this service. It can include <i>platform attributes</i>, <i>application attributes</i>, and <i>telemetry attributes</i>.</p> <p>Platform attributes contain information the service's platform.</p> <ul> <li> <p> <code>PlatformType</code> defines the hosted-in platform.</p> </li> <li> <p> <code>EKS.Cluster</code> is the name of the Amazon EKS cluster.</p> </li> <li> <p> <code>K8s.Cluster</code> is the name of the self-hosted Kubernetes cluster.</p> </li> <li> <p> <code>K8s.Namespace</code> is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>K8s.Workload</code> is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>K8s.Node</code> is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>K8s.Pod</code> is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.</p> </li> <li> <p> <code>EC2.AutoScalingGroup</code> is the name of the Amazon EC2 Auto Scaling group.</p> </li> <li> <p> <code>EC2.InstanceId</code> is the ID of the Amazon EC2 instance.</p> </li> <li> <p> <code>Host</code> is the name of the host, for all platform types.</p> </li> </ul> <p>Application attributes contain information about the application.</p> <ul> <li> <p> <code>AWS.Application</code> is the application's name in Amazon Web Services Service Catalog AppRegistry.</p> </li> <li> <p> <code>AWS.Application.ARN</code> is the application's ARN in Amazon Web Services Service Catalog AppRegistry.</p> </li> </ul> <p>Telemetry attributes contain telemetry information.</p> <ul> <li> <p> <code>Telemetry.SDK</code> is the fingerprint of the OpenTelemetry SDK version for instrumented services.</p> </li> <li> <p> <code>Telemetry.Agent</code> is the fingerprint of the agent used to collect and send telemetry data.</p> </li> <li> <p> <code>Telemetry.Source</code> Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.</p> </li> </ul>
|
|
1923
1651
|
* @public
|
|
1924
1652
|
*/
|
|
1925
1653
|
AttributeMaps?: Record<string, string>[] | undefined;
|
|
@@ -1928,39 +1656,192 @@ export interface ServiceSummary {
|
|
|
1928
1656
|
* @public
|
|
1929
1657
|
*/
|
|
1930
1658
|
MetricReferences: MetricReference[] | undefined;
|
|
1659
|
+
/**
|
|
1660
|
+
* <p>An array of service groups that this service belongs to, based on the configured grouping attributes.</p>
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
ServiceGroups?: ServiceGroup[] | undefined;
|
|
1931
1664
|
}
|
|
1932
1665
|
/**
|
|
1933
1666
|
* @public
|
|
1934
1667
|
*/
|
|
1935
1668
|
export interface ListServicesOutput {
|
|
1936
1669
|
/**
|
|
1937
|
-
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1938
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1939
|
-
* </p>
|
|
1940
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1941
|
-
* it was rounded to the nearest hour.</p>
|
|
1670
|
+
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1942
1671
|
* @public
|
|
1943
1672
|
*/
|
|
1944
1673
|
StartTime: Date | undefined;
|
|
1945
1674
|
/**
|
|
1946
|
-
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
|
|
1947
|
-
* be epoch time in seconds. For example: <code>1698778057</code>
|
|
1948
|
-
* </p>
|
|
1949
|
-
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
|
|
1950
|
-
* it was rounded to the nearest hour.</p>
|
|
1675
|
+
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>
|
|
1951
1676
|
* @public
|
|
1952
1677
|
*/
|
|
1953
1678
|
EndTime: Date | undefined;
|
|
1954
1679
|
/**
|
|
1955
|
-
* <p>An array of structures, where each structure contains some information about a service. To
|
|
1956
|
-
* get complete information about a service, use
|
|
1957
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetService.html">GetService</a>.</p>
|
|
1680
|
+
* <p>An array of structures, where each structure contains some information about a service. To get complete information about a service, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetService.html">GetService</a>.</p>
|
|
1958
1681
|
* @public
|
|
1959
1682
|
*/
|
|
1960
1683
|
ServiceSummaries: ServiceSummary[] | undefined;
|
|
1961
1684
|
/**
|
|
1962
|
-
* <p>Include this value in your next use of this API to get next set
|
|
1963
|
-
*
|
|
1685
|
+
* <p>Include this value in your next use of this API to get next set of services.</p>
|
|
1686
|
+
* @public
|
|
1687
|
+
*/
|
|
1688
|
+
NextToken?: string | undefined;
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
* <p>A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics.</p>
|
|
1692
|
+
* @public
|
|
1693
|
+
*/
|
|
1694
|
+
export interface AttributeFilter {
|
|
1695
|
+
/**
|
|
1696
|
+
* <p>The name of the attribute to filter by, such as <code>Platform</code>, <code>Environment</code>, or <code>BusinessUnit</code>.</p>
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
AttributeFilterName: string | undefined;
|
|
1700
|
+
/**
|
|
1701
|
+
* <p>An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results.</p>
|
|
1702
|
+
* @public
|
|
1703
|
+
*/
|
|
1704
|
+
AttributeFilterValues: string[] | undefined;
|
|
1705
|
+
}
|
|
1706
|
+
/**
|
|
1707
|
+
* @public
|
|
1708
|
+
*/
|
|
1709
|
+
export interface ListServiceStatesInput {
|
|
1710
|
+
/**
|
|
1711
|
+
* <p>The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1712
|
+
* @public
|
|
1713
|
+
*/
|
|
1714
|
+
StartTime: Date | undefined;
|
|
1715
|
+
/**
|
|
1716
|
+
* <p>The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1717
|
+
* @public
|
|
1718
|
+
*/
|
|
1719
|
+
EndTime: Date | undefined;
|
|
1720
|
+
/**
|
|
1721
|
+
* <p>The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.</p>
|
|
1722
|
+
* @public
|
|
1723
|
+
*/
|
|
1724
|
+
MaxResults?: number | undefined;
|
|
1725
|
+
/**
|
|
1726
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of service states.</p>
|
|
1727
|
+
* @public
|
|
1728
|
+
*/
|
|
1729
|
+
NextToken?: string | undefined;
|
|
1730
|
+
/**
|
|
1731
|
+
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include service states from source accounts in the returned data.</p>
|
|
1732
|
+
* @public
|
|
1733
|
+
*/
|
|
1734
|
+
IncludeLinkedAccounts?: boolean | undefined;
|
|
1735
|
+
/**
|
|
1736
|
+
* <p>The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.</p>
|
|
1737
|
+
* @public
|
|
1738
|
+
*/
|
|
1739
|
+
AwsAccountId?: string | undefined;
|
|
1740
|
+
/**
|
|
1741
|
+
* <p>A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.</p>
|
|
1742
|
+
* @public
|
|
1743
|
+
*/
|
|
1744
|
+
AttributeFilters?: AttributeFilter[] | undefined;
|
|
1745
|
+
}
|
|
1746
|
+
/**
|
|
1747
|
+
* @public
|
|
1748
|
+
* @enum
|
|
1749
|
+
*/
|
|
1750
|
+
export declare const ChangeEventType: {
|
|
1751
|
+
readonly DEPLOYMENT: "DEPLOYMENT";
|
|
1752
|
+
};
|
|
1753
|
+
/**
|
|
1754
|
+
* @public
|
|
1755
|
+
*/
|
|
1756
|
+
export type ChangeEventType = (typeof ChangeEventType)[keyof typeof ChangeEventType];
|
|
1757
|
+
/**
|
|
1758
|
+
* <p>A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.</p>
|
|
1759
|
+
* @public
|
|
1760
|
+
*/
|
|
1761
|
+
export interface ChangeEvent {
|
|
1762
|
+
/**
|
|
1763
|
+
* <p>The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1764
|
+
* @public
|
|
1765
|
+
*/
|
|
1766
|
+
Timestamp: Date | undefined;
|
|
1767
|
+
/**
|
|
1768
|
+
* <p>The Amazon Web Services account ID where this change event occurred.</p>
|
|
1769
|
+
* @public
|
|
1770
|
+
*/
|
|
1771
|
+
AccountId: string | undefined;
|
|
1772
|
+
/**
|
|
1773
|
+
* <p>The Amazon Web Services region where this change event occurred.</p>
|
|
1774
|
+
* @public
|
|
1775
|
+
*/
|
|
1776
|
+
Region: string | undefined;
|
|
1777
|
+
/**
|
|
1778
|
+
* <p>The entity (service or resource) that was affected by this change event, including its key attributes.</p>
|
|
1779
|
+
* @public
|
|
1780
|
+
*/
|
|
1781
|
+
Entity: Record<string, string> | undefined;
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>The type of change event that occurred, such as <code>DEPLOYMENT</code>.</p>
|
|
1784
|
+
* @public
|
|
1785
|
+
*/
|
|
1786
|
+
ChangeEventType: ChangeEventType | undefined;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>A unique identifier for this change event.</p>
|
|
1789
|
+
* @public
|
|
1790
|
+
*/
|
|
1791
|
+
EventId: string | undefined;
|
|
1792
|
+
/**
|
|
1793
|
+
* <p>The name of the user who initiated this change event, if available.</p>
|
|
1794
|
+
* @public
|
|
1795
|
+
*/
|
|
1796
|
+
UserName?: string | undefined;
|
|
1797
|
+
/**
|
|
1798
|
+
* <p>The name or description of this change event.</p>
|
|
1799
|
+
* @public
|
|
1800
|
+
*/
|
|
1801
|
+
EventName?: string | undefined;
|
|
1802
|
+
}
|
|
1803
|
+
/**
|
|
1804
|
+
* <p>A structure that contains information about the current state of a service, including its latest change events such as deployments and other state-changing activities.</p>
|
|
1805
|
+
* @public
|
|
1806
|
+
*/
|
|
1807
|
+
export interface ServiceState {
|
|
1808
|
+
/**
|
|
1809
|
+
* <p>The attribute filters that were applied when retrieving this service state information.</p>
|
|
1810
|
+
* @public
|
|
1811
|
+
*/
|
|
1812
|
+
AttributeFilters?: AttributeFilter[] | undefined;
|
|
1813
|
+
/**
|
|
1814
|
+
* <p>The key attributes that identify this service, including Type, Name, and Environment information.</p>
|
|
1815
|
+
* @public
|
|
1816
|
+
*/
|
|
1817
|
+
Service: Record<string, string> | undefined;
|
|
1818
|
+
/**
|
|
1819
|
+
* <p>An array containing the most recent change events for this service, such as deployments, with information about when they occurred and who initiated them.</p>
|
|
1820
|
+
* @public
|
|
1821
|
+
*/
|
|
1822
|
+
LatestChangeEvents: ChangeEvent[] | undefined;
|
|
1823
|
+
}
|
|
1824
|
+
/**
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
export interface ListServiceStatesOutput {
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1830
|
+
* @public
|
|
1831
|
+
*/
|
|
1832
|
+
StartTime: Date | undefined;
|
|
1833
|
+
/**
|
|
1834
|
+
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
EndTime: Date | undefined;
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>An array of structures, where each structure contains information about the state of one service, including its latest change events such as deployments.</p>
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
ServiceStates: ServiceState[] | undefined;
|
|
1843
|
+
/**
|
|
1844
|
+
* <p>Include this value in your next use of this API to get the next set of service states.</p>
|
|
1964
1845
|
* @public
|
|
1965
1846
|
*/
|
|
1966
1847
|
NextToken?: string | undefined;
|
|
@@ -1970,14 +1851,7 @@ export interface ListServicesOutput {
|
|
|
1970
1851
|
*/
|
|
1971
1852
|
export interface ListTagsForResourceRequest {
|
|
1972
1853
|
/**
|
|
1973
|
-
* <p>The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.</p>
|
|
1974
|
-
* <p>The ARN format of an Application Signals SLO is
|
|
1975
|
-
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:slo:<i>slo-name</i>
|
|
1976
|
-
* </code>
|
|
1977
|
-
* </p>
|
|
1978
|
-
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
|
|
1979
|
-
* Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
|
|
1980
|
-
* Reference</i>.</p>
|
|
1854
|
+
* <p>The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.</p> <p>The ARN format of an Application Signals SLO is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:slo:<i>slo-name</i> </code> </p> <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
1981
1855
|
* @public
|
|
1982
1856
|
*/
|
|
1983
1857
|
ResourceArn: string | undefined;
|
|
@@ -1988,8 +1862,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1988
1862
|
*/
|
|
1989
1863
|
export interface Tag {
|
|
1990
1864
|
/**
|
|
1991
|
-
* <p>A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your
|
|
1992
|
-
* resources.</p>
|
|
1865
|
+
* <p>A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.</p>
|
|
1993
1866
|
* @public
|
|
1994
1867
|
*/
|
|
1995
1868
|
Key: string | undefined;
|
|
@@ -2009,6 +1882,42 @@ export interface ListTagsForResourceResponse {
|
|
|
2009
1882
|
*/
|
|
2010
1883
|
Tags?: Tag[] | undefined;
|
|
2011
1884
|
}
|
|
1885
|
+
/**
|
|
1886
|
+
* @public
|
|
1887
|
+
*/
|
|
1888
|
+
export interface PutGroupingConfigurationInput {
|
|
1889
|
+
/**
|
|
1890
|
+
* <p>An array of grouping attribute definitions that specify how services should be grouped. Each definition includes a friendly name, source keys to derive the grouping value from, and an optional default value.</p>
|
|
1891
|
+
* @public
|
|
1892
|
+
*/
|
|
1893
|
+
GroupingAttributeDefinitions: GroupingAttributeDefinition[] | undefined;
|
|
1894
|
+
}
|
|
1895
|
+
/**
|
|
1896
|
+
* <p>A structure that contains the complete grouping configuration for an account, including all defined grouping attributes and metadata about when it was last updated.</p>
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
export interface GroupingConfiguration {
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>An array of grouping attribute definitions that specify how services should be grouped based on various attributes and source keys.</p>
|
|
1902
|
+
* @public
|
|
1903
|
+
*/
|
|
1904
|
+
GroupingAttributeDefinitions: GroupingAttributeDefinition[] | undefined;
|
|
1905
|
+
/**
|
|
1906
|
+
* <p>The timestamp when this grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1907
|
+
* @public
|
|
1908
|
+
*/
|
|
1909
|
+
UpdatedAt: Date | undefined;
|
|
1910
|
+
}
|
|
1911
|
+
/**
|
|
1912
|
+
* @public
|
|
1913
|
+
*/
|
|
1914
|
+
export interface PutGroupingConfigurationOutput {
|
|
1915
|
+
/**
|
|
1916
|
+
* <p>A structure containing the updated grouping configuration, including all grouping attribute definitions and the timestamp when it was last updated.</p>
|
|
1917
|
+
* @public
|
|
1918
|
+
*/
|
|
1919
|
+
GroupingConfiguration: GroupingConfiguration | undefined;
|
|
1920
|
+
}
|
|
2012
1921
|
/**
|
|
2013
1922
|
* <p>This operation attempted to create a resource that already exists.</p>
|
|
2014
1923
|
* @public
|
|
@@ -2023,14 +1932,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
2023
1932
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
2024
1933
|
}
|
|
2025
1934
|
/**
|
|
2026
|
-
* <p>This object defines the length of the look-back window used to calculate one burn rate metric
|
|
2027
|
-
* for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of
|
|
2028
|
-
* exactly 1 indicates that the SLO goal will be met exactly.</p>
|
|
2029
|
-
* <p>For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:</p>
|
|
2030
|
-
* <p>
|
|
2031
|
-
* <i>burn rate = error rate over the look-back window / (100% - attainment goal percentage)</i>
|
|
2032
|
-
* </p>
|
|
2033
|
-
* <p>For more information about burn rates, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-burn">Calculate burn rates</a>.</p>
|
|
1935
|
+
* <p>This object defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.</p> <p>For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:</p> <p> <i>burn rate = error rate over the look-back window / (100% - attainment goal percentage)</i> </p> <p>For more information about burn rates, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-burn">Calculate burn rates</a>.</p>
|
|
2034
1936
|
* @public
|
|
2035
1937
|
*/
|
|
2036
1938
|
export interface BurnRateConfiguration {
|
|
@@ -2046,37 +1948,7 @@ export interface BurnRateConfiguration {
|
|
|
2046
1948
|
*/
|
|
2047
1949
|
export interface RequestBasedServiceLevelIndicatorMetricConfig {
|
|
2048
1950
|
/**
|
|
2049
|
-
* <p>If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service
|
|
2050
|
-
* the SLO metric is related to. To do so, you must specify at least the <code>Type</code>,
|
|
2051
|
-
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
2052
|
-
* <p>This is a string-to-string map. It can
|
|
2053
|
-
* include the following fields.</p>
|
|
2054
|
-
* <ul>
|
|
2055
|
-
* <li>
|
|
2056
|
-
* <p>
|
|
2057
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
2058
|
-
* </li>
|
|
2059
|
-
* <li>
|
|
2060
|
-
* <p>
|
|
2061
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
2062
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2063
|
-
* </li>
|
|
2064
|
-
* <li>
|
|
2065
|
-
* <p>
|
|
2066
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
2067
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
2068
|
-
* </li>
|
|
2069
|
-
* <li>
|
|
2070
|
-
* <p>
|
|
2071
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
2072
|
-
* This is used only if the value of the <code>Type</code> field
|
|
2073
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2074
|
-
* </li>
|
|
2075
|
-
* <li>
|
|
2076
|
-
* <p>
|
|
2077
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
2078
|
-
* </li>
|
|
2079
|
-
* </ul>
|
|
1951
|
+
* <p>If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
2080
1952
|
* @public
|
|
2081
1953
|
*/
|
|
2082
1954
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -2086,25 +1958,17 @@ export interface RequestBasedServiceLevelIndicatorMetricConfig {
|
|
|
2086
1958
|
*/
|
|
2087
1959
|
OperationName?: string | undefined;
|
|
2088
1960
|
/**
|
|
2089
|
-
* <p>If the SLO is to monitor either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals
|
|
2090
|
-
* collects, use this field to specify which of those metrics is used.</p>
|
|
1961
|
+
* <p>If the SLO is to monitor either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals collects, use this field to specify which of those metrics is used.</p>
|
|
2091
1962
|
* @public
|
|
2092
1963
|
*/
|
|
2093
1964
|
MetricType?: ServiceLevelIndicatorMetricType | undefined;
|
|
2094
1965
|
/**
|
|
2095
|
-
* <p>Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO.
|
|
2096
|
-
* This result will be divided by the "good request" or "bad request" value defined in
|
|
2097
|
-
* <code>MonitoredRequestCountMetric</code>.</p>
|
|
1966
|
+
* <p>Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in <code>MonitoredRequestCountMetric</code>.</p>
|
|
2098
1967
|
* @public
|
|
2099
1968
|
*/
|
|
2100
1969
|
TotalRequestCountMetric?: MetricDataQuery[] | undefined;
|
|
2101
1970
|
/**
|
|
2102
|
-
* <p>Use this structure to define the metric that you want to use as the "good request" or "bad request"
|
|
2103
|
-
* value for a request-based SLO.
|
|
2104
|
-
* This value observed for the metric defined in
|
|
2105
|
-
* <code>TotalRequestCountMetric</code> will be divided by the number found for
|
|
2106
|
-
* <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that
|
|
2107
|
-
* this SLO tracks.</p>
|
|
1971
|
+
* <p>Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in <code>TotalRequestCountMetric</code> will be divided by the number found for <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that this SLO tracks.</p>
|
|
2108
1972
|
* @public
|
|
2109
1973
|
*/
|
|
2110
1974
|
MonitoredRequestCountMetric?: MonitoredRequestCountMetricDataQueries | undefined;
|
|
@@ -2130,8 +1994,7 @@ export interface RequestBasedServiceLevelIndicatorConfig {
|
|
|
2130
1994
|
*/
|
|
2131
1995
|
MetricThreshold?: number | undefined;
|
|
2132
1996
|
/**
|
|
2133
|
-
* <p>The arithmetic operation to use when comparing the specified metric to the
|
|
2134
|
-
* threshold. This parameter is required if this SLO is tracking the <code>Latency</code> metric.</p>
|
|
1997
|
+
* <p>The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the <code>Latency</code> metric.</p>
|
|
2135
1998
|
* @public
|
|
2136
1999
|
*/
|
|
2137
2000
|
ComparisonOperator?: ServiceLevelIndicatorComparisonOperator | undefined;
|
|
@@ -2142,37 +2005,7 @@ export interface RequestBasedServiceLevelIndicatorConfig {
|
|
|
2142
2005
|
*/
|
|
2143
2006
|
export interface ServiceLevelIndicatorMetricConfig {
|
|
2144
2007
|
/**
|
|
2145
|
-
* <p>If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service
|
|
2146
|
-
* the SLO metric is related to. To do so, you must specify at least the <code>Type</code>,
|
|
2147
|
-
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
2148
|
-
* <p>This is a string-to-string map. It can
|
|
2149
|
-
* include the following fields.</p>
|
|
2150
|
-
* <ul>
|
|
2151
|
-
* <li>
|
|
2152
|
-
* <p>
|
|
2153
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
2154
|
-
* </li>
|
|
2155
|
-
* <li>
|
|
2156
|
-
* <p>
|
|
2157
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
2158
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2159
|
-
* </li>
|
|
2160
|
-
* <li>
|
|
2161
|
-
* <p>
|
|
2162
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
2163
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
2164
|
-
* </li>
|
|
2165
|
-
* <li>
|
|
2166
|
-
* <p>
|
|
2167
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
2168
|
-
* This is used only if the value of the <code>Type</code> field
|
|
2169
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2170
|
-
* </li>
|
|
2171
|
-
* <li>
|
|
2172
|
-
* <p>
|
|
2173
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
2174
|
-
* </li>
|
|
2175
|
-
* </ul>
|
|
2008
|
+
* <p>If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
2176
2009
|
* @public
|
|
2177
2010
|
*/
|
|
2178
2011
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -2182,26 +2015,27 @@ export interface ServiceLevelIndicatorMetricConfig {
|
|
|
2182
2015
|
*/
|
|
2183
2016
|
OperationName?: string | undefined;
|
|
2184
2017
|
/**
|
|
2185
|
-
* <p>If the SLO is to monitor either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals
|
|
2186
|
-
* collects, use this field to specify which of those metrics is used.</p>
|
|
2018
|
+
* <p>If the SLO is to monitor either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals collects, use this field to specify which of those metrics is used.</p>
|
|
2187
2019
|
* @public
|
|
2188
2020
|
*/
|
|
2189
2021
|
MetricType?: ServiceLevelIndicatorMetricType | undefined;
|
|
2190
2022
|
/**
|
|
2191
|
-
* <p>The
|
|
2192
|
-
*
|
|
2023
|
+
* <p>The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.</p>
|
|
2024
|
+
* @public
|
|
2025
|
+
*/
|
|
2026
|
+
MetricName?: string | undefined;
|
|
2027
|
+
/**
|
|
2028
|
+
* <p>The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
|
|
2193
2029
|
* @public
|
|
2194
2030
|
*/
|
|
2195
2031
|
Statistic?: string | undefined;
|
|
2196
2032
|
/**
|
|
2197
|
-
* <p>The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the
|
|
2198
|
-
* SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.</p>
|
|
2033
|
+
* <p>The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.</p>
|
|
2199
2034
|
* @public
|
|
2200
2035
|
*/
|
|
2201
2036
|
PeriodSeconds?: number | undefined;
|
|
2202
2037
|
/**
|
|
2203
|
-
* <p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression,
|
|
2204
|
-
* use this structure to specify that metric or expression. </p>
|
|
2038
|
+
* <p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression. </p>
|
|
2205
2039
|
* @public
|
|
2206
2040
|
*/
|
|
2207
2041
|
MetricDataQueries?: MetricDataQuery[] | undefined;
|
|
@@ -2222,14 +2056,12 @@ export interface ServiceLevelIndicatorConfig {
|
|
|
2222
2056
|
*/
|
|
2223
2057
|
SliMetricConfig: ServiceLevelIndicatorMetricConfig | undefined;
|
|
2224
2058
|
/**
|
|
2225
|
-
* <p>This parameter is used only when a request-based SLO tracks the <code>Latency</code> metric. Specify the threshold value that the
|
|
2226
|
-
* observed <code>Latency</code> metric values are to be compared to.</p>
|
|
2059
|
+
* <p>This parameter is used only when a request-based SLO tracks the <code>Latency</code> metric. Specify the threshold value that the observed <code>Latency</code> metric values are to be compared to.</p>
|
|
2227
2060
|
* @public
|
|
2228
2061
|
*/
|
|
2229
2062
|
MetricThreshold: number | undefined;
|
|
2230
2063
|
/**
|
|
2231
|
-
* <p>The arithmetic operation to use when comparing the specified metric to the
|
|
2232
|
-
* threshold.</p>
|
|
2064
|
+
* <p>The arithmetic operation to use when comparing the specified metric to the threshold.</p>
|
|
2233
2065
|
* @public
|
|
2234
2066
|
*/
|
|
2235
2067
|
ComparisonOperator: ServiceLevelIndicatorComparisonOperator | undefined;
|
|
@@ -2249,14 +2081,12 @@ export interface CreateServiceLevelObjectiveInput {
|
|
|
2249
2081
|
*/
|
|
2250
2082
|
Description?: string | undefined;
|
|
2251
2083
|
/**
|
|
2252
|
-
* <p>If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
2253
|
-
* <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>
|
|
2084
|
+
* <p>If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p> <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>
|
|
2254
2085
|
* @public
|
|
2255
2086
|
*/
|
|
2256
2087
|
SliConfig?: ServiceLevelIndicatorConfig | undefined;
|
|
2257
2088
|
/**
|
|
2258
|
-
* <p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
2259
|
-
* <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>
|
|
2089
|
+
* <p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p> <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>
|
|
2260
2090
|
* @public
|
|
2261
2091
|
*/
|
|
2262
2092
|
RequestBasedSliConfig?: RequestBasedServiceLevelIndicatorConfig | undefined;
|
|
@@ -2266,18 +2096,12 @@ export interface CreateServiceLevelObjectiveInput {
|
|
|
2266
2096
|
*/
|
|
2267
2097
|
Goal?: Goal | undefined;
|
|
2268
2098
|
/**
|
|
2269
|
-
* <p>A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO.
|
|
2270
|
-
* To be able to associate tags with the SLO when you create the SLO, you must
|
|
2271
|
-
* have the <code>cloudwatch:TagResource</code> permission.</p>
|
|
2272
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
2273
|
-
* permissions by granting a user
|
|
2274
|
-
* permission to access or change only resources with certain tag values.</p>
|
|
2099
|
+
* <p>A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the <code>cloudwatch:TagResource</code> permission.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</p>
|
|
2275
2100
|
* @public
|
|
2276
2101
|
*/
|
|
2277
2102
|
Tags?: Tag[] | undefined;
|
|
2278
2103
|
/**
|
|
2279
|
-
* <p>Use this array to create <i>burn rates</i> for this SLO. Each
|
|
2280
|
-
* burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>
|
|
2104
|
+
* <p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>
|
|
2281
2105
|
* @public
|
|
2282
2106
|
*/
|
|
2283
2107
|
BurnRateConfigurations?: BurnRateConfiguration[] | undefined;
|
|
@@ -2296,12 +2120,7 @@ export declare const MetricSourceType: {
|
|
|
2296
2120
|
*/
|
|
2297
2121
|
export type MetricSourceType = (typeof MetricSourceType)[keyof typeof MetricSourceType];
|
|
2298
2122
|
/**
|
|
2299
|
-
* <p>A structure containing information about one service level objective (SLO) that has been created in Application Signals.
|
|
2300
|
-
* Creating SLOs can help you ensure your services are
|
|
2301
|
-
* performing to the level that you expect. SLOs help you set and track a specific target level for the
|
|
2302
|
-
* reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is
|
|
2303
|
-
* a key performance metric, to
|
|
2304
|
-
* calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.</p>
|
|
2123
|
+
* <p>A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.</p>
|
|
2305
2124
|
* @public
|
|
2306
2125
|
*/
|
|
2307
2126
|
export interface ServiceLevelObjective {
|
|
@@ -2321,16 +2140,12 @@ export interface ServiceLevelObjective {
|
|
|
2321
2140
|
*/
|
|
2322
2141
|
Description?: string | undefined;
|
|
2323
2142
|
/**
|
|
2324
|
-
* <p>The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as
|
|
2325
|
-
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
2326
|
-
* <code>2019-07-01T23:59:59</code>.</p>
|
|
2143
|
+
* <p>The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example, <code>2019-07-01T23:59:59</code>.</p>
|
|
2327
2144
|
* @public
|
|
2328
2145
|
*/
|
|
2329
2146
|
CreatedTime: Date | undefined;
|
|
2330
2147
|
/**
|
|
2331
|
-
* <p>The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as
|
|
2332
|
-
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
2333
|
-
* <code>2019-07-01T23:59:59</code>.</p>
|
|
2148
|
+
* <p>The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example, <code>2019-07-01T23:59:59</code>.</p>
|
|
2334
2149
|
* @public
|
|
2335
2150
|
*/
|
|
2336
2151
|
LastUpdatedTime: Date | undefined;
|
|
@@ -2350,30 +2165,17 @@ export interface ServiceLevelObjective {
|
|
|
2350
2165
|
*/
|
|
2351
2166
|
EvaluationType?: EvaluationType | undefined;
|
|
2352
2167
|
/**
|
|
2353
|
-
* <p>This structure contains the attributes that determine the goal of an SLO. This includes
|
|
2354
|
-
* the time period for evaluation and the attainment threshold.</p>
|
|
2168
|
+
* <p>This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.</p>
|
|
2355
2169
|
* @public
|
|
2356
2170
|
*/
|
|
2357
2171
|
Goal: Goal | undefined;
|
|
2358
2172
|
/**
|
|
2359
|
-
* <p>Each object in this array defines the length of the look-back window used to calculate one burn rate metric
|
|
2360
|
-
* for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>
|
|
2173
|
+
* <p>Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>
|
|
2361
2174
|
* @public
|
|
2362
2175
|
*/
|
|
2363
2176
|
BurnRateConfigurations?: BurnRateConfiguration[] | undefined;
|
|
2364
2177
|
/**
|
|
2365
|
-
* <p>Displays the SLI metric source type for this SLO. Supported types are:</p>
|
|
2366
|
-
* <ul>
|
|
2367
|
-
* <li>
|
|
2368
|
-
* <p>Service operation</p>
|
|
2369
|
-
* </li>
|
|
2370
|
-
* <li>
|
|
2371
|
-
* <p>Service dependency</p>
|
|
2372
|
-
* </li>
|
|
2373
|
-
* <li>
|
|
2374
|
-
* <p>CloudWatch metric</p>
|
|
2375
|
-
* </li>
|
|
2376
|
-
* </ul>
|
|
2178
|
+
* <p>Displays the SLI metric source type for this SLO. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>CloudWatch metric</p> </li> </ul>
|
|
2377
2179
|
* @public
|
|
2378
2180
|
*/
|
|
2379
2181
|
MetricSourceType?: MetricSourceType | undefined;
|
|
@@ -2421,9 +2223,7 @@ export interface DeleteServiceLevelObjectiveOutput {
|
|
|
2421
2223
|
*/
|
|
2422
2224
|
export interface GetServiceLevelObjectiveInput {
|
|
2423
2225
|
/**
|
|
2424
|
-
* <p>The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs
|
|
2425
|
-
* of SLOs by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListServiceLevelObjectives.html">ListServiceLevelObjectives</a>
|
|
2426
|
-
* operation.</p>
|
|
2226
|
+
* <p>The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListServiceLevelObjectives.html">ListServiceLevelObjectives</a> operation.</p>
|
|
2427
2227
|
* @public
|
|
2428
2228
|
*/
|
|
2429
2229
|
Id: string | undefined;
|
|
@@ -2443,35 +2243,7 @@ export interface GetServiceLevelObjectiveOutput {
|
|
|
2443
2243
|
*/
|
|
2444
2244
|
export interface ListServiceLevelObjectivesInput {
|
|
2445
2245
|
/**
|
|
2446
|
-
* <p>You can use this optional field to specify which services you want to retrieve SLO information for.</p>
|
|
2447
|
-
* <p>This is a string-to-string map. It can
|
|
2448
|
-
* include the following fields.</p>
|
|
2449
|
-
* <ul>
|
|
2450
|
-
* <li>
|
|
2451
|
-
* <p>
|
|
2452
|
-
* <code>Type</code> designates the type of object this is.</p>
|
|
2453
|
-
* </li>
|
|
2454
|
-
* <li>
|
|
2455
|
-
* <p>
|
|
2456
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
2457
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2458
|
-
* </li>
|
|
2459
|
-
* <li>
|
|
2460
|
-
* <p>
|
|
2461
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
2462
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
2463
|
-
* </li>
|
|
2464
|
-
* <li>
|
|
2465
|
-
* <p>
|
|
2466
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
2467
|
-
* This is used only if the value of the <code>Type</code> field
|
|
2468
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2469
|
-
* </li>
|
|
2470
|
-
* <li>
|
|
2471
|
-
* <p>
|
|
2472
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
2473
|
-
* </li>
|
|
2474
|
-
* </ul>
|
|
2246
|
+
* <p>You can use this optional field to specify which services you want to retrieve SLO information for.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
2475
2247
|
* @public
|
|
2476
2248
|
*/
|
|
2477
2249
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -2486,8 +2258,7 @@ export interface ListServiceLevelObjectivesInput {
|
|
|
2486
2258
|
*/
|
|
2487
2259
|
DependencyConfig?: DependencyConfig | undefined;
|
|
2488
2260
|
/**
|
|
2489
|
-
* <p>The maximum number of results to return in one operation. If you omit this
|
|
2490
|
-
* parameter, the default of 50 is used.</p>
|
|
2261
|
+
* <p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p>
|
|
2491
2262
|
* @public
|
|
2492
2263
|
*/
|
|
2493
2264
|
MaxResults?: number | undefined;
|
|
@@ -2497,28 +2268,7 @@ export interface ListServiceLevelObjectivesInput {
|
|
|
2497
2268
|
*/
|
|
2498
2269
|
NextToken?: string | undefined;
|
|
2499
2270
|
/**
|
|
2500
|
-
* <p>
|
|
2501
|
-
* <ul>
|
|
2502
|
-
* <li>
|
|
2503
|
-
* <p>Service operation</p>
|
|
2504
|
-
* </li>
|
|
2505
|
-
* <li>
|
|
2506
|
-
* <p>Service dependency</p>
|
|
2507
|
-
* </li>
|
|
2508
|
-
* <li>
|
|
2509
|
-
* <p>CloudWatch metric</p>
|
|
2510
|
-
* </li>
|
|
2511
|
-
* </ul>
|
|
2512
|
-
* @public
|
|
2513
|
-
*/
|
|
2514
|
-
MetricSourceTypes?: MetricSourceType[] | undefined;
|
|
2515
|
-
/**
|
|
2516
|
-
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include SLO from source accounts in the returned data.
|
|
2517
|
-
*
|
|
2518
|
-
* </p>
|
|
2519
|
-
* <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account.
|
|
2520
|
-
*
|
|
2521
|
-
* </p>
|
|
2271
|
+
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include SLO from source accounts in the returned data. </p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p>
|
|
2522
2272
|
* @public
|
|
2523
2273
|
*/
|
|
2524
2274
|
IncludeLinkedAccounts?: boolean | undefined;
|
|
@@ -2527,6 +2277,11 @@ export interface ListServiceLevelObjectivesInput {
|
|
|
2527
2277
|
* @public
|
|
2528
2278
|
*/
|
|
2529
2279
|
SloOwnerAwsAccountId?: string | undefined;
|
|
2280
|
+
/**
|
|
2281
|
+
* <p>Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>CloudWatch metric</p> </li> </ul>
|
|
2282
|
+
* @public
|
|
2283
|
+
*/
|
|
2284
|
+
MetricSourceTypes?: MetricSourceType[] | undefined;
|
|
2530
2285
|
}
|
|
2531
2286
|
/**
|
|
2532
2287
|
* <p>A structure that contains information about one service level objective (SLO) created in Application Signals.</p>
|
|
@@ -2544,40 +2299,12 @@ export interface ServiceLevelObjectiveSummary {
|
|
|
2544
2299
|
*/
|
|
2545
2300
|
Name: string | undefined;
|
|
2546
2301
|
/**
|
|
2547
|
-
* <p>This is a string-to-string map. It can
|
|
2548
|
-
* include the following fields.</p>
|
|
2549
|
-
* <ul>
|
|
2550
|
-
* <li>
|
|
2551
|
-
* <p>
|
|
2552
|
-
* <code>Type</code> designates the type of object this service level objective is for.</p>
|
|
2553
|
-
* </li>
|
|
2554
|
-
* <li>
|
|
2555
|
-
* <p>
|
|
2556
|
-
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
2557
|
-
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2558
|
-
* </li>
|
|
2559
|
-
* <li>
|
|
2560
|
-
* <p>
|
|
2561
|
-
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
2562
|
-
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
2563
|
-
* </li>
|
|
2564
|
-
* <li>
|
|
2565
|
-
* <p>
|
|
2566
|
-
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
2567
|
-
* This is used only if the value of the <code>Type</code> field
|
|
2568
|
-
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
2569
|
-
* </li>
|
|
2570
|
-
* <li>
|
|
2571
|
-
* <p>
|
|
2572
|
-
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
2573
|
-
* </li>
|
|
2574
|
-
* </ul>
|
|
2302
|
+
* <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this service level objective is for.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>
|
|
2575
2303
|
* @public
|
|
2576
2304
|
*/
|
|
2577
2305
|
KeyAttributes?: Record<string, string> | undefined;
|
|
2578
2306
|
/**
|
|
2579
|
-
* <p>If this service level objective is specific to a single operation, this
|
|
2580
|
-
* field displays the name of that operation.</p>
|
|
2307
|
+
* <p>If this service level objective is specific to a single operation, this field displays the name of that operation.</p>
|
|
2581
2308
|
* @public
|
|
2582
2309
|
*/
|
|
2583
2310
|
OperationName?: string | undefined;
|
|
@@ -2597,18 +2324,7 @@ export interface ServiceLevelObjectiveSummary {
|
|
|
2597
2324
|
*/
|
|
2598
2325
|
EvaluationType?: EvaluationType | undefined;
|
|
2599
2326
|
/**
|
|
2600
|
-
* <p>Displays the SLI metric source type for this SLO. Supported types are:</p>
|
|
2601
|
-
* <ul>
|
|
2602
|
-
* <li>
|
|
2603
|
-
* <p>Service operation</p>
|
|
2604
|
-
* </li>
|
|
2605
|
-
* <li>
|
|
2606
|
-
* <p>Service dependency</p>
|
|
2607
|
-
* </li>
|
|
2608
|
-
* <li>
|
|
2609
|
-
* <p>CloudWatch metric</p>
|
|
2610
|
-
* </li>
|
|
2611
|
-
* </ul>
|
|
2327
|
+
* <p>Displays the SLI metric source type for this SLO. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>CloudWatch metric</p> </li> </ul>
|
|
2612
2328
|
* @public
|
|
2613
2329
|
*/
|
|
2614
2330
|
MetricSourceType?: MetricSourceType | undefined;
|
|
@@ -2623,8 +2339,7 @@ export interface ListServiceLevelObjectivesOutput {
|
|
|
2623
2339
|
*/
|
|
2624
2340
|
SloSummaries?: ServiceLevelObjectiveSummary[] | undefined;
|
|
2625
2341
|
/**
|
|
2626
|
-
* <p>Include this value in your next use of this API to get next set
|
|
2627
|
-
* of service level objectives.</p>
|
|
2342
|
+
* <p>Include this value in your next use of this API to get next set of service level objectives.</p>
|
|
2628
2343
|
* @public
|
|
2629
2344
|
*/
|
|
2630
2345
|
NextToken?: string | undefined;
|
|
@@ -2649,20 +2364,17 @@ export interface UpdateServiceLevelObjectiveInput {
|
|
|
2649
2364
|
*/
|
|
2650
2365
|
SliConfig?: ServiceLevelIndicatorConfig | undefined;
|
|
2651
2366
|
/**
|
|
2652
|
-
* <p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
2653
|
-
* <p>You can't specify both <code>SliConfig</code> and <code>RequestBasedSliConfig</code> in the same operation.</p>
|
|
2367
|
+
* <p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p> <p>You can't specify both <code>SliConfig</code> and <code>RequestBasedSliConfig</code> in the same operation.</p>
|
|
2654
2368
|
* @public
|
|
2655
2369
|
*/
|
|
2656
2370
|
RequestBasedSliConfig?: RequestBasedServiceLevelIndicatorConfig | undefined;
|
|
2657
2371
|
/**
|
|
2658
|
-
* <p>A structure that contains the attributes that determine the goal of the SLO. This includes
|
|
2659
|
-
* the time period for evaluation and the attainment threshold.</p>
|
|
2372
|
+
* <p>A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.</p>
|
|
2660
2373
|
* @public
|
|
2661
2374
|
*/
|
|
2662
2375
|
Goal?: Goal | undefined;
|
|
2663
2376
|
/**
|
|
2664
|
-
* <p>Use this array to create <i>burn rates</i> for this SLO. Each
|
|
2665
|
-
* burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>
|
|
2377
|
+
* <p>Use this array to create <i>burn rates</i> for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>
|
|
2666
2378
|
* @public
|
|
2667
2379
|
*/
|
|
2668
2380
|
BurnRateConfigurations?: BurnRateConfiguration[] | undefined;
|
|
@@ -2692,14 +2404,7 @@ export interface StartDiscoveryOutput {
|
|
|
2692
2404
|
*/
|
|
2693
2405
|
export interface TagResourceRequest {
|
|
2694
2406
|
/**
|
|
2695
|
-
* <p>The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.</p>
|
|
2696
|
-
* <p>The ARN format of an Application Signals SLO is
|
|
2697
|
-
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:slo:<i>slo-name</i>
|
|
2698
|
-
* </code>
|
|
2699
|
-
* </p>
|
|
2700
|
-
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
|
|
2701
|
-
* Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
|
|
2702
|
-
* Reference</i>.</p>
|
|
2407
|
+
* <p>The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.</p> <p>The ARN format of an Application Signals SLO is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:slo:<i>slo-name</i> </code> </p> <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
2703
2408
|
* @public
|
|
2704
2409
|
*/
|
|
2705
2410
|
ResourceArn: string | undefined;
|
|
@@ -2719,14 +2424,7 @@ export interface TagResourceResponse {
|
|
|
2719
2424
|
*/
|
|
2720
2425
|
export interface UntagResourceRequest {
|
|
2721
2426
|
/**
|
|
2722
|
-
* <p>The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.</p>
|
|
2723
|
-
* <p>The ARN format of an Application Signals SLO is
|
|
2724
|
-
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:slo:<i>slo-name</i>
|
|
2725
|
-
* </code>
|
|
2726
|
-
* </p>
|
|
2727
|
-
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
|
|
2728
|
-
* Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
|
|
2729
|
-
* Reference</i>.</p>
|
|
2427
|
+
* <p>The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.</p> <p>The ARN format of an Application Signals SLO is <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:slo:<i>slo-name</i> </code> </p> <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
2730
2428
|
* @public
|
|
2731
2429
|
*/
|
|
2732
2430
|
ResourceArn: string | undefined;
|