Skip to content

ServiceLevelObjectiveSummary

Source code in docs_src/capo_application_signals/types/service_level_objective_summary.py
class ServiceLevelObjectiveSummary(TypedDict, closed=True):
    arn: "capo_application_signals.types.service_level_objective_arn.ServiceLevelObjectiveArn"
    """<p>The ARN of this service level objective.</p>"""
    name: "capo_application_signals.types.service_level_objective_name.ServiceLevelObjectiveName"
    """<p>The name of the service level objective.</p>"""
    key_attributes: NotRequired["capo_application_signals.types.attributes.Attributes"]
    """<p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this service level objective is for.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>"""
    operation_name: NotRequired[
        "capo_application_signals.types.operation_name.OperationName"
    ]
    """<p>If this service level objective is specific to a single operation, this field displays the name of that operation.</p>"""
    dependency_config: NotRequired[
        "capo_application_signals.types.dependency_config.DependencyConfig"
    ]
    """<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>"""
    created_time: NotRequired["datetime.datetime"]
    """<p>The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</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>"""
    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>"""
    metric_source: NotRequired[
        "capo_application_signals.types.metric_source.MetricSource"
    ]
    """<p>Identifies the metric source for SLOs on resources other than Application Signals services.</p>"""
    composite_sli_config: NotRequired[
        "capo_application_signals.types.composite_sli_config.CompositeSliConfig"
    ]
    """<p>The composite SLI configuration for service-level SLOs that monitor multiple operations of a service.</p>"""

arn instance-attribute

The ARN of this service level objective.

composite_sli_config instance-attribute

composite_sli_config: NotRequired[CompositeSliConfig]

The composite SLI configuration for service-level SLOs that monitor multiple operations of a service.

created_time instance-attribute

created_time: NotRequired[datetime]

The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

dependency_config instance-attribute

dependency_config: NotRequired[DependencyConfig]

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

evaluation_type instance-attribute

evaluation_type: NotRequired[EvaluationType]

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

key_attributes instance-attribute

key_attributes: NotRequired[Attributes]

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this service level objective is for.

  • 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 belongs to.

metric_source instance-attribute

metric_source: NotRequired[MetricSource]

Identifies the metric source for SLOs on resources other than Application Signals services.

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 the service level objective.

operation_name instance-attribute

operation_name: NotRequired[OperationName]

If this service level objective is specific to a single operation, this field displays the name of that operation.