| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudWatch.Types
Contents
- Service Configuration
- Errors
- AlarmType
- AnomalyDetectorStateValue
- ComparisonOperator
- HistoryItemType
- MetricStreamOutputFormat
- RecentlyActive
- ScanBy
- StandardUnit
- StateValue
- Statistic
- StatusCode
- AlarmHistoryItem
- AnomalyDetector
- AnomalyDetectorConfiguration
- CompositeAlarm
- DashboardEntry
- DashboardValidationMessage
- Datapoint
- Dimension
- DimensionFilter
- InsightRule
- InsightRuleContributor
- InsightRuleContributorDatapoint
- InsightRuleMetricDatapoint
- LabelOptions
- MessageData
- Metric
- MetricAlarm
- MetricDataQuery
- MetricDataResult
- MetricDatum
- MetricStat
- MetricStreamEntry
- MetricStreamFilter
- PartialFailure
- Range
- StatisticSet
- Tag
Description
Synopsis
- defaultService :: Service
- _LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DashboardNotFoundError :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DashboardInvalidInputError :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFormatFault :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AlarmType where
- AlarmType' { }
- pattern AlarmType_CompositeAlarm :: AlarmType
- pattern AlarmType_MetricAlarm :: AlarmType
- newtype AnomalyDetectorStateValue where
- newtype ComparisonOperator where
- ComparisonOperator' { }
- pattern ComparisonOperator_GreaterThanOrEqualToThreshold :: ComparisonOperator
- pattern ComparisonOperator_GreaterThanThreshold :: ComparisonOperator
- pattern ComparisonOperator_GreaterThanUpperThreshold :: ComparisonOperator
- pattern ComparisonOperator_LessThanLowerOrGreaterThanUpperThreshold :: ComparisonOperator
- pattern ComparisonOperator_LessThanLowerThreshold :: ComparisonOperator
- pattern ComparisonOperator_LessThanOrEqualToThreshold :: ComparisonOperator
- pattern ComparisonOperator_LessThanThreshold :: ComparisonOperator
- newtype HistoryItemType where
- HistoryItemType' { }
- pattern HistoryItemType_Action :: HistoryItemType
- pattern HistoryItemType_ConfigurationUpdate :: HistoryItemType
- pattern HistoryItemType_StateUpdate :: HistoryItemType
- newtype MetricStreamOutputFormat where
- newtype RecentlyActive where
- RecentlyActive' { }
- pattern RecentlyActive_PT3H :: RecentlyActive
- newtype ScanBy where
- ScanBy' {
- fromScanBy :: Text
- pattern ScanBy_TimestampAscending :: ScanBy
- pattern ScanBy_TimestampDescending :: ScanBy
- ScanBy' {
- newtype StandardUnit where
- StandardUnit' { }
- pattern StandardUnit_Bits :: StandardUnit
- pattern StandardUnit_Bits_Second :: StandardUnit
- pattern StandardUnit_Bytes :: StandardUnit
- pattern StandardUnit_Bytes_Second :: StandardUnit
- pattern StandardUnit_Count :: StandardUnit
- pattern StandardUnit_Count_Second :: StandardUnit
- pattern StandardUnit_Gigabits :: StandardUnit
- pattern StandardUnit_Gigabits_Second :: StandardUnit
- pattern StandardUnit_Gigabytes :: StandardUnit
- pattern StandardUnit_Gigabytes_Second :: StandardUnit
- pattern StandardUnit_Kilobits :: StandardUnit
- pattern StandardUnit_Kilobits_Second :: StandardUnit
- pattern StandardUnit_Kilobytes :: StandardUnit
- pattern StandardUnit_Kilobytes_Second :: StandardUnit
- pattern StandardUnit_Megabits :: StandardUnit
- pattern StandardUnit_Megabits_Second :: StandardUnit
- pattern StandardUnit_Megabytes :: StandardUnit
- pattern StandardUnit_Megabytes_Second :: StandardUnit
- pattern StandardUnit_Microseconds :: StandardUnit
- pattern StandardUnit_Milliseconds :: StandardUnit
- pattern StandardUnit_None :: StandardUnit
- pattern StandardUnit_Percent :: StandardUnit
- pattern StandardUnit_Seconds :: StandardUnit
- pattern StandardUnit_Terabits :: StandardUnit
- pattern StandardUnit_Terabits_Second :: StandardUnit
- pattern StandardUnit_Terabytes :: StandardUnit
- pattern StandardUnit_Terabytes_Second :: StandardUnit
- newtype StateValue where
- StateValue' { }
- pattern StateValue_ALARM :: StateValue
- pattern StateValue_INSUFFICIENT_DATA :: StateValue
- pattern StateValue_OK :: StateValue
- newtype Statistic where
- Statistic' { }
- pattern Statistic_Average :: Statistic
- pattern Statistic_Maximum :: Statistic
- pattern Statistic_Minimum :: Statistic
- pattern Statistic_SampleCount :: Statistic
- pattern Statistic_Sum :: Statistic
- newtype StatusCode where
- StatusCode' { }
- pattern StatusCode_Complete :: StatusCode
- pattern StatusCode_InternalError :: StatusCode
- pattern StatusCode_PartialData :: StatusCode
- data AlarmHistoryItem = AlarmHistoryItem' {}
- newAlarmHistoryItem :: AlarmHistoryItem
- alarmHistoryItem_alarmName :: Lens' AlarmHistoryItem (Maybe Text)
- alarmHistoryItem_historyItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType)
- alarmHistoryItem_historyData :: Lens' AlarmHistoryItem (Maybe Text)
- alarmHistoryItem_alarmType :: Lens' AlarmHistoryItem (Maybe AlarmType)
- alarmHistoryItem_historySummary :: Lens' AlarmHistoryItem (Maybe Text)
- alarmHistoryItem_timestamp :: Lens' AlarmHistoryItem (Maybe UTCTime)
- data AnomalyDetector = AnomalyDetector' {}
- newAnomalyDetector :: AnomalyDetector
- anomalyDetector_metricName :: Lens' AnomalyDetector (Maybe Text)
- anomalyDetector_namespace :: Lens' AnomalyDetector (Maybe Text)
- anomalyDetector_stateValue :: Lens' AnomalyDetector (Maybe AnomalyDetectorStateValue)
- anomalyDetector_stat :: Lens' AnomalyDetector (Maybe Text)
- anomalyDetector_configuration :: Lens' AnomalyDetector (Maybe AnomalyDetectorConfiguration)
- anomalyDetector_dimensions :: Lens' AnomalyDetector (Maybe [Dimension])
- data AnomalyDetectorConfiguration = AnomalyDetectorConfiguration' {}
- newAnomalyDetectorConfiguration :: AnomalyDetectorConfiguration
- anomalyDetectorConfiguration_metricTimezone :: Lens' AnomalyDetectorConfiguration (Maybe Text)
- anomalyDetectorConfiguration_excludedTimeRanges :: Lens' AnomalyDetectorConfiguration (Maybe [Range])
- data CompositeAlarm = CompositeAlarm' {
- alarmName :: Maybe Text
- stateUpdatedTimestamp :: Maybe ISO8601
- alarmDescription :: Maybe Text
- alarmRule :: Maybe Text
- oKActions :: Maybe [Text]
- stateValue :: Maybe StateValue
- alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
- actionsEnabled :: Maybe Bool
- insufficientDataActions :: Maybe [Text]
- stateReason :: Maybe Text
- stateReasonData :: Maybe Text
- alarmArn :: Maybe Text
- alarmActions :: Maybe [Text]
- newCompositeAlarm :: CompositeAlarm
- compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
- compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text])
- compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue)
- compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
- compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool)
- compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text])
- compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text])
- data DashboardEntry = DashboardEntry' {}
- newDashboardEntry :: DashboardEntry
- dashboardEntry_size :: Lens' DashboardEntry (Maybe Integer)
- dashboardEntry_dashboardName :: Lens' DashboardEntry (Maybe Text)
- dashboardEntry_lastModified :: Lens' DashboardEntry (Maybe UTCTime)
- dashboardEntry_dashboardArn :: Lens' DashboardEntry (Maybe Text)
- data DashboardValidationMessage = DashboardValidationMessage' {}
- newDashboardValidationMessage :: DashboardValidationMessage
- dashboardValidationMessage_dataPath :: Lens' DashboardValidationMessage (Maybe Text)
- dashboardValidationMessage_message :: Lens' DashboardValidationMessage (Maybe Text)
- data Datapoint = Datapoint' {}
- newDatapoint :: Datapoint
- datapoint_sampleCount :: Lens' Datapoint (Maybe Double)
- datapoint_maximum :: Lens' Datapoint (Maybe Double)
- datapoint_average :: Lens' Datapoint (Maybe Double)
- datapoint_minimum :: Lens' Datapoint (Maybe Double)
- datapoint_extendedStatistics :: Lens' Datapoint (Maybe (HashMap Text Double))
- datapoint_sum :: Lens' Datapoint (Maybe Double)
- datapoint_unit :: Lens' Datapoint (Maybe StandardUnit)
- datapoint_timestamp :: Lens' Datapoint (Maybe UTCTime)
- data Dimension = Dimension' {}
- newDimension :: Text -> Text -> Dimension
- dimension_name :: Lens' Dimension Text
- dimension_value :: Lens' Dimension Text
- data DimensionFilter = DimensionFilter' {}
- newDimensionFilter :: Text -> DimensionFilter
- dimensionFilter_value :: Lens' DimensionFilter (Maybe Text)
- dimensionFilter_name :: Lens' DimensionFilter Text
- data InsightRule = InsightRule' {}
- newInsightRule :: Text -> Text -> Text -> Text -> InsightRule
- insightRule_name :: Lens' InsightRule Text
- insightRule_state :: Lens' InsightRule Text
- insightRule_schema :: Lens' InsightRule Text
- insightRule_definition :: Lens' InsightRule Text
- data InsightRuleContributor = InsightRuleContributor' {}
- newInsightRuleContributor :: Double -> InsightRuleContributor
- insightRuleContributor_keys :: Lens' InsightRuleContributor [Text]
- insightRuleContributor_approximateAggregateValue :: Lens' InsightRuleContributor Double
- insightRuleContributor_datapoints :: Lens' InsightRuleContributor [InsightRuleContributorDatapoint]
- data InsightRuleContributorDatapoint = InsightRuleContributorDatapoint' {}
- newInsightRuleContributorDatapoint :: UTCTime -> Double -> InsightRuleContributorDatapoint
- insightRuleContributorDatapoint_timestamp :: Lens' InsightRuleContributorDatapoint UTCTime
- insightRuleContributorDatapoint_approximateValue :: Lens' InsightRuleContributorDatapoint Double
- data InsightRuleMetricDatapoint = InsightRuleMetricDatapoint' {}
- newInsightRuleMetricDatapoint :: UTCTime -> InsightRuleMetricDatapoint
- insightRuleMetricDatapoint_maxContributorValue :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_sampleCount :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_maximum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_average :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_minimum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_uniqueContributors :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_sum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
- insightRuleMetricDatapoint_timestamp :: Lens' InsightRuleMetricDatapoint UTCTime
- data LabelOptions = LabelOptions' {}
- newLabelOptions :: LabelOptions
- labelOptions_timezone :: Lens' LabelOptions (Maybe Text)
- data MessageData = MessageData' {}
- newMessageData :: MessageData
- messageData_value :: Lens' MessageData (Maybe Text)
- messageData_code :: Lens' MessageData (Maybe Text)
- data Metric = Metric' {
- metricName :: Maybe Text
- namespace :: Maybe Text
- dimensions :: Maybe [Dimension]
- newMetric :: Metric
- metric_metricName :: Lens' Metric (Maybe Text)
- metric_namespace :: Lens' Metric (Maybe Text)
- metric_dimensions :: Lens' Metric (Maybe [Dimension])
- data MetricAlarm = MetricAlarm' {
- alarmName :: Maybe Text
- stateUpdatedTimestamp :: Maybe ISO8601
- metrics :: Maybe [MetricDataQuery]
- treatMissingData :: Maybe Text
- period :: Maybe Natural
- alarmDescription :: Maybe Text
- evaluationPeriods :: Maybe Natural
- metricName :: Maybe Text
- namespace :: Maybe Text
- thresholdMetricId :: Maybe Text
- comparisonOperator :: Maybe ComparisonOperator
- oKActions :: Maybe [Text]
- evaluateLowSampleCountPercentile :: Maybe Text
- stateValue :: Maybe StateValue
- datapointsToAlarm :: Maybe Natural
- threshold :: Maybe Double
- alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
- actionsEnabled :: Maybe Bool
- insufficientDataActions :: Maybe [Text]
- stateReason :: Maybe Text
- stateReasonData :: Maybe Text
- dimensions :: Maybe [Dimension]
- alarmArn :: Maybe Text
- alarmActions :: Maybe [Text]
- unit :: Maybe StandardUnit
- statistic :: Maybe Statistic
- extendedStatistic :: Maybe Text
- newMetricAlarm :: MetricAlarm
- metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery])
- metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_period :: Lens' MetricAlarm (Maybe Natural)
- metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
- metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
- metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text])
- metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue)
- metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
- metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double)
- metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool)
- metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text])
- metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension])
- metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text)
- metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text])
- metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit)
- metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic)
- metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text)
- data MetricDataQuery = MetricDataQuery' {
- returnData :: Maybe Bool
- period :: Maybe Natural
- accountId :: Maybe Text
- expression :: Maybe Text
- label :: Maybe Text
- metricStat :: Maybe MetricStat
- id :: Text
- newMetricDataQuery :: Text -> MetricDataQuery
- metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool)
- metricDataQuery_period :: Lens' MetricDataQuery (Maybe Natural)
- metricDataQuery_accountId :: Lens' MetricDataQuery (Maybe Text)
- metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text)
- metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text)
- metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat)
- metricDataQuery_id :: Lens' MetricDataQuery Text
- data MetricDataResult = MetricDataResult' {
- values :: Maybe [Double]
- id :: Maybe Text
- timestamps :: Maybe [ISO8601]
- messages :: Maybe [MessageData]
- label :: Maybe Text
- statusCode :: Maybe StatusCode
- newMetricDataResult :: MetricDataResult
- metricDataResult_values :: Lens' MetricDataResult (Maybe [Double])
- metricDataResult_id :: Lens' MetricDataResult (Maybe Text)
- metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime])
- metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData])
- metricDataResult_label :: Lens' MetricDataResult (Maybe Text)
- metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode)
- data MetricDatum = MetricDatum' {
- values :: Maybe [Double]
- counts :: Maybe [Double]
- value :: Maybe Double
- storageResolution :: Maybe Natural
- dimensions :: Maybe [Dimension]
- unit :: Maybe StandardUnit
- timestamp :: Maybe ISO8601
- statisticValues :: Maybe StatisticSet
- metricName :: Text
- newMetricDatum :: Text -> MetricDatum
- metricDatum_values :: Lens' MetricDatum (Maybe [Double])
- metricDatum_counts :: Lens' MetricDatum (Maybe [Double])
- metricDatum_value :: Lens' MetricDatum (Maybe Double)
- metricDatum_storageResolution :: Lens' MetricDatum (Maybe Natural)
- metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])
- metricDatum_unit :: Lens' MetricDatum (Maybe StandardUnit)
- metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime)
- metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)
- metricDatum_metricName :: Lens' MetricDatum Text
- data MetricStat = MetricStat' {}
- newMetricStat :: Metric -> Natural -> Text -> MetricStat
- metricStat_unit :: Lens' MetricStat (Maybe StandardUnit)
- metricStat_metric :: Lens' MetricStat Metric
- metricStat_period :: Lens' MetricStat Natural
- metricStat_stat :: Lens' MetricStat Text
- data MetricStreamEntry = MetricStreamEntry' {}
- newMetricStreamEntry :: MetricStreamEntry
- metricStreamEntry_state :: Lens' MetricStreamEntry (Maybe Text)
- metricStreamEntry_arn :: Lens' MetricStreamEntry (Maybe Text)
- metricStreamEntry_firehoseArn :: Lens' MetricStreamEntry (Maybe Text)
- metricStreamEntry_outputFormat :: Lens' MetricStreamEntry (Maybe MetricStreamOutputFormat)
- metricStreamEntry_lastUpdateDate :: Lens' MetricStreamEntry (Maybe UTCTime)
- metricStreamEntry_name :: Lens' MetricStreamEntry (Maybe Text)
- metricStreamEntry_creationDate :: Lens' MetricStreamEntry (Maybe UTCTime)
- data MetricStreamFilter = MetricStreamFilter' {}
- newMetricStreamFilter :: MetricStreamFilter
- metricStreamFilter_namespace :: Lens' MetricStreamFilter (Maybe Text)
- data PartialFailure = PartialFailure' {}
- newPartialFailure :: PartialFailure
- partialFailure_failureResource :: Lens' PartialFailure (Maybe Text)
- partialFailure_failureCode :: Lens' PartialFailure (Maybe Text)
- partialFailure_failureDescription :: Lens' PartialFailure (Maybe Text)
- partialFailure_exceptionType :: Lens' PartialFailure (Maybe Text)
- data Range = Range' {}
- newRange :: UTCTime -> UTCTime -> Range
- range_startTime :: Lens' Range UTCTime
- range_endTime :: Lens' Range UTCTime
- data StatisticSet = StatisticSet' {}
- newStatisticSet :: Double -> Double -> Double -> Double -> StatisticSet
- statisticSet_sampleCount :: Lens' StatisticSet Double
- statisticSet_sum :: Lens' StatisticSet Double
- statisticSet_minimum :: Lens' StatisticSet Double
- statisticSet_maximum :: Lens' StatisticSet Double
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2010-08-01 of the Amazon CloudWatch SDK configuration.
Errors
_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota for alarms for this customer has already been reached.
_DashboardNotFoundError :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified dashboard does not exist.
_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The next token specified is invalid.
_InternalServiceFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request processing has failed due to some unknown error, exception, or failure.
_DashboardInvalidInputError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Some part of the dashboard data is invalid.
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of an input parameter is bad or out-of-range.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
More than one process tried to modify a resource at the same time.
_InvalidFormatFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Data was not syntactically valid JSON.
_MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An input parameter that is required is missing.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The named resource does not exist.
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Parameters were used together that cannot be used together.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation exceeded one or more limits.
_ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The named resource does not exist.
AlarmType
Constructors
| AlarmType' | |
Fields | |
Bundled Patterns
| pattern AlarmType_CompositeAlarm :: AlarmType | |
| pattern AlarmType_MetricAlarm :: AlarmType |
Instances
AnomalyDetectorStateValue
newtype AnomalyDetectorStateValue Source #
Constructors
| AnomalyDetectorStateValue' | |
Fields | |
Bundled Patterns
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Constructors
| ComparisonOperator' | |
Fields | |
Bundled Patterns
Instances
HistoryItemType
newtype HistoryItemType Source #
Constructors
| HistoryItemType' | |
Fields | |
Bundled Patterns
| pattern HistoryItemType_Action :: HistoryItemType | |
| pattern HistoryItemType_ConfigurationUpdate :: HistoryItemType | |
| pattern HistoryItemType_StateUpdate :: HistoryItemType |
Instances
MetricStreamOutputFormat
newtype MetricStreamOutputFormat Source #
Constructors
| MetricStreamOutputFormat' | |
Fields | |
Bundled Patterns
| pattern MetricStreamOutputFormat_Json :: MetricStreamOutputFormat | |
| pattern MetricStreamOutputFormat_Opentelemetry0_7 :: MetricStreamOutputFormat |
Instances
RecentlyActive
newtype RecentlyActive Source #
Constructors
| RecentlyActive' | |
Fields | |
Bundled Patterns
| pattern RecentlyActive_PT3H :: RecentlyActive |
Instances
ScanBy
Constructors
| ScanBy' | |
Fields
| |
Bundled Patterns
| pattern ScanBy_TimestampAscending :: ScanBy | |
| pattern ScanBy_TimestampDescending :: ScanBy |
Instances
StandardUnit
newtype StandardUnit Source #
Constructors
| StandardUnit' | |
Fields | |
Bundled Patterns
Instances
StateValue
newtype StateValue Source #
Constructors
| StateValue' | |
Fields | |
Bundled Patterns
| pattern StateValue_ALARM :: StateValue | |
| pattern StateValue_INSUFFICIENT_DATA :: StateValue | |
| pattern StateValue_OK :: StateValue |
Instances
Statistic
Constructors
| Statistic' | |
Fields | |
Bundled Patterns
| pattern Statistic_Average :: Statistic | |
| pattern Statistic_Maximum :: Statistic | |
| pattern Statistic_Minimum :: Statistic | |
| pattern Statistic_SampleCount :: Statistic | |
| pattern Statistic_Sum :: Statistic |
Instances
StatusCode
newtype StatusCode Source #
Constructors
| StatusCode' | |
Fields | |
Bundled Patterns
| pattern StatusCode_Complete :: StatusCode | |
| pattern StatusCode_InternalError :: StatusCode | |
| pattern StatusCode_PartialData :: StatusCode |
Instances
AlarmHistoryItem
data AlarmHistoryItem Source #
Represents the history of a specific alarm.
See: newAlarmHistoryItem smart constructor.
Constructors
| AlarmHistoryItem' | |
Fields
| |
Instances
newAlarmHistoryItem :: AlarmHistoryItem Source #
Create a value of AlarmHistoryItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarmName:AlarmHistoryItem', alarmHistoryItem_alarmName - The descriptive name for the alarm.
$sel:historyItemType:AlarmHistoryItem', alarmHistoryItem_historyItemType - The type of alarm history item.
$sel:historyData:AlarmHistoryItem', alarmHistoryItem_historyData - Data about the alarm, in JSON format.
$sel:alarmType:AlarmHistoryItem', alarmHistoryItem_alarmType - The type of alarm, either metric alarm or composite alarm.
$sel:historySummary:AlarmHistoryItem', alarmHistoryItem_historySummary - A summary of the alarm history, in text format.
$sel:timestamp:AlarmHistoryItem', alarmHistoryItem_timestamp - The time stamp for the alarm history item.
alarmHistoryItem_alarmName :: Lens' AlarmHistoryItem (Maybe Text) Source #
The descriptive name for the alarm.
alarmHistoryItem_historyItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType) Source #
The type of alarm history item.
alarmHistoryItem_historyData :: Lens' AlarmHistoryItem (Maybe Text) Source #
Data about the alarm, in JSON format.
alarmHistoryItem_alarmType :: Lens' AlarmHistoryItem (Maybe AlarmType) Source #
The type of alarm, either metric alarm or composite alarm.
alarmHistoryItem_historySummary :: Lens' AlarmHistoryItem (Maybe Text) Source #
A summary of the alarm history, in text format.
alarmHistoryItem_timestamp :: Lens' AlarmHistoryItem (Maybe UTCTime) Source #
The time stamp for the alarm history item.
AnomalyDetector
data AnomalyDetector Source #
An anomaly detection model associated with a particular CloudWatch metric and statistic. You can use the model to display a band of expected normal values when the metric is graphed.
See: newAnomalyDetector smart constructor.
Constructors
| AnomalyDetector' | |
Fields
| |
Instances
newAnomalyDetector :: AnomalyDetector Source #
Create a value of AnomalyDetector with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricName:AnomalyDetector', anomalyDetector_metricName - The name of the metric associated with the anomaly detection model.
$sel:namespace:AnomalyDetector', anomalyDetector_namespace - The namespace of the metric associated with the anomaly detection model.
$sel:stateValue:AnomalyDetector', anomalyDetector_stateValue - The current status of the anomaly detector's training. The possible
values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
$sel:stat:AnomalyDetector', anomalyDetector_stat - The statistic associated with the anomaly detection model.
$sel:configuration:AnomalyDetector', anomalyDetector_configuration - The configuration specifies details about how the anomaly detection
model is to be trained, including time ranges to exclude from use for
training the model, and the time zone to use for the metric.
$sel:dimensions:AnomalyDetector', anomalyDetector_dimensions - The metric dimensions associated with the anomaly detection model.
anomalyDetector_metricName :: Lens' AnomalyDetector (Maybe Text) Source #
The name of the metric associated with the anomaly detection model.
anomalyDetector_namespace :: Lens' AnomalyDetector (Maybe Text) Source #
The namespace of the metric associated with the anomaly detection model.
anomalyDetector_stateValue :: Lens' AnomalyDetector (Maybe AnomalyDetectorStateValue) Source #
The current status of the anomaly detector's training. The possible
values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
anomalyDetector_stat :: Lens' AnomalyDetector (Maybe Text) Source #
The statistic associated with the anomaly detection model.
anomalyDetector_configuration :: Lens' AnomalyDetector (Maybe AnomalyDetectorConfiguration) Source #
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.
anomalyDetector_dimensions :: Lens' AnomalyDetector (Maybe [Dimension]) Source #
The metric dimensions associated with the anomaly detection model.
AnomalyDetectorConfiguration
data AnomalyDetectorConfiguration Source #
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model and the time zone to use for the metric.
See: newAnomalyDetectorConfiguration smart constructor.
Constructors
| AnomalyDetectorConfiguration' | |
Fields
| |
Instances
newAnomalyDetectorConfiguration :: AnomalyDetectorConfiguration Source #
Create a value of AnomalyDetectorConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricTimezone:AnomalyDetectorConfiguration', anomalyDetectorConfiguration_metricTimezone - The time zone to use for the metric. This is useful to enable the model
to automatically account for daylight savings time changes if the metric
is sensitive to such time changes.
To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.
$sel:excludedTimeRanges:AnomalyDetectorConfiguration', anomalyDetectorConfiguration_excludedTimeRanges - An array of time ranges to exclude from use when the anomaly detection
model is trained. Use this to make sure that events that could cause
unusual values for the metric, such as deployments, aren't used when
CloudWatch creates the model.
anomalyDetectorConfiguration_metricTimezone :: Lens' AnomalyDetectorConfiguration (Maybe Text) Source #
The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.
To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.
anomalyDetectorConfiguration_excludedTimeRanges :: Lens' AnomalyDetectorConfiguration (Maybe [Range]) Source #
An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.
CompositeAlarm
data CompositeAlarm Source #
The details about a composite alarm.
See: newCompositeAlarm smart constructor.
Constructors
| CompositeAlarm' | |
Fields
| |
Instances
newCompositeAlarm :: CompositeAlarm Source #
Create a value of CompositeAlarm with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarmName:CompositeAlarm', compositeAlarm_alarmName - The name of the alarm.
$sel:stateUpdatedTimestamp:CompositeAlarm', compositeAlarm_stateUpdatedTimestamp - The time stamp of the last update to the alarm state.
$sel:alarmDescription:CompositeAlarm', compositeAlarm_alarmDescription - The description of the alarm.
$sel:alarmRule:CompositeAlarm', compositeAlarm_alarmRule - The rule that this alarm uses to evaluate its alarm state.
$sel:oKActions:CompositeAlarm', compositeAlarm_oKActions - The actions to execute when this alarm transitions to the OK state from
any other state. Each action is specified as an Amazon Resource Name
(ARN).
$sel:stateValue:CompositeAlarm', compositeAlarm_stateValue - The state value for the alarm.
$sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm', compositeAlarm_alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.
$sel:actionsEnabled:CompositeAlarm', compositeAlarm_actionsEnabled - Indicates whether actions should be executed during any changes to the
alarm state.
$sel:insufficientDataActions:CompositeAlarm', compositeAlarm_insufficientDataActions - The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other state. Each action is specified
as an Amazon Resource Name (ARN).
$sel:stateReason:CompositeAlarm', compositeAlarm_stateReason - An explanation for the alarm state, in text format.
$sel:stateReasonData:CompositeAlarm', compositeAlarm_stateReasonData - An explanation for the alarm state, in JSON format.
$sel:alarmArn:CompositeAlarm', compositeAlarm_alarmArn - The Amazon Resource Name (ARN) of the alarm.
$sel:alarmActions:CompositeAlarm', compositeAlarm_alarmActions - The actions to execute when this alarm transitions to the ALARM state
from any other state. Each action is specified as an Amazon Resource
Name (ARN).
compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text) Source #
The name of the alarm.
compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm state.
compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text) Source #
The description of the alarm.
compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text) Source #
The rule that this alarm uses to evaluate its alarm state.
compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text]) Source #
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).
compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue) Source #
The state value for the alarm.
compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm configuration.
compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool) Source #
Indicates whether actions should be executed during any changes to the alarm state.
compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text]) Source #
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).
compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text) Source #
An explanation for the alarm state, in text format.
compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text) Source #
An explanation for the alarm state, in JSON format.
compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the alarm.
compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text]) Source #
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).
DashboardEntry
data DashboardEntry Source #
Represents a specific dashboard.
See: newDashboardEntry smart constructor.
Constructors
| DashboardEntry' | |
Fields
| |
Instances
newDashboardEntry :: DashboardEntry Source #
Create a value of DashboardEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:size:DashboardEntry', dashboardEntry_size - The size of the dashboard, in bytes.
$sel:dashboardName:DashboardEntry', dashboardEntry_dashboardName - The name of the dashboard.
$sel:lastModified:DashboardEntry', dashboardEntry_lastModified - The time stamp of when the dashboard was last modified, either by an API
call or through the console. This number is expressed as the number of
milliseconds since Jan 1, 1970 00:00:00 UTC.
$sel:dashboardArn:DashboardEntry', dashboardEntry_dashboardArn - The Amazon Resource Name (ARN) of the dashboard.
dashboardEntry_size :: Lens' DashboardEntry (Maybe Integer) Source #
The size of the dashboard, in bytes.
dashboardEntry_dashboardName :: Lens' DashboardEntry (Maybe Text) Source #
The name of the dashboard.
dashboardEntry_lastModified :: Lens' DashboardEntry (Maybe UTCTime) Source #
The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
dashboardEntry_dashboardArn :: Lens' DashboardEntry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dashboard.
DashboardValidationMessage
data DashboardValidationMessage Source #
An error or warning for the operation.
See: newDashboardValidationMessage smart constructor.
Constructors
| DashboardValidationMessage' | |
Instances
newDashboardValidationMessage :: DashboardValidationMessage Source #
Create a value of DashboardValidationMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataPath:DashboardValidationMessage', dashboardValidationMessage_dataPath - The data path related to the message.
$sel:message:DashboardValidationMessage', dashboardValidationMessage_message - A message describing the error or warning.
dashboardValidationMessage_dataPath :: Lens' DashboardValidationMessage (Maybe Text) Source #
The data path related to the message.
dashboardValidationMessage_message :: Lens' DashboardValidationMessage (Maybe Text) Source #
A message describing the error or warning.
Datapoint
Encapsulates the statistical data that CloudWatch computes from metric data.
See: newDatapoint smart constructor.
Constructors
| Datapoint' | |
Fields
| |
Instances
newDatapoint :: Datapoint Source #
Create a value of Datapoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sampleCount:Datapoint', datapoint_sampleCount - The number of metric values that contributed to the aggregate value of
this data point.
$sel:maximum:Datapoint', datapoint_maximum - The maximum metric value for the data point.
$sel:average:Datapoint', datapoint_average - The average of the metric values that correspond to the data point.
$sel:minimum:Datapoint', datapoint_minimum - The minimum metric value for the data point.
$sel:extendedStatistics:Datapoint', datapoint_extendedStatistics - The percentile statistic for the data point.
$sel:sum:Datapoint', datapoint_sum - The sum of the metric values for the data point.
$sel:unit:Datapoint', datapoint_unit - The standard unit for the data point.
$sel:timestamp:Datapoint', datapoint_timestamp - The time stamp used for the data point.
datapoint_sampleCount :: Lens' Datapoint (Maybe Double) Source #
The number of metric values that contributed to the aggregate value of this data point.
datapoint_maximum :: Lens' Datapoint (Maybe Double) Source #
The maximum metric value for the data point.
datapoint_average :: Lens' Datapoint (Maybe Double) Source #
The average of the metric values that correspond to the data point.
datapoint_minimum :: Lens' Datapoint (Maybe Double) Source #
The minimum metric value for the data point.
datapoint_extendedStatistics :: Lens' Datapoint (Maybe (HashMap Text Double)) Source #
The percentile statistic for the data point.
datapoint_sum :: Lens' Datapoint (Maybe Double) Source #
The sum of the metric values for the data point.
datapoint_unit :: Lens' Datapoint (Maybe StandardUnit) Source #
The standard unit for the data point.
datapoint_timestamp :: Lens' Datapoint (Maybe UTCTime) Source #
The time stamp used for the data point.
Dimension
A dimension is a name/value pair that is part of the identity of a metric. You can assign up to 10 dimensions to a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric.
See: newDimension smart constructor.
Constructors
| Dimension' | |
Instances
| Eq Dimension Source # | |
| Read Dimension Source # | |
| Show Dimension Source # | |
| Generic Dimension Source # | |
| NFData Dimension Source # | |
Defined in Amazonka.CloudWatch.Types.Dimension | |
| Hashable Dimension Source # | |
Defined in Amazonka.CloudWatch.Types.Dimension | |
| ToQuery Dimension Source # | |
Defined in Amazonka.CloudWatch.Types.Dimension Methods toQuery :: Dimension -> QueryString # | |
| FromXML Dimension Source # | |
| type Rep Dimension Source # | |
Defined in Amazonka.CloudWatch.Types.Dimension type Rep Dimension = D1 ('MetaData "Dimension" "Amazonka.CloudWatch.Types.Dimension" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "Dimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Dimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Dimension', dimension_name - The name of the dimension. Dimension names must contain only ASCII
characters and must include at least one non-whitespace character.
$sel:value:Dimension', dimension_value - The value of the dimension. Dimension values must contain only ASCII
characters and must include at least one non-whitespace character.
dimension_name :: Lens' Dimension Text Source #
The name of the dimension. Dimension names must contain only ASCII characters and must include at least one non-whitespace character.
dimension_value :: Lens' Dimension Text Source #
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
DimensionFilter
data DimensionFilter Source #
Represents filters for a dimension.
See: newDimensionFilter smart constructor.
Constructors
| DimensionFilter' | |
Instances
Arguments
| :: Text | |
| -> DimensionFilter |
Create a value of DimensionFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:DimensionFilter', dimensionFilter_value - The value of the dimension to be matched.
$sel:name:DimensionFilter', dimensionFilter_name - The dimension name to be matched.
dimensionFilter_value :: Lens' DimensionFilter (Maybe Text) Source #
The value of the dimension to be matched.
dimensionFilter_name :: Lens' DimensionFilter Text Source #
The dimension name to be matched.
InsightRule
data InsightRule Source #
This structure contains the definition for a Contributor Insights rule.
See: newInsightRule smart constructor.
Constructors
| InsightRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> InsightRule |
Create a value of InsightRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:InsightRule', insightRule_name - The name of the rule.
$sel:state:InsightRule', insightRule_state - Indicates whether the rule is enabled or disabled.
$sel:schema:InsightRule', insightRule_schema - For rules that you create, this is always
{"Name": "CloudWatchLogRule", "Version": 1}. For built-in rules,
this is {"Name": "ServiceLogRule", "Version": 1}
$sel:definition:InsightRule', insightRule_definition - The definition of the rule, as a JSON object. The definition contains
the keywords used to define contributors, the value to aggregate on if
this rule returns a sum instead of a count, and the filters. For details
on the valid syntax, see
Contributor Insights Rule Syntax.
insightRule_name :: Lens' InsightRule Text Source #
The name of the rule.
insightRule_state :: Lens' InsightRule Text Source #
Indicates whether the rule is enabled or disabled.
insightRule_schema :: Lens' InsightRule Text Source #
For rules that you create, this is always
{"Name": "CloudWatchLogRule", "Version": 1}. For built-in rules,
this is {"Name": "ServiceLogRule", "Version": 1}
insightRule_definition :: Lens' InsightRule Text Source #
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
InsightRuleContributor
data InsightRuleContributor Source #
One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.
If the rule contains a single key, then each unique contributor is each unique value for this key.
For more information, see GetInsightRuleReport.
See: newInsightRuleContributor smart constructor.
Constructors
| InsightRuleContributor' | |
Fields
| |
Instances
newInsightRuleContributor Source #
Create a value of InsightRuleContributor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keys:InsightRuleContributor', insightRuleContributor_keys - One of the log entry field keywords that is used to define contributors
for this rule.
$sel:approximateAggregateValue:InsightRuleContributor', insightRuleContributor_approximateAggregateValue - An approximation of the aggregate value that comes from this
contributor.
$sel:datapoints:InsightRuleContributor', insightRuleContributor_datapoints - An array of the data points where this contributor is present. Only the
data points when this contributor appeared are included in the array.
insightRuleContributor_keys :: Lens' InsightRuleContributor [Text] Source #
One of the log entry field keywords that is used to define contributors for this rule.
insightRuleContributor_approximateAggregateValue :: Lens' InsightRuleContributor Double Source #
An approximation of the aggregate value that comes from this contributor.
insightRuleContributor_datapoints :: Lens' InsightRuleContributor [InsightRuleContributorDatapoint] Source #
An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
InsightRuleContributorDatapoint
data InsightRuleContributorDatapoint Source #
One data point related to one contributor.
For more information, see GetInsightRuleReport and InsightRuleContributor.
See: newInsightRuleContributorDatapoint smart constructor.
Constructors
| InsightRuleContributorDatapoint' | |
Fields
| |
Instances
newInsightRuleContributorDatapoint Source #
Arguments
| :: UTCTime | |
| -> Double | |
| -> InsightRuleContributorDatapoint |
Create a value of InsightRuleContributorDatapoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timestamp:InsightRuleContributorDatapoint', insightRuleContributorDatapoint_timestamp - The timestamp of the data point.
$sel:approximateValue:InsightRuleContributorDatapoint', insightRuleContributorDatapoint_approximateValue - The approximate value that this contributor added during this timestamp.
insightRuleContributorDatapoint_timestamp :: Lens' InsightRuleContributorDatapoint UTCTime Source #
The timestamp of the data point.
insightRuleContributorDatapoint_approximateValue :: Lens' InsightRuleContributorDatapoint Double Source #
The approximate value that this contributor added during this timestamp.
InsightRuleMetricDatapoint
data InsightRuleMetricDatapoint Source #
One data point from the metric time series returned in a Contributor Insights rule report.
For more information, see GetInsightRuleReport.
See: newInsightRuleMetricDatapoint smart constructor.
Constructors
| InsightRuleMetricDatapoint' | |
Fields
| |
Instances
newInsightRuleMetricDatapoint Source #
Create a value of InsightRuleMetricDatapoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxContributorValue:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_maxContributorValue - The maximum value provided by one contributor during this timestamp.
Each timestamp is evaluated separately, so the identity of the max
contributor could be different for each timestamp.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:sampleCount:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_sampleCount - The number of occurrences that matched the rule during this data point.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:maximum:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_maximum - The maximum value from a single occurence from a single contributor
during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:average:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_average - The average value from all contributors during the time period
represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:minimum:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_minimum - The minimum value from a single contributor during the time period
represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:uniqueContributors:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_uniqueContributors - The number of unique contributors who published data during this
timestamp.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:sum:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_sum - The sum of the values from all contributors during the time period
represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
$sel:timestamp:InsightRuleMetricDatapoint', insightRuleMetricDatapoint_timestamp - The timestamp of the data point.
insightRuleMetricDatapoint_maxContributorValue :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, so the identity of the max contributor could be different for each timestamp.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_sampleCount :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The number of occurrences that matched the rule during this data point.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_maximum :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The maximum value from a single occurence from a single contributor during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_average :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The average value from all contributors during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_minimum :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The minimum value from a single contributor during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_uniqueContributors :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The number of unique contributors who published data during this timestamp.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_sum :: Lens' InsightRuleMetricDatapoint (Maybe Double) Source #
The sum of the values from all contributors during the time period represented by that data point.
This statistic is returned only if you included it in the Metrics
array in your request.
insightRuleMetricDatapoint_timestamp :: Lens' InsightRuleMetricDatapoint UTCTime Source #
The timestamp of the data point.
LabelOptions
data LabelOptions Source #
This structure includes the Timezone parameter, which you can use to
specify your time zone so that the labels that are associated with
returned metrics display the correct time for your time zone.
The Timezone value affects a label only if you have a time-based
dynamic expression in the label. For more information about dynamic
expressions in labels, see
Using Dynamic Labels.
See: newLabelOptions smart constructor.
Constructors
| LabelOptions' | |
Fields
| |
Instances
newLabelOptions :: LabelOptions Source #
Create a value of LabelOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timezone:LabelOptions', labelOptions_timezone - The time zone to use for metric data return in this operation. The
format is + or - followed by four digits. The first two digits
indicate the number of hours ahead or behind of UTC, and the final two
digits are the number of minutes. For example, +0130 indicates a time
zone that is 1 hour and 30 minutes ahead of UTC. The default is +0000.
labelOptions_timezone :: Lens' LabelOptions (Maybe Text) Source #
The time zone to use for metric data return in this operation. The
format is + or - followed by four digits. The first two digits
indicate the number of hours ahead or behind of UTC, and the final two
digits are the number of minutes. For example, +0130 indicates a time
zone that is 1 hour and 30 minutes ahead of UTC. The default is +0000.
MessageData
data MessageData Source #
A message returned by the GetMetricDataAPI, including a code and a
description.
If a cross-Region GetMetricData operation fails with a code of
Forbidden and a value of
Authentication too complex to retrieve cross region data, you can
correct the problem by running the GetMetricData operation in the same
Region where the metric data is.
See: newMessageData smart constructor.
Constructors
| MessageData' | |
Instances
newMessageData :: MessageData Source #
Create a value of MessageData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:MessageData', messageData_value - The message text.
$sel:code:MessageData', messageData_code - The error code or status code associated with the message.
messageData_value :: Lens' MessageData (Maybe Text) Source #
The message text.
messageData_code :: Lens' MessageData (Maybe Text) Source #
The error code or status code associated with the message.
Metric
Represents a specific metric.
See: newMetric smart constructor.
Constructors
| Metric' | |
Fields
| |
Instances
| Eq Metric Source # | |
| Read Metric Source # | |
| Show Metric Source # | |
| Generic Metric Source # | |
| NFData Metric Source # | |
Defined in Amazonka.CloudWatch.Types.Metric | |
| Hashable Metric Source # | |
Defined in Amazonka.CloudWatch.Types.Metric | |
| ToQuery Metric Source # | |
Defined in Amazonka.CloudWatch.Types.Metric Methods toQuery :: Metric -> QueryString # | |
| FromXML Metric Source # | |
| type Rep Metric Source # | |
Defined in Amazonka.CloudWatch.Types.Metric type Rep Metric = D1 ('MetaData "Metric" "Amazonka.CloudWatch.Types.Metric" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "Metric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Dimension]))))) | |
Create a value of Metric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricName:Metric', metric_metricName - The name of the metric. This is a required field.
$sel:namespace:Metric', metric_namespace - The namespace of the metric.
$sel:dimensions:Metric', metric_dimensions - The dimensions for the metric.
metric_metricName :: Lens' Metric (Maybe Text) Source #
The name of the metric. This is a required field.
MetricAlarm
data MetricAlarm Source #
The details about a metric alarm.
See: newMetricAlarm smart constructor.
Constructors
| MetricAlarm' | |
Fields
| |
Instances
newMetricAlarm :: MetricAlarm Source #
Create a value of MetricAlarm with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarmName:MetricAlarm', metricAlarm_alarmName - The name of the alarm.
$sel:stateUpdatedTimestamp:MetricAlarm', metricAlarm_stateUpdatedTimestamp - The time stamp of the last update to the alarm state.
$sel:metrics:MetricAlarm', metricAlarm_metrics - An array of MetricDataQuery structures, used in an alarm based on a
metric math expression. Each structure either retrieves a metric or
performs a math expression. One item in the Metrics array is the math
expression that the alarm watches. This expression by designated by
having ReturnData set to true.
$sel:treatMissingData:MetricAlarm', metricAlarm_treatMissingData - Sets how this alarm is to handle missing data points. If this parameter
is omitted, the default behavior of missing is used.
$sel:period:MetricAlarm', metricAlarm_period - The period, in seconds, over which the statistic is applied.
$sel:alarmDescription:MetricAlarm', metricAlarm_alarmDescription - The description of the alarm.
$sel:evaluationPeriods:MetricAlarm', metricAlarm_evaluationPeriods - The number of periods over which data is compared to the specified
threshold.
$sel:metricName:MetricAlarm', metricAlarm_metricName - The name of the metric associated with the alarm, if this is an alarm
based on a single metric.
$sel:namespace:MetricAlarm', metricAlarm_namespace - The namespace of the metric associated with the alarm.
$sel:thresholdMetricId:MetricAlarm', metricAlarm_thresholdMetricId - In an alarm based on an anomaly detection model, this is the ID of the
ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
$sel:comparisonOperator:MetricAlarm', metricAlarm_comparisonOperator - The arithmetic operation to use when comparing the specified statistic
and threshold. The specified statistic value is used as the first
operand.
$sel:oKActions:MetricAlarm', metricAlarm_oKActions - The actions to execute when this alarm transitions to the OK state
from any other state. Each action is specified as an Amazon Resource
Name (ARN).
$sel:evaluateLowSampleCountPercentile:MetricAlarm', metricAlarm_evaluateLowSampleCountPercentile - Used only for alarms based on percentiles. If ignore, the alarm state
does not change during periods with too few data points to be
statistically significant. If evaluate or this parameter is not used,
the alarm is always evaluated and possibly changes state no matter how
many data points are available.
$sel:stateValue:MetricAlarm', metricAlarm_stateValue - The state value for the alarm.
$sel:datapointsToAlarm:MetricAlarm', metricAlarm_datapointsToAlarm - The number of data points that must be breaching to trigger the alarm.
$sel:threshold:MetricAlarm', metricAlarm_threshold - The value to compare with the specified statistic.
$sel:alarmConfigurationUpdatedTimestamp:MetricAlarm', metricAlarm_alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.
$sel:actionsEnabled:MetricAlarm', metricAlarm_actionsEnabled - Indicates whether actions should be executed during any changes to the
alarm state.
$sel:insufficientDataActions:MetricAlarm', metricAlarm_insufficientDataActions - The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other state. Each action is specified
as an Amazon Resource Name (ARN).
$sel:stateReason:MetricAlarm', metricAlarm_stateReason - An explanation for the alarm state, in text format.
$sel:stateReasonData:MetricAlarm', metricAlarm_stateReasonData - An explanation for the alarm state, in JSON format.
$sel:dimensions:MetricAlarm', metricAlarm_dimensions - The dimensions for the metric associated with the alarm.
$sel:alarmArn:MetricAlarm', metricAlarm_alarmArn - The Amazon Resource Name (ARN) of the alarm.
$sel:alarmActions:MetricAlarm', metricAlarm_alarmActions - The actions to execute when this alarm transitions to the ALARM state
from any other state. Each action is specified as an Amazon Resource
Name (ARN).
$sel:unit:MetricAlarm', metricAlarm_unit - The unit of the metric associated with the alarm.
$sel:statistic:MetricAlarm', metricAlarm_statistic - The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use ExtendedStatistic.
$sel:extendedStatistic:MetricAlarm', metricAlarm_extendedStatistic - The percentile statistic for the metric associated with the alarm.
Specify a value between p0.0 and p100.
metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text) Source #
The name of the alarm.
metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm state.
metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery]) Source #
An array of MetricDataQuery structures, used in an alarm based on a
metric math expression. Each structure either retrieves a metric or
performs a math expression. One item in the Metrics array is the math
expression that the alarm watches. This expression by designated by
having ReturnData set to true.
metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text) Source #
Sets how this alarm is to handle missing data points. If this parameter
is omitted, the default behavior of missing is used.
metricAlarm_period :: Lens' MetricAlarm (Maybe Natural) Source #
The period, in seconds, over which the statistic is applied.
metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text) Source #
The description of the alarm.
metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural) Source #
The number of periods over which data is compared to the specified threshold.
metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text) Source #
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text) Source #
The namespace of the metric associated with the alarm.
metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text) Source #
In an alarm based on an anomaly detection model, this is the ID of the
ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator) Source #
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text]) Source #
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).
metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text) Source #
Used only for alarms based on percentiles. If ignore, the alarm state
does not change during periods with too few data points to be
statistically significant. If evaluate or this parameter is not used,
the alarm is always evaluated and possibly changes state no matter how
many data points are available.
metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue) Source #
The state value for the alarm.
metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural) Source #
The number of data points that must be breaching to trigger the alarm.
metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double) Source #
The value to compare with the specified statistic.
metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm configuration.
metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool) Source #
Indicates whether actions should be executed during any changes to the alarm state.
metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text]) Source #
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).
metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in text format.
metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in JSON format.
metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension]) Source #
The dimensions for the metric associated with the alarm.
metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the alarm.
metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text]) Source #
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).
metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit) Source #
The unit of the metric associated with the alarm.
metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic) Source #
The statistic for the metric associated with the alarm, other than
percentile. For percentile statistics, use ExtendedStatistic.
metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text) Source #
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
MetricDataQuery
data MetricDataQuery Source #
This structure is used in both GetMetricData and PutMetricAlarm. The
supported use of this structure is different for those two operations.
When used in GetMetricData, it indicates the metric data to return,
and whether this call is just retrieving a batch set of data for one
metric, or is performing a math expression on metric data. A single
GetMetricData call can include up to 500 MetricDataQuery structures.
When used in PutMetricAlarm, it enables you to create an alarm based
on a metric math expression. Each MetricDataQuery in the array
specifies either a metric to retrieve, or a math expression to be
performed on retrieved metrics. A single PutMetricAlarm call can
include up to 20 MetricDataQuery structures in the array. The 20
structures can include as many as 10 structures that contain a
MetricStat parameter to retrieve a metric, and as many as 10
structures that contain the Expression parameter to perform a math
expression. Of those Expression structures, one must have True as
the value for ReturnData. The result of this expression is the value
the alarm watches.
Any expression used in a PutMetricAlarm operation must return a single
time series. For more information, see
Metric Math Syntax and Functions
in the Amazon CloudWatch User Guide.
Some of the parameters of this structure also have different uses
whether you are using this structure in a GetMetricData operation or a
PutMetricAlarm operation. These differences are explained in the
following parameter list.
See: newMetricDataQuery smart constructor.
Constructors
| MetricDataQuery' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MetricDataQuery |
Create a value of MetricDataQuery with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnData:MetricDataQuery', metricDataQuery_returnData - When used in GetMetricData, this option indicates whether to return
the timestamps and raw data values of this metric. If you are performing
this call just to do math expressions and do not also need the raw data
returned, you can specify False. If you omit this, the default of
True is used.
When used in PutMetricAlarm, specify True for the one expression
result to use as the alarm. For all other metrics and expressions in the
same PutMetricAlarm operation, specify ReturnData as False.
$sel:period:MetricDataQuery', metricDataQuery_period - The granularity, in seconds, of the returned data points. For metrics
with regular resolution, a period can be as short as one minute (60
seconds) and must be a multiple of 60. For high-resolution metrics that
are collected at intervals of less than one minute, the period can be 1,
5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those
metrics stored by a PutMetricData operation that includes a
StorageResolution of 1 second.
$sel:accountId:MetricDataQuery', metricDataQuery_accountId - The ID of the account where the metrics are located, if this is a
cross-account alarm.
Use this field only for PutMetricAlarm operations. It is not used in
GetMetricData operations.
$sel:expression:MetricDataQuery', metricDataQuery_expression - The math expression to be performed on the returned data, if this object
is performing a math expression. This expression can use the Id of the
other metrics to refer to those metrics, and can also use the Id of
other expressions to use the result of those expressions. For more
information about metric math expressions, see
Metric Math Syntax and Functions
in the Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either Expression
or MetricStat but not both.
$sel:label:MetricDataQuery', metricDataQuery_label - A human-readable label for this metric or expression. This is especially
useful if this is an expression, so that you know what the value
represents. If the metric or expression is shown in a CloudWatch
dashboard widget, the label is shown. If Label is omitted, CloudWatch
generates a default.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
$sel:metricStat:MetricDataQuery', metricDataQuery_metricStat - The metric to be returned, along with statistics, period, and units. Use
this parameter only if this object is retrieving a metric and not
performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat but not both.
$sel:id:MetricDataQuery', metricDataQuery_id - A short name used to tie this object to the results in the response.
This name must be unique within a single call to GetMetricData. If you
are performing math expressions on this set of data, this name
represents that data and can serve as a variable in the mathematical
expression. The valid characters are letters, numbers, and underscore.
The first character must be a lowercase letter.
metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool) Source #
When used in GetMetricData, this option indicates whether to return
the timestamps and raw data values of this metric. If you are performing
this call just to do math expressions and do not also need the raw data
returned, you can specify False. If you omit this, the default of
True is used.
When used in PutMetricAlarm, specify True for the one expression
result to use as the alarm. For all other metrics and expressions in the
same PutMetricAlarm operation, specify ReturnData as False.
metricDataQuery_period :: Lens' MetricDataQuery (Maybe Natural) Source #
The granularity, in seconds, of the returned data points. For metrics
with regular resolution, a period can be as short as one minute (60
seconds) and must be a multiple of 60. For high-resolution metrics that
are collected at intervals of less than one minute, the period can be 1,
5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those
metrics stored by a PutMetricData operation that includes a
StorageResolution of 1 second.
metricDataQuery_accountId :: Lens' MetricDataQuery (Maybe Text) Source #
The ID of the account where the metrics are located, if this is a cross-account alarm.
Use this field only for PutMetricAlarm operations. It is not used in
GetMetricData operations.
metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text) Source #
The math expression to be performed on the returned data, if this object
is performing a math expression. This expression can use the Id of the
other metrics to refer to those metrics, and can also use the Id of
other expressions to use the result of those expressions. For more
information about metric math expressions, see
Metric Math Syntax and Functions
in the Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either Expression
or MetricStat but not both.
metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text) Source #
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat) Source #
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
Within one MetricDataQuery object, you must specify either Expression
or MetricStat but not both.
metricDataQuery_id :: Lens' MetricDataQuery Text Source #
A short name used to tie this object to the results in the response.
This name must be unique within a single call to GetMetricData. If you
are performing math expressions on this set of data, this name
represents that data and can serve as a variable in the mathematical
expression. The valid characters are letters, numbers, and underscore.
The first character must be a lowercase letter.
MetricDataResult
data MetricDataResult Source #
A GetMetricData call returns an array of MetricDataResult
structures. Each of these structures includes the data points for that
metric, along with the timestamps of those data points and other
identifying information.
See: newMetricDataResult smart constructor.
Constructors
| MetricDataResult' | |
Fields
| |
Instances
newMetricDataResult :: MetricDataResult Source #
Create a value of MetricDataResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:MetricDataResult', metricDataResult_values - The data points for the metric corresponding to Timestamps. The number
of values always matches the number of timestamps and the timestamp for
Values[x] is Timestamps[x].
$sel:id:MetricDataResult', metricDataResult_id - The short name you specified to represent this metric.
$sel:timestamps:MetricDataResult', metricDataResult_timestamps - The timestamps for the data points, formatted in Unix timestamp format.
The number of timestamps always matches the number of values and the
value for Timestamps[x] is Values[x].
$sel:messages:MetricDataResult', metricDataResult_messages - A list of messages with additional information about the data returned.
$sel:label:MetricDataResult', metricDataResult_label - The human-readable label associated with the data.
$sel:statusCode:MetricDataResult', metricDataResult_statusCode - The status of the returned data. Complete indicates that all data
points in the requested time range were returned. PartialData means
that an incomplete set of data points were returned. You can use the
NextToken value that was returned and repeat your request to get more
data points. NextToken is not returned if you are performing a math
expression. InternalError indicates that an error occurred. Retry your
request using NextToken, if present.
metricDataResult_values :: Lens' MetricDataResult (Maybe [Double]) Source #
The data points for the metric corresponding to Timestamps. The number
of values always matches the number of timestamps and the timestamp for
Values[x] is Timestamps[x].
metricDataResult_id :: Lens' MetricDataResult (Maybe Text) Source #
The short name you specified to represent this metric.
metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime]) Source #
The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].
metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData]) Source #
A list of messages with additional information about the data returned.
metricDataResult_label :: Lens' MetricDataResult (Maybe Text) Source #
The human-readable label associated with the data.
metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode) Source #
The status of the returned data. Complete indicates that all data
points in the requested time range were returned. PartialData means
that an incomplete set of data points were returned. You can use the
NextToken value that was returned and repeat your request to get more
data points. NextToken is not returned if you are performing a math
expression. InternalError indicates that an error occurred. Retry your
request using NextToken, if present.
MetricDatum
data MetricDatum Source #
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
See: newMetricDatum smart constructor.
Constructors
| MetricDatum' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MetricDatum |
Create a value of MetricDatum with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:MetricDatum', metricDatum_values - Array of numbers representing the values for the metric during the
period. Each unique value is listed just once in this array, and the
corresponding number in the Counts array specifies the number of times
that value occurred during the period. You can include up to 150 unique
values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type Double, CloudWatch
rejects values that are either too small or too large. Values must be in
the range of -2^360 to 2^360. In addition, special values (for example,
NaN, +Infinity, -Infinity) are not supported.
$sel:counts:MetricDatum', metricDatum_counts - Array of numbers that is used along with the Values array. Each number
in the Count array is the number of times the corresponding value in
the Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value
for each count. If you include a Counts array, it must include the
same amount of values as the Values array.
$sel:value:MetricDatum', metricDatum_value - The value for the metric.
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
$sel:storageResolution:MetricDatum', metricDatum_storageResolution - Valid values are 1 and 60. Setting this to 1 specifies this metric as a
high-resolution metric, so that CloudWatch stores the metric with
sub-minute resolution down to one second. Setting this to 60 specifies
this metric as a regular-resolution metric, which CloudWatch stores at
1-minute resolution. Currently, high resolution is available only for
custom metrics. For more information about high-resolution metrics, see
High-Resolution Metrics
in the Amazon CloudWatch User Guide.
This field is optional, if you do not specify it the default of 60 is used.
$sel:dimensions:MetricDatum', metricDatum_dimensions - The dimensions associated with the metric.
$sel:unit:MetricDatum', metricDatum_unit - When you are using a Put operation, this defines what unit you want to
use when storing the metric.
In a Get operation, this displays the unit that is used for the
metric.
$sel:timestamp:MetricDatum', metricDatum_timestamp - The time the metric data was received, expressed as the number of
milliseconds since Jan 1, 1970 00:00:00 UTC.
$sel:statisticValues:MetricDatum', metricDatum_statisticValues - The statistical values for the metric.
$sel:metricName:MetricDatum', metricDatum_metricName - The name of the metric.
metricDatum_values :: Lens' MetricDatum (Maybe [Double]) Source #
Array of numbers representing the values for the metric during the
period. Each unique value is listed just once in this array, and the
corresponding number in the Counts array specifies the number of times
that value occurred during the period. You can include up to 150 unique
values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type Double, CloudWatch
rejects values that are either too small or too large. Values must be in
the range of -2^360 to 2^360. In addition, special values (for example,
NaN, +Infinity, -Infinity) are not supported.
metricDatum_counts :: Lens' MetricDatum (Maybe [Double]) Source #
Array of numbers that is used along with the Values array. Each number
in the Count array is the number of times the corresponding value in
the Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value
for each count. If you include a Counts array, it must include the
same amount of values as the Values array.
metricDatum_value :: Lens' MetricDatum (Maybe Double) Source #
The value for the metric.
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
metricDatum_storageResolution :: Lens' MetricDatum (Maybe Natural) Source #
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
This field is optional, if you do not specify it the default of 60 is used.
metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension]) Source #
The dimensions associated with the metric.
metricDatum_unit :: Lens' MetricDatum (Maybe StandardUnit) Source #
When you are using a Put operation, this defines what unit you want to
use when storing the metric.
In a Get operation, this displays the unit that is used for the
metric.
metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime) Source #
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source #
The statistical values for the metric.
metricDatum_metricName :: Lens' MetricDatum Text Source #
The name of the metric.
MetricStat
data MetricStat Source #
This structure defines the metric to be returned, along with the statistics, period, and units.
See: newMetricStat smart constructor.
Constructors
| MetricStat' | |
Fields
| |
Instances
Arguments
| :: Metric | |
| -> Natural | |
| -> Text | |
| -> MetricStat |
Create a value of MetricStat with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unit:MetricStat', metricStat_unit - When you are using a Put operation, this defines what unit you want to
use when storing the metric.
In a Get operation, if you omit Unit then all data that was
collected with any unit is returned, along with the corresponding units
that were specified when the data was reported to CloudWatch. If you
specify a unit, the operation returns only data that was collected with
that unit specified. If you specify a unit that does not match the data
collected, the results of the operation are null. CloudWatch does not
perform unit conversions.
$sel:metric:MetricStat', metricStat_metric - The metric to return, including the metric name, namespace, and
dimensions.
$sel:period:MetricStat', metricStat_period - The granularity, in seconds, of the returned data points. For metrics
with regular resolution, a period can be as short as one minute (60
seconds) and must be a multiple of 60. For high-resolution metrics that
are collected at intervals of less than one minute, the period can be 1,
5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those
metrics stored by a PutMetricData call that includes a
StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than
3 hours ago, you must specify the period as follows or no data points in
that time range is returned:
- Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
- Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
- Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
$sel:stat:MetricStat', metricStat_stat - The statistic to return. It can include any CloudWatch statistic or
extended statistic.
metricStat_unit :: Lens' MetricStat (Maybe StandardUnit) Source #
When you are using a Put operation, this defines what unit you want to
use when storing the metric.
In a Get operation, if you omit Unit then all data that was
collected with any unit is returned, along with the corresponding units
that were specified when the data was reported to CloudWatch. If you
specify a unit, the operation returns only data that was collected with
that unit specified. If you specify a unit that does not match the data
collected, the results of the operation are null. CloudWatch does not
perform unit conversions.
metricStat_metric :: Lens' MetricStat Metric Source #
The metric to return, including the metric name, namespace, and dimensions.
metricStat_period :: Lens' MetricStat Natural Source #
The granularity, in seconds, of the returned data points. For metrics
with regular resolution, a period can be as short as one minute (60
seconds) and must be a multiple of 60. For high-resolution metrics that
are collected at intervals of less than one minute, the period can be 1,
5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those
metrics stored by a PutMetricData call that includes a
StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than
3 hours ago, you must specify the period as follows or no data points in
that time range is returned:
- Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
- Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
- Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
metricStat_stat :: Lens' MetricStat Text Source #
The statistic to return. It can include any CloudWatch statistic or extended statistic.
MetricStreamEntry
data MetricStreamEntry Source #
This structure contains the configuration information about one metric stream.
See: newMetricStreamEntry smart constructor.
Constructors
| MetricStreamEntry' | |
Fields
| |
Instances
newMetricStreamEntry :: MetricStreamEntry Source #
Create a value of MetricStreamEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:MetricStreamEntry', metricStreamEntry_state - The current state of this stream. Valid values are running and
stopped.
$sel:arn:MetricStreamEntry', metricStreamEntry_arn - The ARN of the metric stream.
$sel:firehoseArn:MetricStreamEntry', metricStreamEntry_firehoseArn - The ARN of the Kinesis Firehose devlivery stream that is used for this
metric stream.
$sel:outputFormat:MetricStreamEntry', metricStreamEntry_outputFormat - The output format of this metric stream. Valid values are json and
opentelemetry0.7.
$sel:lastUpdateDate:MetricStreamEntry', metricStreamEntry_lastUpdateDate - The date that the configuration of this metric stream was most recently
updated.
$sel:name:MetricStreamEntry', metricStreamEntry_name - The name of the metric stream.
$sel:creationDate:MetricStreamEntry', metricStreamEntry_creationDate - The date that the metric stream was originally created.
metricStreamEntry_state :: Lens' MetricStreamEntry (Maybe Text) Source #
The current state of this stream. Valid values are running and
stopped.
metricStreamEntry_arn :: Lens' MetricStreamEntry (Maybe Text) Source #
The ARN of the metric stream.
metricStreamEntry_firehoseArn :: Lens' MetricStreamEntry (Maybe Text) Source #
The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
metricStreamEntry_outputFormat :: Lens' MetricStreamEntry (Maybe MetricStreamOutputFormat) Source #
The output format of this metric stream. Valid values are json and
opentelemetry0.7.
metricStreamEntry_lastUpdateDate :: Lens' MetricStreamEntry (Maybe UTCTime) Source #
The date that the configuration of this metric stream was most recently updated.
metricStreamEntry_name :: Lens' MetricStreamEntry (Maybe Text) Source #
The name of the metric stream.
metricStreamEntry_creationDate :: Lens' MetricStreamEntry (Maybe UTCTime) Source #
The date that the metric stream was originally created.
MetricStreamFilter
data MetricStreamFilter Source #
This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
See: newMetricStreamFilter smart constructor.
Constructors
| MetricStreamFilter' | |
Instances
newMetricStreamFilter :: MetricStreamFilter Source #
Create a value of MetricStreamFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:namespace:MetricStreamFilter', metricStreamFilter_namespace - The name of the metric namespace in the filter.
metricStreamFilter_namespace :: Lens' MetricStreamFilter (Maybe Text) Source #
The name of the metric namespace in the filter.
PartialFailure
data PartialFailure Source #
This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
See: newPartialFailure smart constructor.
Constructors
| PartialFailure' | |
Fields
| |
Instances
newPartialFailure :: PartialFailure Source #
Create a value of PartialFailure with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureResource:PartialFailure', partialFailure_failureResource - The specified rule that could not be deleted.
$sel:failureCode:PartialFailure', partialFailure_failureCode - The code of the error.
$sel:failureDescription:PartialFailure', partialFailure_failureDescription - A description of the error.
$sel:exceptionType:PartialFailure', partialFailure_exceptionType - The type of error.
partialFailure_failureResource :: Lens' PartialFailure (Maybe Text) Source #
The specified rule that could not be deleted.
partialFailure_failureCode :: Lens' PartialFailure (Maybe Text) Source #
The code of the error.
partialFailure_failureDescription :: Lens' PartialFailure (Maybe Text) Source #
A description of the error.
partialFailure_exceptionType :: Lens' PartialFailure (Maybe Text) Source #
The type of error.
Range
Specifies one range of days or times to exclude from use for training an anomaly detection model.
See: newRange smart constructor.
Constructors
| Range' | |
Instances
| Eq Range Source # | |
| Read Range Source # | |
| Show Range Source # | |
| Generic Range Source # | |
| NFData Range Source # | |
Defined in Amazonka.CloudWatch.Types.Range | |
| Hashable Range Source # | |
Defined in Amazonka.CloudWatch.Types.Range | |
| ToQuery Range Source # | |
Defined in Amazonka.CloudWatch.Types.Range Methods toQuery :: Range -> QueryString # | |
| FromXML Range Source # | |
| type Rep Range Source # | |
Defined in Amazonka.CloudWatch.Types.Range type Rep Range = D1 ('MetaData "Range" "Amazonka.CloudWatch.Types.Range" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "Range'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))) | |
Create a value of Range with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:Range', range_startTime - The start time of the range to exclude. The format is
yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
$sel:endTime:Range', range_endTime - The end time of the range to exclude. The format is
yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
range_startTime :: Lens' Range UTCTime Source #
The start time of the range to exclude. The format is
yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
range_endTime :: Lens' Range UTCTime Source #
The end time of the range to exclude. The format is
yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
StatisticSet
data StatisticSet Source #
Represents a set of statistics that describes a specific metric.
See: newStatisticSet smart constructor.
Constructors
| StatisticSet' | |
Instances
Arguments
| :: Double | |
| -> Double | |
| -> Double | |
| -> Double | |
| -> StatisticSet |
Create a value of StatisticSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sampleCount:StatisticSet', statisticSet_sampleCount - The number of samples used for the statistic set.
$sel:sum:StatisticSet', statisticSet_sum - The sum of values for the sample set.
$sel:minimum:StatisticSet', statisticSet_minimum - The minimum value of the sample set.
$sel:maximum:StatisticSet', statisticSet_maximum - The maximum value of the sample set.
statisticSet_sampleCount :: Lens' StatisticSet Double Source #
The number of samples used for the statistic set.
statisticSet_sum :: Lens' StatisticSet Double Source #
The sum of values for the sample set.
statisticSet_minimum :: Lens' StatisticSet Double Source #
The minimum value of the sample set.
statisticSet_maximum :: Lens' StatisticSet Double Source #
The maximum value of the sample set.
Tag
A key-value pair associated with a CloudWatch resource.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CloudWatch.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.CloudWatch.Types.Tag | |
| ToQuery Tag Source # | |
Defined in Amazonka.CloudWatch.Types.Tag Methods toQuery :: Tag -> QueryString # | |
| FromXML Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.CloudWatch.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudWatch.Types.Tag" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - A string that you can use to assign a value. The combination of tag keys
and values can help you organize and categorize your resources.
$sel:value:Tag', tag_value - The value for the specified tag key.