RequestBasedServiceLevelIndicatorMetric - Application Signals
ContentsSee Also

RequestBasedServiceLevelIndicatorMetric

This structure contains the information about the metric that is used for a request-based SLO.

Contents

MonitoredRequestCountMetric

This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

Type: MonitoredRequestCountMetricDataQueries object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

TotalRequestCountMetric

This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric.

Type: Array of MetricDataQuery objects

Required: Yes

KeyAttributes

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.

Type: String to string map

Map Entries: Maximum number of 3 items.

Key Pattern: [a-zA-Z]{1,50}

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [ -~]*[!-~]+[ -~]*

Required: No

MetricType

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

Type: String

Valid Values: LATENCY | AVAILABILITY

Required: No

OperationName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: