| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.CloudWatch
Description
Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
Synopsis
- cloudWatch :: 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
- _InvalidFormatFault :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- alarmExists :: Wait DescribeAlarms
- module Network.AWS.CloudWatch.EnableAlarmActions
- module Network.AWS.CloudWatch.GetDashboard
- module Network.AWS.CloudWatch.GetMetricData
- module Network.AWS.CloudWatch.PutMetricData
- module Network.AWS.CloudWatch.ListDashboards
- module Network.AWS.CloudWatch.DescribeAlarms
- module Network.AWS.CloudWatch.ListMetrics
- module Network.AWS.CloudWatch.DeleteDashboards
- module Network.AWS.CloudWatch.DeleteAlarms
- module Network.AWS.CloudWatch.DescribeAlarmHistory
- module Network.AWS.CloudWatch.GetMetricStatistics
- module Network.AWS.CloudWatch.DescribeAlarmsForMetric
- module Network.AWS.CloudWatch.DisableAlarmActions
- module Network.AWS.CloudWatch.PutDashboard
- module Network.AWS.CloudWatch.PutMetricAlarm
- module Network.AWS.CloudWatch.SetAlarmState
- data ComparisonOperator
- data HistoryItemType
- data ScanBy
- data StandardUnit
- = Bits
- | BitsSecond
- | Bytes
- | BytesSecond
- | Count
- | CountSecond
- | Gigabits
- | GigabitsSecond
- | Gigabytes
- | GigabytesSecond
- | Kilobits
- | KilobitsSecond
- | Kilobytes
- | KilobytesSecond
- | Megabits
- | MegabitsSecond
- | Megabytes
- | MegabytesSecond
- | Microseconds
- | Milliseconds
- | None
- | Percent
- | Seconds
- | Terabits
- | TerabitsSecond
- | Terabytes
- | TerabytesSecond
- data StateValue
- = Alarm
- | InsufficientData
- | OK
- data Statistic
- = Average
- | Maximum
- | Minimum
- | SampleCount
- | Sum
- data StatusCode
- data AlarmHistoryItem
- alarmHistoryItem :: AlarmHistoryItem
- ahiAlarmName :: Lens' AlarmHistoryItem (Maybe Text)
- ahiHistoryItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType)
- ahiHistoryData :: Lens' AlarmHistoryItem (Maybe Text)
- ahiHistorySummary :: Lens' AlarmHistoryItem (Maybe Text)
- ahiTimestamp :: Lens' AlarmHistoryItem (Maybe UTCTime)
- data DashboardEntry
- dashboardEntry :: DashboardEntry
- deSize :: Lens' DashboardEntry (Maybe Integer)
- deDashboardName :: Lens' DashboardEntry (Maybe Text)
- deLastModified :: Lens' DashboardEntry (Maybe UTCTime)
- deDashboardARN :: Lens' DashboardEntry (Maybe Text)
- data DashboardValidationMessage
- dashboardValidationMessage :: DashboardValidationMessage
- dvmDataPath :: Lens' DashboardValidationMessage (Maybe Text)
- dvmMessage :: Lens' DashboardValidationMessage (Maybe Text)
- data Datapoint
- datapoint :: Datapoint
- dSampleCount :: Lens' Datapoint (Maybe Double)
- dMaximum :: Lens' Datapoint (Maybe Double)
- dAverage :: Lens' Datapoint (Maybe Double)
- dMinimum :: Lens' Datapoint (Maybe Double)
- dExtendedStatistics :: Lens' Datapoint (HashMap Text Double)
- dSum :: Lens' Datapoint (Maybe Double)
- dUnit :: Lens' Datapoint (Maybe StandardUnit)
- dTimestamp :: Lens' Datapoint (Maybe UTCTime)
- data Dimension
- dimension :: Text -> Text -> Dimension
- dName :: Lens' Dimension Text
- dValue :: Lens' Dimension Text
- data DimensionFilter
- dimensionFilter :: Text -> DimensionFilter
- dfValue :: Lens' DimensionFilter (Maybe Text)
- dfName :: Lens' DimensionFilter Text
- data MessageData
- messageData :: MessageData
- mValue :: Lens' MessageData (Maybe Text)
- mCode :: Lens' MessageData (Maybe Text)
- data Metric
- metric :: Metric
- mMetricName :: Lens' Metric (Maybe Text)
- mNamespace :: Lens' Metric (Maybe Text)
- mDimensions :: Lens' Metric [Dimension]
- data MetricAlarm
- metricAlarm :: MetricAlarm
- maAlarmName :: Lens' MetricAlarm (Maybe Text)
- maStateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- maTreatMissingData :: Lens' MetricAlarm (Maybe Text)
- maPeriod :: Lens' MetricAlarm (Maybe Natural)
- maAlarmDescription :: Lens' MetricAlarm (Maybe Text)
- maEvaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
- maMetricName :: Lens' MetricAlarm (Maybe Text)
- maNamespace :: Lens' MetricAlarm (Maybe Text)
- maComparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
- maOKActions :: Lens' MetricAlarm [Text]
- maEvaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
- maStateValue :: Lens' MetricAlarm (Maybe StateValue)
- maDatapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
- maThreshold :: Lens' MetricAlarm (Maybe Double)
- maAlarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
- maActionsEnabled :: Lens' MetricAlarm (Maybe Bool)
- maInsufficientDataActions :: Lens' MetricAlarm [Text]
- maStateReason :: Lens' MetricAlarm (Maybe Text)
- maStateReasonData :: Lens' MetricAlarm (Maybe Text)
- maDimensions :: Lens' MetricAlarm [Dimension]
- maAlarmARN :: Lens' MetricAlarm (Maybe Text)
- maAlarmActions :: Lens' MetricAlarm [Text]
- maUnit :: Lens' MetricAlarm (Maybe StandardUnit)
- maStatistic :: Lens' MetricAlarm (Maybe Statistic)
- maExtendedStatistic :: Lens' MetricAlarm (Maybe Text)
- data MetricDataQuery
- metricDataQuery :: Text -> MetricDataQuery
- mdqReturnData :: Lens' MetricDataQuery (Maybe Bool)
- mdqExpression :: Lens' MetricDataQuery (Maybe Text)
- mdqLabel :: Lens' MetricDataQuery (Maybe Text)
- mdqMetricStat :: Lens' MetricDataQuery (Maybe MetricStat)
- mdqId :: Lens' MetricDataQuery Text
- data MetricDataResult
- metricDataResult :: MetricDataResult
- mdrValues :: Lens' MetricDataResult [Double]
- mdrId :: Lens' MetricDataResult (Maybe Text)
- mdrTimestamps :: Lens' MetricDataResult [UTCTime]
- mdrMessages :: Lens' MetricDataResult [MessageData]
- mdrLabel :: Lens' MetricDataResult (Maybe Text)
- mdrStatusCode :: Lens' MetricDataResult (Maybe StatusCode)
- data MetricDatum
- metricDatum :: Text -> MetricDatum
- mdValue :: Lens' MetricDatum (Maybe Double)
- mdStorageResolution :: Lens' MetricDatum (Maybe Natural)
- mdDimensions :: Lens' MetricDatum [Dimension]
- mdUnit :: Lens' MetricDatum (Maybe StandardUnit)
- mdTimestamp :: Lens' MetricDatum (Maybe UTCTime)
- mdStatisticValues :: Lens' MetricDatum (Maybe StatisticSet)
- mdMetricName :: Lens' MetricDatum Text
- data MetricStat
- metricStat :: Metric -> Natural -> Text -> MetricStat
- msUnit :: Lens' MetricStat (Maybe StandardUnit)
- msMetric :: Lens' MetricStat Metric
- msPeriod :: Lens' MetricStat Natural
- msStat :: Lens' MetricStat Text
- data StatisticSet
- statisticSet :: Double -> Double -> Double -> Double -> StatisticSet
- ssSampleCount :: Lens' StatisticSet Double
- ssSum :: Lens' StatisticSet Double
- ssMinimum :: Lens' StatisticSet Double
- ssMaximum :: Lens' StatisticSet Double
Service Configuration
cloudWatch :: Service Source #
API version 2010-08-01 of the Amazon CloudWatch SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CloudWatch.
LimitExceededFault
_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota for alarms for this customer has already been reached.
DashboardNotFoundError
_DashboardNotFoundError :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified dashboard does not exist.
InvalidNextToken
_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The next token specified is invalid.
InternalServiceFault
_InternalServiceFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request processing has failed due to some unknown error, exception, or failure.
DashboardInvalidInputError
_DashboardInvalidInputError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Some part of the dashboard data is invalid.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of an input parameter is bad or out-of-range.
InvalidFormatFault
_InvalidFormatFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Data was not syntactically valid JSON.
MissingRequiredParameterException
_MissingRequiredParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An input parameter that is required is missing.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Parameters were used together that cannot be used together.
ResourceNotFound
_ResourceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The named resource does not exist.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
AlarmExists
alarmExists :: Wait DescribeAlarms Source #
Polls DescribeAlarms every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
EnableAlarmActions
GetDashboard
GetMetricData
PutMetricData
ListDashboards (Paginated)
DescribeAlarms (Paginated)
ListMetrics (Paginated)
DeleteDashboards
DeleteAlarms
DescribeAlarmHistory (Paginated)
GetMetricStatistics
DescribeAlarmsForMetric
DisableAlarmActions
PutDashboard
PutMetricAlarm
SetAlarmState
Types
ComparisonOperator
data ComparisonOperator Source #
Constructors
| GreaterThanOrEqualToThreshold | |
| GreaterThanThreshold | |
| LessThanOrEqualToThreshold | |
| LessThanThreshold |
Instances
HistoryItemType
data HistoryItemType Source #
Constructors
| Action | |
| ConfigurationUpdate | |
| StateUpdate |
Instances
ScanBy
Constructors
| TimestampAscending | |
| TimestampDescending |
Instances
StandardUnit
data StandardUnit Source #
Constructors
Instances
StateValue
data StateValue Source #
Constructors
| Alarm | |
| InsufficientData | |
| OK |
Instances
Statistic
Constructors
| Average | |
| Maximum | |
| Minimum | |
| SampleCount | |
| Sum |
Instances
StatusCode
data StatusCode Source #
Constructors
| Complete | |
| InternalError | |
| PartialData |
Instances
AlarmHistoryItem
data AlarmHistoryItem Source #
Represents the history of a specific alarm.
See: alarmHistoryItem smart constructor.
Instances
alarmHistoryItem :: AlarmHistoryItem Source #
Creates a value of AlarmHistoryItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ahiAlarmName- The descriptive name for the alarm.ahiHistoryItemType- The type of alarm history item.ahiHistoryData- Data about the alarm, in JSON format.ahiHistorySummary- A summary of the alarm history, in text format.ahiTimestamp- The time stamp for the alarm history item.
ahiAlarmName :: Lens' AlarmHistoryItem (Maybe Text) Source #
The descriptive name for the alarm.
ahiHistoryItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType) Source #
The type of alarm history item.
ahiHistoryData :: Lens' AlarmHistoryItem (Maybe Text) Source #
Data about the alarm, in JSON format.
ahiHistorySummary :: Lens' AlarmHistoryItem (Maybe Text) Source #
A summary of the alarm history, in text format.
ahiTimestamp :: Lens' AlarmHistoryItem (Maybe UTCTime) Source #
The time stamp for the alarm history item.
DashboardEntry
data DashboardEntry Source #
Represents a specific dashboard.
See: dashboardEntry smart constructor.
Instances
dashboardEntry :: DashboardEntry Source #
Creates a value of DashboardEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deSize- The size of the dashboard, in bytes.deDashboardName- The name of the dashboard.deLastModified- 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.deDashboardARN- The Amazon Resource Name (ARN) of the dashboard.
deDashboardName :: Lens' DashboardEntry (Maybe Text) Source #
The name of the dashboard.
deLastModified :: 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.
deDashboardARN :: 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: dashboardValidationMessage smart constructor.
Instances
dashboardValidationMessage :: DashboardValidationMessage Source #
Creates a value of DashboardValidationMessage with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvmDataPath- The data path related to the message.dvmMessage- A message describing the error or warning.
dvmDataPath :: Lens' DashboardValidationMessage (Maybe Text) Source #
The data path related to the message.
dvmMessage :: Lens' DashboardValidationMessage (Maybe Text) Source #
A message describing the error or warning.
Datapoint
Encapsulates the statistical data that CloudWatch computes from metric data.
See: datapoint smart constructor.
Instances
datapoint :: Datapoint Source #
Creates a value of Datapoint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dSampleCount- The number of metric values that contributed to the aggregate value of this data point.dMaximum- The maximum metric value for the data point.dAverage- The average of the metric values that correspond to the data point.dMinimum- The minimum metric value for the data point.dExtendedStatistics- The percentile statistic for the data point.dSum- The sum of the metric values for the data point.dUnit- The standard unit for the data point.dTimestamp- The time stamp used for the data point.
dSampleCount :: Lens' Datapoint (Maybe Double) Source #
The number of metric values that contributed to the aggregate value of this data point.
dAverage :: Lens' Datapoint (Maybe Double) Source #
The average of the metric values that correspond to the data point.
dExtendedStatistics :: Lens' Datapoint (HashMap Text Double) Source #
The percentile statistic for the data point.
Dimension
Expands the identity of a metric.
See: dimension smart constructor.
Instances
DimensionFilter
data DimensionFilter Source #
Represents filters for a dimension.
See: dimensionFilter smart constructor.
Instances
Arguments
| :: Text | |
| -> DimensionFilter |
Creates a value of DimensionFilter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
MessageData
data MessageData Source #
A message returned by the GetMetricData API, including a code and a description.
See: messageData smart constructor.
Instances
messageData :: MessageData Source #
Creates a value of MessageData with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mCode :: Lens' MessageData (Maybe Text) Source #
The error code or status code associated with the message.
Metric
Represents a specific metric.
See: metric smart constructor.
Instances
| Eq Metric Source # | |
| Data Metric Source # | |
Defined in Network.AWS.CloudWatch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Metric -> c Metric # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Metric # toConstr :: Metric -> Constr # dataTypeOf :: Metric -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Metric) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Metric) # gmapT :: (forall b. Data b => b -> b) -> Metric -> Metric # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Metric -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Metric -> r # gmapQ :: (forall d. Data d => d -> u) -> Metric -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Metric -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Metric -> m Metric # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Metric -> m Metric # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Metric -> m Metric # | |
| Read Metric Source # | |
| Show Metric Source # | |
| Generic Metric Source # | |
| Hashable Metric Source # | |
Defined in Network.AWS.CloudWatch.Types.Product | |
| FromXML Metric Source # | |
| ToQuery Metric Source # | |
Defined in Network.AWS.CloudWatch.Types.Product Methods toQuery :: Metric -> QueryString # | |
| NFData Metric Source # | |
Defined in Network.AWS.CloudWatch.Types.Product | |
| type Rep Metric Source # | |
Defined in Network.AWS.CloudWatch.Types.Product type Rep Metric = D1 (MetaData "Metric" "Network.AWS.CloudWatch.Types.Product" "amazonka-cloudwatch-1.6.1-7Rnwowqga1k8zXg3cAhS87" False) (C1 (MetaCons "Metric'" PrefixI True) (S1 (MetaSel (Just "_mMetricName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Dimension]))))) | |
Creates a value of Metric with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMetricName- The name of the metric.mNamespace- The namespace of the metric.mDimensions- The dimensions for the metric.
MetricAlarm
data MetricAlarm Source #
Represents an alarm.
See: metricAlarm smart constructor.
Instances
metricAlarm :: MetricAlarm Source #
Creates a value of MetricAlarm with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
maAlarmName- The name of the alarm.maStateUpdatedTimestamp- The time stamp of the last update to the alarm state.maTreatMissingData- Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior ofmissingis used.maPeriod- The period, in seconds, over which the statistic is applied.maAlarmDescription- The description of the alarm.maEvaluationPeriods- The number of periods over which data is compared to the specified threshold.maMetricName- The name of the metric associated with the alarm.maNamespace- The namespace of the metric associated with the alarm.maComparisonOperator- The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.maOKActions- The actions to execute when this alarm transitions to theOKstate from any other state. Each action is specified as an Amazon Resource Name (ARN).maEvaluateLowSampleCountPercentile- Used only for alarms based on percentiles. Ifignore, the alarm state does not change during periods with too few data points to be statistically significant. Ifevaluateor this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.maStateValue- The state value for the alarm.maDatapointsToAlarm- The number of datapoints that must be breaching to trigger the alarm.maThreshold- The value to compare with the specified statistic.maAlarmConfigurationUpdatedTimestamp- The time stamp of the last update to the alarm configuration.maActionsEnabled- Indicates whether actions should be executed during any changes to the alarm state.maInsufficientDataActions- The actions to execute when this alarm transitions to theINSUFFICIENT_DATAstate from any other state. Each action is specified as an Amazon Resource Name (ARN).maStateReason- An explanation for the alarm state, in text format.maStateReasonData- An explanation for the alarm state, in JSON format.maDimensions- The dimensions for the metric associated with the alarm.maAlarmARN- The Amazon Resource Name (ARN) of the alarm.maAlarmActions- The actions to execute when this alarm transitions to theALARMstate from any other state. Each action is specified as an Amazon Resource Name (ARN).maUnit- The unit of the metric associated with the alarm.maStatistic- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, useExtendedStatistic.maExtendedStatistic- The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
maAlarmName :: Lens' MetricAlarm (Maybe Text) Source #
The name of the alarm.
maStateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm state.
maTreatMissingData :: 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.
maPeriod :: Lens' MetricAlarm (Maybe Natural) Source #
The period, in seconds, over which the statistic is applied.
maAlarmDescription :: Lens' MetricAlarm (Maybe Text) Source #
The description of the alarm.
maEvaluationPeriods :: Lens' MetricAlarm (Maybe Natural) Source #
The number of periods over which data is compared to the specified threshold.
maMetricName :: Lens' MetricAlarm (Maybe Text) Source #
The name of the metric associated with the alarm.
maNamespace :: Lens' MetricAlarm (Maybe Text) Source #
The namespace of the metric associated with the alarm.
maComparisonOperator :: 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.
maOKActions :: Lens' MetricAlarm [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).
maEvaluateLowSampleCountPercentile :: 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.
maStateValue :: Lens' MetricAlarm (Maybe StateValue) Source #
The state value for the alarm.
maDatapointsToAlarm :: Lens' MetricAlarm (Maybe Natural) Source #
The number of datapoints that must be breaching to trigger the alarm.
maThreshold :: Lens' MetricAlarm (Maybe Double) Source #
The value to compare with the specified statistic.
maAlarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm configuration.
maActionsEnabled :: Lens' MetricAlarm (Maybe Bool) Source #
Indicates whether actions should be executed during any changes to the alarm state.
maInsufficientDataActions :: Lens' MetricAlarm [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).
maStateReason :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in text format.
maStateReasonData :: Lens' MetricAlarm (Maybe Text) Source #
An explanation for the alarm state, in JSON format.
maDimensions :: Lens' MetricAlarm [Dimension] Source #
The dimensions for the metric associated with the alarm.
maAlarmARN :: Lens' MetricAlarm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the alarm.
maAlarmActions :: Lens' MetricAlarm [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).
maUnit :: Lens' MetricAlarm (Maybe StandardUnit) Source #
The unit of the metric associated with the alarm.
maStatistic :: Lens' MetricAlarm (Maybe Statistic) Source #
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .
maExtendedStatistic :: 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 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 100 MetricDataQuery structures.
See: metricDataQuery smart constructor.
Instances
Arguments
| :: Text | |
| -> MetricDataQuery |
Creates a value of MetricDataQuery with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdqReturnData- Indicates whether to return the time stamps 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 specifyFalse. If you omit this, the default ofTrueis used.mdqExpression- The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide . Within one MetricDataQuery structure, you must specify eitherExpressionorMetricStatbut not both.mdqLabel- 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.mdqMetricStat- The metric to be returned, along with statistics, period, and units. Use this parameter only if this structure is performing a data retrieval and not performing a math expression on the returned data. Within one MetricDataQuery structure, you must specify eitherExpressionorMetricStatbut not both.mdqId- A short name used to tie this structure to the results in the response. This name must be unique within a single call toGetMetricData. 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.
mdqReturnData :: Lens' MetricDataQuery (Maybe Bool) Source #
Indicates whether to return the time stamps 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.
mdqExpression :: Lens' MetricDataQuery (Maybe Text) Source #
The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide . Within one MetricDataQuery structure, you must specify either Expression or MetricStat but not both.
mdqLabel :: 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.
mdqMetricStat :: Lens' MetricDataQuery (Maybe MetricStat) Source #
The metric to be returned, along with statistics, period, and units. Use this parameter only if this structure is performing a data retrieval and not performing a math expression on the returned data. Within one MetricDataQuery structure, you must specify either Expression or MetricStat but not both.
mdqId :: Lens' MetricDataQuery Text Source #
A short name used to tie this structure 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 time stamps of those data points and other identifying information.
See: metricDataResult smart constructor.
Instances
metricDataResult :: MetricDataResult Source #
Creates a value of MetricDataResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdrValues- The data points for the metric corresponding toTimestamps. The number of values always matches the number of time stamps and the time stamp for Values[x] is Timestamps[x].mdrId- The short name you specified to represent this metric.mdrTimestamps- The time stamps for the data points, formatted in Unix timestamp format. The number of time stamps always matches the number of values and the value for Timestamps[x] is Values[x].mdrMessages- A list of messages with additional information about the data returned.mdrLabel- The human-readable label associated with the data.mdrStatusCode- The status of the returned data.Completeindicates that all data points in the requested time range were returned.PartialDatameans that an incomplete set of data points were returned. You can use theNextTokenvalue that was returned and repeat your request to get more data points.NextTokenis not returned if you are performing a math expression.InternalErrorindicates that an error occurred. Retry your request usingNextToken, if present.
mdrValues :: Lens' MetricDataResult [Double] Source #
The data points for the metric corresponding to Timestamps . The number of values always matches the number of time stamps and the time stamp for Values[x] is Timestamps[x].
mdrId :: Lens' MetricDataResult (Maybe Text) Source #
The short name you specified to represent this metric.
mdrTimestamps :: Lens' MetricDataResult [UTCTime] Source #
The time stamps for the data points, formatted in Unix timestamp format. The number of time stamps always matches the number of values and the value for Timestamps[x] is Values[x].
mdrMessages :: Lens' MetricDataResult [MessageData] Source #
A list of messages with additional information about the data returned.
mdrLabel :: Lens' MetricDataResult (Maybe Text) Source #
The human-readable label associated with the data.
mdrStatusCode :: 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: metricDatum smart constructor.
Instances
Arguments
| :: Text | |
| -> MetricDatum |
Creates a value of MetricDatum with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdValue- 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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.mdStorageResolution- 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.mdDimensions- The dimensions associated with the metric.mdUnit- The unit of the metric.mdTimestamp- The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.mdStatisticValues- The statistical values for the metric.mdMetricName- The name of the metric.
mdValue :: 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 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
mdStorageResolution :: 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.
mdDimensions :: Lens' MetricDatum [Dimension] Source #
The dimensions associated with the metric.
mdUnit :: Lens' MetricDatum (Maybe StandardUnit) Source #
The unit of the metric.
mdTimestamp :: 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.
mdStatisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source #
The statistical values for the metric.
mdMetricName :: 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: metricStat smart constructor.
Instances
Creates a value of MetricStat with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
msUnit :: Lens' MetricStat (Maybe StandardUnit) Source #
The unit to use for the returned data points.
msMetric :: Lens' MetricStat Metric Source #
The metric to return, including the metric name, namespace, and dimensions.
msStat :: Lens' MetricStat Text Source #
The statistic to return. It can include any CloudWatch statistic or extended statistic.
StatisticSet
data StatisticSet Source #
Represents a set of statistics that describes a specific metric.
See: statisticSet smart constructor.
Instances
Arguments
| :: Double | |
| -> Double | |
| -> Double | |
| -> Double | |
| -> StatisticSet |
Creates a value of StatisticSet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssSampleCount- The number of samples used for the statistic set.ssSum- The sum of values for the sample set.ssMinimum- The minimum value of the sample set.ssMaximum- The maximum value of the sample set.
ssSampleCount :: Lens' StatisticSet Double Source #
The number of samples used for the statistic set.