@aws-sdk/client-application-signals 3.637.0 → 3.646.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/dist-cjs/models/models_0.js +21 -5
- package/dist-cjs/protocols/Aws_restJson1.js +22 -0
- package/dist-es/models/models_0.js +20 -4
- package/dist-es/protocols/Aws_restJson1.js +22 -0
- package/dist-types/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.d.ts +94 -3
- package/dist-types/commands/CreateServiceLevelObjectiveCommand.d.ts +221 -19
- package/dist-types/commands/GetServiceLevelObjectiveCommand.d.ts +91 -2
- package/dist-types/commands/UpdateServiceLevelObjectiveCommand.d.ts +183 -4
- package/dist-types/models/models_0.d.ts +331 -27
- package/dist-types/ts3.4/models/models_0.d.ts +82 -8
- package/package.json +6 -6
|
@@ -70,12 +70,26 @@ export declare const ServiceLevelObjectiveBudgetStatus: {
|
|
|
70
70
|
* @public
|
|
71
71
|
*/
|
|
72
72
|
export type ServiceLevelObjectiveBudgetStatus = (typeof ServiceLevelObjectiveBudgetStatus)[keyof typeof ServiceLevelObjectiveBudgetStatus];
|
|
73
|
+
/**
|
|
74
|
+
* @public
|
|
75
|
+
* @enum
|
|
76
|
+
*/
|
|
77
|
+
export declare const EvaluationType: {
|
|
78
|
+
readonly PERIOD_BASED: "PeriodBased";
|
|
79
|
+
readonly REQUEST_BASED: "RequestBased";
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export type EvaluationType = (typeof EvaluationType)[keyof typeof EvaluationType];
|
|
73
85
|
/**
|
|
74
86
|
* @public
|
|
75
87
|
* @enum
|
|
76
88
|
*/
|
|
77
89
|
export declare const DurationUnit: {
|
|
78
90
|
readonly DAY: "DAY";
|
|
91
|
+
readonly HOUR: "HOUR";
|
|
92
|
+
readonly MINUTE: "MINUTE";
|
|
79
93
|
readonly MONTH: "MONTH";
|
|
80
94
|
};
|
|
81
95
|
/**
|
|
@@ -182,10 +196,13 @@ export interface Goal {
|
|
|
182
196
|
*/
|
|
183
197
|
Interval?: Interval;
|
|
184
198
|
/**
|
|
185
|
-
* <p>The threshold that determines if the goal is being met
|
|
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.
|
|
187
202
|
* For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the
|
|
188
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>
|
|
189
206
|
* <p>If you omit this parameter, 99 is used
|
|
190
207
|
* to represent 99% as the attainment goal.</p>
|
|
191
208
|
* @public
|
|
@@ -212,6 +229,18 @@ export declare const ServiceLevelIndicatorComparisonOperator: {
|
|
|
212
229
|
* @public
|
|
213
230
|
*/
|
|
214
231
|
export type ServiceLevelIndicatorComparisonOperator = (typeof ServiceLevelIndicatorComparisonOperator)[keyof typeof ServiceLevelIndicatorComparisonOperator];
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
* @enum
|
|
235
|
+
*/
|
|
236
|
+
export declare const ServiceLevelIndicatorMetricType: {
|
|
237
|
+
readonly AVAILABILITY: "AVAILABILITY";
|
|
238
|
+
readonly LATENCY: "LATENCY";
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export type ServiceLevelIndicatorMetricType = (typeof ServiceLevelIndicatorMetricType)[keyof typeof ServiceLevelIndicatorMetricType];
|
|
215
244
|
/**
|
|
216
245
|
* <p>A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique
|
|
217
246
|
* identifier for a metric, whenever you add a unique name/value pair to one of
|
|
@@ -414,26 +443,153 @@ export interface MetricDataQuery {
|
|
|
414
443
|
*/
|
|
415
444
|
Period?: number;
|
|
416
445
|
/**
|
|
417
|
-
* <p>The ID of the account where this metric is located. If you are performing this
|
|
446
|
+
* <p>The ID of the account where this metric is located. If you are performing this operation in a monitoring account,
|
|
418
447
|
* use this to specify which source account to retrieve this metric from.</p>
|
|
419
448
|
* @public
|
|
420
449
|
*/
|
|
421
450
|
AccountId?: string;
|
|
422
451
|
}
|
|
423
452
|
/**
|
|
453
|
+
* <p>This structure defines the metric that is used as the "good request" or "bad request"
|
|
454
|
+
* value for a request-based SLO.
|
|
455
|
+
* This value observed for the metric defined in
|
|
456
|
+
* <code>TotalRequestCountMetric</code> is divided by the number found for
|
|
457
|
+
* <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that
|
|
458
|
+
* this SLO tracks.</p>
|
|
424
459
|
* @public
|
|
425
|
-
* @enum
|
|
426
460
|
*/
|
|
427
|
-
export
|
|
428
|
-
readonly AVAILABILITY: "AVAILABILITY";
|
|
429
|
-
readonly LATENCY: "LATENCY";
|
|
430
|
-
};
|
|
461
|
+
export type MonitoredRequestCountMetricDataQueries = MonitoredRequestCountMetricDataQueries.BadCountMetricMember | MonitoredRequestCountMetricDataQueries.GoodCountMetricMember | MonitoredRequestCountMetricDataQueries.$UnknownMember;
|
|
431
462
|
/**
|
|
432
463
|
* @public
|
|
433
464
|
*/
|
|
434
|
-
export
|
|
465
|
+
export declare namespace MonitoredRequestCountMetricDataQueries {
|
|
466
|
+
/**
|
|
467
|
+
* <p>If you want to count "good requests" to determine the percentage of successful requests for this
|
|
468
|
+
* request-based SLO, specify the metric to use as "good requests" in this structure.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
interface GoodCountMetricMember {
|
|
472
|
+
GoodCountMetric: MetricDataQuery[];
|
|
473
|
+
BadCountMetric?: never;
|
|
474
|
+
$unknown?: never;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* <p>If you want to count "bad requests" to determine the percentage of successful requests for this
|
|
478
|
+
* request-based SLO, specify the metric to use as "bad requests" in this structure.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
interface BadCountMetricMember {
|
|
482
|
+
GoodCountMetric?: never;
|
|
483
|
+
BadCountMetric: MetricDataQuery[];
|
|
484
|
+
$unknown?: never;
|
|
485
|
+
}
|
|
486
|
+
/**
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
interface $UnknownMember {
|
|
490
|
+
GoodCountMetric?: never;
|
|
491
|
+
BadCountMetric?: never;
|
|
492
|
+
$unknown: [string, any];
|
|
493
|
+
}
|
|
494
|
+
interface Visitor<T> {
|
|
495
|
+
GoodCountMetric: (value: MetricDataQuery[]) => T;
|
|
496
|
+
BadCountMetric: (value: MetricDataQuery[]) => T;
|
|
497
|
+
_: (name: string, value: any) => T;
|
|
498
|
+
}
|
|
499
|
+
const visit: <T>(value: MonitoredRequestCountMetricDataQueries, visitor: Visitor<T>) => T;
|
|
500
|
+
}
|
|
435
501
|
/**
|
|
436
|
-
* <p>This structure contains the information about the metric that is used for
|
|
502
|
+
* <p>This structure contains the information about the metric that is used for a request-based SLO.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
export interface RequestBasedServiceLevelIndicatorMetric {
|
|
506
|
+
/**
|
|
507
|
+
* <p>This is a string-to-string map that contains information about the type of object that this SLO is related to. It can
|
|
508
|
+
* include the following fields.</p>
|
|
509
|
+
* <ul>
|
|
510
|
+
* <li>
|
|
511
|
+
* <p>
|
|
512
|
+
* <code>Type</code> designates the type of object that this SLO is related to.</p>
|
|
513
|
+
* </li>
|
|
514
|
+
* <li>
|
|
515
|
+
* <p>
|
|
516
|
+
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
517
|
+
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
518
|
+
* </li>
|
|
519
|
+
* <li>
|
|
520
|
+
* <p>
|
|
521
|
+
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
522
|
+
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
523
|
+
* </li>
|
|
524
|
+
* <li>
|
|
525
|
+
* <p>
|
|
526
|
+
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
527
|
+
* This is used only if the value of the <code>Type</code> field
|
|
528
|
+
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
529
|
+
* </li>
|
|
530
|
+
* <li>
|
|
531
|
+
* <p>
|
|
532
|
+
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
533
|
+
* </li>
|
|
534
|
+
* </ul>
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
KeyAttributes?: Record<string, string>;
|
|
538
|
+
/**
|
|
539
|
+
* <p>If the SLO monitors a specific operation of the service, this field displays that operation name.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
OperationName?: string;
|
|
543
|
+
/**
|
|
544
|
+
* <p>If the SLO monitors either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals
|
|
545
|
+
* collects, this field displays which of those metrics is used.</p>
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
MetricType?: ServiceLevelIndicatorMetricType;
|
|
549
|
+
/**
|
|
550
|
+
* <p>This structure defines the metric that is used as the "total requests" number for a request-based SLO.
|
|
551
|
+
* The number observed for this metric is divided by the number of "good requests" or "bad requests" that is
|
|
552
|
+
* observed for the metric defined in
|
|
553
|
+
* <code>MonitoredRequestCountMetric</code>.</p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
TotalRequestCountMetric: MetricDataQuery[] | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>This structure defines the metric that is used as the "good request" or "bad request"
|
|
559
|
+
* value for a request-based SLO.
|
|
560
|
+
* This value observed for the metric defined in
|
|
561
|
+
* <code>TotalRequestCountMetric</code> is divided by the number found for
|
|
562
|
+
* <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that
|
|
563
|
+
* this SLO tracks.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
MonitoredRequestCountMetric: MonitoredRequestCountMetricDataQueries | undefined;
|
|
567
|
+
}
|
|
568
|
+
/**
|
|
569
|
+
* <p>This structure contains information about the performance metric that a request-based SLO monitors.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
export interface RequestBasedServiceLevelIndicator {
|
|
573
|
+
/**
|
|
574
|
+
* <p>A structure that contains information about the metric that the SLO monitors. </p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
RequestBasedSliMetric: RequestBasedServiceLevelIndicatorMetric | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* <p>This value is the threshold that
|
|
580
|
+
* the observed metric values of the SLI metric are compared to.</p>
|
|
581
|
+
* @public
|
|
582
|
+
*/
|
|
583
|
+
MetricThreshold?: number;
|
|
584
|
+
/**
|
|
585
|
+
* <p>The arithmetic operation used when comparing the specified metric to the
|
|
586
|
+
* threshold.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
ComparisonOperator?: ServiceLevelIndicatorComparisonOperator;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* <p>This structure contains the information about the metric that is used for a period-based SLO.</p>
|
|
437
593
|
* @public
|
|
438
594
|
*/
|
|
439
595
|
export interface ServiceLevelIndicatorMetric {
|
|
@@ -488,7 +644,7 @@ export interface ServiceLevelIndicatorMetric {
|
|
|
488
644
|
MetricDataQueries: MetricDataQuery[] | undefined;
|
|
489
645
|
}
|
|
490
646
|
/**
|
|
491
|
-
* <p>This structure contains information about the performance metric that
|
|
647
|
+
* <p>This structure contains information about the performance metric that a period-based SLO monitors.</p>
|
|
492
648
|
* @public
|
|
493
649
|
*/
|
|
494
650
|
export interface ServiceLevelIndicator {
|
|
@@ -524,6 +680,11 @@ export interface ServiceLevelObjectiveBudgetReport {
|
|
|
524
680
|
* @public
|
|
525
681
|
*/
|
|
526
682
|
Name: string | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* <p>Displays whether this budget report is for a period-based SLO or a request-based SLO.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
EvaluationType?: EvaluationType;
|
|
527
688
|
/**
|
|
528
689
|
* <p>The status of this SLO, as it relates to the error budget for the entire time interval.</p>
|
|
529
690
|
* <ul>
|
|
@@ -544,7 +705,7 @@ export interface ServiceLevelObjectiveBudgetReport {
|
|
|
544
705
|
* </li>
|
|
545
706
|
* <li>
|
|
546
707
|
* <p>
|
|
547
|
-
* <code>INSUFFICIENT_DATA</code> means that the
|
|
708
|
+
* <code>INSUFFICIENT_DATA</code> means that the specified start and end times were before the
|
|
548
709
|
* SLO was created, or that attainment data is missing.</p>
|
|
549
710
|
* </li>
|
|
550
711
|
* </ul>
|
|
@@ -552,13 +713,18 @@ export interface ServiceLevelObjectiveBudgetReport {
|
|
|
552
713
|
*/
|
|
553
714
|
BudgetStatus: ServiceLevelObjectiveBudgetStatus | undefined;
|
|
554
715
|
/**
|
|
555
|
-
* <p>A number between 0 and 100 that represents the percentage of
|
|
716
|
+
* <p>A number between 0 and 100 that represents the success percentage of your application compared
|
|
717
|
+
* to the goal set by the SLO.</p>
|
|
718
|
+
* <p>If this is a period-based SLO, the number is the percentage of time periods that the service has
|
|
556
719
|
* attained the SLO's attainment goal, as of the time of the request.</p>
|
|
720
|
+
* <p>If this is a request-based SLO, the number is the number of successful requests divided
|
|
721
|
+
* by the number of total requests, multiplied by 100, during the time range that you specified in your request.</p>
|
|
557
722
|
* @public
|
|
558
723
|
*/
|
|
559
724
|
Attainment?: number;
|
|
560
725
|
/**
|
|
561
|
-
* <p>The total number of seconds in the error budget for the interval
|
|
726
|
+
* <p>The total number of seconds in the error budget for the interval. This field is included only
|
|
727
|
+
* if the SLO is a period-based SLO.</p>
|
|
562
728
|
* @public
|
|
563
729
|
*/
|
|
564
730
|
TotalBudgetSeconds?: number;
|
|
@@ -567,14 +733,38 @@ export interface ServiceLevelObjectiveBudgetReport {
|
|
|
567
733
|
* the
|
|
568
734
|
* <code>Timestemp</code> parameter of the request. If this value is negative, then the SLO is already in <code>BREACHING</code>
|
|
569
735
|
* status.</p>
|
|
736
|
+
* <p> This field is included only
|
|
737
|
+
* if the SLO is a period-based SLO.</p>
|
|
570
738
|
* @public
|
|
571
739
|
*/
|
|
572
740
|
BudgetSecondsRemaining?: number;
|
|
741
|
+
/**
|
|
742
|
+
* <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
|
|
743
|
+
* interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred,
|
|
744
|
+
* and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then
|
|
745
|
+
* this SLO is currently breaching.</p>
|
|
746
|
+
* <p>This number can go up and down between reports with different time stamps, based on both how many total requests occur.</p>
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
TotalBudgetRequests?: number;
|
|
750
|
+
/**
|
|
751
|
+
* <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,
|
|
752
|
+
* and still have the application meet its SLO goal.</p>
|
|
753
|
+
* <p>This number can go up and down between different reports, based on both how many successful requests and how many failed
|
|
754
|
+
* requests occur in that time.</p>
|
|
755
|
+
* @public
|
|
756
|
+
*/
|
|
757
|
+
BudgetRequestsRemaining?: number;
|
|
573
758
|
/**
|
|
574
759
|
* <p>A structure that contains information about the performance metric that this SLO monitors.</p>
|
|
575
760
|
* @public
|
|
576
761
|
*/
|
|
577
762
|
Sli?: ServiceLevelIndicator;
|
|
763
|
+
/**
|
|
764
|
+
* <p>This structure contains information about the performance metric that a request-based SLO monitors.</p>
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
RequestBasedSli?: RequestBasedServiceLevelIndicator;
|
|
578
768
|
/**
|
|
579
769
|
* <p>This structure contains the attributes that determine the goal of an SLO. This includes
|
|
580
770
|
* the time period for evaluation and the attainment threshold.</p>
|
|
@@ -796,7 +986,7 @@ export interface Service {
|
|
|
796
986
|
* <code>Host</code> is the name of the host, for all platform types.</p>
|
|
797
987
|
* </li>
|
|
798
988
|
* </ul>
|
|
799
|
-
* <p>
|
|
989
|
+
* <p>Application attributes contain information about the application.</p>
|
|
800
990
|
* <ul>
|
|
801
991
|
* <li>
|
|
802
992
|
* <p>
|
|
@@ -1378,7 +1568,7 @@ export interface ListServicesInput {
|
|
|
1378
1568
|
}
|
|
1379
1569
|
/**
|
|
1380
1570
|
* <p>This structure contains information about one of your services that
|
|
1381
|
-
* was
|
|
1571
|
+
* was discovered by Application Signals</p>
|
|
1382
1572
|
* @public
|
|
1383
1573
|
*/
|
|
1384
1574
|
export interface ServiceSummary {
|
|
@@ -1459,7 +1649,7 @@ export interface ServiceSummary {
|
|
|
1459
1649
|
* <code>Host</code> is the name of the host, for all platform types.</p>
|
|
1460
1650
|
* </li>
|
|
1461
1651
|
* </ul>
|
|
1462
|
-
* <p>
|
|
1652
|
+
* <p>Application attributes contain information about the application.</p>
|
|
1463
1653
|
* <ul>
|
|
1464
1654
|
* <li>
|
|
1465
1655
|
* <p>
|
|
@@ -1611,7 +1801,98 @@ export declare class ConflictException extends __BaseException {
|
|
|
1611
1801
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
1612
1802
|
}
|
|
1613
1803
|
/**
|
|
1614
|
-
* <p>Use this structure to specify the information for the metric that
|
|
1804
|
+
* <p>Use this structure to specify the information for the metric that a period-based SLO will monitor.</p>
|
|
1805
|
+
* @public
|
|
1806
|
+
*/
|
|
1807
|
+
export interface RequestBasedServiceLevelIndicatorMetricConfig {
|
|
1808
|
+
/**
|
|
1809
|
+
* <p>If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service
|
|
1810
|
+
* the SLO metric is related to. To do so, you must specify at least the <code>Type</code>,
|
|
1811
|
+
* <code>Name</code>, and <code>Environment</code> attributes.</p>
|
|
1812
|
+
* <p>This is a string-to-string map. It can
|
|
1813
|
+
* include the following fields.</p>
|
|
1814
|
+
* <ul>
|
|
1815
|
+
* <li>
|
|
1816
|
+
* <p>
|
|
1817
|
+
* <code>Type</code> designates the type of object this is.</p>
|
|
1818
|
+
* </li>
|
|
1819
|
+
* <li>
|
|
1820
|
+
* <p>
|
|
1821
|
+
* <code>ResourceType</code> specifies the type of the resource. This field is used only
|
|
1822
|
+
* when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1823
|
+
* </li>
|
|
1824
|
+
* <li>
|
|
1825
|
+
* <p>
|
|
1826
|
+
* <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field
|
|
1827
|
+
* is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p>
|
|
1828
|
+
* </li>
|
|
1829
|
+
* <li>
|
|
1830
|
+
* <p>
|
|
1831
|
+
* <code>Identifier</code> identifies the resource objects of this resource.
|
|
1832
|
+
* This is used only if the value of the <code>Type</code> field
|
|
1833
|
+
* is <code>Resource</code> or <code>AWS::Resource</code>.</p>
|
|
1834
|
+
* </li>
|
|
1835
|
+
* <li>
|
|
1836
|
+
* <p>
|
|
1837
|
+
* <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p>
|
|
1838
|
+
* </li>
|
|
1839
|
+
* </ul>
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
KeyAttributes?: Record<string, string>;
|
|
1843
|
+
/**
|
|
1844
|
+
* <p>If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.</p>
|
|
1845
|
+
* @public
|
|
1846
|
+
*/
|
|
1847
|
+
OperationName?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* <p>If the SLO is to monitor either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals
|
|
1850
|
+
* collects, use this field to specify which of those metrics is used.</p>
|
|
1851
|
+
* @public
|
|
1852
|
+
*/
|
|
1853
|
+
MetricType?: ServiceLevelIndicatorMetricType;
|
|
1854
|
+
/**
|
|
1855
|
+
* <p>Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO.
|
|
1856
|
+
* This result will be divided by the "good request" or "bad request" value defined in
|
|
1857
|
+
* <code>MonitoredRequestCountMetric</code>.</p>
|
|
1858
|
+
* @public
|
|
1859
|
+
*/
|
|
1860
|
+
TotalRequestCountMetric?: MetricDataQuery[];
|
|
1861
|
+
/**
|
|
1862
|
+
* <p>Use this structure to define the metric that you want to use as the "good request" or "bad request"
|
|
1863
|
+
* value for a request-based SLO.
|
|
1864
|
+
* This value observed for the metric defined in
|
|
1865
|
+
* <code>TotalRequestCountMetric</code> will be divided by the number found for
|
|
1866
|
+
* <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that
|
|
1867
|
+
* this SLO tracks.</p>
|
|
1868
|
+
* @public
|
|
1869
|
+
*/
|
|
1870
|
+
MonitoredRequestCountMetric?: MonitoredRequestCountMetricDataQueries;
|
|
1871
|
+
}
|
|
1872
|
+
/**
|
|
1873
|
+
* <p>This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor.</p>
|
|
1874
|
+
* @public
|
|
1875
|
+
*/
|
|
1876
|
+
export interface RequestBasedServiceLevelIndicatorConfig {
|
|
1877
|
+
/**
|
|
1878
|
+
* <p>Use this structure to specify the metric to be used for the SLO.</p>
|
|
1879
|
+
* @public
|
|
1880
|
+
*/
|
|
1881
|
+
RequestBasedSliMetricConfig: RequestBasedServiceLevelIndicatorMetricConfig | undefined;
|
|
1882
|
+
/**
|
|
1883
|
+
* <p>The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the <code>Latency</code> metric.</p>
|
|
1884
|
+
* @public
|
|
1885
|
+
*/
|
|
1886
|
+
MetricThreshold?: number;
|
|
1887
|
+
/**
|
|
1888
|
+
* <p>The arithmetic operation to use when comparing the specified metric to the
|
|
1889
|
+
* threshold. This parameter is required if this SLO is tracking the <code>Latency</code> metric.</p>
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
ComparisonOperator?: ServiceLevelIndicatorComparisonOperator;
|
|
1893
|
+
}
|
|
1894
|
+
/**
|
|
1895
|
+
* <p>Use this structure to specify the information for the metric that a period-based SLO will monitor.</p>
|
|
1615
1896
|
* @public
|
|
1616
1897
|
*/
|
|
1617
1898
|
export interface ServiceLevelIndicatorMetricConfig {
|
|
@@ -1681,7 +1962,7 @@ export interface ServiceLevelIndicatorMetricConfig {
|
|
|
1681
1962
|
MetricDataQueries?: MetricDataQuery[];
|
|
1682
1963
|
}
|
|
1683
1964
|
/**
|
|
1684
|
-
* <p>This structure specifies the information about the service and the performance metric that
|
|
1965
|
+
* <p>This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor.</p>
|
|
1685
1966
|
* @public
|
|
1686
1967
|
*/
|
|
1687
1968
|
export interface ServiceLevelIndicatorConfig {
|
|
@@ -1691,7 +1972,8 @@ export interface ServiceLevelIndicatorConfig {
|
|
|
1691
1972
|
*/
|
|
1692
1973
|
SliMetricConfig: ServiceLevelIndicatorMetricConfig | undefined;
|
|
1693
1974
|
/**
|
|
1694
|
-
* <p>
|
|
1975
|
+
* <p>This parameter is used only when a request-based SLO tracks the <code>Latency</code> metric. Specify the threshold value that the
|
|
1976
|
+
* observed <code>Latency</code> metric values are to be compared to.</p>
|
|
1695
1977
|
* @public
|
|
1696
1978
|
*/
|
|
1697
1979
|
MetricThreshold: number | undefined;
|
|
@@ -1717,13 +1999,19 @@ export interface CreateServiceLevelObjectiveInput {
|
|
|
1717
1999
|
*/
|
|
1718
2000
|
Description?: string;
|
|
1719
2001
|
/**
|
|
1720
|
-
* <p>
|
|
2002
|
+
* <p>If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
2003
|
+
* <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>
|
|
1721
2004
|
* @public
|
|
1722
2005
|
*/
|
|
1723
|
-
SliConfig
|
|
2006
|
+
SliConfig?: ServiceLevelIndicatorConfig;
|
|
1724
2007
|
/**
|
|
1725
|
-
* <p>
|
|
1726
|
-
*
|
|
2008
|
+
* <p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
2009
|
+
* <p>You can't specify both <code>RequestBasedSliConfig</code> and <code>SliConfig</code> in the same operation.</p>
|
|
2010
|
+
* @public
|
|
2011
|
+
*/
|
|
2012
|
+
RequestBasedSliConfig?: RequestBasedServiceLevelIndicatorConfig;
|
|
2013
|
+
/**
|
|
2014
|
+
* <p>This structure contains the attributes that determine the goal of the SLO.</p>
|
|
1727
2015
|
* @public
|
|
1728
2016
|
*/
|
|
1729
2017
|
Goal?: Goal;
|
|
@@ -1778,10 +2066,20 @@ export interface ServiceLevelObjective {
|
|
|
1778
2066
|
*/
|
|
1779
2067
|
LastUpdatedTime: Date | undefined;
|
|
1780
2068
|
/**
|
|
1781
|
-
* <p>A structure containing information about the performance metric that this SLO monitors.</p>
|
|
2069
|
+
* <p>A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.</p>
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
Sli?: ServiceLevelIndicator;
|
|
2073
|
+
/**
|
|
2074
|
+
* <p>A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.</p>
|
|
1782
2075
|
* @public
|
|
1783
2076
|
*/
|
|
1784
|
-
|
|
2077
|
+
RequestBasedSli?: RequestBasedServiceLevelIndicator;
|
|
2078
|
+
/**
|
|
2079
|
+
* <p>Displays whether this is a period-based SLO or a request-based SLO.</p>
|
|
2080
|
+
* @public
|
|
2081
|
+
*/
|
|
2082
|
+
EvaluationType?: EvaluationType;
|
|
1785
2083
|
/**
|
|
1786
2084
|
* <p>This structure contains the attributes that determine the goal of an SLO. This includes
|
|
1787
2085
|
* the time period for evaluation and the attainment threshold.</p>
|
|
@@ -1993,10 +2291,16 @@ export interface UpdateServiceLevelObjectiveInput {
|
|
|
1993
2291
|
*/
|
|
1994
2292
|
Description?: string;
|
|
1995
2293
|
/**
|
|
1996
|
-
* <p>
|
|
2294
|
+
* <p>If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
1997
2295
|
* @public
|
|
1998
2296
|
*/
|
|
1999
2297
|
SliConfig?: ServiceLevelIndicatorConfig;
|
|
2298
|
+
/**
|
|
2299
|
+
* <p>If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.</p>
|
|
2300
|
+
* <p>You can't specify both <code>SliConfig</code> and <code>RequestBasedSliConfig</code> in the same operation.</p>
|
|
2301
|
+
* @public
|
|
2302
|
+
*/
|
|
2303
|
+
RequestBasedSliConfig?: RequestBasedServiceLevelIndicatorConfig;
|
|
2000
2304
|
/**
|
|
2001
2305
|
* <p>A structure that contains the attributes that determine the goal of the SLO. This includes
|
|
2002
2306
|
* the time period for evaluation and the attainment threshold.</p>
|
|
@@ -26,8 +26,16 @@ export declare const ServiceLevelObjectiveBudgetStatus: {
|
|
|
26
26
|
};
|
|
27
27
|
export type ServiceLevelObjectiveBudgetStatus =
|
|
28
28
|
(typeof ServiceLevelObjectiveBudgetStatus)[keyof typeof ServiceLevelObjectiveBudgetStatus];
|
|
29
|
+
export declare const EvaluationType: {
|
|
30
|
+
readonly PERIOD_BASED: "PeriodBased";
|
|
31
|
+
readonly REQUEST_BASED: "RequestBased";
|
|
32
|
+
};
|
|
33
|
+
export type EvaluationType =
|
|
34
|
+
(typeof EvaluationType)[keyof typeof EvaluationType];
|
|
29
35
|
export declare const DurationUnit: {
|
|
30
36
|
readonly DAY: "DAY";
|
|
37
|
+
readonly HOUR: "HOUR";
|
|
38
|
+
readonly MINUTE: "MINUTE";
|
|
31
39
|
readonly MONTH: "MONTH";
|
|
32
40
|
};
|
|
33
41
|
export type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
|
|
@@ -80,6 +88,12 @@ export declare const ServiceLevelIndicatorComparisonOperator: {
|
|
|
80
88
|
};
|
|
81
89
|
export type ServiceLevelIndicatorComparisonOperator =
|
|
82
90
|
(typeof ServiceLevelIndicatorComparisonOperator)[keyof typeof ServiceLevelIndicatorComparisonOperator];
|
|
91
|
+
export declare const ServiceLevelIndicatorMetricType: {
|
|
92
|
+
readonly AVAILABILITY: "AVAILABILITY";
|
|
93
|
+
readonly LATENCY: "LATENCY";
|
|
94
|
+
};
|
|
95
|
+
export type ServiceLevelIndicatorMetricType =
|
|
96
|
+
(typeof ServiceLevelIndicatorMetricType)[keyof typeof ServiceLevelIndicatorMetricType];
|
|
83
97
|
export interface Dimension {
|
|
84
98
|
Name: string | undefined;
|
|
85
99
|
Value: string | undefined;
|
|
@@ -134,12 +148,50 @@ export interface MetricDataQuery {
|
|
|
134
148
|
Period?: number;
|
|
135
149
|
AccountId?: string;
|
|
136
150
|
}
|
|
137
|
-
export
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
export
|
|
142
|
-
|
|
151
|
+
export type MonitoredRequestCountMetricDataQueries =
|
|
152
|
+
| MonitoredRequestCountMetricDataQueries.BadCountMetricMember
|
|
153
|
+
| MonitoredRequestCountMetricDataQueries.GoodCountMetricMember
|
|
154
|
+
| MonitoredRequestCountMetricDataQueries.$UnknownMember;
|
|
155
|
+
export declare namespace MonitoredRequestCountMetricDataQueries {
|
|
156
|
+
interface GoodCountMetricMember {
|
|
157
|
+
GoodCountMetric: MetricDataQuery[];
|
|
158
|
+
BadCountMetric?: never;
|
|
159
|
+
$unknown?: never;
|
|
160
|
+
}
|
|
161
|
+
interface BadCountMetricMember {
|
|
162
|
+
GoodCountMetric?: never;
|
|
163
|
+
BadCountMetric: MetricDataQuery[];
|
|
164
|
+
$unknown?: never;
|
|
165
|
+
}
|
|
166
|
+
interface $UnknownMember {
|
|
167
|
+
GoodCountMetric?: never;
|
|
168
|
+
BadCountMetric?: never;
|
|
169
|
+
$unknown: [string, any];
|
|
170
|
+
}
|
|
171
|
+
interface Visitor<T> {
|
|
172
|
+
GoodCountMetric: (value: MetricDataQuery[]) => T;
|
|
173
|
+
BadCountMetric: (value: MetricDataQuery[]) => T;
|
|
174
|
+
_: (name: string, value: any) => T;
|
|
175
|
+
}
|
|
176
|
+
const visit: <T>(
|
|
177
|
+
value: MonitoredRequestCountMetricDataQueries,
|
|
178
|
+
visitor: Visitor<T>
|
|
179
|
+
) => T;
|
|
180
|
+
}
|
|
181
|
+
export interface RequestBasedServiceLevelIndicatorMetric {
|
|
182
|
+
KeyAttributes?: Record<string, string>;
|
|
183
|
+
OperationName?: string;
|
|
184
|
+
MetricType?: ServiceLevelIndicatorMetricType;
|
|
185
|
+
TotalRequestCountMetric: MetricDataQuery[] | undefined;
|
|
186
|
+
MonitoredRequestCountMetric:
|
|
187
|
+
| MonitoredRequestCountMetricDataQueries
|
|
188
|
+
| undefined;
|
|
189
|
+
}
|
|
190
|
+
export interface RequestBasedServiceLevelIndicator {
|
|
191
|
+
RequestBasedSliMetric: RequestBasedServiceLevelIndicatorMetric | undefined;
|
|
192
|
+
MetricThreshold?: number;
|
|
193
|
+
ComparisonOperator?: ServiceLevelIndicatorComparisonOperator;
|
|
194
|
+
}
|
|
143
195
|
export interface ServiceLevelIndicatorMetric {
|
|
144
196
|
KeyAttributes?: Record<string, string>;
|
|
145
197
|
OperationName?: string;
|
|
@@ -154,11 +206,15 @@ export interface ServiceLevelIndicator {
|
|
|
154
206
|
export interface ServiceLevelObjectiveBudgetReport {
|
|
155
207
|
Arn: string | undefined;
|
|
156
208
|
Name: string | undefined;
|
|
209
|
+
EvaluationType?: EvaluationType;
|
|
157
210
|
BudgetStatus: ServiceLevelObjectiveBudgetStatus | undefined;
|
|
158
211
|
Attainment?: number;
|
|
159
212
|
TotalBudgetSeconds?: number;
|
|
160
213
|
BudgetSecondsRemaining?: number;
|
|
214
|
+
TotalBudgetRequests?: number;
|
|
215
|
+
BudgetRequestsRemaining?: number;
|
|
161
216
|
Sli?: ServiceLevelIndicator;
|
|
217
|
+
RequestBasedSli?: RequestBasedServiceLevelIndicator;
|
|
162
218
|
Goal?: Goal;
|
|
163
219
|
}
|
|
164
220
|
export interface BatchGetServiceLevelObjectiveBudgetReportOutput {
|
|
@@ -302,6 +358,20 @@ export declare class ConflictException extends __BaseException {
|
|
|
302
358
|
Message: string | undefined;
|
|
303
359
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
304
360
|
}
|
|
361
|
+
export interface RequestBasedServiceLevelIndicatorMetricConfig {
|
|
362
|
+
KeyAttributes?: Record<string, string>;
|
|
363
|
+
OperationName?: string;
|
|
364
|
+
MetricType?: ServiceLevelIndicatorMetricType;
|
|
365
|
+
TotalRequestCountMetric?: MetricDataQuery[];
|
|
366
|
+
MonitoredRequestCountMetric?: MonitoredRequestCountMetricDataQueries;
|
|
367
|
+
}
|
|
368
|
+
export interface RequestBasedServiceLevelIndicatorConfig {
|
|
369
|
+
RequestBasedSliMetricConfig:
|
|
370
|
+
| RequestBasedServiceLevelIndicatorMetricConfig
|
|
371
|
+
| undefined;
|
|
372
|
+
MetricThreshold?: number;
|
|
373
|
+
ComparisonOperator?: ServiceLevelIndicatorComparisonOperator;
|
|
374
|
+
}
|
|
305
375
|
export interface ServiceLevelIndicatorMetricConfig {
|
|
306
376
|
KeyAttributes?: Record<string, string>;
|
|
307
377
|
OperationName?: string;
|
|
@@ -318,7 +388,8 @@ export interface ServiceLevelIndicatorConfig {
|
|
|
318
388
|
export interface CreateServiceLevelObjectiveInput {
|
|
319
389
|
Name: string | undefined;
|
|
320
390
|
Description?: string;
|
|
321
|
-
SliConfig
|
|
391
|
+
SliConfig?: ServiceLevelIndicatorConfig;
|
|
392
|
+
RequestBasedSliConfig?: RequestBasedServiceLevelIndicatorConfig;
|
|
322
393
|
Goal?: Goal;
|
|
323
394
|
Tags?: Tag[];
|
|
324
395
|
}
|
|
@@ -328,7 +399,9 @@ export interface ServiceLevelObjective {
|
|
|
328
399
|
Description?: string;
|
|
329
400
|
CreatedTime: Date | undefined;
|
|
330
401
|
LastUpdatedTime: Date | undefined;
|
|
331
|
-
Sli
|
|
402
|
+
Sli?: ServiceLevelIndicator;
|
|
403
|
+
RequestBasedSli?: RequestBasedServiceLevelIndicator;
|
|
404
|
+
EvaluationType?: EvaluationType;
|
|
332
405
|
Goal: Goal | undefined;
|
|
333
406
|
}
|
|
334
407
|
export interface CreateServiceLevelObjectiveOutput {
|
|
@@ -373,6 +446,7 @@ export interface UpdateServiceLevelObjectiveInput {
|
|
|
373
446
|
Id: string | undefined;
|
|
374
447
|
Description?: string;
|
|
375
448
|
SliConfig?: ServiceLevelIndicatorConfig;
|
|
449
|
+
RequestBasedSliConfig?: RequestBasedServiceLevelIndicatorConfig;
|
|
376
450
|
Goal?: Goal;
|
|
377
451
|
}
|
|
378
452
|
export interface UpdateServiceLevelObjectiveOutput {
|