ServiceLevelObjective - Application Signals

ServiceLevelObjective

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.

Contents

Arn

The ARN of this SLO.

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

CreatedTime

The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Type: Timestamp

Required: Yes

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: Yes

LastUpdatedTime

The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Type: Timestamp

Required: Yes

Name

The name of this SLO.

Type: String

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

Required: Yes

BurnRateConfigurations

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.

Type: Array of BurnRateConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

Description

The description that you created for this SLO.

Type: String

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

Required: No

EvaluationType

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

Type: String

Valid Values: PeriodBased | RequestBased

Required: No

RequestBasedSli

A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.

Type: RequestBasedServiceLevelIndicator object

Required: No

Sli

A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.

Type: ServiceLevelIndicator object

Required: No

See Also

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