Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
If you specify an incorrect alarm name or make any other error in the operation, no alarms are deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
" }, "DeleteDashboards": { "name": "DeleteDashboards", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteDashboardsInput" }, "output": { "shape": "DeleteDashboardsOutput", "resultWrapper": "DeleteDashboardsResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "DashboardNotFoundError" }, { "shape": "InternalServiceFault" } ], "documentation": "Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
" }, "DeleteInsightRules": { "name": "DeleteInsightRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteInsightRulesInput" }, "output": { "shape": "DeleteInsightRulesOutput", "resultWrapper": "DeleteInsightRulesResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" } ], "documentation": "Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
" }, "DeleteMetricStream": { "name": "DeleteMetricStream", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteMetricStreamInput" }, "output": { "shape": "DeleteMetricStreamOutput", "resultWrapper": "DeleteMetricStreamResult" }, "errors": [ { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" } ], "documentation": "Permanently deletes the metric stream that you specify.
" }, "DescribeAlarmHistory": { "name": "DescribeAlarmHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAlarmHistoryInput" }, "output": { "shape": "DescribeAlarmHistoryOutput", "resultWrapper": "DescribeAlarmHistoryResult" }, "errors": [ { "shape": "InvalidNextToken" } ], "documentation": "Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.
Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.
To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.
" }, "DescribeAnomalyDetectors": { "name": "DescribeAnomalyDetectors", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeAnomalyDetectorsInput" }, "output": { "shape": "DescribeAnomalyDetectorsOutput", "resultWrapper": "DescribeAnomalyDetectorsResult" }, "errors": [ { "shape": "InvalidNextToken" }, { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" }, { "shape": "InvalidParameterCombinationException" } ], "documentation": "Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.
Returns a list of all the Contributor Insights rules in your account.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
" }, "DisableAlarmActions": { "name": "DisableAlarmActions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableAlarmActionsInput" }, "documentation": "Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
" }, "DisableInsightRules": { "name": "DisableInsightRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisableInsightRulesInput" }, "output": { "shape": "DisableInsightRulesOutput", "resultWrapper": "DisableInsightRulesResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" } ], "documentation": "Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
" }, "EnableAlarmActions": { "name": "EnableAlarmActions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableAlarmActionsInput" }, "documentation": "Enables the actions for the specified alarms.
" }, "EnableInsightRules": { "name": "EnableInsightRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "EnableInsightRulesInput" }, "output": { "shape": "EnableInsightRulesOutput", "resultWrapper": "EnableInsightRulesResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" }, { "shape": "LimitExceededException" } ], "documentation": "Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
" }, "GetDashboard": { "name": "GetDashboard", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetDashboardInput" }, "output": { "shape": "GetDashboardOutput", "resultWrapper": "GetDashboardResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "DashboardNotFoundError" }, { "shape": "InternalServiceFault" } ], "documentation": "Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.
You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
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.
You can use the GetMetricData API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData operation that does not include a query can retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform metric math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
If you include a Metrics Insights query, each GetMetricData operation can include only one query. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries can query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
If you omit Unit in your request, 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.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
" }, "GetMetricStatistics": { "name": "GetMetricStatistics", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetMetricStatisticsInput" }, "output": { "shape": "GetMetricStatisticsOutput", "resultWrapper": "GetMetricStatisticsResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" }, { "shape": "InvalidParameterCombinationException" }, { "shape": "InternalServiceFault" } ], "documentation": "Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
" }, "GetMetricStream": { "name": "GetMetricStream", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetMetricStreamInput" }, "output": { "shape": "GetMetricStreamOutput", "resultWrapper": "GetMetricStreamResult" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" }, { "shape": "InvalidParameterCombinationException" } ], "documentation": "Returns information about the metric stream that you specify.
" }, "GetMetricWidgetImage": { "name": "GetMetricWidgetImage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetMetricWidgetImageInput" }, "output": { "shape": "GetMetricWidgetImageOutput", "resultWrapper": "GetMetricWidgetImageResult" }, "documentation": "You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:
As many as 100 metrics in the graph.
Up to 100 KB uncompressed payload.
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.
Returns a list that contains the number of managed Contributor Insights rules in your account.
" }, "ListMetricStreams": { "name": "ListMetricStreams", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListMetricStreamsInput" }, "output": { "shape": "ListMetricStreamsOutput", "resultWrapper": "ListMetricStreamsResult" }, "errors": [ { "shape": "InvalidNextToken" }, { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" } ], "documentation": "Returns a list of metric streams in this account.
" }, "ListMetrics": { "name": "ListMetrics", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListMetricsInput" }, "output": { "shape": "ListMetricsOutput", "resultWrapper": "ListMetricsResult" }, "errors": [ { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" } ], "documentation": "List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to 15 minutes for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view metrics from the linked source accounts. For more information, see CloudWatch cross-account observability.
ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.
Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
" }, "PutAnomalyDetector": { "name": "PutAnomalyDetector", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutAnomalyDetectorInput" }, "output": { "shape": "PutAnomalyDetectorOutput", "resultWrapper": "PutAnomalyDetectorResult" }, "errors": [ { "shape": "LimitExceededException" }, { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" }, { "shape": "InvalidParameterCombinationException" } ], "documentation": "Creates an anomaly detection model for a CloudWatch metric. 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. You can specify the account ID in the object you specify in the SingleMetricAnomalyDetector parameter.
For more information, see CloudWatch Anomaly Detection.
" }, "PutCompositeAlarm": { "name": "PutCompositeAlarm", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutCompositeAlarmInput" }, "errors": [ { "shape": "LimitExceededFault" } ], "documentation": "Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms.
Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
Composite alarms can take the following actions:
Notify Amazon SNS topics.
Invoke Lambda functions.
Create OpsItems in Systems Manager Ops Center.
Create incidents in Systems Manager Incident Manager.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.
Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
" }, "PutManagedInsightRules": { "name": "PutManagedInsightRules", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutManagedInsightRulesInput" }, "output": { "shape": "PutManagedInsightRulesOutput", "resultWrapper": "PutManagedInsightRulesResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" } ], "documentation": " Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You cannot edit these rules with PutInsightRule. The rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use ListManagedInsightRules to describe all available rules.
Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
The iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
Cross-account alarms
You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:
The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.
The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.
Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricData structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 1000 different metrics.
Although the Value 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.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.
You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party solutions.
For more information, see Using Metric Streams.
To create a metric stream, you must be signed in to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission.
When you create or update a metric stream, you choose one of the following:
Stream metrics from all metric namespaces in the account.
Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters.
Stream metrics from only the metric namespaces that you list in IncludeFilters.
By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use the StatisticsConfigurations parameter to have the metric stream send additional statistics in the stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream to create a new metric stream, the stream is created in the running state. If you use it to update an existing stream, the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account, you can choose whether to include metrics from source accounts in the stream. For more information, see CloudWatch cross-account observability.
" }, "SetAlarmState": { "name": "SetAlarmState", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetAlarmStateInput" }, "errors": [ { "shape": "ResourceNotFound" }, { "shape": "InvalidFormatFault" } ], "documentation": "Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.
Starts the streaming of metrics for one or more of your metric streams.
" }, "StopMetricStreams": { "name": "StopMetricStreams", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StopMetricStreamsInput" }, "output": { "shape": "StopMetricStreamsOutput", "resultWrapper": "StopMetricStreamsResult" }, "errors": [ { "shape": "InternalServiceFault" }, { "shape": "InvalidParameterValueException" }, { "shape": "MissingRequiredParameterException" } ], "documentation": "Stops the streaming of metrics for one or more of your metric streams.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceInput" }, "output": { "shape": "TagResourceOutput", "resultWrapper": "TagResourceResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ConcurrentModificationException" }, { "shape": "InternalServiceFault" } ], "documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceInput" }, "output": { "shape": "UntagResourceOutput", "resultWrapper": "UntagResourceResult" }, "errors": [ { "shape": "InvalidParameterValueException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ConcurrentModificationException" }, { "shape": "InternalServiceFault" } ], "documentation": "Removes one or more tags from the specified resource.
" } }, "shapes": { "AccountId": { "type": "string", "max": 255, "min": 1 }, "ActionPrefix": { "type": "string", "max": 1024, "min": 1 }, "ActionsEnabled": { "type": "boolean" }, "ActionsSuppressedBy": { "type": "string", "enum": [ "WaitPeriod", "ExtensionPeriod", "Alarm" ] }, "ActionsSuppressedReason": { "type": "string", "max": 1024, "min": 0 }, "AlarmArn": { "type": "string", "max": 1600, "min": 1 }, "AlarmDescription": { "type": "string", "max": 1024, "min": 0 }, "AlarmHistoryItem": { "type": "structure", "members": { "AlarmName": { "shape": "AlarmName", "documentation": "The descriptive name for the alarm.
" }, "AlarmType": { "shape": "AlarmType", "documentation": "The type of alarm, either metric alarm or composite alarm.
" }, "Timestamp": { "shape": "Timestamp", "documentation": "The time stamp for the alarm history item.
" }, "HistoryItemType": { "shape": "HistoryItemType", "documentation": "The type of alarm history item.
" }, "HistorySummary": { "shape": "HistorySummary", "documentation": "A summary of the alarm history, in text format.
" }, "HistoryData": { "shape": "HistoryData", "documentation": "Data about the alarm, in JSON format.
" } }, "documentation": "Represents the history of a specific alarm.
" }, "AlarmHistoryItems": { "type": "list", "member": { "shape": "AlarmHistoryItem" } }, "AlarmName": { "type": "string", "max": 255, "min": 1 }, "AlarmNamePrefix": { "type": "string", "max": 255, "min": 1 }, "AlarmNames": { "type": "list", "member": { "shape": "AlarmName" }, "max": 100 }, "AlarmRule": { "type": "string", "max": 10240, "min": 1 }, "AlarmType": { "type": "string", "enum": [ "CompositeAlarm", "MetricAlarm" ] }, "AlarmTypes": { "type": "list", "member": { "shape": "AlarmType" } }, "AmazonResourceName": { "type": "string", "max": 1024, "min": 1 }, "AnomalyDetector": { "type": "structure", "members": { "Namespace": { "shape": "Namespace", "documentation": "The namespace of the metric associated with the anomaly detection model.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector.Namespace property." }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric associated with the anomaly detection model.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector.MetricName property." }, "Dimensions": { "shape": "Dimensions", "documentation": "The metric dimensions associated with the anomaly detection model.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector.Dimensions property." }, "Stat": { "shape": "AnomalyDetectorMetricStat", "documentation": "The statistic associated with the anomaly detection model.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector.Stat property." }, "Configuration": { "shape": "AnomalyDetectorConfiguration", "documentation": "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.
" }, "StateValue": { "shape": "AnomalyDetectorStateValue", "documentation": "The current status of the anomaly detector's training.
" }, "MetricCharacteristics": { "shape": "MetricCharacteristics", "documentation": "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.
The CloudWatch metric and statistic for this anomaly detector.
" }, "MetricMathAnomalyDetector": { "shape": "MetricMathAnomalyDetector", "documentation": "The CloudWatch metric math expression for this anomaly detector.
" } }, "documentation": "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.
" }, "AnomalyDetectorConfiguration": { "type": "structure", "members": { "ExcludedTimeRanges": { "shape": "AnomalyDetectorExcludedTimeRanges", "documentation": "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.
" }, "MetricTimezone": { "shape": "AnomalyDetectorMetricTimezone", "documentation": "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.
" } }, "documentation": "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.
" }, "AnomalyDetectorExcludedTimeRanges": { "type": "list", "member": { "shape": "Range" } }, "AnomalyDetectorMetricStat": { "type": "string", "max": 50, "pattern": "(SampleCount|Average|Sum|Minimum|Maximum|IQM|(p|tc|tm|ts|wm)(\\d{1,2}(\\.\\d{0,10})?|100)|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?|(TM|TC|TS|WM)\\(((((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?:((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%|((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%:(((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?)\\)|(TM|TC|TS|WM|PR)\\(((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)):((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?|((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?:(\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))\\)" }, "AnomalyDetectorMetricTimezone": { "type": "string", "max": 50, "pattern": ".*" }, "AnomalyDetectorStateValue": { "type": "string", "enum": [ "PENDING_TRAINING", "TRAINED_INSUFFICIENT_DATA", "TRAINED" ] }, "AnomalyDetectorType": { "type": "string", "enum": [ "SINGLE_METRIC", "METRIC_MATH" ] }, "AnomalyDetectorTypes": { "type": "list", "member": { "shape": "AnomalyDetectorType" }, "max": 2 }, "AnomalyDetectors": { "type": "list", "member": { "shape": "AnomalyDetector" } }, "BatchFailures": { "type": "list", "member": { "shape": "PartialFailure" } }, "ComparisonOperator": { "type": "string", "enum": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold", "LessThanLowerOrGreaterThanUpperThreshold", "LessThanLowerThreshold", "GreaterThanUpperThreshold" ] }, "CompositeAlarm": { "type": "structure", "members": { "ActionsEnabled": { "shape": "ActionsEnabled", "documentation": "Indicates whether actions should be executed during any changes to the alarm state.
" }, "AlarmActions": { "shape": "ResourceList", "documentation": "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).
" }, "AlarmArn": { "shape": "AlarmArn", "documentation": "The Amazon Resource Name (ARN) of the alarm.
" }, "AlarmConfigurationUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time stamp of the last update to the alarm configuration.
" }, "AlarmDescription": { "shape": "AlarmDescription", "documentation": "The description of the alarm.
" }, "AlarmName": { "shape": "AlarmName", "documentation": "The name of the alarm.
" }, "AlarmRule": { "shape": "AlarmRule", "documentation": "The rule that this alarm uses to evaluate its alarm state.
" }, "InsufficientDataActions": { "shape": "ResourceList", "documentation": "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).
" }, "OKActions": { "shape": "ResourceList", "documentation": "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).
" }, "StateReason": { "shape": "StateReason", "documentation": "An explanation for the alarm state, in text format.
" }, "StateReasonData": { "shape": "StateReasonData", "documentation": "An explanation for the alarm state, in JSON format.
" }, "StateUpdatedTimestamp": { "shape": "Timestamp", "documentation": "Tracks the timestamp of any state update, even if StateValue doesn't change.
The state value for the alarm.
" }, "StateTransitionedTimestamp": { "shape": "Timestamp", "documentation": " The timestamp of the last change to the alarm's StateValue.
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.
Captures the reason for action suppression.
" }, "ActionsSuppressor": { "shape": "AlarmArn", "documentation": " 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.
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.
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.
The details about a composite alarm.
", "xmlOrder": [ "ActionsEnabled", "AlarmActions", "AlarmArn", "AlarmConfigurationUpdatedTimestamp", "AlarmDescription", "AlarmName", "AlarmRule", "InsufficientDataActions", "OKActions", "StateReason", "StateReasonData", "StateUpdatedTimestamp", "StateValue", "StateTransitionedTimestamp", "ActionsSuppressedBy", "ActionsSuppressedReason", "ActionsSuppressor", "ActionsSuppressorWaitPeriod", "ActionsSuppressorExtensionPeriod" ] }, "CompositeAlarms": { "type": "list", "member": { "shape": "CompositeAlarm" } }, "Counts": { "type": "list", "member": { "shape": "DatapointValue" } }, "DashboardArn": { "type": "string" }, "DashboardBody": { "type": "string" }, "DashboardEntries": { "type": "list", "member": { "shape": "DashboardEntry" } }, "DashboardEntry": { "type": "structure", "members": { "DashboardName": { "shape": "DashboardName", "documentation": "The name of the dashboard.
" }, "DashboardArn": { "shape": "DashboardArn", "documentation": "The Amazon Resource Name (ARN) of the dashboard.
" }, "LastModified": { "shape": "LastModified", "documentation": "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.
" }, "Size": { "shape": "Size", "documentation": "The size of the dashboard, in bytes.
" } }, "documentation": "Represents a specific dashboard.
" }, "DashboardName": { "type": "string" }, "DashboardNamePrefix": { "type": "string" }, "DashboardNames": { "type": "list", "member": { "shape": "DashboardName" } }, "DashboardValidationMessage": { "type": "structure", "members": { "DataPath": { "shape": "DataPath", "documentation": "The data path related to the message.
" }, "Message": { "shape": "Message", "documentation": "A message describing the error or warning.
" } }, "documentation": "An error or warning for the operation.
" }, "DashboardValidationMessages": { "type": "list", "member": { "shape": "DashboardValidationMessage" } }, "DataPath": { "type": "string" }, "Datapoint": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The time stamp used for the data point.
" }, "SampleCount": { "shape": "DatapointValue", "documentation": "The number of metric values that contributed to the aggregate value of this data point.
" }, "Average": { "shape": "DatapointValue", "documentation": "The average of the metric values that correspond to the data point.
" }, "Sum": { "shape": "DatapointValue", "documentation": "The sum of the metric values for the data point.
" }, "Minimum": { "shape": "DatapointValue", "documentation": "The minimum metric value for the data point.
" }, "Maximum": { "shape": "DatapointValue", "documentation": "The maximum metric value for the data point.
" }, "Unit": { "shape": "StandardUnit", "documentation": "The standard unit for the data point.
" }, "ExtendedStatistics": { "shape": "DatapointValueMap", "documentation": "The percentile statistic for the data point.
" } }, "documentation": "Encapsulates the statistical data that CloudWatch computes from metric data.
", "xmlOrder": [ "Timestamp", "SampleCount", "Average", "Sum", "Minimum", "Maximum", "Unit", "ExtendedStatistics" ] }, "DatapointValue": { "type": "double" }, "DatapointValueMap": { "type": "map", "key": { "shape": "ExtendedStatistic" }, "value": { "shape": "DatapointValue" } }, "DatapointValues": { "type": "list", "member": { "shape": "DatapointValue" } }, "Datapoints": { "type": "list", "member": { "shape": "Datapoint" } }, "DatapointsToAlarm": { "type": "integer", "min": 1 }, "DeleteAlarmsInput": { "type": "structure", "required": [ "AlarmNames" ], "members": { "AlarmNames": { "shape": "AlarmNames", "documentation": "The alarms to be deleted. Do not enclose the alarm names in quote marks.
" } } }, "DeleteAnomalyDetectorInput": { "type": "structure", "members": { "Namespace": { "shape": "Namespace", "documentation": "The namespace associated with the anomaly detection model to delete.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "MetricName": { "shape": "MetricName", "documentation": "The metric name associated with the anomaly detection model to delete.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "Dimensions": { "shape": "Dimensions", "documentation": "The metric dimensions associated with the anomaly detection model to delete.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "Stat": { "shape": "AnomalyDetectorMetricStat", "documentation": "The statistic associated with the anomaly detection model to delete.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "SingleMetricAnomalyDetector": { "shape": "SingleMetricAnomalyDetector", "documentation": "A single metric anomaly detector to be deleted.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:
Dimensions,
MetricName
Namespace
Stat
the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the SingleMetricAnomalyDetector property.
The metric math anomaly detector to be deleted.
When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:
Dimensions,
MetricName
Namespace
Stat
the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the MetricMathAnomalyDetector property.
The dashboards to be deleted. This parameter is required.
" } } }, "DeleteDashboardsOutput": { "type": "structure", "members": {} }, "DeleteInsightRulesInput": { "type": "structure", "required": [ "RuleNames" ], "members": { "RuleNames": { "shape": "InsightRuleNames", "documentation": "An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
" } } }, "DeleteInsightRulesOutput": { "type": "structure", "members": { "Failures": { "shape": "BatchFailures", "documentation": "An array listing the rules that could not be deleted. You cannot delete built-in rules.
" } } }, "DeleteMetricStreamInput": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "MetricStreamName", "documentation": "The name of the metric stream to delete.
" } } }, "DeleteMetricStreamOutput": { "type": "structure", "members": {} }, "DescribeAlarmHistoryInput": { "type": "structure", "members": { "AlarmName": { "shape": "AlarmName", "documentation": "The name of the alarm.
" }, "AlarmTypes": { "shape": "AlarmTypes", "documentation": "Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
" }, "HistoryItemType": { "shape": "HistoryItemType", "documentation": "The type of alarm histories to retrieve.
" }, "StartDate": { "shape": "Timestamp", "documentation": "The starting date to retrieve alarm history.
" }, "EndDate": { "shape": "Timestamp", "documentation": "The ending date to retrieve alarm history.
" }, "MaxRecords": { "shape": "MaxRecords", "documentation": "The maximum number of alarm history records to retrieve.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned by a previous call to indicate that there is more data available.
" }, "ScanBy": { "shape": "ScanBy", "documentation": "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.
The alarm histories, in JSON format.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token that marks the start of the next batch of returned results.
" } } }, "DescribeAlarmsForMetricInput": { "type": "structure", "required": [ "MetricName", "Namespace" ], "members": { "MetricName": { "shape": "MetricName", "documentation": "The name of the metric.
" }, "Namespace": { "shape": "Namespace", "documentation": "The namespace of the metric.
" }, "Statistic": { "shape": "Statistic", "documentation": "The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
The percentile statistic for the metric. Specify a value between p0.0 and p100.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
" }, "Period": { "shape": "Period", "documentation": "The period, in seconds, over which the statistic is applied.
" }, "Unit": { "shape": "StandardUnit", "documentation": "The unit for the metric.
" } } }, "DescribeAlarmsForMetricOutput": { "type": "structure", "members": { "MetricAlarms": { "shape": "MetricAlarms", "documentation": "The information for each alarm with the specified metric.
" } } }, "DescribeAlarmsInput": { "type": "structure", "members": { "AlarmNames": { "shape": "AlarmNames", "documentation": "The names of the alarms to retrieve information about.
" }, "AlarmNamePrefix": { "shape": "AlarmNamePrefix", "documentation": "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.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite 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, even if composite alarms exist in the account.
If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.
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.
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.
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
" }, "ActionPrefix": { "shape": "ActionPrefix", "documentation": "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.
" }, "MaxRecords": { "shape": "MaxRecords", "documentation": "The maximum number of alarm descriptions to retrieve.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned by a previous call to indicate that there is more data available.
" } } }, "DescribeAlarmsOutput": { "type": "structure", "members": { "CompositeAlarms": { "shape": "CompositeAlarms", "documentation": "The information about any composite alarms returned by the operation.
" }, "MetricAlarms": { "shape": "MetricAlarms", "documentation": "The information about any metric alarms returned by the operation.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token that marks the start of the next batch of returned results.
" } } }, "DescribeAnomalyDetectorsInput": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "Use the token returned by the previous operation to request the next page of results.
" }, "MaxResults": { "shape": "MaxReturnedResultsCount", "documentation": "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.
Limits the results to only the anomaly detection models that are associated with the specified namespace.
" }, "MetricName": { "shape": "MetricName", "documentation": "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.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "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.
" }, "AnomalyDetectorTypes": { "shape": "AnomalyDetectorTypes", "documentation": "The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults to SINGLE_METRIC.
The list of anomaly detection models returned by the operation.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token that you can use in a subsequent operation to retrieve the next set of results.
" } } }, "DescribeInsightRulesInput": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "Include this value, if it was returned by the previous operation, to get the next set of rules.
" }, "MaxResults": { "shape": "InsightRuleMaxResults", "documentation": "The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.
" } } }, "DescribeInsightRulesOutput": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "If this parameter is present, it is a token that marks the start of the next batch of returned results.
" }, "InsightRules": { "shape": "InsightRules", "documentation": "The rules returned by the operation.
" } } }, "Dimension": { "type": "structure", "required": [ "Name", "Value" ], "members": { "Name": { "shape": "DimensionName", "documentation": "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.
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.
" } }, "documentation": "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.
", "xmlOrder": [ "Name", "Value" ] }, "DimensionFilter": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "DimensionName", "documentation": "The dimension name to be matched.
" }, "Value": { "shape": "DimensionValue", "documentation": "The value of the dimension to be matched.
" } }, "documentation": "Represents filters for a dimension.
" }, "DimensionFilters": { "type": "list", "member": { "shape": "DimensionFilter" }, "max": 10 }, "DimensionName": { "type": "string", "max": 255, "min": 1 }, "DimensionValue": { "type": "string", "max": 1024, "min": 1 }, "Dimensions": { "type": "list", "member": { "shape": "Dimension" }, "max": 30 }, "DisableAlarmActionsInput": { "type": "structure", "required": [ "AlarmNames" ], "members": { "AlarmNames": { "shape": "AlarmNames", "documentation": "The names of the alarms.
" } } }, "DisableInsightRulesInput": { "type": "structure", "required": [ "RuleNames" ], "members": { "RuleNames": { "shape": "InsightRuleNames", "documentation": "An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
" } } }, "DisableInsightRulesOutput": { "type": "structure", "members": { "Failures": { "shape": "BatchFailures", "documentation": "An array listing the rules that could not be disabled. You cannot disable built-in rules.
" } } }, "EnableAlarmActionsInput": { "type": "structure", "required": [ "AlarmNames" ], "members": { "AlarmNames": { "shape": "AlarmNames", "documentation": "The names of the alarms.
" } } }, "EnableInsightRulesInput": { "type": "structure", "required": [ "RuleNames" ], "members": { "RuleNames": { "shape": "InsightRuleNames", "documentation": "An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
" } } }, "EnableInsightRulesOutput": { "type": "structure", "members": { "Failures": { "shape": "BatchFailures", "documentation": "An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
" } } }, "EvaluateLowSampleCountPercentile": { "type": "string", "max": 255, "min": 1 }, "EvaluationPeriods": { "type": "integer", "min": 1 }, "EvaluationState": { "type": "string", "enum": [ "PARTIAL_DATA" ] }, "ExceptionType": { "type": "string" }, "ExtendedStatistic": { "type": "string" }, "ExtendedStatistics": { "type": "list", "member": { "shape": "ExtendedStatistic" }, "max": 10, "min": 1 }, "FailureCode": { "type": "string" }, "FailureDescription": { "type": "string" }, "FailureResource": { "type": "string" }, "GetDashboardInput": { "type": "structure", "required": [ "DashboardName" ], "members": { "DashboardName": { "shape": "DashboardName", "documentation": "The name of the dashboard to be described.
" } } }, "GetDashboardOutput": { "type": "structure", "members": { "DashboardArn": { "shape": "DashboardArn", "documentation": "The Amazon Resource Name (ARN) of the dashboard.
" }, "DashboardBody": { "shape": "DashboardBody", "documentation": "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.
The name of the dashboard.
" } } }, "GetInsightRuleReportInput": { "type": "structure", "required": [ "RuleName", "StartTime", "EndTime", "Period" ], "members": { "RuleName": { "shape": "InsightRuleName", "documentation": "The name of the rule that you want to see data from.
" }, "StartTime": { "shape": "Timestamp", "documentation": "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.
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.
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
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.
" }, "Metrics": { "shape": "InsightRuleMetricList", "documentation": "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.
Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
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.
" }, "AggregationStatistic": { "shape": "InsightRuleAggregationStatistic", "documentation": "Specifies whether this rule aggregates contributor data by COUNT or SUM.
" }, "AggregateValue": { "shape": "InsightRuleUnboundDouble", "documentation": "The sum of the values from all individual contributors that match the rule.
" }, "ApproximateUniqueCount": { "shape": "InsightRuleUnboundLong", "documentation": "An approximate count of the unique contributors found by this rule in this time period.
" }, "Contributors": { "shape": "InsightRuleContributors", "documentation": "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.
" }, "MetricDatapoints": { "shape": "InsightRuleMetricDatapoints", "documentation": "A time series of metric data points that matches the time period in the rule request.
" } } }, "GetMetricDataInput": { "type": "structure", "required": [ "MetricDataQueries", "StartTime", "EndTime" ], "members": { "MetricDataQueries": { "shape": "MetricDataQueries", "documentation": "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.
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
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.
Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.
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.
The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
" }, "LabelOptions": { "shape": "LabelOptions", "documentation": "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.
The metrics that are returned, including the metric name, namespace, and dimensions.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token that marks the next batch of returned results.
" }, "Messages": { "shape": "MetricDataResultMessages", "documentation": "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.
The namespace of the metric, with or without spaces.
" }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric, with or without spaces.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "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.
" }, "StartTime": { "shape": "Timestamp", "documentation": "The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
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).
" }, "Period": { "shape": "Period", "documentation": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
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.
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.
A label for the specified metric.
" }, "Datapoints": { "shape": "Datapoints", "documentation": "The data points for the specified metric.
" } } }, "GetMetricStreamInput": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "MetricStreamName", "documentation": "The name of the metric stream to retrieve information about.
" } } }, "GetMetricStreamOutput": { "type": "structure", "members": { "Arn": { "shape": "AmazonResourceName", "documentation": "The ARN of the metric stream.
" }, "Name": { "shape": "MetricStreamName", "documentation": "The name of the metric stream.
" }, "IncludeFilters": { "shape": "MetricStreamFilters", "documentation": "If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
" }, "ExcludeFilters": { "shape": "MetricStreamFilters", "documentation": "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.
" }, "FirehoseArn": { "shape": "AmazonResourceName", "documentation": "The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
" }, "RoleArn": { "shape": "AmazonResourceName", "documentation": "The ARN of the IAM role that is used by this metric stream.
" }, "State": { "shape": "MetricStreamState", "documentation": "The state of the metric stream. The possible values are running and stopped.
The date that the metric stream was created.
" }, "LastUpdateDate": { "shape": "Timestamp", "documentation": "The date of the most recent update to the metric stream's configuration.
" }, "OutputFormat": { "shape": "MetricStreamOutputFormat", "documentation": "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.
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.
" }, "IncludeLinkedAccountsMetrics": { "shape": "IncludeLinkedAccountsMetrics", "documentation": "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.
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.
" }, "OutputFormat": { "shape": "OutputFormat", "documentation": "The format of the resulting image. Only PNG images are supported.
The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example:
<GetMetricWidgetImageResponse xmlns=<URLstring>>
<GetMetricWidgetImageResult>
<MetricWidgetImage>
iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
</MetricWidgetImage>
</GetMetricWidgetImageResult>
<ResponseMetadata>
<RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
</ResponseMetadata>
</GetMetricWidgetImageResponse>
The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image.
The image of the graph, in the output format specified. The output is base64-encoded.
" } } }, "HistoryData": { "type": "string", "max": 4095, "min": 1 }, "HistoryItemType": { "type": "string", "enum": [ "ConfigurationUpdate", "StateUpdate", "Action" ] }, "HistorySummary": { "type": "string", "max": 255, "min": 1 }, "IncludeLinkedAccounts": { "type": "boolean" }, "IncludeLinkedAccountsMetrics": { "type": "boolean" }, "InsightRule": { "type": "structure", "required": [ "Name", "State", "Schema", "Definition" ], "members": { "Name": { "shape": "InsightRuleName", "documentation": "The name of the rule.
" }, "State": { "shape": "InsightRuleState", "documentation": "Indicates whether the rule is enabled or disabled.
" }, "Schema": { "shape": "InsightRuleSchema", "documentation": "For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For managed rules, this is {\"Name\": \"ServiceLogRule\", \"Version\": 1}
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.
" }, "ManagedRule": { "shape": "InsightRuleIsManaged", "documentation": "An optional built-in rule that Amazon Web Services manages.
" } }, "documentation": "This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.
" }, "InsightRuleAggregationStatistic": { "type": "string" }, "InsightRuleContributor": { "type": "structure", "required": [ "Keys", "ApproximateAggregateValue", "Datapoints" ], "members": { "Keys": { "shape": "InsightRuleContributorKeys", "documentation": "One of the log entry field keywords that is used to define contributors for this rule.
" }, "ApproximateAggregateValue": { "shape": "InsightRuleUnboundDouble", "documentation": "An approximation of the aggregate value that comes from this contributor.
" }, "Datapoints": { "shape": "InsightRuleContributorDatapoints", "documentation": "An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
" } }, "documentation": "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.
" }, "InsightRuleContributorDatapoint": { "type": "structure", "required": [ "Timestamp", "ApproximateValue" ], "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The timestamp of the data point.
" }, "ApproximateValue": { "shape": "InsightRuleUnboundDouble", "documentation": "The approximate value that this contributor added during this timestamp.
" } }, "documentation": "One data point related to one contributor.
For more information, see GetInsightRuleReport and InsightRuleContributor.
" }, "InsightRuleContributorDatapoints": { "type": "list", "member": { "shape": "InsightRuleContributorDatapoint" } }, "InsightRuleContributorKey": { "type": "string" }, "InsightRuleContributorKeyLabel": { "type": "string" }, "InsightRuleContributorKeyLabels": { "type": "list", "member": { "shape": "InsightRuleContributorKeyLabel" } }, "InsightRuleContributorKeys": { "type": "list", "member": { "shape": "InsightRuleContributorKey" } }, "InsightRuleContributors": { "type": "list", "member": { "shape": "InsightRuleContributor" } }, "InsightRuleDefinition": { "type": "string", "max": 8192, "min": 1, "pattern": "[\\x00-\\x7F]+" }, "InsightRuleIsManaged": { "type": "boolean" }, "InsightRuleMaxResults": { "type": "integer", "max": 500, "min": 1 }, "InsightRuleMetricDatapoint": { "type": "structure", "required": [ "Timestamp" ], "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The timestamp of the data point.
" }, "UniqueContributors": { "shape": "InsightRuleUnboundDouble", "documentation": "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.
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.
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.
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.
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.
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.
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.
One data point from the metric time series returned in a Contributor Insights rule report.
For more information, see GetInsightRuleReport.
" }, "InsightRuleMetricDatapoints": { "type": "list", "member": { "shape": "InsightRuleMetricDatapoint" } }, "InsightRuleMetricList": { "type": "list", "member": { "shape": "InsightRuleMetricName" } }, "InsightRuleMetricName": { "type": "string", "max": 32, "min": 1, "pattern": "[\\x20-\\x7E]+" }, "InsightRuleName": { "type": "string", "max": 128, "min": 1, "pattern": "[\\x20-\\x7E]+" }, "InsightRuleNames": { "type": "list", "member": { "shape": "InsightRuleName" } }, "InsightRuleOrderBy": { "type": "string", "max": 32, "min": 1, "pattern": "[\\x20-\\x7E]+" }, "InsightRuleSchema": { "type": "string" }, "InsightRuleState": { "type": "string", "max": 32, "min": 1, "pattern": "[\\x20-\\x7E]+" }, "InsightRuleUnboundDouble": { "type": "double" }, "InsightRuleUnboundInteger": { "type": "integer" }, "InsightRuleUnboundLong": { "type": "long" }, "InsightRules": { "type": "list", "member": { "shape": "InsightRule" } }, "LabelOptions": { "type": "structure", "members": { "Timezone": { "shape": "GetMetricDataLabelTimezone", "documentation": "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.
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 \"_\".
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned by a previous call to indicate that there is more data available.
" } } }, "ListDashboardsOutput": { "type": "structure", "members": { "DashboardEntries": { "shape": "DashboardEntries", "documentation": "The list of matching dashboards.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token that marks the start of the next batch of returned results.
" } } }, "ListManagedInsightRulesInput": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
" }, "NextToken": { "shape": "NextToken", "documentation": "Include this value to get the next set of rules if the value was returned by the previous operation.
" }, "MaxResults": { "shape": "InsightRuleMaxResults", "documentation": " 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.
The managed rules that are available for the specified Amazon Web Services resource.
" }, "NextToken": { "shape": "NextToken", "documentation": "Include this value to get the next set of rules if the value was returned by the previous operation.
" } } }, "ListMetricStreamsInput": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "Include this value, if it was returned by the previous call, to get the next set of metric streams.
" }, "MaxResults": { "shape": "ListMetricStreamsMaxResults", "documentation": "The maximum number of results to return in one operation.
" } } }, "ListMetricStreamsMaxResults": { "type": "integer", "max": 500, "min": 1 }, "ListMetricStreamsOutput": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "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.
" }, "Entries": { "shape": "MetricStreamEntries", "documentation": "The array of metric stream information.
" } } }, "ListMetricsInput": { "type": "structure", "members": { "Namespace": { "shape": "Namespace", "documentation": "The metric namespace to filter against. Only the namespace that matches exactly will be returned.
" }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric to filter against. Only the metrics with names that match exactly will be returned.
" }, "Dimensions": { "shape": "DimensionFilters", "documentation": "The dimensions to filter against. Only the dimensions that match exactly will be returned.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token returned by a previous call to indicate that there is more data available.
" }, "RecentlyActive": { "shape": "RecentlyActive", "documentation": "To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
" }, "IncludeLinkedAccounts": { "shape": "IncludeLinkedAccounts", "documentation": "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.
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.
The metrics that match your request.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token that marks the start of the next batch of returned results.
" }, "OwningAccounts": { "shape": "OwningAccounts", "documentation": "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.
" } }, "xmlOrder": [ "Metrics", "NextToken", "OwningAccounts" ] }, "ListTagsForResourceInput": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "The ARN of the CloudWatch resource that you want to view tags for.
The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" } } }, "ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "shape": "TagList", "documentation": "The list of tag keys and values associated with the resource you specified.
" } } }, "ManagedRule": { "type": "structure", "required": [ "TemplateName", "ResourceARN" ], "members": { "TemplateName": { "shape": "TemplateName", "documentation": " The template name for the managed Contributor Insights rule, as returned by ListManagedInsightRules.
The ARN of an Amazon Web Services resource that has managed Contributor Insights rules.
" }, "Tags": { "shape": "TagList", "documentation": " A list of key-value pairs that you can associate with a managed Contributor Insights rule. You can associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You also can use them to scope user permissions by granting a user permission to access or change only the resources that have certain tag values. To associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission. If you are using this operation to update an existing Contributor Insights rule, any tags that you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.
" }, "ManagedRuleDescription": { "type": "structure", "members": { "TemplateName": { "shape": "TemplateName", "documentation": " The template name for the managed rule. Used to enable managed rules using PutManagedInsightRules.
If a managed rule is enabled, this is the ARN for the related Amazon Web Services resource.
" }, "RuleState": { "shape": "ManagedRuleState", "documentation": "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.
" } }, "documentation": " Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules.
The name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource.
" }, "State": { "shape": "InsightRuleState", "documentation": "Indicates whether the rule is enabled or disabled.
" } }, "documentation": "The status of a managed Contributor Insights rule.
" }, "ManagedRules": { "type": "list", "member": { "shape": "ManagedRule" } }, "MaxRecords": { "type": "integer", "max": 100, "min": 1 }, "MaxReturnedResultsCount": { "type": "integer", "min": 1 }, "Message": { "type": "string" }, "MessageData": { "type": "structure", "members": { "Code": { "shape": "MessageDataCode", "documentation": "The error code or status code associated with the message.
" }, "Value": { "shape": "MessageDataValue", "documentation": "The message text.
" } }, "documentation": "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.
The namespace of the metric.
" }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric. This is a required field.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "The dimensions for the metric.
" } }, "documentation": "Represents a specific metric.
", "xmlOrder": [ "Namespace", "MetricName", "Dimensions" ] }, "MetricAlarm": { "type": "structure", "members": { "AlarmName": { "shape": "AlarmName", "documentation": "The name of the alarm.
" }, "AlarmArn": { "shape": "AlarmArn", "documentation": "The Amazon Resource Name (ARN) of the alarm.
" }, "AlarmDescription": { "shape": "AlarmDescription", "documentation": "The description of the alarm.
" }, "AlarmConfigurationUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time stamp of the last update to the alarm configuration.
" }, "ActionsEnabled": { "shape": "ActionsEnabled", "documentation": "Indicates whether actions should be executed during any changes to the alarm state.
" }, "OKActions": { "shape": "ResourceList", "documentation": "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).
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).
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).
The state value for the alarm.
" }, "StateReason": { "shape": "StateReason", "documentation": "An explanation for the alarm state, in text format.
" }, "StateReasonData": { "shape": "StateReasonData", "documentation": "An explanation for the alarm state, in JSON format.
" }, "StateUpdatedTimestamp": { "shape": "Timestamp", "documentation": "The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
" }, "Namespace": { "shape": "Namespace", "documentation": "The namespace of the metric associated with the alarm.
" }, "Statistic": { "shape": "Statistic", "documentation": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "The dimensions for the metric associated with the alarm.
" }, "Period": { "shape": "Period", "documentation": "The period, in seconds, over which the statistic is applied.
" }, "Unit": { "shape": "StandardUnit", "documentation": "The unit of the metric associated with the alarm.
" }, "EvaluationPeriods": { "shape": "EvaluationPeriods", "documentation": "The number of periods over which data is compared to the specified threshold.
" }, "DatapointsToAlarm": { "shape": "DatapointsToAlarm", "documentation": "The number of data points that must be breaching to trigger the alarm.
" }, "Threshold": { "shape": "Threshold", "documentation": "The value to compare with the specified statistic.
" }, "ComparisonOperator": { "shape": "ComparisonOperator", "documentation": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
" }, "TreatMissingData": { "shape": "TreatMissingData", "documentation": "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.
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.
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.
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.
If the value of this field is PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.
The date and time that the alarm's StateValue most recently changed.
The details about a metric alarm.
", "xmlOrder": [ "AlarmName", "AlarmArn", "AlarmDescription", "AlarmConfigurationUpdatedTimestamp", "ActionsEnabled", "OKActions", "AlarmActions", "InsufficientDataActions", "StateValue", "StateReason", "StateReasonData", "StateUpdatedTimestamp", "MetricName", "Namespace", "Statistic", "Dimensions", "Period", "Unit", "EvaluationPeriods", "Threshold", "ComparisonOperator", "ExtendedStatistic", "TreatMissingData", "EvaluateLowSampleCountPercentile", "DatapointsToAlarm", "Metrics", "ThresholdMetricId", "EvaluationState", "StateTransitionedTimestamp" ] }, "MetricAlarms": { "type": "list", "member": { "shape": "MetricAlarm" } }, "MetricCharacteristics": { "type": "structure", "members": { "PeriodicSpikes": { "shape": "PeriodicSpikes", "documentation": "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.
" }, "MetricData": { "type": "list", "member": { "shape": "MetricDatum" } }, "MetricDataQueries": { "type": "list", "member": { "shape": "MetricDataQuery" } }, "MetricDataQuery": { "type": "structure", "required": [ "Id" ], "members": { "Id": { "shape": "MetricId", "documentation": "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.
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.
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.
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.
" }, "ReturnData": { "shape": "ReturnData", "documentation": "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.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.
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.
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.
The short name you specified to represent this metric.
" }, "Label": { "shape": "MetricLabel", "documentation": "The human-readable label associated with the data.
" }, "Timestamps": { "shape": "Timestamps", "documentation": "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].
" }, "Values": { "shape": "DatapointValues", "documentation": "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].
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.
A list of messages with additional information about the data returned.
" } }, "documentation": "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.
The name of the metric.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "The dimensions associated with the metric.
" }, "Timestamp": { "shape": "Timestamp", "documentation": "The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" }, "Value": { "shape": "DatapointValue", "documentation": "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.
" }, "StatisticValues": { "shape": "StatisticSet", "documentation": "The statistical values for the metric.
" }, "Values": { "shape": "Values", "documentation": "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.
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.
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.
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.
" } }, "documentation": "Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
" }, "MetricExpression": { "type": "string", "max": 2048, "min": 1 }, "MetricId": { "type": "string", "max": 255, "min": 1 }, "MetricLabel": { "type": "string" }, "MetricMathAnomalyDetector": { "type": "structure", "members": { "MetricDataQueries": { "shape": "MetricDataQueries", "documentation": "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.
" }, "MetricName": { "type": "string", "max": 255, "min": 1 }, "MetricStat": { "type": "structure", "required": [ "Metric", "Period", "Stat" ], "members": { "Metric": { "shape": "Metric", "documentation": "The metric to return, including the metric name, namespace, and dimensions.
" }, "Period": { "shape": "Period", "documentation": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The statistic to return. It can include any CloudWatch statistic or extended statistic.
" }, "Unit": { "shape": "StandardUnit", "documentation": "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.
This structure defines the metric to be returned, along with the statistics, period, and units.
" }, "MetricStreamEntries": { "type": "list", "member": { "shape": "MetricStreamEntry" } }, "MetricStreamEntry": { "type": "structure", "members": { "Arn": { "shape": "AmazonResourceName", "documentation": "The ARN of the metric stream.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The date that the metric stream was originally created.
" }, "LastUpdateDate": { "shape": "Timestamp", "documentation": "The date that the configuration of this metric stream was most recently updated.
" }, "Name": { "shape": "MetricStreamName", "documentation": "The name of the metric stream.
" }, "FirehoseArn": { "shape": "AmazonResourceName", "documentation": "The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
" }, "State": { "shape": "MetricStreamState", "documentation": "The current state of this stream. Valid values are running and stopped.
The output format of this metric stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7.
This structure contains the configuration information about one metric stream.
" }, "MetricStreamFilter": { "type": "structure", "members": { "Namespace": { "shape": "Namespace", "documentation": "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.
" }, "MetricNames": { "shape": "MetricStreamFilterMetricNames", "documentation": "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.
" } }, "documentation": "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.
" }, "MetricStreamFilterMetricNames": { "type": "list", "member": { "shape": "MetricName" } }, "MetricStreamFilters": { "type": "list", "member": { "shape": "MetricStreamFilter" } }, "MetricStreamName": { "type": "string", "max": 255, "min": 1 }, "MetricStreamNames": { "type": "list", "member": { "shape": "MetricStreamName" } }, "MetricStreamOutputFormat": { "type": "string", "enum": [ "json", "opentelemetry0.7", "opentelemetry1.0" ], "max": 255, "min": 1 }, "MetricStreamState": { "type": "string" }, "MetricStreamStatistic": { "type": "string" }, "MetricStreamStatisticsAdditionalStatistics": { "type": "list", "member": { "shape": "MetricStreamStatistic" } }, "MetricStreamStatisticsConfiguration": { "type": "structure", "required": [ "IncludeMetrics", "AdditionalStatistics" ], "members": { "IncludeMetrics": { "shape": "MetricStreamStatisticsIncludeMetrics", "documentation": "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.
" }, "AdditionalStatistics": { "shape": "MetricStreamStatisticsAdditionalStatistics", "documentation": "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?? 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.
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.
The namespace of the metric.
" }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric.
" } }, "documentation": "This object contains the information for one metric that is to be streamed with additional statistics.
" }, "MetricWidget": { "type": "string" }, "MetricWidgetImage": { "type": "blob" }, "Metrics": { "type": "list", "member": { "shape": "Metric" } }, "Namespace": { "type": "string", "max": 255, "min": 1, "pattern": "[^:].*" }, "NextToken": { "type": "string" }, "OutputFormat": { "type": "string" }, "OwningAccounts": { "type": "list", "member": { "shape": "AccountId" } }, "PartialFailure": { "type": "structure", "members": { "FailureResource": { "shape": "FailureResource", "documentation": "The specified rule that could not be deleted.
" }, "ExceptionType": { "shape": "ExceptionType", "documentation": "The type of error.
" }, "FailureCode": { "shape": "FailureCode", "documentation": "The code of the error.
" }, "FailureDescription": { "shape": "FailureDescription", "documentation": "A description of the error.
" } }, "documentation": "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.
" }, "Period": { "type": "integer", "min": 1 }, "PeriodicSpikes": { "type": "boolean" }, "PutAnomalyDetectorInput": { "type": "structure", "members": { "Namespace": { "shape": "Namespace", "documentation": "The namespace of the metric to create the anomaly detection model for.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric to create the anomaly detection model for.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "Dimensions": { "shape": "Dimensions", "documentation": "The metric dimensions to create the anomaly detection model for.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "Stat": { "shape": "AnomalyDetectorMetricStat", "documentation": "The statistic to use for the metric and the anomaly detection model.
", "deprecated": true, "deprecatedMessage": "Use SingleMetricAnomalyDetector." }, "Configuration": { "shape": "AnomalyDetectorConfiguration", "documentation": "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.
" }, "MetricCharacteristics": { "shape": "MetricCharacteristics", "documentation": "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.
A single metric anomaly detector to be created.
When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:
Dimensions
MetricName
Namespace
Stat
the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput
Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.
The metric math anomaly detector to be created.
When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:
Dimensions
MetricName
Namespace
Stat
the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput
Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
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:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
Systems Manager actions:
arn:aws:ssm:region:account-id:opsitem:severity
The description for the composite alarm.
" }, "AlarmName": { "shape": "AlarmName", "documentation": "The name for the composite alarm. This name must be unique within the Region.
" }, "AlarmRule": { "shape": "AlarmRule", "documentation": "An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in ALARM state.
OK(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in OK state.
INSUFFICIENT_DATA(\"alarm-name or alarm-ARN\") is TRUE if the named alarm is in INSUFFICIENT_DATA state.
TRUE always evaluates to TRUE.
FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.
The following are some examples of AlarmRule:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress) specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This example reduces alarm noise during a known deployment window.
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule can specify as many as 100 \"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.
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:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
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:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
" }, "ActionsSuppressor": { "shape": "AlarmArn", "documentation": " 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.
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.
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.
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.
" }, "DashboardBody": { "shape": "DashboardBody", "documentation": "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.
" } } }, "PutDashboardOutput": { "type": "structure", "members": { "DashboardValidationMessages": { "shape": "DashboardValidationMessages", "documentation": "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.
" } } }, "PutInsightRuleInput": { "type": "structure", "required": [ "RuleName", "RuleDefinition" ], "members": { "RuleName": { "shape": "InsightRuleName", "documentation": "A unique name for the rule.
" }, "RuleState": { "shape": "InsightRuleState", "documentation": "The state of the rule. Valid values are ENABLED and DISABLED.
" }, "RuleDefinition": { "shape": "InsightRuleDefinition", "documentation": "The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
" }, "Tags": { "shape": "TagList", "documentation": "A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
" } } }, "PutInsightRuleOutput": { "type": "structure", "members": {} }, "PutManagedInsightRulesInput": { "type": "structure", "required": [ "ManagedRules" ], "members": { "ManagedRules": { "shape": "ManagedRules", "documentation": " A list of ManagedRules to enable.
An array that lists the rules that could not be enabled.
" } } }, "PutMetricAlarmInput": { "type": "structure", "required": [ "AlarmName", "EvaluationPeriods", "ComparisonOperator" ], "members": { "AlarmName": { "shape": "AlarmName", "documentation": "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
" }, "AlarmDescription": { "shape": "AlarmDescription", "documentation": "The description for the alarm.
" }, "ActionsEnabled": { "shape": "ActionsEnabled", "documentation": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
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:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
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:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
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:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.
The namespace for the metric associated specified in MetricName.
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.
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:
p90
tm90
tc90
ts90
wm90
IQM
PR(n:m) where n and m are values of the metric
TC(X%:X%) where X is between 10 and 90 inclusive.
TM(X%:X%) where X is between 10 and 90 inclusive.
TS(X%:X%) where X is between 10 and 90 inclusive.
WM(X%:X%) where X is between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "The dimensions for the metric specified in MetricName.
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.
Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
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.
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
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.
" }, "Threshold": { "shape": "Threshold", "documentation": "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.
" }, "ComparisonOperator": { "shape": "ComparisonOperator", "documentation": "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.
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.
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
An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.
Each item in the Metrics array either retrieves a metric or performs a math expression.
One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.
If you use the Metrics parameter, you cannot include the 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.
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
" }, "ThresholdMetricId": { "shape": "MetricId", "documentation": "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.
" } } }, "PutMetricDataInput": { "type": "structure", "required": [ "Namespace", "MetricData" ], "members": { "Namespace": { "shape": "Namespace", "documentation": "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/
The data for the metric. The array can include no more than 1000 metrics per call.
" } } }, "PutMetricStreamInput": { "type": "structure", "required": [ "Name", "FirehoseArn", "RoleArn", "OutputFormat" ], "members": { "Name": { "shape": "MetricStreamName", "documentation": "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 \"_\".
" }, "IncludeFilters": { "shape": "MetricStreamFilters", "documentation": "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.
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.
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.
" }, "RoleArn": { "shape": "AmazonResourceName", "documentation": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:
firehose:PutRecord
firehose:PutRecordBatch
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.
A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.
" }, "StatisticsConfigurations": { "shape": "MetricStreamStatisticsConfigurations", "documentation": "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.
If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.
The ARN of the metric stream.
" } } }, "Range": { "type": "structure", "required": [ "StartTime", "EndTime" ], "members": { "StartTime": { "shape": "Timestamp", "documentation": "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.
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.
Specifies one range of days or times to exclude from use for training an anomaly detection model.
", "xmlOrder": [ "StartTime", "EndTime" ] }, "RecentlyActive": { "type": "string", "enum": [ "PT3H" ] }, "ResourceList": { "type": "list", "member": { "shape": "ResourceName" }, "max": 5 }, "ResourceName": { "type": "string", "max": 1024, "min": 1 }, "ReturnData": { "type": "boolean" }, "ScanBy": { "type": "string", "enum": [ "TimestampDescending", "TimestampAscending" ] }, "SetAlarmStateInput": { "type": "structure", "required": [ "AlarmName", "StateValue", "StateReason" ], "members": { "AlarmName": { "shape": "AlarmName", "documentation": "The name of the alarm.
" }, "StateValue": { "shape": "StateValue", "documentation": "The value of the state.
" }, "StateReason": { "shape": "StateReason", "documentation": "The reason that this alarm is set to this specific state, in text format.
" }, "StateReasonData": { "shape": "StateReasonData", "documentation": "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.
" } } }, "SingleMetricAnomalyDetector": { "type": "structure", "members": { "AccountId": { "shape": "AccountId", "documentation": "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.
" }, "Namespace": { "shape": "Namespace", "documentation": "The namespace of the metric to create the anomaly detection model for.
" }, "MetricName": { "shape": "MetricName", "documentation": "The name of the metric to create the anomaly detection model for.
" }, "Dimensions": { "shape": "Dimensions", "documentation": "The metric dimensions to create the anomaly detection model for.
" }, "Stat": { "shape": "AnomalyDetectorMetricStat", "documentation": "The statistic to use for the metric and anomaly detection model.
" } }, "documentation": "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.
" }, "Size": { "type": "long" }, "StandardUnit": { "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ] }, "StartMetricStreamsInput": { "type": "structure", "required": [ "Names" ], "members": { "Names": { "shape": "MetricStreamNames", "documentation": "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.
" } } }, "StartMetricStreamsOutput": { "type": "structure", "members": {} }, "Stat": { "type": "string" }, "StateReason": { "type": "string", "max": 1023, "min": 0 }, "StateReasonData": { "type": "string", "max": 4000, "min": 0 }, "StateValue": { "type": "string", "enum": [ "OK", "ALARM", "INSUFFICIENT_DATA" ] }, "Statistic": { "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ] }, "StatisticSet": { "type": "structure", "required": [ "SampleCount", "Sum", "Minimum", "Maximum" ], "members": { "SampleCount": { "shape": "DatapointValue", "documentation": "The number of samples used for the statistic set.
" }, "Sum": { "shape": "DatapointValue", "documentation": "The sum of values for the sample set.
" }, "Minimum": { "shape": "DatapointValue", "documentation": "The minimum value of the sample set.
" }, "Maximum": { "shape": "DatapointValue", "documentation": "The maximum value of the sample set.
" } }, "documentation": "Represents a set of statistics that describes a specific metric.
" }, "Statistics": { "type": "list", "member": { "shape": "Statistic" }, "max": 5, "min": 1 }, "StatusCode": { "type": "string", "enum": [ "Complete", "InternalError", "PartialData", "Forbidden" ] }, "StopMetricStreamsInput": { "type": "structure", "required": [ "Names" ], "members": { "Names": { "shape": "MetricStreamNames", "documentation": "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.
" } } }, "StopMetricStreamsOutput": { "type": "structure", "members": {} }, "StorageResolution": { "type": "integer", "min": 1 }, "SuppressorPeriod": { "type": "integer" }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "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.
" }, "Value": { "shape": "TagValue", "documentation": "The value for the specified tag key.
" } }, "documentation": "A key-value pair associated with a CloudWatch resource.
" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" } }, "TagList": { "type": "list", "member": { "shape": "Tag" } }, "TagResourceInput": { "type": "structure", "required": [ "ResourceARN", "Tags" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "The ARN of the CloudWatch resource that you're adding tags to.
The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" }, "Tags": { "shape": "TagList", "documentation": "The list of key-value pairs to associate with the alarm.
" } } }, "TagResourceOutput": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "min": 0 }, "TemplateName": { "type": "string", "max": 128, "min": 1, "pattern": "[0-9A-Za-z][\\-\\.\\_0-9A-Za-z]{0,126}[0-9A-Za-z]" }, "Threshold": { "type": "double" }, "Timestamp": { "type": "timestamp" }, "Timestamps": { "type": "list", "member": { "shape": "Timestamp" } }, "TreatMissingData": { "type": "string", "max": 255, "min": 1 }, "UntagResourceInput": { "type": "structure", "required": [ "ResourceARN", "TagKeys" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "The ARN of the CloudWatch resource that you're removing tags from.
The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
" }, "TagKeys": { "shape": "TagKeyList", "documentation": "The list of tag keys to remove from the resource.
" } } }, "UntagResourceOutput": { "type": "structure", "members": {} }, "Values": { "type": "list", "member": { "shape": "DatapointValue" } } }, "documentation": "Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
" }