The descriptive name for the alarm.
" } }, "AlarmType": { "target": "com.amazonaws.cloudwatch#AlarmType", "traits": { "smithy.api#documentation": "The type of alarm, either metric alarm or composite alarm.
" } }, "Timestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp for the alarm history item.
" } }, "HistoryItemType": { "target": "com.amazonaws.cloudwatch#HistoryItemType", "traits": { "smithy.api#documentation": "The type of alarm history item.
" } }, "HistorySummary": { "target": "com.amazonaws.cloudwatch#HistorySummary", "traits": { "smithy.api#documentation": "A summary of the alarm history, in text format.
" } }, "HistoryData": { "target": "com.amazonaws.cloudwatch#HistoryData", "traits": { "smithy.api#documentation": "Data about the alarm, in JSON format.
" } } }, "traits": { "smithy.api#documentation": "Represents the history of a specific alarm.
" } }, "com.amazonaws.cloudwatch#AlarmHistoryItems": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#AlarmHistoryItem" } }, "com.amazonaws.cloudwatch#AlarmName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#AlarmNamePrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#AlarmNames": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#AlarmName" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.cloudwatch#AlarmRule": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10240 } } }, "com.amazonaws.cloudwatch#AlarmType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CompositeAlarm", "name": "CompositeAlarm" }, { "value": "MetricAlarm", "name": "MetricAlarm" } ] } }, "com.amazonaws.cloudwatch#AlarmTypes": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#AlarmType" } }, "com.amazonaws.cloudwatch#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.cloudwatch#AnomalyDetector": { "type": "structure", "members": { "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The namespace of the metric associated with the anomaly detection model.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric associated with the anomaly detection model.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The metric dimensions associated with the anomaly detection model.
" } }, "Stat": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { "smithy.api#documentation": "The statistic associated with the anomaly detection model.
" } }, "Configuration": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", "traits": { "smithy.api#documentation": "The configuration specifies details about how the \n\t\tanomaly detection model is to be trained, including time ranges to \n\t\texclude from use for training the model, and the time zone to use for \n\t\tthe metric.
" } }, "StateValue": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorStateValue", "traits": { "smithy.api#documentation": "The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA\n
An anomaly detection model associated with a particular CloudWatch metric and statistic. You\n\t\t\tcan use the model to display a band of expected normal values when the metric is\n\t\t\tgraphed.
" } }, "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration": { "type": "structure", "members": { "ExcludedTimeRanges": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorExcludedTimeRanges", "traits": { "smithy.api#documentation": "An array of time ranges to exclude from use when the anomaly detection model is trained. Use\n\t\t\tthis to make sure that events that could cause unusual values for the metric, such as\n\t\t\tdeployments, aren't used when CloudWatch creates the model.
" } }, "MetricTimezone": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone", "traits": { "smithy.api#documentation": "The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.
\n\t\tTo specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.
" } } }, "traits": { "smithy.api#documentation": "The configuration specifies details about how the anomaly detection model is to be trained,\n\t\t\tincluding time ranges to exclude from use for training the model and the time zone to\n\t\t\tuse for the metric.
" } }, "com.amazonaws.cloudwatch#AnomalyDetectorExcludedTimeRanges": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Range" } }, "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat": { "type": "string", "traits": { "smithy.api#pattern": "(SampleCount|Average|Sum|Minimum|Maximum|p(\\d{1,2}|100)(\\.\\d{0,2})?|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?" } }, "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 50 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.cloudwatch#AnomalyDetectorStateValue": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PENDING_TRAINING", "name": "PENDING_TRAINING" }, { "value": "TRAINED_INSUFFICIENT_DATA", "name": "TRAINED_INSUFFICIENT_DATA" }, { "value": "TRAINED", "name": "TRAINED" } ] } }, "com.amazonaws.cloudwatch#AnomalyDetectors": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#AnomalyDetector" } }, "com.amazonaws.cloudwatch#AwsQueryErrorMessage": { "type": "string" }, "com.amazonaws.cloudwatch#BatchFailures": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#PartialFailure" } }, "com.amazonaws.cloudwatch#ComparisonOperator": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "GreaterThanOrEqualToThreshold", "name": "GreaterThanOrEqualToThreshold" }, { "value": "GreaterThanThreshold", "name": "GreaterThanThreshold" }, { "value": "LessThanThreshold", "name": "LessThanThreshold" }, { "value": "LessThanOrEqualToThreshold", "name": "LessThanOrEqualToThreshold" }, { "value": "LessThanLowerOrGreaterThanUpperThreshold", "name": "LessThanLowerOrGreaterThanUpperThreshold" }, { "value": "LessThanLowerThreshold", "name": "LessThanLowerThreshold" }, { "value": "GreaterThanUpperThreshold", "name": "GreaterThanUpperThreshold" } ] } }, "com.amazonaws.cloudwatch#CompositeAlarm": { "type": "structure", "members": { "ActionsEnabled": { "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm state.
" } }, "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { "smithy.api#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": { "target": "com.amazonaws.cloudwatch#AlarmArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alarm.
" } }, "AlarmConfigurationUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp of the last update to the alarm configuration.
" } }, "AlarmDescription": { "target": "com.amazonaws.cloudwatch#AlarmDescription", "traits": { "smithy.api#documentation": "The description of the alarm.
" } }, "AlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "The name of the alarm.
" } }, "AlarmRule": { "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { "smithy.api#documentation": "The rule that this alarm uses to evaluate its alarm state.
" } }, "InsufficientDataActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { "smithy.api#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": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { "smithy.api#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": { "target": "com.amazonaws.cloudwatch#StateReason", "traits": { "smithy.api#documentation": "An explanation for the alarm state, in text format.
" } }, "StateReasonData": { "target": "com.amazonaws.cloudwatch#StateReasonData", "traits": { "smithy.api#documentation": "An explanation for the alarm state, in JSON format.
" } }, "StateUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp of the last update to the alarm state.
" } }, "StateValue": { "target": "com.amazonaws.cloudwatch#StateValue", "traits": { "smithy.api#documentation": "The state value for the alarm.
" } } }, "traits": { "smithy.api#documentation": "The details about a composite alarm.
" } }, "com.amazonaws.cloudwatch#CompositeAlarms": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#CompositeAlarm" } }, "com.amazonaws.cloudwatch#ConcurrentModificationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudwatch#FaultDescription" } }, "traits": { "smithy.api#documentation": "More than one process tried to modify a resource at the same time.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.cloudwatch#Counts": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DatapointValue" } }, "com.amazonaws.cloudwatch#DashboardArn": { "type": "string" }, "com.amazonaws.cloudwatch#DashboardBody": { "type": "string" }, "com.amazonaws.cloudwatch#DashboardEntries": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DashboardEntry" } }, "com.amazonaws.cloudwatch#DashboardEntry": { "type": "structure", "members": { "DashboardName": { "target": "com.amazonaws.cloudwatch#DashboardName", "traits": { "smithy.api#documentation": "The name of the dashboard.
" } }, "DashboardArn": { "target": "com.amazonaws.cloudwatch#DashboardArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" } }, "LastModified": { "target": "com.amazonaws.cloudwatch#LastModified", "traits": { "smithy.api#documentation": "The time stamp of when the dashboard was last modified, either by an API call or\n\t\t\tthrough the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" } }, "Size": { "target": "com.amazonaws.cloudwatch#Size", "traits": { "smithy.api#documentation": "The size of the dashboard, in bytes.
" } } }, "traits": { "smithy.api#documentation": "Represents a specific dashboard.
" } }, "com.amazonaws.cloudwatch#DashboardErrorMessage": { "type": "string" }, "com.amazonaws.cloudwatch#DashboardInvalidInputError": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#DashboardErrorMessage" }, "dashboardValidationMessages": { "target": "com.amazonaws.cloudwatch#DashboardValidationMessages" } }, "traits": { "smithy.api#documentation": "Some part of the dashboard data is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#DashboardName": { "type": "string" }, "com.amazonaws.cloudwatch#DashboardNamePrefix": { "type": "string" }, "com.amazonaws.cloudwatch#DashboardNames": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DashboardName" } }, "com.amazonaws.cloudwatch#DashboardNotFoundError": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#DashboardErrorMessage" } }, "traits": { "smithy.api#documentation": "The specified dashboard does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudwatch#DashboardValidationMessage": { "type": "structure", "members": { "DataPath": { "target": "com.amazonaws.cloudwatch#DataPath", "traits": { "smithy.api#documentation": "The data path related to the message.
" } }, "Message": { "target": "com.amazonaws.cloudwatch#Message", "traits": { "smithy.api#documentation": "A message describing the error or warning.
" } } }, "traits": { "smithy.api#documentation": "An error or warning for the operation.
" } }, "com.amazonaws.cloudwatch#DashboardValidationMessages": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DashboardValidationMessage" } }, "com.amazonaws.cloudwatch#DataPath": { "type": "string" }, "com.amazonaws.cloudwatch#Datapoint": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp used for the data point.
" } }, "SampleCount": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The number of metric values that contributed to the aggregate value of this\n\t\t\tdata point.
" } }, "Average": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The average of the metric values that correspond to the data point.
" } }, "Sum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The sum of the metric values for the data point.
" } }, "Minimum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The minimum metric value for the data point.
" } }, "Maximum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The maximum metric value for the data point.
" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { "smithy.api#documentation": "The standard unit for the data point.
" } }, "ExtendedStatistics": { "target": "com.amazonaws.cloudwatch#DatapointValueMap", "traits": { "smithy.api#documentation": "The percentile statistic for the data point.
" } } }, "traits": { "smithy.api#documentation": "Encapsulates the statistical data that CloudWatch computes from metric data.
" } }, "com.amazonaws.cloudwatch#DatapointValue": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudwatch#DatapointValueMap": { "type": "map", "key": { "target": "com.amazonaws.cloudwatch#ExtendedStatistic" }, "value": { "target": "com.amazonaws.cloudwatch#DatapointValue" } }, "com.amazonaws.cloudwatch#DatapointValues": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DatapointValue" } }, "com.amazonaws.cloudwatch#Datapoints": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Datapoint" } }, "com.amazonaws.cloudwatch#DatapointsToAlarm": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudwatch#DeleteAlarms": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DeleteAlarmsInput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#ResourceNotFound" } ], "traits": { "smithy.api#documentation": "Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more\n\t\t\tthan one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't\n\t\t\tdelete two composite alarms with one operation.
\n\t\t\n\t\t\tIn the event of an error, no alarms are\n\t\t\tdeleted.
\n\t\tIt is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.
\n\t\t\tTo get out of such a situation, you must\n\t\t\t\tbreak 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\n\t\t\t\tchange 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.\n\t\t\t
\nThe alarms to be deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DeleteAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DeleteAnomalyDetectorInput" }, "output": { "target": "com.amazonaws.cloudwatch#DeleteAnomalyDetectorOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes the specified anomaly detection model from your account.
" } }, "com.amazonaws.cloudwatch#DeleteAnomalyDetectorInput": { "type": "structure", "members": { "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The namespace associated with the anomaly detection model to delete.
", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The metric name associated with the anomaly detection model to delete.
", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The metric dimensions associated with the anomaly detection model to delete.
" } }, "Stat": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { "smithy.api#documentation": "The statistic associated with the anomaly detection model to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DeleteAnomalyDetectorOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#DeleteDashboards": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DeleteDashboardsInput" }, "output": { "target": "com.amazonaws.cloudwatch#DeleteDashboardsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#DashboardNotFoundError" }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Deletes all dashboards that you specify. You\n\t\t\tcan specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are\n\t\t\tdeleted.
" } }, "com.amazonaws.cloudwatch#DeleteDashboardsInput": { "type": "structure", "members": { "DashboardNames": { "target": "com.amazonaws.cloudwatch#DashboardNames", "traits": { "smithy.api#documentation": "The dashboards to be deleted. This parameter is required.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DeleteDashboardsOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#DeleteInsightRules": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DeleteInsightRulesInput" }, "output": { "target": "com.amazonaws.cloudwatch#DeleteInsightRulesOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Permanently deletes the specified Contributor Insights rules.
\n\t\tIf you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might\n\t\t\tnot be available.
" } }, "com.amazonaws.cloudwatch#DeleteInsightRulesInput": { "type": "structure", "members": { "RuleNames": { "target": "com.amazonaws.cloudwatch#InsightRuleNames", "traits": { "smithy.api#documentation": "An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DeleteInsightRulesOutput": { "type": "structure", "members": { "Failures": { "target": "com.amazonaws.cloudwatch#BatchFailures", "traits": { "smithy.api#documentation": "An array listing the rules that could not be deleted. You cannot delete built-in rules.
" } } } }, "com.amazonaws.cloudwatch#DeleteMetricStream": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DeleteMetricStreamInput" }, "output": { "target": "com.amazonaws.cloudwatch#DeleteMetricStreamOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Permanently deletes the metric stream that you specify.
" } }, "com.amazonaws.cloudwatch#DeleteMetricStreamInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { "smithy.api#documentation": "The name of the metric stream to delete.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DeleteMetricStreamOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#DescribeAlarmHistory": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DescribeAlarmHistoryInput" }, "output": { "target": "com.amazonaws.cloudwatch#DescribeAlarmHistoryOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidNextToken" } ], "traits": { "smithy.api#documentation": "Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
\n\t\tCloudWatch retains the history of an alarm even if you delete the alarm.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "AlarmHistoryItems", "pageSize": "MaxRecords" } } }, "com.amazonaws.cloudwatch#DescribeAlarmHistoryInput": { "type": "structure", "members": { "AlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "The name of the alarm.
" } }, "AlarmTypes": { "target": "com.amazonaws.cloudwatch#AlarmTypes", "traits": { "smithy.api#documentation": "Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, \n\t\t\tonly metric alarms are returned.
" } }, "HistoryItemType": { "target": "com.amazonaws.cloudwatch#HistoryItemType", "traits": { "smithy.api#documentation": "The type of alarm histories to retrieve.
" } }, "StartDate": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The starting date to retrieve alarm history.
" } }, "EndDate": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The ending date to retrieve alarm history.
" } }, "MaxRecords": { "target": "com.amazonaws.cloudwatch#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of alarm history records to retrieve.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.
" } }, "ScanBy": { "target": "com.amazonaws.cloudwatch#ScanBy", "traits": { "smithy.api#documentation": "Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest\n\t\tevent history returned first, and specify TimestampAscending to have the oldest history returned first.
The alarm histories, in JSON format.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token that marks the start of the next batch of returned results.
" } } } }, "com.amazonaws.cloudwatch#DescribeAlarms": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DescribeAlarmsInput" }, "output": { "target": "com.amazonaws.cloudwatch#DescribeAlarmsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidNextToken" } ], "traits": { "smithy.api#documentation": "Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxRecords" }, "smithy.waiters#waitable": { "AlarmExists": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "length(MetricAlarms[]) > `0`", "expected": "true", "comparator": "booleanEquals" } } } ], "minDelay": 5 }, "CompositeAlarmExists": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "length(CompositeAlarms[]) > `0`", "expected": "true", "comparator": "booleanEquals" } } } ], "minDelay": 5 } } } }, "com.amazonaws.cloudwatch#DescribeAlarmsForMetric": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DescribeAlarmsForMetricInput" }, "output": { "target": "com.amazonaws.cloudwatch#DescribeAlarmsForMetricOutput" }, "traits": { "smithy.api#documentation": "Retrieves the alarms for the specified metric. To\n\t\t\tfilter the results, specify a statistic, period, or unit.
\n\t\tThis operation retrieves only standard alarms that are based on\n\t\tthe specified metric. It does not return alarms based on math expressions that\n\t\tuse the specified metric, or composite alarms that use the specified metric.
" } }, "com.amazonaws.cloudwatch#DescribeAlarmsForMetricInput": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric.
", "smithy.api#required": {} } }, "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The namespace of the metric.
", "smithy.api#required": {} } }, "Statistic": { "target": "com.amazonaws.cloudwatch#Statistic", "traits": { "smithy.api#documentation": "The statistic for the metric, other than percentiles.\n\t\t For percentile statistics, use ExtendedStatistics.
The percentile statistic for the metric. Specify a value between\n\t\t p0.0 and p100.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The dimensions associated with the metric. If the metric has any associated\n\t\t\tdimensions, you must specify them in order for the call to succeed.
" } }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#documentation": "The period, in seconds, over which the statistic is applied.
" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { "smithy.api#documentation": "The unit for the metric.
" } } } }, "com.amazonaws.cloudwatch#DescribeAlarmsForMetricOutput": { "type": "structure", "members": { "MetricAlarms": { "target": "com.amazonaws.cloudwatch#MetricAlarms", "traits": { "smithy.api#documentation": "The information for each alarm with the specified metric.
" } } } }, "com.amazonaws.cloudwatch#DescribeAlarmsInput": { "type": "structure", "members": { "AlarmNames": { "target": "com.amazonaws.cloudwatch#AlarmNames", "traits": { "smithy.api#documentation": "The names of the alarms to retrieve information about.
" } }, "AlarmNamePrefix": { "target": "com.amazonaws.cloudwatch#AlarmNamePrefix", "traits": { "smithy.api#documentation": "An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.
\n\t\tIf this parameter\n\t\t\tis 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, \n\t\tonly metric alarms are returned.
" } }, "ChildrenOfAlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.
If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.
Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe 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 \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe 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": { "target": "com.amazonaws.cloudwatch#ActionPrefix", "traits": { "smithy.api#documentation": "Use this parameter to filter the results of the operation to only those alarms that\n\t\tuse a certain alarm action. For example, you could specify the ARN of an SNS topic to find all\n\t\talarms that send notifications to that topic.
" } }, "MaxRecords": { "target": "com.amazonaws.cloudwatch#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of alarm descriptions to retrieve.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.
" } } } }, "com.amazonaws.cloudwatch#DescribeAlarmsOutput": { "type": "structure", "members": { "CompositeAlarms": { "target": "com.amazonaws.cloudwatch#CompositeAlarms", "traits": { "smithy.api#documentation": "The information about any composite alarms returned by the operation.
" } }, "MetricAlarms": { "target": "com.amazonaws.cloudwatch#MetricAlarms", "traits": { "smithy.api#documentation": "The information about any metric alarms returned by the operation.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token that marks the start of the next batch of returned results.
" } } } }, "com.amazonaws.cloudwatch#DescribeAnomalyDetectors": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsInput" }, "output": { "target": "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidNextToken" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Lists the anomaly detection models that you have created in your account. You can list all\n\t\t\tmodels in your account or filter the results to only the models that are related to a\n\t\t\tcertain namespace, metric name, or metric dimension.
" } }, "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "Use the token returned by the previous operation to request the next page of results.
" } }, "MaxResults": { "target": "com.amazonaws.cloudwatch#MaxReturnedResultsCount", "traits": { "smithy.api#documentation": "The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.
\n\t\t\tTo retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.
Limits the results to only the anomaly detection models that\n\t\t\tare associated with the specified namespace.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric name. If there are multiple metrics with this name in different\n\t\t\tnamespaces that have anomaly detection models, they're all returned.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric dimensions. If there are multiple metrics that have these dimensions\n\t\t\tand have anomaly detection models associated, they're all returned.
" } } } }, "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsOutput": { "type": "structure", "members": { "AnomalyDetectors": { "target": "com.amazonaws.cloudwatch#AnomalyDetectors", "traits": { "smithy.api#documentation": "The list of anomaly detection models returned by the operation.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "A token that you can use in a subsequent operation to \n\t\tretrieve the next set of results.
" } } } }, "com.amazonaws.cloudwatch#DescribeInsightRules": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DescribeInsightRulesInput" }, "output": { "target": "com.amazonaws.cloudwatch#DescribeInsightRulesOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidNextToken" } ], "traits": { "smithy.api#documentation": "Returns a list of all the Contributor Insights rules in your account.
\n\t\t\n\t\tFor more information about Contributor Insights, see \n\t\tUsing Contributor Insights to Analyze High-Cardinality Data.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudwatch#DescribeInsightRulesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "Include this value, if it was returned by the previous operation, to get the next set of rules.
" } }, "MaxResults": { "target": "com.amazonaws.cloudwatch#InsightRuleMaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in one operation. If you omit this\n\t\tparameter, the default of 500 is used.
" } } } }, "com.amazonaws.cloudwatch#DescribeInsightRulesOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "If this parameter is present, it is a token that marks the start of the next batch of returned results.
" } }, "InsightRules": { "target": "com.amazonaws.cloudwatch#InsightRules", "traits": { "smithy.api#documentation": "The rules returned by the operation.
" } } } }, "com.amazonaws.cloudwatch#Dimension": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudwatch#DimensionName", "traits": { "smithy.api#documentation": "The name of the dimension. Dimension names cannot contain blank spaces or non-ASCII\n\t\tcharacters.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudwatch#DimensionValue", "traits": { "smithy.api#documentation": "The value of the dimension. Dimension values cannot contain blank spaces \n\t\t\tor non-ASCII characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A dimension is a name/value pair that is part of the identity of a metric. You \n\t\t\tcan assign up to 10 dimensions to a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric.
" } }, "com.amazonaws.cloudwatch#DimensionFilter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudwatch#DimensionName", "traits": { "smithy.api#documentation": "The dimension name to be matched.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudwatch#DimensionValue", "traits": { "smithy.api#documentation": "The value of the dimension to be matched.
" } } }, "traits": { "smithy.api#documentation": "Represents filters for a dimension.
" } }, "com.amazonaws.cloudwatch#DimensionFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DimensionFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.cloudwatch#DimensionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#DimensionValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#Dimensions": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Dimension" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.cloudwatch#DisableAlarmActions": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DisableAlarmActionsInput" }, "traits": { "smithy.api#documentation": "Disables the actions for the specified alarms. When an alarm's actions are disabled, the\n\t\t\talarm actions do not execute when the alarm state changes.
" } }, "com.amazonaws.cloudwatch#DisableAlarmActionsInput": { "type": "structure", "members": { "AlarmNames": { "target": "com.amazonaws.cloudwatch#AlarmNames", "traits": { "smithy.api#documentation": "The names of the alarms.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DisableInsightRules": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#DisableInsightRulesInput" }, "output": { "target": "com.amazonaws.cloudwatch#DisableInsightRulesOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do \n\t\tnot incur costs.
" } }, "com.amazonaws.cloudwatch#DisableInsightRulesInput": { "type": "structure", "members": { "RuleNames": { "target": "com.amazonaws.cloudwatch#InsightRuleNames", "traits": { "smithy.api#documentation": "An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#DisableInsightRulesOutput": { "type": "structure", "members": { "Failures": { "target": "com.amazonaws.cloudwatch#BatchFailures", "traits": { "smithy.api#documentation": "An array listing the rules that could not be disabled. You cannot disable built-in rules.
" } } } }, "com.amazonaws.cloudwatch#EnableAlarmActions": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#EnableAlarmActionsInput" }, "traits": { "smithy.api#documentation": "Enables the actions for the specified alarms.
" } }, "com.amazonaws.cloudwatch#EnableAlarmActionsInput": { "type": "structure", "members": { "AlarmNames": { "target": "com.amazonaws.cloudwatch#AlarmNames", "traits": { "smithy.api#documentation": "The names of the alarms.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#EnableInsightRules": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#EnableInsightRulesInput" }, "output": { "target": "com.amazonaws.cloudwatch#EnableInsightRulesOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#LimitExceededException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
" } }, "com.amazonaws.cloudwatch#EnableInsightRulesInput": { "type": "structure", "members": { "RuleNames": { "target": "com.amazonaws.cloudwatch#InsightRuleNames", "traits": { "smithy.api#documentation": "An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#EnableInsightRulesOutput": { "type": "structure", "members": { "Failures": { "target": "com.amazonaws.cloudwatch#BatchFailures", "traits": { "smithy.api#documentation": "An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
" } } } }, "com.amazonaws.cloudwatch#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#EvaluationPeriods": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudwatch#ExceptionType": { "type": "string" }, "com.amazonaws.cloudwatch#ExtendedStatistic": { "type": "string", "traits": { "smithy.api#pattern": "p(\\d{1,2}(\\.\\d{0,2})?|100)" } }, "com.amazonaws.cloudwatch#ExtendedStatistics": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#ExtendedStatistic" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.cloudwatch#FailureCode": { "type": "string" }, "com.amazonaws.cloudwatch#FailureDescription": { "type": "string" }, "com.amazonaws.cloudwatch#FailureResource": { "type": "string" }, "com.amazonaws.cloudwatch#FaultDescription": { "type": "string" }, "com.amazonaws.cloudwatch#GetDashboard": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#GetDashboardInput" }, "output": { "target": "com.amazonaws.cloudwatch#GetDashboardOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#DashboardNotFoundError" }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Displays the details of the dashboard that you specify.
\n\t\tTo copy an existing dashboard, use GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard to create\n\t\t\tthe copy.
The name of the dashboard to be described.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#GetDashboardOutput": { "type": "structure", "members": { "DashboardArn": { "target": "com.amazonaws.cloudwatch#DashboardArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" } }, "DashboardBody": { "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { "smithy.api#documentation": "The detailed information about the dashboard, including what widgets are included and their location\n\t\t\ton the dashboard. For more information about the DashboardBody syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.
The name of the dashboard.
" } } } }, "com.amazonaws.cloudwatch#GetInsightRuleReport": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#GetInsightRuleReportInput" }, "output": { "target": "com.amazonaws.cloudwatch#GetInsightRuleReportOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of \n\t\tcontributors to the log group.
\n\t\tYou can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
\n\t\t\n UniqueContributors -- the number of unique contributors for each data point.
\n MaxContributorValue -- the value of the top contributor for each data point. The identity of the\n\t\t\t\t\tcontributor 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 \n\t\t\t\t\tmost 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\n\t\t\t\t\tby the rule's Value, during that period.
\n SampleCount -- the number of data points matched by the rule.
\n Sum -- the sum of the values from all contributors during the time period represented by that data point.
\n Minimum -- the minimum value from a single observation during the time period represented by that data point.
\n Maximum -- the maximum value from a single observation during the time period represented by that data point.
\n Average -- the average value from all contributors during the time period represented by that data point.
The name of the rule that you want to see data from.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-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 \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-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": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricList", "traits": { "smithy.api#documentation": "Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:
\n\t\t\n UniqueContributors -- the number of unique contributors for each data point.
\n MaxContributorValue -- the value of the top contributor for each data point. The identity of the\n\t\t\t\t\tcontributor 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 \n\t\t\t\t\tmost 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\n\t\t\t\t\tby the rule's Value, during that period.
\n SampleCount -- the number of data points matched by the rule.
\n Sum -- the sum of the values from all contributors during the time period represented by that data point.
\n Minimum -- the minimum value from a single observation during the time period represented by that data point.
\n Maximum -- the maximum value from a single observation during the time period represented by that data point.
\n 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.
" } } } }, "com.amazonaws.cloudwatch#GetInsightRuleReportOutput": { "type": "structure", "members": { "KeyLabels": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorKeyLabels", "traits": { "smithy.api#documentation": "An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. \n\t\t\tIf the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
" } }, "AggregationStatistic": { "target": "com.amazonaws.cloudwatch#InsightRuleAggregationStatistic", "traits": { "smithy.api#documentation": "Specifies whether this rule aggregates contributor data by COUNT or SUM.
" } }, "AggregateValue": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { "smithy.api#documentation": "The sum of the values from all individual contributors that match the rule.
" } }, "ApproximateUniqueCount": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundLong", "traits": { "smithy.api#documentation": "An approximate count of the unique contributors found by this rule in this time period.
" } }, "Contributors": { "target": "com.amazonaws.cloudwatch#InsightRuleContributors", "traits": { "smithy.api#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\n\t\tfor the keys counts as a unique contributor.
" } }, "MetricDatapoints": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints", "traits": { "smithy.api#documentation": "A time series of metric data points that matches the time period in the rule request.
" } } } }, "com.amazonaws.cloudwatch#GetMetricData": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#GetMetricDataInput" }, "output": { "target": "com.amazonaws.cloudwatch#GetMetricDataOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidNextToken" } ], "traits": { "smithy.api#documentation": "You can use the GetMetricData API to retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.
Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
\n\t\tData points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics 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.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
\nData points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata 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, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.
\n\t\t\n\t\tIf you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.
The time stamp indicating the earliest data to be returned.
\n\t\tThe value specified is inclusive; results include data points with the specified time stamp.
\n\t\tCloudWatch rounds the specified time stamp as follows:
\n\t\tStart time less than 15 days ago - Round down to the nearest whole minute.\n\t\t\t\tFor example, 12:32:34 is rounded down to 12:32:00.
\nStart time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval.\n\t\t\t\tFor example, 12:32:34 is rounded down to 12:30:00.
\nStart time greater than 63 days ago - Round down to the nearest 1-hour clock interval.\n\t\t\t\tFor example, 12:32:34 is rounded down to 12:00:00.
\nIf you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t
For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the latest data to be returned.
\n\t\tThe value specified is exclusive; results include data points up to the specified time stamp.
\n\t\tFor better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.
Include this value, if it was returned by the previous GetMetricData operation, \n\t\t\tto get the next set of data points.
The order in which data points should be returned. TimestampDescending returns the newest data first and paginates\n\t\t\twhen the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates\n\t\t\twhen the MaxDatapoints limit is reached.
The maximum number of data points the request should return before paginating. If you omit\n\t\t\tthis, the default of 100,800 is used.
" } }, "LabelOptions": { "target": "com.amazonaws.cloudwatch#LabelOptions", "traits": { "smithy.api#documentation": "This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels of returned data display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.
The metrics that are returned, including the metric name, namespace, and dimensions.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "A token that marks the next batch of returned results.
" } }, "Messages": { "target": "com.amazonaws.cloudwatch#MetricDataResultMessages", "traits": { "smithy.api#documentation": "Contains a message about this GetMetricData operation, if the operation results in such a message.\n\t\t\tAn example of a message that\n\t\t\tmight be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the\n\t\t\toperation as possible is still executed.
A message appears here only if it is related to the global GetMetricData operation. Any message\n\t\t\tabout a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.
Gets statistics for the specified metric.
\n\n\n\n\t\tThe maximum number of data points returned from a single call is 1,440. If \n\t\t\tyou request more than 1,440 data points, CloudWatch returns an error. \n\t\t\tTo reduce the number of data points, you can narrow the specified time range and make \n\t\t\tmultiple requests across adjacent time ranges, or you can increase the specified period. \n\t\t\tData points are not returned in chronological order.
\n\n\t\tCloudWatch aggregates data points based on the length of the period\n\t\t\tthat you specify. For example, if you request statistics with a one-hour period, \n\t\t\tCloudWatch aggregates all data points with time stamps that fall within each \n\t\t\tone-hour period. Therefore, the number of values aggregated by CloudWatch is larger than\n\t\t\tthe number of data points returned.
\n\t\tCloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:
\n\t\tThe SampleCount value of the statistic set is 1.
\nThe Min and the Max values of the statistic set are equal.
\nPercentile statistics are not available for metrics when any of the metric values are negative numbers.
\n\t\tAmazon CloudWatch retains metric data as follows:
\n\t\tData points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics 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.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
\nData points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata 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, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\ta resolution of 1 hour.
\n\t\tCloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
\t\n\n\t\tFor information about metrics and dimensions supported by AWS services, see the \n\t\t\tAmazon CloudWatch Metrics and Dimensions Reference in the\n\t\t\tAmazon CloudWatch User Guide.
" } }, "com.amazonaws.cloudwatch#GetMetricStatisticsInput": { "type": "structure", "members": { "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The namespace of the metric, with or without spaces.
", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric, with or without spaces.
", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#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.\n\t\t If a specific combination of dimensions was not published, you can't retrieve statistics for it.\n\t\t You must specify the same dimensions that were used when the metrics were created. For an example,\n\t\t see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.
" } }, "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.
\n\tThe value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
\n\t\tCloudWatch rounds the specified time stamp as follows:
\n\t\tStart time less than 15 days ago - Round down to the nearest whole minute.\n\t\t\t For example, 12:32:34 is rounded down to 12:32:00.
\nStart time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval.\n\t\t\t For example, 12:32:34 is rounded down to 12:30:00.
\nStart time greater than 63 days ago - Round down to the nearest 1-hour clock interval.\n\t\t\t For example, 12:32:34 is rounded down to 12:00:00.
\nIf you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t
The time stamp that determines the last data point to return.
\n\t\tThe value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
", "smithy.api#required": {} } }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#documentation": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare 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\n\t\t 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).
\nStart time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
\nStart time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
\nThe metric statistics, other than percentile. For percentile statistics,\n\t\t use ExtendedStatistics. When calling GetMetricStatistics, you must \n\t\tspecify either Statistics or ExtendedStatistics, but not both.
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must \n\t\t\tspecify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not \n\t\t\tavailable for metrics when any of the metric values are negative numbers.
The unit for a given metric. \n\t\t\tIf you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf 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": { "target": "com.amazonaws.cloudwatch#Datapoints", "traits": { "smithy.api#documentation": "The data points for the specified metric.
" } } } }, "com.amazonaws.cloudwatch#GetMetricStream": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#GetMetricStreamInput" }, "output": { "target": "com.amazonaws.cloudwatch#GetMetricStreamOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns information about the metric stream that you specify.
" } }, "com.amazonaws.cloudwatch#GetMetricStreamInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { "smithy.api#documentation": "The name of the metric stream to retrieve information about.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#GetMetricStreamOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the metric stream.
" } }, "Name": { "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { "smithy.api#documentation": "The name of the metric stream.
" } }, "IncludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { "smithy.api#documentation": "If this array of metric namespaces is present, then these\n\t\t\tnamespaces are the only\n\t\tmetric namespaces that are streamed by this metric stream.
" } }, "ExcludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { "smithy.api#documentation": "If this array of metric namespaces is present, then these namespaces are the only\n\t\t\tmetric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in\n\t\tthe account are streamed by this metric stream.
" } }, "FirehoseArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the Amazon Kinesis Firehose delivery stream that is used by\n\t\tthis metric stream.
" } }, "RoleArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the IAM role that is used by this metric stream.
" } }, "State": { "target": "com.amazonaws.cloudwatch#MetricStreamState", "traits": { "smithy.api#documentation": "The state of the metric stream. The possible values are running\n\t\tand stopped.
The date that the metric stream was created.
" } }, "LastUpdateDate": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The date of the most recent update to the metric stream's configuration.
" } }, "OutputFormat": { "target": "com.amazonaws.cloudwatch#MetricStreamOutputFormat", "traits": { "smithy.api#documentation": "" } } } }, "com.amazonaws.cloudwatch#GetMetricWidgetImage": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#GetMetricWidgetImageInput" }, "output": { "target": "com.amazonaws.cloudwatch#GetMetricWidgetImageOutput" }, "traits": { "smithy.api#documentation": "You can use the GetMetricWidgetImage API to retrieve a snapshot graph of \n\t\t\tone or more Amazon CloudWatch metrics as a bitmap image. You can then embed this \n\t\t\timage into your services and products, such as wiki pages, reports, and documents. \n\t\t\tYou could also retrieve images regularly, such as every minute, and create your own \n\t\t\tcustom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math\n\t\tand horizontal and vertical annotations.
\n\t\t\n\t\tThere 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.
\n\t\t\tUp to 100 KB uncompressed payload.
\n\t\t\tA JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.
For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: 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\n\t\t\tpoint appears next to the graph legend.
", "smithy.api#required": {} } }, "OutputFormat": { "target": "com.amazonaws.cloudwatch#OutputFormat", "traits": { "smithy.api#documentation": "The format of the resulting image. Only PNG images are supported.
\n\n\t\tThe default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:
\n \n\t\t\t\n
\n \n
\n \n
\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n
\n \n
\n \n
\n \n
\n \n
\n \n
\n \n
The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an AWS SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.
The image of the graph, in the output format specified. The output is base64-encoded.
" } } } }, "com.amazonaws.cloudwatch#GraniteServiceVersion20100801": { "type": "service", "version": "2010-08-01", "operations": [ { "target": "com.amazonaws.cloudwatch#DeleteAlarms" }, { "target": "com.amazonaws.cloudwatch#DeleteAnomalyDetector" }, { "target": "com.amazonaws.cloudwatch#DeleteDashboards" }, { "target": "com.amazonaws.cloudwatch#DeleteInsightRules" }, { "target": "com.amazonaws.cloudwatch#DeleteMetricStream" }, { "target": "com.amazonaws.cloudwatch#DescribeAlarmHistory" }, { "target": "com.amazonaws.cloudwatch#DescribeAlarms" }, { "target": "com.amazonaws.cloudwatch#DescribeAlarmsForMetric" }, { "target": "com.amazonaws.cloudwatch#DescribeAnomalyDetectors" }, { "target": "com.amazonaws.cloudwatch#DescribeInsightRules" }, { "target": "com.amazonaws.cloudwatch#DisableAlarmActions" }, { "target": "com.amazonaws.cloudwatch#DisableInsightRules" }, { "target": "com.amazonaws.cloudwatch#EnableAlarmActions" }, { "target": "com.amazonaws.cloudwatch#EnableInsightRules" }, { "target": "com.amazonaws.cloudwatch#GetDashboard" }, { "target": "com.amazonaws.cloudwatch#GetInsightRuleReport" }, { "target": "com.amazonaws.cloudwatch#GetMetricData" }, { "target": "com.amazonaws.cloudwatch#GetMetricStatistics" }, { "target": "com.amazonaws.cloudwatch#GetMetricStream" }, { "target": "com.amazonaws.cloudwatch#GetMetricWidgetImage" }, { "target": "com.amazonaws.cloudwatch#ListDashboards" }, { "target": "com.amazonaws.cloudwatch#ListMetrics" }, { "target": "com.amazonaws.cloudwatch#ListMetricStreams" }, { "target": "com.amazonaws.cloudwatch#ListTagsForResource" }, { "target": "com.amazonaws.cloudwatch#PutAnomalyDetector" }, { "target": "com.amazonaws.cloudwatch#PutCompositeAlarm" }, { "target": "com.amazonaws.cloudwatch#PutDashboard" }, { "target": "com.amazonaws.cloudwatch#PutInsightRule" }, { "target": "com.amazonaws.cloudwatch#PutMetricAlarm" }, { "target": "com.amazonaws.cloudwatch#PutMetricData" }, { "target": "com.amazonaws.cloudwatch#PutMetricStream" }, { "target": "com.amazonaws.cloudwatch#SetAlarmState" }, { "target": "com.amazonaws.cloudwatch#StartMetricStreams" }, { "target": "com.amazonaws.cloudwatch#StopMetricStreams" }, { "target": "com.amazonaws.cloudwatch#TagResource" }, { "target": "com.amazonaws.cloudwatch#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "CloudWatch", "arnNamespace": "monitoring", "cloudFormationName": "CloudWatch", "cloudTrailEventSource": "cloudwatch.amazonaws.com", "endpointPrefix": "monitoring" }, "aws.auth#sigv4": { "name": "monitoring" }, "aws.protocols#awsQuery": {}, "smithy.api#documentation": "Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the\n\t\t\tapplications you run on AWS in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.
\n\n\t\tCloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.
\n\n\t\tIn addition to monitoring the built-in metrics that come with AWS, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.
", "smithy.api#title": "Amazon CloudWatch", "smithy.api#xmlNamespace": { "uri": "http://monitoring.amazonaws.com/doc/2010-08-01/" } } }, "com.amazonaws.cloudwatch#HistoryData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4095 } } }, "com.amazonaws.cloudwatch#HistoryItemType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ConfigurationUpdate", "name": "ConfigurationUpdate" }, { "value": "StateUpdate", "name": "StateUpdate" }, { "value": "Action", "name": "Action" } ] } }, "com.amazonaws.cloudwatch#HistorySummary": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#InsightRule": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cloudwatch#InsightRuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.cloudwatch#InsightRuleState", "traits": { "smithy.api#documentation": "Indicates whether the rule is enabled or disabled.
", "smithy.api#required": {} } }, "Schema": { "target": "com.amazonaws.cloudwatch#InsightRuleSchema", "traits": { "smithy.api#documentation": "For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For built-in rules, \n\t\t\tthis is {\"Name\": \"ServiceLogRule\", \"Version\": 1}\n
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, \n\t\t\tthe value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\t\tRule Syntax.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This structure contains the definition for a Contributor Insights rule.
" } }, "com.amazonaws.cloudwatch#InsightRuleAggregationStatistic": { "type": "string" }, "com.amazonaws.cloudwatch#InsightRuleContributor": { "type": "structure", "members": { "Keys": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorKeys", "traits": { "smithy.api#documentation": "One of the log entry field keywords that is used to define contributors for this rule.
", "smithy.api#required": {} } }, "ApproximateAggregateValue": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { "smithy.api#documentation": "An approximation of the aggregate value that comes from this contributor.
", "smithy.api#required": {} } }, "Datapoints": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorDatapoints", "traits": { "smithy.api#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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then\n\t\t\ta unique contributor is a unique combination of values from all the keys in the rule.
\n\t\tIf the rule contains a single key, then each unique contributor is each unique value for this key.
\n\t\tFor more information, see GetInsightRuleReport.
" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoint": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the data point.
", "smithy.api#required": {} } }, "ApproximateValue": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { "smithy.api#documentation": "The approximate value that this contributor added during this timestamp.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One data point related to one contributor.
\n\t\tFor more information, see GetInsightRuleReport and \n\t\t\tInsightRuleContributor.
" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoints": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorDatapoint" } }, "com.amazonaws.cloudwatch#InsightRuleContributorKey": { "type": "string" }, "com.amazonaws.cloudwatch#InsightRuleContributorKeyLabel": { "type": "string" }, "com.amazonaws.cloudwatch#InsightRuleContributorKeyLabels": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorKeyLabel" } }, "com.amazonaws.cloudwatch#InsightRuleContributorKeys": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleContributorKey" } }, "com.amazonaws.cloudwatch#InsightRuleContributors": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleContributor" } }, "com.amazonaws.cloudwatch#InsightRuleDefinition": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 }, "smithy.api#pattern": "[\\x00-\\x7F]+" } }, "com.amazonaws.cloudwatch#InsightRuleMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.cloudwatch#InsightRuleMetricDatapoint": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the data point.
", "smithy.api#required": {} } }, "UniqueContributors": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { "smithy.api#documentation": "The number of unique contributors who published data during this timestamp.
\n\t\tThis 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, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.
\n\t\tThis 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.
\n\t\tThis 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.
\n\t\tThis 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.
\n\t\tThis 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.
\n\t\tThis 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.
\n\t\tThis 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.
\n\t\tFor more information, see GetInsightRuleReport.
" } }, "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricDatapoint" } }, "com.amazonaws.cloudwatch#InsightRuleMetricList": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricName" } }, "com.amazonaws.cloudwatch#InsightRuleMetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "[\\x20-\\x7E]+" } }, "com.amazonaws.cloudwatch#InsightRuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\x20-\\x7E]+" } }, "com.amazonaws.cloudwatch#InsightRuleNames": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRuleName" } }, "com.amazonaws.cloudwatch#InsightRuleOrderBy": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "[\\x20-\\x7E]+" } }, "com.amazonaws.cloudwatch#InsightRuleSchema": { "type": "string" }, "com.amazonaws.cloudwatch#InsightRuleState": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "[\\x20-\\x7E]+" } }, "com.amazonaws.cloudwatch#InsightRuleUnboundDouble": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudwatch#InsightRuleUnboundInteger": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudwatch#InsightRuleUnboundLong": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudwatch#InsightRules": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#InsightRule" } }, "com.amazonaws.cloudwatch#InternalServiceFault": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.cloudwatch#FaultDescription", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "Request processing has failed due to some unknown error, exception, or failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.cloudwatch#InvalidFormatFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#ErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "Data was not syntactically valid JSON.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#InvalidNextToken": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#ErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "The next token specified is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#InvalidParameterCombinationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#AwsQueryErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "Parameters were used together that cannot be used together.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#InvalidParameterValueException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#AwsQueryErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "The value of an input parameter is bad or out-of-range.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#LabelOptions": { "type": "structure", "members": { "Timezone": { "target": "com.amazonaws.cloudwatch#GetMetricDataLabelTimezone", "traits": { "smithy.api#documentation": "The time zone to use for metric data return in this operation. \n\t\t\tThe format is + or - followed by four digits. \n\t\t\tThe first two digits indicate the number of hours ahead or behind of UTC, and \n\t\t\tthe final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour \n\t\t\tand 30 minutes ahead of UTC. The default is +0000.
This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels that are associated with returned metrics display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.
The Timezone value affects a label only if you have a time-based\n\t\tdynamic expression in the label. For more information about dynamic expressions in labels, \n\t\tsee Using Dynamic Labels.
The operation exceeded one or more limits.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#LimitExceededFault": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#ErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "The quota for alarms for this customer has already been reached.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#ListDashboards": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#ListDashboardsInput" }, "output": { "target": "com.amazonaws.cloudwatch#ListDashboardsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only\n\t\t\tthose dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are\n\t\t\tlisted.\n\t
\n ListDashboards returns up to 1000 results on one page. If there\n\t\t\tare more than 1000 dashboards, you can call ListDashboards again and\n\t\tinclude the value you received for NextToken in the first call, to receive\n\t\tthe next 1000 results.
If you specify this parameter, only\n\t\t\tthe dashboards with names starting with the specified string are listed. The maximum length is 255, and \n\t\t\tvalid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".\n\t\t\t \n\t\t
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data available.
" } } } }, "com.amazonaws.cloudwatch#ListDashboardsOutput": { "type": "structure", "members": { "DashboardEntries": { "target": "com.amazonaws.cloudwatch#DashboardEntries", "traits": { "smithy.api#documentation": "The list of matching dashboards.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token that marks the start of the next batch of returned results.
" } } } }, "com.amazonaws.cloudwatch#ListMetricStreams": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#ListMetricStreamsInput" }, "output": { "target": "com.amazonaws.cloudwatch#ListMetricStreamsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidNextToken" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Returns a list of metric streams in this account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.cloudwatch#ListMetricStreamsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "Include this value, if it was returned by the previous call, to get the next set of metric streams.
" } }, "MaxResults": { "target": "com.amazonaws.cloudwatch#ListMetricStreamsMaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in one operation.
" } } } }, "com.amazonaws.cloudwatch#ListMetricStreamsMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.cloudwatch#ListMetricStreamsOutput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token that marks the start of the next batch of returned results. You can use this \n\t\ttoken in a subsequent operation to get the next batch of results.
" } }, "Entries": { "target": "com.amazonaws.cloudwatch#MetricStreamEntries", "traits": { "smithy.api#documentation": "The array of metric stream information.
" } } } }, "com.amazonaws.cloudwatch#ListMetrics": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#ListMetricsInput" }, "output": { "target": "com.amazonaws.cloudwatch#ListMetricsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" } ], "traits": { "smithy.api#documentation": "List the specified metrics. You can use the returned metrics with\n\t\t\tGetMetricData or \n\t\t\tGetMetricStatistics to obtain statistical data.
\n\t\tUp to 500 results are returned for any one call. To retrieve additional results,\n\t\t\tuse the returned token with subsequent calls.
\n\t\tAfter you create a metric, allow up to 15 minutes before the metric appears.\n\t\t\tYou can see statistics about the metric sooner by using GetMetricData or \n\t\t\tGetMetricStatistics.
\n\n\t\n ListMetrics doesn't return information about metrics if those metrics haven't \n\treported data in the past two weeks. To retrieve those metrics, use \n\t\tGetMetricData or \n\t\tGetMetricStatistics.
The metric namespace to filter against. Only the namespace that matches exactly \n\t\twill be returned.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric to filter against. Only the metrics with names that match exactly \n\t\t\twill be returned.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#DimensionFilters", "traits": { "smithy.api#documentation": "The dimensions to filter against. Only the dimensions that match exactly \n\t\t\twill be returned.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.
" } }, "RecentlyActive": { "target": "com.amazonaws.cloudwatch#RecentlyActive", "traits": { "smithy.api#documentation": "To filter the results to show only metrics that have had data points published\n\t\t\tin the past three hours, specify this parameter\n\t\t\twith a value of PT3H. This is the only valid value\n\t\t\tfor this parameter.
The results that are returned are an approximation of the value you specify. There\n\t\tis a low probability that the returned results include metrics with last published\n\t\tdata as much as 40 minutes more than the specified time interval.
" } } } }, "com.amazonaws.cloudwatch#ListMetricsOutput": { "type": "structure", "members": { "Metrics": { "target": "com.amazonaws.cloudwatch#Metrics", "traits": { "smithy.api#documentation": "The metrics that match your request.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { "smithy.api#documentation": "The token that marks the start of the next batch of returned results.
" } } } }, "com.amazonaws.cloudwatch#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.cloudwatch#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Displays the tags associated with a CloudWatch resource. Currently, alarms \n\t\t\tand Contributor Insights rules support tagging.
" } }, "com.amazonaws.cloudwatch#ListTagsForResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the CloudWatch resource that you want to view tags for.
\n\t\tThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { "smithy.api#documentation": "The list of tag keys and values associated with the resource you specified.
" } } } }, "com.amazonaws.cloudwatch#MaxRecords": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cloudwatch#MaxReturnedResultsCount": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudwatch#Message": { "type": "string" }, "com.amazonaws.cloudwatch#MessageData": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.cloudwatch#MessageDataCode", "traits": { "smithy.api#documentation": "The error code or status code associated with the message.
" } }, "Value": { "target": "com.amazonaws.cloudwatch#MessageDataValue", "traits": { "smithy.api#documentation": "The message text.
" } } }, "traits": { "smithy.api#documentation": "A message returned by the GetMetricDataAPI, including a code and a description.
The namespace of the metric.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric. This is a required field.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The dimensions for the metric.
" } } }, "traits": { "smithy.api#documentation": "Represents a specific metric.
" } }, "com.amazonaws.cloudwatch#MetricAlarm": { "type": "structure", "members": { "AlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "The name of the alarm.
" } }, "AlarmArn": { "target": "com.amazonaws.cloudwatch#AlarmArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alarm.
" } }, "AlarmDescription": { "target": "com.amazonaws.cloudwatch#AlarmDescription", "traits": { "smithy.api#documentation": "The description of the alarm.
" } }, "AlarmConfigurationUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp of the last update to the alarm configuration.
" } }, "ActionsEnabled": { "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm state.
" } }, "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { "smithy.api#documentation": "The actions to execute when this alarm transitions to the OK state\n\t\t\tfrom 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 \n\t\t\tfrom 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 \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
The state value for the alarm.
" } }, "StateReason": { "target": "com.amazonaws.cloudwatch#StateReason", "traits": { "smithy.api#documentation": "An explanation for the alarm state, in text format.
" } }, "StateReasonData": { "target": "com.amazonaws.cloudwatch#StateReasonData", "traits": { "smithy.api#documentation": "An explanation for the alarm state, in JSON format.
" } }, "StateUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time stamp of the last update to the alarm state.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric associated with the alarm, if this is an alarm\n\t\tbased on a single metric.
" } }, "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The namespace of the metric associated with the alarm.
" } }, "Statistic": { "target": "com.amazonaws.cloudwatch#Statistic", "traits": { "smithy.api#documentation": "The statistic for the metric associated with the alarm, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic.
The percentile statistic for the metric associated with the alarm. Specify a value between\n\t\t\tp0.0 and p100.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The dimensions for the metric associated with the alarm.
" } }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#documentation": "The period, in seconds, over which the statistic is applied.
" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { "smithy.api#documentation": "The unit of the metric associated with the alarm.
" } }, "EvaluationPeriods": { "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.
" } }, "DatapointsToAlarm": { "target": "com.amazonaws.cloudwatch#DatapointsToAlarm", "traits": { "smithy.api#documentation": "The number of data points that must be breaching to trigger the alarm.
" } }, "Threshold": { "target": "com.amazonaws.cloudwatch#Threshold", "traits": { "smithy.api#documentation": "The value to compare with the specified statistic.
" } }, "ComparisonOperator": { "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { "smithy.api#documentation": "The arithmetic operation to use when comparing the specified\n\t\t\tstatistic and threshold. The specified statistic value is used as the first operand.
" } }, "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { "smithy.api#documentation": "Sets how this alarm is to handle missing data points. 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 \n\t\t\tduring periods with too few data points to be statistically significant. If evaluate or this \n\t\t\tparameter is not used, the alarm is always evaluated and possibly changes state no matter \n\t\t\thow many data points are available.
An array of MetricDataQuery structures, used in an alarm based on a \n\t\t\tmetric math expression. Each structure either retrieves a \n\t\t\tmetric or performs a math expression.\n\t\t\t\n\t\t\tOne item in the Metrics array is the math expression that the alarm watches. \n\t\t\tThis expression by designated by having ReturnData set to\n\t\t\ttrue.
In an alarm based on an anomaly detection model, this is the ID of the \n\t\t\tANOMALY_DETECTION_BAND function \n\t\t\tused as the threshold for the alarm.
The details about a metric alarm.
" } }, "com.amazonaws.cloudwatch#MetricAlarms": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#MetricAlarm" } }, "com.amazonaws.cloudwatch#MetricData": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#MetricDatum" } }, "com.amazonaws.cloudwatch#MetricDataQueries": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#MetricDataQuery" } }, "com.amazonaws.cloudwatch#MetricDataQuery": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudwatch#MetricId", "traits": { "smithy.api#documentation": "A short name used to tie this object to the results in the response. This name must be\n\t\t\tunique within a single call to GetMetricData. If you are performing math\n\t\t\texpressions on this set of data, this name represents that data and can serve as a\n\t\t\tvariable in the mathematical expression. The valid characters are letters, numbers, and\n\t\t\tunderscore. 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 \n\t\t\tand not performing a math expression on returned data.
\n\t\tWithin one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.
The math expression to be performed on the returned data, if this object is performing a math expression. This expression\n\t\t\tcan use the Id of the other metrics to refer to those metrics, and can also use the Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.
A human-readable label for this metric or expression. This is especially useful \n\t\t\tif this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a \n\t\t\tCloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.
\n\t\tYou can put dynamic expressions into a label, so that it is more descriptive. \n\t\t\tFor more information, see Using Dynamic Labels.
" } }, "ReturnData": { "target": "com.amazonaws.cloudwatch#ReturnData", "traits": { "smithy.api#documentation": "When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tFalse. If you omit this, the default of True is\n\t\t\tused.
When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all \n\t\tother 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 \n\t\t\tperiod can be as short as one minute (60 seconds) and must be a multiple of 60. \n\t\t\tFor high-resolution metrics that are collected at intervals of less than one minute, \n\t\t\tthe period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics \n\t\t\tstored by a PutMetricData operation that includes a StorageResolution of 1 second.
This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse 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\n\t\t\ta batch set of data for one metric, or is performing a math expression on metric data. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.
When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have True\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.
The short name you specified to represent this metric.
" } }, "Label": { "target": "com.amazonaws.cloudwatch#MetricLabel", "traits": { "smithy.api#documentation": "The human-readable label associated with the data.
" } }, "Timestamps": { "target": "com.amazonaws.cloudwatch#Timestamps", "traits": { "smithy.api#documentation": "The timestamps for the data points, formatted in Unix timestamp format. The number of\n\t\t\ttimestamps always matches the number of values and the value for Timestamps[x] is\n\t\t\tValues[x].
" } }, "Values": { "target": "com.amazonaws.cloudwatch#DatapointValues", "traits": { "smithy.api#documentation": "The data points for the metric corresponding to Timestamps. The number of\n\t\t\tvalues always matches the number of timestamps and the timestamp for Values[x] is\n\t\t\tTimestamps[x].
The status of the returned data. Complete indicates that all data points in the requested time range were returned. \n\t\t\tPartialData means that an incomplete set of data points were returned. \n\t\t\t\t\tYou can use the NextToken value that was returned and repeat your request to get more data points. \n\t\t\tNextToken is not returned if you are performing a math expression. InternalError \n\t\t\tindicates that an error occurred. Retry your request using NextToken, if present.
A list of messages with additional information about the data returned.
" } } }, "traits": { "smithy.api#documentation": "A GetMetricData call returns an array of MetricDataResult\n\t\t\tstructures. Each of these structures includes the data points for that metric, along\n\t\t\twith the timestamps of those data points and other identifying information.
The name of the metric.
", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The dimensions associated with the metric.
" } }, "Timestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" } }, "Value": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The value for the metric.
\n\t\tAlthough the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.
" } }, "StatisticValues": { "target": "com.amazonaws.cloudwatch#StatisticSet", "traits": { "smithy.api#documentation": "The statistical values for the metric.
" } }, "Values": { "target": "com.amazonaws.cloudwatch#Values", "traits": { "smithy.api#documentation": "Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.
Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis 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\n\t\tinclude 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 \n\t\ta 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 \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t
\n\tThis field is optional, if you do not specify it the default of 60 is used.
" } } }, "traits": { "smithy.api#documentation": "Encapsulates the information sent to either create a metric or add new values\n\t\t\tto be aggregated into an existing metric.
" } }, "com.amazonaws.cloudwatch#MetricExpression": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.cloudwatch#MetricId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#MetricLabel": { "type": "string" }, "com.amazonaws.cloudwatch#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#MetricStat": { "type": "structure", "members": { "Metric": { "target": "com.amazonaws.cloudwatch#Metric", "traits": { "smithy.api#documentation": "The metric to return, including the metric name, namespace, and dimensions.
", "smithy.api#required": {} } }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#documentation": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare 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\n\t\t\t\t3 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).
\nStart time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
\nStart time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
\nThe statistic to return. It can include any CloudWatch statistic or extended statistic.
", "smithy.api#required": {} } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { "smithy.api#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\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf 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.
" } }, "com.amazonaws.cloudwatch#MetricStreamEntries": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#MetricStreamEntry" } }, "com.amazonaws.cloudwatch#MetricStreamEntry": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the metric stream.
" } }, "CreationDate": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The date that the metric stream was originally created.
" } }, "LastUpdateDate": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The date that the configuration of this metric stream was most recently updated.
" } }, "Name": { "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { "smithy.api#documentation": "The name of the metric stream.
" } }, "FirehoseArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
" } }, "State": { "target": "com.amazonaws.cloudwatch#MetricStreamState", "traits": { "smithy.api#documentation": "The current state of this stream. Valid values are running and stopped.
The output format of this metric stream. Valid values are \n\t\t\tjson\n\t\t\tand opentelemetry0.7.
This structure contains the configuration information about one metric stream.
" } }, "com.amazonaws.cloudwatch#MetricStreamFilter": { "type": "structure", "members": { "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The name of the metric namespace in the filter.
" } } }, "traits": { "smithy.api#documentation": "This structure contains the name of one of the metric namespaces that is listed in\n\t\ta filter of a metric stream.
" } }, "com.amazonaws.cloudwatch#MetricStreamFilters": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#MetricStreamFilter" } }, "com.amazonaws.cloudwatch#MetricStreamName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#MetricStreamNames": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#MetricStreamName" } }, "com.amazonaws.cloudwatch#MetricStreamOutputFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "json", "name": "JSON" }, { "value": "opentelemetry0.7", "name": "OPEN_TELEMETRY_0_7" } ], "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#MetricStreamState": { "type": "string" }, "com.amazonaws.cloudwatch#MetricWidget": { "type": "string" }, "com.amazonaws.cloudwatch#MetricWidgetImage": { "type": "blob" }, "com.amazonaws.cloudwatch#Metrics": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Metric" } }, "com.amazonaws.cloudwatch#MissingRequiredParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#AwsQueryErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "An input parameter that is required is missing.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cloudwatch#Namespace": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[^:].*" } }, "com.amazonaws.cloudwatch#NextToken": { "type": "string" }, "com.amazonaws.cloudwatch#OutputFormat": { "type": "string" }, "com.amazonaws.cloudwatch#PartialFailure": { "type": "structure", "members": { "FailureResource": { "target": "com.amazonaws.cloudwatch#FailureResource", "traits": { "smithy.api#documentation": "The specified rule that could not be deleted.
" } }, "ExceptionType": { "target": "com.amazonaws.cloudwatch#ExceptionType", "traits": { "smithy.api#documentation": "The type of error.
" } }, "FailureCode": { "target": "com.amazonaws.cloudwatch#FailureCode", "traits": { "smithy.api#documentation": "The code of the error.
" } }, "FailureDescription": { "target": "com.amazonaws.cloudwatch#FailureDescription", "traits": { "smithy.api#documentation": "A description of the error.
" } } }, "traits": { "smithy.api#documentation": "This array is empty if the API operation was successful for all the rules specified in the request. If the operation could\n\t\tnot process one of the rules, the following data is returned for each of those rules.
" } }, "com.amazonaws.cloudwatch#Period": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudwatch#PutAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutAnomalyDetectorInput" }, "output": { "target": "com.amazonaws.cloudwatch#PutAnomalyDetectorOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#LimitExceededException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Creates an anomaly detection model for a CloudWatch metric. You can use the model\n\t\t\tto display a band of expected normal values when the metric is graphed.
\n\t\tFor more information, see CloudWatch Anomaly Detection.
" } }, "com.amazonaws.cloudwatch#PutAnomalyDetectorInput": { "type": "structure", "members": { "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { "smithy.api#documentation": "The namespace of the metric to create the anomaly detection model for.
", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { "smithy.api#documentation": "The name of the metric to create the anomaly detection model for.
", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { "smithy.api#documentation": "The metric dimensions to create the anomaly detection model for.
" } }, "Stat": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { "smithy.api#documentation": "The statistic to use for the metric and the anomaly detection model.
", "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", "traits": { "smithy.api#documentation": "The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.
\n\t\tThe configuration can also include the time zone to use for \n\t\t\tthe metric.
" } } } }, "com.amazonaws.cloudwatch#PutAnomalyDetectorOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#PutCompositeAlarm": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutCompositeAlarmInput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#LimitExceededFault" } ], "traits": { "smithy.api#documentation": "Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.
\n\t\tThe alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms.
\n\t\tUsing composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.
\n\t\tCurrently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.
\n\t\tIt is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.
\n\t\t\tTo get out of such a situation, you must\n\t\t\tbreak 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\n\t\t\tchange 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.\n\t\t
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.
\n\t\t\n\t\tIf you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is \n\t\t\tTRUE.
The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n
The description for the composite alarm.
" } }, "AlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { "smithy.api#documentation": "The name for the composite alarm. This name must be unique within the Region.
", "smithy.api#required": {} } }, "AlarmRule": { "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { "smithy.api#documentation": "An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.
\n\t\tYou can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
\n\t\tFunctions can include the following:
\n\t\t\n ALARM(\"alarm-name or alarm-ARN\") is TRUE if the named\n\t\t\talarm is in ALARM state.
\n OK(\"alarm-name or alarm-ARN\") is TRUE if the named\n\t\t\t\talarm is in OK state.
\n INSUFFICIENT_DATA(\"alarm-name or alarm-ARN\") is TRUE if the named\n\t\t\t\talarm is in INSUFFICIENT_DATA state.
\n TRUE always evaluates to TRUE.
\n FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.
The following\n\t\t\tare some examples of AlarmRule:
\n ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the composite alarm goes into ALARM state only\n\t\t\t\tif both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
\n ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)\n\t\t\t\t\tspecifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state\n\t\t\t\t\tand DeploymentInProgress is not in ALARM state. This example reduces\n\t\t\t\t\talarm noise during a known deployment window.
\n (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) goes into ALARM \n\t\t\t\tstate if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. \n\t\t\t\tThis provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an \n\t\t\t\talarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n
The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n
A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
\n\t\tTags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.
" } } } }, "com.amazonaws.cloudwatch#PutDashboard": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutDashboardInput" }, "output": { "target": "com.amazonaws.cloudwatch#PutDashboardOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#DashboardInvalidInputError" }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" } ], "traits": { "smithy.api#documentation": "Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,\n\t\tthe entire contents are replaced with what you specify here.
\n\t\tAll dashboards in your account are global, not region-specific.
\n\t\tA simple way to create a dashboard using PutDashboard is to copy an \n\t\t\texisting dashboard. To copy an existing dashboard using the console, you can load the dashboard\n\t\t\tand then use the View/edit source command in the Actions menu to display the JSON block\n\t\t\tfor that dashboard. Another way to copy a dashboard is to \n\t\t\tuse GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to \n\t\t\tadd a text widget at the top of the dashboard with a message that the dashboard was created by script and should\n\t\tnot be changed in the console. This message could also point console users to the location \n\t\tof the DashboardBody script or the CloudFormation template used to create the\n\t\tdashboard.
The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing\n\t\t\tits current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are \n\t\t\tA-Z, a-z, 0-9, \"-\", and \"_\". This parameter is required.
", "smithy.api#required": {} } }, "DashboardBody": { "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { "smithy.api#documentation": "The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.
\n\t\tFor more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#PutDashboardOutput": { "type": "structure", "members": { "DashboardValidationMessages": { "target": "com.amazonaws.cloudwatch#DashboardValidationMessages", "traits": { "smithy.api#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\n\t\t\tcreated or modified, but some elements of the dashboard\n\t\t\tmight not render.
\n\t\t\t\tIf this result includes error messages, the input was not valid and the operation failed.
" } } } }, "com.amazonaws.cloudwatch#PutInsightRule": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutInsightRuleInput" }, "output": { "target": "com.amazonaws.cloudwatch#PutInsightRuleOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#LimitExceededException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Creates a Contributor Insights rule. Rules evaluate log events in a\n\t\tCloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, \n\t\tsee Using Contributor Insights to Analyze High-Cardinality Data.
\n\t\tIf you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might not be available.
" } }, "com.amazonaws.cloudwatch#PutInsightRuleInput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.cloudwatch#InsightRuleName", "traits": { "smithy.api#documentation": "A unique name for the rule.
", "smithy.api#required": {} } }, "RuleState": { "target": "com.amazonaws.cloudwatch#InsightRuleState", "traits": { "smithy.api#documentation": "The state of the rule. Valid values are ENABLED and DISABLED.
" } }, "RuleDefinition": { "target": "com.amazonaws.cloudwatch#InsightRuleDefinition", "traits": { "smithy.api#documentation": "The definition of the rule, as a JSON object. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\tRule Syntax.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { "smithy.api#documentation": "A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.
\n\t\tTags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.
\n\t\tTo be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.
" } } } }, "com.amazonaws.cloudwatch#PutInsightRuleOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#PutMetricAlarm": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutMetricAlarmInput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#LimitExceededFault" } ], "traits": { "smithy.api#documentation": "Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tor anomaly detection model.
\n\t\tAlarms based on anomaly detection models cannot have Auto Scaling actions.
\n\t\tWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.
\n\n\t\tIf you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:
\n\t\tThe iam:CreateServiceLinkedRole for all alarms with EC2 actions
The iam:CreateServiceLinkedRole to create an alarm\n\t\t\t\t\twith Systems Manager OpsItem actions.
The first time you create an alarm in the \n\t\t\tAWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see AWS service-linked role.
The name for the alarm. This name must be unique within the Region.
", "smithy.api#required": {} } }, "AlarmDescription": { "target": "com.amazonaws.cloudwatch#AlarmDescription", "traits": { "smithy.api#documentation": "The description for the alarm.
" } }, "ActionsEnabled": { "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm state. The default is \n\t\t\tTRUE.
The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\t arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n
Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, 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 \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall 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.\n\t\t For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\tspecify either Statistic or ExtendedStatistic, but not both.
The percentile statistic for the metric specified in MetricName. Specify a value \n\t\t\tbetween p0.0 and p100. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\t\tspecify either Statistic or ExtendedStatistic, but not both.
The dimensions for the metric specified in MetricName.
The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.
\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod 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\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can\n\t\tbe 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\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.
\n\t\tIf you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves predictably.
\n\t\tWe recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses 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\n\t\t\tsetting an alarm that requires that a number of consecutive data points be breaching to\n\t\t\ttrigger the alarm, this value specifies that number. If you are setting an \"M out of N\"\n\t\t\talarm, this value is the N.
\n\t\tAn alarm's total current evaluation period can\n\t\t\tbe 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 \n\t\t\tan \"M out of N\" alarm. In that case, this value is the M. For more information, see \n\t\t\tEvaluating an Alarm in the\n\t\t\tAmazon CloudWatch User Guide.
" } }, "Threshold": { "target": "com.amazonaws.cloudwatch#Threshold", "traits": { "smithy.api#documentation": "The value against which the specified statistic is compared.
\n\t\tThis parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.
" } }, "ComparisonOperator": { "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { "smithy.api#documentation": "The arithmetic operation to use when comparing the specified statistic and\n\t\t\tthreshold. The specified statistic value is used as the first operand.
\n\t\tThe values LessThanLowerOrGreaterThanUpperThreshold, \n\t\t\tLessThanLowerThreshold, and GreaterThanUpperThreshold\n\t\tare 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. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing\n
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 \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore\n
An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, 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 \n\t\t\tby setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.
If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe 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.
\n\t\tTags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\n\t\tIf you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.
" } }, "ThresholdMetricId": { "target": "com.amazonaws.cloudwatch#MetricId", "traits": { "smithy.api#documentation": "If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.
\n\t\tIf your alarm uses this parameter, it cannot have Auto Scaling actions.
" } } } }, "com.amazonaws.cloudwatch#PutMetricData": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutMetricDataInput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.
\n\n\t\tYou can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 20 different metrics.
Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.
\n\n\t\tYou specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.
\n\t\tData points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.
\n\t\tCloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:
\n\t\t\tThe SampleCount value of the statistic set is 1 and Min,\n\t\t\t\t\tMax, and Sum are all equal.
The Min and\n\t\t\t\t\tMax are equal, and Sum is equal to Min \n\t\t\t\t\tmultiplied by SampleCount.
The namespace for the metric data.
\n\t\tTo avoid conflicts\n\t\t\twith AWS service namespaces, you should not specify a namespace that begins with AWS/\n
The data for the metric. The array can include no more than 20 metrics per call.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#PutMetricStream": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#PutMetricStreamInput" }, "output": { "target": "com.amazonaws.cloudwatch#PutMetricStreamOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#ConcurrentModificationException" }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterCombinationException" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto AWS destinations including\n\t\t\tAmazon S3 and to many third-party solutions.
\n\t\tFor more information, see \n\t\tUsing Metric Streams.
\n\t\tTo create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.
When you create or update a metric stream, you choose one of the following:
\n\t\tStream metrics from all metric namespaces in the account.
\nStream metrics from all metric namespaces in the account, except\n\t\t\t\tfor the namespaces that you list in ExcludeFilters.
Stream metrics from only the metric namespaces that you list in \n\t\t\t\tIncludeFilters.
When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.
If you are creating a new metric stream, this is the name for the new stream. The name\n\t\tmust be different than the names of other metric streams in this account and Region.
\n\t\tIf you are updating a metric stream, specify the name of that stream here.
\n\t\tValid characters are A-Z, a-z, 0-9, \"-\" and \"_\".
", "smithy.api#required": {} } }, "IncludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { "smithy.api#documentation": "If you specify this parameter, the stream sends only the \n\t\tmetrics from the metric namespaces that you specify here.
\n\t\tYou cannot include IncludeFilters and ExcludeFilters\n\t\tin the same operation.
If you specify this parameter, the stream sends metrics from all\n\t\t\tmetric namespaces except for the namespaces that you specify here.
\n\t\tYou cannot include ExcludeFilters and IncludeFilters in \n\t\t\tthe same operation.
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.\n\t\tThis Amazon Kinesis Firehose delivery stream must already exist and must be in the same\n\t\taccount as the metric stream.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of an IAM role that this metric stream will use to access\n\t\t\tAmazon Kinesis Firehose resources. This IAM role must already \n\t\texist and must be in the same account as the metric stream. This IAM role must include the following permissions:
\n\t\tfirehose:PutRecord
\nfirehose:PutRecordBatch
\nThe output format for the stream. Valid values are json\n\t\tand opentelemetry0.7. For more information about metric stream\n\t\toutput formats, see \n\t\t\t\n\t\t\t\tMetric streams output formats.
A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.
\n\t\tTags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
" } } } }, "com.amazonaws.cloudwatch#PutMetricStreamOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the metric stream.
" } } } }, "com.amazonaws.cloudwatch#Range": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#documentation": "The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.
The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.
Specifies one range of days or times to exclude from use for training an\n\t\tanomaly detection model.
" } }, "com.amazonaws.cloudwatch#RecentlyActive": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PT3H", "name": "PT3H" } ] } }, "com.amazonaws.cloudwatch#ResourceId": { "type": "string" }, "com.amazonaws.cloudwatch#ResourceList": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#ResourceName" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.cloudwatch#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.cloudwatch#ResourceNotFound": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cloudwatch#ErrorMessage", "traits": { "smithy.api#documentation": "" } } }, "traits": { "smithy.api#documentation": "The named resource does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudwatch#ResourceNotFoundException": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.cloudwatch#ResourceType" }, "ResourceId": { "target": "com.amazonaws.cloudwatch#ResourceId" }, "Message": { "target": "com.amazonaws.cloudwatch#FaultDescription" } }, "traits": { "smithy.api#documentation": "The named resource does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cloudwatch#ResourceType": { "type": "string" }, "com.amazonaws.cloudwatch#ReturnData": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudwatch#ScanBy": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TimestampDescending", "name": "TIMESTAMP_DESCENDING" }, { "value": "TimestampAscending", "name": "TIMESTAMP_ASCENDING" } ] } }, "com.amazonaws.cloudwatch#SetAlarmState": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#SetAlarmStateInput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidFormatFault" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFound" } ], "traits": { "smithy.api#documentation": "Temporarily sets the state of an alarm for testing purposes. When the updated\n\t\t\tstate differs from the previous value, the action configured for\n\t\t\tthe appropriate state is invoked. For example, if your alarm is configured to send an\n\t\t\tAmazon SNS message when an alarm is triggered, temporarily changing the alarm state to\n\t\t\tALARM sends an SNS message.
Metric alarms\n\t\t\treturns to their actual state quickly, often within seconds. Because the metric alarm state change\n\t\t\thappens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through\n\t\t\tDescribeAlarmHistory.
\n\t\tIf you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return\n\t\t\tto its actual state. It\n\t\t\treturns to its actual state only once any of its children alarms change state. It is also\n\t\t\treevaluated if you update its\n\t\t\tconfiguration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include\n\t\tinformation in the StateReasonData parameter to enable the policy to take the correct action.
The name of the alarm.
", "smithy.api#required": {} } }, "StateValue": { "target": "com.amazonaws.cloudwatch#StateValue", "traits": { "smithy.api#documentation": "The value of the state.
", "smithy.api#required": {} } }, "StateReason": { "target": "com.amazonaws.cloudwatch#StateReason", "traits": { "smithy.api#documentation": "The reason that this alarm is set to this specific state, in text format.
", "smithy.api#required": {} } }, "StateReasonData": { "target": "com.amazonaws.cloudwatch#StateReasonData", "traits": { "smithy.api#documentation": "The reason that this alarm is set to this specific state, in JSON format.
\n\t\tFor SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
" } } } }, "com.amazonaws.cloudwatch#Size": { "type": "long" }, "com.amazonaws.cloudwatch#StandardUnit": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Seconds", "name": "Seconds" }, { "value": "Microseconds", "name": "Microseconds" }, { "value": "Milliseconds", "name": "Milliseconds" }, { "value": "Bytes", "name": "Bytes" }, { "value": "Kilobytes", "name": "Kilobytes" }, { "value": "Megabytes", "name": "Megabytes" }, { "value": "Gigabytes", "name": "Gigabytes" }, { "value": "Terabytes", "name": "Terabytes" }, { "value": "Bits", "name": "Bits" }, { "value": "Kilobits", "name": "Kilobits" }, { "value": "Megabits", "name": "Megabits" }, { "value": "Gigabits", "name": "Gigabits" }, { "value": "Terabits", "name": "Terabits" }, { "value": "Percent", "name": "Percent" }, { "value": "Count", "name": "Count" }, { "value": "Bytes/Second", "name": "Bytes_Second" }, { "value": "Kilobytes/Second", "name": "Kilobytes_Second" }, { "value": "Megabytes/Second", "name": "Megabytes_Second" }, { "value": "Gigabytes/Second", "name": "Gigabytes_Second" }, { "value": "Terabytes/Second", "name": "Terabytes_Second" }, { "value": "Bits/Second", "name": "Bits_Second" }, { "value": "Kilobits/Second", "name": "Kilobits_Second" }, { "value": "Megabits/Second", "name": "Megabits_Second" }, { "value": "Gigabits/Second", "name": "Gigabits_Second" }, { "value": "Terabits/Second", "name": "Terabits_Second" }, { "value": "Count/Second", "name": "Count_Second" }, { "value": "None", "name": "None" } ] } }, "com.amazonaws.cloudwatch#StartMetricStreams": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#StartMetricStreamsInput" }, "output": { "target": "com.amazonaws.cloudwatch#StartMetricStreamsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Starts the streaming of metrics for one or more of your metric streams.
" } }, "com.amazonaws.cloudwatch#StartMetricStreamsInput": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { "smithy.api#documentation": "The array of the names of metric streams to start streaming.
\n\t\tThis is an \"all or nothing\" operation. If you do not have \n\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\tin the operation will start streaming.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#StartMetricStreamsOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#Stat": { "type": "string" }, "com.amazonaws.cloudwatch#StateReason": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1023 } } }, "com.amazonaws.cloudwatch#StateReasonData": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4000 } } }, "com.amazonaws.cloudwatch#StateValue": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OK", "name": "OK" }, { "value": "ALARM", "name": "ALARM" }, { "value": "INSUFFICIENT_DATA", "name": "INSUFFICIENT_DATA" } ] } }, "com.amazonaws.cloudwatch#Statistic": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SampleCount", "name": "SampleCount" }, { "value": "Average", "name": "Average" }, { "value": "Sum", "name": "Sum" }, { "value": "Minimum", "name": "Minimum" }, { "value": "Maximum", "name": "Maximum" } ] } }, "com.amazonaws.cloudwatch#StatisticSet": { "type": "structure", "members": { "SampleCount": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The number of samples used for the statistic set.
", "smithy.api#required": {} } }, "Sum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The sum of values for the sample set.
", "smithy.api#required": {} } }, "Minimum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The minimum value of the sample set.
", "smithy.api#required": {} } }, "Maximum": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { "smithy.api#documentation": "The maximum value of the sample set.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents a set of statistics that describes a specific metric.
" } }, "com.amazonaws.cloudwatch#Statistics": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Statistic" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.cloudwatch#StatusCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Complete", "name": "COMPLETE" }, { "value": "InternalError", "name": "INTERNAL_ERROR" }, { "value": "PartialData", "name": "PARTIAL_DATA" } ] } }, "com.amazonaws.cloudwatch#StopMetricStreams": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#StopMetricStreamsInput" }, "output": { "target": "com.amazonaws.cloudwatch#StopMetricStreamsOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#MissingRequiredParameterException" } ], "traits": { "smithy.api#documentation": "Stops the streaming of metrics for one or more of your metric streams.
" } }, "com.amazonaws.cloudwatch#StopMetricStreamsInput": { "type": "structure", "members": { "Names": { "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { "smithy.api#documentation": "The array of the names of metric streams to stop streaming.
\n\t\tThis is an \"all or nothing\" operation. If you do not have \n\t\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\t\tin the operation will stop streaming.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#StopMetricStreamsOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#StorageResolution": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.cloudwatch#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.cloudwatch#TagKey", "traits": { "smithy.api#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 \n\t\tresources.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudwatch#TagValue", "traits": { "smithy.api#documentation": "The value for the specified tag key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A key-value pair associated with a CloudWatch resource.
" } }, "com.amazonaws.cloudwatch#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cloudwatch#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#TagKey" } }, "com.amazonaws.cloudwatch#TagList": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Tag" } }, "com.amazonaws.cloudwatch#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#TagResourceInput" }, "output": { "target": "com.amazonaws.cloudwatch#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#ConcurrentModificationException" }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that \n\t\t\tcan be tagged are alarms and Contributor Insights rules.
\n\t\tTags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\n\t\tTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
\n\t\tYou can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n\t\t\tthis tag is appended to the list of tags associated\n\t\t\twith the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n\t\t\tthe previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
" } }, "com.amazonaws.cloudwatch#TagResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the CloudWatch resource that you're adding tags to.
\n\t\tThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { "smithy.api#documentation": "The list of key-value pairs to associate with the alarm.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#TagResourceOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.cloudwatch#Threshold": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.cloudwatch#Timestamp": { "type": "timestamp" }, "com.amazonaws.cloudwatch#Timestamps": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#Timestamp" } }, "com.amazonaws.cloudwatch#TreatMissingData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.cloudwatch#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.cloudwatch#UntagResourceInput" }, "output": { "target": "com.amazonaws.cloudwatch#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.cloudwatch#ConcurrentModificationException" }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, { "target": "com.amazonaws.cloudwatch#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Removes one or more tags from the specified resource.
" } }, "com.amazonaws.cloudwatch#UntagResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the CloudWatch resource that you're removing tags from.
\n\t\tThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.cloudwatch#TagKeyList", "traits": { "smithy.api#documentation": "The list of tag keys to remove from the resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.cloudwatch#UntagResourceOutput": { "type": "structure", "members": {} }, "com.amazonaws.cloudwatch#Values": { "type": "list", "member": { "target": "com.amazonaws.cloudwatch#DatapointValue" } } } }