2024/06/10 - Amazon CloudWatch Application Signals - 15 new api methods
Changes This is the initial SDK release for Amazon CloudWatch Application Signals. Amazon CloudWatch Application Signals provides curated application performance monitoring for developers to monitor and troubleshoot application health using pre-built dashboards and Service Level Objectives.
Returns information about one SLO created in the account.
See also: AWS API Documentation
Request Syntax
client.get_service_level_objective(
Id='string'
)
string
[REQUIRED]
The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.
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'
},
]
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'Goal': {
'Interval': {
'RollingInterval': {
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
}
}
}
Response Structure
(dict) --
Slo (dict) --
A structure containing the information about the SLO.
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.
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 operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
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.
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. An attainment goal is the ratio 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 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.
Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.
See also: AWS API Documentation
Request Syntax
client.list_service_dependencies(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
},
MaxResults=123,
NextToken='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
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
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) --
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 service dependencies.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceDependencies': [
{
'OperationName': 'string',
'DependencyKeyAttributes': {
'string': 'string'
},
'DependencyOperationName': 'string',
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': '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
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
ServiceDependencies (list) --
An array, where each object in the array contains information about one of the dependencies of this service.
(dict) --
This structure contains information about one dependency of this service.
OperationName (string) --
The name of the operation in this service that calls the dependency.
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.
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service dependency that was discovered by Application Signals.
(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.
NextToken (string) --
Include this value in your next use of this API to get next set of service dependencies.
Returns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.
See also: AWS API Documentation
Request Syntax
client.list_service_operations(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
},
MaxResults=123,
NextToken='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
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
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) --
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 service operations.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceOperations': [
{
'Name': 'string',
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': '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
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
ServiceOperations (list) --
An array of structures that each contain information about one operation of this service.
(dict) --
This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent.
Name (string) --
The name of the operation, discovered by Application Signals.
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service operation that was discovered by Application Signals.
(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.
NextToken (string) --
Include this value in your next use of this API to get next set of service operations.
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
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.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.
The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
list
[REQUIRED]
The list of key-value pairs to associate with the alarm.
(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.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of SLOs created in this account.
See also: AWS API Documentation
Request Syntax
client.list_service_level_objectives(
KeyAttributes={
'string': 'string'
},
OperationName='string',
MaxResults=123,
NextToken='string'
)
dict
You can use this optional field to specify which services you want to retrieve SLO information for.
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) --
string
The name of the operation that this SLO is associated with.
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 service level objectives.
dict
Response Syntax
{
'SloSummaries': [
{
'Arn': 'string',
'Name': 'string',
'KeyAttributes': {
'string': 'string'
},
'OperationName': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SloSummaries (list) --
An array of structures, where each structure contains information about one SLO.
(dict) --
A structure that contains information about one service level objective (SLO) created in Application Signals.
Arn (string) --
The ARN of this service level objective.
Name (string) --
The name of the service level objective.
KeyAttributes (dict) --
This is a string-to-string map. It can include the following fields.
Type designates the type of object this service level objective is for.
ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.
Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.
Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.
Environment specifies the location where this object is hosted, or what it belongs to.
(string) --
(string) --
OperationName (string) --
If this service level objective is specific to a single operation, this field displays the name of that operation.
CreatedTime (datetime) --
The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
NextToken (string) --
Include this value in your next use of this API to get next set of service level objectives.
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
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',
'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'
},
]
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
Goal={
'Interval': {
'RollingInterval': {
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
}
)
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
A structure that contains 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.
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 operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
MetricThreshold (float) -- [REQUIRED]
The value that the SLI metric is compared to.
ComparisonOperator (string) -- [REQUIRED]
The arithmetic operation to use when comparing the specified metric to the threshold.
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. An attainment goal is the ratio 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 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.
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'
},
]
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'Goal': {
'Interval': {
'RollingInterval': {
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
}
}
}
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.
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 operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
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.
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. An attainment goal is the ratio 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 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.
Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
See also: AWS API Documentation
Request Syntax
client.list_service_dependents(
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
KeyAttributes={
'string': 'string'
},
MaxResults=123,
NextToken='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
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
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) --
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 service dependents.
dict
Response Syntax
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ServiceDependents': [
{
'OperationName': 'string',
'DependentKeyAttributes': {
'string': 'string'
},
'DependentOperationName': 'string',
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': '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
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
ServiceDependents (list) --
An array, where each object in the array contains information about one of the dependents of this service.
(dict) --
This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
OperationName (string) --
If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
DependentKeyAttributes (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) --
DependentOperationName (string) --
If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.
MetricReferences (list) --
An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.
(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.
NextToken (string) --
Include this value in your next use of this API to get next set of service dependents.
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the following permissions:
xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups
After completing this step, you still need to instrument your Java and Python applications to send data to Application Signals. For more information, see Enabling Application Signals.
See also: AWS API Documentation
Request Syntax
client.start_discovery()
dict
Response Syntax
{}
Response Structure
(dict) --
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'
)
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
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
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.
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'
},
]
},
],
'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
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
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 discoverd 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.
Applciation 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.
NextToken (string) --
Include this value in your next use of this API to get next set of services.
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.
When you create an SLO, you set an attainment goal for it. An attainment goal is the ratio 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.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the number of periods or amount of time that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. 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.
When you call this 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
You can easily 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.
For more information about SLOs, see Service level objectives (SLOs).
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',
'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'
},
]
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
Goal={
'Interval': {
'RollingInterval': {
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A name for this SLO.
string
An optional description for this SLO.
dict
[REQUIRED]
A structure that contains information about what service and what performance metric that 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.
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 operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
MetricThreshold (float) -- [REQUIRED]
The value that the SLI metric is compared to.
ComparisonOperator (string) -- [REQUIRED]
The arithmetic operation to use when comparing the specified metric to the threshold.
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. An attainment goal is the ratio 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 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.
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'
},
]
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'Goal': {
'Interval': {
'RollingInterval': {
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
}
}
}
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.
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 operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
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.
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. An attainment goal is the ratio 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 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.
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
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
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'
},
],
'MetricReferences': [
{
'Namespace': 'string',
'MetricType': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'MetricName': 'string'
},
]
},
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
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.
Applciation 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.
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.
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.
Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.
The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
list
[REQUIRED]
The list of tag keys to remove from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.
The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The list of tag keys and values associated with the resource you specified.
(dict) --
A key-value pair associated with a resource. Tags can help you organize and categorize your resources.
Key (string) --
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) --
The value for the specified tag key.
Use this operation to retrieve one or more service level objective (SLO) budget reports.
An error budget is the amount of time in unhealthy periods that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.
Budget reports include a health indicator, the attainment value, and remaining budget.
For more information about SLO error budgets, see SLO concepts.
See also: AWS API Documentation
Request Syntax
client.batch_get_service_level_objective_budget_report(
Timestamp=datetime(2015, 1, 1),
SloIds=[
'string',
]
)
datetime
[REQUIRED]
The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
list
[REQUIRED]
An array containing the IDs of the service level objectives that you want to include in the report.
(string) --
dict
Response Syntax
{
'Timestamp': datetime(2015, 1, 1),
'Reports': [
{
'Arn': 'string',
'Name': 'string',
'BudgetStatus': 'OK'|'WARNING'|'BREACHED'|'INSUFFICIENT_DATA',
'Attainment': 123.0,
'TotalBudgetSeconds': 123,
'BudgetSecondsRemaining': 123,
'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'
},
]
},
'MetricThreshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualTo'|'GreaterThan'|'LessThan'|'LessThanOrEqualTo'
},
'Goal': {
'Interval': {
'RollingInterval': {
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
},
'CalendarInterval': {
'StartTime': datetime(2015, 1, 1),
'DurationUnit': 'DAY'|'MONTH',
'Duration': 123
}
},
'AttainmentGoal': 123.0,
'WarningThreshold': 123.0
}
},
],
'Errors': [
{
'Name': 'string',
'Arn': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
Timestamp (datetime) --
The date and time that the report is for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Reports (list) --
An array of structures, where each structure is one budget report.
(dict) --
A structure containing an SLO budget report that you have requested.
Arn (string) --
The ARN of the SLO that this report is for.
Name (string) --
The name of the SLO that this report is for.
BudgetStatus (string) --
The status of this SLO, as it relates to the error budget for the entire time interval.
OK means that the SLO had remaining budget above the warning threshold, as of the time that you specified in TimeStamp.
WARNING means that the SLO's remaining budget was below the warning threshold, as of the time that you specified in TimeStamp.
BREACHED means that the SLO's budget was exhausted, as of the time that you specified in TimeStamp.
INSUFFICIENT_DATA means that the specifed start and end times were before the SLO was created, or that attainment data is missing.
Attainment (float) --
A number between 0 and 100 that represents the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
TotalBudgetSeconds (integer) --
The total number of seconds in the error budget for the interval.
BudgetSecondsRemaining (integer) --
The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING status.
Sli (dict) --
A structure that contains information about the performance metric that this SLO monitors.
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 operatiion in a monitoring account, use this to specify which source account to retrieve this metric from.
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.
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. An attainment goal is the ratio 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 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.
Errors (list) --
An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.
(dict) --
A structure containing information about one error that occurred during a BatchGetServiceLevelObjectiveBudgetReport operation.
Name (string) --
The name of the SLO that this error is related to.
Arn (string) --
The ARN of the SLO that this error is related to.
ErrorCode (string) --
The error code for this error.
ErrorMessage (string) --
The message for this error.
Deletes the specified service level objective.
See also: AWS API Documentation
Request Syntax
client.delete_service_level_objective(
Id='string'
)
string
[REQUIRED]
The ARN or name of the service level objective to delete.
dict
Response Syntax
{}
Response Structure
(dict) --