ServiceLevelObjectiveBudgetReport - Application Signals
ContentsSee Also

ServiceLevelObjectiveBudgetReport

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

Contents

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 specifed 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 percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.

Type: Double

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.

Type: Integer

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

Sli

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

Type: ServiceLevelIndicator object

Required: No

TotalBudgetSeconds

The total number of seconds in the error budget for the interval.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: