CreateServiceLevelObjectiveInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-create-service-level-objective-input-schema.json",
  "title": "CreateServiceLevelObjectiveInput",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-slo-api-openapi.yml#/components/schemas/CreateServiceLevelObjectiveInput",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "A name for this SLO."
    },
    "Description": {
      "type": "string",
      "description": "An optional description for this SLO."
    },
    "SliConfig": {
      "$ref": "#/$defs/ServiceLevelIndicatorConfig"
    },
    "RequestBasedSliConfig": {
      "$ref": "#/$defs/RequestBasedServiceLevelIndicatorConfig"
    },
    "Goal": {
      "$ref": "#/$defs/Goal"
    },
    "Tags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "description": "A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values."
    },
    "BurnRateConfigurations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BurnRateConfiguration"
      },
      "description": "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."
    },
    "CreateRecommendedSlo": {
      "type": "boolean",
      "description": "Set this to true to create a recommended SLO out of the box. When set to true, you don't need to specify the MetricThreshold or ComparisonOperator in the SliConfig or RequestBasedSliConfig. The default value is false. This is supported for SLOs on a service, service operation, or a dependency."
    },
    "AutoInvestigationEnabled": {
      "type": "boolean",
      "description": "Indicates whether DevOps Agent will automatically investigate this SLO when it is breached"
    }
  },
  "required": [
    "Name"
  ],
  "$defs": {
    "ApplicationSignalsMetric": {
      "type": "object",
      "properties": {
        "Namespace": {
          "type": "string",
          "description": "The namespace of the metric. For more information, see Namespaces."
        },
        "MetricName": {
          "type": "string",
          "description": "The name of the metric to use."
        },
        "Dimensions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Dimension"
          },
          "description": "An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions."
        }
      }
    },
    "ApplicationSignalsMetricDataQuery": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "description": "A short name used to tie this object to the results in the response. This Id must be unique within a MetricDataQueries array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter."
        },
        "MetricStat": {
          "$ref": "#/$defs/ApplicationSignalsMetricStat"
        },
        "Expression": {
          "type": "string",
          "description": "This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this MetricDataQueries structure. A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide. Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both."
        },
        "Label": {
          "type": "string",
          "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default. You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels."
        },
        "ReturnData": {
          "type": "boolean",
          "description": "Use this only if you are using a metric math expression for the SLO. Specify true for ReturnData for only the one expression result to use as the alarm. For all other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false."
        },
        "Period": {
          "type": "integer",
          "description": "The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second. If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in"
        },
        "AccountId": {
          "type": "string",
          "description": "The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from."
        }
      },
      "required": [
        "Id"
      ]
    },
    "ApplicationSignalsMetricStat": {
      "type": "object",
      "properties": {
        "Metric": {
          "$ref": "#/$defs/ApplicationSignalsMetric"
        },
        "Period": {
          "type": "integer",
          "description": "The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second."
        },
        "Stat": {
          "type": "string",
          "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions."
        },
        "Unit": {
          "type": "string",
          "enum": [
            "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"
          ],
          "description": "If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions."
        }
      },
      "required": [
        "Metric",
        "Period",
        "Stat"
      ]
    },
    "BurnRateConfiguration": {
      "type": "object",
      "properties": {
        "LookBackWindowMinutes": {
          "type": "integer",
          "description": "The number of minutes to use as the look-back window."
        }
      },
      "required": [
        "LookBackWindowMinutes"
      ]
    },
    "CalendarInterval": {
      "type": "object",
      "properties": {
        "StartTime": {
          "type": "string",
          "description": "The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057 As soon as one calendar interval ends, another automatically begins."
        },
        "DurationUnit": {
          "type": "string",
          "enum": [
            "MINUTE",
            "HOUR",
            "DAY",
            "MONTH"
          ],
          "description": "Specifies the calendar interval unit."
        },
        "Duration": {
          "type": "integer",
          "description": "Specifies the duration of each calendar interval. For example, if Duration is 1 and DurationUnit is MONTH, each interval is one month, aligned with the calendar."
        }
      },
      "required": [
        "StartTime",
        "DurationUnit",
        "Duration"
      ]
    },
    "CompositeSliComponent": {
      "type": "object",
      "properties": {
        "OperationName": {
          "type": "string",
          "description": "The name of the operation to include in the composite SLI."
        }
      },
      "description": "Exactly one member is set."
    },
    "CompositeSliConfig": {
      "type": "object",
      "properties": {
        "SelectionConfig": {
          "$ref": "#/$defs/SelectionConfig"
        },
        "Components": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CompositeSliComponent"
          },
          "description": "The list of operations included in this composite SLI. You must specify between 2 and 20 components. Each component is a CompositeSliComponent that identifies a single operation by its OperationName."
        }
      },
      "required": [
        "SelectionConfig"
      ]
    },
    "DependencyConfig": {
      "type": "object",
      "properties": {
        "DependencyKeyAttributes": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "This is a string-to-string map. It can include the following fields. Type designates the type of object this is. ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource. Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service. Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource. Environment specifies the location where this object is hosted, or what it belo"
        },
        "DependencyOperationName": {
          "type": "string",
          "description": "The name of the called operation in the dependency."
        }
      },
      "required": [
        "DependencyKeyAttributes",
        "DependencyOperationName"
      ]
    },
    "Dimension": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string",
          "description": "The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names."
        },
        "Value": {
          "type": "string",
          "description": "The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values."
        }
      },
      "required": [
        "Name",
        "Value"
      ]
    },
    "Goal": {
      "type": "object",
      "properties": {
        "Interval": {
          "$ref": "#/$defs/Interval"
        },
        "AttainmentGoal": {
          "type": "number",
          "description": "The threshold that determines if the goal is being met. If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state. If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal. If you omit this parameter, 99 is used to represent 99% as the attainment goal."
        },
        "WarningThreshold": {
          "type": "number",
          "description": "The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used."
        }
      }
    },
    "Interval": {
      "type": "object",
      "properties": {
        "RollingInterval": {
          "$ref": "#/$defs/RollingInterval"
        },
        "CalendarInterval": {
          "$ref": "#/$defs/CalendarInterval"
        }
      },
      "description": "Exactly one member is set."
    },
    "MetricSource": {
      "type": "object",
      "properties": {
        "MetricSourceKeyAttributes": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Key attributes that identify the metric source."
        },
        "MetricSourceAttributes": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Additional attributes for the metric source."
        }
      },
      "required": [
        "MetricSourceKeyAttributes"
      ]
    },
    "MonitoredRequestCountMetricDataQueries": {
      "type": "object",
      "properties": {
        "GoodCountMetric": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApplicationSignalsMetricDataQuery"
          },
          "description": "If you want to count \"good requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"good requests\" in this structure."
        },
        "BadCountMetric": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApplicationSignalsMetricDataQuery"
          },
          "description": "If you want to count \"bad requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"bad requests\" in this structure."
        }
      },
      "description": "Exactly one member is set."
    },
    "RequestBasedServiceLevelIndicatorConfig": {
      "type": "object",
      "properties": {
        "RequestBasedSliMetricConfig": {
          "$ref": "#/$defs/RequestBasedServiceLevelIndicatorMetricConfig"
        },
        "MetricThreshold": {
          "type": "number",
          "description": "The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric."
        },
        "ComparisonOperator": {
          "type": "string",
          "enum": [
            "GreaterThanOrEqualTo",
            "GreaterThan",
            "LessThan",
            "LessThanOrEqualTo"
          ],
          "description": "The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the Latency metric."
        }
      },
      "required": [
        "RequestBasedSliMetricConfig"
      ]
    },
    "RequestBasedServiceLevelIndicatorMetricConfig": {
      "type": "object",
      "properties": {
        "KeyAttributes": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes. This is a string-to-string map. It can include the following fields. Type designates the type of object this is. ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource. Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::"
        },
        "OperationName": {
          "type": "string",
          "description": "If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation."
        },
        "MetricType": {
          "type": "string",
          "enum": [
            "LATENCY",
            "AVAILABILITY"
          ],
          "description": "If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used."
        },
        "TotalRequestCountMetric": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApplicationSignalsMetricDataQuery"
          },
          "description": "Use this structure to define the metric that you want to use as the \"total requests\" number for a request-based SLO. This result will be divided by the \"good request\" or \"bad request\" value defined in MonitoredRequestCountMetric."
        },
        "MonitoredRequestCountMetric": {
          "$ref": "#/$defs/MonitoredRequestCountMetricDataQueries"
        },
        "DependencyConfig": {
          "$ref": "#/$defs/DependencyConfig"
        },
        "MetricSource": {
          "$ref": "#/$defs/MetricSource"
        },
        "MetricName": {
          "type": "string",
          "description": "The name of the metric for SLOs on resources other than Application Signals services."
        },
        "CompositeSliConfig": {
          "$ref": "#/$defs/CompositeSliConfig"
        }
      }
    },
    "RollingInterval": {
      "type": "object",
      "properties": {
        "DurationUnit": {
          "type": "string",
          "enum": [
            "MINUTE",
            "HOUR",
            "DAY",
            "MONTH"
          ],
          "description": "Specifies the rolling interval unit."
        },
        "Duration": {
          "type": "integer",
          "description": "Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days."
        }
      },
      "required": [
        "DurationUnit",
        "Duration"
      ]
    },
    "SelectionConfig": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "EXPLICIT",
            "PREFIX",
            "REGEX"
          ]
        },
        "Pattern": {
          "type": "string",
          "description": "A prefix string or regular expression that specifies which operations to include in a service-level SLO. When SelectionType is PREFIX, this value is a prefix string that matches the beginning of operation names. When SelectionType is REGEX, this value is a regular expression that matches operation names."
        }
      },
      "required": [
        "Type"
      ]
    },
    "ServiceLevelIndicatorConfig": {
      "type": "object",
      "properties": {
        "SliMetricConfig": {
          "$ref": "#/$defs/ServiceLevelIndicatorMetricConfig"
        },
        "MetricThreshold": {
          "type": "number",
          "description": "This parameter is used only when a request-based SLO tracks the Latency metric. Specify the threshold value that the observed Latency metric values are to be compared to. This is not required if CreateRecommendedSlo is set to true."
        },
        "ComparisonOperator": {
          "type": "string",
          "enum": [
            "GreaterThanOrEqualTo",
            "GreaterThan",
            "LessThan",
            "LessThanOrEqualTo"
          ],
          "description": "The arithmetic operation to use when comparing the specified metric to the threshold. This is not required if CreateRecommendedSlo is set to true."
        }
      },
      "required": [
        "SliMetricConfig"
      ]
    },
    "ServiceLevelIndicatorMetricConfig": {
      "type": "object",
      "properties": {
        "KeyAttributes": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes. This is a string-to-string map. It can include the following fields. Type designates the type of object this is. ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource. Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::"
        },
        "OperationName": {
          "type": "string",
          "description": "If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation."
        },
        "MetricType": {
          "type": "string",
          "enum": [
            "LATENCY",
            "AVAILABILITY"
          ],
          "description": "If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used."
        },
        "MetricName": {
          "type": "string",
          "description": "The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics."
        },
        "Statistic": {
          "type": "string",
          "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions."
        },
        "PeriodSeconds": {
          "type": "integer",
          "description": "The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance."
        },
        "MetricSource": {
          "$ref": "#/$defs/MetricSource"
        },
        "MetricDataQueries": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApplicationSignalsMetricDataQuery"
          },
          "description": "If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression."
        },
        "DependencyConfig": {
          "$ref": "#/$defs/DependencyConfig"
        },
        "CompositeSliConfig": {
          "$ref": "#/$defs/CompositeSliConfig"
        }
      }
    },
    "Tag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."
        },
        "Value": {
          "type": "string",
          "description": "The value for the specified tag key."
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    }
  }
}