ServiceLevelObjectiveBudgetReport

A structure containing an SLO budget report that you have requested.

Arn

The ARN of the SLO that this report is for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws:application-signals:[^:]*:[^:]*:slo/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]

Required: Yes

BudgetStatus

The status of this SLO, as it relates to the error budget for the entire time interval.

OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.
WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.
BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.
INSUFFICIENT_DATA means that the specified start and end times were before the SLO was created, or that attainment data is missing.

Type: String

Valid Values: OK | WARNING | BREACHED | INSUFFICIENT_DATA

Required: Yes

Name

The name of the SLO that this report is for.

Type: String

Pattern: [0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]

Required: Yes

Attainment

A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.

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.

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.

Type: Double

Required: No

BudgetRequestsRemaining

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.

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.

Type: Integer

Required: No

BudgetSecondsRemaining

The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.

This field is included only if the SLO is a period-based SLO.

Type: Integer

Required: No

EvaluationType

Displays whether this budget report is for a period-based SLO or a request-based SLO.

Type: String

Valid Values: PeriodBased | RequestBased

Required: No

Goal

This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

Type: Goal object

Required: No

RequestBasedSli

This structure contains information about the performance metric that a request-based SLO monitors.

Type: RequestBasedServiceLevelIndicator object

Required: No

Sli

A structure that contains information about the performance metric that this SLO monitors.

Type: ServiceLevelIndicator object

Required: No

TotalBudgetRequests

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.

This number can go up and down between reports with different time stamps, based on both how many total requests occur.

Type: Integer

Required: No

TotalBudgetSeconds

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.

Type: Integer

Required: No

ServiceLevelObjectiveBudgetReport

Contents

See Also