2016/11/17 - Amazon CloudWatch - 4 updated api methods
Changes Update cloudwatch client to latest version
{'MetricAlarms': {'ExtendedStatistic': 'string'}}
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
Request Syntax
client.describe_alarms(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string'
)
list
The names of the alarms.
(string) --
string
The alarm name prefix. You cannot specify AlarmNames if this parameter is specified.
string
The state value to be used in matching alarms.
string
The action name prefix.
integer
The maximum number of alarm descriptions to retrieve.
string
The token returned by a previous call to indicate that there is more data available.
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,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricAlarms (list) --
The information for the specified alarms.
(dict) --
Represents an 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).
(string) --
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).
(string) --
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).
(string) --
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.
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) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
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.
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.
NextToken (string) --
The token that marks the start of the next batch of returned results.
{'ExtendedStatistic': 'string'}
Response {'MetricAlarms': {'ExtendedStatistic': 'string'}}
Retrieves the alarms for the specified metric. Specify a statistic, period, or unit to filter the results.
Request Syntax
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'
)
string
[REQUIRED]
The name of the metric.
string
[REQUIRED]
The namespace of the metric.
string
The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
string
The percentile statistic for the metric. Specify a value between p0.0 and p100.
list
The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
(dict) --
Expands the identity of a metric.
Name (string) -- [REQUIRED]
The name of the dimension.
Value (string) -- [REQUIRED]
The value representing the dimension measurement.
integer
The period, in seconds, over which the statistic is applied.
string
The unit for the metric.
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,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'
},
]
}
Response Structure
(dict) --
MetricAlarms (list) --
The information for each alarm with the specified metric.
(dict) --
Represents an 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).
(string) --
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).
(string) --
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).
(string) --
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.
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) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
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.
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.
{'ExtendedStatistics': ['string']}
Response {'Datapoints': {'ExtendedStatistics': {'string': 'double'}}}
Gets statistics for the specified metric.
Amazon CloudWatch retains metric data as follows:
Data points with a period of 60 seconds (1 minute) are available for 15 days
Data points with a period of 300 seconds (5 minute) are available for 63 days
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)
Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon 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. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.
Amazon 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, Amazon 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.
For a list of metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
Request Syntax
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'
)
string
[REQUIRED]
The namespace of the metric, with or without spaces.
string
[REQUIRED]
The name of the metric, with or without spaces.
list
The dimensions. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. 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.
(dict) --
Expands the identity of a metric.
Name (string) -- [REQUIRED]
The name of the dimension.
Value (string) -- [REQUIRED]
The value representing the dimension measurement.
datetime
[REQUIRED]
The time stamp that determines the first data point to return. Note that 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. 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:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
datetime
[REQUIRED]
The time stamp that determines the last data point to return.
The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
integer
[REQUIRED]
The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.
If the StartTime parameter specifies a time stamp that is greater than 15 days ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
list
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.
(string) --
list
The percentile statistics. Specify values between p0.0 and p100.
(string) --
string
The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.
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 Amazon 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.
(string) --
(float) --
{'ExtendedStatistic': 'string'}
Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its state is set appropriately. Any actions associated with the 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 AWS Identity and Access Management (IAM) user, you must have Amazon EC2 permissions for some operations:
ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics
ec2:StopInstances for alarms with stop actions
ec2:TerminateInstances for alarms with terminate actions
ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances for alarms with recover actions
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions won't be performed. However, if you are later granted the required permissions, the alarm actions that you created earlier will be performed.
If you are using an IAM role (for example, an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.
Note that you must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or an API.
Request Syntax
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,
Threshold=123.0,
ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold'
)
string
[REQUIRED]
The name for the alarm. This name must be unique within the AWS account.
string
The description for the alarm.
boolean
Indicates whether actions should be executed during any changes to the alarm state.
list
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
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
(string) --
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).
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
(string) --
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).
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
(string) --
string
[REQUIRED]
The name for the metric associated with the alarm.
string
[REQUIRED]
The namespace for the metric associated with the alarm.
string
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
string
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
list
The dimensions for the metric associated with the alarm.
(dict) --
Expands the identity of a metric.
Name (string) -- [REQUIRED]
The name of the dimension.
Value (string) -- [REQUIRED]
The value representing the dimension measurement.
integer
[REQUIRED]
The period, in seconds, over which the specified statistic is applied.
string
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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.
integer
[REQUIRED]
The number of periods over which data is compared to the specified threshold.
float
[REQUIRED]
The value against which the specified statistic is compared.
string
[REQUIRED]
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
None