String alarmName
The descriptive name for the alarm.
Constraints:
Length: 1 - 255
Date timestamp
The time stamp for the alarm history item.
String historyItemType
The type of alarm history item.
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
String historySummary
A human-readable summary of the alarm history.
Constraints:
Length: 1 - 255
String historyData
Machine-readable data about the alarm in JSON format.
Constraints:
Length: 1 - 4095
Date timestamp
The time stamp used for the datapoint.
Double sampleCount
The number of metric values that contributed to the aggregate value of this datapoint.
Double average
The average of metric values that correspond to the datapoint.
Double sum
The sum of metric values used for the datapoint.
Double minimum
The minimum metric value used for the datapoint.
Double maximum
The maximum of the metric value used for the datapoint.
String unit
The standard unit used for the datapoint.
Constraints:
Allowed Values: 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 alarmName
The name of the alarm.
Constraints:
Length: 1 - 255
String historyItemType
The type of alarm histories to retrieve.
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
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.
Constraints:
Range: 1 - 100
String nextToken
The token returned by a previous call to indicate that there is more data available.
Constraints:
Length: 0 - 1024
String metricName
The name of the metric.
Constraints:
Length: 1 - 255
String namespace
The namespace of the metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
The statistic for the metric.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
List<E> dimensions
The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed.
Integer period
The period in seconds over which the statistic is applied.
Constraints:
Range: 60 -
String unit
The unit for the metric.
Constraints:
Allowed Values: 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
List<E> alarmNames
A list of alarm names to retrieve information for.
String alarmNamePrefix
The alarm name prefix. AlarmNames cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
String stateValue
The state value to be used in matching alarms.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String actionPrefix
The action name prefix.
Constraints:
Length: 1 - 1024
Integer maxRecords
The maximum number of alarm descriptions to retrieve.
Constraints:
Range: 1 - 100
String nextToken
The token returned by a previous call to indicate that there is more data available.
Constraints:
Length: 0 - 1024
String namespace
The namespace of the metric, with or without spaces.
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
The name of the metric, with or without spaces.
Constraints:
Length: 1 - 255
List<E> dimensions
A list of dimensions describing qualities of the metric.
Date startTime
The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
Data that is timestamped 24 hours or more in the past may take in excess
of 48 hours to become available from submission time using
GetMetricStatistics.
Date endTime
The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
Integer period
The granularity, in seconds, of the returned datapoints.
Period must be at least 60 seconds and must be a multiple of
60. The default value is 60.
Constraints:
Range: 60 -
List<E> statistics
The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
String unit
The unit for the metric.
Constraints:
Allowed Values: 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 namespace
The namespace to filter against.
Constraints:
Length: 1 - 255
Pattern: [^:].*
String metricName
The name of the metric to filter against.
Constraints:
Length: 1 - 255
List<E> dimensions
A list of dimensions to filter against.
String nextToken
The token returned by a previous call to indicate that there is more data available.
Constraints:
Length: 0 - 1024
String alarmName
The name of the alarm.
Constraints:
Length: 1 - 255
String alarmArn
The Amazon Resource Name (ARN) of the alarm.
Constraints:
Length: 1 - 1600
String alarmDescription
The description for the alarm.
Constraints:
Length: 0 - 1024
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's state.
List<E> oKActions
The list of actions to execute when this alarm transitions into an
OK state from any other state. Each action is specified as
an Amazon Resource Name (ARN).
List<E> alarmActions
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. Each action is specified
as an Amazon Resource Name (ARN).
List<E> insufficientDataActions
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Name (ARN).
UnknownActions.String stateValue
The state value for the alarm.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String stateReason
A human-readable explanation for the alarm's state.
Constraints:
Length: 0 - 1023
String stateReasonData
An explanation for the alarm's state in machine-readable JSON format
Constraints:
Length: 0 - 4000
Date stateUpdatedTimestamp
The time stamp of the last update to the alarm's state.
String metricName
The name of the alarm's metric.
Constraints:
Length: 1 - 255
String namespace
The namespace of alarm's associated metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
The statistic to apply to the alarm's associated metric.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
List<E> dimensions
The list of dimensions associated with the alarm's associated metric.
Integer period
The period in seconds over which the statistic is applied.
Constraints:
Range: 60 -
String unit
The unit of the alarm's associated metric.
Constraints:
Allowed Values: 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
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Constraints:
Range: 1 -
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.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold,
GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
String metricName
The name of the metric.
Constraints:
Length: 1 - 255
List<E> dimensions
A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).
Date timestamp
The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.
Double value
The value for the metric.
Value parameter accepts numbers of
type Double, Amazon 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 (e.g., NaN, +Infinity, -Infinity) are not
supported. StatisticSet statisticValues
A set of statistical values describing the metric.
String unit
The unit of the metric.
Constraints:
Allowed Values: 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 alarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account
Constraints:
Length: 1 - 255
String alarmDescription
The description for the alarm.
Constraints:
Length: 0 - 1024
Boolean actionsEnabled
Indicates whether or not actions should be executed during any changes to the alarm's state.
List<E> oKActions
The list of actions to execute when this alarm transitions into an
OK state from any other state. Each action is specified as
an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
List<E> alarmActions
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. Each action is specified
as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
List<E> insufficientDataActions
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any other state. Each action is
specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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
Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
String metricName
The name for the alarm's associated metric.
Constraints:
Length: 1 - 255
String namespace
The namespace for the alarm's associated metric.
Constraints:
Length: 1 - 255
Pattern: [^:].*
String statistic
The statistic to apply to the alarm's associated metric.
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
List<E> dimensions
The dimensions for the alarm's associated metric.
Integer period
The period in seconds over which the specified statistic is applied.
Constraints:
Range: 60 -
String unit
The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
Constraints:
Allowed Values: 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
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
Constraints:
Range: 1 -
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.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold,
GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
String namespace
The namespace for the metric data.
Constraints:
Length: 1 - 255
Pattern: [^:].*
List<E> metricData
A list of data describing the metric.
String alarmName
The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.
Constraints:
Length: 1 - 255
String stateValue
The value of the state.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
String stateReason
The reason that this alarm is set to this specific state (in human-readable text format)
Constraints:
Length: 0 - 1023
String stateReasonData
The reason that this alarm is set to this specific state (in machine-readable JSON format)
Constraints:
Length: 0 - 4000
Copyright © 2019. All rights reserved.