Update Service Level Objective

cloudwatchapplicationsignals_update_service_level_objective

R Documentation

Updates an existing service level objective (SLO)

Description

Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.

You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.

Usage

cloudwatchapplicationsignals_update_service_level_objective(Id,
  Description, SliConfig, RequestBasedSliConfig, Goal,
  BurnRateConfigurations)

Arguments

Id

[required] The Amazon Resource Name (ARN) or name of the service level objective that you want to update.

Description

An optional description for the SLO.

SliConfig

If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

RequestBasedSliConfig

If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

You can't specify both SliConfig and RequestBasedSliConfig in the same operation.

Goal

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

BurnRateConfigurations

Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

Value

A list with the following syntax:

list(
  Slo = list(
    Arn = "string",
    Name = "string",
    Description = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    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"
    ),
    EvaluationType = "PeriodBased"|"RequestBased",
    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
    ),
    BurnRateConfigurations = list(
      list(
        LookBackWindowMinutes = 123
      )
    )
  )
)

Request syntax

svc$update_service_level_objective(
  Id = "string",
  Description = "string",
  SliConfig = list(
    SliMetricConfig = list(
      KeyAttributes = list(
        "string"
      ),
      OperationName = "string",
      MetricType = "LATENCY"|"AVAILABILITY",
      Statistic = "string",
      PeriodSeconds = 123,
      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"
  ),
  RequestBasedSliConfig = list(
    RequestBasedSliMetricConfig = 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
  ),
  BurnRateConfigurations = list(
    list(
      LookBackWindowMinutes = 123
    )
  )
)