2025/09/30 - Amazon CloudWatch Application Signals - 5 new4 updated api methods
Changes Amazon CloudWatch Application Signals is introducing the Application Map to give users a more comprehensive view of their service health. Users will now be able to group services, track their latest deployments, and view automated audit findings concerning service performance.
Creates or updates the grouping configuration for this account. This operation allows you to define custom grouping attributes that determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings. These grouping attributes can then be used to organize and filter services in the Application Signals console and APIs.
See also: AWS API Documentation
Request Syntax
client.put_grouping_configuration(
GroupingAttributeDefinitions=[
{
'GroupingName': 'string',
'GroupingSourceKeys': [
'string',
],
'DefaultGroupingValue': 'string'
},
]
)
list
[REQUIRED]
An array of grouping attribute definitions that specify how services should be grouped. Each definition includes a friendly name, source keys to derive the grouping value from, and an optional default value.
(dict) --
A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.
GroupingName (string) -- [REQUIRED]
The friendly name for this grouping attribute, such as BusinessUnit or Environment. This name is used to identify the grouping in the console and APIs.
GroupingSourceKeys (list) --
An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, ["business_unit", "team"] would look for values in those fields.
(string) --
DefaultGroupingValue (string) --
The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.
dict
Response Syntax
{
'GroupingConfiguration': {
'GroupingAttributeDefinitions': [
{
'GroupingName': 'string',
'GroupingSourceKeys': [
'string',
],
'DefaultGroupingValue': 'string'
},
],
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
GroupingConfiguration (dict) --
A structure containing the updated grouping configuration, including all grouping attribute definitions and the timestamp when it was last updated.
GroupingAttributeDefinitions (list) --
An array of grouping attribute definitions that specify how services should be grouped based on various attributes and source keys.
(dict) --
A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.
GroupingName (string) --
The friendly name for this grouping attribute, such as BusinessUnit or Environment. This name is used to identify the grouping in the console and APIs.
GroupingSourceKeys (list) --
An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, ["business_unit", "team"] would look for values in those fields.
(string) --
DefaultGroupingValue (string) --
The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.
UpdatedAt (datetime) --
The timestamp when this grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
Returns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most significant observations about your services, including performance issues, anomalies, and potential problems. The findings are generated using heuristic algorithms based on established troubleshooting patterns.
See also: AWS API Documentation
Request Syntax
client.list_audit_findings(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Auditors=[
'string',
],
AuditTargets=[
{
'Type': 'string',
'Data': {
'Service': {
'Type': 'string',
'Name': 'string',
'Environment': 'string',
'AwsAccountId': 'string'
},
'Slo': {
'SloName': 'string',
'SloArn': 'string'
},
'ServiceOperation': {
'Service': {
'Type': 'string',
'Name': 'string',
'Environment': 'string',
'AwsAccountId': 'string'
},
'Operation': 'string',
'MetricType': 'string'
}
}
},
],
NextToken='string',
MaxResults=123
)
datetime
[REQUIRED]
The start of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057
datetime
[REQUIRED]
The end of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057
list
A list of auditor names to filter the findings by. Only findings generated by the specified auditors will be returned.
The following auditors are available for configuration:
slo - SloAuditor: Identifies SLO violations and detects breached thresholds during the Assessment phase.
operation_metric - OperationMetricAuditor: Detects anomalies in service operation metrics from Application Signals RED metrics during the Assessment phase
service_quota - ServiceQuotaAuditor: Monitors resource utilization against service quotas during the Assessment phase
trace - TraceAuditor: Performs deep-dive analysis of distributed traces, correlating traces with breached SLOs or abnormal RED metrics during the Analysis phase
dependency_metric - CriticalPathAuditor: Analyzes service dependency impacts and maps dependency relationships from Application Signals RED metrics during the Analysis phase
top_contributor - TopContributorAuditor: Identifies infrastructure-level contributors to issues by analyzing EMF logs of Application Signals RED metrics during the Analysis phase
log - LogAuditor: Extracts insights from application logs, categorizing error types and ranking severity by frequency during the Analysis phase
(string) --
list
[REQUIRED]
A list of audit targets to filter the findings by. You can specify services, SLOs, or service operations to limit the audit findings to specific entities.
(dict) --
A structure that specifies the target entity for audit analysis, such as a service, SLO, or service_operation.
Type (string) -- [REQUIRED]
The type of entity being audited, such as Service, SLO, or ServiceOperation.
Data (dict) -- [REQUIRED]
The specific data identifying the audit target entity.
Service (dict) --
Service entity information when the audit target is a service.
Type (string) --
The type of the service entity.
Name (string) --
The name of the service.
Environment (string) --
The environment where the service is deployed.
AwsAccountId (string) --
The Amazon Web Services account ID where the service is located. Provide this value only for cross-account access.
Slo (dict) --
SLO entity information when the audit target is a service level objective.
SloName (string) --
The name of the service level objective.
SloArn (string) --
The ARN of the service level objective. The SLO must be provided with ARN for cross-account access.
ServiceOperation (dict) --
Service operation entity information when the audit target is a specific service operation.
Service (dict) --
The service entity that contains this operation.
Type (string) --
The type of the service entity.
Name (string) --
The name of the service.
Environment (string) --
The environment where the service is deployed.
AwsAccountId (string) --
The Amazon Web Services account ID where the service is located. Provide this value only for cross-account access.
Operation (string) --
The name of the operation.
MetricType (string) --
The type of metric associated with this service operation.
string
Include this value, if it was returned by the previous operation, to get the next set of audit findings.
integer
The maximum number of audit findings to return in one operation. If you omit this parameter, the default of 10 is used.
dict
Response Syntax
{
'AuditFindings': [
{
'KeyAttributes': {
'string': 'string'
},
'AuditorResults': [
{
'Auditor': 'string',
'Description': 'string',
'Severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'NONE'
},
],
'Operation': 'string',
'MetricGraph': {
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'DependencyGraph': {
'Nodes': [
{
'KeyAttributes': {
'string': 'string'
},
'Name': 'string',
'NodeId': 'string',
'Operation': 'string',
'Type': 'string',
'Duration': 123.0,
'Status': 'string'
},
],
'Edges': [
{
'SourceNodeId': 'string',
'DestinationNodeId': 'string',
'Duration': 123.0,
'ConnectionType': 'INDIRECT'|'DIRECT'
},
]
},
'Type': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AuditFindings (list) --
An array of structures, where each structure contains information about one audit finding, including the auditor results, severity, and associated metric and dependency graphs.
(dict) --
A structure that contains information about an audit finding, which represents an automated analysis result about service behavior, performance issues, or potential problems identified through heuristic algorithms.
KeyAttributes (dict) --
The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.
(string) --
(string) --
AuditorResults (list) --
An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.
(dict) --
A structure that contains the result of an automated audit analysis, including the auditor name, description of findings, and severity level.
Auditor (string) --
The name of the auditor algorithm that generated this result.
Description (string) --
A detailed description of the audit finding, explaining what was observed and potential implications.
Severity (string) --
The severity level of this audit finding, indicating the importance and potential impact of the issue.
Operation (string) --
The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.
MetricGraph (dict) --
A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.
MetricDataQueries (list) --
An array of metric data queries that define the metrics to be retrieved and analyzed as part of the audit finding context.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
StartTime (datetime) --
The start time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
EndTime (datetime) --
The end time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
DependencyGraph (dict) --
A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.
Nodes (list) --
An array of nodes representing the services, resources, or other entities in the dependency graph.
(dict) --
A structure that represents a node in a dependency graph, containing information about a service, resource, or other entity and its characteristics.
KeyAttributes (dict) --
The key attributes that identify this node, including Type, Name, and Environment information.
(string) --
(string) --
Name (string) --
The name of the entity represented by this node.
NodeId (string) --
A unique identifier for this node within the dependency graph.
Operation (string) --
The operation associated with this node, if applicable.
Type (string) --
The type of entity represented by this node, such as Service or Resource.
Duration (float) --
The duration or processing time associated with this node, if applicable.
Status (string) --
The status of the entity represented by this node.
Edges (list) --
An array of edges representing the connections and relationships between the nodes in the dependency graph.
(dict) --
A structure that represents a connection between two nodes in a dependency graph, showing the relationship and characteristics of the connection.
SourceNodeId (string) --
The identifier of the source node in this edge connection.
DestinationNodeId (string) --
The identifier of the destination node in this edge connection.
Duration (float) --
The duration or latency associated with this connection, if applicable.
ConnectionType (string) --
The type of connection between the nodes, indicating the nature of the relationship.
Type (string) --
The type of audit finding.
NextToken (string) --
Include this value in your next use of this API to get the next set of audit findings.
Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.
See also: AWS API Documentation
Request Syntax
client.list_grouping_attribute_definitions(
NextToken='string'
)
string
Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.
dict
Response Syntax
{
'GroupingAttributeDefinitions': [
{
'GroupingName': 'string',
'GroupingSourceKeys': [
'string',
],
'DefaultGroupingValue': 'string'
},
],
'UpdatedAt': datetime(2015, 1, 1),
'NextToken': 'string'
}
Response Structure
(dict) --
GroupingAttributeDefinitions (list) --
An array of structures, where each structure contains information about one grouping attribute definition, including the grouping name, source keys, and default values.
(dict) --
A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.
GroupingName (string) --
The friendly name for this grouping attribute, such as BusinessUnit or Environment. This name is used to identify the grouping in the console and APIs.
GroupingSourceKeys (list) --
An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, ["business_unit", "team"] would look for values in those fields.
(string) --
DefaultGroupingValue (string) --
The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.
UpdatedAt (datetime) --
The timestamp when the grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
NextToken (string) --
Include this value in your next use of this API to get the next set of grouping attribute definitions.
Returns information about the last deployment and other change states of services. This API provides visibility into recent changes that may have affected service performance, helping with troubleshooting and change correlation.
See also: AWS API Documentation
Request Syntax
client.list_service_states(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
IncludeLinkedAccounts=True|False,
AwsAccountId='string',
AttributeFilters=[
{
'AttributeFilterName': 'string',
'AttributeFilterValues': [
'string',
]
},
]
)
datetime
[REQUIRED]
The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.
datetime
[REQUIRED]
The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.
integer
The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of service states.
boolean
If you are using this operation in a monitoring account, specify true to include service states from source accounts in the returned data.
string
The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.
list
A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.
(dict) --
A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics.
AttributeFilterName (string) -- [REQUIRED]
The name of the attribute to filter by, such as Platform, Environment, or BusinessUnit.
AttributeFilterValues (list) -- [REQUIRED]
An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results.
(string) --
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceStates': [
{
'AttributeFilters': [
{
'AttributeFilterName': 'string',
'AttributeFilterValues': [
'string',
]
},
],
'Service': {
'string': 'string'
},
'LatestChangeEvents': [
{
'Timestamp': datetime(2015, 1, 1),
'AccountId': 'string',
'Region': 'string',
'Entity': {
'string': 'string'
},
'ChangeEventType': 'DEPLOYMENT',
'EventId': 'string',
'UserName': 'string',
'EventName': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StartTime (datetime) --
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.
EndTime (datetime) --
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.
ServiceStates (list) --
An array of structures, where each structure contains information about the state of one service, including its latest change events such as deployments.
(dict) --
A structure that contains information about the current state of a service, including its latest change events such as deployments and other state-changing activities.
AttributeFilters (list) --
The attribute filters that were applied when retrieving this service state information.
(dict) --
A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics.
AttributeFilterName (string) --
The name of the attribute to filter by, such as Platform, Environment, or BusinessUnit.
AttributeFilterValues (list) --
An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results.
(string) --
Service (dict) --
The key attributes that identify this service, including Type, Name, and Environment information.
(string) --
(string) --
LatestChangeEvents (list) --
An array containing the most recent change events for this service, such as deployments, with information about when they occurred and who initiated them.
(dict) --
A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.
Timestamp (datetime) --
The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
AccountId (string) --
The Amazon Web Services account ID where this change event occurred.
Region (string) --
The Amazon Web Services region where this change event occurred.
Entity (dict) --
The entity (service or resource) that was affected by this change event, including its key attributes.
(string) --
(string) --
ChangeEventType (string) --
The type of change event that occurred, such as DEPLOYMENT.
EventId (string) --
A unique identifier for this change event.
UserName (string) --
The name of the user who initiated this change event, if available.
EventName (string) --
The name or description of this change event.
NextToken (string) --
Include this value in your next use of this API to get the next set of service states.
Deletes the grouping configuration for this account. This removes all custom grouping attribute definitions that were previously configured.
See also: AWS API Documentation
Request Syntax
client.delete_grouping_configuration()
dict
Response Syntax
{}
Response Structure
(dict) --
{'SliConfig': {'SliMetricConfig': {'MetricName': 'string'}}}
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
The target performance quality that is defined for an SLO is the attainment goal.
You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.
A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the number of good periods/number of total periods. For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.
A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures number of good requests/number of total requests during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.
For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase. For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.
For more information about SLOs, see Service level objectives (SLOs).
When you perform a CreateServiceLevelObjective operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups
See also: AWS API Documentation
Request Syntax
client.create_service_level_objective(
Name='string',
Description='string',
SliConfig={
'SliMetricConfig': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'MetricName': 'string',
'Statistic': 'string',
'PeriodSeconds': 123,
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
RequestBasedSliConfig={
'RequestBasedSliMetricConfig': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'TotalRequestCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'MonitoredRequestCountMetric': {
'GoodCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'BadCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
]
},
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
Goal={
'Interval': {
'RollingInterval': {
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
BurnRateConfigurations=[
{
'LookBackWindowMinutes': 123
},
]
)
string
[REQUIRED]
A name for this SLO.
string
An optional description for this SLO.
dict
If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both RequestBasedSliConfig and SliConfig in the same operation.
SliMetricConfig (dict) -- [REQUIRED]
Use this structure to specify the metric to be used for the SLO.
KeyAttributes (dict) --
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::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.
(string) --
(string) --
OperationName (string) --
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
MetricType (string) --
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 (string) --
The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.
Statistic (string) --
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 (integer) --
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.
MetricDataQueries (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) -- [REQUIRED]
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) -- [REQUIRED]
The name of the called operation in the dependency.
MetricThreshold (float) -- [REQUIRED]
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.
ComparisonOperator (string) -- [REQUIRED]
The arithmetic operation to use when comparing the specified metric to the threshold.
dict
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both RequestBasedSliConfig and SliConfig in the same operation.
RequestBasedSliMetricConfig (dict) -- [REQUIRED]
Use this structure to specify the metric to be used for the SLO.
KeyAttributes (dict) --
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::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.
(string) --
(string) --
OperationName (string) --
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
MetricType (string) --
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 (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
MonitoredRequestCountMetric (dict) --
Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
GoodCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
BadCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) -- [REQUIRED]
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) -- [REQUIRED]
The name of the called operation in the dependency.
MetricThreshold (float) --
The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric.
ComparisonOperator (string) --
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.
dict
This structure contains the attributes that determine the goal of the SLO.
Interval (dict) --
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
If you omit this parameter, a rolling interval of 7 days is used.
RollingInterval (dict) --
If the interval is a rolling interval, this structure contains the interval specifications.
DurationUnit (string) -- [REQUIRED]
Specifies the rolling interval unit.
Duration (integer) -- [REQUIRED]
Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.
CalendarInterval (dict) --
If the interval is a calendar interval, this structure contains the interval specifications.
StartTime (datetime) -- [REQUIRED]
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 (string) -- [REQUIRED]
Specifies the calendar interval unit.
Duration (integer) -- [REQUIRED]
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.
AttainmentGoal (float) --
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 (float) --
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.
list
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.
(dict) --
A key-value pair associated with a resource. Tags can help you organize and categorize your resources.
Key (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
The value for the specified tag key.
list
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.
(dict) --
This object 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. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.
For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:
burn rate = error rate over the look-back window / (100% - attainment goal percentage)
For more information about burn rates, see Calculate burn rates.
LookBackWindowMinutes (integer) -- [REQUIRED]
The number of minutes to use as the look-back window.
dict
Response Syntax
{
'Slo': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Sli': {
'SliMetric': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'RequestBasedSli': {
'RequestBasedSliMetric': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'TotalRequestCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'MonitoredRequestCountMetric': {
'GoodCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'BadCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
]
},
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'EvaluationType': 'PeriodBased'|'RequestBased',
'Goal': {
'Interval': {
'RollingInterval': {
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
},
'BurnRateConfigurations': [
{
'LookBackWindowMinutes': 123
},
],
'MetricSourceType': 'ServiceOperation'|'CloudWatchMetric'|'ServiceDependency'
}
}
Response Structure
(dict) --
Slo (dict) --
A structure that contains information about the SLO that you just created.
Arn (string) --
The ARN of this SLO.
Name (string) --
The name of this SLO.
Description (string) --
The description that you created for this SLO.
CreatedTime (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.
LastUpdatedTime (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.
Sli (dict) --
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
SliMetric (dict) --
A structure that contains information about the metric that the SLO monitors.
KeyAttributes (dict) --
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.
(string) --
(string) --
OperationName (string) --
If the SLO monitors a specific operation of the service, this field displays that operation name.
MetricType (string) --
If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
MetricDataQueries (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) --
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) --
The name of the called operation in the dependency.
MetricThreshold (float) --
The value that the SLI metric is compared to.
ComparisonOperator (string) --
The arithmetic operation used when comparing the specified metric to the threshold.
RequestBasedSli (dict) --
A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
RequestBasedSliMetric (dict) --
A structure that contains information about the metric that the SLO monitors.
KeyAttributes (dict) --
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.
(string) --
(string) --
OperationName (string) --
If the SLO monitors a specific operation of the service, this field displays that operation name.
MetricType (string) --
If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
TotalRequestCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
MonitoredRequestCountMetric (dict) --
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.
GoodCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
BadCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) --
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) --
The name of the called operation in the dependency.
MetricThreshold (float) --
This value is the threshold that the observed metric values of the SLI metric are compared to.
ComparisonOperator (string) --
The arithmetic operation used when comparing the specified metric to the threshold.
EvaluationType (string) --
Displays whether this is a period-based SLO or a request-based SLO.
Goal (dict) --
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
Interval (dict) --
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
If you omit this parameter, a rolling interval of 7 days is used.
RollingInterval (dict) --
If the interval is a rolling interval, this structure contains the interval specifications.
DurationUnit (string) --
Specifies the rolling interval unit.
Duration (integer) --
Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.
CalendarInterval (dict) --
If the interval is a calendar interval, this structure contains the interval specifications.
StartTime (datetime) --
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 (string) --
Specifies the calendar interval unit.
Duration (integer) --
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.
AttainmentGoal (float) --
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 (float) --
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.
BurnRateConfigurations (list) --
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.
(dict) --
This object 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. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.
For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:
burn rate = error rate over the look-back window / (100% - attainment goal percentage)
For more information about burn rates, see Calculate burn rates.
LookBackWindowMinutes (integer) --
The number of minutes to use as the look-back window.
MetricSourceType (string) --
Displays the SLI metric source type for this SLO. Supported types are:
Service operation
Service dependency
CloudWatch metric
{'Service': {'ServiceGroups': [{'GroupIdentifier': 'string',
'GroupName': 'string',
'GroupSource': 'string',
'GroupValue': 'string'}]}}
Returns information about a service discovered by Application Signals.
See also: AWS API Documentation
Request Syntax
client.get_service(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
}
)
datetime
[REQUIRED]
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
datetime
[REQUIRED]
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
dict
[REQUIRED]
Use this field to specify which service you want to retrieve information for. 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::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.
(string) --
(string) --
dict
Response Syntax
{
'Service': {
'KeyAttributes': {
'string': 'string'
},
'AttributeMaps': [
{
'string': 'string'
},
],
'ServiceGroups': [
{
'GroupName': 'string',
'GroupValue': 'string',
'GroupSource': 'string',
'GroupIdentifier': 'string'
},
],
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'AccountId': 'string'
},
],
'LogGroupReferences': [
{
'string': 'string'
},
]
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'LogGroupReferences': [
{
'string': 'string'
},
]
}
Response Structure
(dict) --
Service (dict) --
A structure containing information about the service.
KeyAttributes (dict) --
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 belongs to.
(string) --
(string) --
AttributeMaps (list) --
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
(dict) --
(string) --
(string) --
ServiceGroups (list) --
An array of service groups that this service belongs to, based on the configured grouping attributes.
(dict) --
A structure that represents a logical grouping of services based on shared attributes such as business unit, environment, or entry point.
GroupName (string) --
The name of the grouping attribute, such as BusinessUnit or Environment.
GroupValue (string) --
The value of the grouping attribute for this service, such as Payments or Production.
GroupSource (string) --
The source of the grouping attribute, such as TAG, OTEL, or DEFAULT.
GroupIdentifier (string) --
A unique identifier for this grouping attribute value, used for filtering and API operations.
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service.
(dict) --
This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.
Namespace (string) --
The namespace of the metric. For more information, see CloudWatchNamespaces.
MetricType (string) --
Used to display the appropriate statistics in the CloudWatch console.
Dimensions (list) --
An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
MetricName (string) --
The name of the metric.
AccountId (string) --
Amazon Web Services account ID.
LogGroupReferences (list) --
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
"Type": "AWS::Resource"
"ResourceType": "AWS::Logs::LogGroup"
"Identifier": "name-of-log-group"
(dict) --
(string) --
(string) --
StartTime (datetime) --
The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
EndTime (datetime) --
The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
LogGroupReferences (list) --
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
"Type": "AWS::Resource"
"ResourceType": "AWS::Logs::LogGroup"
"Identifier": "name-of-log-group"
(dict) --
(string) --
(string) --
{'ServiceSummaries': {'ServiceGroups': [{'GroupIdentifier': 'string',
'GroupName': 'string',
'GroupSource': 'string',
'GroupValue': 'string'}]}}
Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
See also: AWS API Documentation
Request Syntax
client.list_services(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string',
IncludeLinkedAccounts=True|False,
AwsAccountId='string'
)
datetime
[REQUIRED]
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
datetime
[REQUIRED]
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
Your requested start time will be rounded to the nearest hour.
integer
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
string
Include this value, if it was returned by the previous operation, to get the next set of services.
boolean
If you are using this operation in a monitoring account, specify true to include services from source accounts in the returned data.
string
Amazon Web Services Account ID.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceSummaries': [
{
'KeyAttributes': {
'string': 'string'
},
'AttributeMaps': [
{
'string': 'string'
},
],
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string',
'AccountId': 'string'
},
],
'ServiceGroups': [
{
'GroupName': 'string',
'GroupValue': 'string',
'GroupSource': 'string',
'GroupIdentifier': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StartTime (datetime) --
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
EndTime (datetime) --
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
ServiceSummaries (list) --
An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.
(dict) --
This structure contains information about one of your services that was discovered by Application Signals
KeyAttributes (dict) --
This is a string-to-string map that help identify the objects discovered by Application Signals. 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 belongs to.
(string) --
(string) --
AttributeMaps (list) --
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
PlatformType defines the hosted-in platform.
EKS.Cluster is the name of the Amazon EKS cluster.
K8s.Cluster is the name of the self-hosted Kubernetes cluster.
K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
EC2.InstanceId is the ID of the Amazon EC2 instance.
Host is the name of the host, for all platform types.
Application attributes contain information about the application.
AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.
AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
(dict) --
(string) --
(string) --
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service.
(dict) --
This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.
Namespace (string) --
The namespace of the metric. For more information, see CloudWatchNamespaces.
MetricType (string) --
Used to display the appropriate statistics in the CloudWatch console.
Dimensions (list) --
An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
MetricName (string) --
The name of the metric.
AccountId (string) --
Amazon Web Services account ID.
ServiceGroups (list) --
An array of service groups that this service belongs to, based on the configured grouping attributes.
(dict) --
A structure that represents a logical grouping of services based on shared attributes such as business unit, environment, or entry point.
GroupName (string) --
The name of the grouping attribute, such as BusinessUnit or Environment.
GroupValue (string) --
The value of the grouping attribute for this service, such as Payments or Production.
GroupSource (string) --
The source of the grouping attribute, such as TAG, OTEL, or DEFAULT.
GroupIdentifier (string) --
A unique identifier for this grouping attribute value, used for filtering and API operations.
NextToken (string) --
Include this value in your next use of this API to get next set of services.
{'SliConfig': {'SliMetricConfig': {'MetricName': 'string'}}}
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.
See also: AWS API Documentation
Request Syntax
client.update_service_level_objective(
Id='string',
Description='string',
SliConfig={
'SliMetricConfig': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'MetricName': 'string',
'Statistic': 'string',
'PeriodSeconds': 123,
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
RequestBasedSliConfig={
'RequestBasedSliMetricConfig': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'TotalRequestCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'MonitoredRequestCountMetric': {
'GoodCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'BadCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
]
},
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
Goal={
'Interval': {
'RollingInterval': {
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
},
BurnRateConfigurations=[
{
'LookBackWindowMinutes': 123
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) or name of the service level objective that you want to update.
string
An optional description for the SLO.
dict
If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
SliMetricConfig (dict) -- [REQUIRED]
Use this structure to specify the metric to be used for the SLO.
KeyAttributes (dict) --
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::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.
(string) --
(string) --
OperationName (string) --
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
MetricType (string) --
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 (string) --
The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.
Statistic (string) --
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 (integer) --
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.
MetricDataQueries (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) -- [REQUIRED]
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) -- [REQUIRED]
The name of the called operation in the dependency.
MetricThreshold (float) -- [REQUIRED]
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.
ComparisonOperator (string) -- [REQUIRED]
The arithmetic operation to use when comparing the specified metric to the threshold.
dict
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both SliConfig and RequestBasedSliConfig in the same operation.
RequestBasedSliMetricConfig (dict) -- [REQUIRED]
Use this structure to specify the metric to be used for the SLO.
KeyAttributes (dict) --
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::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.
(string) --
(string) --
OperationName (string) --
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
MetricType (string) --
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 (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
MonitoredRequestCountMetric (dict) --
Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
GoodCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
BadCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) -- [REQUIRED]
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) -- [REQUIRED]
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
Period (integer) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) -- [REQUIRED]
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) -- [REQUIRED]
The name of the called operation in the dependency.
MetricThreshold (float) --
The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the Latency metric.
ComparisonOperator (string) --
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.
dict
A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.
Interval (dict) --
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
If you omit this parameter, a rolling interval of 7 days is used.
RollingInterval (dict) --
If the interval is a rolling interval, this structure contains the interval specifications.
DurationUnit (string) -- [REQUIRED]
Specifies the rolling interval unit.
Duration (integer) -- [REQUIRED]
Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.
CalendarInterval (dict) --
If the interval is a calendar interval, this structure contains the interval specifications.
StartTime (datetime) -- [REQUIRED]
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 (string) -- [REQUIRED]
Specifies the calendar interval unit.
Duration (integer) -- [REQUIRED]
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.
AttainmentGoal (float) --
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 (float) --
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.
list
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.
(dict) --
This object 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. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.
For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:
burn rate = error rate over the look-back window / (100% - attainment goal percentage)
For more information about burn rates, see Calculate burn rates.
LookBackWindowMinutes (integer) -- [REQUIRED]
The number of minutes to use as the look-back window.
dict
Response Syntax
{
'Slo': {
'Arn': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Sli': {
'SliMetric': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'RequestBasedSli': {
'RequestBasedSliMetric': {
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'MetricType': 'LATENCY'|'AVAILABILITY',
'TotalRequestCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'MonitoredRequestCountMetric': {
'GoodCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
'BadCountMetric': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': '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'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
]
},
'DependencyConfig': {
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string'
}
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'EvaluationType': 'PeriodBased'|'RequestBased',
'Goal': {
'Interval': {
'RollingInterval': {
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'MINUTE'|'HOUR'|'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
},
'BurnRateConfigurations': [
{
'LookBackWindowMinutes': 123
},
],
'MetricSourceType': 'ServiceOperation'|'CloudWatchMetric'|'ServiceDependency'
}
}
Response Structure
(dict) --
Slo (dict) --
A structure that contains information about the SLO that you just updated.
Arn (string) --
The ARN of this SLO.
Name (string) --
The name of this SLO.
Description (string) --
The description that you created for this SLO.
CreatedTime (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.
LastUpdatedTime (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.
Sli (dict) --
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
SliMetric (dict) --
A structure that contains information about the metric that the SLO monitors.
KeyAttributes (dict) --
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.
(string) --
(string) --
OperationName (string) --
If the SLO monitors a specific operation of the service, this field displays that operation name.
MetricType (string) --
If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
MetricDataQueries (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) --
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) --
The name of the called operation in the dependency.
MetricThreshold (float) --
The value that the SLI metric is compared to.
ComparisonOperator (string) --
The arithmetic operation used when comparing the specified metric to the threshold.
RequestBasedSli (dict) --
A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
RequestBasedSliMetric (dict) --
A structure that contains information about the metric that the SLO monitors.
KeyAttributes (dict) --
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.
(string) --
(string) --
OperationName (string) --
If the SLO monitors a specific operation of the service, this field displays that operation name.
MetricType (string) --
If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.
TotalRequestCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
MonitoredRequestCountMetric (dict) --
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.
GoodCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
BadCountMetric (list) --
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.
(dict) --
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Id (string) --
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 (dict) --
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
Metric (dict) --
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric. For more information, see Namespaces.
MetricName (string) --
The name of the metric to use.
Dimensions (list) --
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
(dict) --
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Name (string) --
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 (string) --
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.
Period (integer) --
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 (string) --
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 (string) --
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.
Expression (string) --
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 (string) --
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 (boolean) --
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 (integer) --
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 that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
AccountId (string) --
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.
DependencyConfig (dict) --
Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
DependencyKeyAttributes (dict) --
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 belongs to.
(string) --
(string) --
DependencyOperationName (string) --
The name of the called operation in the dependency.
MetricThreshold (float) --
This value is the threshold that the observed metric values of the SLI metric are compared to.
ComparisonOperator (string) --
The arithmetic operation used when comparing the specified metric to the threshold.
EvaluationType (string) --
Displays whether this is a period-based SLO or a request-based SLO.
Goal (dict) --
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
Interval (dict) --
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
If you omit this parameter, a rolling interval of 7 days is used.
RollingInterval (dict) --
If the interval is a rolling interval, this structure contains the interval specifications.
DurationUnit (string) --
Specifies the rolling interval unit.
Duration (integer) --
Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days.
CalendarInterval (dict) --
If the interval is a calendar interval, this structure contains the interval specifications.
StartTime (datetime) --
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 (string) --
Specifies the calendar interval unit.
Duration (integer) --
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.
AttainmentGoal (float) --
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 (float) --
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.
BurnRateConfigurations (list) --
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.
(dict) --
This object 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. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.
For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:
burn rate = error rate over the look-back window / (100% - attainment goal percentage)
For more information about burn rates, see Calculate burn rates.
LookBackWindowMinutes (integer) --
The number of minutes to use as the look-back window.
MetricSourceType (string) --
Displays the SLI metric source type for this SLO. Supported types are:
Service operation
Service dependency
CloudWatch metric