Package-level declarations

Types

Link copied to clipboard
data class GetDiscoveryResult(val accountId: String? = null)
Link copied to clipboard
data class GetServiceLevelObjectiveResult(val arn: String? = null, val burnRateConfigurations: List<ServiceLevelObjectiveBurnRateConfiguration>? = null, val createdTime: Int? = null, val description: String? = null, val evaluationType: ServiceLevelObjectiveEvaluationType? = null, val exclusionWindows: List<ServiceLevelObjectiveExclusionWindow>? = null, val goal: ServiceLevelObjectiveGoal? = null, val lastUpdatedTime: Int? = null, val requestBasedSli: ServiceLevelObjectiveRequestBasedSli? = null, val sli: ServiceLevelObjectiveSli? = null, val tags: List<Tag>? = null)
data class ServiceLevelObjectiveBurnRateConfiguration(val lookBackWindowMinutes: Int)

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. For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following: burn rate = error rate over the look-back window / (1 - attainment goal percentage)

Link copied to clipboard
data class ServiceLevelObjectiveCalendarInterval(val duration: Int, val durationUnit: ServiceLevelObjectiveDurationUnit, val startTime: Int)

If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.

Link copied to clipboard
data class ServiceLevelObjectiveDependencyConfig(val dependencyKeyAttributes: Map<String, String>, val dependencyOperationName: String)

Configuration for identifying a dependency and its operation

Link copied to clipboard
data class ServiceLevelObjectiveDimension(val name: String, val value: String)

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 InstanceId as a dimension name, and the actual instance ID as the value for that dimension. You can assign up to 30 dimensions to a metric.

Link copied to clipboard
data class ServiceLevelObjectiveExclusionWindow(val reason: String? = null, val recurrenceRule: ServiceLevelObjectiveRecurrenceRule? = null, val startTime: String? = null, val window: ServiceLevelObjectiveWindow)

This object defines a time exclusion window for this SLO. The time exclusion window is used to exclude breaching data points from affecting attainment rate, error budget, and burn rate metrics.

Link copied to clipboard
data class ServiceLevelObjectiveGoal(val attainmentGoal: Double? = null, val interval: ServiceLevelObjectiveInterval? = null, val warningThreshold: Double? = null)

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

Link copied to clipboard
data class ServiceLevelObjectiveInterval(val calendarInterval: ServiceLevelObjectiveCalendarInterval? = null, val rollingInterval: ServiceLevelObjectiveRollingInterval? = null)

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval. If you omit this parameter, a rolling interval of 7 days is used.

Link copied to clipboard
data class ServiceLevelObjectiveMetric(val dimensions: List<ServiceLevelObjectiveDimension>? = null, val metricName: String? = null, val namespace: String? = null)

This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.

Link copied to clipboard
data class ServiceLevelObjectiveMetricDataQuery(val accountId: String? = null, val expression: String? = null, val id: String, val metricStat: ServiceLevelObjectiveMetricStat? = null, val returnData: Boolean? = null)

Use this structure to define a metric or metric math expression that you want to use as for a service level objective. Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.

Link copied to clipboard
data class ServiceLevelObjectiveMetricStat(val metric: ServiceLevelObjectiveMetric, val period: Int, val stat: String, val unit: String? = null)

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

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 TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

Link copied to clipboard
data class ServiceLevelObjectiveRecurrenceRule(val expression: String)

This object defines how often to repeat a time exclusion window.

Link copied to clipboard
data class ServiceLevelObjectiveRequestBasedSli(val comparisonOperator: ServiceLevelObjectiveRequestBasedSliComparisonOperator? = null, val metricThreshold: Double? = null, val requestBasedSliMetric: ServiceLevelObjectiveRequestBasedSliMetric)

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

data class ServiceLevelObjectiveRequestBasedSliMetric(val dependencyConfig: ServiceLevelObjectiveDependencyConfig? = null, val keyAttributes: Map<String, String>? = null, val metricType: ServiceLevelObjectiveRequestBasedSliMetricMetricType? = null, val monitoredRequestCountMetric: ServiceLevelObjectiveMonitoredRequestCountMetric? = null, val operationName: String? = null, val totalRequestCountMetric: List<ServiceLevelObjectiveMetricDataQuery>? = null)

This structure contains the information about the metric that is used for a request-based SLO.

Link copied to clipboard

If the interval is a calendar interval, this structure contains the interval specifications.

Link copied to clipboard
data class ServiceLevelObjectiveSli(val comparisonOperator: ServiceLevelObjectiveSliComparisonOperator, val metricThreshold: Double, val sliMetric: ServiceLevelObjectiveSliMetric)

This structure contains information about the performance metric that an SLO monitors.

Link copied to clipboard
data class ServiceLevelObjectiveSliMetric(val dependencyConfig: ServiceLevelObjectiveDependencyConfig? = null, val keyAttributes: Map<String, String>? = null, val metricDataQueries: List<ServiceLevelObjectiveMetricDataQuery>? = null, val metricType: ServiceLevelObjectiveSliMetricMetricType? = null, val operationName: String? = null, val periodSeconds: Int? = null, val statistic: String? = null)

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

Link copied to clipboard
data class ServiceLevelObjectiveWindow(val duration: Int, val durationUnit: ServiceLevelObjectiveDurationUnit)

This object defines the length of time an exclusion window should span.