Skip to main content


No description

type AWSCloudWatchMetricAlarm {
metadata: ResourceMetadata!
actionsEnabled: Boolean!
alarmActions: [AWSCloudWatchAlarmAction!]!
arn: String!
configurationUpdatedAt: DateTime
description: String!
name: String!
comparisonOperator: AWSCloudWatchMetricAlarmComparisonOperatorType!
datapointsToAlarm: Int!
dimensions: [AWSCloudWatchMetricDimension!]!
evaluateLowSampleCountPercentile: String!
evaluationPeriods: Int!
evaluationState: AWSCloudWatchMetricAlarmEvaluationStateType!
extendedStatistic: String!
insufficientDataActions: [AWSCloudWatchAlarmAction!]!
metricName: String!
metrics: [AWSCloudWatchMetricDataQuery!]!
namespace: String!
okActions: [AWSCloudWatchAlarmAction!]!
period: Int!
stateReason: String!
stateReasonData: String!
stateTransitionedAt: DateTime
stateUpdatedAt: DateTime
stateValue: AWSCloudWatchAlarmStateValueType!
statistic: AWSCloudWatchMetricAlarmStatisticType!
threshold: Float64!
thresholdMetricId: String!
treatMissingData: String!
unit: AWSCloudWatchMetricStandardUnitType!


AWSCloudWatchMetricAlarm.metadata ● ResourceMetadata! non-null object

The metadata to identify this API in Shisho Cloud

AWSCloudWatchMetricAlarm.actionsEnabled ● Boolean! non-null scalar

Indicates whether actions should be executed during any changes to the alarm state

AWSCloudWatchMetricAlarm.alarmActions ● [AWSCloudWatchAlarmAction!]! non-null union

The actions to execute when this alarm transitions to the ALARM state from any other state

AWSCloudWatchMetricAlarm.arn ● String! non-null scalar

The Amazon Resource Name (ARN) of the alarm

AWSCloudWatchMetricAlarm.configurationUpdatedAt ● DateTime scalar

The time stamp of the last update to the alarm configuration

AWSCloudWatchMetricAlarm.description ● String! non-null scalar

The description of the alarm ● String! non-null scalar

The name of the alarm

AWSCloudWatchMetricAlarm.comparisonOperator ● AWSCloudWatchMetricAlarmComparisonOperatorType! non-null enum

The arithmetic operation to use when comparing the specified statistic and threshold

AWSCloudWatchMetricAlarm.datapointsToAlarm ● Int! non-null scalar

The number of data points that must be breaching to trigger the alarm

AWSCloudWatchMetricAlarm.dimensions ● [AWSCloudWatchMetricDimension!]! non-null object

The dimensions for the metric associated with the alarm

AWSCloudWatchMetricAlarm.evaluateLowSampleCountPercentile ● String! non-null scalar

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.

AWSCloudWatchMetricAlarm.evaluationPeriods ● Int! non-null scalar

The number of periods over which data is compared to the specified threshold

AWSCloudWatchMetricAlarm.evaluationState ● AWSCloudWatchMetricAlarmEvaluationStateType! non-null enum

If the value of this field is PARTIAL_DATA , the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics

AWSCloudWatchMetricAlarm.extendedStatistic ● String! non-null scalar

The percentile statistic for the metric associated with the alarm

AWSCloudWatchMetricAlarm.insufficientDataActions ● [AWSCloudWatchAlarmAction!]! non-null union

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state

AWSCloudWatchMetricAlarm.metricName ● String! non-null scalar

The name of the metric associated with the alarm

AWSCloudWatchMetricAlarm.metrics ● [AWSCloudWatchMetricDataQuery!]! non-null object

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

AWSCloudWatchMetricAlarm.namespace ● String! non-null scalar

The namespace of the metric associated with the alarm

AWSCloudWatchMetricAlarm.okActions ● [AWSCloudWatchAlarmAction!]! non-null union

The actions to execute when this alarm transitions to the OK state from any other state

AWSCloudWatchMetricAlarm.period ● Int! non-null scalar

The period, in seconds, over which the statistic is applied

AWSCloudWatchMetricAlarm.stateReason ● String! non-null scalar

An explanation for the alarm state, in text format

AWSCloudWatchMetricAlarm.stateReasonData ● String! non-null scalar

An explanation for the alarm state, in JSON format

AWSCloudWatchMetricAlarm.stateTransitionedAt ● DateTime scalar

The date and time that the alarm's StateValue most recently changed

AWSCloudWatchMetricAlarm.stateUpdatedAt ● DateTime scalar

The time stamp of the last update to the value of either the StateValue or EvaluationState parameters

AWSCloudWatchMetricAlarm.stateValue ● AWSCloudWatchAlarmStateValueType! non-null enum

The state value for the alarm

AWSCloudWatchMetricAlarm.statistic ● AWSCloudWatchMetricAlarmStatisticType! non-null enum

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic

AWSCloudWatchMetricAlarm.threshold ● Float64! non-null scalar

The value to compare with the specified statistic

AWSCloudWatchMetricAlarm.thresholdMetricId ● String! non-null scalar

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

AWSCloudWatchMetricAlarm.treatMissingData ● String! non-null scalar

Sets how this alarm is to handle missing data points. The valid values are breaching , notBreaching , ignore , and missing . For more information, see Configuring how CloudWatch alarms treat missing data . If this parameter is omitted, the default behavior of missing is used

AWSCloudWatchMetricAlarm.unit ● AWSCloudWatchMetricStandardUnitType! non-null enum

The unit of the metric associated with the alarm

Implemented by

AWSCloudWatchAlarm union