Smaws_Client_CloudWatch.Typestype nonrec wall_clock_window = {timezone : timezone option;The time zone to use when the alarm aligns the evaluation window to clock boundaries. You can specify an IANA time zone name (for example, America/New_York), a fixed UTC offset (for example, +05:30), or an offset-prefixed identifier (for example, UTC+05:30). The offset must be aligned to a multiple of 5 minutes. If you don't specify a time zone, CloudWatch uses UTC.
The time zone affects window alignment for all periods, including periods of one hour or shorter.
*)}An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone.
When you use a wall clock window, the alarm's period must be 1 minute (60 seconds), 5 minutes (300 seconds), 1 hour (3,600 seconds), 1 day (86,400 seconds), or 1 week (604,800 seconds). Other period values aren't supported with a wall clock window.
Choose a wall clock window when your monitoring is tied to a business or calendar period, such as daily reports, batch jobs, or backups, or when you want alarm evaluations to match the periods shown on a metric dashboard.
type nonrec values = datapoint_value listtype nonrec tag_key_list = tag_key listtype nonrec untag_resource_input = {tag_keys : tag_key_list;The list of tag keys to remove from the resource.
*)resource_ar_n : amazon_resource_name;The ARN of the CloudWatch resource that you're removing tags from.
The ARN format of an alarm is
arn:aws:cloudwatch:{i Region}:{i account-id}:alarm:{i alarm-name} The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:{i Region}:{i account-id}:insight-rule/{i insight-rule-name} The ARN format of a dashboard is
arn:aws:cloudwatch::{i account-id}:dashboard/{i dashboard-name} The ARN format of a metric stream is
arn:aws:cloudwatch:{i Region}:{i account-id}:metric-stream/{i metric-stream-name} For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
*)}type nonrec resource_not_found_exception = {message : fault_description option;resource_id : resource_id option;resource_type : resource_type option;}The named resource does not exist.
The value of an input parameter is bad or out-of-range.
Request processing has failed due to some unknown error, exception, or failure.
This operation attempted to create a resource that already exists.
More than one process tried to modify a resource at the same time.
type nonrec timestamps = timestamp listtype nonrec tag = {value : tag_value;The value for the specified tag key.
*)key : tag_key;A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
*)}A key-value pair associated with a CloudWatch resource.
type nonrec tag_list = tag listtype nonrec tag_resource_input = {resource_ar_n : amazon_resource_name;The ARN of the CloudWatch resource that you're adding tags to.
The ARN format of an alarm is
arn:aws:cloudwatch:{i Region}:{i account-id}:alarm:{i alarm-name} The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:{i Region}:{i account-id}:insight-rule/{i insight-rule-name} The ARN format of a dashboard is
arn:aws:cloudwatch::{i account-id}:dashboard/{i dashboard-name} The ARN format of a metric stream is
arn:aws:cloudwatch:{i Region}:{i account-id}:metric-stream/{i metric-stream-name} For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
*)}type nonrec metric_stream_names = metric_stream_name listtype nonrec stop_metric_streams_input = {names : metric_stream_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.
*)}An input parameter that is required is missing.
type nonrec statistics = statistic listtype nonrec statistic_set = {maximum : datapoint_value;The maximum value of the sample set.
*)minimum : datapoint_value;The minimum value of the sample set.
*)sum : datapoint_value;The sum of values for the sample set.
*)sample_count : datapoint_value;The number of samples used for the statistic set.
*)}Represents a set of statistics that describes a specific metric.
type nonrec start_time_offset = Smaws_Lib.CoreTypes.Int64.ttype nonrec start_metric_streams_input = {names : metric_stream_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.
*)}type nonrec standard_unit = | None_| Count_Second| Terabits_Second| Gigabits_Second| Megabits_Second| Kilobits_Second| Bits_Second| Terabytes_Second| Gigabytes_Second| Megabytes_Second| Kilobytes_Second| Bytes_Second| Count| Percent| Terabits| Gigabits| Megabits| Kilobits| Bits| Terabytes| Gigabytes| Megabytes| Kilobytes| Bytes| Milliseconds| Microseconds| Secondstype nonrec size = Smaws_Lib.CoreTypes.Int64.ttype nonrec dimension = {value : dimension_value;The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
*)name : dimension_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 (:). ASCII control characters are not supported as part of dimension names.
}A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
type nonrec dimensions = dimension listtype nonrec single_metric_anomaly_detector = {stat : anomaly_detector_metric_stat option;The statistic to use for the metric and anomaly detection model.
*)dimensions : dimensions option;The metric dimensions to create the anomaly detection model for.
*)metric_name : metric_name option;The name of the metric to create the anomaly detection model for.
*)namespace : namespace option;The namespace of the metric to create the anomaly detection model for.
*)account_id : account_id option;If the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here. If you omit this parameter, the current account is used.
*)}Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input. If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.
type nonrec set_alarm_state_input = {state_reason_data : state_reason_data option;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.
*)state_reason : state_reason;The reason that this alarm is set to this specific state, in text format.
*)state_value : state_value;The value of the state.
*)alarm_name : alarm_name;The name of the alarm.
*)}The named resource does not exist.
Data was not syntactically valid JSON.
type nonrec log_group_identifiers = amazon_resource_name listtype nonrec end_time_offset = Smaws_Lib.CoreTypes.Int64.ttype nonrec schedule_configuration = {end_time_offset : end_time_offset option;The offset, in seconds, before the scheduled execution time at which the query time range ends. Must be non-negative and less than StartTimeOffset. The default is 0.
start_time_offset : start_time_offset option;The offset, in seconds, before the scheduled execution time at which the query time range begins. For example, an offset of 360 (6 minutes) on a query running at 12:05:00 starts the query time range at 11:59:00.
*)schedule_expression : schedule_expression;The schedule expression that defines how often the underlying CloudWatch Logs scheduled query runs. Specify a rate() expression, for example rate(5 minutes).
}Contains the schedule expression and time-range offsets that define when a scheduled query runs and what time range each execution covers.
type nonrec scheduled_query_configuration = {aggregation_expression : aggregation_expression;The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, count(*) or avg(latency) by host | sort desc. Length constraints: minimum 1 character, maximum 2048 characters.
schedule_configuration : schedule_configuration;The schedule and time-range offset configuration for the underlying scheduled query.
*)scheduled_query_role_ar_n : amazon_resource_name;The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.
*)query_ar_n : amazon_resource_name option;The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in DescribeAlarms responses.
log_group_identifiers : log_group_identifiers option;The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.
*)query_string : query_string;The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.
*)}The configuration of the CloudWatch Logs scheduled query that backs a log alarm.
type nonrec schedule = {timezone : timezone option;The time zone to use when evaluating the schedule expression. The time zone must be between 1 and 50 characters in length.
Specify the time zone using standard timezone identifiers (for example, America/New_York, Europe/London, or Asia/Tokyo).
If you don't specify a time zone, UTC is used by default. The time zone affects how cron and at expressions are interpreted, as well as start and expire dates you specify
Examples:
America/New_York - Eastern Time (US)America/Los_Angeles - Pacific Time (US)Europe/London - British TimeAsia/Tokyo - Japan Standard TimeUTC - Coordinated Universal Timeduration : duration;The length of time that alarms remain muted when the schedule activates. The duration must be between 1 and 50 characters in length.
Specify the duration using ISO 8601 duration format with a minimum of 1 minute (PT1M) and maximum of 15 days (P15D).
Examples:
PT4H - 4 hours for weekly system maintenanceP2DT12H - 2 days and 12 hours for weekend muting from Friday 6:00 PM to Monday 6:00 AMPT6H - 6 hours for monthly database maintenancePT2H - 2 hours for nightly backup operationsP7D - 7 days for annual company shutdownThe duration begins when the schedule expression time is reached. For recurring schedules, the duration applies to each occurrence.
*)expression : expression;The schedule expression that defines when the mute rule activates. The expression must be between 1 and 256 characters in length.
You can use one of two expression formats:
Cron expressions - For recurring mute windows. Format: cron(Minutes Hours Day-of-month Month Day-of-week)
Examples:
cron(0 2 * * *) - Activates daily at 2:00 AMcron(0 2 * * SUN) - Activates every Sunday at 2:00 AM for weekly system maintenancecron(0 1 1 * *) - Activates on the first day of each month at 1:00 AM for monthly database maintenancecron(0 18 * * FRI) - Activates every Friday at 6:00 PMcron(0 23 * * *) - Activates every day at 11:00 PM during nightly backup operationsThe characters *, -, and , are supported in all fields. English names can be used for the month (JAN-DEC) and day of week (SUN-SAT) fields.
At expressions - For one-time mute windows. Format: at(yyyy-MM-ddThh:mm)
Examples:
at(2024-05-10T14:00) - Activates once on May 10, 2024 at 2:00 PM during an active incident response sessionat(2024-12-23T00:00) - Activates once on December 23, 2024 at midnight during annual company shutdown}Specifies when and how long an alarm mute rule is active.
The schedule uses either a cron expression for recurring mute windows or an at expression for one-time mute windows. When the schedule activates, the mute rule mutes alarm actions for the specified duration.
type nonrec rule = {schedule : schedule;The schedule configuration that defines when the mute rule activates and how long it remains active.
*)}Defines the schedule configuration for an alarm mute rule.
The rule contains a schedule that specifies when and how long alarms should be muted. The schedule can be a recurring pattern using cron expressions or a one-time mute window using at expressions.
type nonrec resource_list = resource_name listThe operation could not be completed because the request conflicts with the current state of the alarm or its underlying scheduled query resource.
type nonrec range = {end_time : timestamp;The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
start_time : timestamp;The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
}Specifies one range of days or times to exclude from use for training an anomaly detection model.
type nonrec put_metric_stream_output = {arn : amazon_resource_name option;The ARN of the metric stream.
*)}type nonrec metric_stream_filter_metric_names = metric_name listtype nonrec metric_stream_filter = {metric_names : metric_stream_filter_metric_names option;The names of the metrics to either include or exclude from the metric stream.
If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.
Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.
*)namespace : namespace option;The name of the metric namespace for this filter.
The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.
*)}This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric stream or exclude from a metric stream.
A metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.
type nonrec metric_stream_filters = metric_stream_filter listtype nonrec metric_stream_statistics_metric = {metric_name : metric_name;The name of the metric.
*)namespace : namespace;The namespace of the metric.
*)}This object contains the information for one metric that is to be streamed with additional statistics.
type nonrec metric_stream_statistics_include_metrics =
metric_stream_statistics_metric listtype nonrec metric_stream_statistics_additional_statistics =
metric_stream_statistic listtype nonrec metric_stream_statistics_configuration = {additional_statistics : metric_stream_statistics_additional_statistics;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 opentelemetry1.0 or opentelemetry0.7, the only valid values are
p{i ??} 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.
include_metrics : metric_stream_statistics_include_metrics;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.
*)}By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in CloudWatch statistics definitions.
type nonrec metric_stream_statistics_configurations =
metric_stream_statistics_configuration listtype nonrec put_metric_stream_input = {include_linked_accounts_metrics : include_linked_accounts_metrics option;If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.
statistics_configurations : metric_stream_statistics_configurations option;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 opentelemetry1.0 or opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.
output_format : metric_stream_output_format;The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
role_arn : amazon_resource_name;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_arn : amazon_resource_name;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.
*)exclude_filters : metric_stream_filters option;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.
include_filters : metric_stream_filters option;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.
name : metric_stream_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 "_".
*)}Parameters were used together that cannot be used together.
type nonrec counts = datapoint_value listtype nonrec metric_datum = {storage_resolution : storage_resolution option;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.
*)unit_ : standard_unit option;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.
counts : counts option;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.
values : values option;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.
statistic_values : statistic_set option;The statistical values for the metric.
*)value : datapoint_value option;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.
*)timestamp : timestamp option;The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
*)dimensions : dimensions option;The dimensions associated with the metric.
*)metric_name : metric_name;The name of the metric.
*)}Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
type nonrec metric_data = metric_datum listtype nonrec entity_key_attributes_map =
(entity_key_attributes_map_key_string
* entity_key_attributes_map_value_string)
listtype nonrec entity_attributes_map =
(entity_attributes_map_key_string * entity_attributes_map_value_string) listtype nonrec entity = {attributes : entity_attributes_map option;Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.
For details about how to use the attributes, see How to add related information to telemetry in the CloudWatch User Guide.
*)key_attributes : entity_key_attributes_map option;The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same KeyAttributes are considered to be the same entity. For an entity to be valid, the KeyAttributes must exist and be formatted correctly.
There are five allowed attributes (key names): Type, ResourceType, Identifier, Name, and Environment.
For details about how to use the key attributes to specify an entity, see How to add related information to telemetry in the CloudWatch User Guide.
*)}An entity associated with metrics, to allow for finding related telemetry. An entity is typically a resource or service within your system. For example, metrics from an Amazon EC2 instance could be associated with that instance as the entity. Similarly, metrics from a service that you own could be associated with that service as the entity.
type nonrec entity_metric_data = {metric_data : metric_data option;The metric data.
*)entity : entity option;The entity associated with the metrics.
*)}A set of metrics that are associated with an entity, such as a specific service or resource. Contains the entity and the list of metric data associated with it.
type nonrec entity_metric_data_list = entity_metric_data listtype nonrec put_metric_data_input = {strict_entity_validation : strict_entity_validation option;Whether to accept valid metric data when an invalid entity is sent.
true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.InvalidAttributes - The provided Attributes of an entity is invalid.InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
entity_metric_data : entity_metric_data_list option;Data for metrics that contain associated entity information. You can include up to two EntityMetricData objects, each of which can contain a single Entity and associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData metrics.
metric_data : metric_data option;The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData metrics.
namespace : namespace;The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/
}type nonrec metric = {dimensions : dimensions option;The dimensions for the metric.
*)metric_name : metric_name option;The name of the metric. This is a required field.
*)namespace : namespace option;The namespace of the metric.
*)}Represents a specific metric.
type nonrec metric_stat = {unit_ : standard_unit option;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.
stat : stat;The statistic to return. It can include any CloudWatch statistic or extended statistic.
*)period : 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, 20, 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:
metric : metric;The metric to return, including the metric name, namespace, and dimensions.
*)}This structure defines the metric to be returned, along with the statistics, period, and units.
type nonrec metric_data_query = {account_id : account_id option;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.
period : period option;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, 20, 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.
return_data : return_data option;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.
label : metric_label option;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.
*)expression : metric_expression option;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.
metric_stat : metric_stat option;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.
id : metric_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.
}This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.
When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures.
When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have true as the value for ReturnData. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.
type nonrec metric_data_queries = metric_data_query listtype nonrec evaluation_window = | SlidingWindow of sliding_windowA sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.
*)| WallClockWindow of wall_clock_windowA wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.
*)The evaluation window that an alarm uses to select the range of metric data that it evaluates each time it runs. This is a union type. Set exactly one of its members, SlidingWindow or WallClockWindow. If you don't set EvaluationWindow, the alarm uses a SlidingWindow by default.
For more information, see Alarm evaluation windows in the CloudWatch User Guide.
type nonrec alarm_prom_ql_criteria = {recovery_period : recovery_period option;The duration, in seconds, that a contributor must continuously not be breaching before it transitions back to the OK state.
pending_period : pending_period option;The duration, in seconds, that a contributor must be continuously breaching before it transitions to the ALARM state.
query : query;The PromQL query that the alarm evaluates. The query must return a result of vector type. Each entry in the vector result represents an alarm contributor.
*)}Contains the configuration that determines how a PromQL alarm evaluates its contributors, including the query to run and the durations that define when contributors transition between states.
type nonrec evaluation_criteria = | PromQLCriteria of alarm_prom_ql_criteriaThe PromQL criteria for the alarm evaluation.
*)The evaluation criteria for an alarm. This is a union type that currently supports PromQLCriteria.
type nonrec put_metric_alarm_input = {evaluation_interval : evaluation_interval option;The frequency, in seconds, at which the alarm is evaluated. Valid values are 10, 20, 30, and any multiple of 60.
This parameter is required for alarms that use EvaluationCriteria, and cannot be specified for alarms configured with MetricName or Metrics.
evaluation_criteria : evaluation_criteria option;The evaluation criteria for the alarm. For each PutMetricAlarm operation, you must specify either MetricName, a Metrics array, or an EvaluationCriteria.
If you use the EvaluationCriteria parameter, you cannot include the Namespace, MetricName, Dimensions, Period, Unit, Statistic, ExtendedStatistic, Metrics, Threshold, ComparisonOperator, ThresholdMetricId, EvaluationPeriods, or DatapointsToAlarm parameters of PutMetricAlarm in the same operation. Instead, all evaluation parameters are defined within this structure.
For an example of how to use this parameter, see the PromQL alarm example on this page.
*)evaluation_window : evaluation_window option;The evaluation window that the alarm uses to select the range of metric data that it evaluates. Specify either a sliding window or a wall clock window. If you omit this parameter, the alarm uses a sliding window.
A sliding window advances each time the alarm is evaluated, forming a rolling time window. A wall clock window aligns the evaluated range to fixed clock boundaries, such as the top of the hour or the start of the day.
You can use EvaluationWindow with any type of metric alarm except alarms that are based on a PromQL query.
For more information, see Alarm evaluation windows in the CloudWatch User Guide.
*)threshold_metric_id : metric_id option;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.
*)metrics : metric_data_queries option;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, a Metrics array, or an EvaluationCriteria.
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 Namespace, MetricName, Dimensions, Period, Unit, 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.
evaluate_low_sample_count_percentile : evaluate_low_sample_count_percentile
option;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
treat_missing_data : treat_missing_data option;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.
This parameter is not applicable to PromQL alarms.
*)comparison_operator : comparison_operator option;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.
threshold : threshold option;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.
*)datapoints_to_alarm : datapoints_to_alarm option;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.
*)evaluation_periods : evaluation_periods option;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.
*)unit_ : standard_unit option;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 are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.
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.
period : period option;The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 20, 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, 20, or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10, 20, 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, 20, 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 seven days, so Period multiplied by EvaluationPeriods can't be more than 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).
dimensions : dimensions option;The dimensions for the metric specified in MetricName.
extended_statistic : extended_statistic option;The extended statistic for the metric specified in MetricName. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic but not both.
If you specify ExtendedStatistic, the following are valid values:
p90tm90tc90ts90wm90IQMPR({i n}:{i m})where n and m are values of the metric
TC({i X}%:{i X}%)where X is between 10 and 90 inclusive.
TM({i X}%:{i X}%)where X is between 10 and 90 inclusive.
TS({i X}%:{i X}%)where X is between 10 and 90 inclusive.
WM({i X}%:{i X}%)where X is between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
*)statistic : statistic option;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.
namespace : namespace option;The namespace for the metric associated specified in MetricName.
metric_name : metric_name option;The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName, a Metrics array, or an EvaluationCriteria.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.
insufficient_data_actions : resource_list option;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:
EC2 actions:
arn:aws:automate:{i region}:ec2:stoparn:aws:automate:{i region}:ec2:terminatearn:aws:automate:{i region}:ec2:rebootarn:aws:automate:{i region}:ec2:recoverarn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Stop/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Terminate/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Reboot/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Recover/1.0Autoscaling action:
arn:aws:autoscaling:{i region}:{i account-id}:scalingPolicy:{i policy-id}:autoScalingGroupName/{i group-friendly-name}:policyName/{i policy-friendly-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} SNS notification action:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} SSM integration actions:
arn:aws:ssm:{i region}:{i account-id}:opsitem:{i severity}#CATEGORY={i category-name} arn:aws:ssm-incidents::{i account-id}:responseplan/{i response-plan-name} alarm_actions : resource_list option;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:
EC2 actions:
arn:aws:automate:{i region}:ec2:stoparn:aws:automate:{i region}:ec2:terminatearn:aws:automate:{i region}:ec2:rebootarn:aws:automate:{i region}:ec2:recoverarn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Stop/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Terminate/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Reboot/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Recover/1.0Autoscaling action:
arn:aws:autoscaling:{i region}:{i account-id}:scalingPolicy:{i policy-id}:autoScalingGroupName/{i group-friendly-name}:policyName/{i policy-friendly-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} SNS notification action:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} SSM integration actions:
arn:aws:ssm:{i region}:{i account-id}:opsitem:{i severity}#CATEGORY={i category-name} arn:aws:ssm-incidents::{i account-id}:responseplan/{i response-plan-name} Start a Amazon Q Developer operational investigation
arn:aws:aiops:{i region}:{i account-id}:investigation-group:{i investigation-group-id} ok_actions : resource_list option;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:
EC2 actions:
arn:aws:automate:{i region}:ec2:stoparn:aws:automate:{i region}:ec2:terminatearn:aws:automate:{i region}:ec2:rebootarn:aws:automate:{i region}:ec2:recoverarn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Stop/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Terminate/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Reboot/1.0arn:aws:swf:{i region}:{i account-id}:action/actions/AWS_EC2.InstanceId.Recover/1.0Autoscaling action:
arn:aws:autoscaling:{i region}:{i account-id}:scalingPolicy:{i policy-id}:autoScalingGroupName/{i group-friendly-name}:policyName/{i policy-friendly-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} SNS notification action:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} SSM integration actions:
arn:aws:ssm:{i region}:{i account-id}:opsitem:{i severity}#CATEGORY={i category-name} arn:aws:ssm-incidents::{i account-id}:responseplan/{i response-plan-name} actions_enabled : actions_enabled option;Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
alarm_description : alarm_description option;The description for the alarm.
*)alarm_name : alarm_name;The name for the alarm. This name must be unique within the Region.
The name must contain only UTF-8 characters, and can't contain ASCII control characters
*)}The quota for alarms for this customer has already been reached.
type nonrec partial_failure = {failure_description : failure_description option;A description of the error.
*)failure_code : failure_code option;The code of the error.
*)exception_type : exception_type option;The type of error.
*)failure_resource : failure_resource option;The specified rule that could not be deleted.
*)}This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
type nonrec batch_failures = partial_failure listtype nonrec put_managed_insight_rules_output = {failures : batch_failures option;An array that lists the rules that could not be enabled.
*)}type nonrec managed_rule = {resource_ar_n : amazon_resource_name;The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
*)template_name : template_name;The template name for the managed Contributor Insights rule, as returned by ListManagedInsightRules.
}Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.
type nonrec managed_rules = managed_rule listtype nonrec put_managed_insight_rules_input = {managed_rules : managed_rules;A list of ManagedRules to enable.
}type nonrec put_log_alarm_input = {treat_missing_data : treat_missing_data option;Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. If this parameter is omitted, the default behavior of missing is used.
comparison_operator : comparison_operator;The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are GreaterThanThreshold, GreaterThanOrEqualToThreshold, LessThanThreshold, and LessThanOrEqualToThreshold.
threshold : threshold;The value to compare with the aggregated query result.
*)query_results_to_alarm : query_results_to_alarm;The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation). Must be less than or equal to QueryResultsToEvaluate.
query_results_to_evaluate : query_results_to_evaluate;The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.
*)insufficient_data_actions : resource_list option;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:
Amazon SNS actions:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} alarm_actions : resource_list option;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:
Amazon SNS actions:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} Systems Manager actions:
arn:aws:ssm:{i region}:{i account-id}:opsitem:{i severity} ok_actions : resource_list option;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).
Valid Values:
Amazon SNS actions:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} actions_enabled : actions_enabled option;Indicates whether actions should be executed during any changes to the alarm state. The default is true.
action_log_line_role_arn : action_log_line_role_arn option;The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when ActionLogLineCount is greater than 0.
action_log_line_count : action_log_line_count option;The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.
*)scheduled_query_configuration : scheduled_query_configuration;The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.
*)alarm_description : alarm_description option;The description for the alarm.
*)alarm_name : alarm_name;The name for the alarm. This name must be unique within the Amazon Web Services account and Region.
*)}type nonrec put_insight_rule_input = {apply_on_transformed_logs : insight_rule_on_transformed_logs option;Specify true to have this rule evaluate log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.
The default is false
If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.
*)rule_definition : insight_rule_definition;The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
*)rule_state : insight_rule_state option;The state of the rule. Valid values are ENABLED and DISABLED.
*)rule_name : insight_rule_name;A unique name for the rule.
*)}The operation exceeded one or more limits.
type nonrec dashboard_validation_message = {message : message option;A message describing the error or warning.
*)data_path : data_path option;The data path related to the message.
*)}An error or warning for the operation.
type nonrec dashboard_validation_messages = dashboard_validation_message listtype nonrec put_dashboard_output = {dashboard_validation_messages : dashboard_validation_messages option;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.
*)}type nonrec put_dashboard_input = {dashboard_body : dashboard_body;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.
*)dashboard_name : dashboard_name;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.
*)}type nonrec dashboard_invalid_input_error = {dashboard_validation_messages : dashboard_validation_messages option;message : dashboard_error_message option;}Some part of the dashboard data is invalid.
type nonrec put_composite_alarm_input = {actions_suppressor_extension_period : suppressor_period option;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.
actions_suppressor_wait_period : suppressor_period option;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.
actions_suppressor : alarm_arn option;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.
ok_actions : resource_list option;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: ]
Amazon SNS actions:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} insufficient_data_actions : resource_list option;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: ]
Amazon SNS actions:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} alarm_rule : alarm_rule;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("{i alarm-name} or {i alarm-ARN}")is TRUE if the named alarm is in ALARM state.
OK("{i alarm-name} or {i alarm-ARN}")is TRUE if the named alarm is in OK state.
INSUFFICIENT_DATA("{i alarm-name} or {i 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.
alarm_name : alarm_name;The name for the composite alarm. This name must be unique within the Region.
*)alarm_description : alarm_description option;The description for the composite alarm.
*)alarm_actions : resource_list option;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: ]
Amazon SNS actions:
arn:aws:sns:{i region}:{i account-id}:{i sns-topic-name} Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name} Invoke a specific version of a Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i version-number} Invoke a function by using an alias Lambda function:
arn:aws:lambda:{i region}:{i account-id}:function:{i function-name}:{i alias-name} Systems Manager actions:
arn:aws:ssm:{i region}:{i account-id}:opsitem:{i severity} Start a Amazon Q Developer operational investigation
arn:aws:aiops:{i region}:{i account-id}:investigation-group:{i investigation-group-id} actions_enabled : actions_enabled option;Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
}type nonrec anomaly_detector_excluded_time_ranges = range listtype nonrec anomaly_detector_configuration = {metric_timezone : anomaly_detector_metric_timezone option;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.
*)excluded_time_ranges : anomaly_detector_excluded_time_ranges option;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.
*)}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.
type nonrec metric_characteristics = {periodic_spikes : periodic_spikes option;Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies. With this set to true, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won't flag future similar spikes as anomalies.
}This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
type nonrec metric_math_anomaly_detector = {metric_data_queries : metric_data_queries option;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.
}Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.
type nonrec put_anomaly_detector_input = {metric_math_anomaly_detector : metric_math_anomaly_detector option;The metric math anomaly detector to be created.
When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:
DimensionsMetricNameNamespaceStatSingleMetricAnomalyDetector parameters of PutAnomalyDetectorInputInstead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.
single_metric_anomaly_detector : single_metric_anomaly_detector option;A single metric anomaly detector to be created.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:
DimensionsMetricNameNamespaceStatMetricMathAnomalyDetector parameters of PutAnomalyDetectorInputInstead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.
metric_characteristics : metric_characteristics option;Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.
configuration : anomaly_detector_configuration option;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.
*)stat : anomaly_detector_metric_stat option;The statistic to use for the metric and the anomaly detection model.
*)dimensions : dimensions option;The metric dimensions to create the anomaly detection model for.
*)metric_name : metric_name option;The name of the metric to create the anomaly detection model for.
*)namespace : namespace option;The namespace of the metric to create the anomaly detection model for.
*)}type nonrec mute_target_alarm_name_list = name listtype nonrec mute_targets = {alarm_names : mute_target_alarm_name_list;The list of alarm names that this mute rule targets. You can specify up to 100 alarm names.
Each alarm name must be between 1 and 255 characters in length. The alarm names must match existing alarms in your Amazon Web Services account and region.
*)}Specifies which alarms an alarm mute rule applies to.
You can target up to 100 specific alarms by name. When a mute rule is active, the targeted alarms continue to evaluate metrics and transition between states, but their configured actions are muted.
type nonrec put_alarm_mute_rule_input = {expire_date : timestamp option;The date and time when the mute rule expires and is no longer evaluated, specified as a timestamp in ISO 8601 format (for example, 2026-12-31T23:59:59Z). After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.
start_date : timestamp option;The date and time after which the mute rule takes effect, specified as a timestamp in ISO 8601 format (for example, 2026-04-15T08:00:00Z). If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.
mute_targets : mute_targets option;Specifies which alarms this rule applies to.
*)rule : rule;The configuration that defines when and how long alarms should be muted.
*)description : alarm_description option;A description of the alarm mute rule that helps you identify its purpose.
*)name : name;The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region.
*)}type nonrec owning_accounts = account_id listThe status of OTel enrichment for the account.
type nonrec metrics = metric listtype nonrec metric_stream_entry = {output_format : metric_stream_output_format option;The output format of this metric stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7.
state : metric_stream_state option;The current state of this stream. Valid values are running and stopped.
firehose_arn : amazon_resource_name option;The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
*)name : metric_stream_name option;The name of the metric stream.
*)last_update_date : timestamp option;The date that the configuration of this metric stream was most recently updated.
*)creation_date : timestamp option;The date that the metric stream was originally created.
*)arn : amazon_resource_name option;The ARN of the metric stream.
*)}This structure contains the configuration information about one metric stream.
type nonrec metric_stream_entries = metric_stream_entry listtype nonrec datapoint_values = datapoint_value listtype nonrec message_data = {value : message_data_value option;The message text.
*)code : message_data_code option;The error code or status code associated with the message.
*)}A message returned by the GetMetricDataAPI, including a code and a description.
If a cross-Region GetMetricData operation fails with a code of Forbidden and a value of Authentication too complex to retrieve cross region data, you can correct the problem by running the GetMetricData operation in the same Region where the metric data is.
type nonrec metric_data_result_messages = message_data listtype nonrec metric_data_result = {messages : metric_data_result_messages option;A list of messages with additional information about the data returned.
*)status_code : status_code option;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.
values : datapoint_values option;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].
timestamps : timestamps option;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].
*)label : metric_label option;The human-readable label associated with the data.
*)id : metric_id option;The short name you specified to represent this metric.
*)}A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.
type nonrec metric_data_results = metric_data_result listtype nonrec metric_alarm = {evaluation_interval : evaluation_interval option;The frequency, in seconds, at which the alarm is evaluated.
*)evaluation_criteria : evaluation_criteria option;The evaluation criteria for the alarm.
*)evaluation_window : evaluation_window option;The evaluation window that the alarm uses to select the range of metric data that it evaluates. This is either a sliding window or a wall clock window. For more information, see Alarm evaluation windows in the CloudWatch User Guide.
*)state_transitioned_timestamp : timestamp option;The date and time that the alarm's StateValue most recently changed.
evaluation_state : evaluation_state option;If the value of this field is PARTIAL_DATA, it indicates that not all the available data was able to be retrieved due to quota limitations. For more information, see Create alarms on Metrics Insights queries.
If the value of this field is EVALUATION_ERROR, it indicates configuration errors in alarm setup that require review and correction. Refer to StateReason field of the alarm for more details.
If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved
threshold_metric_id : metric_id option;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.
metrics : metric_data_queries option;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.
evaluate_low_sample_count_percentile : evaluate_low_sample_count_percentile
option;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.
treat_missing_data : treat_missing_data option;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.
This parameter is not applicable to PromQL alarms.
*)comparison_operator : comparison_operator option;The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
*)threshold : threshold option;The value to compare with the specified statistic.
*)datapoints_to_alarm : datapoints_to_alarm option;The number of data points that must be breaching to trigger the alarm.
*)evaluation_periods : evaluation_periods option;The number of periods over which data is compared to the specified threshold.
*)unit_ : standard_unit option;The unit of the metric associated with the alarm.
*)period : period option;The period, in seconds, over which the statistic is applied.
*)dimensions : dimensions option;The dimensions for the metric associated with the alarm.
*)extended_statistic : extended_statistic option;The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
*)statistic : statistic option;The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
namespace : namespace option;The namespace of the metric associated with the alarm.
*)metric_name : metric_name option;The name of the metric associated with the alarm, if this is an alarm based on a single metric.
*)state_updated_timestamp : timestamp option;The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
state_reason_data : state_reason_data option;An explanation for the alarm state, in JSON format.
*)state_reason : state_reason option;An explanation for the alarm state, in text format.
*)state_value : state_value option;The state value for the alarm.
*)insufficient_data_actions : resource_list option;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).
alarm_actions : resource_list option;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).
ok_actions : resource_list option;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).
actions_enabled : actions_enabled option;Indicates whether actions should be executed during any changes to the alarm state.
*)alarm_configuration_updated_timestamp : timestamp option;The time stamp of the last update to the alarm configuration.
*)alarm_description : alarm_description option;The description of the alarm.
*)alarm_arn : alarm_arn option;The Amazon Resource Name (ARN) of the alarm.
*)alarm_name : alarm_name option;The name of the alarm.
*)}The details about a metric alarm.
type nonrec metric_alarms = metric_alarm listtype nonrec managed_rule_state = {state : insight_rule_state;Indicates whether the rule is enabled or disabled.
*)rule_name : insight_rule_name;The name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource.
*)}The status of a managed Contributor Insights rule.
type nonrec managed_rule_description = {rule_state : managed_rule_state option;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.
*)resource_ar_n : amazon_resource_name option;If a managed rule is enabled, this is the ARN for the related Amazon Web Services resource.
*)template_name : template_name option;The template name for the managed rule. Used to enable managed rules using PutManagedInsightRules.
}Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules.
type nonrec managed_rule_descriptions = managed_rule_description listtype nonrec log_alarm = {action_log_line_role_arn : action_log_line_role_arn option;The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.
action_log_line_count : action_log_line_count option;The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.
*)evaluation_state : evaluation_state option;If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.
If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.
If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.
state_transitioned_timestamp : timestamp option;The date and time that the alarm's StateValue most recently changed.
treat_missing_data : treat_missing_data option;How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.
comparison_operator : comparison_operator option;The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.
*)threshold : threshold option;The value to compare with the aggregated query result.
*)query_results_to_alarm : query_results_to_alarm option;The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).
query_results_to_evaluate : query_results_to_evaluate option;The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).
*)scheduled_query_configuration : scheduled_query_configuration option;The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.
*)state_updated_timestamp : timestamp option;The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
state_reason_data : state_reason_data option;An explanation for the alarm state, in JSON format.
*)state_reason : state_reason option;An explanation for the alarm state, in text format.
*)state_value : state_value option;The state value for the alarm.
*)insufficient_data_actions : resource_list option;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).
alarm_actions : resource_list option;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).
ok_actions : resource_list option;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).
actions_enabled : actions_enabled option;Indicates whether actions should be executed during any changes to the alarm state.
*)alarm_configuration_updated_timestamp : timestamp option;The time stamp of the last update to the alarm configuration.
*)alarm_description : alarm_description option;The description of the alarm.
*)alarm_arn : alarm_arn option;The Amazon Resource Name (ARN) of the alarm.
*)alarm_name : alarm_name option;The name of the alarm.
*)}The details about a log alarm.
type nonrec log_alarms = log_alarm listtype nonrec list_metrics_output = {owning_accounts : owning_accounts option;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.
*)next_token : next_token option;The token that marks the start of the next batch of returned results.
*)metrics : metrics option;The metrics that match your request.
*)}type nonrec dimension_filter = {value : dimension_value option;The value of the dimension to be matched.
*)name : dimension_name;The dimension name to be matched.
*)}Represents filters for a dimension.
type nonrec dimension_filters = dimension_filter listtype nonrec list_metrics_input = {owning_account : account_id option;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.
include_linked_accounts : include_linked_accounts option;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.
recently_active : recently_active option;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 50 minutes more than the specified time interval.
*)next_token : next_token option;The token returned by a previous call to indicate that there is more data available.
*)dimensions : dimension_filters option;The dimensions to filter against. Only the dimension with names that match exactly will be returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.
*)metric_name : metric_name option;The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
*)namespace : namespace option;The metric namespace to filter against. Only the namespace that matches exactly will be returned.
*)}type nonrec list_metric_streams_output = {entries : metric_stream_entries option;The array of metric stream information.
*)next_token : next_token option;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.
*)}type nonrec list_metric_streams_input = {max_results : list_metric_streams_max_results option;The maximum number of results to return in one operation.
*)next_token : next_token option;Include this value, if it was returned by the previous call, to get the next set of metric streams.
*)}The next token specified is invalid.
type nonrec list_managed_insight_rules_output = {next_token : next_token option;Include this value to get the next set of rules if the value was returned by the previous operation.
*)managed_rules : managed_rule_descriptions option;The managed rules that are available for the specified Amazon Web Services resource.
*)}type nonrec list_managed_insight_rules_input = {max_results : insight_rule_max_results option;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.
next_token : next_token option;Include this value to get the next set of rules if the value was returned by the previous operation.
*)resource_ar_n : amazon_resource_name;The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
*)}type nonrec dashboard_entry = {size : size option;The size of the dashboard, in bytes.
*)last_modified : last_modified option;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.
*)dashboard_arn : dashboard_arn option;The Amazon Resource Name (ARN) of the dashboard.
*)dashboard_name : dashboard_name option;The name of the dashboard.
*)}Represents a specific dashboard.
type nonrec dashboard_entries = dashboard_entry listtype nonrec list_dashboards_output = {next_token : next_token option;The token that marks the start of the next batch of returned results.
*)dashboard_entries : dashboard_entries option;The list of matching dashboards.
*)}type nonrec list_dashboards_input = {next_token : next_token option;The token returned by a previous call to indicate that there is more data available.
*)dashboard_name_prefix : dashboard_name_prefix option;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 "_".
*)}type nonrec alarm_mute_rule_summary = {last_updated_timestamp : timestamp option;The date and time when the mute rule was last updated.
*)mute_type : mute_type option;Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.
status : alarm_mute_rule_status option;The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
expire_date : timestamp option;The date and time when the mute rule expires and is no longer evaluated. This field is only present if an expiration date was configured.
*)alarm_mute_rule_arn : arn option;The Amazon Resource Name (ARN) of the alarm mute rule.
*)}Summary information about an alarm mute rule, including its name, status, and configuration details.
type nonrec alarm_mute_rule_summaries = alarm_mute_rule_summary listtype nonrec list_alarm_mute_rules_output = {next_token : next_token option;The token to use when requesting the next set of results. If this field is absent, there are no more results to retrieve.
*)alarm_mute_rule_summaries : alarm_mute_rule_summaries option;A list of alarm mute rule summaries.
*)}type nonrec alarm_mute_rule_statuses = alarm_mute_rule_status listtype nonrec list_alarm_mute_rules_input = {next_token : next_token option;The token returned from a previous call to indicate where to continue retrieving results.
*)max_records : max_records option;The maximum number of mute rules to return in one call. The default is 50.
*)statuses : alarm_mute_rule_statuses option;Filter results to show only mute rules with the specified statuses. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
alarm_name : name option;Filter results to show only mute rules that target the specified alarm name.
*)}type nonrec label_options = {timezone : get_metric_data_label_timezone option;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.
}This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone.
The Timezone value affects a label only if you have a time-based dynamic expression in the label. For more information about dynamic expressions in labels, see Using Dynamic Labels.
The specified Amazon Web Services Key Management Service (Amazon Web Services KMS) key could not be found. Verify that the key Amazon Resource Name (ARN) is correct, that the key exists, and that it is in the same Amazon Web Services Region as the resource.
The specified Amazon Web Services Key Management Service (Amazon Web Services KMS) key is disabled or pending deletion. Re-enable the key (or restore it, if it is pending deletion) and retry the operation.
The operation was denied because either the calling principal lacks the required Amazon Web Services Key Management Service (Amazon Web Services KMS) permission on the key, or the key policy does not grant Amazon CloudWatch the permissions it needs to use the key. Verify that the caller has kms:Decrypt permission on the key, and that the key policy grants the CloudWatch service principal the kms:DescribeKey, kms:GenerateDataKey, kms:Encrypt, kms:Decrypt, and kms:ReEncrypt* permissions described in AssociateDatasetKmsKey.
type nonrec insight_rule = {apply_on_transformed_logs : insight_rule_on_transformed_logs option;Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.
managed_rule : insight_rule_is_managed option;An optional built-in rule that Amazon Web Services manages.
*)definition : insight_rule_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.
*)schema : insight_rule_schema;For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
state : insight_rule_state;Indicates whether the rule is enabled or disabled.
*)name : insight_rule_name;The name of the rule.
*)}This structure contains the definition for a Contributor Insights rule. For more information about this rule, seeUsing Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.
type nonrec insight_rules = insight_rule listtype nonrec insight_rule_unbound_long = Smaws_Lib.CoreTypes.Int64.ttype nonrec insight_rule_names = insight_rule_name listtype nonrec insight_rule_metric_list = insight_rule_metric_name listtype nonrec insight_rule_metric_datapoint = {maximum : insight_rule_unbound_double option;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.
minimum : insight_rule_unbound_double option;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.
sum : insight_rule_unbound_double option;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.
average : insight_rule_unbound_double option;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.
sample_count : insight_rule_unbound_double option;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.
max_contributor_value : insight_rule_unbound_double option;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.
unique_contributors : insight_rule_unbound_double option;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.
timestamp : timestamp;The timestamp of the data point.
*)}One data point from the metric time series returned in a Contributor Insights rule report.
For more information, see GetInsightRuleReport.
type nonrec insight_rule_metric_datapoints = insight_rule_metric_datapoint listtype nonrec insight_rule_contributor_keys = insight_rule_contributor_key listtype nonrec insight_rule_contributor_datapoint = {approximate_value : insight_rule_unbound_double;The approximate value that this contributor added during this timestamp.
*)timestamp : timestamp;The timestamp of the data point.
*)}One data point related to one contributor.
For more information, see GetInsightRuleReport and InsightRuleContributor.
type nonrec insight_rule_contributor_datapoints =
insight_rule_contributor_datapoint listtype nonrec insight_rule_contributor = {datapoints : insight_rule_contributor_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.
*)approximate_aggregate_value : insight_rule_unbound_double;An approximation of the aggregate value that comes from this contributor.
*)keys : insight_rule_contributor_keys;One of the log entry field keywords that is used to define contributors for this rule.
*)}One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.
If the rule contains a single key, then each unique contributor is each unique value for this key.
For more information, see GetInsightRuleReport.
type nonrec insight_rule_contributors = insight_rule_contributor listtype nonrec insight_rule_contributor_key_labels =
insight_rule_contributor_key_label listtype nonrec get_o_tel_enrichment_output = {status : o_tel_enrichment_status;The status of OTel enrichment for the account. Valid values are Running (enrichment is enabled) and Stopped (enrichment is disabled).
}type nonrec get_metric_widget_image_output = {metric_widget_image : metric_widget_image option;The image of the graph, in the output format specified. The output is base64-encoded.
*)}type nonrec get_metric_widget_image_input = {output_format : output_format option;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:
> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
6f0d4192-4d42-11e8-82c1-f539a07e0e3b
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.
metric_widget : metric_widget;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.
*)}type nonrec get_metric_stream_output = {include_linked_accounts_metrics : include_linked_accounts_metrics option;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.
statistics_configurations : metric_stream_statistics_configurations option;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.
*)output_format : metric_stream_output_format option;The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
last_update_date : timestamp option;The date of the most recent update to the metric stream's configuration.
*)creation_date : timestamp option;The date that the metric stream was created.
*)state : metric_stream_state option;The state of the metric stream. The possible values are running and stopped.
role_arn : amazon_resource_name option;The ARN of the IAM role that is used by this metric stream.
*)firehose_arn : amazon_resource_name option;The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
*)exclude_filters : metric_stream_filters option;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.
*)include_filters : metric_stream_filters option;If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
*)name : metric_stream_name option;The name of the metric stream.
*)arn : amazon_resource_name option;The ARN of the metric stream.
*)}type nonrec get_metric_stream_input = {name : metric_stream_name;The name of the metric stream to retrieve information about.
*)}type nonrec datapoint_value_map = (extended_statistic * datapoint_value) listtype nonrec datapoint = {extended_statistics : datapoint_value_map option;The percentile statistic for the data point.
*)unit_ : standard_unit option;The standard unit for the data point.
*)maximum : datapoint_value option;The maximum metric value for the data point.
*)minimum : datapoint_value option;The minimum metric value for the data point.
*)sum : datapoint_value option;The sum of the metric values for the data point.
*)average : datapoint_value option;The average of the metric values that correspond to the data point.
*)sample_count : datapoint_value option;The number of metric values that contributed to the aggregate value of this data point.
*)timestamp : timestamp option;The time stamp used for the data point.
*)}Encapsulates the statistical data that CloudWatch computes from metric data.
type nonrec datapoints = datapoint listtype nonrec get_metric_statistics_output = {datapoints : datapoints option;The data points for the specified metric.
*)label : metric_label option;A label for the specified metric.
*)}type nonrec extended_statistics = extended_statistic listtype nonrec get_metric_statistics_input = {unit_ : standard_unit option;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.
extended_statistics : extended_statistics option;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.
statistics : statistics option;The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
period : 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, 20, 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:
end_time : timestamp;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).
*)start_time : timestamp;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:
If you set Period to 5, 10, 20, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, 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.
dimensions : dimensions option;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.
*)metric_name : metric_name;The name of the metric, with or without spaces.
*)namespace : namespace;The namespace of the metric, with or without spaces.
*)}type nonrec get_metric_data_output = {messages : metric_data_result_messages option;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.
next_token : next_token option;A token that marks the next batch of returned results.
*)metric_data_results : metric_data_results option;The metrics that are returned, including the metric name, namespace, and dimensions.
*)}type nonrec get_metric_data_input = {label_options : label_options option;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.
max_datapoints : get_metric_data_max_datapoints option;The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
*)scan_by : scan_by option;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.
If you omit this parameter, the default of TimestampDescending is used.
next_token : next_token option;Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.
end_time : timestamp;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.
start_time : timestamp;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:
If you set Period to 5, 10, 20, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, 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.
metric_data_queries : metric_data_queries;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.
}type nonrec get_insight_rule_report_output = {metric_datapoints : insight_rule_metric_datapoints option;A time series of metric data points that matches the time period in the rule request.
*)contributors : insight_rule_contributors option;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.
*)approximate_unique_count : insight_rule_unbound_long option;An approximate count of the unique contributors found by this rule in this time period.
*)aggregate_value : insight_rule_unbound_double option;The sum of the values from all individual contributors that match the rule.
*)aggregation_statistic : insight_rule_aggregation_statistic option;Specifies whether this rule aggregates contributor data by COUNT or SUM.
*)key_labels : insight_rule_contributor_key_labels option;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.
*)}type nonrec get_insight_rule_report_input = {order_by : insight_rule_order_by option;Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
metrics : insight_rule_metric_list option;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.max_contributor_count : insight_rule_unbound_integer option;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.
*)period : period;The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
end_time : timestamp;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.
start_time : timestamp;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.
rule_name : insight_rule_name;The name of the rule that you want to see data from.
*)}type nonrec get_dataset_output = {kms_key_arn : kms_key_arn option;Returns the Amazon Resource Name (ARN) of the customer managed Amazon Web Services KMS key that is currently associated with the dataset, if any. If the dataset is not associated with a customer managed KMS key, this field is not included in the response and the dataset is encrypted at rest using an Amazon Web Services owned key.
*)arn : dataset_arn;Returns the Amazon Resource Name (ARN) of the dataset, in the format
arn:aws:cloudwatch:{i Region}:{i account-id}:dataset/{i dataset-id} .
*)dataset_id : dataset_id;Returns the identifier of the dataset.
*)}type nonrec get_dataset_input = {dataset_identifier : dataset_identifier;Specifies the identifier of the dataset to retrieve. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format
arn:aws:cloudwatch:{i Region}:{i account-id}:dataset/default.
*)}The specified dashboard does not exist.
type nonrec get_dashboard_output = {dashboard_name : dashboard_name option;The name of the dashboard.
*)dashboard_body : dashboard_body option;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.
dashboard_arn : dashboard_arn option;The Amazon Resource Name (ARN) of the dashboard.
*)}type nonrec get_dashboard_input = {dashboard_name : dashboard_name;The name of the dashboard to be described.
*)}type nonrec get_alarm_mute_rule_output = {mute_type : mute_type option;Indicates whether the mute rule is one-time or recurring. Valid values are ONE_TIME or RECURRING.
last_updated_timestamp : timestamp option;The date and time when the mute rule was last updated.
*)status : alarm_mute_rule_status option;The current status of the alarm mute rule. Valid values are SCHEDULED, ACTIVE, or EXPIRED.
expire_date : timestamp option;The date and time when the mute rule expires and is no longer evaluated.
*)start_date : timestamp option;The date and time when the mute rule becomes active. If not set, the rule is active immediately.
*)mute_targets : mute_targets option;Specifies which alarms this rule applies to.
*)rule : rule option;The configuration that defines when and how long alarms are muted.
*)description : alarm_description option;The description of the alarm mute rule.
*)alarm_mute_rule_arn : arn option;The Amazon Resource Name (ARN) of the alarm mute rule.
*)name : name option;The name of the alarm mute rule.
*)}type nonrec get_alarm_mute_rule_input = {alarm_mute_rule_name : name;The name of the alarm mute rule to retrieve.
*)}type nonrec enable_insight_rules_output = {failures : batch_failures option;An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
*)}type nonrec enable_insight_rules_input = {rule_names : insight_rule_names;An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
*)}type nonrec alarm_names = alarm_name listtype nonrec disassociate_dataset_kms_key_input = {dataset_identifier : dataset_identifier;Specifies the identifier of the dataset from which to remove the KMS key association. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format
arn:aws:cloudwatch:{i Region}:{i account-id}:dataset/default.
*)}type nonrec disable_insight_rules_output = {failures : batch_failures option;An array listing the rules that could not be disabled. You cannot disable built-in rules.
*)}type nonrec disable_insight_rules_input = {rule_names : insight_rule_names;An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
*)}type nonrec describe_insight_rules_output = {insight_rules : insight_rules option;The rules returned by the operation.
*)next_token : next_token option;If this parameter is present, it is a token that marks the start of the next batch of returned results.
*)}type nonrec describe_insight_rules_input = {max_results : insight_rule_max_results option;The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.
*)next_token : next_token option;Include this value, if it was returned by the previous operation, to get the next set of rules.
*)}type nonrec anomaly_detector = {metric_math_anomaly_detector : metric_math_anomaly_detector option;The CloudWatch metric math expression for this anomaly detector.
*)single_metric_anomaly_detector : single_metric_anomaly_detector option;The CloudWatch metric and statistic for this anomaly detector.
*)metric_characteristics : metric_characteristics option;This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.
state_value : anomaly_detector_state_value option;The current status of the anomaly detector's training.
*)configuration : anomaly_detector_configuration option;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.
*)stat : anomaly_detector_metric_stat option;The statistic associated with the anomaly detection model.
*)dimensions : dimensions option;The metric dimensions associated with the anomaly detection model.
*)metric_name : metric_name option;The name of the metric associated with the anomaly detection model.
*)namespace : namespace option;The namespace of the metric associated with the anomaly detection model.
*)}An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.
If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.
type nonrec anomaly_detectors = anomaly_detector listtype nonrec describe_anomaly_detectors_output = {next_token : next_token option;A token that you can use in a subsequent operation to retrieve the next set of results.
*)anomaly_detectors : anomaly_detectors option;The list of anomaly detection models returned by the operation.
*)}type nonrec anomaly_detector_types = anomaly_detector_type listtype nonrec describe_anomaly_detectors_input = {anomaly_detector_types : anomaly_detector_types option;The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults to SINGLE_METRIC.
dimensions : dimensions option;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.
*)metric_name : metric_name option;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.
*)namespace : namespace option;Limits the results to only the anomaly detection models that are associated with the specified namespace.
*)max_results : max_returned_results_count option;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.
next_token : next_token option;Use the token returned by the previous operation to request the next page of results.
*)}type nonrec describe_alarms_for_metric_output = {metric_alarms : metric_alarms option;The information for each alarm with the specified metric.
*)}type nonrec describe_alarms_for_metric_input = {unit_ : standard_unit option;The unit for the metric.
*)period : period option;The period, in seconds, over which the statistic is applied.
*)dimensions : dimensions option;The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
*)extended_statistic : extended_statistic option;The percentile statistic for the metric. Specify a value between p0.0 and p100.
*)statistic : statistic option;The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
namespace : namespace;The namespace of the metric.
*)metric_name : metric_name;The name of the metric.
*)}type nonrec composite_alarm = {actions_suppressor_extension_period : suppressor_period option;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.
actions_suppressor_wait_period : suppressor_period option;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.
actions_suppressor : alarm_arn option;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.
actions_suppressed_reason : actions_suppressed_reason option;Captures the reason for action suppression.
*)actions_suppressed_by : actions_suppressed_by option;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.
state_transitioned_timestamp : timestamp option;The timestamp of the last change to the alarm's StateValue.
state_value : state_value option;The state value for the alarm.
*)state_updated_timestamp : timestamp option;Tracks the timestamp of any state update, even if StateValue doesn't change.
state_reason_data : state_reason_data option;An explanation for the alarm state, in JSON format.
*)state_reason : state_reason option;An explanation for the alarm state, in text format.
*)ok_actions : resource_list option;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).
*)insufficient_data_actions : resource_list option;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).
*)alarm_rule : alarm_rule option;The rule that this alarm uses to evaluate its alarm state.
*)alarm_name : alarm_name option;The name of the alarm.
*)alarm_description : alarm_description option;The description of the alarm.
*)alarm_configuration_updated_timestamp : timestamp option;The time stamp of the last update to the alarm configuration.
*)alarm_arn : alarm_arn option;The Amazon Resource Name (ARN) of the alarm.
*)alarm_actions : resource_list option;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).
*)actions_enabled : actions_enabled option;Indicates whether actions should be executed during any changes to the alarm state.
*)}The details about a composite alarm.
type nonrec composite_alarms = composite_alarm listtype nonrec describe_alarms_output = {next_token : next_token option;The token that marks the start of the next batch of returned results.
*)log_alarms : log_alarms option;The information about any log alarms returned by the operation.
*)metric_alarms : metric_alarms option;The information about any metric alarms returned by the operation.
*)composite_alarms : composite_alarms option;The information about any composite alarms returned by the operation.
*)}type nonrec alarm_types = alarm_type listtype nonrec describe_alarms_input = {next_token : next_token option;The token returned by a previous call to indicate that there is more data available.
*)max_records : max_records option;The maximum number of alarm descriptions to retrieve.
*)action_prefix : action_prefix option;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.
*)state_value : state_value option;Specify this parameter to receive information only about alarms that are currently in the state that you specify.
*)parents_of_alarm_name : alarm_name option;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.
children_of_alarm_name : alarm_name option;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.
alarm_types : alarm_types option;Use this parameter to specify whether you want the operation to return metric alarms, composite alarms, or log alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms or log alarms exist in the account.
For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms or log alarms, even if they exist in the account.
If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms or log alarms.
If you specify LogAlarms, the operation returns only a list of log alarms, and does not return any metric alarms or composite alarms.
alarm_name_prefix : alarm_name_prefix option;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.
alarm_names : alarm_names option;The names of the alarms to retrieve information about.
*)}type nonrec contributor_attributes = (attribute_name * attribute_value) listtype nonrec alarm_history_item = {alarm_contributor_attributes : contributor_attributes option;A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.
*)history_data : history_data option;Data about the alarm, in JSON format.
*)history_summary : history_summary option;A summary of the alarm history, in text format.
*)history_item_type : history_item_type option;The type of alarm history item.
*)timestamp : timestamp option;The time stamp for the alarm history item.
*)alarm_type : alarm_type option;The type of alarm, either metric alarm or composite alarm.
*)alarm_contributor_id : contributor_id option;The unique identifier of the alarm contributor associated with this history item, if applicable.
*)alarm_name : alarm_name option;The descriptive name for the alarm.
*)}Represents the history of a specific alarm.
type nonrec alarm_history_items = alarm_history_item listtype nonrec describe_alarm_history_output = {next_token : next_token option;The token that marks the start of the next batch of returned results.
*)alarm_history_items : alarm_history_items option;The alarm histories, in JSON format.
*)}type nonrec describe_alarm_history_input = {scan_by : scan_by option;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.
next_token : next_token option;The token returned by a previous call to indicate that there is more data available.
*)max_records : max_records option;The maximum number of alarm history records to retrieve.
*)end_date : timestamp option;The ending date to retrieve alarm history.
*)start_date : timestamp option;The starting date to retrieve alarm history.
*)history_item_type : history_item_type option;The type of alarm histories to retrieve.
*)alarm_types : alarm_types option;Use this parameter to specify whether you want the operation to return metric alarms, composite alarms, or log alarms. If you omit this parameter, only metric alarms are returned.
*)alarm_contributor_id : contributor_id option;The unique identifier of a specific alarm contributor to filter the alarm history results.
*)alarm_name : alarm_name option;The name of the alarm.
*)}type nonrec alarm_contributor = {state_transitioned_timestamp : timestamp option;The timestamp when the contributor last transitioned to its current state.
*)state_reason : state_reason;An explanation for the contributor's current state, providing context about why it is in its current condition.
*)contributor_attributes : contributor_attributes;A map of attributes that describe the contributor, such as metric dimensions and other identifying characteristics.
*)contributor_id : contributor_id;The unique identifier for this alarm contributor.
*)}Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm's state.
type nonrec alarm_contributors = alarm_contributor listtype nonrec describe_alarm_contributors_output = {next_token : next_token option;The token that marks the start of the next batch of returned results.
*)alarm_contributors : alarm_contributors;A list of alarm contributors that provide details about the individual time series contributing to the alarm's state.
*)}type nonrec describe_alarm_contributors_input = {next_token : next_token option;The token returned by a previous call to indicate that there is more data available.
*)alarm_name : alarm_name;The name of the alarm for which to retrieve contributor information.
*)}type nonrec delete_metric_stream_input = {name : metric_stream_name;The name of the metric stream to delete.
*)}type nonrec delete_insight_rules_output = {failures : batch_failures option;An array listing the rules that could not be deleted. You cannot delete built-in rules.
*)}type nonrec delete_insight_rules_input = {rule_names : insight_rule_names;An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
*)}type nonrec dashboard_names = dashboard_name listtype nonrec delete_dashboards_input = {dashboard_names : dashboard_names;The dashboards to be deleted. This parameter is required.
*)}type nonrec delete_anomaly_detector_input = {metric_math_anomaly_detector : metric_math_anomaly_detector option;The metric math anomaly detector to be deleted.
When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:
Dimensions,MetricNameNamespaceStatSingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInputInstead, specify the metric math anomaly detector attributes as part of the MetricMathAnomalyDetector property.
single_metric_anomaly_detector : single_metric_anomaly_detector option;A single metric anomaly detector to be deleted.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:
Dimensions,MetricNameNamespaceStatMetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInputInstead, specify the single metric anomaly detector attributes as part of the SingleMetricAnomalyDetector property.
stat : anomaly_detector_metric_stat option;The statistic associated with the anomaly detection model to delete.
*)dimensions : dimensions option;The metric dimensions associated with the anomaly detection model to delete.
*)metric_name : metric_name option;The metric name associated with the anomaly detection model to delete.
*)namespace : namespace option;The namespace associated with the anomaly detection model to delete.
*)}type nonrec delete_alarms_input = {alarm_names : alarm_names;The alarms to be deleted. Do not enclose the alarm names in quote marks.
*)}type nonrec delete_alarm_mute_rule_input = {alarm_mute_rule_name : name;The name of the alarm mute rule to delete.
*)}type nonrec associate_dataset_kms_key_input = {kms_key_arn : kms_key_arn;Specifies the Amazon Resource Name (ARN) of the customer managed KMS key to associate with the dataset. The key must be a symmetric encryption KMS key (SYMMETRIC_DEFAULT) in the same Amazon Web Services Region as the dataset.
The ARN must be in the format
arn:aws:kms:{i Region}:{i account-id}:key/{i key-id} . Key IDs, aliases, and alias ARNs are not accepted.
For more information about KMS key ARNs, see Key ARN in the Amazon Web Services Key Management Service Developer Guide.
*)dataset_identifier : dataset_identifier;Specifies the identifier of the dataset that you want to associate the KMS key with. For the default dataset, you can specify either default or the full dataset Amazon Resource Name (ARN) in the format
arn:aws:cloudwatch:{i Region}:{i account-id}:dataset/default.
*)}