String alarmName
The descriptive name for the alarm.
String alarmType
The type of alarm, either metric alarm or composite 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.
String stateValue
The current status of the anomaly detector's training. The possible values are
TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
SingleMetricAnomalyDetector singleMetricAnomalyDetector
The CloudWatch metric and statistic for this anomaly detector.
MetricMathAnomalyDetector metricMathAnomalyDetector
The CloudWatch metric math expression for this anomaly detector.
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.
Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm state.
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).
String alarmArn
The Amazon Resource Name (ARN) of the alarm.
Date alarmConfigurationUpdatedTimestamp
The time stamp of the last update to the alarm configuration.
String alarmDescription
The description of the alarm.
String alarmName
The name of the alarm.
String alarmRule
The rule that this alarm uses to evaluate its alarm state.
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).
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).
String stateReason
An explanation for the alarm state, in text format.
String stateReasonData
An explanation for the alarm state, in JSON format.
Date stateUpdatedTimestamp
Tracks the timestamp of any state update, even if StateValue doesn't change.
String stateValue
The state value for the alarm.
Date stateTransitionedTimestamp
The timestamp of the last change to the alarm's StateValue.
String actionsSuppressedBy
When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in
ALARM When the value is WaitPeriod, it means that the actions are suppressed because
the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum
waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm
performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed
because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The
maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the
composite alarm performs its actions.
String actionsSuppressedReason
Captures the reason for action suppression.
String actionsSuppressor
Actions will be suppressed if the suppressor alarm is in the ALARM state.
ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
Integer actionsSuppressorWaitPeriod
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the
ALARM state. After this time, the composite alarm performs its actions.
WaitPeriod is required only when ActionsSuppressor is specified.
Integer actionsSuppressorExtensionPeriod
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARM state. After this time, the composite alarm performs its actions.
ExtensionPeriod is required only when ActionsSuppressor is specified.
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.
SingleMetricAnomalyDetector singleMetricAnomalyDetector
A single metric anomaly detector to be deleted.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same
operation:
Dimensions,
MetricName
Namespace
Stat
the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the
SingleMetricAnomalyDetector property.
MetricMathAnomalyDetector metricMathAnomalyDetector
The metric math anomaly detector to be deleted.
When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:
Dimensions,
MetricName
Namespace
Stat
the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the
MetricMathAnomalyDetector property.
SdkInternalList<T> dashboardNames
The dashboards to be deleted. This parameter is required.
SdkInternalList<T> ruleNames
An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
SdkInternalList<T> failures
An array listing the rules that could not be deleted. You cannot delete built-in rules.
String name
The name of the metric stream to delete.
String alarmName
The name of the alarm.
SdkInternalList<T> alarmTypes
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
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.
String scanBy
Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
have the newest event history returned first, and specify TimestampAscending to have the oldest
history returned first.
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 to retrieve information about.
String alarmNamePrefix
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify AlarmNames.
SdkInternalList<T> alarmTypes
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
String childrenOfAlarmName
If you use this parameter and specify the name of a composite alarm, the operation returns information about the
"children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the
AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName.
Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.
If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except
for MaxRecords and NextToken. If you do so, you receive a validation error.
Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and
StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get
complete information about these alarms, perform another DescribeAlarms operation and specify the
parent alarm names in the AlarmNames parameter.
String parentsOfAlarmName
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information
about the "parent" alarms of the alarm you specify. These are the composite alarms that have
AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information
about the alarm that you specify in ParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for
MaxRecords and NextToken. If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete
information about these alarms, perform another DescribeAlarms operation and specify the parent
alarm names in the AlarmNames parameter.
String stateValue
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
String actionPrefix
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
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> compositeAlarms
The information about any composite alarms returned by the operation.
SdkInternalList<T> metricAlarms
The information about any metric alarms returned by the operation.
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 that you can specify is 100.
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> anomalyDetectorTypes
The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults
to SINGLE_METRIC.
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.
String nextToken
If this parameter is present, it is a token that marks the start of the next batch of returned results.
SdkInternalList<T> insightRules
The rules returned by the operation.
String name
The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
non-whitespace character, and cannot start with a colon (:).
String value
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
SdkInternalList<T> alarmNames
The names of the alarms.
SdkInternalList<T> ruleNames
An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
SdkInternalList<T> failures
An array listing the rules that could not be disabled. You cannot disable built-in rules.
SdkInternalList<T> alarmNames
The names of the alarms.
SdkInternalList<T> ruleNames
An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
SdkInternalList<T> failures
An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
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 Dashboard Body Structure and Syntax.
String dashboardName
The name of the dashboard.
String ruleName
The name of the rule that you want to see data from.
Date startTime
The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
Date endTime
The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
Integer period
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
Integer maxContributorCount
The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.
SdkInternalList<T> metrics
Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:
UniqueContributors -- the number of unique contributors for each data point.
MaxContributorValue -- the value of the top contributor for each data point. The identity of the
contributor might change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
highest sum in the log field specified by the rule's Value, during that period.
SampleCount -- the number of data points matched by the rule.
Sum -- the sum of the values from all contributors during the time period represented by that data
point.
Minimum -- the minimum value from a single observation during the time period represented by that
data point.
Maximum -- the maximum value from a single observation during the time period represented by that
data point.
Average -- the average value from all contributors during the time period represented by that data
point.
String orderBy
Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.
SdkInternalList<T> keyLabels
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
String aggregationStatistic
Specifies whether this rule aggregates contributor data by COUNT or SUM.
Double aggregateValue
The sum of the values from all individual contributors that match the rule.
Long approximateUniqueCount
An approximate count of the unique contributors found by this rule in this time period.
SdkInternalList<T> contributors
An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.
SdkInternalList<T> metricDatapoints
A time series of metric data points that matches the time period in the rule request.
SdkInternalList<T> metricDataQueries
The metric queries to be returned. A single GetMetricData call can include as many as 500
MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, a
Metrics Insights query, 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 GetMetricData operation, 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.
LabelOptions labelOptions
This structure includes the Timezone parameter, which you can use to specify your time zone so that
the labels of returned data display the correct time for your time zone.
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 might 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. In a raw HTTP query, 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. In a raw HTTP query, 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 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 name
The name of the metric stream to retrieve information about.
String arn
The ARN of the metric stream.
String name
The name of the metric stream.
SdkInternalList<T> includeFilters
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
SdkInternalList<T> excludeFilters
If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.
String firehoseArn
The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
String roleArn
The ARN of the IAM role that is used by this metric stream.
String state
The state of the metric stream. The possible values are running and stopped.
Date creationDate
The date that the metric stream was created.
Date lastUpdateDate
The date of the most recent update to the metric stream's configuration.
String outputFormat
The output format for the stream. Valid values are json and opentelemetry0.7. For more
information about metric stream output formats, see Metric streams output formats.
SdkInternalList<T> statisticsConfigurations
Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.
Boolean includeLinkedAccountsMetrics
If this is true and this metric stream is in a monitoring account, then the stream includes metrics
from source accounts that the monitoring account is linked to.
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 GetMetricWidgetImage: Metric Widget Structure and Syntax.
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 Amazon Web Services 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. The output is base64-encoded.
String name
The name of the rule.
String state
Indicates whether the rule is enabled or disabled.
String schema
For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed
rules, this is {"Name": "ServiceLogRule", "Version": 1}
String definition
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
Boolean managedRule
An optional built-in rule that Amazon Web Services manages.
SdkInternalList<T> keys
One of the log entry field keywords that is used to define contributors for this rule.
Double approximateAggregateValue
An approximation of the aggregate value that comes from this contributor.
SdkInternalList<T> datapoints
An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
Date timestamp
The timestamp of the data point.
Double uniqueContributors
The number of unique contributors who published data during this timestamp.
This statistic is returned only if you included it in the Metrics array in your request.
Double maxContributorValue
The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, so the identity of the max contributor could be different for each timestamp.
This statistic is returned only if you included it in the Metrics array in your request.
Double sampleCount
The number of occurrences that matched the rule during this data point.
This statistic is returned only if you included it in the Metrics array in your request.
Double average
The average value from all contributors during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics array in your request.
Double sum
The sum of the values from all contributors during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics array in your request.
Double minimum
The minimum value from a single contributor during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics array in your request.
Double maximum
The maximum value from a single occurence from a single contributor during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics array in your request.
String timezone
The time zone to use for metric data return in this operation. The format is + or -
followed by four digits. The first two digits indicate the number of hours ahead or behind of UTC, and the final
two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30 minutes
ahead of UTC. The default is +0000.
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 resourceARN
The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
String nextToken
Include this value to get the next set of rules if the value was returned by the previous operation.
Integer maxResults
The maximum number of results to return in one operation. If you omit this parameter, the default number is used.
The default number is 100.
SdkInternalList<T> managedRules
The managed rules that are available for the specified Amazon Web Services resource.
String nextToken
Include this value to get the next set of rules if the value was returned by the previous operation.
String namespace
The metric namespace to filter against. Only the namespace that matches exactly will be returned.
String metricName
The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
SdkInternalList<T> dimensions
The dimensions to filter against. Only the dimensions that match exactly will be returned.
String nextToken
The token returned by a previous call to indicate that there is more data available.
String recentlyActive
To filter the results to show only metrics that have had data points published in the past three hours, specify
this parameter with a value of PT3H. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
Boolean includeLinkedAccounts
If you are using this operation in a monitoring account, specify true to include metrics from source
accounts in the returned data.
The default is false.
String owningAccount
When you use this operation in a monitoring account, use this field to return metrics only from one source
account. To do so, specify that source account ID in this field, and also specify true for
IncludeLinkedAccounts.
SdkInternalList<T> metrics
The metrics that match your request.
String nextToken
The token that marks the start of the next batch of returned results.
SdkInternalList<T> owningAccounts
If you are using this operation in a monitoring account, this array contains the account IDs of the source accounts where the metrics in the returned data are from.
This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.
String nextToken
The token that marks the start of the next batch of returned results. You can use this token in a subsequent operation to get the next batch of results.
SdkInternalList<T> entries
The array of metric stream information.
String resourceARN
The ARN of the CloudWatch resource that you want to view tags for.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
SdkInternalList<T> tags
The list of tag keys and values associated with the resource you specified.
String templateName
The template name for the managed Contributor Insights rule, as returned by ListManagedInsightRules.
String resourceARN
The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
SdkInternalList<T> tags
A list of key-value pairs that you can associate with a managed Contributor Insights rule. You can associate as
many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use them to
scope user permissions by granting a user permission to access or change only the resources that have certain tag
values. To associate tags with a rule, you must have the cloudwatch:TagResource permission in
addition to the cloudwatch:PutInsightRule permission. If you are using this operation to update an
existing Contributor Insights rule, any tags that you specify in this parameter are ignored. To change the tags
of an existing rule, use TagResource.
String templateName
The template name for the managed rule. Used to enable managed rules using PutManagedInsightRules.
String resourceARN
If a managed rule is enabled, this is the ARN for the related Amazon Web Services resource.
ManagedRuleState ruleState
Describes the state of a managed rule. If present, it contains information about the Contributor Insights rule that contains information about the related Amazon Web Services resource.
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 value of either the StateValue or
EvaluationState parameters.
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 data points 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. 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.
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 ReturnData 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 evaluationState
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. For more information, see Create
alarms on Metrics Insights queries.
Date stateTransitionedTimestamp
The date and time that the alarm's StateValue most recently changed.
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
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide.
A math expression can use the Id of the other metrics or queries 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.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
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.
String accountId
The ID of the account where the metrics are located.
If you are performing a GetMetricData operation in a monitoring account, use this to specify which
account to retrieve this metric from.
If you are performing a PutMetricAlarm operation, use this to specify which account contains the
metric that the alarm is watching.
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 -2^360 to 2^360. 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 -2^360 to 2^360. 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.
SdkInternalList<T> metricDataQueries
An array of metric data query structures that enables you to create an anomaly detector based on the result of a
metric math expression. Each item in MetricDataQueries gets a metric or performs a math expression.
One item in MetricDataQueries is the expression that provides the time series that the anomaly
detector uses as input. Designate the expression by setting ReturnData to true for this
object in the array. For all other expressions and metrics, set ReturnData to false.
The designated expression must return a single time series.
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 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 arn
The ARN of the metric stream.
Date creationDate
The date that the metric stream was originally created.
Date lastUpdateDate
The date that the configuration of this metric stream was most recently updated.
String name
The name of the metric stream.
String firehoseArn
The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
String state
The current state of this stream. Valid values are running and stopped.
String outputFormat
The output format of this metric stream. Valid values are json and opentelemetry0.7.
String namespace
The name of the metric namespace in the filter.
SdkInternalList<T> includeMetrics
An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
AdditionalStatistics parameter. There can be as many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
SdkInternalList<T> additionalStatistics
The list of additional statistics that are to be streamed for the metrics listed in the
IncludeMetrics array in this structure. This list can include as many as 20 statistics.
If the OutputFormat for the stream is opentelemetry0.7, the only valid values are
p?? percentile statistics such as p90, p99 and so on.
If the OutputFormat for the stream is json, the valid values include the abbreviations
for all of the statistics listed in
CloudWatch statistics definitions. For example, this includes tm98, wm90,
PR(:300), and so on.
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.
SingleMetricAnomalyDetector singleMetricAnomalyDetector
A single metric anomaly detector to be created.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same
operation:
Dimensions
MetricName
Namespace
Stat
the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the property
SingleMetricAnomalyDetector.
MetricMathAnomalyDetector metricMathAnomalyDetector
The metric math anomaly detector to be created.
When using MetricMathAnomalyDetector, you cannot include the following parameters in the same
operation:
Dimensions
MetricName
Namespace
Stat
the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the property
MetricMathAnomalyDetector.
Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The
default is TRUE.
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:sns:region:account-id:sns-topic-name |
arn:aws:ssm:region:account-id:opsitem:severity
String alarmDescription
The description for the composite alarm.
String alarmName
The name for the composite alarm. This name must be unique within the Region.
String alarmRule
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM state.
OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state.
INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in
INSUFFICIENT_DATA state.
TRUE always evaluates to TRUE.
FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm
actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes ("), but do not have to be.
The following are some examples of AlarmRule:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the composite alarm goes
into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress) specifies that the alarm goes to
ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This
example reduces alarm noise during a known deployment window.
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) goes into
ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are
not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule can specify as many as 100 "children" alarms. The AlarmRule expression
can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.
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:sns:region:account-id:sns-topic-name
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:sns:region:account-id:sns-topic-name
SdkInternalList<T> tags
A list of key-value pairs to associate with the composite 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 actionsSuppressor
Actions will be suppressed if the suppressor alarm is in the ALARM state.
ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
Integer actionsSuppressorWaitPeriod
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the
ALARM state. After this time, the composite alarm performs its actions.
WaitPeriod is required only when ActionsSuppressor is specified.
Integer actionsSuppressorExtensionPeriod
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARM state. After this time, the composite alarm performs its actions.
ExtensionPeriod is required only when ActionsSuppressor is specified.
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 Dashboard Body Structure and Syntax.
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 might not render.
If this result includes error messages, the input was not valid and the operation failed.
String ruleName
A unique name for the rule.
String ruleState
The state of the rule. Valid values are ENABLED and DISABLED.
String ruleDefinition
The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
SdkInternalList<T> tags
A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
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 the resources that have certain tag values.
To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in
addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
SdkInternalList<T> managedRules
A list of ManagedRules to enable.
SdkInternalList<T> failures
An array that lists the rules that could not be enabled.
String alarmName
The name for the alarm. This name must be unique within the Region.
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-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 |
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/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-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
| arn:aws:ssm:region:account-id:opsitem:severity |
arn:aws:ssm-incidents::account-id:response-plan:response-plan-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 |
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/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-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. 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
might 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 works
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 it behaves unpredictably.
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 data points 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
Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore missing data
even if you choose a different option for TreatMissingData. When an AWS/DynamoDB metric
has missing data, alarms that evaluate that metric remain in their current state.
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 ReturnData 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.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
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 Amazon Web Services 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 1000 metrics per call.
String name
If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
If you are updating a metric stream, specify the name of that stream here.
Valid characters are A-Z, a-z, 0-9, "-" and "_".
SdkInternalList<T> includeFilters
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
You cannot include IncludeFilters and ExcludeFilters in the same operation.
SdkInternalList<T> excludeFilters
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
You cannot include ExcludeFilters and IncludeFilters in the same operation.
String firehoseArn
The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.
String roleArn
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:
firehose:PutRecord
firehose:PutRecordBatch
String outputFormat
The output format for the stream. Valid values are json and opentelemetry0.7. For more
information about metric stream output formats, see
Metric streams output formats.
SdkInternalList<T> tags
A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.
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.
You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.
SdkInternalList<T> statisticsConfigurations
By default, a metric stream always sends the MAX, MIN, SUM, and
SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the
metric stream also send additional statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for
those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If
the OutputFormat is json, you can stream any additional statistic that is supported by
CloudWatch, listed in
CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can
stream percentile statistics such as p95, p99.9, and so on.
Boolean includeLinkedAccountsMetrics
If you are creating a metric stream in a monitoring account, specify true to include metrics from
source accounts in the metric stream.
String arn
The ARN of the metric stream.
String alarmName
The name of the alarm.
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.
For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
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 anomaly detection model.
SdkInternalList<T> names
The array of the names of metric streams to start streaming.
This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will start streaming.
SdkInternalList<T> names
The array of the names of metric streams to stop streaming.
This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will stop streaming.
String resourceARN
The ARN of the CloudWatch resource that you're adding tags to.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
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.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
SdkInternalList<T> tagKeys
The list of tag keys to remove from the resource.
Copyright © 2023. All rights reserved.