Skip to content

ServiceLevelObjective

Source code in docs_src/capo_application_signals/types/service_level_objective.py
class ServiceLevelObjective(TypedDict, closed=True):
    arn: "capo_application_signals.types.service_level_objective_arn.ServiceLevelObjectiveArn"
    """<p>The ARN of this SLO.</p>"""
    name: "capo_application_signals.types.service_level_objective_name.ServiceLevelObjectiveName"
    """<p>The name of this SLO.</p>"""
    description: NotRequired[
        "capo_application_signals.types.service_level_objective_description.ServiceLevelObjectiveDescription"
    ]
    """<p>The description that you created for this SLO.</p>"""
    created_time: "datetime.datetime"
    """<p>The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example, <code>2019-07-01T23:59:59</code>.</p>"""
    last_updated_time: "datetime.datetime"
    """<p>The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example, <code>2019-07-01T23:59:59</code>.</p>"""
    sli: NotRequired[
        "capo_application_signals.types.service_level_indicator.ServiceLevelIndicator"
    ]
    """<p>A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.</p>"""
    request_based_sli: NotRequired[
        "capo_application_signals.types.request_based_service_level_indicator.RequestBasedServiceLevelIndicator"
    ]
    """<p>A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.</p>"""
    evaluation_type: NotRequired[
        "capo_application_signals.types.evaluation_type.EvaluationType"
    ]
    """<p>Displays whether this is a period-based SLO or a request-based SLO.</p>"""
    goal: "capo_application_signals.types.goal.Goal"
    burn_rate_configurations: NotRequired[
        "capo_application_signals.types.burn_rate_configurations.BurnRateConfigurations"
    ]
    """<p>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.</p>"""
    metric_source_type: NotRequired[
        "capo_application_signals.types.metric_source_type.MetricSourceType"
    ]
    """<p>Displays the SLI metric source type for this SLO. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>Service</p> </li> <li> <p>CloudWatch metric</p> </li> <li> <p>AppMonitor</p> </li> <li> <p>Canary</p> </li> </ul>"""
    auto_investigation_enabled: NotRequired["bool"]
    """Indicates whether DevOps Agent will automatically investigate this SLO when it is breached"""

arn instance-attribute

The ARN of this SLO.

auto_investigation_enabled instance-attribute

auto_investigation_enabled: NotRequired[bool]

Indicates whether DevOps Agent will automatically investigate this SLO when it is breached

burn_rate_configurations instance-attribute

burn_rate_configurations: NotRequired[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.

created_time instance-attribute

created_time: datetime

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.

description instance-attribute

description: NotRequired[ServiceLevelObjectiveDescription]

The description that you created for this SLO.

evaluation_type instance-attribute

evaluation_type: NotRequired[EvaluationType]

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

goal instance-attribute

goal: Goal

last_updated_time instance-attribute

last_updated_time: datetime

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.

metric_source_type instance-attribute

metric_source_type: NotRequired[MetricSourceType]

Displays the SLI metric source type for this SLO. Supported types are:

  • Service operation

  • Service dependency

  • Service

  • CloudWatch metric

  • AppMonitor

  • Canary

name instance-attribute

The name of this SLO.

request_based_sli instance-attribute

request_based_sli: NotRequired[RequestBasedServiceLevelIndicator]

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

sli instance-attribute

sli: NotRequired[ServiceLevelIndicator]

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