Batch Get Service Level Objective Budget Report

cloudwatchapplicationsignals_batch_get_service_level_objective_budget_report

R Documentation

Use this operation to retrieve one or more service level objective (SLO) budget reports

Description

Use this operation to retrieve one or more service level objective (SLO) budget reports.

An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.

Budget reports include a health indicator, the attainment value, and remaining budget.

For more information about SLO error budgets, see SLO concepts.

Usage

cloudwatchapplicationsignals_batch_get_service_level_objective_budget_report(
  Timestamp, SloIds)

Arguments

Timestamp

[required] The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

SloIds

[required] An array containing the IDs of the service level objectives that you want to include in the report.

Value

A list with the following syntax:

list(
  Timestamp = as.POSIXct(
    "2015-01-01"
  ),
  Reports = list(
    list(
      Arn = "string",
      Name = "string",
      EvaluationType = "PeriodBased"|"RequestBased",
      BudgetStatus = "OK"|"WARNING"|"BREACHED"|"INSUFFICIENT_DATA",
      Attainment = 123.0,
      TotalBudgetSeconds = 123,
      BudgetSecondsRemaining = 123,
      TotalBudgetRequests = 123,
      BudgetRequestsRemaining = 123,
      Sli = list(
        SliMetric = list(
          KeyAttributes = list(
            "string"
          ),
          OperationName = "string",
          MetricType = "LATENCY"|"AVAILABILITY",
          MetricDataQueries = list(
            list(
              Id = "string",
              MetricStat = list(
                Metric = list(
                  Namespace = "string",
                  MetricName = "string",
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  )
                ),
                Period = 123,
                Stat = "string",
                Unit = "Microseconds"|"Milliseconds"|"Seconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
              ),
              Expression = "string",
              Label = "string",
              ReturnData = TRUE|FALSE,
              Period = 123,
              AccountId = "string"
            )
          )
        ),
        MetricThreshold = 123.0,
        ComparisonOperator = "GreaterThanOrEqualTo"|"GreaterThan"|"LessThan"|"LessThanOrEqualTo"
      ),
      RequestBasedSli = list(
        RequestBasedSliMetric = list(
          KeyAttributes = list(
            "string"
          ),
          OperationName = "string",
          MetricType = "LATENCY"|"AVAILABILITY",
          TotalRequestCountMetric = list(
            list(
              Id = "string",
              MetricStat = list(
                Metric = list(
                  Namespace = "string",
                  MetricName = "string",
                  Dimensions = list(
                    list(
                      Name = "string",
                      Value = "string"
                    )
                  )
                ),
                Period = 123,
                Stat = "string",
                Unit = "Microseconds"|"Milliseconds"|"Seconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
              ),
              Expression = "string",
              Label = "string",
              ReturnData = TRUE|FALSE,
              Period = 123,
              AccountId = "string"
            )
          ),
          MonitoredRequestCountMetric = list(
            GoodCountMetric = list(
              list(
                Id = "string",
                MetricStat = list(
                  Metric = list(
                    Namespace = "string",
                    MetricName = "string",
                    Dimensions = list(
                      list(
                        Name = "string",
                        Value = "string"
                      )
                    )
                  ),
                  Period = 123,
                  Stat = "string",
                  Unit = "Microseconds"|"Milliseconds"|"Seconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
                ),
                Expression = "string",
                Label = "string",
                ReturnData = TRUE|FALSE,
                Period = 123,
                AccountId = "string"
              )
            ),
            BadCountMetric = list(
              list(
                Id = "string",
                MetricStat = list(
                  Metric = list(
                    Namespace = "string",
                    MetricName = "string",
                    Dimensions = list(
                      list(
                        Name = "string",
                        Value = "string"
                      )
                    )
                  ),
                  Period = 123,
                  Stat = "string",
                  Unit = "Microseconds"|"Milliseconds"|"Seconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
                ),
                Expression = "string",
                Label = "string",
                ReturnData = TRUE|FALSE,
                Period = 123,
                AccountId = "string"
              )
            )
          )
        ),
        MetricThreshold = 123.0,
        ComparisonOperator = "GreaterThanOrEqualTo"|"GreaterThan"|"LessThan"|"LessThanOrEqualTo"
      ),
      Goal = list(
        Interval = list(
          RollingInterval = list(
            DurationUnit = "MINUTE"|"HOUR"|"DAY"|"MONTH",
            Duration = 123
          ),
          CalendarInterval = list(
            StartTime = as.POSIXct(
              "2015-01-01"
            ),
            DurationUnit = "MINUTE"|"HOUR"|"DAY"|"MONTH",
            Duration = 123
          )
        ),
        AttainmentGoal = 123.0,
        WarningThreshold = 123.0
      )
    )
  ),
  Errors = list(
    list(
      Name = "string",
      Arn = "string",
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_get_service_level_objective_budget_report(
  Timestamp = as.POSIXct(
    "2015-01-01"
  ),
  SloIds = list(
    "string"
  )
)