Skip to content

ServiceLevelIndicatorMetric

Source code in docs_src/capo_application_signals/types/service_level_indicator_metric.py
class ServiceLevelIndicatorMetric(TypedDict, closed=True):
    key_attributes: NotRequired["capo_application_signals.types.attributes.Attributes"]
    """<p>This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object that this SLO is related to.</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 the SLO monitors a specific operation of the service, this field displays that operation name.</p>"""
    metric_type: NotRequired[
        "capo_application_signals.types.service_level_indicator_metric_type.ServiceLevelIndicatorMetricType"
    ]
    """<p>If the SLO monitors either the <code>LATENCY</code> or <code>AVAILABILITY</code> metric that Application Signals collects, this field displays which of those metrics is used.</p>"""
    metric_data_queries: (
        "capo_application_signals.types.metric_data_queries.MetricDataQueries"
    )
    """<p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression. </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>"""
    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>"""

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.

dependency_config instance-attribute

dependency_config: NotRequired[DependencyConfig]

Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

key_attributes instance-attribute

key_attributes: NotRequired[Attributes]

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

  • Type designates the type of object that this SLO is related to.

  • 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_data_queries instance-attribute

metric_data_queries: MetricDataQueries

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.

metric_source instance-attribute

metric_source: NotRequired[MetricSource]

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

metric_type instance-attribute

metric_type: NotRequired[ServiceLevelIndicatorMetricType]

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

operation_name instance-attribute

operation_name: NotRequired[OperationName]

If the SLO monitors a specific operation of the service, this field displays that operation name.