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 |
- Service Configuration
- Errors
- LimitExceededFault
- DashboardNotFoundError
- InvalidNextToken
- InternalServiceFault
- DashboardInvalidInputError
- InvalidParameterValueException
- ConcurrentModificationException
- InvalidFormatFault
- MissingRequiredParameterException
- ResourceNotFoundException
- InvalidParameterCombinationException
- LimitExceededException
- ResourceNotFound
- Waiters
- Operations
- EnableAlarmActions
- DisableInsightRules
- PutCompositeAlarm
- DeleteAnomalyDetector
- DeleteInsightRules
- GetDashboard
- PutAnomalyDetector
- ListTagsForResource
- GetMetricData (Paginated)
- PutMetricData
- ListDashboards (Paginated)
- DescribeAlarms (Paginated)
- ListMetrics (Paginated)
- GetInsightRuleReport
- StartMetricStreams
- DeleteDashboards
- PutInsightRule
- ListMetricStreams
- GetMetricWidgetImage
- DeleteMetricStream
- DeleteAlarms
- PutMetricStream
- DescribeAlarmHistory (Paginated)
- GetMetricStatistics
- DescribeAlarmsForMetric
- EnableInsightRules
- DisableAlarmActions
- DescribeAnomalyDetectors
- PutDashboard
- TagResource
- StopMetricStreams
- UntagResource
- GetMetricStream
- PutMetricAlarm
- SetAlarmState
- DescribeInsightRules
- Types
- 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
Derived from API version 2010-08-01
of the AWS service descriptions, licensed under Apache 2.0.
Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
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
- newCompositeAlarmExists :: Wait DescribeAlarms
- newAlarmExists :: Wait DescribeAlarms
- data EnableAlarmActions = EnableAlarmActions' [Text]
- newEnableAlarmActions :: EnableAlarmActions
- data EnableAlarmActionsResponse = EnableAlarmActionsResponse' {
- newEnableAlarmActionsResponse :: EnableAlarmActionsResponse
- data DisableInsightRules = DisableInsightRules' [Text]
- newDisableInsightRules :: DisableInsightRules
- data DisableInsightRulesResponse = DisableInsightRulesResponse' (Maybe [PartialFailure]) Int
- newDisableInsightRulesResponse :: Int -> DisableInsightRulesResponse
- data PutCompositeAlarm = PutCompositeAlarm' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text
- newPutCompositeAlarm :: Text -> Text -> PutCompositeAlarm
- data PutCompositeAlarmResponse = PutCompositeAlarmResponse' {
- newPutCompositeAlarmResponse :: PutCompositeAlarmResponse
- data DeleteAnomalyDetector = DeleteAnomalyDetector' (Maybe [Dimension]) Text Text Text
- newDeleteAnomalyDetector :: Text -> Text -> Text -> DeleteAnomalyDetector
- data DeleteAnomalyDetectorResponse = DeleteAnomalyDetectorResponse' Int
- newDeleteAnomalyDetectorResponse :: Int -> DeleteAnomalyDetectorResponse
- data DeleteInsightRules = DeleteInsightRules' [Text]
- newDeleteInsightRules :: DeleteInsightRules
- data DeleteInsightRulesResponse = DeleteInsightRulesResponse' (Maybe [PartialFailure]) Int
- newDeleteInsightRulesResponse :: Int -> DeleteInsightRulesResponse
- data GetDashboard = GetDashboard' Text
- newGetDashboard :: Text -> GetDashboard
- data GetDashboardResponse = GetDashboardResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetDashboardResponse :: Int -> GetDashboardResponse
- data PutAnomalyDetector = PutAnomalyDetector' (Maybe AnomalyDetectorConfiguration) (Maybe [Dimension]) Text Text Text
- newPutAnomalyDetector :: Text -> Text -> Text -> PutAnomalyDetector
- data PutAnomalyDetectorResponse = PutAnomalyDetectorResponse' Int
- newPutAnomalyDetectorResponse :: Int -> PutAnomalyDetectorResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data GetMetricData = GetMetricData' (Maybe Int) (Maybe LabelOptions) (Maybe Text) (Maybe ScanBy) [MetricDataQuery] ISO8601 ISO8601
- newGetMetricData :: UTCTime -> UTCTime -> GetMetricData
- data GetMetricDataResponse = GetMetricDataResponse' (Maybe [MetricDataResult]) (Maybe Text) (Maybe [MessageData]) Int
- newGetMetricDataResponse :: Int -> GetMetricDataResponse
- data PutMetricData = PutMetricData' Text [MetricDatum]
- newPutMetricData :: Text -> PutMetricData
- data PutMetricDataResponse = PutMetricDataResponse' {
- newPutMetricDataResponse :: PutMetricDataResponse
- data ListDashboards = ListDashboards' (Maybe Text) (Maybe Text)
- newListDashboards :: ListDashboards
- data ListDashboardsResponse = ListDashboardsResponse' (Maybe [DashboardEntry]) (Maybe Text) Int
- newListDashboardsResponse :: Int -> ListDashboardsResponse
- data DescribeAlarms = DescribeAlarms' (Maybe Text) (Maybe [AlarmType]) (Maybe Text) (Maybe Text) (Maybe StateValue) (Maybe [Text]) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeAlarms :: DescribeAlarms
- data DescribeAlarmsResponse = DescribeAlarmsResponse' (Maybe [MetricAlarm]) (Maybe [CompositeAlarm]) (Maybe Text) Int
- newDescribeAlarmsResponse :: Int -> DescribeAlarmsResponse
- data ListMetrics = ListMetrics' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecentlyActive) (Maybe [DimensionFilter])
- newListMetrics :: ListMetrics
- data ListMetricsResponse = ListMetricsResponse' (Maybe [Metric]) (Maybe Text) Int
- newListMetricsResponse :: Int -> ListMetricsResponse
- data GetInsightRuleReport = GetInsightRuleReport' (Maybe Int) (Maybe [Text]) (Maybe Text) Text ISO8601 ISO8601 Natural
- newGetInsightRuleReport :: Text -> UTCTime -> UTCTime -> Natural -> GetInsightRuleReport
- data GetInsightRuleReportResponse = GetInsightRuleReportResponse' (Maybe [Text]) (Maybe Integer) (Maybe Text) (Maybe Double) (Maybe [InsightRuleContributor]) (Maybe [InsightRuleMetricDatapoint]) Int
- newGetInsightRuleReportResponse :: Int -> GetInsightRuleReportResponse
- data StartMetricStreams = StartMetricStreams' [Text]
- newStartMetricStreams :: StartMetricStreams
- data StartMetricStreamsResponse = StartMetricStreamsResponse' Int
- newStartMetricStreamsResponse :: Int -> StartMetricStreamsResponse
- data DeleteDashboards = DeleteDashboards' [Text]
- newDeleteDashboards :: DeleteDashboards
- data DeleteDashboardsResponse = DeleteDashboardsResponse' Int
- newDeleteDashboardsResponse :: Int -> DeleteDashboardsResponse
- data PutInsightRule = PutInsightRule' (Maybe [Tag]) (Maybe Text) Text Text
- newPutInsightRule :: Text -> Text -> PutInsightRule
- data PutInsightRuleResponse = PutInsightRuleResponse' Int
- newPutInsightRuleResponse :: Int -> PutInsightRuleResponse
- data ListMetricStreams = ListMetricStreams' (Maybe Text) (Maybe Natural)
- newListMetricStreams :: ListMetricStreams
- data ListMetricStreamsResponse = ListMetricStreamsResponse' (Maybe [MetricStreamEntry]) (Maybe Text) Int
- newListMetricStreamsResponse :: Int -> ListMetricStreamsResponse
- data GetMetricWidgetImage = GetMetricWidgetImage' (Maybe Text) Text
- newGetMetricWidgetImage :: Text -> GetMetricWidgetImage
- data GetMetricWidgetImageResponse = GetMetricWidgetImageResponse' (Maybe Base64) Int
- newGetMetricWidgetImageResponse :: Int -> GetMetricWidgetImageResponse
- data DeleteMetricStream = DeleteMetricStream' Text
- newDeleteMetricStream :: Text -> DeleteMetricStream
- data DeleteMetricStreamResponse = DeleteMetricStreamResponse' Int
- newDeleteMetricStreamResponse :: Int -> DeleteMetricStreamResponse
- data DeleteAlarms = DeleteAlarms' [Text]
- newDeleteAlarms :: DeleteAlarms
- data DeleteAlarmsResponse = DeleteAlarmsResponse' {
- newDeleteAlarmsResponse :: DeleteAlarmsResponse
- data PutMetricStream = PutMetricStream' (Maybe [MetricStreamFilter]) (Maybe [MetricStreamFilter]) (Maybe [Tag]) Text Text Text MetricStreamOutputFormat
- newPutMetricStream :: Text -> Text -> Text -> MetricStreamOutputFormat -> PutMetricStream
- data PutMetricStreamResponse = PutMetricStreamResponse' (Maybe Text) Int
- newPutMetricStreamResponse :: Int -> PutMetricStreamResponse
- data DescribeAlarmHistory = DescribeAlarmHistory' (Maybe Text) (Maybe HistoryItemType) (Maybe [AlarmType]) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe ScanBy) (Maybe Natural)
- newDescribeAlarmHistory :: DescribeAlarmHistory
- data DescribeAlarmHistoryResponse = DescribeAlarmHistoryResponse' (Maybe [AlarmHistoryItem]) (Maybe Text) Int
- newDescribeAlarmHistoryResponse :: Int -> DescribeAlarmHistoryResponse
- data GetMetricStatistics = GetMetricStatistics' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Statistic)) (Maybe [Dimension]) (Maybe StandardUnit) Text Text ISO8601 ISO8601 Natural
- newGetMetricStatistics :: Text -> Text -> UTCTime -> UTCTime -> Natural -> GetMetricStatistics
- data GetMetricStatisticsResponse = GetMetricStatisticsResponse' (Maybe [Datapoint]) (Maybe Text) Int
- newGetMetricStatisticsResponse :: Int -> GetMetricStatisticsResponse
- data DescribeAlarmsForMetric = DescribeAlarmsForMetric' (Maybe Natural) (Maybe [Dimension]) (Maybe StandardUnit) (Maybe Statistic) (Maybe Text) Text Text
- newDescribeAlarmsForMetric :: Text -> Text -> DescribeAlarmsForMetric
- data DescribeAlarmsForMetricResponse = DescribeAlarmsForMetricResponse' (Maybe [MetricAlarm]) Int
- newDescribeAlarmsForMetricResponse :: Int -> DescribeAlarmsForMetricResponse
- data EnableInsightRules = EnableInsightRules' [Text]
- newEnableInsightRules :: EnableInsightRules
- data EnableInsightRulesResponse = EnableInsightRulesResponse' (Maybe [PartialFailure]) Int
- newEnableInsightRulesResponse :: Int -> EnableInsightRulesResponse
- data DisableAlarmActions = DisableAlarmActions' [Text]
- newDisableAlarmActions :: DisableAlarmActions
- data DisableAlarmActionsResponse = DisableAlarmActionsResponse' {
- newDisableAlarmActionsResponse :: DisableAlarmActionsResponse
- data DescribeAnomalyDetectors = DescribeAnomalyDetectors' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Dimension]) (Maybe Natural)
- newDescribeAnomalyDetectors :: DescribeAnomalyDetectors
- data DescribeAnomalyDetectorsResponse = DescribeAnomalyDetectorsResponse' (Maybe [AnomalyDetector]) (Maybe Text) Int
- newDescribeAnomalyDetectorsResponse :: Int -> DescribeAnomalyDetectorsResponse
- data PutDashboard = PutDashboard' Text Text
- newPutDashboard :: Text -> Text -> PutDashboard
- data PutDashboardResponse = PutDashboardResponse' (Maybe [DashboardValidationMessage]) Int
- newPutDashboardResponse :: Int -> PutDashboardResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data StopMetricStreams = StopMetricStreams' [Text]
- newStopMetricStreams :: StopMetricStreams
- data StopMetricStreamsResponse = StopMetricStreamsResponse' Int
- newStopMetricStreamsResponse :: Int -> StopMetricStreamsResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data GetMetricStream = GetMetricStream' Text
- newGetMetricStream :: Text -> GetMetricStream
- data GetMetricStreamResponse = GetMetricStreamResponse' (Maybe [MetricStreamFilter]) (Maybe Text) (Maybe [MetricStreamFilter]) (Maybe Text) (Maybe Text) (Maybe MetricStreamOutputFormat) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) Int
- newGetMetricStreamResponse :: Int -> GetMetricStreamResponse
- data PutMetricAlarm = PutMetricAlarm' (Maybe [MetricDataQuery]) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe Bool) (Maybe [Text]) (Maybe [Dimension]) (Maybe [Text]) (Maybe StandardUnit) (Maybe Statistic) (Maybe [Tag]) (Maybe Text) Text Natural ComparisonOperator
- newPutMetricAlarm :: Text -> Natural -> ComparisonOperator -> PutMetricAlarm
- data PutMetricAlarmResponse = PutMetricAlarmResponse' {
- newPutMetricAlarmResponse :: PutMetricAlarmResponse
- data SetAlarmState = SetAlarmState' (Maybe Text) Text StateValue Text
- newSetAlarmState :: Text -> StateValue -> Text -> SetAlarmState
- data SetAlarmStateResponse = SetAlarmStateResponse' {
- newSetAlarmStateResponse :: SetAlarmStateResponse
- data DescribeInsightRules = DescribeInsightRules' (Maybe Text) (Maybe Natural)
- newDescribeInsightRules :: DescribeInsightRules
- data DescribeInsightRulesResponse = DescribeInsightRulesResponse' (Maybe Text) (Maybe [InsightRule]) Int
- newDescribeInsightRulesResponse :: Int -> DescribeInsightRulesResponse
- 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' (Maybe Text) (Maybe HistoryItemType) (Maybe Text) (Maybe AlarmType) (Maybe Text) (Maybe ISO8601)
- newAlarmHistoryItem :: AlarmHistoryItem
- data AnomalyDetector = AnomalyDetector' (Maybe Text) (Maybe Text) (Maybe AnomalyDetectorStateValue) (Maybe Text) (Maybe AnomalyDetectorConfiguration) (Maybe [Dimension])
- newAnomalyDetector :: AnomalyDetector
- data AnomalyDetectorConfiguration = AnomalyDetectorConfiguration' (Maybe Text) (Maybe [Range])
- newAnomalyDetectorConfiguration :: AnomalyDetectorConfiguration
- data CompositeAlarm = CompositeAlarm' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe StateValue) (Maybe ISO8601) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newCompositeAlarm :: CompositeAlarm
- data DashboardEntry = DashboardEntry' (Maybe Integer) (Maybe Text) (Maybe ISO8601) (Maybe Text)
- newDashboardEntry :: DashboardEntry
- data DashboardValidationMessage = DashboardValidationMessage' (Maybe Text) (Maybe Text)
- newDashboardValidationMessage :: DashboardValidationMessage
- data Datapoint = Datapoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe (HashMap Text Double)) (Maybe Double) (Maybe StandardUnit) (Maybe ISO8601)
- newDatapoint :: Datapoint
- data Dimension = Dimension' Text Text
- newDimension :: Text -> Text -> Dimension
- data DimensionFilter = DimensionFilter' (Maybe Text) Text
- newDimensionFilter :: Text -> DimensionFilter
- data InsightRule = InsightRule' Text Text Text Text
- newInsightRule :: Text -> Text -> Text -> Text -> InsightRule
- data InsightRuleContributor = InsightRuleContributor' [Text] Double [InsightRuleContributorDatapoint]
- newInsightRuleContributor :: Double -> InsightRuleContributor
- data InsightRuleContributorDatapoint = InsightRuleContributorDatapoint' ISO8601 Double
- newInsightRuleContributorDatapoint :: UTCTime -> Double -> InsightRuleContributorDatapoint
- data InsightRuleMetricDatapoint = InsightRuleMetricDatapoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) ISO8601
- newInsightRuleMetricDatapoint :: UTCTime -> InsightRuleMetricDatapoint
- data LabelOptions = LabelOptions' (Maybe Text)
- newLabelOptions :: LabelOptions
- data MessageData = MessageData' (Maybe Text) (Maybe Text)
- newMessageData :: MessageData
- data Metric = Metric' (Maybe Text) (Maybe Text) (Maybe [Dimension])
- newMetric :: Metric
- data MetricAlarm = MetricAlarm' (Maybe Text) (Maybe ISO8601) (Maybe [MetricDataQuery]) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ComparisonOperator) (Maybe [Text]) (Maybe Text) (Maybe StateValue) (Maybe Natural) (Maybe Double) (Maybe ISO8601) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Dimension]) (Maybe Text) (Maybe [Text]) (Maybe StandardUnit) (Maybe Statistic) (Maybe Text)
- newMetricAlarm :: MetricAlarm
- data MetricDataQuery = MetricDataQuery' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MetricStat) Text
- newMetricDataQuery :: Text -> MetricDataQuery
- data MetricDataResult = MetricDataResult' (Maybe [Double]) (Maybe Text) (Maybe [ISO8601]) (Maybe [MessageData]) (Maybe Text) (Maybe StatusCode)
- newMetricDataResult :: MetricDataResult
- data MetricDatum = MetricDatum' (Maybe [Double]) (Maybe [Double]) (Maybe Double) (Maybe Natural) (Maybe [Dimension]) (Maybe StandardUnit) (Maybe ISO8601) (Maybe StatisticSet) Text
- newMetricDatum :: Text -> MetricDatum
- data MetricStat = MetricStat' (Maybe StandardUnit) Metric Natural Text
- newMetricStat :: Metric -> Natural -> Text -> MetricStat
- data MetricStreamEntry = MetricStreamEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MetricStreamOutputFormat) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601)
- newMetricStreamEntry :: MetricStreamEntry
- data MetricStreamFilter = MetricStreamFilter' (Maybe Text)
- newMetricStreamFilter :: MetricStreamFilter
- data PartialFailure = PartialFailure' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPartialFailure :: PartialFailure
- data Range = Range' ISO8601 ISO8601
- newRange :: UTCTime -> UTCTime -> Range
- data StatisticSet = StatisticSet' Double Double Double Double
- newStatisticSet :: Double -> Double -> Double -> Double -> StatisticSet
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: 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.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
More than one process tried to modify a resource at the same time.
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.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The named resource does not exist.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Parameters were used together that cannot be used together.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation exceeded one or more limits.
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.
CompositeAlarmExists
newCompositeAlarmExists :: Wait DescribeAlarms Source #
Polls DescribeAlarms
every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
AlarmExists
newAlarmExists :: 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
data EnableAlarmActions Source #
See: newEnableAlarmActions
smart constructor.
Instances
newEnableAlarmActions :: EnableAlarmActions Source #
Create a value of EnableAlarmActions
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:alarmNames:EnableAlarmActions'
, enableAlarmActions_alarmNames
- The names of the alarms.
data EnableAlarmActionsResponse Source #
See: newEnableAlarmActionsResponse
smart constructor.
Instances
newEnableAlarmActionsResponse :: EnableAlarmActionsResponse Source #
Create a value of EnableAlarmActionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisableInsightRules
data DisableInsightRules Source #
See: newDisableInsightRules
smart constructor.
Instances
newDisableInsightRules :: DisableInsightRules Source #
Create a value of DisableInsightRules
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:ruleNames:DisableInsightRules'
, disableInsightRules_ruleNames
- An array of the rule names to disable. If you need to find out the names
of your rules, use
DescribeInsightRules.
data DisableInsightRulesResponse Source #
See: newDisableInsightRulesResponse
smart constructor.
Instances
newDisableInsightRulesResponse Source #
Create a value of DisableInsightRulesResponse
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:failures:DisableInsightRulesResponse'
, disableInsightRulesResponse_failures
- An array listing the rules that could not be disabled. You cannot
disable built-in rules.
$sel:httpStatus:DisableInsightRulesResponse'
, disableInsightRulesResponse_httpStatus
- The response's http status code.
PutCompositeAlarm
data PutCompositeAlarm Source #
See: newPutCompositeAlarm
smart constructor.
PutCompositeAlarm' (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text |
Instances
:: Text | |
-> Text | |
-> PutCompositeAlarm |
Create a value of PutCompositeAlarm
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:alarmDescription:PutCompositeAlarm'
, putCompositeAlarm_alarmDescription
- The description for the composite alarm.
$sel:oKActions:PutCompositeAlarm'
, putCompositeAlarm_oKActions
- The actions to execute when this alarm transitions to an OK
state from
any other state. Each action is specified as an Amazon Resource Name
(ARN).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
$sel:actionsEnabled:PutCompositeAlarm'
, putCompositeAlarm_actionsEnabled
- Indicates whether actions should be executed during any changes to the
alarm state of the composite alarm. The default is TRUE
.
$sel:insufficientDataActions:PutCompositeAlarm'
, putCompositeAlarm_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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
$sel:alarmActions:PutCompositeAlarm'
, putCompositeAlarm_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).
Valid Values: arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:ssm:region:account-id:opsitem:severity
$sel:tags:PutCompositeAlarm'
, putCompositeAlarm_tags
- A list of key-value pairs to associate with the composite alarm. You can
associate as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
$sel:alarmName:PutCompositeAlarm'
, putCompositeAlarm_alarmName
- The name for the composite alarm. This name must be unique within the
Region.
$sel:alarmRule:PutCompositeAlarm'
, putCompositeAlarm_alarmRule
- An expression that specifies which other alarms are to be evaluated to
determine this composite alarm's state. For each alarm that you
reference, you designate a function that specifies whether that alarm
needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You
can use operators (AND, OR and NOT) to combine multiple functions in a
single expression. You can use parenthesis to logically group the
functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM("alarm-name or alarm-ARN")
is TRUE if the named alarm is in ALARM state.OK("alarm-name or alarm-ARN")
is TRUE if the named alarm is in OK state.INSUFFICIENT_DATA("alarm-name or alarm-ARN")
is TRUE if the named alarm is in INSUFFICIENT_DATA state.TRUE
always evaluates to TRUE.FALSE
always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule
structure,
and for testing your alarm actions.
Alarm names specified in AlarmRule
can be surrounded with
double-quotes ("), but do not have to be.
The following are some examples of AlarmRule
:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This example reduces alarm noise during a known deployment window.(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule
can specify as many as 100 "children" alarms. The
AlarmRule
expression can have as many as 500 elements. Elements are
child alarms, TRUE or FALSE statements, and parentheses.
data PutCompositeAlarmResponse Source #
See: newPutCompositeAlarmResponse
smart constructor.
Instances
Eq PutCompositeAlarmResponse Source # | |
Read PutCompositeAlarmResponse Source # | |
Show PutCompositeAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutCompositeAlarm showsPrec :: Int -> PutCompositeAlarmResponse -> ShowS # show :: PutCompositeAlarmResponse -> String # showList :: [PutCompositeAlarmResponse] -> ShowS # | |
Generic PutCompositeAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutCompositeAlarm type Rep PutCompositeAlarmResponse :: Type -> Type # | |
NFData PutCompositeAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutCompositeAlarm rnf :: PutCompositeAlarmResponse -> () # | |
type Rep PutCompositeAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutCompositeAlarm |
newPutCompositeAlarmResponse :: PutCompositeAlarmResponse Source #
Create a value of PutCompositeAlarmResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteAnomalyDetector
data DeleteAnomalyDetector Source #
See: newDeleteAnomalyDetector
smart constructor.
Instances
newDeleteAnomalyDetector Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteAnomalyDetector |
Create a value of DeleteAnomalyDetector
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:dimensions:DeleteAnomalyDetector'
, deleteAnomalyDetector_dimensions
- The metric dimensions associated with the anomaly detection model to
delete.
$sel:namespace:DeleteAnomalyDetector'
, deleteAnomalyDetector_namespace
- The namespace associated with the anomaly detection model to delete.
$sel:metricName:DeleteAnomalyDetector'
, deleteAnomalyDetector_metricName
- The metric name associated with the anomaly detection model to delete.
$sel:stat:DeleteAnomalyDetector'
, deleteAnomalyDetector_stat
- The statistic associated with the anomaly detection model to delete.
data DeleteAnomalyDetectorResponse Source #
See: newDeleteAnomalyDetectorResponse
smart constructor.
Instances
newDeleteAnomalyDetectorResponse Source #
Create a value of DeleteAnomalyDetectorResponse
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:httpStatus:DeleteAnomalyDetectorResponse'
, deleteAnomalyDetectorResponse_httpStatus
- The response's http status code.
DeleteInsightRules
data DeleteInsightRules Source #
See: newDeleteInsightRules
smart constructor.
Instances
newDeleteInsightRules :: DeleteInsightRules Source #
Create a value of DeleteInsightRules
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:ruleNames:DeleteInsightRules'
, deleteInsightRules_ruleNames
- An array of the rule names to delete. If you need to find out the names
of your rules, use
DescribeInsightRules.
data DeleteInsightRulesResponse Source #
See: newDeleteInsightRulesResponse
smart constructor.
Instances
newDeleteInsightRulesResponse Source #
Create a value of DeleteInsightRulesResponse
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:failures:DeleteInsightRulesResponse'
, deleteInsightRulesResponse_failures
- An array listing the rules that could not be deleted. You cannot delete
built-in rules.
$sel:httpStatus:DeleteInsightRulesResponse'
, deleteInsightRulesResponse_httpStatus
- The response's http status code.
GetDashboard
data GetDashboard Source #
See: newGetDashboard
smart constructor.
Instances
Create a value of GetDashboard
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:dashboardName:GetDashboard'
, getDashboard_dashboardName
- The name of the dashboard to be described.
data GetDashboardResponse Source #
See: newGetDashboardResponse
smart constructor.
Instances
newGetDashboardResponse Source #
Create a value of GetDashboardResponse
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:dashboardName:GetDashboard'
, getDashboardResponse_dashboardName
- The name of the dashboard.
$sel:dashboardBody:GetDashboardResponse'
, getDashboardResponse_dashboardBody
- The detailed information about the dashboard, including what widgets are
included and their location on the dashboard. For more information about
the DashboardBody
syntax, see
Dashboard Body Structure and Syntax.
$sel:dashboardArn:GetDashboardResponse'
, getDashboardResponse_dashboardArn
- The Amazon Resource Name (ARN) of the dashboard.
$sel:httpStatus:GetDashboardResponse'
, getDashboardResponse_httpStatus
- The response's http status code.
PutAnomalyDetector
data PutAnomalyDetector Source #
See: newPutAnomalyDetector
smart constructor.
Instances
newPutAnomalyDetector Source #
:: Text | |
-> Text | |
-> Text | |
-> PutAnomalyDetector |
Create a value of PutAnomalyDetector
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:configuration:PutAnomalyDetector'
, putAnomalyDetector_configuration
- The configuration specifies details about how the anomaly detection
model is to be trained, including time ranges to exclude when training
and updating the model. You can specify as many as 10 time ranges.
The configuration can also include the time zone to use for the metric.
$sel:dimensions:PutAnomalyDetector'
, putAnomalyDetector_dimensions
- The metric dimensions to create the anomaly detection model for.
$sel:namespace:PutAnomalyDetector'
, putAnomalyDetector_namespace
- The namespace of the metric to create the anomaly detection model for.
$sel:metricName:PutAnomalyDetector'
, putAnomalyDetector_metricName
- The name of the metric to create the anomaly detection model for.
$sel:stat:PutAnomalyDetector'
, putAnomalyDetector_stat
- The statistic to use for the metric and the anomaly detection model.
data PutAnomalyDetectorResponse Source #
See: newPutAnomalyDetectorResponse
smart constructor.
Instances
newPutAnomalyDetectorResponse Source #
Create a value of PutAnomalyDetectorResponse
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:httpStatus:PutAnomalyDetectorResponse'
, putAnomalyDetectorResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The ARN of the CloudWatch resource that you want to view tags for.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tag keys and values associated with the resource you
specified.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
GetMetricData (Paginated)
data GetMetricData Source #
See: newGetMetricData
smart constructor.
GetMetricData' (Maybe Int) (Maybe LabelOptions) (Maybe Text) (Maybe ScanBy) [MetricDataQuery] ISO8601 ISO8601 |
Instances
Create a value of GetMetricData
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:maxDatapoints:GetMetricData'
, getMetricData_maxDatapoints
- The maximum number of data points the request should return before
paginating. If you omit this, the default of 100,800 is used.
$sel:labelOptions:GetMetricData'
, getMetricData_labelOptions
- This structure includes the Timezone
parameter, which you can use to
specify your time zone so that the labels of returned data display the
correct time for your time zone.
$sel:nextToken:GetMetricData'
, getMetricData_nextToken
- Include this value, if it was returned by the previous GetMetricData
operation, to get the next set of data points.
$sel:scanBy:GetMetricData'
, getMetricData_scanBy
- The order in which data points should be returned. TimestampDescending
returns the newest data first and paginates when the MaxDatapoints
limit is reached. TimestampAscending
returns the oldest data first and
paginates when the MaxDatapoints
limit is reached.
$sel:metricDataQueries:GetMetricData'
, getMetricData_metricDataQueries
- The metric queries to be returned. A single GetMetricData
call can
include as many as 500 MetricDataQuery
structures. Each of these
structures can specify either a metric to retrieve, or a math expression
to perform on retrieved data.
$sel:startTime:GetMetricData'
, getMetricData_startTime
- The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
- Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
- Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
- Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period
to 5, 10, or 30, the start time of your request is
rounded down to the nearest time that corresponds to even 5-, 10-, or
30-second divisions of a minute. For example, if you make a query at
(HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of
your request is rounded down and you receive data from 01:05:10 to
01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of
data, using a period of 5 seconds, you receive data timestamped between
15:02:15 and 15:07:15.
For better performance, specify StartTime
and EndTime
values that
align with the value of the metric's Period
and sync up with the
beginning and end of an hour. For example, if the Period
of a metric
is 5 minutes, specifying 12:05 or 12:30 as StartTime
can get a faster
response from CloudWatch than setting 12:07 or 12:29 as the StartTime
.
$sel:endTime:GetMetricData'
, getMetricData_endTime
- The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime
and EndTime
values that
align with the value of the metric's Period
and sync up with the
beginning and end of an hour. For example, if the Period
of a metric
is 5 minutes, specifying 12:05 or 12:30 as EndTime
can get a faster
response from CloudWatch than setting 12:07 or 12:29 as the EndTime
.
data GetMetricDataResponse Source #
See: newGetMetricDataResponse
smart constructor.
Instances
newGetMetricDataResponse Source #
Create a value of GetMetricDataResponse
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:metricDataResults:GetMetricDataResponse'
, getMetricDataResponse_metricDataResults
- The metrics that are returned, including the metric name, namespace, and
dimensions.
$sel:nextToken:GetMetricData'
, getMetricDataResponse_nextToken
- A token that marks the next batch of returned results.
$sel:messages:GetMetricDataResponse'
, getMetricDataResponse_messages
- Contains a message about this GetMetricData
operation, if the
operation results in such a message. An example of a message that might
be returned is Maximum number of allowed metrics exceeded
. If there is
a message, as much of the operation as possible is still executed.
A message appears here only if it is related to the global
GetMetricData
operation. Any message about a specific metric returned
by the operation appears in the MetricDataResult
object returned for
that metric.
$sel:httpStatus:GetMetricDataResponse'
, getMetricDataResponse_httpStatus
- The response's http status code.
PutMetricData
data PutMetricData Source #
See: newPutMetricData
smart constructor.
Instances
Create a value of PutMetricData
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:PutMetricData'
, putMetricData_namespace
- The namespace for the metric data.
To avoid conflicts with Amazon Web Services service namespaces, you
should not specify a namespace that begins with AWS/
$sel:metricData:PutMetricData'
, putMetricData_metricData
- The data for the metric. The array can include no more than 20 metrics
per call.
data PutMetricDataResponse Source #
See: newPutMetricDataResponse
smart constructor.
Instances
Eq PutMetricDataResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricData (==) :: PutMetricDataResponse -> PutMetricDataResponse -> Bool # (/=) :: PutMetricDataResponse -> PutMetricDataResponse -> Bool # | |
Read PutMetricDataResponse Source # | |
Show PutMetricDataResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricData showsPrec :: Int -> PutMetricDataResponse -> ShowS # show :: PutMetricDataResponse -> String # showList :: [PutMetricDataResponse] -> ShowS # | |
Generic PutMetricDataResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricData type Rep PutMetricDataResponse :: Type -> Type # | |
NFData PutMetricDataResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricData rnf :: PutMetricDataResponse -> () # | |
type Rep PutMetricDataResponse Source # | |
newPutMetricDataResponse :: PutMetricDataResponse Source #
Create a value of PutMetricDataResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListDashboards (Paginated)
data ListDashboards Source #
See: newListDashboards
smart constructor.
Instances
newListDashboards :: ListDashboards Source #
Create a value of ListDashboards
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:dashboardNamePrefix:ListDashboards'
, listDashboards_dashboardNamePrefix
- If you specify this parameter, only the dashboards with names starting
with the specified string are listed. The maximum length is 255, and
valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
$sel:nextToken:ListDashboards'
, listDashboards_nextToken
- The token returned by a previous call to indicate that there is more
data available.
data ListDashboardsResponse Source #
See: newListDashboardsResponse
smart constructor.
Instances
newListDashboardsResponse Source #
Create a value of ListDashboardsResponse
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:dashboardEntries:ListDashboardsResponse'
, listDashboardsResponse_dashboardEntries
- The list of matching dashboards.
$sel:nextToken:ListDashboards'
, listDashboardsResponse_nextToken
- The token that marks the start of the next batch of returned results.
$sel:httpStatus:ListDashboardsResponse'
, listDashboardsResponse_httpStatus
- The response's http status code.
DescribeAlarms (Paginated)
data DescribeAlarms Source #
See: newDescribeAlarms
smart constructor.
DescribeAlarms' (Maybe Text) (Maybe [AlarmType]) (Maybe Text) (Maybe Text) (Maybe StateValue) (Maybe [Text]) (Maybe Natural) (Maybe Text) (Maybe Text) |
Instances
newDescribeAlarms :: DescribeAlarms Source #
Create a value of DescribeAlarms
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:alarmNamePrefix:DescribeAlarms'
, describeAlarms_alarmNamePrefix
- An alarm name prefix. If you specify this parameter, you receive
information about all alarms that have names that start with this
prefix.
If this parameter is specified, you cannot specify AlarmNames
.
$sel:alarmTypes:DescribeAlarms'
, describeAlarms_alarmTypes
- Use this parameter to specify whether you want the operation to return
metric alarms or composite alarms. If you omit this parameter, only
metric alarms are returned.
$sel:actionPrefix:DescribeAlarms'
, describeAlarms_actionPrefix
- Use this parameter to filter the results of the operation to only those
alarms that use a certain alarm action. For example, you could specify
the ARN of an SNS topic to find all alarms that send notifications to
that topic.
$sel:nextToken:DescribeAlarms'
, describeAlarms_nextToken
- The token returned by a previous call to indicate that there is more
data available.
$sel:stateValue:DescribeAlarms'
, describeAlarms_stateValue
- Specify this parameter to receive information only about alarms that are
currently in the state that you specify.
$sel:alarmNames:DescribeAlarms'
, describeAlarms_alarmNames
- The names of the alarms to retrieve information about.
$sel:maxRecords:DescribeAlarms'
, describeAlarms_maxRecords
- The maximum number of alarm descriptions to retrieve.
$sel:parentsOfAlarmName:DescribeAlarms'
, describeAlarms_parentsOfAlarmName
- If you use this parameter and specify the name of a metric or composite
alarm, the operation returns information about the "parent" alarms of
the alarm you specify. These are the composite alarms that have
AlarmRule
parameters that reference the alarm named in
ParentsOfAlarmName
. Information about the alarm that you specify in
ParentsOfAlarmName
is not returned.
If you specify ParentsOfAlarmName
, you cannot specify any other
parameters in the request except for MaxRecords
and NextToken
. If
you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use
this parameter. To get complete information about these alarms, perform
another DescribeAlarms
operation and specify the parent alarm names in
the AlarmNames
parameter.
$sel:childrenOfAlarmName:DescribeAlarms'
, describeAlarms_childrenOfAlarmName
- If you use this parameter and specify the name of a composite alarm, the
operation returns information about the "children" alarms of the alarm
you specify. These are the metric alarms and composite alarms referenced
in the AlarmRule
field of the composite alarm that you specify in
ChildrenOfAlarmName
. Information about the composite alarm that you
name in ChildrenOfAlarmName
is not returned.
If you specify ChildrenOfAlarmName
, you cannot specify any other
parameters in the request except for MaxRecords
and NextToken
. If
you do so, you receive a validation error.
Only the Alarm Name
, ARN
, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
information
are returned by this operation when you use this parameter. To get
complete information about these alarms, perform another
DescribeAlarms
operation and specify the parent alarm names in the
AlarmNames
parameter.
data DescribeAlarmsResponse Source #
See: newDescribeAlarmsResponse
smart constructor.
Instances
newDescribeAlarmsResponse Source #
Create a value of DescribeAlarmsResponse
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:metricAlarms:DescribeAlarmsResponse'
, describeAlarmsResponse_metricAlarms
- The information about any metric alarms returned by the operation.
$sel:compositeAlarms:DescribeAlarmsResponse'
, describeAlarmsResponse_compositeAlarms
- The information about any composite alarms returned by the operation.
$sel:nextToken:DescribeAlarms'
, describeAlarmsResponse_nextToken
- The token that marks the start of the next batch of returned results.
$sel:httpStatus:DescribeAlarmsResponse'
, describeAlarmsResponse_httpStatus
- The response's http status code.
ListMetrics (Paginated)
data ListMetrics Source #
See: newListMetrics
smart constructor.
ListMetrics' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecentlyActive) (Maybe [DimensionFilter]) |
Instances
newListMetrics :: ListMetrics Source #
Create a value of ListMetrics
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:ListMetrics'
, listMetrics_metricName
- The name of the metric to filter against. Only the metrics with names
that match exactly will be returned.
$sel:namespace:ListMetrics'
, listMetrics_namespace
- The metric namespace to filter against. Only the namespace that matches
exactly will be returned.
$sel:nextToken:ListMetrics'
, listMetrics_nextToken
- The token returned by a previous call to indicate that there is more
data available.
$sel:recentlyActive:ListMetrics'
, listMetrics_recentlyActive
- To filter the results to show only metrics that have had data points
published in the past three hours, specify this parameter with a value
of PT3H
. This is the only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.
$sel:dimensions:ListMetrics'
, listMetrics_dimensions
- The dimensions to filter against. Only the dimensions that match exactly
will be returned.
data ListMetricsResponse Source #
See: newListMetricsResponse
smart constructor.
Instances
newListMetricsResponse Source #
Create a value of ListMetricsResponse
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:metrics:ListMetricsResponse'
, listMetricsResponse_metrics
- The metrics that match your request.
$sel:nextToken:ListMetrics'
, listMetricsResponse_nextToken
- The token that marks the start of the next batch of returned results.
$sel:httpStatus:ListMetricsResponse'
, listMetricsResponse_httpStatus
- The response's http status code.
GetInsightRuleReport
data GetInsightRuleReport Source #
See: newGetInsightRuleReport
smart constructor.
Instances
newGetInsightRuleReport Source #
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> Natural | |
-> GetInsightRuleReport |
Create a value of GetInsightRuleReport
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:maxContributorCount:GetInsightRuleReport'
, getInsightRuleReport_maxContributorCount
- The maximum number of contributors to include in the report. The range
is 1 to 100. If you omit this, the default of 10 is used.
$sel:metrics:GetInsightRuleReport'
, getInsightRuleReport_metrics
- Specifies which metrics to use for aggregation of contributor values for
the report. You can specify one or more of the following metrics:
UniqueContributors
-- the number of unique contributors for each data point.MaxContributorValue
-- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's
Value
, during that period.SampleCount
-- the number of data points matched by the rule.Sum
-- the sum of the values from all contributors during the time period represented by that data point.Minimum
-- the minimum value from a single observation during the time period represented by that data point.Maximum
-- the maximum value from a single observation during the time period represented by that data point.Average
-- the average value from all contributors during the time period represented by that data point.
$sel:orderBy:GetInsightRuleReport'
, getInsightRuleReport_orderBy
- Determines what statistic to use to rank the contributors. Valid values
are SUM and MAXIMUM.
$sel:ruleName:GetInsightRuleReport'
, getInsightRuleReport_ruleName
- The name of the rule that you want to see data from.
$sel:startTime:GetInsightRuleReport'
, getInsightRuleReport_startTime
- The start time of the data to use in the report. When used in a raw HTTP
Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss
. For example,
2019-07-01T23:59:59
.
$sel:endTime:GetInsightRuleReport'
, getInsightRuleReport_endTime
- The end time of the data to use in the report. When used in a raw HTTP
Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss
. For example,
2019-07-01T23:59:59
.
$sel:period:GetInsightRuleReport'
, getInsightRuleReport_period
- The period, in seconds, to use for the statistics in the
InsightRuleMetricDatapoint
results.
data GetInsightRuleReportResponse Source #
See: newGetInsightRuleReportResponse
smart constructor.
GetInsightRuleReportResponse' (Maybe [Text]) (Maybe Integer) (Maybe Text) (Maybe Double) (Maybe [InsightRuleContributor]) (Maybe [InsightRuleMetricDatapoint]) Int |
Instances
newGetInsightRuleReportResponse Source #
Create a value of GetInsightRuleReportResponse
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:keyLabels:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_keyLabels
- An array of the strings used as the keys for this rule. The keys are the
dimensions used to classify contributors. If the rule contains more than
one key, then each unique combination of values for the keys is counted
as a unique contributor.
$sel:approximateUniqueCount:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_approximateUniqueCount
- An approximate count of the unique contributors found by this rule in
this time period.
$sel:aggregationStatistic:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_aggregationStatistic
- Specifies whether this rule aggregates contributor data by COUNT or SUM.
$sel:aggregateValue:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_aggregateValue
- The sum of the values from all individual contributors that match the
rule.
$sel:contributors:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_contributors
- An array of the unique contributors found by this rule in this time
period. If the rule contains multiple keys, each combination of values
for the keys counts as a unique contributor.
$sel:metricDatapoints:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_metricDatapoints
- A time series of metric data points that matches the time period in the
rule request.
$sel:httpStatus:GetInsightRuleReportResponse'
, getInsightRuleReportResponse_httpStatus
- The response's http status code.
StartMetricStreams
data StartMetricStreams Source #
See: newStartMetricStreams
smart constructor.
Instances
newStartMetricStreams :: StartMetricStreams Source #
Create a value of StartMetricStreams
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:names:StartMetricStreams'
, startMetricStreams_names
- The array of the names of metric streams to start streaming.
This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will start streaming.
data StartMetricStreamsResponse Source #
See: newStartMetricStreamsResponse
smart constructor.
Instances
newStartMetricStreamsResponse Source #
Create a value of StartMetricStreamsResponse
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:httpStatus:StartMetricStreamsResponse'
, startMetricStreamsResponse_httpStatus
- The response's http status code.
DeleteDashboards
data DeleteDashboards Source #
See: newDeleteDashboards
smart constructor.
Instances
newDeleteDashboards :: DeleteDashboards Source #
Create a value of DeleteDashboards
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:dashboardNames:DeleteDashboards'
, deleteDashboards_dashboardNames
- The dashboards to be deleted. This parameter is required.
data DeleteDashboardsResponse Source #
See: newDeleteDashboardsResponse
smart constructor.
Instances
newDeleteDashboardsResponse Source #
Create a value of DeleteDashboardsResponse
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:httpStatus:DeleteDashboardsResponse'
, deleteDashboardsResponse_httpStatus
- The response's http status code.
PutInsightRule
data PutInsightRule Source #
See: newPutInsightRule
smart constructor.
Instances
Create a value of PutInsightRule
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:tags:PutInsightRule'
, putInsightRule_tags
- A list of key-value pairs to associate with the Contributor Insights
rule. You can associate as many as 50 tags with a rule.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
To be able to associate tags with a rule, you must have the
cloudwatch:TagResource
permission in addition to the
cloudwatch:PutInsightRule
permission.
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
$sel:ruleState:PutInsightRule'
, putInsightRule_ruleState
- The state of the rule. Valid values are ENABLED and DISABLED.
$sel:ruleName:PutInsightRule'
, putInsightRule_ruleName
- A unique name for the rule.
$sel:ruleDefinition:PutInsightRule'
, putInsightRule_ruleDefinition
- The definition of the rule, as a JSON object. For details on the valid
syntax, see
Contributor Insights Rule Syntax.
data PutInsightRuleResponse Source #
See: newPutInsightRuleResponse
smart constructor.
Instances
newPutInsightRuleResponse Source #
Create a value of PutInsightRuleResponse
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:httpStatus:PutInsightRuleResponse'
, putInsightRuleResponse_httpStatus
- The response's http status code.
ListMetricStreams
data ListMetricStreams Source #
See: newListMetricStreams
smart constructor.
Instances
newListMetricStreams :: ListMetricStreams Source #
Create a value of ListMetricStreams
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:nextToken:ListMetricStreams'
, listMetricStreams_nextToken
- Include this value, if it was returned by the previous call, to get the
next set of metric streams.
$sel:maxResults:ListMetricStreams'
, listMetricStreams_maxResults
- The maximum number of results to return in one operation.
data ListMetricStreamsResponse Source #
See: newListMetricStreamsResponse
smart constructor.
Instances
newListMetricStreamsResponse Source #
Create a value of ListMetricStreamsResponse
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:entries:ListMetricStreamsResponse'
, listMetricStreamsResponse_entries
- The array of metric stream information.
$sel:nextToken:ListMetricStreams'
, listMetricStreamsResponse_nextToken
- The token that marks the start of the next batch of returned results.
You can use this token in a subsequent operation to get the next batch
of results.
$sel:httpStatus:ListMetricStreamsResponse'
, listMetricStreamsResponse_httpStatus
- The response's http status code.
GetMetricWidgetImage
data GetMetricWidgetImage Source #
See: newGetMetricWidgetImage
smart constructor.
Instances
newGetMetricWidgetImage Source #
Create a value of GetMetricWidgetImage
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:outputFormat:GetMetricWidgetImage'
, getMetricWidgetImage_outputFormat
- The format of the resulting image. Only PNG images are supported.
The default is png
. If you specify png
, the API returns an HTTP
response with the content-type set to text/xml
. The image data is in
a MetricWidgetImage
field. For example:
<GetMetricWidgetImageResponse xmlns=<URLstring>>
<GetMetricWidgetImageResult>
<MetricWidgetImage>
iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
</MetricWidgetImage>
</GetMetricWidgetImageResult>
<ResponseMetadata>
<RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
</ResponseMetadata>
</GetMetricWidgetImageResponse>
The image/png
setting is intended only for custom HTTP requests. For
most use cases, and all actions using an Amazon Web Services SDK, you
should use png
. If you specify image/png
, the HTTP response has a
content-type set to image/png
, and the body of the response is a PNG
image.
$sel:metricWidget:GetMetricWidgetImage'
, getMetricWidgetImage_metricWidget
- A JSON string that defines the bitmap graph to be retrieved. The string
includes the metrics to include in the graph, statistics, annotations,
title, axis limits, and so on. You can include only one MetricWidget
parameter in each GetMetricWidgetImage
call.
For more information about the syntax of MetricWidget
see
GetMetricWidgetImage: Metric Widget Structure and Syntax.
If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.
data GetMetricWidgetImageResponse Source #
See: newGetMetricWidgetImageResponse
smart constructor.
Instances
newGetMetricWidgetImageResponse Source #
Create a value of GetMetricWidgetImageResponse
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:metricWidgetImage:GetMetricWidgetImageResponse'
, getMetricWidgetImageResponse_metricWidgetImage
- The image of the graph, in the output format specified. The output is
base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:httpStatus:GetMetricWidgetImageResponse'
, getMetricWidgetImageResponse_httpStatus
- The response's http status code.
DeleteMetricStream
data DeleteMetricStream Source #
See: newDeleteMetricStream
smart constructor.
Instances
newDeleteMetricStream Source #
Create a value of DeleteMetricStream
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:DeleteMetricStream'
, deleteMetricStream_name
- The name of the metric stream to delete.
data DeleteMetricStreamResponse Source #
See: newDeleteMetricStreamResponse
smart constructor.
Instances
newDeleteMetricStreamResponse Source #
Create a value of DeleteMetricStreamResponse
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:httpStatus:DeleteMetricStreamResponse'
, deleteMetricStreamResponse_httpStatus
- The response's http status code.
DeleteAlarms
data DeleteAlarms Source #
See: newDeleteAlarms
smart constructor.
Instances
newDeleteAlarms :: DeleteAlarms Source #
Create a value of DeleteAlarms
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:alarmNames:DeleteAlarms'
, deleteAlarms_alarmNames
- The alarms to be deleted.
data DeleteAlarmsResponse Source #
See: newDeleteAlarmsResponse
smart constructor.
Instances
Eq DeleteAlarmsResponse Source # | |
Defined in Amazonka.CloudWatch.DeleteAlarms (==) :: DeleteAlarmsResponse -> DeleteAlarmsResponse -> Bool # (/=) :: DeleteAlarmsResponse -> DeleteAlarmsResponse -> Bool # | |
Read DeleteAlarmsResponse Source # | |
Show DeleteAlarmsResponse Source # | |
Defined in Amazonka.CloudWatch.DeleteAlarms showsPrec :: Int -> DeleteAlarmsResponse -> ShowS # show :: DeleteAlarmsResponse -> String # showList :: [DeleteAlarmsResponse] -> ShowS # | |
Generic DeleteAlarmsResponse Source # | |
Defined in Amazonka.CloudWatch.DeleteAlarms type Rep DeleteAlarmsResponse :: Type -> Type # from :: DeleteAlarmsResponse -> Rep DeleteAlarmsResponse x # to :: Rep DeleteAlarmsResponse x -> DeleteAlarmsResponse # | |
NFData DeleteAlarmsResponse Source # | |
Defined in Amazonka.CloudWatch.DeleteAlarms rnf :: DeleteAlarmsResponse -> () # | |
type Rep DeleteAlarmsResponse Source # | |
newDeleteAlarmsResponse :: DeleteAlarmsResponse Source #
Create a value of DeleteAlarmsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutMetricStream
data PutMetricStream Source #
See: newPutMetricStream
smart constructor.
PutMetricStream' (Maybe [MetricStreamFilter]) (Maybe [MetricStreamFilter]) (Maybe [Tag]) Text Text Text MetricStreamOutputFormat |
Instances
:: Text | |
-> Text | |
-> Text | |
-> MetricStreamOutputFormat | |
-> PutMetricStream |
Create a value of PutMetricStream
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:includeFilters:PutMetricStream'
, putMetricStream_includeFilters
- If you specify this parameter, the stream sends only the metrics from
the metric namespaces that you specify here.
You cannot include IncludeFilters
and ExcludeFilters
in the same
operation.
$sel:excludeFilters:PutMetricStream'
, putMetricStream_excludeFilters
- If you specify this parameter, the stream sends metrics from all metric
namespaces except for the namespaces that you specify here.
You cannot include ExcludeFilters
and IncludeFilters
in the same
operation.
$sel:tags:PutMetricStream'
, putMetricStream_tags
- A list of key-value pairs to associate with the metric stream. You can
associate as many as 50 tags with a metric stream.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.
$sel:name:PutMetricStream'
, putMetricStream_name
- If you are creating a new metric stream, this is the name for the new
stream. The name must be different than the names of other metric
streams in this account and Region.
If you are updating a metric stream, specify the name of that stream here.
Valid characters are A-Z, a-z, 0-9, "-" and "_".
$sel:firehoseArn:PutMetricStream'
, putMetricStream_firehoseArn
- The ARN of the Amazon Kinesis Firehose delivery stream to use for this
metric stream. This Amazon Kinesis Firehose delivery stream must already
exist and must be in the same account as the metric stream.
$sel:roleArn:PutMetricStream'
, putMetricStream_roleArn
- The ARN of an IAM role that this metric stream will use to access Amazon
Kinesis Firehose resources. This IAM role must already exist and must be
in the same account as the metric stream. This IAM role must include the
following permissions:
- firehose:PutRecord
- firehose:PutRecordBatch
$sel:outputFormat:PutMetricStream'
, putMetricStream_outputFormat
- The output format for the stream. Valid values are json
and
opentelemetry0.7
. For more information about metric stream output
formats, see
Metric streams output formats.
data PutMetricStreamResponse Source #
See: newPutMetricStreamResponse
smart constructor.
Instances
newPutMetricStreamResponse Source #
Create a value of PutMetricStreamResponse
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:arn:PutMetricStreamResponse'
, putMetricStreamResponse_arn
- The ARN of the metric stream.
$sel:httpStatus:PutMetricStreamResponse'
, putMetricStreamResponse_httpStatus
- The response's http status code.
DescribeAlarmHistory (Paginated)
data DescribeAlarmHistory Source #
See: newDescribeAlarmHistory
smart constructor.
DescribeAlarmHistory' (Maybe Text) (Maybe HistoryItemType) (Maybe [AlarmType]) (Maybe ISO8601) (Maybe ISO8601) (Maybe Text) (Maybe ScanBy) (Maybe Natural) |
Instances
newDescribeAlarmHistory :: DescribeAlarmHistory Source #
Create a value of DescribeAlarmHistory
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:DescribeAlarmHistory'
, describeAlarmHistory_alarmName
- The name of the alarm.
$sel:historyItemType:DescribeAlarmHistory'
, describeAlarmHistory_historyItemType
- The type of alarm histories to retrieve.
$sel:alarmTypes:DescribeAlarmHistory'
, describeAlarmHistory_alarmTypes
- Use this parameter to specify whether you want the operation to return
metric alarms or composite alarms. If you omit this parameter, only
metric alarms are returned.
$sel:endDate:DescribeAlarmHistory'
, describeAlarmHistory_endDate
- The ending date to retrieve alarm history.
$sel:startDate:DescribeAlarmHistory'
, describeAlarmHistory_startDate
- The starting date to retrieve alarm history.
$sel:nextToken:DescribeAlarmHistory'
, describeAlarmHistory_nextToken
- The token returned by a previous call to indicate that there is more
data available.
$sel:scanBy:DescribeAlarmHistory'
, describeAlarmHistory_scanBy
- Specified whether to return the newest or oldest alarm history first.
Specify TimestampDescending
to have the newest event history returned
first, and specify TimestampAscending
to have the oldest history
returned first.
$sel:maxRecords:DescribeAlarmHistory'
, describeAlarmHistory_maxRecords
- The maximum number of alarm history records to retrieve.
data DescribeAlarmHistoryResponse Source #
See: newDescribeAlarmHistoryResponse
smart constructor.
Instances
newDescribeAlarmHistoryResponse Source #
Create a value of DescribeAlarmHistoryResponse
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:alarmHistoryItems:DescribeAlarmHistoryResponse'
, describeAlarmHistoryResponse_alarmHistoryItems
- The alarm histories, in JSON format.
$sel:nextToken:DescribeAlarmHistory'
, describeAlarmHistoryResponse_nextToken
- The token that marks the start of the next batch of returned results.
$sel:httpStatus:DescribeAlarmHistoryResponse'
, describeAlarmHistoryResponse_httpStatus
- The response's http status code.
GetMetricStatistics
data GetMetricStatistics Source #
See: newGetMetricStatistics
smart constructor.
GetMetricStatistics' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Statistic)) (Maybe [Dimension]) (Maybe StandardUnit) Text Text ISO8601 ISO8601 Natural |
Instances
newGetMetricStatistics Source #
Create a value of GetMetricStatistics
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:extendedStatistics:GetMetricStatistics'
, getMetricStatistics_extendedStatistics
- The percentile statistics. Specify values between p0.0 and p100. When
calling GetMetricStatistics
, you must specify either Statistics
or
ExtendedStatistics
, but not both. Percentile statistics are not
available for metrics when any of the metric values are negative
numbers.
$sel:statistics:GetMetricStatistics'
, getMetricStatistics_statistics
- The metric statistics, other than percentile. For percentile statistics,
use ExtendedStatistics
. When calling GetMetricStatistics
, you must
specify either Statistics
or ExtendedStatistics
, but not both.
$sel:dimensions:GetMetricStatistics'
, getMetricStatistics_dimensions
- The dimensions. If the metric contains multiple dimensions, you must
include a value for each dimension. CloudWatch treats each unique
combination of dimensions as a separate metric. If a specific
combination of dimensions was not published, you can't retrieve
statistics for it. You must specify the same dimensions that were used
when the metrics were created. For an example, see
Dimension Combinations
in the Amazon CloudWatch User Guide. For more information about
specifying dimensions, see
Publishing Metrics
in the Amazon CloudWatch User Guide.
$sel:unit:GetMetricStatistics'
, getMetricStatistics_unit
- The unit for a given metric. If you omit Unit
, all data that was
collected with any unit is returned, along with the corresponding units
that were specified when the data was reported to CloudWatch. If you
specify a unit, the operation returns only data that was collected with
that unit specified. If you specify a unit that does not match the data
collected, the results of the operation are null. CloudWatch does not
perform unit conversions.
$sel:namespace:GetMetricStatistics'
, getMetricStatistics_namespace
- The namespace of the metric, with or without spaces.
$sel:metricName:GetMetricStatistics'
, getMetricStatistics_metricName
- The name of the metric, with or without spaces.
$sel:startTime:GetMetricStatistics'
, getMetricStatistics_startTime
- The time stamp that determines the first data point to return. Start
times are evaluated relative to the time that CloudWatch receives the
request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
- Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
- Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
- Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period
to 5, 10, or 30, the start time of your request is
rounded down to the nearest time that corresponds to even 5-, 10-, or
30-second divisions of a minute. For example, if you make a query at
(HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of
your request is rounded down and you receive data from 01:05:10 to
01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of
data, using a period of 5 seconds, you receive data timestamped between
15:02:15 and 15:07:15.
$sel:endTime:GetMetricStatistics'
, getMetricStatistics_endTime
- The time stamp that determines the last data point to return.
The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
$sel:period:GetMetricStatistics'
, getMetricStatistics_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).
data GetMetricStatisticsResponse Source #
See: newGetMetricStatisticsResponse
smart constructor.
Instances
newGetMetricStatisticsResponse Source #
Create a value of GetMetricStatisticsResponse
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:datapoints:GetMetricStatisticsResponse'
, getMetricStatisticsResponse_datapoints
- The data points for the specified metric.
$sel:label:GetMetricStatisticsResponse'
, getMetricStatisticsResponse_label
- A label for the specified metric.
$sel:httpStatus:GetMetricStatisticsResponse'
, getMetricStatisticsResponse_httpStatus
- The response's http status code.
DescribeAlarmsForMetric
data DescribeAlarmsForMetric Source #
See: newDescribeAlarmsForMetric
smart constructor.
DescribeAlarmsForMetric' (Maybe Natural) (Maybe [Dimension]) (Maybe StandardUnit) (Maybe Statistic) (Maybe Text) Text Text |
Instances
newDescribeAlarmsForMetric Source #
:: Text | |
-> Text | |
-> DescribeAlarmsForMetric |
Create a value of DescribeAlarmsForMetric
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:period:DescribeAlarmsForMetric'
, describeAlarmsForMetric_period
- The period, in seconds, over which the statistic is applied.
$sel:dimensions:DescribeAlarmsForMetric'
, describeAlarmsForMetric_dimensions
- The dimensions associated with the metric. If the metric has any
associated dimensions, you must specify them in order for the call to
succeed.
$sel:unit:DescribeAlarmsForMetric'
, describeAlarmsForMetric_unit
- The unit for the metric.
$sel:statistic:DescribeAlarmsForMetric'
, describeAlarmsForMetric_statistic
- The statistic for the metric, other than percentiles. For percentile
statistics, use ExtendedStatistics
.
$sel:extendedStatistic:DescribeAlarmsForMetric'
, describeAlarmsForMetric_extendedStatistic
- The percentile statistic for the metric. Specify a value between p0.0
and p100.
$sel:metricName:DescribeAlarmsForMetric'
, describeAlarmsForMetric_metricName
- The name of the metric.
$sel:namespace:DescribeAlarmsForMetric'
, describeAlarmsForMetric_namespace
- The namespace of the metric.
data DescribeAlarmsForMetricResponse Source #
See: newDescribeAlarmsForMetricResponse
smart constructor.
Instances
Eq DescribeAlarmsForMetricResponse Source # | |
Read DescribeAlarmsForMetricResponse Source # | |
Show DescribeAlarmsForMetricResponse Source # | |
Defined in Amazonka.CloudWatch.DescribeAlarmsForMetric | |
Generic DescribeAlarmsForMetricResponse Source # | |
NFData DescribeAlarmsForMetricResponse Source # | |
Defined in Amazonka.CloudWatch.DescribeAlarmsForMetric rnf :: DescribeAlarmsForMetricResponse -> () # | |
type Rep DescribeAlarmsForMetricResponse Source # | |
Defined in Amazonka.CloudWatch.DescribeAlarmsForMetric type Rep DescribeAlarmsForMetricResponse = D1 ('MetaData "DescribeAlarmsForMetricResponse" "Amazonka.CloudWatch.DescribeAlarmsForMetric" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "DescribeAlarmsForMetricResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricAlarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricAlarm])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeAlarmsForMetricResponse Source #
Create a value of DescribeAlarmsForMetricResponse
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:metricAlarms:DescribeAlarmsForMetricResponse'
, describeAlarmsForMetricResponse_metricAlarms
- The information for each alarm with the specified metric.
$sel:httpStatus:DescribeAlarmsForMetricResponse'
, describeAlarmsForMetricResponse_httpStatus
- The response's http status code.
EnableInsightRules
data EnableInsightRules Source #
See: newEnableInsightRules
smart constructor.
Instances
newEnableInsightRules :: EnableInsightRules Source #
Create a value of EnableInsightRules
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:ruleNames:EnableInsightRules'
, enableInsightRules_ruleNames
- An array of the rule names to enable. If you need to find out the names
of your rules, use
DescribeInsightRules.
data EnableInsightRulesResponse Source #
See: newEnableInsightRulesResponse
smart constructor.
Instances
newEnableInsightRulesResponse Source #
Create a value of EnableInsightRulesResponse
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:failures:EnableInsightRulesResponse'
, enableInsightRulesResponse_failures
- An array listing the rules that could not be enabled. You cannot disable
or enable built-in rules.
$sel:httpStatus:EnableInsightRulesResponse'
, enableInsightRulesResponse_httpStatus
- The response's http status code.
DisableAlarmActions
data DisableAlarmActions Source #
See: newDisableAlarmActions
smart constructor.
Instances
newDisableAlarmActions :: DisableAlarmActions Source #
Create a value of DisableAlarmActions
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:alarmNames:DisableAlarmActions'
, disableAlarmActions_alarmNames
- The names of the alarms.
data DisableAlarmActionsResponse Source #
See: newDisableAlarmActionsResponse
smart constructor.
Instances
newDisableAlarmActionsResponse :: DisableAlarmActionsResponse Source #
Create a value of DisableAlarmActionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeAnomalyDetectors
data DescribeAnomalyDetectors Source #
See: newDescribeAnomalyDetectors
smart constructor.
DescribeAnomalyDetectors' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Dimension]) (Maybe Natural) |
Instances
newDescribeAnomalyDetectors :: DescribeAnomalyDetectors Source #
Create a value of DescribeAnomalyDetectors
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:DescribeAnomalyDetectors'
, describeAnomalyDetectors_metricName
- Limits the results to only the anomaly detection models that are
associated with the specified metric name. If there are multiple metrics
with this name in different namespaces that have anomaly detection
models, they're all returned.
$sel:namespace:DescribeAnomalyDetectors'
, describeAnomalyDetectors_namespace
- Limits the results to only the anomaly detection models that are
associated with the specified namespace.
$sel:nextToken:DescribeAnomalyDetectors'
, describeAnomalyDetectors_nextToken
- Use the token returned by the previous operation to request the next
page of results.
$sel:dimensions:DescribeAnomalyDetectors'
, describeAnomalyDetectors_dimensions
- Limits the results to only the anomaly detection models that are
associated with the specified metric dimensions. If there are multiple
metrics that have these dimensions and have anomaly detection models
associated, they're all returned.
$sel:maxResults:DescribeAnomalyDetectors'
, describeAnomalyDetectors_maxResults
- The maximum number of results to return in one operation. The maximum
value that you can specify is 100.
To retrieve the remaining results, make another call with the returned
NextToken
value.
data DescribeAnomalyDetectorsResponse Source #
See: newDescribeAnomalyDetectorsResponse
smart constructor.
Instances
newDescribeAnomalyDetectorsResponse Source #
Create a value of DescribeAnomalyDetectorsResponse
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:anomalyDetectors:DescribeAnomalyDetectorsResponse'
, describeAnomalyDetectorsResponse_anomalyDetectors
- The list of anomaly detection models returned by the operation.
$sel:nextToken:DescribeAnomalyDetectors'
, describeAnomalyDetectorsResponse_nextToken
- A token that you can use in a subsequent operation to retrieve the next
set of results.
$sel:httpStatus:DescribeAnomalyDetectorsResponse'
, describeAnomalyDetectorsResponse_httpStatus
- The response's http status code.
PutDashboard
data PutDashboard Source #
See: newPutDashboard
smart constructor.
Instances
Create a value of PutDashboard
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:dashboardName:PutDashboard'
, putDashboard_dashboardName
- The name of the dashboard. If a dashboard with this name already exists,
this call modifies that dashboard, replacing its current contents.
Otherwise, a new dashboard is created. The maximum length is 255, and
valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is
required.
$sel:dashboardBody:PutDashboard'
, putDashboard_dashboardBody
- The detailed information about the dashboard in JSON format, including
the widgets to include and their location on the dashboard. This
parameter is required.
For more information about the syntax, see Dashboard Body Structure and Syntax.
data PutDashboardResponse Source #
See: newPutDashboardResponse
smart constructor.
Instances
newPutDashboardResponse Source #
Create a value of PutDashboardResponse
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:dashboardValidationMessages:PutDashboardResponse'
, putDashboardResponse_dashboardValidationMessages
- If the input for PutDashboard
was correct and the dashboard was
successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard might not render.
If this result includes error messages, the input was not valid and the operation failed.
$sel:httpStatus:PutDashboardResponse'
, putDashboardResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceARN:TagResource'
, tagResource_resourceARN
- The ARN of the CloudWatch resource that you're adding tags to.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
$sel:tags:TagResource'
, tagResource_tags
- The list of key-value pairs to associate with the alarm.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
StopMetricStreams
data StopMetricStreams Source #
See: newStopMetricStreams
smart constructor.
Instances
newStopMetricStreams :: StopMetricStreams Source #
Create a value of StopMetricStreams
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:names:StopMetricStreams'
, stopMetricStreams_names
- The array of the names of metric streams to stop streaming.
This is an "all or nothing" operation. If you do not have permission to access all of the metric streams that you list here, then none of the streams that you list in the operation will stop streaming.
data StopMetricStreamsResponse Source #
See: newStopMetricStreamsResponse
smart constructor.
Instances
newStopMetricStreamsResponse Source #
Create a value of StopMetricStreamsResponse
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:httpStatus:StopMetricStreamsResponse'
, stopMetricStreamsResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceARN:UntagResource'
, untagResource_resourceARN
- The ARN of the CloudWatch resource that you're removing tags from.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
The ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
GetMetricStream
data GetMetricStream Source #
See: newGetMetricStream
smart constructor.
Instances
Create a value of GetMetricStream
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:GetMetricStream'
, getMetricStream_name
- The name of the metric stream to retrieve information about.
data GetMetricStreamResponse Source #
See: newGetMetricStreamResponse
smart constructor.
GetMetricStreamResponse' (Maybe [MetricStreamFilter]) (Maybe Text) (Maybe [MetricStreamFilter]) (Maybe Text) (Maybe Text) (Maybe MetricStreamOutputFormat) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe Text) Int |
Instances
newGetMetricStreamResponse Source #
Create a value of GetMetricStreamResponse
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:includeFilters:GetMetricStreamResponse'
, getMetricStreamResponse_includeFilters
- If this array of metric namespaces is present, then these namespaces are
the only metric namespaces that are streamed by this metric stream.
$sel:state:GetMetricStreamResponse'
, getMetricStreamResponse_state
- The state of the metric stream. The possible values are running
and
stopped
.
$sel:excludeFilters:GetMetricStreamResponse'
, getMetricStreamResponse_excludeFilters
- If this array of metric namespaces is present, then these namespaces are
the only metric namespaces that are not streamed by this metric stream.
In this case, all other metric namespaces in the account are streamed by
this metric stream.
$sel:arn:GetMetricStreamResponse'
, getMetricStreamResponse_arn
- The ARN of the metric stream.
$sel:firehoseArn:GetMetricStreamResponse'
, getMetricStreamResponse_firehoseArn
- The ARN of the Amazon Kinesis Firehose delivery stream that is used by
this metric stream.
$sel:outputFormat:GetMetricStreamResponse'
, getMetricStreamResponse_outputFormat
-
$sel:lastUpdateDate:GetMetricStreamResponse'
, getMetricStreamResponse_lastUpdateDate
- The date of the most recent update to the metric stream's
configuration.
$sel:name:GetMetricStream'
, getMetricStreamResponse_name
- The name of the metric stream.
$sel:creationDate:GetMetricStreamResponse'
, getMetricStreamResponse_creationDate
- The date that the metric stream was created.
$sel:roleArn:GetMetricStreamResponse'
, getMetricStreamResponse_roleArn
- The ARN of the IAM role that is used by this metric stream.
$sel:httpStatus:GetMetricStreamResponse'
, getMetricStreamResponse_httpStatus
- The response's http status code.
PutMetricAlarm
data PutMetricAlarm Source #
See: newPutMetricAlarm
smart constructor.
PutMetricAlarm' (Maybe [MetricDataQuery]) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe Bool) (Maybe [Text]) (Maybe [Dimension]) (Maybe [Text]) (Maybe StandardUnit) (Maybe Statistic) (Maybe [Tag]) (Maybe Text) Text Natural ComparisonOperator |
Instances
:: Text | |
-> Natural | |
-> ComparisonOperator | |
-> PutMetricAlarm |
Create a value of PutMetricAlarm
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:metrics:PutMetricAlarm'
, putMetricAlarm_metrics
- An array of MetricDataQuery
structures that enable you to create an
alarm based on the result of a metric math expression. For each
PutMetricAlarm
operation, you must specify either MetricName
or a
Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a
math expression.
One item in the Metrics
array is the expression that the alarm
watches. You designate this expression by setting ReturnData
to true
for this object in the array. For more information, see
MetricDataQuery.
If you use the Metrics
parameter, you cannot include the MetricName
,
Dimensions
, Period
, Namespace
, Statistic
, or ExtendedStatistic
parameters of PutMetricAlarm
in the same operation. Instead, you
retrieve the metrics you are using in your math expression as part of
the Metrics
array.
$sel:treatMissingData:PutMetricAlarm'
, putMetricAlarm_treatMissingData
- Sets how this alarm is to handle missing data points. If
TreatMissingData
is omitted, the default behavior of missing
is
used. For more information, see
Configuring How CloudWatch Alarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing
$sel:period:PutMetricAlarm'
, putMetricAlarm_period
- The length, in seconds, used each time the metric specified in
MetricName
is evaluated. Valid values are 10, 30, and any multiple of
60.
Period
is required for alarms based on static thresholds. If you are
creating an alarm based on a metric math expression, you specify the
period for each metric within the objects in the Metrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a
PutMetricData
call with a StorageResolution
of 1. If you specify a
period of 10 or 30 for a metric that does not have sub-minute
resolution, the alarm still attempts to gather data at the period rate
that you specify. In this case, it does not receive data for the
attempts that do not correspond to a one-minute data resolution, and the
alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or
30 also sets this alarm as a high-resolution alarm, which has a higher
charge than other alarms. For more information about pricing, see
Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than one
day, so Period
multiplied by EvaluationPeriods
cannot be more than
86,400 seconds.
$sel:alarmDescription:PutMetricAlarm'
, putMetricAlarm_alarmDescription
- The description for the alarm.
$sel:metricName:PutMetricAlarm'
, putMetricAlarm_metricName
- The name for the metric associated with the alarm. For each
PutMetricAlarm
operation, you must specify either MetricName
or a
Metrics
array.
If you are creating an alarm based on a math expression, you cannot
specify this parameter, or any of the Dimensions
, Period
,
Namespace
, Statistic
, or ExtendedStatistic
parameters. Instead,
you specify all this information in the Metrics
array.
$sel:namespace:PutMetricAlarm'
, putMetricAlarm_namespace
- The namespace for the metric associated specified in MetricName
.
$sel:thresholdMetricId:PutMetricAlarm'
, putMetricAlarm_thresholdMetricId
- If this is an alarm based on an anomaly detection model, make this value
match the ID of the ANOMALY_DETECTION_BAND
function.
For an example of how to use this parameter, see the __Anomaly Detection Model Alarm__ example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
$sel:oKActions:PutMetricAlarm'
, putMetricAlarm_oKActions
- The actions to execute when this alarm transitions to an OK
state from
any other state. Each action is specified as an Amazon Resource Name
(ARN).
Valid Values: arn:aws:automate:region:ec2:stop
|
arn:aws:automate:region:ec2:terminate
|
arn:aws:automate:region:ec2:recover
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
$sel:evaluateLowSampleCountPercentile:PutMetricAlarm'
, putMetricAlarm_evaluateLowSampleCountPercentile
- Used only for alarms based on percentiles. If you specify ignore
, the
alarm state does not change during periods with too few data points to
be statistically significant. If you specify evaluate
or omit this
parameter, the alarm is always evaluated and possibly changes state no
matter how many data points are available. For more information, see
Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore
$sel:datapointsToAlarm:PutMetricAlarm'
, putMetricAlarm_datapointsToAlarm
- The number of data points that must be breaching to trigger the alarm.
This is used only if you are setting an "M out of N" alarm. In that
case, this value is the M. For more information, see
Evaluating an Alarm
in the Amazon CloudWatch User Guide.
$sel:threshold:PutMetricAlarm'
, putMetricAlarm_threshold
- The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
$sel:actionsEnabled:PutMetricAlarm'
, putMetricAlarm_actionsEnabled
- Indicates whether actions should be executed during any changes to the
alarm state. The default is TRUE
.
$sel:insufficientDataActions:PutMetricAlarm'
, putMetricAlarm_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).
Valid Values: arn:aws:automate:region:ec2:stop
|
arn:aws:automate:region:ec2:terminate
|
arn:aws:automate:region:ec2:recover
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
$sel:dimensions:PutMetricAlarm'
, putMetricAlarm_dimensions
- The dimensions for the metric specified in MetricName
.
$sel:alarmActions:PutMetricAlarm'
, putMetricAlarm_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).
Valid Values: arn:aws:automate:region:ec2:stop
|
arn:aws:automate:region:ec2:terminate
|
arn:aws:automate:region:ec2:recover
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
| arn:aws:ssm:region:account-id:opsitem:severity
|
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
$sel:unit:PutMetricAlarm'
, putMetricAlarm_unit
- The unit of measure for the statistic. For example, the units for the
Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the
number of bytes that an instance receives on all network interfaces. You
can also specify a unit when you create a custom metric. Units help
provide conceptual meaning to your data. Metric data points that specify
a unit of measure, such as Percent, are aggregated separately.
If you don't specify Unit
, CloudWatch retrieves all unit types that
have been published for the metric and attempts to evaluate the alarm.
Usually, metrics are published with only one unit, so the alarm works as
intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit
so that you don't inadvertently specify an
incorrect unit that is not published for this metric. Doing so causes
the alarm to be stuck in the INSUFFICIENT DATA
state.
$sel:statistic:PutMetricAlarm'
, putMetricAlarm_statistic
- The statistic for the metric specified in MetricName
, other than
percentile. For percentile statistics, use ExtendedStatistic
. When you
call PutMetricAlarm
and specify a MetricName
, you must specify
either Statistic
or ExtendedStatistic,
but not both.
$sel:tags:PutMetricAlarm'
, putMetricAlarm_tags
- A list of key-value pairs to associate with the alarm. You can associate
as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
$sel:extendedStatistic:PutMetricAlarm'
, putMetricAlarm_extendedStatistic
- The percentile statistic for the metric specified in MetricName
.
Specify a value between p0.0 and p100. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or
ExtendedStatistic,
but not both.
$sel:alarmName:PutMetricAlarm'
, putMetricAlarm_alarmName
- The name for the alarm. This name must be unique within the Region.
$sel:evaluationPeriods:PutMetricAlarm'
, putMetricAlarm_evaluationPeriods
- The number of periods over which data is compared to the specified
threshold. If you are setting an alarm that requires that a number of
consecutive data points be breaching to trigger the alarm, this value
specifies that number. If you are setting an "M out of N" alarm, this
value is the N.
An alarm's total current evaluation period can be no longer than one
day, so this number multiplied by Period
cannot be more than 86,400
seconds.
$sel:comparisonOperator:PutMetricAlarm'
, putMetricAlarm_comparisonOperator
- The arithmetic operation to use when comparing the specified statistic
and threshold. The specified statistic value is used as the first
operand.
The values LessThanLowerOrGreaterThanUpperThreshold
,
LessThanLowerThreshold
, and GreaterThanUpperThreshold
are used only
for alarms based on anomaly detection models.
data PutMetricAlarmResponse Source #
See: newPutMetricAlarmResponse
smart constructor.
Instances
Eq PutMetricAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricAlarm | |
Read PutMetricAlarmResponse Source # | |
Show PutMetricAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricAlarm showsPrec :: Int -> PutMetricAlarmResponse -> ShowS # show :: PutMetricAlarmResponse -> String # showList :: [PutMetricAlarmResponse] -> ShowS # | |
Generic PutMetricAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricAlarm type Rep PutMetricAlarmResponse :: Type -> Type # | |
NFData PutMetricAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricAlarm rnf :: PutMetricAlarmResponse -> () # | |
type Rep PutMetricAlarmResponse Source # | |
Defined in Amazonka.CloudWatch.PutMetricAlarm |
newPutMetricAlarmResponse :: PutMetricAlarmResponse Source #
Create a value of PutMetricAlarmResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetAlarmState
data SetAlarmState Source #
See: newSetAlarmState
smart constructor.
Instances
:: Text | |
-> StateValue | |
-> Text | |
-> SetAlarmState |
Create a value of SetAlarmState
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:stateReasonData:SetAlarmState'
, setAlarmState_stateReasonData
- The reason that this alarm is set to this specific state, in JSON
format.
For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
$sel:alarmName:SetAlarmState'
, setAlarmState_alarmName
- The name of the alarm.
$sel:stateValue:SetAlarmState'
, setAlarmState_stateValue
- The value of the state.
$sel:stateReason:SetAlarmState'
, setAlarmState_stateReason
- The reason that this alarm is set to this specific state, in text
format.
data SetAlarmStateResponse Source #
See: newSetAlarmStateResponse
smart constructor.
Instances
Eq SetAlarmStateResponse Source # | |
Defined in Amazonka.CloudWatch.SetAlarmState (==) :: SetAlarmStateResponse -> SetAlarmStateResponse -> Bool # (/=) :: SetAlarmStateResponse -> SetAlarmStateResponse -> Bool # | |
Read SetAlarmStateResponse Source # | |
Show SetAlarmStateResponse Source # | |
Defined in Amazonka.CloudWatch.SetAlarmState showsPrec :: Int -> SetAlarmStateResponse -> ShowS # show :: SetAlarmStateResponse -> String # showList :: [SetAlarmStateResponse] -> ShowS # | |
Generic SetAlarmStateResponse Source # | |
Defined in Amazonka.CloudWatch.SetAlarmState type Rep SetAlarmStateResponse :: Type -> Type # | |
NFData SetAlarmStateResponse Source # | |
Defined in Amazonka.CloudWatch.SetAlarmState rnf :: SetAlarmStateResponse -> () # | |
type Rep SetAlarmStateResponse Source # | |
newSetAlarmStateResponse :: SetAlarmStateResponse Source #
Create a value of SetAlarmStateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeInsightRules
data DescribeInsightRules Source #
See: newDescribeInsightRules
smart constructor.
Instances
newDescribeInsightRules :: DescribeInsightRules Source #
Create a value of DescribeInsightRules
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:nextToken:DescribeInsightRules'
, describeInsightRules_nextToken
- Include this value, if it was returned by the previous operation, to get
the next set of rules.
$sel:maxResults:DescribeInsightRules'
, describeInsightRules_maxResults
- The maximum number of results to return in one operation. If you omit
this parameter, the default of 500 is used.
data DescribeInsightRulesResponse Source #
See: newDescribeInsightRulesResponse
smart constructor.
Instances
newDescribeInsightRulesResponse Source #
Create a value of DescribeInsightRulesResponse
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:nextToken:DescribeInsightRules'
, describeInsightRulesResponse_nextToken
- If this parameter is present, it is a token that marks the start of the
next batch of returned results.
$sel:insightRules:DescribeInsightRulesResponse'
, describeInsightRulesResponse_insightRules
- The rules returned by the operation.
$sel:httpStatus:DescribeInsightRulesResponse'
, describeInsightRulesResponse_httpStatus
- The response's http status code.
Types
AlarmType
pattern AlarmType_CompositeAlarm :: AlarmType | |
pattern AlarmType_MetricAlarm :: AlarmType |
Instances
AnomalyDetectorStateValue
newtype AnomalyDetectorStateValue Source #
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Instances
HistoryItemType
newtype HistoryItemType Source #
pattern HistoryItemType_Action :: HistoryItemType | |
pattern HistoryItemType_ConfigurationUpdate :: HistoryItemType | |
pattern HistoryItemType_StateUpdate :: HistoryItemType |
Instances
MetricStreamOutputFormat
newtype MetricStreamOutputFormat Source #
pattern MetricStreamOutputFormat_Json :: MetricStreamOutputFormat | |
pattern MetricStreamOutputFormat_Opentelemetry0_7 :: MetricStreamOutputFormat |
Instances
RecentlyActive
newtype RecentlyActive Source #
pattern RecentlyActive_PT3H :: RecentlyActive |
Instances
ScanBy
pattern ScanBy_TimestampAscending :: ScanBy | |
pattern ScanBy_TimestampDescending :: ScanBy |
Instances
StandardUnit
newtype StandardUnit Source #
Instances
StateValue
newtype StateValue Source #
pattern StateValue_ALARM :: StateValue | |
pattern StateValue_INSUFFICIENT_DATA :: StateValue | |
pattern StateValue_OK :: StateValue |
Instances
Statistic
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 #
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.
AlarmHistoryItem' (Maybe Text) (Maybe HistoryItemType) (Maybe Text) (Maybe AlarmType) (Maybe Text) (Maybe ISO8601) |
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.
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.
AnomalyDetector' (Maybe Text) (Maybe Text) (Maybe AnomalyDetectorStateValue) (Maybe Text) (Maybe AnomalyDetectorConfiguration) (Maybe [Dimension]) |
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.
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.
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.
CompositeAlarm
data CompositeAlarm Source #
The details about a composite alarm.
See: newCompositeAlarm
smart constructor.
CompositeAlarm' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe StateValue) (Maybe ISO8601) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) |
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).
DashboardEntry
data DashboardEntry Source #
Represents a specific dashboard.
See: newDashboardEntry
smart constructor.
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.
DashboardValidationMessage
data DashboardValidationMessage Source #
An error or warning for the operation.
See: newDashboardValidationMessage
smart constructor.
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.
Datapoint
Encapsulates the statistical data that CloudWatch computes from metric data.
See: newDatapoint
smart constructor.
Datapoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe (HashMap Text Double)) (Maybe Double) (Maybe StandardUnit) (Maybe ISO8601) |
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.
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.
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 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.
DimensionFilter
data DimensionFilter Source #
Represents filters for a dimension.
See: newDimensionFilter
smart constructor.
Instances
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.
InsightRule
data InsightRule Source #
This structure contains the definition for a Contributor Insights rule.
See: newInsightRule
smart constructor.
Instances
:: 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.
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.
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.
InsightRuleContributorDatapoint
data InsightRuleContributorDatapoint Source #
One data point related to one contributor.
For more information, see GetInsightRuleReport and InsightRuleContributor.
See: newInsightRuleContributorDatapoint
smart constructor.
Instances
newInsightRuleContributorDatapoint Source #
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.
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.
InsightRuleMetricDatapoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) ISO8601 |
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.
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.
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.
MessageData
data MessageData Source #
A message returned by the GetMetricData
API, 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.
MessageData' (Maybe Text) (Maybe Text) |
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.
Metric
Represents a specific metric.
See: newMetric
smart constructor.
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 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.
MetricAlarm
data MetricAlarm Source #
The details about a metric alarm.
See: newMetricAlarm
smart constructor.
MetricAlarm' (Maybe Text) (Maybe ISO8601) (Maybe [MetricDataQuery]) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ComparisonOperator) (Maybe [Text]) (Maybe Text) (Maybe StateValue) (Maybe Natural) (Maybe Double) (Maybe ISO8601) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Dimension]) (Maybe Text) (Maybe [Text]) (Maybe StandardUnit) (Maybe Statistic) (Maybe Text) |
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.
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.
MetricDataQuery' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MetricStat) Text |
Instances
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.
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.
MetricDataResult' (Maybe [Double]) (Maybe Text) (Maybe [ISO8601]) (Maybe [MessageData]) (Maybe Text) (Maybe StatusCode) |
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.
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.
MetricDatum' (Maybe [Double]) (Maybe [Double]) (Maybe Double) (Maybe Natural) (Maybe [Dimension]) (Maybe StandardUnit) (Maybe ISO8601) (Maybe StatisticSet) Text |
Instances
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.
MetricStat
data MetricStat Source #
This structure defines the metric to be returned, along with the statistics, period, and units.
See: newMetricStat
smart constructor.
Instances
:: 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.
MetricStreamEntry
data MetricStreamEntry Source #
This structure contains the configuration information about one metric stream.
See: newMetricStreamEntry
smart constructor.
MetricStreamEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MetricStreamOutputFormat) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) |
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.
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.
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.
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.
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.
Range
Specifies one range of days or times to exclude from use for training an anomaly detection model.
See: newRange
smart constructor.
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 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
.
StatisticSet
data StatisticSet Source #
Represents a set of statistics that describes a specific metric.
See: newStatisticSet
smart constructor.
Instances
:: 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.
Tag
A key-value pair associated with a CloudWatch resource.
See: newTag
smart constructor.
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 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.