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 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.
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.
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.
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.
String unit
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.
String label
A label for the specified metric.
SdkInternalList<T> datapoints
The data points for the specified metric.
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 namespace
The namespace of the metric.
String metricName
The name of the metric.
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.
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.
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.
String unit
The unit of 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.
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 the AWS account.
String alarmDescription
The description for the alarm.
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 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: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
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: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
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: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
String metricName
The name for the metric associated with the alarm.
String namespace
The namespace for 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
. When you call PutMetricAlarm
, you must specify either
Statistic
or ExtendedStatistic,
but not both.
String extendedStatistic
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. When
you call PutMetricAlarm
, you must specify either Statistic
or
ExtendedStatistic,
but not both.
SdkInternalList<T> dimensions
The dimensions for the metric associated with the alarm.
Integer period
The period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.
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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm
can get stuck in the INSUFFICIENT DATA
state.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold. 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.
Double threshold
The value against which the specified statistic is compared.
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 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
String namespace
The namespace for the metric data.
You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for use by Amazon Web Services products.
SdkInternalList<T> metricData
The data for the metric.
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.
Copyright © 2018. All rights reserved.