String alarmName
The descriptive name for the alarm.
Date timestamp
The time stamp for the alarm history item.
String historyItemType
The type of alarm history item.
String historySummary
A summary of the alarm history, in text format.
String historyData
Data about the alarm, in JSON format.
String namespace
The namespace of the metric associated with the anomaly detection model.
String metricName
The name of the metric associated with the anomaly detection model.
SdkInternalList<T> dimensions
The metric dimensions associated with the anomaly detection model.
String stat
The statistic associated with the anomaly detection model.
AnomalyDetectorConfiguration configuration
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.
SdkInternalList<T> excludedTimeRanges
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.
String metricTimezone
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.
String dashboardName
The name of the dashboard.
String dashboardArn
The Amazon Resource Name (ARN) of the dashboard.
Date lastModified
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.
Long size
The size of the dashboard, in bytes.
SdkInternalList<T> dashboardValidationMessages
Date timestamp
The time stamp used for the data point.
Double sampleCount
The number of metric values that contributed to the aggregate value of this data point.
Double average
The average of the metric values that correspond to the data point.
Double sum
The sum of the metric values for the data point.
Double minimum
The minimum metric value for the data point.
Double maximum
The maximum metric value for the data point.
String unit
The standard unit for the data point.
Map<K,V> extendedStatistics
The percentile statistic for the data point.
SdkInternalList<T> alarmNames
The alarms to be deleted.
String namespace
The namespace associated with the anomaly detection model to delete.
String metricName
The metric name associated with the anomaly detection model to delete.
SdkInternalList<T> dimensions
The metric dimensions associated with the anomaly detection model to delete.
String stat
The statistic associated with the anomaly detection model to delete.
SdkInternalList<T> dashboardNames
The dashboards to be deleted. This parameter is required.
String alarmName
The name of the alarm.
String historyItemType
The type of alarm histories to retrieve.
Date startDate
The starting date to retrieve alarm history.
Date endDate
The ending date to retrieve alarm history.
Integer maxRecords
The maximum number of alarm history records to retrieve.
String nextToken
The token returned by a previous call to indicate that there is more data available.
SdkInternalList<T> alarmHistoryItems
The alarm histories, in JSON format.
String nextToken
The token that marks the start of the next batch of returned results.
String metricName
The name of the metric.
String namespace
The namespace of the metric.
String statistic
The statistic for the metric, other than percentiles. For percentile statistics, use
ExtendedStatistics
.
String extendedStatistic
The percentile statistic for the metric. Specify a value between p0.0 and p100.
SdkInternalList<T> dimensions
The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
Integer period
The period, in seconds, over which the statistic is applied.
String unit
The unit for the metric.
SdkInternalList<T> metricAlarms
The information for each alarm with the specified metric.
SdkInternalList<T> alarmNames
The names of the alarms.
String alarmNamePrefix
The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames
.
String stateValue
The state value to be used in matching alarms.
String actionPrefix
The action name prefix.
Integer maxRecords
The maximum number of alarm descriptions to retrieve.
String nextToken
The token returned by a previous call to indicate that there is more data available.
SdkInternalList<T> metricAlarms
The information for the specified alarms.
String nextToken
The token that marks the start of the next batch of returned results.
String nextToken
Use the token returned by the previous operation to request the next page of results.
Integer maxResults
The maximum number of results to return in one operation. The maximum value you can specify is 10.
To retrieve the remaining results, make another call with the returned NextToken
value.
String namespace
Limits the results to only the anomaly detection models that are associated with the specified namespace.
String metricName
Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.
SdkInternalList<T> dimensions
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.
SdkInternalList<T> anomalyDetectors
The list of anomaly detection models returned by the operation.
String nextToken
A token that you can use in a subsequent operation to retrieve the next set of results.
SdkInternalList<T> alarmNames
The names of the alarms.
SdkInternalList<T> alarmNames
The names of the alarms.
String dashboardName
The name of the dashboard to be described.
String dashboardArn
The Amazon Resource Name (ARN) of the dashboard.
String dashboardBody
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
CloudWatch-Dashboard-Body-Structure.
String dashboardName
The name of the dashboard.
SdkInternalList<T> metricDataQueries
The metric queries to be returned. A single GetMetricData
call can include as many as 100
MetricDataQuery
structures. Each of these structures can specify either a metric to retrieve, or a
math expression to perform on retrieved data.
Date startTime
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:
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.
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
.
Date endTime
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
.
String nextToken
Include this value, if it was returned by the previous call, to get the next set of data points.
String scanBy
The order in which data points should be returned. 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.
Integer maxDatapoints
The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
SdkInternalList<T> metricDataResults
The metrics that are returned, including the metric name, namespace, and dimensions.
String nextToken
A token that marks the next batch of returned results.
SdkInternalList<T> messages
Contains a message about this GetMetricData
operation, if the operation results in such a message.
An example of a message that may 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.
String namespace
The namespace of the metric, with or without spaces.
String metricName
The name of the metric, with or without spaces.
SdkInternalList<T> dimensions
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.
Date startTime
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. 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.
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.
Date endTime
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. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
Integer period
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:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
SdkInternalList<T> statistics
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics
.
When calling GetMetricStatistics
, you must specify either Statistics
or
ExtendedStatistics
, but not both.
SdkInternalList<T> extendedStatistics
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.
String unit
The unit for a given metric. If you omit 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 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.
String label
A label for the specified metric.
SdkInternalList<T> datapoints
The data points for the specified metric.
String metricWidget
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 CloudWatch-Metric-Widget-Structure.
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.
String outputFormat
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 AWS 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.
ByteBuffer metricWidgetImage
The image of the graph, in the output format specified.
String dashboardNamePrefix
If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
String nextToken
The token returned by a previous call to indicate that there is more data available.
SdkInternalList<T> dashboardEntries
The list of matching dashboards.
String nextToken
The token that marks the start of the next batch of returned results.
String namespace
The namespace to filter against.
String metricName
The name of the metric to filter against.
SdkInternalList<T> dimensions
The dimensions to filter against.
String nextToken
The token returned by a previous call to indicate that there is more data available.
SdkInternalList<T> metrics
The metrics.
String nextToken
The token that marks the start of the next batch of returned results.
String resourceARN
The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.
SdkInternalList<T> tags
The list of tag keys and values associated with the resource you specified.
String namespace
The namespace of the metric.
String metricName
The name of the metric. This is a required field.
SdkInternalList<T> dimensions
The dimensions for the metric.
String alarmName
The name of the alarm.
String alarmArn
The Amazon Resource Name (ARN) of the alarm.
String alarmDescription
The description of the alarm.
Date alarmConfigurationUpdatedTimestamp
The time stamp of the last update to the alarm configuration.
Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm state.
SdkInternalList<T> oKActions
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).
SdkInternalList<T> alarmActions
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).
SdkInternalList<T> insufficientDataActions
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
The state value for the alarm.
String stateReason
An explanation for the alarm state, in text format.
String stateReasonData
An explanation for the alarm state, in JSON format.
Date stateUpdatedTimestamp
The time stamp of the last update to the alarm state.
String metricName
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
String namespace
The namespace of the metric associated with the alarm.
String statistic
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
String extendedStatistic
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
SdkInternalList<T> dimensions
The dimensions for the metric associated with the alarm.
Integer period
The period, in seconds, over which the statistic is applied.
String unit
The unit of the metric associated with the alarm.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Integer datapointsToAlarm
The number of datapoints that must be breaching to trigger the alarm.
Double threshold
The value to compare with the specified statistic.
String comparisonOperator
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
String treatMissingData
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of
missing
is used.
String evaluateLowSampleCountPercentile
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.
SdkInternalList<T> metrics
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 ReturnValue
set to true.
String thresholdMetricId
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.
String id
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 metricStat
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.
String expression
The math expression to be performed on the returned data, if this object is performing a math expression. This
expression can use the Id
of the other metrics 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.
String label
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.
Boolean returnData
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.
Integer period
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
.
Use this field only when you are performing a GetMetricData
operation, and only when you are
specifying the Expression
field. Do not use this field with a PutMetricAlarm
operation
or when you are specifying a MetricStat
in a GetMetricData
operation.
String id
The short name you specified to represent this metric.
String label
The human-readable label associated with the data.
SdkInternalList<T> timestamps
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].
SdkInternalList<T> values
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].
String statusCode
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.
SdkInternalList<T> messages
A list of messages with additional information about the data returned.
String metricName
The name of the metric.
SdkInternalList<T> dimensions
The dimensions associated with the metric.
Date timestamp
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Double value
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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
StatisticSet statisticValues
The statistical values for the metric.
SdkInternalList<T> values
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 8.515920e-109 to 1.174271e+108 (Base 10)
or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not
supported.
SdkInternalList<T> counts
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.
String unit
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.
Integer storageResolution
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.
Metric metric
The metric to return, including the metric name, namespace, and dimensions.
Integer period
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:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
String stat
The statistic to return. It can include any CloudWatch statistic or extended statistic.
String unit
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 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.
String namespace
The namespace of the metric to create the anomaly detection model for.
String metricName
The name of the metric to create the anomaly detection model for.
SdkInternalList<T> dimensions
The metric dimensions to create the anomaly detection model for.
String stat
The statistic to use for the metric and the anomaly detection model.
AnomalyDetectorConfiguration configuration
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.
You can in
String dashboardName
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.
String dashboardBody
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 CloudWatch-Dashboard-Body-Structure.
SdkInternalList<T> dashboardValidationMessages
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 may not render.
If this result includes error messages, the input was not valid and the operation failed.
String alarmName
The name for the alarm. This name must be unique within your AWS account.
String alarmDescription
The description for the alarm.
Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE
.
SdkInternalList<T> oKActions
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-idautoScalingGroupName/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
SdkInternalList<T> alarmActions
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-idautoScalingGroupName/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
SdkInternalList<T> insufficientDataActions
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-idautoScalingGroupName/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
String metricName
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.
String namespace
The namespace for the metric associated specified in MetricName
.
String statistic
The statistic for the metric specified in 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.
String extendedStatistic
The percentile statistic for the metric specified in 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.
SdkInternalList<T> dimensions
The dimensions for the metric specified in MetricName
.
Integer period
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 the Metrics
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
may 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.
String unit
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 will
work 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 will behave un-predictably.
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.
Integer evaluationPeriods
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.
Integer datapointsToAlarm
The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.
Double threshold
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.
String comparisonOperator
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.
String treatMissingData
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
String evaluateLowSampleCountPercentile
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
SdkInternalList<T> metrics
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 ReturnValue
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.
SdkInternalList<T> tags
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.
String thresholdMetricId
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.
String namespace
The namespace for the metric data.
To avoid conflicts with AWS service namespaces, you should not specify a namespace that begins with
AWS/
SdkInternalList<T> metricData
The data for the metric. The array can include no more than 20 metrics per call.
String alarmName
The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.
String stateValue
The value of the state.
String stateReason
The reason that this alarm is set to this specific state, in text format.
String stateReasonData
The reason that this alarm is set to this specific state, in JSON format.
String resourceARN
The ARN of the CloudWatch alarm that you're adding tags to. The ARN format is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
SdkInternalList<T> tags
The list of key-value pairs to associate with the alarm.
String resourceARN
The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.
SdkInternalList<T> tagKeys
The list of tag keys to remove from the resource.
Copyright © 2019. All rights reserved.