Table of Contents
CloudWatch.
Client
¶A low-level client representing Amazon CloudWatch
Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
import boto3
client = boto3.client('cloudwatch')
These are the available methods:
can_paginate()
close()
delete_alarms()
delete_anomaly_detector()
delete_dashboards()
delete_insight_rules()
delete_metric_stream()
describe_alarm_history()
describe_alarms()
describe_alarms_for_metric()
describe_anomaly_detectors()
describe_insight_rules()
disable_alarm_actions()
disable_insight_rules()
enable_alarm_actions()
enable_insight_rules()
get_dashboard()
get_insight_rule_report()
get_metric_data()
get_metric_statistics()
get_metric_stream()
get_metric_widget_image()
get_paginator()
get_waiter()
list_dashboards()
list_managed_insight_rules()
list_metric_streams()
list_metrics()
list_tags_for_resource()
put_anomaly_detector()
put_composite_alarm()
put_dashboard()
put_insight_rule()
put_managed_insight_rules()
put_metric_alarm()
put_metric_data()
put_metric_stream()
set_alarm_state()
start_metric_streams()
stop_metric_streams()
tag_resource()
untag_resource()
can_paginate
(operation_name)¶Check if an operation can be paginated.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.True
if the operation can be paginated,
False
otherwise.close
()¶Closes underlying endpoint connections.
delete_alarms
(**kwargs)¶Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
In the event of an error, no alarms are deleted.
Note
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
See also: AWS API Documentation
Request Syntax
response = client.delete_alarms(
AlarmNames=[
'string',
]
)
[REQUIRED]
The alarms to be deleted.
Exceptions
CloudWatch.Client.exceptions.ResourceNotFound
delete_anomaly_detector
(**kwargs)¶Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_anomaly_detector(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Stat='string',
SingleMetricAnomalyDetector={
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'string'
},
MetricMathAnomalyDetector={
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
]
}
)
The metric dimensions associated with the anomaly detection model to delete.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
A single metric anomaly detector to be deleted.
When using SingleMetricAnomalyDetector
, you cannot include the following parameters in the same operation:
Dimensions
,MetricName
Namespace
Stat
MetricMathAnomalyDetector
parameters of DeleteAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the SingleMetricAnomalyDetector
property.
The namespace of the metric to create the anomaly detection model for.
The name of the metric to create the anomaly detection model for.
The metric dimensions to create the anomaly detection model for.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The statistic to use for the metric and anomaly detection model.
The metric math anomaly detector to be deleted.
When using MetricMathAnomalyDetector
, you cannot include following parameters in the same operation:
Dimensions
,MetricName
Namespace
Stat
SingleMetricAnomalyDetector
parameters of DeleteAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the MetricMathAnomalyDetector
property.
An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries
gets a metric or performs a math expression. One item in MetricDataQueries
is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData
to True
for this object in the array. For all other expressions and metrics, set ReturnData
to False
. The designated expression must return a single time series.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric. This is a required field.
The dimensions for the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The granularity, in seconds, of the returned data points. 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:
The statistic to return. It can include any CloudWatch statistic or extended statistic.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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.
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 .
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
dict
Response Syntax
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.ResourceNotFoundException
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
delete_dashboards
(**kwargs)¶Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_dashboards(
DashboardNames=[
'string',
]
)
[REQUIRED]
The dashboards to be deleted. This parameter is required.
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.DashboardNotFoundError
CloudWatch.Client.exceptions.InternalServiceFault
delete_insight_rules
(**kwargs)¶Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
See also: AWS API Documentation
Request Syntax
response = client.delete_insight_rules(
RuleNames=[
'string',
]
)
[REQUIRED]
An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules .
{
'Failures': [
{
'FailureResource': 'string',
'ExceptionType': 'string',
'FailureCode': 'string',
'FailureDescription': 'string'
},
]
}
Response Structure
An array listing the rules that could not be deleted. You cannot delete built-in rules.
This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
The specified rule that could not be deleted.
The type of error.
The code of the error.
A description of the error.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
delete_metric_stream
(**kwargs)¶Permanently deletes the metric stream that you specify.
See also: AWS API Documentation
Request Syntax
response = client.delete_metric_stream(
Name='string'
)
[REQUIRED]
The name of the metric stream to delete.
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
describe_alarm_history
(**kwargs)¶Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory
permission that is scoped to *
. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory
permission has a narrower scope.
See also: AWS API Documentation
Request Syntax
response = client.describe_alarm_history(
AlarmName='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
HistoryItemType='ConfigurationUpdate'|'StateUpdate'|'Action',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
MaxRecords=123,
NextToken='string',
ScanBy='TimestampDescending'|'TimestampAscending'
)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
TimestampDescending
to have the newest event history returned first, and specify TimestampAscending
to have the oldest history returned first.dict
Response Syntax
{
'AlarmHistoryItems': [
{
'AlarmName': 'string',
'AlarmType': 'CompositeAlarm'|'MetricAlarm',
'Timestamp': datetime(2015, 1, 1),
'HistoryItemType': 'ConfigurationUpdate'|'StateUpdate'|'Action',
'HistorySummary': 'string',
'HistoryData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AlarmHistoryItems (list) --
The alarm histories, in JSON format.
(dict) --
Represents the history of a specific alarm.
AlarmName (string) --
The descriptive name for the alarm.
AlarmType (string) --
The type of alarm, either metric alarm or composite alarm.
Timestamp (datetime) --
The time stamp for the alarm history item.
HistoryItemType (string) --
The type of alarm history item.
HistorySummary (string) --
A summary of the alarm history, in text format.
HistoryData (string) --
Data about the alarm, in JSON format.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Exceptions
CloudWatch.Client.exceptions.InvalidNextToken
describe_alarms
(**kwargs)¶Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.
To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms
permission that is scoped to *
. You can't return information about composite alarms if your cloudwatch:DescribeAlarms
permission has a narrower scope.
See also: AWS API Documentation
Request Syntax
response = client.describe_alarms(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
ChildrenOfAlarmName='string',
ParentsOfAlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string'
)
The names of the alarms to retrieve information about.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
dict
Response Syntax
{
'CompositeAlarms': [
{
'ActionsEnabled': True|False,
'AlarmActions': [
'string',
],
'AlarmArn': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'AlarmDescription': 'string',
'AlarmName': 'string',
'AlarmRule': 'string',
'InsufficientDataActions': [
'string',
],
'OKActions': [
'string',
],
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateTransitionedTimestamp': datetime(2015, 1, 1),
'ActionsSuppressedBy': 'WaitPeriod'|'ExtensionPeriod'|'Alarm',
'ActionsSuppressedReason': 'string',
'ActionsSuppressor': 'string',
'ActionsSuppressorWaitPeriod': 123,
'ActionsSuppressorExtensionPeriod': 123
},
],
'MetricAlarms': [
{
'AlarmName': 'string',
'AlarmArn': 'string',
'AlarmDescription': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'ActionsEnabled': True|False,
'OKActions': [
'string',
],
'AlarmActions': [
'string',
],
'InsufficientDataActions': [
'string',
],
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
'ExtendedStatistic': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Period': 123,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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',
'EvaluationPeriods': 123,
'DatapointsToAlarm': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'|'LessThanLowerOrGreaterThanUpperThreshold'|'LessThanLowerThreshold'|'GreaterThanUpperThreshold',
'TreatMissingData': 'string',
'EvaluateLowSampleCountPercentile': 'string',
'Metrics': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
],
'ThresholdMetricId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CompositeAlarms (list) --
The information about any composite alarms returned by the operation.
(dict) --
The details about a composite alarm.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
AlarmDescription (string) --
The description of the alarm.
AlarmName (string) --
The name of the alarm.
AlarmRule (string) --
The rule that this alarm uses to evaluate its alarm state.
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
OKActions (list) --
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
Tracks the timestamp of any state update, even if StateValue
doesn't change.
StateValue (string) --
The state value for the alarm.
StateTransitionedTimestamp (datetime) --
The timestamp of the last change to the alarm's StateValue
.
ActionsSuppressedBy (string) --
When the value is ALARM
, it means that the actions are suppressed because the suppressor alarm is in ALARM
When the value is WaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM
state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM
state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod
. After this time, the composite alarm performs its actions.
ActionsSuppressedReason (string) --
Captures the reason for action suppression.
ActionsSuppressor (string) --
Actions will be suppressed if the suppressor alarm is in the ALARM
state. ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
ActionsSuppressorWaitPeriod (integer) --
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM
state. After this time, the composite alarm performs its actions.
Warning
WaitPeriod
is required only when ActionsSuppressor
is specified.
ActionsSuppressorExtensionPeriod (integer) --
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM
state. After this time, the composite alarm performs its actions.
Warning
ExtensionPeriod
is required only when ActionsSuppressor
is specified.
MetricAlarms (list) --
The information about any metric alarms returned by the operation.
(dict) --
The details about a metric alarm.
AlarmName (string) --
The name of the alarm.
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmDescription (string) --
The description of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
OKActions (list) --
The actions to execute when this alarm transitions to the OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateValue (string) --
The state value for the alarm.
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm state.
MetricName (string) --
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
Namespace (string) --
The namespace of the metric associated with the alarm.
Statistic (string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic
.
ExtendedStatistic (string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
Dimensions (list) --
The dimensions for the metric associated with the alarm.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The period, in seconds, over which the statistic is applied.
Unit (string) --
The unit of the metric associated with the alarm.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm (integer) --
The number of data points that must be breaching to trigger the alarm.
Threshold (float) --
The value to compare with the specified statistic.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
TreatMissingData (string) --
Sets how this alarm is to handle missing data points. The valid values are breaching
, notBreaching
, ignore
, and missing
. For more information, see Configuring how CloudWatch alarms treat missing data .
If this parameter is omitted, the default behavior of missing
is used.
EvaluateLowSampleCountPercentile (string) --
Used only for alarms based on percentiles. If ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
Metrics (list) --
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData
set to true.
(dict) --
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Id (string) --
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
MetricStat (dict) --
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
Metric (dict) --
The metric to return, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The granularity, in seconds, of the returned data points. 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:
Stat (string) --
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit (string) --
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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 either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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) --
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
Period (integer) --
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
AccountId (string) --
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
ThresholdMetricId (string) --
In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Exceptions
CloudWatch.Client.exceptions.InvalidNextToken
describe_alarms_for_metric
(**kwargs)¶Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.
See also: AWS API Documentation
Request Syntax
response = client.describe_alarms_for_metric(
MetricName='string',
Namespace='string',
Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
ExtendedStatistic='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Period=123,
Unit='Seconds'|'Microseconds'|'Milliseconds'|'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'
)
[REQUIRED]
The name of the metric.
[REQUIRED]
The namespace of the metric.
ExtendedStatistics
.The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
dict
Response Syntax
{
'MetricAlarms': [
{
'AlarmName': 'string',
'AlarmArn': 'string',
'AlarmDescription': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'ActionsEnabled': True|False,
'OKActions': [
'string',
],
'AlarmActions': [
'string',
],
'InsufficientDataActions': [
'string',
],
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
'ExtendedStatistic': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Period': 123,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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',
'EvaluationPeriods': 123,
'DatapointsToAlarm': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'|'LessThanLowerOrGreaterThanUpperThreshold'|'LessThanLowerThreshold'|'GreaterThanUpperThreshold',
'TreatMissingData': 'string',
'EvaluateLowSampleCountPercentile': 'string',
'Metrics': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
],
'ThresholdMetricId': 'string'
},
]
}
Response Structure
(dict) --
MetricAlarms (list) --
The information for each alarm with the specified metric.
(dict) --
The details about a metric alarm.
AlarmName (string) --
The name of the alarm.
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmDescription (string) --
The description of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
OKActions (list) --
The actions to execute when this alarm transitions to the OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateValue (string) --
The state value for the alarm.
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm state.
MetricName (string) --
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
Namespace (string) --
The namespace of the metric associated with the alarm.
Statistic (string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic
.
ExtendedStatistic (string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
Dimensions (list) --
The dimensions for the metric associated with the alarm.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The period, in seconds, over which the statistic is applied.
Unit (string) --
The unit of the metric associated with the alarm.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm (integer) --
The number of data points that must be breaching to trigger the alarm.
Threshold (float) --
The value to compare with the specified statistic.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
TreatMissingData (string) --
Sets how this alarm is to handle missing data points. The valid values are breaching
, notBreaching
, ignore
, and missing
. For more information, see Configuring how CloudWatch alarms treat missing data .
If this parameter is omitted, the default behavior of missing
is used.
EvaluateLowSampleCountPercentile (string) --
Used only for alarms based on percentiles. If ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
Metrics (list) --
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData
set to true.
(dict) --
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Id (string) --
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
MetricStat (dict) --
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
Metric (dict) --
The metric to return, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The granularity, in seconds, of the returned data points. 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:
Stat (string) --
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit (string) --
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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 either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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) --
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
Period (integer) --
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
AccountId (string) --
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
ThresholdMetricId (string) --
In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
describe_anomaly_detectors
(**kwargs)¶Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH
to the AnomalyDetectorTypes
array. This will return all metric math anomaly detectors in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_anomaly_detectors(
NextToken='string',
MaxResults=123,
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
AnomalyDetectorTypes=[
'SINGLE_METRIC'|'METRIC_MATH',
]
)
The maximum number of results to return in one operation. The maximum value that you can specify is 100.
To retrieve the remaining results, make another call with the returned NextToken
value.
Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The anomaly detector types to request when using DescribeAnomalyDetectorsInput
. If empty, defaults to SINGLE_METRIC
.
dict
Response Syntax
{
'AnomalyDetectors': [
{
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'string',
'Configuration': {
'ExcludedTimeRanges': [
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
'MetricTimezone': 'string'
},
'StateValue': 'PENDING_TRAINING'|'TRAINED_INSUFFICIENT_DATA'|'TRAINED',
'SingleMetricAnomalyDetector': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'string'
},
'MetricMathAnomalyDetector': {
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AnomalyDetectors (list) --
The list of anomaly detection models returned by the operation.
(dict) --
An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.
Namespace (string) --
The namespace of the metric associated with the anomaly detection model.
MetricName (string) --
The name of the metric associated with the anomaly detection model.
Dimensions (list) --
The metric dimensions associated with the anomaly detection model.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Stat (string) --
The statistic associated with the anomaly detection model.
Configuration (dict) --
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.
ExcludedTimeRanges (list) --
An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.
(dict) --
Specifies one range of days or times to exclude from use for training an anomaly detection model.
StartTime (datetime) --
The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss
. For example, 2019-07-01T23:59:59
.
EndTime (datetime) --
The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss
. For example, 2019-07-01T23:59:59
.
MetricTimezone (string) --
The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.
To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .
StateValue (string) --
The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
SingleMetricAnomalyDetector (dict) --
The CloudWatch metric and statistic for this anomaly detector.
Namespace (string) --
The namespace of the metric to create the anomaly detection model for.
MetricName (string) --
The name of the metric to create the anomaly detection model for.
Dimensions (list) --
The metric dimensions to create the anomaly detection model for.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Stat (string) --
The statistic to use for the metric and anomaly detection model.
MetricMathAnomalyDetector (dict) --
The CloudWatch metric math expression for this anomaly detector.
MetricDataQueries (list) --
An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries
gets a metric or performs a math expression. One item in MetricDataQueries
is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData
to True
for this object in the array. For all other expressions and metrics, set ReturnData
to False
. The designated expression must return a single time series.
(dict) --
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Id (string) --
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
MetricStat (dict) --
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
Metric (dict) --
The metric to return, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The granularity, in seconds, of the returned data points. 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:
Stat (string) --
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit (string) --
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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 either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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) --
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
Period (integer) --
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
AccountId (string) --
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
NextToken (string) --
A token that you can use in a subsequent operation to retrieve the next set of results.
Exceptions
CloudWatch.Client.exceptions.InvalidNextToken
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
describe_insight_rules
(**kwargs)¶Returns a list of all the Contributor Insights rules in your account.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data .
See also: AWS API Documentation
Request Syntax
response = client.describe_insight_rules(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'InsightRules': [
{
'Name': 'string',
'State': 'string',
'Schema': 'string',
'Definition': 'string',
'ManagedRule': True|False
},
]
}
Response Structure
(dict) --
NextToken (string) --
If this parameter is present, it is a token that marks the start of the next batch of returned results.
InsightRules (list) --
The rules returned by the operation.
(dict) --
This structure contains the definition for a Contributor Insights rule. For more information about this rule, see`Using Constributor Insights to analyze high-cardinality data <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html>`__ in the Amazon CloudWatch User Guide .
Name (string) --
The name of the rule.
State (string) --
Indicates whether the rule is enabled or disabled.
Schema (string) --
For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}
. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
Definition (string) --
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax .
ManagedRule (boolean) --
An optional built-in rule that Amazon Web Services manages.
Exceptions
CloudWatch.Client.exceptions.InvalidNextToken
disable_alarm_actions
(**kwargs)¶Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
See also: AWS API Documentation
Request Syntax
response = client.disable_alarm_actions(
AlarmNames=[
'string',
]
)
[REQUIRED]
The names of the alarms.
disable_insight_rules
(**kwargs)¶Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
See also: AWS API Documentation
Request Syntax
response = client.disable_insight_rules(
RuleNames=[
'string',
]
)
[REQUIRED]
An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules .
{
'Failures': [
{
'FailureResource': 'string',
'ExceptionType': 'string',
'FailureCode': 'string',
'FailureDescription': 'string'
},
]
}
Response Structure
An array listing the rules that could not be disabled. You cannot disable built-in rules.
This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
The specified rule that could not be deleted.
The type of error.
The code of the error.
A description of the error.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
enable_alarm_actions
(**kwargs)¶Enables the actions for the specified alarms.
See also: AWS API Documentation
Request Syntax
response = client.enable_alarm_actions(
AlarmNames=[
'string',
]
)
[REQUIRED]
The names of the alarms.
enable_insight_rules
(**kwargs)¶Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
See also: AWS API Documentation
Request Syntax
response = client.enable_insight_rules(
RuleNames=[
'string',
]
)
[REQUIRED]
An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules .
{
'Failures': [
{
'FailureResource': 'string',
'ExceptionType': 'string',
'FailureCode': 'string',
'FailureDescription': 'string'
},
]
}
Response Structure
An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
The specified rule that could not be deleted.
The type of error.
The code of the error.
A description of the error.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.LimitExceededException
get_dashboard
(**kwargs)¶Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard
, and then use the data returned within DashboardBody
as the template for the new dashboard when you call PutDashboard
to create the copy.
See also: AWS API Documentation
Request Syntax
response = client.get_dashboard(
DashboardName='string'
)
[REQUIRED]
The name of the dashboard to be described.
{
'DashboardArn': 'string',
'DashboardBody': 'string',
'DashboardName': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the dashboard.
The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody
syntax, see Dashboard Body Structure and Syntax .
The name of the dashboard.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.DashboardNotFoundError
CloudWatch.Client.exceptions.InternalServiceFault
get_insight_rule_report
(**kwargs)¶This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
UniqueContributors
-- the number of unique contributors for each data point.MaxContributorValue
-- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph. If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value
, during that period.SampleCount
-- the number of data points matched by the rule.Sum
-- the sum of the values from all contributors during the time period represented by that data point.Minimum
-- the minimum value from a single observation during the time period represented by that data point.Maximum
-- the maximum value from a single observation during the time period represented by that data point.Average
-- the average value from all contributors during the time period represented by that data point.See also: AWS API Documentation
Request Syntax
response = client.get_insight_rule_report(
RuleName='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Period=123,
MaxContributorCount=123,
Metrics=[
'string',
],
OrderBy='string'
)
[REQUIRED]
The name of the rule that you want to see data from.
[REQUIRED]
The start time of the data to use in the report. 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
.
[REQUIRED]
The end time of the data to use in the report. 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
.
[REQUIRED]
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint
results.
Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:
UniqueContributors
-- the number of unique contributors for each data point.MaxContributorValue
-- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph. If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value
, during that period.SampleCount
-- the number of data points matched by the rule.Sum
-- the sum of the values from all contributors during the time period represented by that data point.Minimum
-- the minimum value from a single observation during the time period represented by that data point.Maximum
-- the maximum value from a single observation during the time period represented by that data point.Average
-- the average value from all contributors during the time period represented by that data point.dict
Response Syntax
{
'KeyLabels': [
'string',
],
'AggregationStatistic': 'string',
'AggregateValue': 123.0,
'ApproximateUniqueCount': 123,
'Contributors': [
{
'Keys': [
'string',
],
'ApproximateAggregateValue': 123.0,
'Datapoints': [
{
'Timestamp': datetime(2015, 1, 1),
'ApproximateValue': 123.0
},
]
},
],
'MetricDatapoints': [
{
'Timestamp': datetime(2015, 1, 1),
'UniqueContributors': 123.0,
'MaxContributorValue': 123.0,
'SampleCount': 123.0,
'Average': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0
},
]
}
Response Structure
(dict) --
KeyLabels (list) --
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
AggregationStatistic (string) --
Specifies whether this rule aggregates contributor data by COUNT or SUM.
AggregateValue (float) --
The sum of the values from all individual contributors that match the rule.
ApproximateUniqueCount (integer) --
An approximate count of the unique contributors found by this rule in this time period.
Contributors (list) --
An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.
(dict) --
One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.
If the rule contains a single key, then each unique contributor is each unique value for this key.
For more information, see GetInsightRuleReport .
Keys (list) --
One of the log entry field keywords that is used to define contributors for this rule.
ApproximateAggregateValue (float) --
An approximation of the aggregate value that comes from this contributor.
Datapoints (list) --
An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
(dict) --
One data point related to one contributor.
For more information, see GetInsightRuleReport and InsightRuleContributor .
Timestamp (datetime) --
The timestamp of the data point.
ApproximateValue (float) --
The approximate value that this contributor added during this timestamp.
MetricDatapoints (list) --
A time series of metric data points that matches the time period in the rule request.
(dict) --
One data point from the metric time series returned in a Contributor Insights rule report.
For more information, see GetInsightRuleReport .
Timestamp (datetime) --
The timestamp of the data point.
UniqueContributors (float) --
The number of unique contributors who published data during this timestamp.
This statistic is returned only if you included it in the Metrics
array in your request.
MaxContributorValue (float) --
The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, so the identity of the max contributor could be different for each timestamp.
This statistic is returned only if you included it in the Metrics
array in your request.
SampleCount (float) --
The number of occurrences that matched the rule during this data point.
This statistic is returned only if you included it in the Metrics
array in your request.
Average (float) --
The average value from all contributors during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
Sum (float) --
The sum of the values from all contributors during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
Minimum (float) --
The minimum value from a single contributor during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
Maximum (float) --
The maximum value from a single occurence from a single contributor during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.ResourceNotFoundException
get_metric_data
(**kwargs)¶You can use the GetMetricData
API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData
operation that does not include a query can retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform metric math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
If you include a Metrics Insights query, each GetMetricData
operation can include only one query. But the same GetMetricData
operation can also retrieve other metrics. Metrics Insights queries can query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights .
Calls to the GetMetricData
API have a different pricing structure than calls to GetMetricStatistics
. For more information about pricing, see Amazon CloudWatch Pricing .
Amazon CloudWatch retains metric data as follows:
StorageResolution
of 1.Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit
in your request, 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.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
See also: AWS API Documentation
Request Syntax
response = client.get_metric_data(
MetricDataQueries=[
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string',
ScanBy='TimestampDescending'|'TimestampAscending',
MaxDatapoints=123,
LabelOptions={
'Timezone': 'string'
}
)
[REQUIRED]
The metric queries to be returned. A single GetMetricData
call can include as many as 500 MetricDataQuery
structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query, or a math expression to perform on retrieved data.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric. This is a required field.
The dimensions for the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The granularity, in seconds, of the returned data points. 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:
The statistic to return. It can include any CloudWatch statistic or extended statistic.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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.
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 .
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
[REQUIRED]
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime
and EndTime
values that align with the value of the metric's Period
and sync up with the beginning and end of an hour. For example, if the Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime
.
[REQUIRED]
The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime
and EndTime
values that align with the value of the metric's Period
and sync up with the beginning and end of an hour. For example, if the Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime
.
GetMetricData
operation, to get the next set of data points.TimestampDescending
returns the newest data first and paginates when the MaxDatapoints
limit is reached. TimestampAscending
returns the oldest data first and paginates when the MaxDatapoints
limit is reached.This structure includes the Timezone
parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.
The time zone to use for metric data return in this operation. The format is +
or -
followed by four digits. The first two digits indicate the number of hours ahead or behind of UTC, and the final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The default is +0000.
dict
Response Syntax
{
'MetricDataResults': [
{
'Id': 'string',
'Label': 'string',
'Timestamps': [
datetime(2015, 1, 1),
],
'Values': [
123.0,
],
'StatusCode': 'Complete'|'InternalError'|'PartialData',
'Messages': [
{
'Code': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string',
'Messages': [
{
'Code': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
MetricDataResults (list) --
The metrics that are returned, including the metric name, namespace, and dimensions.
(dict) --
A GetMetricData
call returns an array of MetricDataResult
structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.
Id (string) --
The short name you specified to represent this metric.
Label (string) --
The human-readable label associated with the data.
Timestamps (list) --
The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].
Values (list) --
The data points for the metric corresponding to Timestamps
. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].
StatusCode (string) --
The status of the returned data. Complete
indicates that all data points in the requested time range were returned. PartialData
means that an incomplete set of data points were returned. You can use the NextToken
value that was returned and repeat your request to get more data points. NextToken
is not returned if you are performing a math expression. InternalError
indicates that an error occurred. Retry your request using NextToken
, if present.
Messages (list) --
A list of messages with additional information about the data returned.
(dict) --
A message returned by the GetMetricData
API, including a code and a description.
If a cross-Region GetMetricData
operation fails with a code of Forbidden
and a value of Authentication too complex to retrieve cross region data
, you can correct the problem by running the GetMetricData
operation in the same Region where the metric data is.
Code (string) --
The error code or status code associated with the message.
Value (string) --
The message text.
NextToken (string) --
A token that marks the next batch of returned results.
Messages (list) --
Contains a message about this GetMetricData
operation, if the operation results in such a message. An example of a message that might be returned is Maximum number of allowed metrics exceeded
. If there is a message, as much of the operation as possible is still executed.
A message appears here only if it is related to the global GetMetricData
operation. Any message about a specific metric returned by the operation appears in the MetricDataResult
object returned for that metric.
(dict) --
A message returned by the GetMetricData
API, including a code and a description.
If a cross-Region GetMetricData
operation fails with a code of Forbidden
and a value of Authentication too complex to retrieve cross region data
, you can correct the problem by running the GetMetricData
operation in the same Region where the metric data is.
Code (string) --
The error code or status code associated with the message.
Value (string) --
The message text.
Exceptions
CloudWatch.Client.exceptions.InvalidNextToken
get_metric_statistics
(**kwargs)¶Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
StorageResolution
of 1.Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_metric_statistics(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Period=123,
Statistics=[
'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
],
ExtendedStatistics=[
'string',
],
Unit='Seconds'|'Microseconds'|'Milliseconds'|'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'
)
[REQUIRED]
The namespace of the metric, with or without spaces.
[REQUIRED]
The name of the metric, with or without spaces.
The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide . For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide .
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
[REQUIRED]
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
[REQUIRED]
The time stamp that determines the last data point to return.
The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
[REQUIRED]
The granularity, in seconds, of the returned data points. 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:
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics
. When calling GetMetricStatistics
, you must specify either Statistics
or ExtendedStatistics
, but not both.
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics
, you must specify either Statistics
or ExtendedStatistics
, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Unit
, 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.dict
Response Syntax
{
'Label': 'string',
'Datapoints': [
{
'Timestamp': datetime(2015, 1, 1),
'SampleCount': 123.0,
'Average': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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',
'ExtendedStatistics': {
'string': 123.0
}
},
]
}
Response Structure
(dict) --
Label (string) --
A label for the specified metric.
Datapoints (list) --
The data points for the specified metric.
(dict) --
Encapsulates the statistical data that CloudWatch computes from metric data.
Timestamp (datetime) --
The time stamp used for the data point.
SampleCount (float) --
The number of metric values that contributed to the aggregate value of this data point.
Average (float) --
The average of the metric values that correspond to the data point.
Sum (float) --
The sum of the metric values for the data point.
Minimum (float) --
The minimum metric value for the data point.
Maximum (float) --
The maximum metric value for the data point.
Unit (string) --
The standard unit for the data point.
ExtendedStatistics (dict) --
The percentile statistic for the data point.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
CloudWatch.Client.exceptions.InternalServiceFault
get_metric_stream
(**kwargs)¶Returns information about the metric stream that you specify.
See also: AWS API Documentation
Request Syntax
response = client.get_metric_stream(
Name='string'
)
[REQUIRED]
The name of the metric stream to retrieve information about.
{
'Arn': 'string',
'Name': 'string',
'IncludeFilters': [
{
'Namespace': 'string'
},
],
'ExcludeFilters': [
{
'Namespace': 'string'
},
],
'FirehoseArn': 'string',
'RoleArn': 'string',
'State': 'string',
'CreationDate': datetime(2015, 1, 1),
'LastUpdateDate': datetime(2015, 1, 1),
'OutputFormat': 'json'|'opentelemetry0.7',
'StatisticsConfigurations': [
{
'IncludeMetrics': [
{
'Namespace': 'string',
'MetricName': 'string'
},
],
'AdditionalStatistics': [
'string',
]
},
]
}
Response Structure
The ARN of the metric stream.
The name of the metric stream.
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
The name of the metric namespace in the filter.
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.
This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
The name of the metric namespace in the filter.
The ARN of the Amazon Kinesis Firehose delivery stream that is used by this metric stream.
The ARN of the IAM role that is used by this metric stream.
The state of the metric stream. The possible values are running
and stopped
.
The date that the metric stream was created.
The date of the most recent update to the metric stream's configuration.
The output format for the stream. Valid values are json
and opentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats .
Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions .
By default, a metric stream always sends the MAX
, MIN
, SUM
, and SAMPLECOUNT
statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in CloudWatch statistics definitions .
An array of metric name and namespace pairs that stream the additional statistics listed in the value of the AdditionalStatistics
parameter. There can be as many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
This object contains the information for one metric that is to be streamed with additional statistics.
The namespace of the metric.
The name of the metric.
The list of additional statistics that are to be streamed for the metrics listed in the IncludeMetrics
array in this structure. This list can include as many as 20 statistics.
If the OutputFormat
for the stream is opentelemetry0.7
, the only valid values are p*??* `` percentile statistics such as ``p90
, p99
and so on.
If the OutputFormat
for the stream is json
, the valid values include the abbreviations for all of the statistics listed in CloudWatch statistics definitions . For example, this includes tm98,
wm90
, PR(:300)
, and so on.
Exceptions
CloudWatch.Client.exceptions.ResourceNotFoundException
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
get_metric_widget_image
(**kwargs)¶You can use the GetMetricWidgetImage
API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage
action has the following limits:
See also: AWS API Documentation
Request Syntax
response = client.get_metric_widget_image(
MetricWidget='string',
OutputFormat='string'
)
[REQUIRED]
A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget
parameter in each GetMetricWidgetImage
call.
For more information about the syntax of MetricWidget
see GetMetricWidgetImage: Metric Widget Structure and Syntax .
If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.
The format of the resulting image. Only PNG images are supported.
The default is png
. If you specify png
, the API returns an HTTP response with the content-type set to text/xml
. The image data is in a MetricWidgetImage
field. For example:
<GetMetricWidgetImageResponse xmlns=<URLstring>>
<GetMetricWidgetImageResult>
<MetricWidgetImage>
iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
</MetricWidgetImage>
</GetMetricWidgetImageResult>
<ResponseMetadata>
<RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
</ResponseMetadata>
</GetMetricWidgetImageResponse>
The image/png
setting is intended only for custom HTTP requests. For most use cases, and all actions using an Amazon Web Services SDK, you should use png
. If you specify image/png
, the HTTP response has a content-type set to image/png
, and the body of the response is a PNG image.
dict
Response Syntax
{
'MetricWidgetImage': b'bytes'
}
Response Structure
(dict) --
MetricWidgetImage (bytes) --
The image of the graph, in the output format specified. The output is base64-encoded.
get_paginator
(operation_name)¶Create a paginator for an operation.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.client.can_paginate
method to
check if an operation is pageable.get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
list_dashboards
(**kwargs)¶Returns a list of the dashboards for your account. If you include DashboardNamePrefix
, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
ListDashboards
returns up to 1000 results on one page. If there are more than 1000 dashboards, you can callListDashboards
again and include the value you received forNextToken
in the first call, to receive the next 1000 results.
See also: AWS API Documentation
Request Syntax
response = client.list_dashboards(
DashboardNamePrefix='string',
NextToken='string'
)
dict
Response Syntax
{
'DashboardEntries': [
{
'DashboardName': 'string',
'DashboardArn': 'string',
'LastModified': datetime(2015, 1, 1),
'Size': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DashboardEntries (list) --
The list of matching dashboards.
(dict) --
Represents a specific dashboard.
DashboardName (string) --
The name of the dashboard.
DashboardArn (string) --
The Amazon Resource Name (ARN) of the dashboard.
LastModified (datetime) --
The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Size (integer) --
The size of the dashboard, in bytes.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.InternalServiceFault
list_managed_insight_rules
(**kwargs)¶Returns a list that contains the number of managed Contributor Insights rules in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_managed_insight_rules(
ResourceARN='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
100
.dict
Response Syntax
{
'ManagedRules': [
{
'TemplateName': 'string',
'ResourceARN': 'string',
'RuleState': {
'RuleName': 'string',
'State': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ManagedRules (list) --
The managed rules that are available for the specified Amazon Web Services resource.
(dict) --
Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules
.
TemplateName (string) --
The template name for the managed rule. Used to enable managed rules using PutManagedInsightRules
.
ResourceARN (string) --
If a managed rule is enabled, this is the ARN for the related Amazon Web Services resource.
RuleState (dict) --
Describes the state of a managed rule. If present, it contains information about the Contributor Insights rule that contains information about the related Amazon Web Services resource.
RuleName (string) --
The name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource.
State (string) --
Indicates whether the rule is enabled or disabled.
NextToken (string) --
Include this value to get the next set of rules if the value was returned by the previous operation.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidNextToken
list_metric_streams
(**kwargs)¶Returns a list of metric streams in this account.
See also: AWS API Documentation
Request Syntax
response = client.list_metric_streams(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'Entries': [
{
'Arn': 'string',
'CreationDate': datetime(2015, 1, 1),
'LastUpdateDate': datetime(2015, 1, 1),
'Name': 'string',
'FirehoseArn': 'string',
'State': 'string',
'OutputFormat': 'json'|'opentelemetry0.7'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token that marks the start of the next batch of returned results. You can use this token in a subsequent operation to get the next batch of results.
Entries (list) --
The array of metric stream information.
(dict) --
This structure contains the configuration information about one metric stream.
Arn (string) --
The ARN of the metric stream.
CreationDate (datetime) --
The date that the metric stream was originally created.
LastUpdateDate (datetime) --
The date that the configuration of this metric stream was most recently updated.
Name (string) --
The name of the metric stream.
FirehoseArn (string) --
The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
State (string) --
The current state of this stream. Valid values are running
and stopped
.
OutputFormat (string) --
The output format of this metric stream. Valid values are json
and opentelemetry0.7
.
Exceptions
CloudWatch.Client.exceptions.InvalidNextToken
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
list_metrics
(**kwargs)¶List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics .
ListMetrics
doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics .
See also: AWS API Documentation
Request Syntax
response = client.list_metrics(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
NextToken='string',
RecentlyActive='PT3H'
)
The dimensions to filter against. Only the dimensions that match exactly will be returned.
Represents filters for a dimension.
The dimension name to be matched.
The value of the dimension to be matched.
To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H
. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
dict
Response Syntax
{
'Metrics': [
{
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Metrics (list) --
The metrics that match your request.
(dict) --
Represents a specific metric.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Exceptions
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The ARN of the CloudWatch resource that you want to view tags for.
The ARN format of an alarm is ``arn:aws:cloudwatch:Region :account-id :alarm:alarm-name ``
The ARN format of a Contributor Insights rule is ``arn:aws:cloudwatch:Region :account-id :insight-rule:insight-rule-name ``
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference .
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The list of tag keys and values associated with the resource you specified.
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.ResourceNotFoundException
CloudWatch.Client.exceptions.InternalServiceFault
put_anomaly_detector
(**kwargs)¶Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.
For more information, see CloudWatch Anomaly Detection .
See also: AWS API Documentation
Request Syntax
response = client.put_anomaly_detector(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Stat='string',
Configuration={
'ExcludedTimeRanges': [
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
'MetricTimezone': 'string'
},
SingleMetricAnomalyDetector={
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'string'
},
MetricMathAnomalyDetector={
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
]
}
)
The metric dimensions to create the anomaly detection model for.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.
The configuration can also include the time zone to use for the metric.
An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.
Specifies one range of days or times to exclude from use for training an anomaly detection model.
The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss
. For example, 2019-07-01T23:59:59
.
The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss
. For example, 2019-07-01T23:59:59
.
The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.
To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .
A single metric anomaly detector to be created.
When using SingleMetricAnomalyDetector
, you cannot include the following parameters in the same operation:
Dimensions
MetricName
Namespace
Stat
MetricMatchAnomalyDetector
parameters of PutAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector
.
The namespace of the metric to create the anomaly detection model for.
The name of the metric to create the anomaly detection model for.
The metric dimensions to create the anomaly detection model for.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The statistic to use for the metric and anomaly detection model.
The metric math anomaly detector to be created.
When using MetricMathAnomalyDetector
, you cannot include the following parameters in the same operation:
Dimensions
MetricName
Namespace
Stat
SingleMetricAnomalyDetector
parameters of PutAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector
.
An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries
gets a metric or performs a math expression. One item in MetricDataQueries
is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData
to True
for this object in the array. For all other expressions and metrics, set ReturnData
to False
. The designated expression must return a single time series.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric. This is a required field.
The dimensions for the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The granularity, in seconds, of the returned data points. 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:
The statistic to return. It can include any CloudWatch statistic or extended statistic.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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.
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 .
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
dict
Response Syntax
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.LimitExceededException
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
put_composite_alarm
(**kwargs)¶Creates or updates a composite alarm . When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.
Note
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA
state.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm
permission that is scoped to *
. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm
permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole
to create a composite alarm that has Systems Manager OpsItem actions.
See also: AWS API Documentation
Request Syntax
response = client.put_composite_alarm(
ActionsEnabled=True|False,
AlarmActions=[
'string',
],
AlarmDescription='string',
AlarmName='string',
AlarmRule='string',
InsufficientDataActions=[
'string',
],
OKActions=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ActionsSuppressor='string',
ActionsSuppressorWaitPeriod=123,
ActionsSuppressorExtensionPeriod=123
)
TRUE
.The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:ssm:region :account-id :opsitem:severity ``
[REQUIRED]
The name for the composite alarm. This name must be unique within the Region.
[REQUIRED]
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM("*alarm-name* or *alarm-ARN* ")
is TRUE if the named alarm is in ALARM state.OK("*alarm-name* or *alarm-ARN* ")
is TRUE if the named alarm is in OK state.INSUFFICIENT_DATA("*alarm-name* or *alarm-ARN* ")
is TRUE if the named alarm is in INSUFFICIENT_DATA state.TRUE
always evaluates to TRUE.FALSE
always evaluates to FALSE.TRUE and FALSE are useful for testing a complex AlarmRule
structure, and for testing your alarm actions.
Alarm names specified in AlarmRule
can be surrounded with double-quotes ("), but do not have to be.
The following are some examples of AlarmRule
:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This example reduces alarm noise during a known deployment window.(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.The AlarmRule
can specify as many as 100 "children" alarms. The AlarmRule
expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ``arn:aws:sns:region :account-id :sns-topic-name ``
The actions to execute when this alarm transitions to an OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ``arn:aws:sns:region :account-id :sns-topic-name ``
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
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.
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
ALARM
state. ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM
state. After this time, the composite alarm performs its actions.
Warning
WaitPeriod
is required only when ActionsSuppressor
is specified.
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM
state. After this time, the composite alarm performs its actions.
Warning
ExtensionPeriod
is required only when ActionsSuppressor
is specified.
None
Exceptions
CloudWatch.Client.exceptions.LimitExceededFault
put_dashboard
(**kwargs)¶Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard
is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard
, and then use the data returned within DashboardBody
as the template for the new dashboard when you call PutDashboard
.
When you create a dashboard with PutDashboard
, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody
script or the CloudFormation template used to create the dashboard.
See also: AWS API Documentation
Request Syntax
response = client.put_dashboard(
DashboardName='string',
DashboardBody='string'
)
[REQUIRED]
The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
[REQUIRED]
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.
For more information about the syntax, see Dashboard Body Structure and Syntax .
dict
Response Syntax
{
'DashboardValidationMessages': [
{
'DataPath': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
DashboardValidationMessages (list) --
If the input for PutDashboard
was correct and the dashboard was successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard might not render.
If this result includes error messages, the input was not valid and the operation failed.
(dict) --
An error or warning for the operation.
DataPath (string) --
The data path related to the message.
Message (string) --
A message describing the error or warning.
Exceptions
CloudWatch.Client.exceptions.DashboardInvalidInputError
CloudWatch.Client.exceptions.InternalServiceFault
put_insight_rule
(**kwargs)¶Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data .
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
See also: AWS API Documentation
Request Syntax
response = client.put_insight_rule(
RuleName='string',
RuleState='string',
RuleDefinition='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A unique name for the rule.
[REQUIRED]
The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax .
A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
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 the resources that have certain tag values.
To be able to associate tags with a rule, you must have the cloudwatch:TagResource
permission in addition to the cloudwatch:PutInsightRule
permission.
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource .
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
dict
Response Syntax
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.LimitExceededException
put_managed_insight_rules
(**kwargs)¶Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You cannot edit these rules with PutInsightRule
. The rules can be enabled, disabled, and deleted using EnableInsightRules
, DisableInsightRules
, and DeleteInsightRules
. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use ListManagedInsightRules
to describe all available rules.
See also: AWS API Documentation
Request Syntax
response = client.put_managed_insight_rules(
ManagedRules=[
{
'TemplateName': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
A list of ManagedRules
to enable.
Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.
The template name for the managed Contributor Insights rule, as returned by ListManagedInsightRules
.
The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
A list of key-value pairs that you can associate with a managed Contributor Insights rule. You can associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use them to scope user permissions by granting a user permission to access or change only the resources that have certain tag values. To associate tags with a rule, you must have the cloudwatch:TagResource
permission in addition to the cloudwatch:PutInsightRule
permission. If you are using this operation to update an existing Contributor Insights rule, any tags that you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource
.
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
{
'Failures': [
{
'FailureResource': 'string',
'ExceptionType': 'string',
'FailureCode': 'string',
'FailureDescription': 'string'
},
]
}
Response Structure
An array that lists the rules that could not be enabled.
This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
The specified rule that could not be deleted.
The type of error.
The code of the error.
A description of the error.
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
put_metric_alarm
(**kwargs)¶Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
iam:CreateServiceLinkedRole
for all alarms with EC2 actionsiam:CreateServiceLinkedRole
to create an alarm with Systems Manager OpsItem actions.The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents
and AWSServiceRoleForCloudWatchAlarms_ActionSSM
. For more information, see Amazon Web Services service-linked role .
Cross-account alarms
You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:
See also: AWS API Documentation
Request Syntax
response = client.put_metric_alarm(
AlarmName='string',
AlarmDescription='string',
ActionsEnabled=True|False,
OKActions=[
'string',
],
AlarmActions=[
'string',
],
InsufficientDataActions=[
'string',
],
MetricName='string',
Namespace='string',
Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
ExtendedStatistic='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Period=123,
Unit='Seconds'|'Microseconds'|'Milliseconds'|'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',
EvaluationPeriods=123,
DatapointsToAlarm=123,
Threshold=123.0,
ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'|'LessThanLowerOrGreaterThanUpperThreshold'|'LessThanLowerThreshold'|'GreaterThanUpperThreshold',
TreatMissingData='string',
EvaluateLowSampleCountPercentile='string',
Metrics=[
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ThresholdMetricId='string'
)
[REQUIRED]
The name for the alarm. This name must be unique within the Region.
TRUE
.The actions to execute when this alarm transitions to an OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:*region* :ec2:stop
| arn:aws:automate:*region* :ec2:terminate
| arn:aws:automate:*region* :ec2:recover
| arn:aws:automate:*region* :ec2:reboot
| ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Valid Values (for use with IAM roles): arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:*region* :ec2:stop
| arn:aws:automate:*region* :ec2:terminate
| arn:aws:automate:*region* :ec2:recover
| arn:aws:automate:*region* :ec2:reboot
| ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name `` | ``arn:aws:ssm:region :account-id :opsitem:severity `` | ``arn:aws:ssm-incidents::account-id :response-plan:response-plan-name ``
Valid Values (for use with IAM roles): arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:*region* :ec2:stop
| arn:aws:automate:*region* :ec2:terminate
| arn:aws:automate:*region* :ec2:recover
| arn:aws:automate:*region* :ec2:reboot
| ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Valid Values (for use with IAM roles): >arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
The name for the metric associated with the alarm. For each PutMetricAlarm
operation, you must specify either MetricName
or a Metrics
array.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions
, Period
, Namespace
, Statistic
, or ExtendedStatistic
parameters. Instead, you specify all this information in the Metrics
array.
MetricName
.MetricName
, other than percentile. For percentile statistics, use ExtendedStatistic
. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or ExtendedStatistic,
but not both.MetricName
. Specify a value between p0.0 and p100. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or ExtendedStatistic,
but not both.The dimensions for the metric specified in MetricName
.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The length, in seconds, used each time the metric specified in MetricName
is evaluated. Valid values are 10, 30, and any multiple of 60.
Period
is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in theMetrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData
call with a StorageResolution
of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing .
An alarm's total current evaluation period can be no longer than one day, so Period
multiplied by EvaluationPeriods
cannot be more than 86,400 seconds.
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you don't specify Unit
, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting Unit
so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA
state.
[REQUIRED]
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period
cannot be more than 86,400 seconds.
The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
[REQUIRED]
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
The values LessThanLowerOrGreaterThanUpperThreshold
, LessThanLowerThreshold
, and GreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.
Sets how this alarm is to handle missing data points. If TreatMissingData
is omitted, the default behavior of missing
is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data .
Valid Values: breaching | notBreaching | ignore | missing
Note
Alarms that evaluate metrics in the AWS/DynamoDB
namespace always ignore
missing data even if you choose a different option for TreatMissingData
. When an AWS/DynamoDB
metric has missing data, alarms that evaluate that metric remain in their current state.
Used only for alarms based on percentiles. If you specify ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate
or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples .
Valid Values: evaluate | ignore
An array of MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm
operation, you must specify either MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate this expression by setting ReturnData
to true for this object in the array. For more information, see MetricDataQuery .
If you use the Metrics
parameter, you cannot include the MetricName
, Dimensions
, Period
, Namespace
, Statistic
, or ExtendedStatistic
parameters of PutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics
array.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric. This is a required field.
The dimensions for the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The granularity, in seconds, of the returned data points. 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:
The statistic to return. It can include any CloudWatch statistic or extended statistic.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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.
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 .
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
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.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource .
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND
function.
For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
None
Exceptions
CloudWatch.Client.exceptions.LimitExceededFault
put_metric_data
(**kwargs)¶Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics .
You can publish either individual data points in the Value
field, or arrays of values and the number of times each value occurred during the period by using the Values
and Counts
fields in the MetricDatum
structure. Using the Values
and Counts
method enables you to publish up to 150 values per metric with one PutMetricData
request, and supports retrieving percentile statistics on this data.
Each PutMetricData
request is limited to 1 MB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 1000 different metrics.
Although the Value
parameter accepts numbers of type Double
, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide .
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics .
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
SampleCount
value of the statistic set is 1 and Min
, Max
, and Sum
are all equal.Min
and Max
are equal, and Sum
is equal to Min
multiplied by SampleCount
.See also: AWS API Documentation
Request Syntax
response = client.put_metric_data(
Namespace='string',
MetricData=[
{
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Timestamp': datetime(2015, 1, 1),
'Value': 123.0,
'StatisticValues': {
'SampleCount': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0
},
'Values': [
123.0,
],
'Counts': [
123.0,
],
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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',
'StorageResolution': 123
},
]
)
[REQUIRED]
The namespace for the metric data.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/
[REQUIRED]
The data for the metric. The array can include no more than 1000 metrics per call.
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
The name of the metric.
The dimensions associated with the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
The value for the metric.
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
The statistical values for the metric.
The number of samples used for the statistic set.
The sum of values for the sample set.
The minimum value of the sample set.
The maximum value of the sample set.
Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts
array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData
action that specifies a Values
array.
Although the Values
array accepts numbers of type Double
, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
Array of numbers that is used along with the Values
array. Each number in the Count
array is the number of times the corresponding value in the Values
array occurred during the period.
If you omit the Counts
array, the default of 1 is used as the value for each count. If you include a Counts
array, it must include the same amount of values as the Values
array.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, this displays the unit that is used for the metric.
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
This field is optional, if you do not specify it the default of 60 is used.
None
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
CloudWatch.Client.exceptions.InternalServiceFault
put_metric_stream
(**kwargs)¶Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations including Amazon S3 and to many third-party solutions.
For more information, see Using Metric Streams .
To create a metric stream, you must be logged on to an account that has the iam:PassRole
permission and either the CloudWatchFullAccess
policy or the cloudwatch:PutMetricStream
permission.
When you create or update a metric stream, you choose one of the following:
ExcludeFilters
.IncludeFilters
.By default, a metric stream always sends the MAX
, MIN
, SUM
, and SAMPLECOUNT
statistics for each metric that is streamed. You can use the StatisticsConfigurations
parameter to have the metric stream also send additional statistics in the stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing .
When you use PutMetricStream
to create a new metric stream, the stream is created in the running
state. If you use it to update an existing stream, the state of the stream is not changed.
See also: AWS API Documentation
Request Syntax
response = client.put_metric_stream(
Name='string',
IncludeFilters=[
{
'Namespace': 'string'
},
],
ExcludeFilters=[
{
'Namespace': 'string'
},
],
FirehoseArn='string',
RoleArn='string',
OutputFormat='json'|'opentelemetry0.7',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StatisticsConfigurations=[
{
'IncludeMetrics': [
{
'Namespace': 'string',
'MetricName': 'string'
},
],
'AdditionalStatistics': [
'string',
]
},
]
)
[REQUIRED]
If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
If you are updating a metric stream, specify the name of that stream here.
Valid characters are A-Z, a-z, 0-9, "-" and "_".
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
You cannot include IncludeFilters
and ExcludeFilters
in the same operation.
This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
The name of the metric namespace in the filter.
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
You cannot include ExcludeFilters
and IncludeFilters
in the same operation.
This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
The name of the metric namespace in the filter.
[REQUIRED]
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
[REQUIRED]
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:
[REQUIRED]
The output format for the stream. Valid values are json
and opentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats .
A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.
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.
You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource .
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
By default, a metric stream always sends the MAX
, MIN
, SUM
, and SAMPLECOUNT
statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat
. If the OutputFormat
is json
, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions . If the OutputFormat
is opentelemetry0.7
, you can stream percentile statistics such as p95, p99.9 and so on.
By default, a metric stream always sends the MAX
, MIN
, SUM
, and SAMPLECOUNT
statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in CloudWatch statistics definitions .
An array of metric name and namespace pairs that stream the additional statistics listed in the value of the AdditionalStatistics
parameter. There can be as many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
This object contains the information for one metric that is to be streamed with additional statistics.
The namespace of the metric.
The name of the metric.
The list of additional statistics that are to be streamed for the metrics listed in the IncludeMetrics
array in this structure. This list can include as many as 20 statistics.
If the OutputFormat
for the stream is opentelemetry0.7
, the only valid values are p*??* `` percentile statistics such as ``p90
, p99
and so on.
If the OutputFormat
for the stream is json
, the valid values include the abbreviations for all of the statistics listed in CloudWatch statistics definitions . For example, this includes tm98,
wm90
, PR(:300)
, and so on.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the metric stream.
Exceptions
CloudWatch.Client.exceptions.ConcurrentModificationException
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
CloudWatch.Client.exceptions.InvalidParameterCombinationException
set_alarm_state
(**kwargs)¶Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM
sends an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory .
If you use SetAlarmState
on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData
parameter to enable the policy to take the correct action.
See also: AWS API Documentation
Request Syntax
response = client.set_alarm_state(
AlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
StateReason='string',
StateReasonData='string'
)
[REQUIRED]
The name of the alarm.
[REQUIRED]
The value of the state.
[REQUIRED]
The reason that this alarm is set to this specific state, in text format.
The reason that this alarm is set to this specific state, in JSON format.
For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
None
Exceptions
CloudWatch.Client.exceptions.ResourceNotFound
CloudWatch.Client.exceptions.InvalidFormatFault
start_metric_streams
(**kwargs)¶Starts the streaming of metrics for one or more of your metric streams.
See also: AWS API Documentation
Request Syntax
response = client.start_metric_streams(
Names=[
'string',
]
)
[REQUIRED]
The array of the names of metric streams to start streaming.
This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will start streaming.
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
stop_metric_streams
(**kwargs)¶Stops the streaming of metrics for one or more of your metric streams.
See also: AWS API Documentation
Request Syntax
response = client.stop_metric_streams(
Names=[
'string',
]
)
[REQUIRED]
The array of the names of metric streams to stop streaming.
This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will stop streaming.
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InternalServiceFault
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.MissingRequiredParameterException
tag_resource
(**kwargs)¶Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
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
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the CloudWatch resource that you're adding tags to.
The ARN format of an alarm is ``arn:aws:cloudwatch:Region :account-id :alarm:alarm-name ``
The ARN format of a Contributor Insights rule is ``arn:aws:cloudwatch:Region :account-id :insight-rule:insight-rule-name ``
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference .
[REQUIRED]
The list of key-value pairs to associate with the alarm.
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
dict
Response Syntax
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.ResourceNotFoundException
CloudWatch.Client.exceptions.ConcurrentModificationException
CloudWatch.Client.exceptions.InternalServiceFault
untag_resource
(**kwargs)¶Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the CloudWatch resource that you're removing tags from.
The ARN format of an alarm is ``arn:aws:cloudwatch:Region :account-id :alarm:alarm-name ``
The ARN format of a Contributor Insights rule is ``arn:aws:cloudwatch:Region :account-id :insight-rule:insight-rule-name ``
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference .
[REQUIRED]
The list of tag keys to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
CloudWatch.Client.exceptions.InvalidParameterValueException
CloudWatch.Client.exceptions.ResourceNotFoundException
CloudWatch.Client.exceptions.ConcurrentModificationException
CloudWatch.Client.exceptions.InternalServiceFault
The available paginators are:
CloudWatch.Paginator.DescribeAlarmHistory
CloudWatch.Paginator.DescribeAlarms
CloudWatch.Paginator.DescribeAnomalyDetectors
CloudWatch.Paginator.GetMetricData
CloudWatch.Paginator.ListDashboards
CloudWatch.Paginator.ListMetrics
CloudWatch.Paginator.
DescribeAlarmHistory
¶paginator = client.get_paginator('describe_alarm_history')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatch.Client.describe_alarm_history()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AlarmName='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
HistoryItemType='ConfigurationUpdate'|'StateUpdate'|'Action',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
ScanBy='TimestampDescending'|'TimestampAscending',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
TimestampDescending
to have the newest event history returned first, and specify TimestampAscending
to have the oldest history returned first.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'AlarmHistoryItems': [
{
'AlarmName': 'string',
'AlarmType': 'CompositeAlarm'|'MetricAlarm',
'Timestamp': datetime(2015, 1, 1),
'HistoryItemType': 'ConfigurationUpdate'|'StateUpdate'|'Action',
'HistorySummary': 'string',
'HistoryData': 'string'
},
],
}
Response Structure
(dict) --
AlarmHistoryItems (list) --
The alarm histories, in JSON format.
(dict) --
Represents the history of a specific alarm.
AlarmName (string) --
The descriptive name for the alarm.
AlarmType (string) --
The type of alarm, either metric alarm or composite alarm.
Timestamp (datetime) --
The time stamp for the alarm history item.
HistoryItemType (string) --
The type of alarm history item.
HistorySummary (string) --
A summary of the alarm history, in text format.
HistoryData (string) --
Data about the alarm, in JSON format.
CloudWatch.Paginator.
DescribeAlarms
¶paginator = client.get_paginator('describe_alarms')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatch.Client.describe_alarms()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
ChildrenOfAlarmName='string',
ParentsOfAlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the alarms to retrieve information about.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'CompositeAlarms': [
{
'ActionsEnabled': True|False,
'AlarmActions': [
'string',
],
'AlarmArn': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'AlarmDescription': 'string',
'AlarmName': 'string',
'AlarmRule': 'string',
'InsufficientDataActions': [
'string',
],
'OKActions': [
'string',
],
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateTransitionedTimestamp': datetime(2015, 1, 1),
'ActionsSuppressedBy': 'WaitPeriod'|'ExtensionPeriod'|'Alarm',
'ActionsSuppressedReason': 'string',
'ActionsSuppressor': 'string',
'ActionsSuppressorWaitPeriod': 123,
'ActionsSuppressorExtensionPeriod': 123
},
],
'MetricAlarms': [
{
'AlarmName': 'string',
'AlarmArn': 'string',
'AlarmDescription': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'ActionsEnabled': True|False,
'OKActions': [
'string',
],
'AlarmActions': [
'string',
],
'InsufficientDataActions': [
'string',
],
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
'ExtendedStatistic': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Period': 123,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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',
'EvaluationPeriods': 123,
'DatapointsToAlarm': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'|'LessThanLowerOrGreaterThanUpperThreshold'|'LessThanLowerThreshold'|'GreaterThanUpperThreshold',
'TreatMissingData': 'string',
'EvaluateLowSampleCountPercentile': 'string',
'Metrics': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
],
'ThresholdMetricId': 'string'
},
],
}
Response Structure
(dict) --
CompositeAlarms (list) --
The information about any composite alarms returned by the operation.
(dict) --
The details about a composite alarm.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
AlarmDescription (string) --
The description of the alarm.
AlarmName (string) --
The name of the alarm.
AlarmRule (string) --
The rule that this alarm uses to evaluate its alarm state.
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
OKActions (list) --
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
Tracks the timestamp of any state update, even if StateValue
doesn't change.
StateValue (string) --
The state value for the alarm.
StateTransitionedTimestamp (datetime) --
The timestamp of the last change to the alarm's StateValue
.
ActionsSuppressedBy (string) --
When the value is ALARM
, it means that the actions are suppressed because the suppressor alarm is in ALARM
When the value is WaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM
state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM
state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod
. After this time, the composite alarm performs its actions.
ActionsSuppressedReason (string) --
Captures the reason for action suppression.
ActionsSuppressor (string) --
Actions will be suppressed if the suppressor alarm is in the ALARM
state. ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
ActionsSuppressorWaitPeriod (integer) --
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM
state. After this time, the composite alarm performs its actions.
Warning
WaitPeriod
is required only when ActionsSuppressor
is specified.
ActionsSuppressorExtensionPeriod (integer) --
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM
state. After this time, the composite alarm performs its actions.
Warning
ExtensionPeriod
is required only when ActionsSuppressor
is specified.
MetricAlarms (list) --
The information about any metric alarms returned by the operation.
(dict) --
The details about a metric alarm.
AlarmName (string) --
The name of the alarm.
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmDescription (string) --
The description of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
OKActions (list) --
The actions to execute when this alarm transitions to the OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateValue (string) --
The state value for the alarm.
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm state.
MetricName (string) --
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
Namespace (string) --
The namespace of the metric associated with the alarm.
Statistic (string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic
.
ExtendedStatistic (string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
Dimensions (list) --
The dimensions for the metric associated with the alarm.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The period, in seconds, over which the statistic is applied.
Unit (string) --
The unit of the metric associated with the alarm.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm (integer) --
The number of data points that must be breaching to trigger the alarm.
Threshold (float) --
The value to compare with the specified statistic.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
TreatMissingData (string) --
Sets how this alarm is to handle missing data points. The valid values are breaching
, notBreaching
, ignore
, and missing
. For more information, see Configuring how CloudWatch alarms treat missing data .
If this parameter is omitted, the default behavior of missing
is used.
EvaluateLowSampleCountPercentile (string) --
Used only for alarms based on percentiles. If ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
Metrics (list) --
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData
set to true.
(dict) --
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Id (string) --
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
MetricStat (dict) --
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
Metric (dict) --
The metric to return, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The granularity, in seconds, of the returned data points. 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:
Stat (string) --
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit (string) --
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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 either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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) --
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
Period (integer) --
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
AccountId (string) --
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
ThresholdMetricId (string) --
In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
CloudWatch.Paginator.
DescribeAnomalyDetectors
¶paginator = client.get_paginator('describe_anomaly_detectors')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatch.Client.describe_anomaly_detectors()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
AnomalyDetectorTypes=[
'SINGLE_METRIC'|'METRIC_MATH',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The anomaly detector types to request when using DescribeAnomalyDetectorsInput
. If empty, defaults to SINGLE_METRIC
.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'AnomalyDetectors': [
{
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'string',
'Configuration': {
'ExcludedTimeRanges': [
{
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
],
'MetricTimezone': 'string'
},
'StateValue': 'PENDING_TRAINING'|'TRAINED_INSUFFICIENT_DATA'|'TRAINED',
'SingleMetricAnomalyDetector': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Stat': 'string'
},
'MetricMathAnomalyDetector': {
'MetricDataQueries': [
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
]
}
},
],
}
Response Structure
(dict) --
AnomalyDetectors (list) --
The list of anomaly detection models returned by the operation.
(dict) --
An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.
Namespace (string) --
The namespace of the metric associated with the anomaly detection model.
MetricName (string) --
The name of the metric associated with the anomaly detection model.
Dimensions (list) --
The metric dimensions associated with the anomaly detection model.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Stat (string) --
The statistic associated with the anomaly detection model.
Configuration (dict) --
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.
ExcludedTimeRanges (list) --
An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.
(dict) --
Specifies one range of days or times to exclude from use for training an anomaly detection model.
StartTime (datetime) --
The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss
. For example, 2019-07-01T23:59:59
.
EndTime (datetime) --
The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss
. For example, 2019-07-01T23:59:59
.
MetricTimezone (string) --
The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.
To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database .
StateValue (string) --
The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
SingleMetricAnomalyDetector (dict) --
The CloudWatch metric and statistic for this anomaly detector.
Namespace (string) --
The namespace of the metric to create the anomaly detection model for.
MetricName (string) --
The name of the metric to create the anomaly detection model for.
Dimensions (list) --
The metric dimensions to create the anomaly detection model for.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Stat (string) --
The statistic to use for the metric and anomaly detection model.
MetricMathAnomalyDetector (dict) --
The CloudWatch metric math expression for this anomaly detector.
MetricDataQueries (list) --
An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries
gets a metric or performs a math expression. One item in MetricDataQueries
is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData
to True
for this object in the array. For all other expressions and metrics, set ReturnData
to False
. The designated expression must return a single time series.
(dict) --
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Id (string) --
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
MetricStat (dict) --
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
Metric (dict) --
The metric to return, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The granularity, in seconds, of the returned data points. 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:
Stat (string) --
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit (string) --
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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 either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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) --
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
Period (integer) --
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
AccountId (string) --
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
CloudWatch.Paginator.
GetMetricData
¶paginator = client.get_paginator('get_metric_data')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatch.Client.get_metric_data()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
MetricDataQueries=[
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False,
'Period': 123,
'AccountId': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
ScanBy='TimestampDescending'|'TimestampAscending',
LabelOptions={
'Timezone': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The metric queries to be returned. A single GetMetricData
call can include as many as 500 MetricDataQuery
structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query, or a math expression to perform on retrieved data.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric. This is a required field.
The dimensions for the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The granularity, in seconds, of the returned data points. 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:
The statistic to return. It can include any CloudWatch statistic or extended statistic.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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.
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 .
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
[REQUIRED]
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime
and EndTime
values that align with the value of the metric's Period
and sync up with the beginning and end of an hour. For example, if the Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime
.
[REQUIRED]
The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime
and EndTime
values that align with the value of the metric's Period
and sync up with the beginning and end of an hour. For example, if the Period
of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime
can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime
.
TimestampDescending
returns the newest data first and paginates when the MaxDatapoints
limit is reached. TimestampAscending
returns the oldest data first and paginates when the MaxDatapoints
limit is reached.This structure includes the Timezone
parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.
The time zone to use for metric data return in this operation. The format is +
or -
followed by four digits. The first two digits indicate the number of hours ahead or behind of UTC, and the final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The default is +0000.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'MetricDataResults': [
{
'Id': 'string',
'Label': 'string',
'Timestamps': [
datetime(2015, 1, 1),
],
'Values': [
123.0,
],
'StatusCode': 'Complete'|'InternalError'|'PartialData',
'Messages': [
{
'Code': 'string',
'Value': 'string'
},
]
},
],
'Messages': [
{
'Code': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
MetricDataResults (list) --
The metrics that are returned, including the metric name, namespace, and dimensions.
(dict) --
A GetMetricData
call returns an array of MetricDataResult
structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.
Id (string) --
The short name you specified to represent this metric.
Label (string) --
The human-readable label associated with the data.
Timestamps (list) --
The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].
Values (list) --
The data points for the metric corresponding to Timestamps
. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].
StatusCode (string) --
The status of the returned data. Complete
indicates that all data points in the requested time range were returned. PartialData
means that an incomplete set of data points were returned. You can use the NextToken
value that was returned and repeat your request to get more data points. NextToken
is not returned if you are performing a math expression. InternalError
indicates that an error occurred. Retry your request using NextToken
, if present.
Messages (list) --
A list of messages with additional information about the data returned.
(dict) --
A message returned by the GetMetricData
API, including a code and a description.
If a cross-Region GetMetricData
operation fails with a code of Forbidden
and a value of Authentication too complex to retrieve cross region data
, you can correct the problem by running the GetMetricData
operation in the same Region where the metric data is.
Code (string) --
The error code or status code associated with the message.
Value (string) --
The message text.
Messages (list) --
Contains a message about this GetMetricData
operation, if the operation results in such a message. An example of a message that might be returned is Maximum number of allowed metrics exceeded
. If there is a message, as much of the operation as possible is still executed.
A message appears here only if it is related to the global GetMetricData
operation. Any message about a specific metric returned by the operation appears in the MetricDataResult
object returned for that metric.
(dict) --
A message returned by the GetMetricData
API, including a code and a description.
If a cross-Region GetMetricData
operation fails with a code of Forbidden
and a value of Authentication too complex to retrieve cross region data
, you can correct the problem by running the GetMetricData
operation in the same Region where the metric data is.
Code (string) --
The error code or status code associated with the message.
Value (string) --
The message text.
CloudWatch.Paginator.
ListDashboards
¶paginator = client.get_paginator('list_dashboards')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatch.Client.list_dashboards()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DashboardNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'DashboardEntries': [
{
'DashboardName': 'string',
'DashboardArn': 'string',
'LastModified': datetime(2015, 1, 1),
'Size': 123
},
],
}
Response Structure
(dict) --
DashboardEntries (list) --
The list of matching dashboards.
(dict) --
Represents a specific dashboard.
DashboardName (string) --
The name of the dashboard.
DashboardArn (string) --
The Amazon Resource Name (ARN) of the dashboard.
LastModified (datetime) --
The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Size (integer) --
The size of the dashboard, in bytes.
CloudWatch.Paginator.
ListMetrics
¶paginator = client.get_paginator('list_metrics')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from CloudWatch.Client.list_metrics()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
RecentlyActive='PT3H',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The dimensions to filter against. Only the dimensions that match exactly will be returned.
Represents filters for a dimension.
The dimension name to be matched.
The value of the dimension to be matched.
To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H
. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Metrics': [
{
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Metrics (list) --
The metrics that match your request.
(dict) --
Represents a specific metric.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The available waiters are:
CloudWatch.Waiter.
AlarmExists
¶waiter = client.get_waiter('alarm_exists')
wait
(**kwargs)¶Polls CloudWatch.Client.describe_alarms()
every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
ChildrenOfAlarmName='string',
ParentsOfAlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The names of the alarms to retrieve information about.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 40
None
CloudWatch.Waiter.
CompositeAlarmExists
¶waiter = client.get_waiter('composite_alarm_exists')
wait
(**kwargs)¶Polls CloudWatch.Client.describe_alarms()
every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
ChildrenOfAlarmName='string',
ParentsOfAlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The names of the alarms to retrieve information about.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 40
None
CloudWatch.
ServiceResource
¶A resource representing Amazon CloudWatch:
import boto3
cloudwatch = boto3.resource('cloudwatch')
These are the resource's available sub-resources:
These are the resource's available collections:
Sub-resources
Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide.
Alarm
(name)¶Creates a Alarm resource.:
alarm = cloudwatch.Alarm('name')
CloudWatch.Alarm
Metric
(namespace, name)¶Creates a Metric resource.:
metric = cloudwatch.Metric('namespace','name')
A Metric resource
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
alarms
¶A collection of Alarm resources.A Alarm Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all
()¶Creates an iterable of all Alarm resources in the collection.
See also: AWS API Documentation
Request Syntax
alarm_iterator = cloudwatch.alarms.all()
cloudwatch.Alarm
)delete
()¶Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
In the event of an error, no alarms are deleted.
Note
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
See also: AWS API Documentation
Request Syntax
response = cloudwatch.alarms.delete()
disable_actions
()¶Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
See also: AWS API Documentation
Request Syntax
response = cloudwatch.alarms.disable_actions()
enable_actions
()¶Enables the actions for the specified alarms.
See also: AWS API Documentation
Request Syntax
response = cloudwatch.alarms.enable_actions()
filter
(**kwargs)¶Creates an iterable of all Alarm resources in the collection filtered by kwargs passed to method. A Alarm collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
alarm_iterator = cloudwatch.alarms.filter(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
ChildrenOfAlarmName='string',
ParentsOfAlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string'
)
The names of the alarms to retrieve information about.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames
.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule
field of the composite alarm that you specify in ChildrenOfAlarmName
. Information about the composite alarm that you name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule
parameters that reference the alarm named in ParentsOfAlarmName
. Information about the alarm that you specify in ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other parameters in the request except for MaxRecords
and NextToken
. If you do so, you receive a validation error.
Note
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms
operation and specify the parent alarm names in the AlarmNames
parameter.
list(cloudwatch.Alarm
)
A list of Alarm resources
limit
(**kwargs)¶Creates an iterable up to a specified amount of Alarm resources in the collection.
See also: AWS API Documentation
Request Syntax
alarm_iterator = cloudwatch.alarms.limit(
count=123
)
cloudwatch.Alarm
)page_size
(**kwargs)¶Creates an iterable of all Alarm resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
alarm_iterator = cloudwatch.alarms.page_size(
count=123
)
cloudwatch.Alarm
)metrics
¶A collection of Metric resources.A Metric Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all
()Creates an iterable of all Metric resources in the collection.
See also: AWS API Documentation
Request Syntax
metric_iterator = cloudwatch.metrics.all()
cloudwatch.Metric
)filter
(**kwargs)Creates an iterable of all Metric resources in the collection filtered by kwargs passed to method. A Metric collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
metric_iterator = cloudwatch.metrics.filter(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
NextToken='string',
RecentlyActive='PT3H'
)
The dimensions to filter against. Only the dimensions that match exactly will be returned.
Represents filters for a dimension.
The dimension name to be matched.
The value of the dimension to be matched.
To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H
. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
list(cloudwatch.Metric
)
A list of Metric resources
limit
(**kwargs)Creates an iterable up to a specified amount of Metric resources in the collection.
See also: AWS API Documentation
Request Syntax
metric_iterator = cloudwatch.metrics.limit(
count=123
)
cloudwatch.Metric
)page_size
(**kwargs)Creates an iterable of all Metric resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
metric_iterator = cloudwatch.metrics.page_size(
count=123
)
cloudwatch.Metric
)CloudWatch.
Alarm
(name)¶A resource representing an Amazon CloudWatch Alarm:
import boto3
cloudwatch = boto3.resource('cloudwatch')
alarm = cloudwatch.Alarm('name')
These are the resource's available identifiers:
These are the resource's available attributes:
actions_enabled
alarm_actions
alarm_arn
alarm_configuration_updated_timestamp
alarm_description
alarm_name
comparison_operator
datapoints_to_alarm
dimensions
evaluate_low_sample_count_percentile
evaluation_periods
extended_statistic
insufficient_data_actions
metric_name
metrics
namespace
ok_actions
period
state_reason
state_reason_data
state_updated_timestamp
state_value
statistic
threshold
threshold_metric_id
treat_missing_data
unit
These are the resource's available references:
These are the resource's available actions:
delete()
describe_history()
disable_actions()
enable_actions()
get_available_subresources()
load()
reload()
set_state()
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
name
¶(string) The Alarm's name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load()
method.
For more information about attributes refer to the Resources Introduction Guide.
actions_enabled
¶(boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
alarm_actions
¶(list) --
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
alarm_arn
¶(string) --
The Amazon Resource Name (ARN) of the alarm.
alarm_configuration_updated_timestamp
¶(datetime) --
The time stamp of the last update to the alarm configuration.
alarm_description
¶(string) --
The description of the alarm.
alarm_name
¶(string) --
The name of the alarm.
comparison_operator
¶(string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
datapoints_to_alarm
¶(integer) --
The number of data points that must be breaching to trigger the alarm.
dimensions
¶(list) --
The dimensions for the metric associated with the alarm.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
evaluate_low_sample_count_percentile
¶(string) --
Used only for alarms based on percentiles. If ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
evaluation_periods
¶(integer) --
The number of periods over which data is compared to the specified threshold.
extended_statistic
¶(string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
insufficient_data_actions
¶(list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
metric_name
¶(string) --
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
metrics
¶(list) --
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData
set to true.
(dict) --
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
Id (string) --
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
MetricStat (dict) --
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
Metric (dict) --
The metric to return, including the metric name, namespace, and dimensions.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric. This is a required field.
Dimensions (list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
Period (integer) --
The granularity, in seconds, of the returned data points. 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:
Stat (string) --
The statistic to return. It can include any CloudWatch statistic or extended statistic.
Unit (string) --
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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 either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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) --
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
Period (integer) --
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
AccountId (string) --
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
namespace
¶(string) --
The namespace of the metric associated with the alarm.
ok_actions
¶(list) --
The actions to execute when this alarm transitions to the OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
period
¶(integer) --
The period, in seconds, over which the statistic is applied.
state_reason
¶(string) --
An explanation for the alarm state, in text format.
state_reason_data
¶(string) --
An explanation for the alarm state, in JSON format.
state_updated_timestamp
¶(datetime) --
The time stamp of the last update to the alarm state.
state_value
¶(string) --
The state value for the alarm.
statistic
¶(string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic
.
threshold
¶(float) --
The value to compare with the specified statistic.
threshold_metric_id
¶(string) --
In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
treat_missing_data
¶(string) --
Sets how this alarm is to handle missing data points. The valid values are breaching
, notBreaching
, ignore
, and missing
. For more information, see Configuring how CloudWatch alarms treat missing data .
If this parameter is omitted, the default behavior of missing
is used.
unit
¶(string) --
The unit of the metric associated with the alarm.
References
References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide.
metric
¶(Metric
) The related metric if set, otherwise None
.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
delete
()¶Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
In the event of an error, no alarms are deleted.
Note
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
See also: AWS API Documentation
Request Syntax
response = alarm.delete()
describe_history
(**kwargs)¶Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory
permission that is scoped to *
. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory
permission has a narrower scope.
See also: AWS API Documentation
Request Syntax
response = alarm.describe_history(
AlarmTypes=[
'CompositeAlarm'|'MetricAlarm',
],
HistoryItemType='ConfigurationUpdate'|'StateUpdate'|'Action',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
MaxRecords=123,
NextToken='string',
ScanBy='TimestampDescending'|'TimestampAscending'
)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
TimestampDescending
to have the newest event history returned first, and specify TimestampAscending
to have the oldest history returned first.dict
Response Syntax
{
'AlarmHistoryItems': [
{
'AlarmName': 'string',
'AlarmType': 'CompositeAlarm'|'MetricAlarm',
'Timestamp': datetime(2015, 1, 1),
'HistoryItemType': 'ConfigurationUpdate'|'StateUpdate'|'Action',
'HistorySummary': 'string',
'HistoryData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AlarmHistoryItems (list) --
The alarm histories, in JSON format.
(dict) --
Represents the history of a specific alarm.
AlarmName (string) --
The descriptive name for the alarm.
AlarmType (string) --
The type of alarm, either metric alarm or composite alarm.
Timestamp (datetime) --
The time stamp for the alarm history item.
HistoryItemType (string) --
The type of alarm history item.
HistorySummary (string) --
A summary of the alarm history, in text format.
HistoryData (string) --
Data about the alarm, in JSON format.
NextToken (string) --
The token that marks the start of the next batch of returned results.
disable_actions
()¶Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
See also: AWS API Documentation
Request Syntax
response = alarm.disable_actions()
enable_actions
()¶Enables the actions for the specified alarms.
See also: AWS API Documentation
Request Syntax
response = alarm.enable_actions()
get_available_subresources
()¶Returns a list of all the available sub-resources for this Resource.
load
()¶Calls CloudWatch.Client.describe_alarms()
to update the attributes of the Alarm resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
alarm.load()
reload
()¶Calls CloudWatch.Client.describe_alarms()
to update the attributes of the Alarm resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
alarm.reload()
set_state
(**kwargs)¶Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM
sends an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory .
If you use SetAlarmState
on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData
parameter to enable the policy to take the correct action.
See also: AWS API Documentation
Request Syntax
response = alarm.set_state(
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
StateReason='string',
StateReasonData='string'
)
[REQUIRED]
The value of the state.
[REQUIRED]
The reason that this alarm is set to this specific state, in text format.
The reason that this alarm is set to this specific state, in JSON format.
For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
None
CloudWatch.
Metric
(namespace, name)¶A resource representing an Amazon CloudWatch Metric:
import boto3
cloudwatch = boto3.resource('cloudwatch')
metric = cloudwatch.Metric('namespace','name')
These are the resource's available identifiers:
These are the resource's available attributes:
These are the resource's available actions:
These are the resource's available collections:
Identifiers
Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide.
namespace
¶(string) The Metric's namespace identifier. This must be set.
name
¶(string) The Metric's name identifier. This must be set.
Attributes
Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the load()
method.
For more information about attributes refer to the Resources Introduction Guide.
dimensions
¶(list) --
The dimensions for the metric.
(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 (:
).
Value (string) --
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
metric_name
¶(string) --
The name of the metric. This is a required field.
Actions
Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide.
get_available_subresources
()¶Returns a list of all the available sub-resources for this Resource.
get_statistics
(**kwargs)¶Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
StorageResolution
of 1.Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide .
See also: AWS API Documentation
Request Syntax
response = metric.get_statistics(
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Period=123,
Statistics=[
'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
],
ExtendedStatistics=[
'string',
],
Unit='Seconds'|'Microseconds'|'Milliseconds'|'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'
)
The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide . For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide .
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
[REQUIRED]
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
If you set Period
to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
[REQUIRED]
The time stamp that determines the last data point to return.
The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
[REQUIRED]
The granularity, in seconds, of the returned data points. 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:
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics
. When calling GetMetricStatistics
, you must specify either Statistics
or ExtendedStatistics
, but not both.
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics
, you must specify either Statistics
or ExtendedStatistics
, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Unit
, 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.dict
Response Syntax
{
'Label': 'string',
'Datapoints': [
{
'Timestamp': datetime(2015, 1, 1),
'SampleCount': 123.0,
'Average': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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',
'ExtendedStatistics': {
'string': 123.0
}
},
]
}
Response Structure
(dict) --
Label (string) --
A label for the specified metric.
Datapoints (list) --
The data points for the specified metric.
(dict) --
Encapsulates the statistical data that CloudWatch computes from metric data.
Timestamp (datetime) --
The time stamp used for the data point.
SampleCount (float) --
The number of metric values that contributed to the aggregate value of this data point.
Average (float) --
The average of the metric values that correspond to the data point.
Sum (float) --
The sum of the metric values for the data point.
Minimum (float) --
The minimum metric value for the data point.
Maximum (float) --
The maximum metric value for the data point.
Unit (string) --
The standard unit for the data point.
ExtendedStatistics (dict) --
The percentile statistic for the data point.
load
()¶Calls CloudWatch.Client.list_metrics()
to update the attributes of the Metric resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
metric.load()
put_alarm
(**kwargs)¶Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
iam:CreateServiceLinkedRole
for all alarms with EC2 actionsiam:CreateServiceLinkedRole
to create an alarm with Systems Manager OpsItem actions.The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents
and AWSServiceRoleForCloudWatchAlarms_ActionSSM
. For more information, see Amazon Web Services service-linked role .
Cross-account alarms
You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:
See also: AWS API Documentation
Request Syntax
alarm = metric.put_alarm(
AlarmName='string',
AlarmDescription='string',
ActionsEnabled=True|False,
OKActions=[
'string',
],
AlarmActions=[
'string',
],
InsufficientDataActions=[
'string',
],
Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
ExtendedStatistic='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Period=123,
Unit='Seconds'|'Microseconds'|'Milliseconds'|'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',
EvaluationPeriods=123,
DatapointsToAlarm=123,
Threshold=123.0,
ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'|'LessThanLowerOrGreaterThanUpperThreshold'|'LessThanLowerThreshold'|'GreaterThanUpperThreshold',
TreatMissingData='string',
EvaluateLowSampleCountPercentile='string',
Metrics=[
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'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'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ThresholdMetricId='string'
)
[REQUIRED]
The name for the alarm. This name must be unique within the Region.
TRUE
.The actions to execute when this alarm transitions to an OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:*region* :ec2:stop
| arn:aws:automate:*region* :ec2:terminate
| arn:aws:automate:*region* :ec2:recover
| arn:aws:automate:*region* :ec2:reboot
| ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Valid Values (for use with IAM roles): arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:*region* :ec2:stop
| arn:aws:automate:*region* :ec2:terminate
| arn:aws:automate:*region* :ec2:recover
| arn:aws:automate:*region* :ec2:reboot
| ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name `` | ``arn:aws:ssm:region :account-id :opsitem:severity `` | ``arn:aws:ssm-incidents::account-id :response-plan:response-plan-name ``
Valid Values (for use with IAM roles): arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Recover/1.0
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:*region* :ec2:stop
| arn:aws:automate:*region* :ec2:terminate
| arn:aws:automate:*region* :ec2:recover
| arn:aws:automate:*region* :ec2:reboot
| ``arn:aws:sns:region :account-id :sns-topic-name `` | ``arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id :autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name ``
Valid Values (for use with IAM roles): >arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Stop/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Terminate/1.0
| arn:aws:swf:*region* :*account-id* :action/actions/AWS_EC2.InstanceId.Reboot/1.0
MetricName
, other than percentile. For percentile statistics, use ExtendedStatistic
. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or ExtendedStatistic,
but not both.MetricName
. Specify a value between p0.0 and p100. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or ExtendedStatistic,
but not both.The dimensions for the metric specified in MetricName
.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The length, in seconds, used each time the metric specified in MetricName
is evaluated. Valid values are 10, 30, and any multiple of 60.
Period
is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in theMetrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData
call with a StorageResolution
of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing .
An alarm's total current evaluation period can be no longer than one day, so Period
multiplied by EvaluationPeriods
cannot be more than 86,400 seconds.
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you don't specify Unit
, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting Unit
so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA
state.
[REQUIRED]
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period
cannot be more than 86,400 seconds.
The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
[REQUIRED]
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
The values LessThanLowerOrGreaterThanUpperThreshold
, LessThanLowerThreshold
, and GreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.
Sets how this alarm is to handle missing data points. If TreatMissingData
is omitted, the default behavior of missing
is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data .
Valid Values: breaching | notBreaching | ignore | missing
Note
Alarms that evaluate metrics in the AWS/DynamoDB
namespace always ignore
missing data even if you choose a different option for TreatMissingData
. When an AWS/DynamoDB
metric has missing data, alarms that evaluate that metric remain in their current state.
Used only for alarms based on percentiles. If you specify ignore
, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate
or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples .
Valid Values: evaluate | ignore
An array of MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm
operation, you must specify either MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate this expression by setting ReturnData
to true for this object in the array. For more information, see MetricDataQuery .
If you use the Metrics
parameter, you cannot include the MetricName
, Dimensions
, Period
, Namespace
, Statistic
, or ExtendedStatistic
parameters of PutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics
array.
This structure is used in both GetMetricData
and PutMetricAlarm
. The supported use of this structure is different for those two operations.
When used in GetMetricData
, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData
call can include up to 500 MetricDataQuery
structures.
When used in PutMetricAlarm
, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery
in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm
call can include up to 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, one must have True
as the value for ReturnData
. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
operation or a PutMetricAlarm
operation. These differences are explained in the following parameter list.
A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData
. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat
but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric. This is a required field.
The dimensions for the metric.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
The granularity, in seconds, of the returned data points. 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:
The statistic to return. It can include any CloudWatch statistic or extended statistic.
When you are using a Put
operation, this defines what unit you want to use when storing the metric.
In a Get
operation, 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.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide .
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.
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 .
When used in GetMetricData
, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False
. If you omit this, the default of True
is used.
When used in PutMetricAlarm
, specify True
for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
operation, specify ReturnData
as False.
The granularity, in seconds, of the returned data points. 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
operation that includes a StorageResolution of 1 second
.
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm
operations. It is not used in GetMetricData
operations.
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
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.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource .
A key-value pair associated with a CloudWatch resource.
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.
The value for the specified tag key.
If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND
function.
For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
cloudwatch.Alarm
Alarm resource
put_data
()¶Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics .
You can publish either individual data points in the Value
field, or arrays of values and the number of times each value occurred during the period by using the Values
and Counts
fields in the MetricDatum
structure. Using the Values
and Counts
method enables you to publish up to 150 values per metric with one PutMetricData
request, and supports retrieving percentile statistics on this data.
Each PutMetricData
request is limited to 1 MB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 1000 different metrics.
Although the Value
parameter accepts numbers of type Double
, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide .
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics .
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
SampleCount
value of the statistic set is 1 and Min
, Max
, and Sum
are all equal.Min
and Max
are equal, and Sum
is equal to Min
multiplied by SampleCount
.See also: AWS API Documentation
Request Syntax
response = metric.put_data()
reload
()¶Calls CloudWatch.Client.list_metrics()
to update the attributes of the Metric resource. Note that the load and reload methods are the same method and can be used interchangeably.
See also: AWS API Documentation
Request Syntax
metric.reload()
Collections
Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide.
alarms
¶A collection of Alarm resources.A Alarm Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.
all
()¶Creates an iterable of all Alarm resources in the collection.
See also: AWS API Documentation
Request Syntax
alarm_iterator = metric.alarms.all()
cloudwatch.Alarm
)delete
()¶Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
In the event of an error, no alarms are deleted.
Note
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule
of one of the alarms to False
.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
See also: AWS API Documentation
Request Syntax
response = metric.alarms.delete()
disable_actions
()¶Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
See also: AWS API Documentation
Request Syntax
response = metric.alarms.disable_actions()
enable_actions
()¶Enables the actions for the specified alarms.
See also: AWS API Documentation
Request Syntax
response = metric.alarms.enable_actions()
filter
(**kwargs)¶Creates an iterable of all Alarm resources in the collection filtered by kwargs passed to method. A Alarm collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.
See also: AWS API Documentation
Request Syntax
alarm_iterator = metric.alarms.filter(
Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
ExtendedStatistic='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Period=123,
Unit='Seconds'|'Microseconds'|'Milliseconds'|'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'
)
ExtendedStatistics
.The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
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.
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 (:
).
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
list(cloudwatch.Alarm
)
A list of Alarm resources
limit
(**kwargs)¶Creates an iterable up to a specified amount of Alarm resources in the collection.
See also: AWS API Documentation
Request Syntax
alarm_iterator = metric.alarms.limit(
count=123
)
cloudwatch.Alarm
)page_size
(**kwargs)¶Creates an iterable of all Alarm resources in the collection, but limits the number of items returned by each service call by the specified amount.
See also: AWS API Documentation
Request Syntax
alarm_iterator = metric.alarms.page_size(
count=123
)
cloudwatch.Alarm
)