-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon CloudWatch SDK.
--
-- Derived from API version 2010-08-01 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- The types from this library are intended to be used with
-- amazonka, which provides mechanisms for specifying AuthN/AuthZ
-- information, sending requests, and receiving responses.
--
-- It is recommended to use generic lenses or optics from packages such
-- as generic-lens or optics to modify optional fields and
-- deconstruct responses.
--
-- Generated lenses can be found in Amazonka.CloudWatch.Lens and
-- are suitable for use with a lens package such as lens or
-- lens-family-core.
--
-- See Amazonka.CloudWatch and the AWS documentation to get
-- started.
@package amazonka-cloudwatch
@version 2.0
module Amazonka.CloudWatch.Types.ActionsSuppressedBy
newtype ActionsSuppressedBy
ActionsSuppressedBy' :: Text -> ActionsSuppressedBy
[fromActionsSuppressedBy] :: ActionsSuppressedBy -> Text
pattern ActionsSuppressedBy_Alarm :: ActionsSuppressedBy
pattern ActionsSuppressedBy_ExtensionPeriod :: ActionsSuppressedBy
pattern ActionsSuppressedBy_WaitPeriod :: ActionsSuppressedBy
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance GHC.Read.Read Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
instance GHC.Show.Show Amazonka.CloudWatch.Types.ActionsSuppressedBy.ActionsSuppressedBy
module Amazonka.CloudWatch.Types.AlarmType
newtype AlarmType
AlarmType' :: Text -> AlarmType
[fromAlarmType] :: AlarmType -> Text
pattern AlarmType_CompositeAlarm :: AlarmType
pattern AlarmType_MetricAlarm :: AlarmType
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance GHC.Read.Read Amazonka.CloudWatch.Types.AlarmType.AlarmType
instance GHC.Show.Show Amazonka.CloudWatch.Types.AlarmType.AlarmType
module Amazonka.CloudWatch.Types.AnomalyDetectorStateValue
newtype AnomalyDetectorStateValue
AnomalyDetectorStateValue' :: Text -> AnomalyDetectorStateValue
[fromAnomalyDetectorStateValue] :: AnomalyDetectorStateValue -> Text
pattern AnomalyDetectorStateValue_PENDING_TRAINING :: AnomalyDetectorStateValue
pattern AnomalyDetectorStateValue_TRAINED :: AnomalyDetectorStateValue
pattern AnomalyDetectorStateValue_TRAINED_INSUFFICIENT_DATA :: AnomalyDetectorStateValue
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance GHC.Read.Read Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
instance GHC.Show.Show Amazonka.CloudWatch.Types.AnomalyDetectorStateValue.AnomalyDetectorStateValue
module Amazonka.CloudWatch.Types.AnomalyDetectorType
newtype AnomalyDetectorType
AnomalyDetectorType' :: Text -> AnomalyDetectorType
[fromAnomalyDetectorType] :: AnomalyDetectorType -> Text
pattern AnomalyDetectorType_METRIC_MATH :: AnomalyDetectorType
pattern AnomalyDetectorType_SINGLE_METRIC :: AnomalyDetectorType
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance GHC.Read.Read Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
instance GHC.Show.Show Amazonka.CloudWatch.Types.AnomalyDetectorType.AnomalyDetectorType
module Amazonka.CloudWatch.Types.ComparisonOperator
newtype ComparisonOperator
ComparisonOperator' :: Text -> ComparisonOperator
[fromComparisonOperator] :: ComparisonOperator -> Text
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
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance GHC.Read.Read Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
instance GHC.Show.Show Amazonka.CloudWatch.Types.ComparisonOperator.ComparisonOperator
module Amazonka.CloudWatch.Types.DashboardEntry
-- | Represents a specific dashboard.
--
-- See: newDashboardEntry smart constructor.
data DashboardEntry
DashboardEntry' :: Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe Integer -> DashboardEntry
-- | The Amazon Resource Name (ARN) of the dashboard.
[$sel:dashboardArn:DashboardEntry'] :: DashboardEntry -> Maybe Text
-- | The name of the dashboard.
[$sel:dashboardName:DashboardEntry'] :: DashboardEntry -> Maybe Text
-- | 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:lastModified:DashboardEntry'] :: DashboardEntry -> Maybe ISO8601
-- | The size of the dashboard, in bytes.
[$sel:size:DashboardEntry'] :: DashboardEntry -> Maybe Integer
-- | 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:dashboardArn:DashboardEntry',
-- dashboardEntry_dashboardArn - The Amazon Resource Name (ARN) of
-- the dashboard.
--
-- $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:size:DashboardEntry', dashboardEntry_size - The
-- size of the dashboard, in bytes.
newDashboardEntry :: DashboardEntry
-- | The Amazon Resource Name (ARN) of the dashboard.
dashboardEntry_dashboardArn :: Lens' DashboardEntry (Maybe Text)
-- | The name of the dashboard.
dashboardEntry_dashboardName :: Lens' DashboardEntry (Maybe Text)
-- | The time stamp of when the dashboard was last modified, either by an
-- API call or through the console. This number is expressed as the
-- number of milliseconds since Jan 1, 1970 00:00:00 UTC.
dashboardEntry_lastModified :: Lens' DashboardEntry (Maybe UTCTime)
-- | The size of the dashboard, in bytes.
dashboardEntry_size :: Lens' DashboardEntry (Maybe Integer)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
instance GHC.Show.Show Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
instance GHC.Read.Read Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.DashboardEntry.DashboardEntry
module Amazonka.CloudWatch.Types.DashboardValidationMessage
-- | An error or warning for the operation.
--
-- See: newDashboardValidationMessage smart constructor.
data DashboardValidationMessage
DashboardValidationMessage' :: Maybe Text -> Maybe Text -> DashboardValidationMessage
-- | The data path related to the message.
[$sel:dataPath:DashboardValidationMessage'] :: DashboardValidationMessage -> Maybe Text
-- | A message describing the error or warning.
[$sel:message:DashboardValidationMessage'] :: DashboardValidationMessage -> Maybe Text
-- | 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.
newDashboardValidationMessage :: DashboardValidationMessage
-- | The data path related to the message.
dashboardValidationMessage_dataPath :: Lens' DashboardValidationMessage (Maybe Text)
-- | A message describing the error or warning.
dashboardValidationMessage_message :: Lens' DashboardValidationMessage (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
instance GHC.Show.Show Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
instance GHC.Read.Read Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.DashboardValidationMessage.DashboardValidationMessage
module Amazonka.CloudWatch.Types.Dimension
-- | A dimension is a name/value pair that is part of the identity of a
-- metric. Because dimensions are part of the unique identifier for a
-- metric, whenever you add a unique name/value pair to one of your
-- metrics, you are creating a new variation of that metric. For example,
-- many Amazon EC2 metrics publish InstanceId as a dimension
-- name, and the actual instance ID as the value for that dimension.
--
-- You can assign up to 30 dimensions to a metric.
--
-- See: newDimension smart constructor.
data Dimension
Dimension' :: Text -> Text -> Dimension
-- | The name of the dimension. Dimension names must contain only ASCII
-- characters, must include at least one non-whitespace character, and
-- cannot start with a colon (:).
[$sel:name:Dimension'] :: Dimension -> Text
-- | The value of the dimension. Dimension values must contain only ASCII
-- characters and must include at least one non-whitespace character.
[$sel:value:Dimension'] :: Dimension -> 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, must
-- include at least one non-whitespace character, and cannot start with a
-- colon (:).
--
-- $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.
newDimension :: Text -> Text -> Dimension
-- | The name of the dimension. Dimension names must contain only ASCII
-- characters, must include at least one non-whitespace character, and
-- cannot start with a colon (:).
dimension_name :: Lens' Dimension Text
-- | The value of the dimension. Dimension values must contain only ASCII
-- characters and must include at least one non-whitespace character.
dimension_value :: Lens' Dimension Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.Dimension.Dimension
instance GHC.Show.Show Amazonka.CloudWatch.Types.Dimension.Dimension
instance GHC.Read.Read Amazonka.CloudWatch.Types.Dimension.Dimension
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.Dimension.Dimension
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.Dimension.Dimension
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.Dimension.Dimension
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.Dimension.Dimension
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.Dimension.Dimension
module Amazonka.CloudWatch.Types.DimensionFilter
-- | Represents filters for a dimension.
--
-- See: newDimensionFilter smart constructor.
data DimensionFilter
DimensionFilter' :: Maybe Text -> Text -> DimensionFilter
-- | The value of the dimension to be matched.
[$sel:value:DimensionFilter'] :: DimensionFilter -> Maybe Text
-- | The dimension name to be matched.
[$sel:name:DimensionFilter'] :: DimensionFilter -> Text
-- | 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.
newDimensionFilter :: Text -> DimensionFilter
-- | The value of the dimension to be matched.
dimensionFilter_value :: Lens' DimensionFilter (Maybe Text)
-- | The dimension name to be matched.
dimensionFilter_name :: Lens' DimensionFilter Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
instance GHC.Show.Show Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
instance GHC.Read.Read Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.DimensionFilter.DimensionFilter
module Amazonka.CloudWatch.Types.EvaluationState
newtype EvaluationState
EvaluationState' :: Text -> EvaluationState
[fromEvaluationState] :: EvaluationState -> Text
pattern EvaluationState_PARTIAL_DATA :: EvaluationState
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance GHC.Read.Read Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
instance GHC.Show.Show Amazonka.CloudWatch.Types.EvaluationState.EvaluationState
module Amazonka.CloudWatch.Types.HistoryItemType
newtype HistoryItemType
HistoryItemType' :: Text -> HistoryItemType
[fromHistoryItemType] :: HistoryItemType -> Text
pattern HistoryItemType_Action :: HistoryItemType
pattern HistoryItemType_ConfigurationUpdate :: HistoryItemType
pattern HistoryItemType_StateUpdate :: HistoryItemType
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance GHC.Read.Read Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
instance GHC.Show.Show Amazonka.CloudWatch.Types.HistoryItemType.HistoryItemType
module Amazonka.CloudWatch.Types.AlarmHistoryItem
-- | Represents the history of a specific alarm.
--
-- See: newAlarmHistoryItem smart constructor.
data AlarmHistoryItem
AlarmHistoryItem' :: Maybe Text -> Maybe AlarmType -> Maybe Text -> Maybe HistoryItemType -> Maybe Text -> Maybe ISO8601 -> AlarmHistoryItem
-- | The descriptive name for the alarm.
[$sel:alarmName:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe Text
-- | The type of alarm, either metric alarm or composite alarm.
[$sel:alarmType:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe AlarmType
-- | Data about the alarm, in JSON format.
[$sel:historyData:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe Text
-- | The type of alarm history item.
[$sel:historyItemType:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe HistoryItemType
-- | A summary of the alarm history, in text format.
[$sel:historySummary:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe Text
-- | The time stamp for the alarm history item.
[$sel:timestamp:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe ISO8601
-- | 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:alarmType:AlarmHistoryItem',
-- alarmHistoryItem_alarmType - The type of alarm, either metric
-- alarm or composite alarm.
--
-- $sel:historyData:AlarmHistoryItem',
-- alarmHistoryItem_historyData - Data about the alarm, in JSON
-- format.
--
-- $sel:historyItemType:AlarmHistoryItem',
-- alarmHistoryItem_historyItemType - The type of alarm history
-- item.
--
-- $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.
newAlarmHistoryItem :: AlarmHistoryItem
-- | The descriptive name for the alarm.
alarmHistoryItem_alarmName :: Lens' AlarmHistoryItem (Maybe Text)
-- | The type of alarm, either metric alarm or composite alarm.
alarmHistoryItem_alarmType :: Lens' AlarmHistoryItem (Maybe AlarmType)
-- | Data about the alarm, in JSON format.
alarmHistoryItem_historyData :: Lens' AlarmHistoryItem (Maybe Text)
-- | The type of alarm history item.
alarmHistoryItem_historyItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType)
-- | A summary of the alarm history, in text format.
alarmHistoryItem_historySummary :: Lens' AlarmHistoryItem (Maybe Text)
-- | The time stamp for the alarm history item.
alarmHistoryItem_timestamp :: Lens' AlarmHistoryItem (Maybe UTCTime)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
instance GHC.Show.Show Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
instance GHC.Read.Read Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.AlarmHistoryItem.AlarmHistoryItem
module Amazonka.CloudWatch.Types.InsightRule
-- | This structure contains the definition for a Contributor Insights
-- rule. For more information about this rule, see Using Constributor
-- Insights to analyze high-cardinality data in the Amazon
-- CloudWatch User Guide.
--
-- See: newInsightRule smart constructor.
data InsightRule
InsightRule' :: Maybe Bool -> Text -> Text -> Text -> Text -> InsightRule
-- | An optional built-in rule that Amazon Web Services manages.
[$sel:managedRule:InsightRule'] :: InsightRule -> Maybe Bool
-- | The name of the rule.
[$sel:name:InsightRule'] :: InsightRule -> Text
-- | Indicates whether the rule is enabled or disabled.
[$sel:state:InsightRule'] :: InsightRule -> Text
-- | For rules that you create, this is always {"Name":
-- "CloudWatchLogRule", "Version": 1}. For managed rules, this is
-- {"Name": "ServiceLogRule", "Version": 1}
[$sel:schema:InsightRule'] :: InsightRule -> Text
-- | 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.
[$sel:definition:InsightRule'] :: InsightRule -> Text
-- | 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:managedRule:InsightRule', insightRule_managedRule -
-- An optional built-in rule that Amazon Web Services manages.
--
-- $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 managed 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.
newInsightRule :: Text -> Text -> Text -> Text -> InsightRule
-- | An optional built-in rule that Amazon Web Services manages.
insightRule_managedRule :: Lens' InsightRule (Maybe Bool)
-- | The name of the rule.
insightRule_name :: Lens' InsightRule Text
-- | Indicates whether the rule is enabled or disabled.
insightRule_state :: Lens' InsightRule Text
-- | For rules that you create, this is always {"Name":
-- "CloudWatchLogRule", "Version": 1}. For managed rules, this is
-- {"Name": "ServiceLogRule", "Version": 1}
insightRule_schema :: Lens' InsightRule Text
-- | The definition of the rule, as a JSON object. The definition contains
-- the keywords used to define contributors, the value to aggregate on if
-- this rule returns a sum instead of a count, and the filters. For
-- details on the valid syntax, see Contributor Insights Rule
-- Syntax.
insightRule_definition :: Lens' InsightRule Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.InsightRule.InsightRule
instance GHC.Show.Show Amazonka.CloudWatch.Types.InsightRule.InsightRule
instance GHC.Read.Read Amazonka.CloudWatch.Types.InsightRule.InsightRule
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.InsightRule.InsightRule
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.InsightRule.InsightRule
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.InsightRule.InsightRule
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.InsightRule.InsightRule
module Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint
-- | One data point related to one contributor.
--
-- For more information, see GetInsightRuleReport and
-- InsightRuleContributor.
--
-- See: newInsightRuleContributorDatapoint smart
-- constructor.
data InsightRuleContributorDatapoint
InsightRuleContributorDatapoint' :: ISO8601 -> Double -> InsightRuleContributorDatapoint
-- | The timestamp of the data point.
[$sel:timestamp:InsightRuleContributorDatapoint'] :: InsightRuleContributorDatapoint -> ISO8601
-- | The approximate value that this contributor added during this
-- timestamp.
[$sel:approximateValue:InsightRuleContributorDatapoint'] :: InsightRuleContributorDatapoint -> Double
-- | 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.
newInsightRuleContributorDatapoint :: UTCTime -> Double -> InsightRuleContributorDatapoint
-- | The timestamp of the data point.
insightRuleContributorDatapoint_timestamp :: Lens' InsightRuleContributorDatapoint UTCTime
-- | The approximate value that this contributor added during this
-- timestamp.
insightRuleContributorDatapoint_approximateValue :: Lens' InsightRuleContributorDatapoint Double
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
instance GHC.Show.Show Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
instance GHC.Read.Read Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.InsightRuleContributorDatapoint.InsightRuleContributorDatapoint
module Amazonka.CloudWatch.Types.InsightRuleContributor
-- | 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.
data InsightRuleContributor
InsightRuleContributor' :: [Text] -> Double -> [InsightRuleContributorDatapoint] -> InsightRuleContributor
-- | One of the log entry field keywords that is used to define
-- contributors for this rule.
[$sel:keys:InsightRuleContributor'] :: InsightRuleContributor -> [Text]
-- | An approximation of the aggregate value that comes from this
-- contributor.
[$sel:approximateAggregateValue:InsightRuleContributor'] :: InsightRuleContributor -> Double
-- | An array of the data points where this contributor is present. Only
-- the data points when this contributor appeared are included in the
-- array.
[$sel:datapoints:InsightRuleContributor'] :: InsightRuleContributor -> [InsightRuleContributorDatapoint]
-- | 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.
newInsightRuleContributor :: Double -> InsightRuleContributor
-- | One of the log entry field keywords that is used to define
-- contributors for this rule.
insightRuleContributor_keys :: Lens' InsightRuleContributor [Text]
-- | An approximation of the aggregate value that comes from this
-- contributor.
insightRuleContributor_approximateAggregateValue :: Lens' InsightRuleContributor Double
-- | An array of the data points where this contributor is present. Only
-- the data points when this contributor appeared are included in the
-- array.
insightRuleContributor_datapoints :: Lens' InsightRuleContributor [InsightRuleContributorDatapoint]
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
instance GHC.Show.Show Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
instance GHC.Read.Read Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.InsightRuleContributor.InsightRuleContributor
module Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint
-- | One data point from the metric time series returned in a Contributor
-- Insights rule report.
--
-- For more information, see GetInsightRuleReport.
--
-- See: newInsightRuleMetricDatapoint smart constructor.
data InsightRuleMetricDatapoint
InsightRuleMetricDatapoint' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> ISO8601 -> InsightRuleMetricDatapoint
-- | 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:average:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:maxContributorValue:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:maximum:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:minimum:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:sampleCount:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:sum:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:uniqueContributors:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | The timestamp of the data point.
[$sel:timestamp:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> ISO8601
-- | 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: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: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: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: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: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: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: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:timestamp:InsightRuleMetricDatapoint',
-- insightRuleMetricDatapoint_timestamp - The timestamp of the
-- data point.
newInsightRuleMetricDatapoint :: UTCTime -> InsightRuleMetricDatapoint
-- | The average value from all contributors during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_average :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The maximum value provided by one contributor during this timestamp.
-- Each timestamp is evaluated separately, so the identity of the max
-- contributor could be different for each timestamp.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_maxContributorValue :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The maximum value from a single occurence from a single contributor
-- during the time period represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_maximum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The minimum value from a single contributor during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_minimum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The number of occurrences that matched the rule during this data
-- point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_sampleCount :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The sum of the values from all contributors during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_sum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The number of unique contributors who published data during this
-- timestamp.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_uniqueContributors :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The timestamp of the data point.
insightRuleMetricDatapoint_timestamp :: Lens' InsightRuleMetricDatapoint UTCTime
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
instance GHC.Show.Show Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
instance GHC.Read.Read Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.InsightRuleMetricDatapoint.InsightRuleMetricDatapoint
module Amazonka.CloudWatch.Types.LabelOptions
-- | 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.
data LabelOptions
LabelOptions' :: Maybe Text -> LabelOptions
-- | 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.
[$sel:timezone:LabelOptions'] :: LabelOptions -> Maybe Text
-- | 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.
newLabelOptions :: LabelOptions
-- | The time zone to use for metric data return in this operation. The
-- format is + or - followed by four digits. The first
-- two digits indicate the number of hours ahead or behind of UTC, and
-- the final two digits are the number of minutes. For example, +0130
-- indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The
-- default is +0000.
labelOptions_timezone :: Lens' LabelOptions (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
instance GHC.Show.Show Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
instance GHC.Read.Read Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.LabelOptions.LabelOptions
module Amazonka.CloudWatch.Types.ManagedRuleState
-- | The status of a managed Contributor Insights rule.
--
-- See: newManagedRuleState smart constructor.
data ManagedRuleState
ManagedRuleState' :: Text -> Text -> ManagedRuleState
-- | The name of the Contributor Insights rule that contains data for the
-- specified Amazon Web Services resource.
[$sel:ruleName:ManagedRuleState'] :: ManagedRuleState -> Text
-- | Indicates whether the rule is enabled or disabled.
[$sel:state:ManagedRuleState'] :: ManagedRuleState -> Text
-- | Create a value of ManagedRuleState 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:ruleName:ManagedRuleState',
-- managedRuleState_ruleName - The name of the Contributor
-- Insights rule that contains data for the specified Amazon Web Services
-- resource.
--
-- $sel:state:ManagedRuleState', managedRuleState_state -
-- Indicates whether the rule is enabled or disabled.
newManagedRuleState :: Text -> Text -> ManagedRuleState
-- | The name of the Contributor Insights rule that contains data for the
-- specified Amazon Web Services resource.
managedRuleState_ruleName :: Lens' ManagedRuleState Text
-- | Indicates whether the rule is enabled or disabled.
managedRuleState_state :: Lens' ManagedRuleState Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
instance GHC.Show.Show Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
instance GHC.Read.Read Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.ManagedRuleState.ManagedRuleState
module Amazonka.CloudWatch.Types.ManagedRuleDescription
-- | Contains information about managed Contributor Insights rules, as
-- returned by ListManagedInsightRules.
--
-- See: newManagedRuleDescription smart constructor.
data ManagedRuleDescription
ManagedRuleDescription' :: Maybe Text -> Maybe ManagedRuleState -> Maybe Text -> ManagedRuleDescription
-- | If a managed rule is enabled, this is the ARN for the related Amazon
-- Web Services resource.
[$sel:resourceARN:ManagedRuleDescription'] :: ManagedRuleDescription -> Maybe Text
-- | Describes the state of a managed rule. If present, it contains
-- information about the Contributor Insights rule that contains
-- information about the related Amazon Web Services resource.
[$sel:ruleState:ManagedRuleDescription'] :: ManagedRuleDescription -> Maybe ManagedRuleState
-- | The template name for the managed rule. Used to enable managed rules
-- using PutManagedInsightRules.
[$sel:templateName:ManagedRuleDescription'] :: ManagedRuleDescription -> Maybe Text
-- | Create a value of ManagedRuleDescription 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:ManagedRuleDescription',
-- managedRuleDescription_resourceARN - If a managed rule is
-- enabled, this is the ARN for the related Amazon Web Services resource.
--
-- $sel:ruleState:ManagedRuleDescription',
-- managedRuleDescription_ruleState - Describes the state of a
-- managed rule. If present, it contains information about the
-- Contributor Insights rule that contains information about the related
-- Amazon Web Services resource.
--
-- $sel:templateName:ManagedRuleDescription',
-- managedRuleDescription_templateName - The template name for the
-- managed rule. Used to enable managed rules using
-- PutManagedInsightRules.
newManagedRuleDescription :: ManagedRuleDescription
-- | If a managed rule is enabled, this is the ARN for the related Amazon
-- Web Services resource.
managedRuleDescription_resourceARN :: Lens' ManagedRuleDescription (Maybe Text)
-- | Describes the state of a managed rule. If present, it contains
-- information about the Contributor Insights rule that contains
-- information about the related Amazon Web Services resource.
managedRuleDescription_ruleState :: Lens' ManagedRuleDescription (Maybe ManagedRuleState)
-- | The template name for the managed rule. Used to enable managed rules
-- using PutManagedInsightRules.
managedRuleDescription_templateName :: Lens' ManagedRuleDescription (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
instance GHC.Show.Show Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
instance GHC.Read.Read Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.ManagedRuleDescription.ManagedRuleDescription
module Amazonka.CloudWatch.Types.MessageData
-- | A message returned by the GetMetricDataAPI, including a code
-- and a description.
--
-- If a cross-Region GetMetricData operation fails with a code
-- of Forbidden and a value of Authentication too complex to
-- retrieve cross region data, you can correct the problem by
-- running the GetMetricData operation in the same Region where
-- the metric data is.
--
-- See: newMessageData smart constructor.
data MessageData
MessageData' :: Maybe Text -> Maybe Text -> MessageData
-- | The error code or status code associated with the message.
[$sel:code:MessageData'] :: MessageData -> Maybe Text
-- | The message text.
[$sel:value:MessageData'] :: MessageData -> Maybe Text
-- | 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:code:MessageData', messageData_code - The error
-- code or status code associated with the message.
--
-- $sel:value:MessageData', messageData_value - The message
-- text.
newMessageData :: MessageData
-- | The error code or status code associated with the message.
messageData_code :: Lens' MessageData (Maybe Text)
-- | The message text.
messageData_value :: Lens' MessageData (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MessageData.MessageData
instance GHC.Show.Show Amazonka.CloudWatch.Types.MessageData.MessageData
instance GHC.Read.Read Amazonka.CloudWatch.Types.MessageData.MessageData
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MessageData.MessageData
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MessageData.MessageData
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MessageData.MessageData
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MessageData.MessageData
module Amazonka.CloudWatch.Types.Metric
-- | Represents a specific metric.
--
-- See: newMetric smart constructor.
data Metric
Metric' :: Maybe [Dimension] -> Maybe Text -> Maybe Text -> Metric
-- | The dimensions for the metric.
[$sel:dimensions:Metric'] :: Metric -> Maybe [Dimension]
-- | The name of the metric. This is a required field.
[$sel:metricName:Metric'] :: Metric -> Maybe Text
-- | The namespace of the metric.
[$sel:namespace:Metric'] :: Metric -> Maybe Text
-- | 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:dimensions:Metric', metric_dimensions - The
-- dimensions for the metric.
--
-- $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.
newMetric :: Metric
-- | The dimensions for the metric.
metric_dimensions :: Lens' Metric (Maybe [Dimension])
-- | The name of the metric. This is a required field.
metric_metricName :: Lens' Metric (Maybe Text)
-- | The namespace of the metric.
metric_namespace :: Lens' Metric (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.Metric.Metric
instance GHC.Show.Show Amazonka.CloudWatch.Types.Metric.Metric
instance GHC.Read.Read Amazonka.CloudWatch.Types.Metric.Metric
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.Metric.Metric
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.Metric.Metric
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.Metric.Metric
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.Metric.Metric
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.Metric.Metric
module Amazonka.CloudWatch.Types.MetricStreamFilter
-- | 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.
data MetricStreamFilter
MetricStreamFilter' :: Maybe Text -> MetricStreamFilter
-- | The name of the metric namespace in the filter.
[$sel:namespace:MetricStreamFilter'] :: MetricStreamFilter -> Maybe Text
-- | 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.
newMetricStreamFilter :: MetricStreamFilter
-- | The name of the metric namespace in the filter.
metricStreamFilter_namespace :: Lens' MetricStreamFilter (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricStreamFilter.MetricStreamFilter
module Amazonka.CloudWatch.Types.MetricStreamOutputFormat
newtype MetricStreamOutputFormat
MetricStreamOutputFormat' :: Text -> MetricStreamOutputFormat
[fromMetricStreamOutputFormat] :: MetricStreamOutputFormat -> Text
pattern MetricStreamOutputFormat_Json :: MetricStreamOutputFormat
pattern MetricStreamOutputFormat_Opentelemetry0_7 :: MetricStreamOutputFormat
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricStreamOutputFormat.MetricStreamOutputFormat
module Amazonka.CloudWatch.Types.MetricStreamEntry
-- | This structure contains the configuration information about one metric
-- stream.
--
-- See: newMetricStreamEntry smart constructor.
data MetricStreamEntry
MetricStreamEntry' :: Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe MetricStreamOutputFormat -> Maybe Text -> MetricStreamEntry
-- | The ARN of the metric stream.
[$sel:arn:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | The date that the metric stream was originally created.
[$sel:creationDate:MetricStreamEntry'] :: MetricStreamEntry -> Maybe ISO8601
-- | The ARN of the Kinesis Firehose devlivery stream that is used for this
-- metric stream.
[$sel:firehoseArn:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | The date that the configuration of this metric stream was most
-- recently updated.
[$sel:lastUpdateDate:MetricStreamEntry'] :: MetricStreamEntry -> Maybe ISO8601
-- | The name of the metric stream.
[$sel:name:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | The output format of this metric stream. Valid values are
-- json and opentelemetry0.7.
[$sel:outputFormat:MetricStreamEntry'] :: MetricStreamEntry -> Maybe MetricStreamOutputFormat
-- | The current state of this stream. Valid values are running
-- and stopped.
[$sel:state:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | 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:arn:MetricStreamEntry', metricStreamEntry_arn - The
-- ARN of the metric stream.
--
-- $sel:creationDate:MetricStreamEntry',
-- metricStreamEntry_creationDate - The date that the metric
-- stream was originally created.
--
-- $sel:firehoseArn:MetricStreamEntry',
-- metricStreamEntry_firehoseArn - The ARN of the Kinesis Firehose
-- devlivery stream that is used for this metric stream.
--
-- $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:outputFormat:MetricStreamEntry',
-- metricStreamEntry_outputFormat - The output format of this
-- metric stream. Valid values are json and
-- opentelemetry0.7.
--
-- $sel:state:MetricStreamEntry', metricStreamEntry_state -
-- The current state of this stream. Valid values are running
-- and stopped.
newMetricStreamEntry :: MetricStreamEntry
-- | The ARN of the metric stream.
metricStreamEntry_arn :: Lens' MetricStreamEntry (Maybe Text)
-- | The date that the metric stream was originally created.
metricStreamEntry_creationDate :: Lens' MetricStreamEntry (Maybe UTCTime)
-- | The ARN of the Kinesis Firehose devlivery stream that is used for this
-- metric stream.
metricStreamEntry_firehoseArn :: Lens' MetricStreamEntry (Maybe Text)
-- | The date that the configuration of this metric stream was most
-- recently updated.
metricStreamEntry_lastUpdateDate :: Lens' MetricStreamEntry (Maybe UTCTime)
-- | The name of the metric stream.
metricStreamEntry_name :: Lens' MetricStreamEntry (Maybe Text)
-- | The output format of this metric stream. Valid values are
-- json and opentelemetry0.7.
metricStreamEntry_outputFormat :: Lens' MetricStreamEntry (Maybe MetricStreamOutputFormat)
-- | The current state of this stream. Valid values are running
-- and stopped.
metricStreamEntry_state :: Lens' MetricStreamEntry (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricStreamEntry.MetricStreamEntry
module Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric
-- | This object contains the information for one metric that is to be
-- streamed with additional statistics.
--
-- See: newMetricStreamStatisticsMetric smart constructor.
data MetricStreamStatisticsMetric
MetricStreamStatisticsMetric' :: Text -> Text -> MetricStreamStatisticsMetric
-- | The namespace of the metric.
[$sel:namespace:MetricStreamStatisticsMetric'] :: MetricStreamStatisticsMetric -> Text
-- | The name of the metric.
[$sel:metricName:MetricStreamStatisticsMetric'] :: MetricStreamStatisticsMetric -> Text
-- | Create a value of MetricStreamStatisticsMetric 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:MetricStreamStatisticsMetric',
-- metricStreamStatisticsMetric_namespace - The namespace of the
-- metric.
--
-- $sel:metricName:MetricStreamStatisticsMetric',
-- metricStreamStatisticsMetric_metricName - The name of the
-- metric.
newMetricStreamStatisticsMetric :: Text -> Text -> MetricStreamStatisticsMetric
-- | The namespace of the metric.
metricStreamStatisticsMetric_namespace :: Lens' MetricStreamStatisticsMetric Text
-- | The name of the metric.
metricStreamStatisticsMetric_metricName :: Lens' MetricStreamStatisticsMetric Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricStreamStatisticsMetric.MetricStreamStatisticsMetric
module Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration
-- | By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. This structure contains information for
-- one metric that includes additional statistics in the stream. For more
-- information about statistics, see CloudWatch, listed in CloudWatch
-- statistics definitions.
--
-- See: newMetricStreamStatisticsConfiguration smart
-- constructor.
data MetricStreamStatisticsConfiguration
MetricStreamStatisticsConfiguration' :: [MetricStreamStatisticsMetric] -> [Text] -> MetricStreamStatisticsConfiguration
-- | An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
[$sel:includeMetrics:MetricStreamStatisticsConfiguration'] :: MetricStreamStatisticsConfiguration -> [MetricStreamStatisticsMetric]
-- | The list of additional statistics that are to be streamed for the
-- metrics listed in the IncludeMetrics array in this structure.
-- This list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
[$sel:additionalStatistics:MetricStreamStatisticsConfiguration'] :: MetricStreamStatisticsConfiguration -> [Text]
-- | Create a value of MetricStreamStatisticsConfiguration 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:includeMetrics:MetricStreamStatisticsConfiguration',
-- metricStreamStatisticsConfiguration_includeMetrics - An array
-- of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
--
-- $sel:additionalStatistics:MetricStreamStatisticsConfiguration',
-- metricStreamStatisticsConfiguration_additionalStatistics - The
-- list of additional statistics that are to be streamed for the metrics
-- listed in the IncludeMetrics array in this structure. This
-- list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
newMetricStreamStatisticsConfiguration :: MetricStreamStatisticsConfiguration
-- | An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
metricStreamStatisticsConfiguration_includeMetrics :: Lens' MetricStreamStatisticsConfiguration [MetricStreamStatisticsMetric]
-- | The list of additional statistics that are to be streamed for the
-- metrics listed in the IncludeMetrics array in this structure.
-- This list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
metricStreamStatisticsConfiguration_additionalStatistics :: Lens' MetricStreamStatisticsConfiguration [Text]
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricStreamStatisticsConfiguration.MetricStreamStatisticsConfiguration
module Amazonka.CloudWatch.Types.PartialFailure
-- | 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.
data PartialFailure
PartialFailure' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> PartialFailure
-- | The type of error.
[$sel:exceptionType:PartialFailure'] :: PartialFailure -> Maybe Text
-- | The code of the error.
[$sel:failureCode:PartialFailure'] :: PartialFailure -> Maybe Text
-- | A description of the error.
[$sel:failureDescription:PartialFailure'] :: PartialFailure -> Maybe Text
-- | The specified rule that could not be deleted.
[$sel:failureResource:PartialFailure'] :: PartialFailure -> Maybe Text
-- | 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:exceptionType:PartialFailure',
-- partialFailure_exceptionType - The type of error.
--
-- $sel:failureCode:PartialFailure',
-- partialFailure_failureCode - The code of the error.
--
-- $sel:failureDescription:PartialFailure',
-- partialFailure_failureDescription - A description of the error.
--
-- $sel:failureResource:PartialFailure',
-- partialFailure_failureResource - The specified rule that could
-- not be deleted.
newPartialFailure :: PartialFailure
-- | The type of error.
partialFailure_exceptionType :: Lens' PartialFailure (Maybe Text)
-- | The code of the error.
partialFailure_failureCode :: Lens' PartialFailure (Maybe Text)
-- | A description of the error.
partialFailure_failureDescription :: Lens' PartialFailure (Maybe Text)
-- | The specified rule that could not be deleted.
partialFailure_failureResource :: Lens' PartialFailure (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
instance GHC.Show.Show Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
instance GHC.Read.Read Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.PartialFailure.PartialFailure
module Amazonka.CloudWatch.Types.Range
-- | Specifies one range of days or times to exclude from use for training
-- an anomaly detection model.
--
-- See: newRange smart constructor.
data Range
Range' :: ISO8601 -> ISO8601 -> Range
-- | 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:startTime:Range'] :: Range -> ISO8601
-- | 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.
[$sel:endTime:Range'] :: Range -> 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.
newRange :: UTCTime -> UTCTime -> Range
-- | The start time of the range to exclude. The format is
-- yyyy-MM-dd'T'HH:mm:ss. For example,
-- 2019-07-01T23:59:59.
range_startTime :: Lens' Range UTCTime
-- | The end time of the range to exclude. The format is
-- yyyy-MM-dd'T'HH:mm:ss. For example,
-- 2019-07-01T23:59:59.
range_endTime :: Lens' Range UTCTime
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.Range.Range
instance GHC.Show.Show Amazonka.CloudWatch.Types.Range.Range
instance GHC.Read.Read Amazonka.CloudWatch.Types.Range.Range
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.Range.Range
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.Range.Range
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.Range.Range
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.Range.Range
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.Range.Range
module Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration
-- | 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.
data AnomalyDetectorConfiguration
AnomalyDetectorConfiguration' :: Maybe [Range] -> Maybe Text -> AnomalyDetectorConfiguration
-- | 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.
[$sel:excludedTimeRanges:AnomalyDetectorConfiguration'] :: AnomalyDetectorConfiguration -> Maybe [Range]
-- | 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:metricTimezone:AnomalyDetectorConfiguration'] :: AnomalyDetectorConfiguration -> Maybe Text
-- | 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: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.
--
-- $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.
newAnomalyDetectorConfiguration :: AnomalyDetectorConfiguration
-- | An array of time ranges to exclude from use when the anomaly detection
-- model is trained. Use this to make sure that events that could cause
-- unusual values for the metric, such as deployments, aren't used when
-- CloudWatch creates the model.
anomalyDetectorConfiguration_excludedTimeRanges :: Lens' AnomalyDetectorConfiguration (Maybe [Range])
-- | The time zone to use for the metric. This is useful to enable the
-- model to automatically account for daylight savings time changes if
-- the metric is sensitive to such time changes.
--
-- To specify a time zone, use the name of the time zone as specified in
-- the standard tz database. For more information, see tz
-- database.
anomalyDetectorConfiguration_metricTimezone :: Lens' AnomalyDetectorConfiguration (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance GHC.Show.Show Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance GHC.Read.Read Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.AnomalyDetectorConfiguration.AnomalyDetectorConfiguration
module Amazonka.CloudWatch.Types.RecentlyActive
newtype RecentlyActive
RecentlyActive' :: Text -> RecentlyActive
[fromRecentlyActive] :: RecentlyActive -> Text
pattern RecentlyActive_PT3H :: RecentlyActive
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance GHC.Read.Read Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
instance GHC.Show.Show Amazonka.CloudWatch.Types.RecentlyActive.RecentlyActive
module Amazonka.CloudWatch.Types.ScanBy
newtype ScanBy
ScanBy' :: Text -> ScanBy
[fromScanBy] :: ScanBy -> Text
pattern ScanBy_TimestampAscending :: ScanBy
pattern ScanBy_TimestampDescending :: ScanBy
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance GHC.Read.Read Amazonka.CloudWatch.Types.ScanBy.ScanBy
instance GHC.Show.Show Amazonka.CloudWatch.Types.ScanBy.ScanBy
module Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector
-- | Designates the CloudWatch metric and statistic that provides the time
-- series the anomaly detector uses as input.
--
-- See: newSingleMetricAnomalyDetector smart constructor.
data SingleMetricAnomalyDetector
SingleMetricAnomalyDetector' :: Maybe [Dimension] -> Maybe Text -> Maybe Text -> Maybe Text -> SingleMetricAnomalyDetector
-- | The metric dimensions to create the anomaly detection model for.
[$sel:dimensions:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe [Dimension]
-- | The name of the metric to create the anomaly detection model for.
[$sel:metricName:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe Text
-- | The namespace of the metric to create the anomaly detection model for.
[$sel:namespace:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe Text
-- | The statistic to use for the metric and anomaly detection model.
[$sel:stat:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe Text
-- | Create a value of SingleMetricAnomalyDetector 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:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_dimensions - The metric dimensions
-- to create the anomaly detection model for.
--
-- $sel:metricName:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_metricName - The name of the metric
-- to create the anomaly detection model for.
--
-- $sel:namespace:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_namespace - The namespace of the
-- metric to create the anomaly detection model for.
--
-- $sel:stat:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_stat - The statistic to use for the
-- metric and anomaly detection model.
newSingleMetricAnomalyDetector :: SingleMetricAnomalyDetector
-- | The metric dimensions to create the anomaly detection model for.
singleMetricAnomalyDetector_dimensions :: Lens' SingleMetricAnomalyDetector (Maybe [Dimension])
-- | The name of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector_metricName :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The namespace of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector_namespace :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The statistic to use for the metric and anomaly detection model.
singleMetricAnomalyDetector_stat :: Lens' SingleMetricAnomalyDetector (Maybe Text)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance GHC.Show.Show Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance GHC.Read.Read Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.SingleMetricAnomalyDetector.SingleMetricAnomalyDetector
module Amazonka.CloudWatch.Types.StandardUnit
newtype StandardUnit
StandardUnit' :: Text -> StandardUnit
[fromStandardUnit] :: StandardUnit -> Text
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
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance GHC.Read.Read Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
instance GHC.Show.Show Amazonka.CloudWatch.Types.StandardUnit.StandardUnit
module Amazonka.CloudWatch.Types.MetricStat
-- | This structure defines the metric to be returned, along with the
-- statistics, period, and units.
--
-- See: newMetricStat smart constructor.
data MetricStat
MetricStat' :: Maybe StandardUnit -> Metric -> Natural -> Text -> MetricStat
-- | 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:unit:MetricStat'] :: MetricStat -> Maybe StandardUnit
-- | The metric to return, including the metric name, namespace, and
-- dimensions.
[$sel:metric:MetricStat'] :: MetricStat -> Metric
-- | 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:period:MetricStat'] :: MetricStat -> Natural
-- | The statistic to return. It can include any CloudWatch statistic or
-- extended statistic.
[$sel:stat:MetricStat'] :: MetricStat -> Text
-- | 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.
newMetricStat :: Metric -> Natural -> Text -> MetricStat
-- | When you are using a Put operation, this defines what unit
-- you want to use when storing the metric.
--
-- In a Get operation, if you omit Unit then all data
-- that was collected with any unit is returned, along with the
-- corresponding units that were specified when the data was reported to
-- CloudWatch. If you specify a unit, the operation returns only data
-- that was collected with that unit specified. If you specify a unit
-- that does not match the data collected, the results of the operation
-- are null. CloudWatch does not perform unit conversions.
metricStat_unit :: Lens' MetricStat (Maybe StandardUnit)
-- | The metric to return, including the metric name, namespace, and
-- dimensions.
metricStat_metric :: Lens' MetricStat Metric
-- | The granularity, in seconds, of the returned data points. For metrics
-- with regular resolution, a period can be as short as one minute (60
-- seconds) and must be a multiple of 60. For high-resolution metrics
-- that are collected at intervals of less than one minute, the period
-- can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
-- metrics are those metrics stored by a PutMetricData call that
-- includes a StorageResolution of 1 second.
--
-- If the StartTime parameter specifies a time stamp that is
-- greater than 3 hours ago, you must specify the period as follows or no
-- data points in that time range is returned:
--
--
-- - Start time between 3 hours and 15 days ago - Use a multiple of 60
-- seconds (1 minute).
-- - Start time between 15 and 63 days ago - Use a multiple of 300
-- seconds (5 minutes).
-- - Start time greater than 63 days ago - Use a multiple of 3600
-- seconds (1 hour).
--
metricStat_period :: Lens' MetricStat Natural
-- | The statistic to return. It can include any CloudWatch statistic or
-- extended statistic.
metricStat_stat :: Lens' MetricStat Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricStat.MetricStat
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricStat.MetricStat
module Amazonka.CloudWatch.Types.MetricDataQuery
-- | This structure is used in both GetMetricData and
-- PutMetricAlarm. The supported use of this structure is
-- different for those two operations.
--
-- When used in GetMetricData, it indicates the metric data to
-- return, and whether this call is just retrieving a batch set of data
-- for one metric, or is performing a Metrics Insights query or a math
-- expression. A single GetMetricData call can include up to 500
-- MetricDataQuery structures.
--
-- When used in PutMetricAlarm, it enables you to create an
-- alarm based on a metric math expression. Each MetricDataQuery
-- in the array specifies either a metric to retrieve, or a math
-- expression to be performed on retrieved metrics. A single
-- PutMetricAlarm call can include up to 20
-- MetricDataQuery structures in the array. The 20 structures
-- can include as many as 10 structures that contain a
-- MetricStat parameter to retrieve a metric, and as many as 10
-- structures that contain the Expression parameter to perform a
-- math expression. Of those Expression structures, one must
-- have true as the value for ReturnData. The result of
-- this expression is the value the alarm watches.
--
-- Any expression used in a PutMetricAlarm operation must return
-- a single time series. For more information, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Some of the parameters of this structure also have different uses
-- whether you are using this structure in a GetMetricData
-- operation or a PutMetricAlarm operation. These differences
-- are explained in the following parameter list.
--
-- See: newMetricDataQuery smart constructor.
data MetricDataQuery
MetricDataQuery' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe MetricStat -> Maybe Natural -> Maybe Bool -> Text -> MetricDataQuery
-- | The ID of the account where the metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
[$sel:accountId:MetricDataQuery'] :: MetricDataQuery -> Maybe Text
-- | This field can contain either a Metrics Insights query, or a metric
-- math expression to be performed on the returned data. For more
-- information about Metrics Insights queries, see Metrics Insights
-- query components and syntax in the Amazon CloudWatch User
-- Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
[$sel:expression:MetricDataQuery'] :: MetricDataQuery -> Maybe Text
-- | 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:label:MetricDataQuery'] :: MetricDataQuery -> Maybe Text
-- | 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:metricStat:MetricDataQuery'] :: MetricDataQuery -> Maybe MetricStat
-- | 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:period:MetricDataQuery'] :: MetricDataQuery -> Maybe Natural
-- | 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:returnData:MetricDataQuery'] :: MetricDataQuery -> Maybe Bool
-- | 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.
[$sel:id:MetricDataQuery'] :: MetricDataQuery -> Text
-- | 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:accountId:MetricDataQuery',
-- metricDataQuery_accountId - The ID of the account where the
-- metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
--
-- $sel:expression:MetricDataQuery',
-- metricDataQuery_expression - This field can contain either a
-- Metrics Insights query, or a metric math expression to be performed on
-- the returned data. For more information about Metrics Insights
-- queries, see Metrics Insights query components and syntax in
-- the Amazon CloudWatch User Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
--
-- $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.
--
-- 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: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: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.
newMetricDataQuery :: Text -> MetricDataQuery
-- | The ID of the account where the metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
metricDataQuery_accountId :: Lens' MetricDataQuery (Maybe Text)
-- | This field can contain either a Metrics Insights query, or a metric
-- math expression to be performed on the returned data. For more
-- information about Metrics Insights queries, see Metrics Insights
-- query components and syntax in the Amazon CloudWatch User
-- Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text)
-- | A human-readable label for this metric or expression. This is
-- especially useful if this is an expression, so that you know what the
-- value represents. If the metric or expression is shown in a CloudWatch
-- dashboard widget, the label is shown. If Label is omitted, CloudWatch
-- generates a default.
--
-- You can put dynamic expressions into a label, so that it is more
-- descriptive. For more information, see Using Dynamic Labels.
metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text)
-- | The metric to be returned, along with statistics, period, and units.
-- Use this parameter only if this object is retrieving a metric and not
-- performing a math expression on returned data.
--
-- Within one MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat)
-- | The granularity, in seconds, of the returned data points. For metrics
-- with regular resolution, a period can be as short as one minute (60
-- seconds) and must be a multiple of 60. For high-resolution metrics
-- that are collected at intervals of less than one minute, the period
-- can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
-- metrics are those metrics stored by a PutMetricData operation
-- that includes a StorageResolution of 1 second.
metricDataQuery_period :: Lens' MetricDataQuery (Maybe Natural)
-- | When used in GetMetricData, this option indicates whether to
-- return the timestamps and raw data values of this metric. If you are
-- performing this call just to do math expressions and do not also need
-- the raw data returned, you can specify false. If you omit
-- this, the default of true is used.
--
-- When used in PutMetricAlarm, specify true for the
-- one expression result to use as the alarm. For all other metrics and
-- expressions in the same PutMetricAlarm operation, specify
-- ReturnData as False.
metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool)
-- | A short name used to tie this object to the results in the response.
-- This name must be unique within a single call to
-- GetMetricData. If you are performing math expressions on this
-- set of data, this name represents that data and can serve as a
-- variable in the mathematical expression. The valid characters are
-- letters, numbers, and underscore. The first character must be a
-- lowercase letter.
metricDataQuery_id :: Lens' MetricDataQuery Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricDataQuery.MetricDataQuery
module Amazonka.CloudWatch.Types.MetricMathAnomalyDetector
-- | Indicates the CloudWatch math expression that provides the time series
-- the anomaly detector uses as input. The designated math expression
-- must return a single time series.
--
-- See: newMetricMathAnomalyDetector smart constructor.
data MetricMathAnomalyDetector
MetricMathAnomalyDetector' :: Maybe [MetricDataQuery] -> MetricMathAnomalyDetector
-- | An array of metric data query structures that enables you to create an
-- anomaly detector based on the result of a metric math expression. Each
-- item in MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
[$sel:metricDataQueries:MetricMathAnomalyDetector'] :: MetricMathAnomalyDetector -> Maybe [MetricDataQuery]
-- | Create a value of MetricMathAnomalyDetector 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:metricDataQueries:MetricMathAnomalyDetector',
-- metricMathAnomalyDetector_metricDataQueries - An array of
-- metric data query structures that enables you to create an anomaly
-- detector based on the result of a metric math expression. Each item in
-- MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
newMetricMathAnomalyDetector :: MetricMathAnomalyDetector
-- | An array of metric data query structures that enables you to create an
-- anomaly detector based on the result of a metric math expression. Each
-- item in MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
metricMathAnomalyDetector_metricDataQueries :: Lens' MetricMathAnomalyDetector (Maybe [MetricDataQuery])
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricMathAnomalyDetector.MetricMathAnomalyDetector
module Amazonka.CloudWatch.Types.AnomalyDetector
-- | An anomaly detection model associated with a particular CloudWatch
-- metric, statistic, or metric math expression. You can use the model to
-- display a band of expected, normal values when the metric is graphed.
--
-- See: newAnomalyDetector smart constructor.
data AnomalyDetector
AnomalyDetector' :: Maybe AnomalyDetectorConfiguration -> Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe Text -> Maybe AnomalyDetectorStateValue -> AnomalyDetector
-- | 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:configuration:AnomalyDetector'] :: AnomalyDetector -> Maybe AnomalyDetectorConfiguration
-- | The metric dimensions associated with the anomaly detection model.
[$sel:dimensions:AnomalyDetector'] :: AnomalyDetector -> Maybe [Dimension]
-- | The CloudWatch metric math expression for this anomaly detector.
[$sel:metricMathAnomalyDetector:AnomalyDetector'] :: AnomalyDetector -> Maybe MetricMathAnomalyDetector
-- | The name of the metric associated with the anomaly detection model.
[$sel:metricName:AnomalyDetector'] :: AnomalyDetector -> Maybe Text
-- | The namespace of the metric associated with the anomaly detection
-- model.
[$sel:namespace:AnomalyDetector'] :: AnomalyDetector -> Maybe Text
-- | The CloudWatch metric and statistic for this anomaly detector.
[$sel:singleMetricAnomalyDetector:AnomalyDetector'] :: AnomalyDetector -> Maybe SingleMetricAnomalyDetector
-- | The statistic associated with the anomaly detection model.
[$sel:stat:AnomalyDetector'] :: AnomalyDetector -> Maybe Text
-- | The current status of the anomaly detector's training. The possible
-- values are TRAINED | PENDING_TRAINING |
-- TRAINED_INSUFFICIENT_DATA
[$sel:stateValue:AnomalyDetector'] :: AnomalyDetector -> Maybe AnomalyDetectorStateValue
-- | 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: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.
--
-- AnomalyDetector, anomalyDetector_dimensions - The metric
-- dimensions associated with the anomaly detection model.
--
-- $sel:metricMathAnomalyDetector:AnomalyDetector',
-- anomalyDetector_metricMathAnomalyDetector - The CloudWatch
-- metric math expression for this anomaly detector.
--
-- AnomalyDetector, anomalyDetector_metricName - The name
-- of the metric associated with the anomaly detection model.
--
-- AnomalyDetector, anomalyDetector_namespace - The
-- namespace of the metric associated with the anomaly detection model.
--
-- $sel:singleMetricAnomalyDetector:AnomalyDetector',
-- anomalyDetector_singleMetricAnomalyDetector - The CloudWatch
-- metric and statistic for this anomaly detector.
--
-- AnomalyDetector, anomalyDetector_stat - The statistic
-- 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
newAnomalyDetector :: AnomalyDetector
-- | The configuration specifies details about how the anomaly detection
-- model is to be trained, including time ranges to exclude from use for
-- training the model, and the time zone to use for the metric.
anomalyDetector_configuration :: Lens' AnomalyDetector (Maybe AnomalyDetectorConfiguration)
-- | The metric dimensions associated with the anomaly detection model.
anomalyDetector_dimensions :: Lens' AnomalyDetector (Maybe [Dimension])
-- | The CloudWatch metric math expression for this anomaly detector.
anomalyDetector_metricMathAnomalyDetector :: Lens' AnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The name of the metric associated with the anomaly detection model.
anomalyDetector_metricName :: Lens' AnomalyDetector (Maybe Text)
-- | The namespace of the metric associated with the anomaly detection
-- model.
anomalyDetector_namespace :: Lens' AnomalyDetector (Maybe Text)
-- | The CloudWatch metric and statistic for this anomaly detector.
anomalyDetector_singleMetricAnomalyDetector :: Lens' AnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic associated with the anomaly detection model.
anomalyDetector_stat :: Lens' AnomalyDetector (Maybe Text)
-- | The current status of the anomaly detector's training. The possible
-- values are TRAINED | PENDING_TRAINING |
-- TRAINED_INSUFFICIENT_DATA
anomalyDetector_stateValue :: Lens' AnomalyDetector (Maybe AnomalyDetectorStateValue)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
instance GHC.Show.Show Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
instance GHC.Read.Read Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.AnomalyDetector.AnomalyDetector
module Amazonka.CloudWatch.Types.Datapoint
-- | Encapsulates the statistical data that CloudWatch computes from metric
-- data.
--
-- See: newDatapoint smart constructor.
data Datapoint
Datapoint' :: Maybe Double -> Maybe (HashMap Text Double) -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe ISO8601 -> Maybe StandardUnit -> Datapoint
-- | The average of the metric values that correspond to the data point.
[$sel:average:Datapoint'] :: Datapoint -> Maybe Double
-- | The percentile statistic for the data point.
[$sel:extendedStatistics:Datapoint'] :: Datapoint -> Maybe (HashMap Text Double)
-- | The maximum metric value for the data point.
[$sel:maximum:Datapoint'] :: Datapoint -> Maybe Double
-- | The minimum metric value for the data point.
[$sel:minimum:Datapoint'] :: Datapoint -> Maybe Double
-- | The number of metric values that contributed to the aggregate value of
-- this data point.
[$sel:sampleCount:Datapoint'] :: Datapoint -> Maybe Double
-- | The sum of the metric values for the data point.
[$sel:sum:Datapoint'] :: Datapoint -> Maybe Double
-- | The time stamp used for the data point.
[$sel:timestamp:Datapoint'] :: Datapoint -> Maybe ISO8601
-- | The standard unit for the data point.
[$sel:unit:Datapoint'] :: Datapoint -> Maybe StandardUnit
-- | 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:average:Datapoint', datapoint_average - The average
-- of the metric values that correspond to the data point.
--
-- $sel:extendedStatistics:Datapoint',
-- datapoint_extendedStatistics - The percentile statistic for the
-- data point.
--
-- $sel:maximum:Datapoint', datapoint_maximum - The maximum
-- metric value for the data point.
--
-- $sel:minimum:Datapoint', datapoint_minimum - The minimum
-- metric value for the data point.
--
-- $sel:sampleCount:Datapoint', datapoint_sampleCount - The
-- number of metric values that contributed to the aggregate value of
-- this data point.
--
-- $sel:sum:Datapoint', datapoint_sum - The sum of the
-- metric values for the data point.
--
-- $sel:timestamp:Datapoint', datapoint_timestamp - The
-- time stamp used for the data point.
--
-- $sel:unit:Datapoint', datapoint_unit - The standard unit
-- for the data point.
newDatapoint :: Datapoint
-- | The average of the metric values that correspond to the data point.
datapoint_average :: Lens' Datapoint (Maybe Double)
-- | The percentile statistic for the data point.
datapoint_extendedStatistics :: Lens' Datapoint (Maybe (HashMap Text Double))
-- | The maximum metric value for the data point.
datapoint_maximum :: Lens' Datapoint (Maybe Double)
-- | The minimum metric value for the data point.
datapoint_minimum :: Lens' Datapoint (Maybe Double)
-- | The number of metric values that contributed to the aggregate value of
-- this data point.
datapoint_sampleCount :: Lens' Datapoint (Maybe Double)
-- | The sum of the metric values for the data point.
datapoint_sum :: Lens' Datapoint (Maybe Double)
-- | The time stamp used for the data point.
datapoint_timestamp :: Lens' Datapoint (Maybe UTCTime)
-- | The standard unit for the data point.
datapoint_unit :: Lens' Datapoint (Maybe StandardUnit)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.Datapoint.Datapoint
instance GHC.Show.Show Amazonka.CloudWatch.Types.Datapoint.Datapoint
instance GHC.Read.Read Amazonka.CloudWatch.Types.Datapoint.Datapoint
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.Datapoint.Datapoint
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.Datapoint.Datapoint
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.Datapoint.Datapoint
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.Datapoint.Datapoint
module Amazonka.CloudWatch.Types.StateValue
newtype StateValue
StateValue' :: Text -> StateValue
[fromStateValue] :: StateValue -> Text
pattern StateValue_ALARM :: StateValue
pattern StateValue_INSUFFICIENT_DATA :: StateValue
pattern StateValue_OK :: StateValue
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.StateValue.StateValue
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.StateValue.StateValue
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.StateValue.StateValue
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.StateValue.StateValue
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.StateValue.StateValue
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.StateValue.StateValue
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.StateValue.StateValue
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.StateValue.StateValue
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.StateValue.StateValue
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.StateValue.StateValue
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.StateValue.StateValue
instance GHC.Read.Read Amazonka.CloudWatch.Types.StateValue.StateValue
instance GHC.Show.Show Amazonka.CloudWatch.Types.StateValue.StateValue
module Amazonka.CloudWatch.Types.CompositeAlarm
-- | The details about a composite alarm.
--
-- See: newCompositeAlarm smart constructor.
data CompositeAlarm
CompositeAlarm' :: Maybe Bool -> Maybe ActionsSuppressedBy -> Maybe Text -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe [Text] -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe ISO8601 -> Maybe StateValue -> CompositeAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
[$sel:actionsEnabled:CompositeAlarm'] :: CompositeAlarm -> Maybe Bool
-- | When the value is ALARM, it means that the actions are
-- suppressed because the suppressor alarm is in ALARM When the
-- value is WaitPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting for the suppressor alarm to go
-- into into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
[$sel:actionsSuppressedBy:CompositeAlarm'] :: CompositeAlarm -> Maybe ActionsSuppressedBy
-- | Captures the reason for action suppression.
[$sel:actionsSuppressedReason:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
[$sel:actionsSuppressor:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
[$sel:actionsSuppressorExtensionPeriod:CompositeAlarm'] :: CompositeAlarm -> Maybe Int
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
[$sel:actionsSuppressorWaitPeriod:CompositeAlarm'] :: CompositeAlarm -> Maybe Int
-- | 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:alarmActions:CompositeAlarm'] :: CompositeAlarm -> Maybe [Text]
-- | The Amazon Resource Name (ARN) of the alarm.
[$sel:alarmArn:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The time stamp of the last update to the alarm configuration.
[$sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm'] :: CompositeAlarm -> Maybe ISO8601
-- | The description of the alarm.
[$sel:alarmDescription:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The name of the alarm.
[$sel:alarmName:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The rule that this alarm uses to evaluate its alarm state.
[$sel:alarmRule:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | 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:insufficientDataActions:CompositeAlarm'] :: CompositeAlarm -> Maybe [Text]
-- | 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:oKActions:CompositeAlarm'] :: CompositeAlarm -> Maybe [Text]
-- | An explanation for the alarm state, in text format.
[$sel:stateReason:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | An explanation for the alarm state, in JSON format.
[$sel:stateReasonData:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The timestamp of the last change to the alarm's StateValue.
[$sel:stateTransitionedTimestamp:CompositeAlarm'] :: CompositeAlarm -> Maybe ISO8601
-- | Tracks the timestamp of any state update, even if StateValue
-- doesn't change.
[$sel:stateUpdatedTimestamp:CompositeAlarm'] :: CompositeAlarm -> Maybe ISO8601
-- | The state value for the alarm.
[$sel:stateValue:CompositeAlarm'] :: CompositeAlarm -> Maybe StateValue
-- | 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:actionsEnabled:CompositeAlarm',
-- compositeAlarm_actionsEnabled - Indicates whether actions
-- should be executed during any changes to the alarm state.
--
-- $sel:actionsSuppressedBy:CompositeAlarm',
-- compositeAlarm_actionsSuppressedBy - When the value is
-- ALARM, it means that the actions are suppressed because the
-- suppressor alarm is in ALARM When the value is
-- WaitPeriod, it means that the actions are suppressed because
-- the composite alarm is waiting for the suppressor alarm to go into
-- into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
--
-- $sel:actionsSuppressedReason:CompositeAlarm',
-- compositeAlarm_actionsSuppressedReason - Captures the reason
-- for action suppression.
--
-- $sel:actionsSuppressor:CompositeAlarm',
-- compositeAlarm_actionsSuppressor - Actions will be suppressed
-- if the suppressor alarm is in the ALARM state.
-- ActionsSuppressor can be an AlarmName or an Amazon Resource
-- Name (ARN) from an existing alarm.
--
-- $sel:actionsSuppressorExtensionPeriod:CompositeAlarm',
-- compositeAlarm_actionsSuppressorExtensionPeriod - The maximum
-- time in seconds that the composite alarm waits after suppressor alarm
-- goes out of the ALARM state. After this time, the composite
-- alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
--
-- $sel:actionsSuppressorWaitPeriod:CompositeAlarm',
-- compositeAlarm_actionsSuppressorWaitPeriod - The maximum time
-- in seconds that the composite alarm waits for the suppressor alarm to
-- go into the ALARM state. After this time, the composite alarm
-- performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
--
-- $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).
--
-- $sel:alarmArn:CompositeAlarm', compositeAlarm_alarmArn -
-- The Amazon Resource Name (ARN) of the alarm.
--
-- $sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm',
-- compositeAlarm_alarmConfigurationUpdatedTimestamp - The time
-- stamp of the last update to the alarm configuration.
--
-- $sel:alarmDescription:CompositeAlarm',
-- compositeAlarm_alarmDescription - The description of the alarm.
--
-- $sel:alarmName:CompositeAlarm', compositeAlarm_alarmName
-- - The name of the alarm.
--
-- $sel:alarmRule:CompositeAlarm', compositeAlarm_alarmRule
-- - The rule that this alarm uses to evaluate its 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: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: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:stateTransitionedTimestamp:CompositeAlarm',
-- compositeAlarm_stateTransitionedTimestamp - The timestamp of
-- the last change to the alarm's StateValue.
--
-- $sel:stateUpdatedTimestamp:CompositeAlarm',
-- compositeAlarm_stateUpdatedTimestamp - Tracks the timestamp of
-- any state update, even if StateValue doesn't change.
--
-- $sel:stateValue:CompositeAlarm',
-- compositeAlarm_stateValue - The state value for the alarm.
newCompositeAlarm :: CompositeAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool)
-- | When the value is ALARM, it means that the actions are
-- suppressed because the suppressor alarm is in ALARM When the
-- value is WaitPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting for the suppressor alarm to go
-- into into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
compositeAlarm_actionsSuppressedBy :: Lens' CompositeAlarm (Maybe ActionsSuppressedBy)
-- | Captures the reason for action suppression.
compositeAlarm_actionsSuppressedReason :: Lens' CompositeAlarm (Maybe Text)
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
compositeAlarm_actionsSuppressor :: Lens' CompositeAlarm (Maybe Text)
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
compositeAlarm_actionsSuppressorExtensionPeriod :: Lens' CompositeAlarm (Maybe Int)
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
compositeAlarm_actionsSuppressorWaitPeriod :: Lens' CompositeAlarm (Maybe Int)
-- | The actions to execute when this alarm transitions to the ALARM state
-- from any other state. Each action is specified as an Amazon Resource
-- Name (ARN).
compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text])
-- | The Amazon Resource Name (ARN) of the alarm.
compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text)
-- | The time stamp of the last update to the alarm configuration.
compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | The description of the alarm.
compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text)
-- | The name of the alarm.
compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text)
-- | The rule that this alarm uses to evaluate its alarm state.
compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the
-- INSUFFICIENT_DATA state from any other state. Each action is specified
-- as an Amazon Resource Name (ARN).
compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text])
-- | The actions to execute when this alarm transitions to the OK state
-- from any other state. Each action is specified as an Amazon Resource
-- Name (ARN).
compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text])
-- | An explanation for the alarm state, in text format.
compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text)
-- | An explanation for the alarm state, in JSON format.
compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text)
-- | The timestamp of the last change to the alarm's StateValue.
compositeAlarm_stateTransitionedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | Tracks the timestamp of any state update, even if StateValue
-- doesn't change.
compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | The state value for the alarm.
compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
instance GHC.Show.Show Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
instance GHC.Read.Read Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.CompositeAlarm.CompositeAlarm
module Amazonka.CloudWatch.Types.Statistic
newtype Statistic
Statistic' :: Text -> Statistic
[fromStatistic] :: Statistic -> Text
pattern Statistic_Average :: Statistic
pattern Statistic_Maximum :: Statistic
pattern Statistic_Minimum :: Statistic
pattern Statistic_SampleCount :: Statistic
pattern Statistic_Sum :: Statistic
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.Statistic.Statistic
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.Statistic.Statistic
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.Statistic.Statistic
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.Statistic.Statistic
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.Statistic.Statistic
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.Statistic.Statistic
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.Statistic.Statistic
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.Statistic.Statistic
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.Statistic.Statistic
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.Statistic.Statistic
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.Statistic.Statistic
instance GHC.Read.Read Amazonka.CloudWatch.Types.Statistic.Statistic
instance GHC.Show.Show Amazonka.CloudWatch.Types.Statistic.Statistic
module Amazonka.CloudWatch.Types.MetricAlarm
-- | The details about a metric alarm.
--
-- See: newMetricAlarm smart constructor.
data MetricAlarm
MetricAlarm' :: Maybe Bool -> Maybe [Text] -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe Text -> Maybe ComparisonOperator -> Maybe Natural -> Maybe [Dimension] -> Maybe Text -> Maybe Natural -> Maybe EvaluationState -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe [MetricDataQuery] -> Maybe Text -> Maybe [Text] -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe ISO8601 -> Maybe StateValue -> Maybe Statistic -> Maybe Double -> Maybe Text -> Maybe Text -> Maybe StandardUnit -> MetricAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
[$sel:actionsEnabled:MetricAlarm'] :: MetricAlarm -> Maybe Bool
-- | 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:alarmActions:MetricAlarm'] :: MetricAlarm -> Maybe [Text]
-- | The Amazon Resource Name (ARN) of the alarm.
[$sel:alarmArn:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The time stamp of the last update to the alarm configuration.
[$sel:alarmConfigurationUpdatedTimestamp:MetricAlarm'] :: MetricAlarm -> Maybe ISO8601
-- | The description of the alarm.
[$sel:alarmDescription:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The name of the alarm.
[$sel:alarmName:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The arithmetic operation to use when comparing the specified statistic
-- and threshold. The specified statistic value is used as the first
-- operand.
[$sel:comparisonOperator:MetricAlarm'] :: MetricAlarm -> Maybe ComparisonOperator
-- | The number of data points that must be breaching to trigger the alarm.
[$sel:datapointsToAlarm:MetricAlarm'] :: MetricAlarm -> Maybe Natural
-- | The dimensions for the metric associated with the alarm.
[$sel:dimensions:MetricAlarm'] :: MetricAlarm -> Maybe [Dimension]
-- | 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:evaluateLowSampleCountPercentile:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The number of periods over which data is compared to the specified
-- threshold.
[$sel:evaluationPeriods:MetricAlarm'] :: MetricAlarm -> Maybe Natural
-- | If the value of this field is PARTIAL_DATA, the alarm is
-- being evaluated based on only partial data. This happens if the query
-- used for the alarm returns more than 10,000 metrics. For more
-- information, see Create alarms on Metrics Insights queries.
[$sel:evaluationState:MetricAlarm'] :: MetricAlarm -> Maybe EvaluationState
-- | The percentile statistic for the metric associated with the alarm.
-- Specify a value between p0.0 and p100.
[$sel:extendedStatistic:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | 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:insufficientDataActions:MetricAlarm'] :: MetricAlarm -> Maybe [Text]
-- | The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
[$sel:metricName:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | 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:metrics:MetricAlarm'] :: MetricAlarm -> Maybe [MetricDataQuery]
-- | The namespace of the metric associated with the alarm.
[$sel:namespace:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | 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:oKActions:MetricAlarm'] :: MetricAlarm -> Maybe [Text]
-- | The period, in seconds, over which the statistic is applied.
[$sel:period:MetricAlarm'] :: MetricAlarm -> Maybe Natural
-- | An explanation for the alarm state, in text format.
[$sel:stateReason:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | An explanation for the alarm state, in JSON format.
[$sel:stateReasonData:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The date and time that the alarm's StateValue most recently
-- changed.
[$sel:stateTransitionedTimestamp:MetricAlarm'] :: MetricAlarm -> Maybe ISO8601
-- | The time stamp of the last update to the value of either the
-- StateValue or EvaluationState parameters.
[$sel:stateUpdatedTimestamp:MetricAlarm'] :: MetricAlarm -> Maybe ISO8601
-- | The state value for the alarm.
[$sel:stateValue:MetricAlarm'] :: MetricAlarm -> Maybe StateValue
-- | The statistic for the metric associated with the alarm, other than
-- percentile. For percentile statistics, use ExtendedStatistic.
[$sel:statistic:MetricAlarm'] :: MetricAlarm -> Maybe Statistic
-- | The value to compare with the specified statistic.
[$sel:threshold:MetricAlarm'] :: MetricAlarm -> Maybe Double
-- | 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:thresholdMetricId:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | Sets how this alarm is to handle missing data points. The valid values
-- are breaching, notBreaching, ignore, and
-- missing. For more information, see Configuring how
-- CloudWatch alarms treat missing data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
[$sel:treatMissingData:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The unit of the metric associated with the alarm.
[$sel:unit:MetricAlarm'] :: MetricAlarm -> Maybe StandardUnit
-- | 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:actionsEnabled:MetricAlarm',
-- metricAlarm_actionsEnabled - Indicates whether actions should
-- be executed during any changes to the alarm state.
--
-- $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:alarmArn:MetricAlarm', metricAlarm_alarmArn - The
-- Amazon Resource Name (ARN) of the alarm.
--
-- $sel:alarmConfigurationUpdatedTimestamp:MetricAlarm',
-- metricAlarm_alarmConfigurationUpdatedTimestamp - The time stamp
-- of the last update to the alarm configuration.
--
-- $sel:alarmDescription:MetricAlarm',
-- metricAlarm_alarmDescription - The description of the alarm.
--
-- $sel:alarmName:MetricAlarm', metricAlarm_alarmName - The
-- name of 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:datapointsToAlarm:MetricAlarm',
-- metricAlarm_datapointsToAlarm - The number of data points that
-- must be breaching to trigger the alarm.
--
-- $sel:dimensions:MetricAlarm', metricAlarm_dimensions -
-- The dimensions for the metric associated with the alarm.
--
-- $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:evaluationPeriods:MetricAlarm',
-- metricAlarm_evaluationPeriods - The number of periods over
-- which data is compared to the specified threshold.
--
-- $sel:evaluationState:MetricAlarm',
-- metricAlarm_evaluationState - If the value of this field is
-- PARTIAL_DATA, the alarm is being evaluated based on only
-- partial data. This happens if the query used for the alarm returns
-- more than 10,000 metrics. For more information, see Create alarms
-- on Metrics Insights queries.
--
-- $sel:extendedStatistic:MetricAlarm',
-- metricAlarm_extendedStatistic - The percentile statistic for
-- the metric associated with the alarm. Specify a value between p0.0 and
-- p100.
--
-- $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:metricName:MetricAlarm', metricAlarm_metricName -
-- The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
--
-- $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:namespace:MetricAlarm', metricAlarm_namespace - The
-- namespace of the metric associated with the alarm.
--
-- $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).
--
-- MetricAlarm, metricAlarm_period - The period, in
-- seconds, over which the statistic is applied.
--
-- $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:stateTransitionedTimestamp:MetricAlarm',
-- metricAlarm_stateTransitionedTimestamp - The date and time that
-- the alarm's StateValue most recently changed.
--
-- $sel:stateUpdatedTimestamp:MetricAlarm',
-- metricAlarm_stateUpdatedTimestamp - The time stamp of the last
-- update to the value of either the StateValue or
-- EvaluationState parameters.
--
-- $sel:stateValue:MetricAlarm', metricAlarm_stateValue -
-- The state value for 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:threshold:MetricAlarm', metricAlarm_threshold - The
-- value to compare with the specified statistic.
--
-- $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:treatMissingData:MetricAlarm',
-- metricAlarm_treatMissingData - Sets how this alarm is to handle
-- missing data points. The valid values are breaching,
-- notBreaching, ignore, and missing. For more
-- information, see Configuring how CloudWatch alarms treat missing
-- data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
--
-- $sel:unit:MetricAlarm', metricAlarm_unit - The unit of
-- the metric associated with the alarm.
newMetricAlarm :: MetricAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool)
-- | The actions to execute when this alarm transitions to the
-- ALARM state from any other state. Each action is specified as
-- an Amazon Resource Name (ARN).
metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text])
-- | The Amazon Resource Name (ARN) of the alarm.
metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text)
-- | The time stamp of the last update to the alarm configuration.
metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The description of the alarm.
metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text)
-- | The name of the alarm.
metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text)
-- | The arithmetic operation to use when comparing the specified statistic
-- and threshold. The specified statistic value is used as the first
-- operand.
metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
-- | The number of data points that must be breaching to trigger the alarm.
metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
-- | The dimensions for the metric associated with the alarm.
metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension])
-- | Used only for alarms based on percentiles. If ignore, the
-- alarm state does not change during periods with too few data points to
-- be statistically significant. If evaluate or this parameter
-- is not used, the alarm is always evaluated and possibly changes state
-- no matter how many data points are available.
metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
-- | The number of periods over which data is compared to the specified
-- threshold.
metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
-- | If the value of this field is PARTIAL_DATA, the alarm is
-- being evaluated based on only partial data. This happens if the query
-- used for the alarm returns more than 10,000 metrics. For more
-- information, see Create alarms on Metrics Insights queries.
metricAlarm_evaluationState :: Lens' MetricAlarm (Maybe EvaluationState)
-- | The percentile statistic for the metric associated with the alarm.
-- Specify a value between p0.0 and p100.
metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the
-- INSUFFICIENT_DATA state from any other state. Each action is
-- specified as an Amazon Resource Name (ARN).
metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text])
-- | The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text)
-- | An array of MetricDataQuery structures, used in an alarm based on a
-- metric math expression. Each structure either retrieves a metric or
-- performs a math expression. One item in the Metrics array is the math
-- expression that the alarm watches. This expression by designated by
-- having ReturnData set to true.
metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery])
-- | The namespace of the metric associated with the alarm.
metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the OK
-- state from any other state. Each action is specified as an Amazon
-- Resource Name (ARN).
metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text])
-- | The period, in seconds, over which the statistic is applied.
metricAlarm_period :: Lens' MetricAlarm (Maybe Natural)
-- | An explanation for the alarm state, in text format.
metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text)
-- | An explanation for the alarm state, in JSON format.
metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text)
-- | The date and time that the alarm's StateValue most recently
-- changed.
metricAlarm_stateTransitionedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The time stamp of the last update to the value of either the
-- StateValue or EvaluationState parameters.
metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The state value for the alarm.
metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue)
-- | The statistic for the metric associated with the alarm, other than
-- percentile. For percentile statistics, use ExtendedStatistic.
metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic)
-- | The value to compare with the specified statistic.
metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double)
-- | In an alarm based on an anomaly detection model, this is the ID of the
-- ANOMALY_DETECTION_BAND function used as the threshold for the
-- alarm.
metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text)
-- | Sets how this alarm is to handle missing data points. The valid values
-- are breaching, notBreaching, ignore, and
-- missing. For more information, see Configuring how
-- CloudWatch alarms treat missing data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text)
-- | The unit of the metric associated with the alarm.
metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit)
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricAlarm.MetricAlarm
module Amazonka.CloudWatch.Types.StatisticSet
-- | Represents a set of statistics that describes a specific metric.
--
-- See: newStatisticSet smart constructor.
data StatisticSet
StatisticSet' :: Double -> Double -> Double -> Double -> StatisticSet
-- | The number of samples used for the statistic set.
[$sel:sampleCount:StatisticSet'] :: StatisticSet -> Double
-- | The sum of values for the sample set.
[$sel:sum:StatisticSet'] :: StatisticSet -> Double
-- | The minimum value of the sample set.
[$sel:minimum:StatisticSet'] :: StatisticSet -> Double
-- | The maximum value of the sample set.
[$sel:maximum:StatisticSet'] :: StatisticSet -> Double
-- | 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.
newStatisticSet :: Double -> Double -> Double -> Double -> StatisticSet
-- | The number of samples used for the statistic set.
statisticSet_sampleCount :: Lens' StatisticSet Double
-- | The sum of values for the sample set.
statisticSet_sum :: Lens' StatisticSet Double
-- | The minimum value of the sample set.
statisticSet_minimum :: Lens' StatisticSet Double
-- | The maximum value of the sample set.
statisticSet_maximum :: Lens' StatisticSet Double
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
instance GHC.Show.Show Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
instance GHC.Read.Read Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.StatisticSet.StatisticSet
module Amazonka.CloudWatch.Types.MetricDatum
-- | Encapsulates the information sent to either create a metric or add new
-- values to be aggregated into an existing metric.
--
-- See: newMetricDatum smart constructor.
data MetricDatum
MetricDatum' :: Maybe [Double] -> Maybe [Dimension] -> Maybe StatisticSet -> Maybe Natural -> Maybe ISO8601 -> Maybe StandardUnit -> Maybe Double -> Maybe [Double] -> Text -> MetricDatum
-- | 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:counts:MetricDatum'] :: MetricDatum -> Maybe [Double]
-- | The dimensions associated with the metric.
[$sel:dimensions:MetricDatum'] :: MetricDatum -> Maybe [Dimension]
-- | The statistical values for the metric.
[$sel:statisticValues:MetricDatum'] :: MetricDatum -> Maybe StatisticSet
-- | 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:storageResolution:MetricDatum'] :: MetricDatum -> Maybe Natural
-- | The time the metric data was received, expressed as the number of
-- milliseconds since Jan 1, 1970 00:00:00 UTC.
[$sel:timestamp:MetricDatum'] :: MetricDatum -> Maybe ISO8601
-- | 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:unit:MetricDatum'] :: MetricDatum -> Maybe StandardUnit
-- | 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:value:MetricDatum'] :: MetricDatum -> Maybe Double
-- | 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:values:MetricDatum'] :: MetricDatum -> Maybe [Double]
-- | The name of the metric.
[$sel:metricName:MetricDatum'] :: MetricDatum -> Text
-- | 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: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:dimensions:MetricDatum', metricDatum_dimensions -
-- The dimensions associated with the metric.
--
-- $sel:statisticValues:MetricDatum',
-- metricDatum_statisticValues - The statistical values for the
-- metric.
--
-- $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: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: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.
--
-- 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: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:metricName:MetricDatum', metricDatum_metricName -
-- The name of the metric.
newMetricDatum :: Text -> MetricDatum
-- | Array of numbers that is used along with the Values array.
-- Each number in the Count array is the number of times the
-- corresponding value in the Values array occurred during the
-- period.
--
-- If you omit the Counts array, the default of 1 is used as the
-- value for each count. If you include a Counts array, it must
-- include the same amount of values as the Values array.
metricDatum_counts :: Lens' MetricDatum (Maybe [Double])
-- | The dimensions associated with the metric.
metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])
-- | The statistical values for the metric.
metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)
-- | Valid values are 1 and 60. Setting this to 1 specifies this metric as
-- a high-resolution metric, so that CloudWatch stores the metric with
-- sub-minute resolution down to one second. Setting this to 60 specifies
-- this metric as a regular-resolution metric, which CloudWatch stores at
-- 1-minute resolution. Currently, high resolution is available only for
-- custom metrics. For more information about high-resolution metrics,
-- see High-Resolution Metrics in the Amazon CloudWatch User
-- Guide.
--
-- This field is optional, if you do not specify it the default of 60 is
-- used.
metricDatum_storageResolution :: Lens' MetricDatum (Maybe Natural)
-- | The time the metric data was received, expressed as the number of
-- milliseconds since Jan 1, 1970 00:00:00 UTC.
metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime)
-- | When you are using a Put operation, this defines what unit
-- you want to use when storing the metric.
--
-- In a Get operation, this displays the unit that is used for
-- the metric.
metricDatum_unit :: Lens' MetricDatum (Maybe StandardUnit)
-- | The value for the metric.
--
-- Although the parameter accepts numbers of type Double, CloudWatch
-- rejects values that are either too small or too large. Values must be
-- in the range of -2^360 to 2^360. In addition, special values (for
-- example, NaN, +Infinity, -Infinity) are not supported.
metricDatum_value :: Lens' MetricDatum (Maybe Double)
-- | Array of numbers representing the values for the metric during the
-- period. Each unique value is listed just once in this array, and the
-- corresponding number in the Counts array specifies the number
-- of times that value occurred during the period. You can include up to
-- 150 unique values in each PutMetricData action that specifies
-- a Values array.
--
-- Although the Values array accepts numbers of type
-- Double, CloudWatch rejects values that are either too small
-- or too large. Values must be in the range of -2^360 to 2^360. In
-- addition, special values (for example, NaN, +Infinity, -Infinity) are
-- not supported.
metricDatum_values :: Lens' MetricDatum (Maybe [Double])
-- | The name of the metric.
metricDatum_metricName :: Lens' MetricDatum Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.MetricDatum.MetricDatum
module Amazonka.CloudWatch.Types.StatusCode
newtype StatusCode
StatusCode' :: Text -> StatusCode
[fromStatusCode] :: StatusCode -> Text
pattern StatusCode_Complete :: StatusCode
pattern StatusCode_Forbidden :: StatusCode
pattern StatusCode_InternalError :: StatusCode
pattern StatusCode_PartialData :: StatusCode
instance Amazonka.Data.XML.ToXML Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.Headers.ToHeader Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.Log.ToLog Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.ByteString.ToByteString Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.Text.ToText Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Amazonka.Data.Text.FromText Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance GHC.Classes.Ord Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance GHC.Read.Read Amazonka.CloudWatch.Types.StatusCode.StatusCode
instance GHC.Show.Show Amazonka.CloudWatch.Types.StatusCode.StatusCode
module Amazonka.CloudWatch.Types.MetricDataResult
-- | 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.
data MetricDataResult
MetricDataResult' :: Maybe Text -> Maybe Text -> Maybe [MessageData] -> Maybe StatusCode -> Maybe [ISO8601] -> Maybe [Double] -> MetricDataResult
-- | The short name you specified to represent this metric.
[$sel:id:MetricDataResult'] :: MetricDataResult -> Maybe Text
-- | The human-readable label associated with the data.
[$sel:label:MetricDataResult'] :: MetricDataResult -> Maybe Text
-- | A list of messages with additional information about the data
-- returned.
[$sel:messages:MetricDataResult'] :: MetricDataResult -> Maybe [MessageData]
-- | 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.
[$sel:statusCode:MetricDataResult'] :: MetricDataResult -> Maybe StatusCode
-- | 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:timestamps:MetricDataResult'] :: MetricDataResult -> Maybe [ISO8601]
-- | 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:values:MetricDataResult'] :: MetricDataResult -> Maybe [Double]
-- | 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:id:MetricDataResult', metricDataResult_id - The
-- short name you specified to represent this metric.
--
-- $sel:label:MetricDataResult', metricDataResult_label -
-- The human-readable label associated with the data.
--
-- $sel:messages:MetricDataResult',
-- metricDataResult_messages - A list of messages with additional
-- information about the data returned.
--
-- $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.
--
-- $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: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].
newMetricDataResult :: MetricDataResult
-- | The short name you specified to represent this metric.
metricDataResult_id :: Lens' MetricDataResult (Maybe Text)
-- | The human-readable label associated with the data.
metricDataResult_label :: Lens' MetricDataResult (Maybe Text)
-- | A list of messages with additional information about the data
-- returned.
metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData])
-- | The status of the returned data. Complete indicates that all
-- data points in the requested time range were returned.
-- PartialData means that an incomplete set of data points were
-- returned. You can use the NextToken value that was returned
-- and repeat your request to get more data points. NextToken is
-- not returned if you are performing a math expression.
-- InternalError indicates that an error occurred. Retry your
-- request using NextToken, if present.
metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode)
-- | The timestamps for the data points, formatted in Unix timestamp
-- format. The number of timestamps always matches the number of values
-- and the value for Timestamps[x] is Values[x].
metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime])
-- | The data points for the metric corresponding to Timestamps.
-- The number of values always matches the number of timestamps and the
-- timestamp for Values[x] is Timestamps[x].
metricDataResult_values :: Lens' MetricDataResult (Maybe [Double])
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
instance GHC.Show.Show Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
instance GHC.Read.Read Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.MetricDataResult.MetricDataResult
module Amazonka.CloudWatch.Types.Tag
-- | A key-value pair associated with a CloudWatch resource.
--
-- See: newTag smart constructor.
data Tag
Tag' :: Text -> Text -> Tag
-- | 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:key:Tag'] :: Tag -> Text
-- | The value for the specified tag key.
[$sel:value:Tag'] :: Tag -> 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.
newTag :: Text -> Text -> Tag
-- | 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.
tag_key :: Lens' Tag Text
-- | The value for the specified tag key.
tag_value :: Lens' Tag Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.Tag.Tag
instance GHC.Show.Show Amazonka.CloudWatch.Types.Tag.Tag
instance GHC.Read.Read Amazonka.CloudWatch.Types.Tag.Tag
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.Tag.Tag
instance Amazonka.Data.XML.FromXML Amazonka.CloudWatch.Types.Tag.Tag
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.Tag.Tag
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.Tag.Tag
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.Tag.Tag
module Amazonka.CloudWatch.Types.ManagedRule
-- | Contains the information that's required to enable a managed
-- Contributor Insights rule for an Amazon Web Services resource.
--
-- See: newManagedRule smart constructor.
data ManagedRule
ManagedRule' :: Maybe [Tag] -> Text -> Text -> ManagedRule
-- | A list of key-value pairs that you can associate with a managed
-- Contributor Insights rule. You can associate as many as 50 tags with a
-- rule. Tags can help you organize and categorize your resources. You
-- also can use them to scope user permissions by granting a user
-- permission to access or change only the resources that have certain
-- tag values. To associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
[$sel:tags:ManagedRule'] :: ManagedRule -> Maybe [Tag]
-- | The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
[$sel:templateName:ManagedRule'] :: ManagedRule -> Text
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
[$sel:resourceARN:ManagedRule'] :: ManagedRule -> Text
-- | Create a value of ManagedRule 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:ManagedRule', managedRule_tags - A list of
-- key-value pairs that you can associate with a managed Contributor
-- Insights rule. You can associate as many as 50 tags with a rule. Tags
-- can help you organize and categorize your resources. You also can use
-- them to scope user permissions by granting a user permission to access
-- or change only the resources that have certain tag values. To
-- associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
--
-- $sel:templateName:ManagedRule', managedRule_templateName
-- - The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
--
-- $sel:resourceARN:ManagedRule', managedRule_resourceARN -
-- The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
newManagedRule :: Text -> Text -> ManagedRule
-- | A list of key-value pairs that you can associate with a managed
-- Contributor Insights rule. You can associate as many as 50 tags with a
-- rule. Tags can help you organize and categorize your resources. You
-- also can use them to scope user permissions by granting a user
-- permission to access or change only the resources that have certain
-- tag values. To associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
managedRule_tags :: Lens' ManagedRule (Maybe [Tag])
-- | The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
managedRule_templateName :: Lens' ManagedRule Text
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
managedRule_resourceARN :: Lens' ManagedRule Text
instance GHC.Generics.Generic Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
instance GHC.Show.Show Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
instance GHC.Read.Read Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
instance GHC.Classes.Eq Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
instance Control.DeepSeq.NFData Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.Types.ManagedRule.ManagedRule
module Amazonka.CloudWatch.Types
-- | API version 2010-08-01 of the Amazon CloudWatch SDK
-- configuration.
defaultService :: Service
-- | More than one process tried to modify a resource at the same time.
_ConcurrentModificationException :: AsError a => Fold a ServiceError
-- | Some part of the dashboard data is invalid.
_DashboardInvalidInputError :: AsError a => Fold a ServiceError
-- | The specified dashboard does not exist.
_DashboardNotFoundError :: AsError a => Fold a ServiceError
-- | Request processing has failed due to some unknown error, exception, or
-- failure.
_InternalServiceFault :: AsError a => Fold a ServiceError
-- | Data was not syntactically valid JSON.
_InvalidFormatFault :: AsError a => Fold a ServiceError
-- | The next token specified is invalid.
_InvalidNextToken :: AsError a => Fold a ServiceError
-- | Parameters were used together that cannot be used together.
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError
-- | The value of an input parameter is bad or out-of-range.
_InvalidParameterValueException :: AsError a => Fold a ServiceError
-- | The operation exceeded one or more limits.
_LimitExceededException :: AsError a => Fold a ServiceError
-- | The quota for alarms for this customer has already been reached.
_LimitExceededFault :: AsError a => Fold a ServiceError
-- | An input parameter that is required is missing.
_MissingRequiredParameterException :: AsError a => Fold a ServiceError
-- | The named resource does not exist.
_ResourceNotFound :: AsError a => Fold a ServiceError
-- | The named resource does not exist.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
newtype ActionsSuppressedBy
ActionsSuppressedBy' :: Text -> ActionsSuppressedBy
[fromActionsSuppressedBy] :: ActionsSuppressedBy -> Text
pattern ActionsSuppressedBy_Alarm :: ActionsSuppressedBy
pattern ActionsSuppressedBy_ExtensionPeriod :: ActionsSuppressedBy
pattern ActionsSuppressedBy_WaitPeriod :: ActionsSuppressedBy
newtype AlarmType
AlarmType' :: Text -> AlarmType
[fromAlarmType] :: AlarmType -> Text
pattern AlarmType_CompositeAlarm :: AlarmType
pattern AlarmType_MetricAlarm :: AlarmType
newtype AnomalyDetectorStateValue
AnomalyDetectorStateValue' :: Text -> AnomalyDetectorStateValue
[fromAnomalyDetectorStateValue] :: AnomalyDetectorStateValue -> Text
pattern AnomalyDetectorStateValue_PENDING_TRAINING :: AnomalyDetectorStateValue
pattern AnomalyDetectorStateValue_TRAINED :: AnomalyDetectorStateValue
pattern AnomalyDetectorStateValue_TRAINED_INSUFFICIENT_DATA :: AnomalyDetectorStateValue
newtype AnomalyDetectorType
AnomalyDetectorType' :: Text -> AnomalyDetectorType
[fromAnomalyDetectorType] :: AnomalyDetectorType -> Text
pattern AnomalyDetectorType_METRIC_MATH :: AnomalyDetectorType
pattern AnomalyDetectorType_SINGLE_METRIC :: AnomalyDetectorType
newtype ComparisonOperator
ComparisonOperator' :: Text -> ComparisonOperator
[fromComparisonOperator] :: ComparisonOperator -> Text
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 EvaluationState
EvaluationState' :: Text -> EvaluationState
[fromEvaluationState] :: EvaluationState -> Text
pattern EvaluationState_PARTIAL_DATA :: EvaluationState
newtype HistoryItemType
HistoryItemType' :: Text -> HistoryItemType
[fromHistoryItemType] :: HistoryItemType -> Text
pattern HistoryItemType_Action :: HistoryItemType
pattern HistoryItemType_ConfigurationUpdate :: HistoryItemType
pattern HistoryItemType_StateUpdate :: HistoryItemType
newtype MetricStreamOutputFormat
MetricStreamOutputFormat' :: Text -> MetricStreamOutputFormat
[fromMetricStreamOutputFormat] :: MetricStreamOutputFormat -> Text
pattern MetricStreamOutputFormat_Json :: MetricStreamOutputFormat
pattern MetricStreamOutputFormat_Opentelemetry0_7 :: MetricStreamOutputFormat
newtype RecentlyActive
RecentlyActive' :: Text -> RecentlyActive
[fromRecentlyActive] :: RecentlyActive -> Text
pattern RecentlyActive_PT3H :: RecentlyActive
newtype ScanBy
ScanBy' :: Text -> ScanBy
[fromScanBy] :: ScanBy -> Text
pattern ScanBy_TimestampAscending :: ScanBy
pattern ScanBy_TimestampDescending :: ScanBy
newtype StandardUnit
StandardUnit' :: Text -> StandardUnit
[fromStandardUnit] :: StandardUnit -> Text
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
StateValue' :: Text -> StateValue
[fromStateValue] :: StateValue -> Text
pattern StateValue_ALARM :: StateValue
pattern StateValue_INSUFFICIENT_DATA :: StateValue
pattern StateValue_OK :: StateValue
newtype Statistic
Statistic' :: Text -> Statistic
[fromStatistic] :: Statistic -> Text
pattern Statistic_Average :: Statistic
pattern Statistic_Maximum :: Statistic
pattern Statistic_Minimum :: Statistic
pattern Statistic_SampleCount :: Statistic
pattern Statistic_Sum :: Statistic
newtype StatusCode
StatusCode' :: Text -> StatusCode
[fromStatusCode] :: StatusCode -> Text
pattern StatusCode_Complete :: StatusCode
pattern StatusCode_Forbidden :: StatusCode
pattern StatusCode_InternalError :: StatusCode
pattern StatusCode_PartialData :: StatusCode
-- | Represents the history of a specific alarm.
--
-- See: newAlarmHistoryItem smart constructor.
data AlarmHistoryItem
AlarmHistoryItem' :: Maybe Text -> Maybe AlarmType -> Maybe Text -> Maybe HistoryItemType -> Maybe Text -> Maybe ISO8601 -> AlarmHistoryItem
-- | The descriptive name for the alarm.
[$sel:alarmName:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe Text
-- | The type of alarm, either metric alarm or composite alarm.
[$sel:alarmType:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe AlarmType
-- | Data about the alarm, in JSON format.
[$sel:historyData:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe Text
-- | The type of alarm history item.
[$sel:historyItemType:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe HistoryItemType
-- | A summary of the alarm history, in text format.
[$sel:historySummary:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe Text
-- | The time stamp for the alarm history item.
[$sel:timestamp:AlarmHistoryItem'] :: AlarmHistoryItem -> Maybe ISO8601
-- | 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:alarmType:AlarmHistoryItem',
-- alarmHistoryItem_alarmType - The type of alarm, either metric
-- alarm or composite alarm.
--
-- $sel:historyData:AlarmHistoryItem',
-- alarmHistoryItem_historyData - Data about the alarm, in JSON
-- format.
--
-- $sel:historyItemType:AlarmHistoryItem',
-- alarmHistoryItem_historyItemType - The type of alarm history
-- item.
--
-- $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.
newAlarmHistoryItem :: AlarmHistoryItem
-- | The descriptive name for the alarm.
alarmHistoryItem_alarmName :: Lens' AlarmHistoryItem (Maybe Text)
-- | The type of alarm, either metric alarm or composite alarm.
alarmHistoryItem_alarmType :: Lens' AlarmHistoryItem (Maybe AlarmType)
-- | Data about the alarm, in JSON format.
alarmHistoryItem_historyData :: Lens' AlarmHistoryItem (Maybe Text)
-- | The type of alarm history item.
alarmHistoryItem_historyItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType)
-- | A summary of the alarm history, in text format.
alarmHistoryItem_historySummary :: Lens' AlarmHistoryItem (Maybe Text)
-- | The time stamp for the alarm history item.
alarmHistoryItem_timestamp :: Lens' AlarmHistoryItem (Maybe UTCTime)
-- | An anomaly detection model associated with a particular CloudWatch
-- metric, statistic, or metric math expression. You can use the model to
-- display a band of expected, normal values when the metric is graphed.
--
-- See: newAnomalyDetector smart constructor.
data AnomalyDetector
AnomalyDetector' :: Maybe AnomalyDetectorConfiguration -> Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe Text -> Maybe AnomalyDetectorStateValue -> AnomalyDetector
-- | 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:configuration:AnomalyDetector'] :: AnomalyDetector -> Maybe AnomalyDetectorConfiguration
-- | The metric dimensions associated with the anomaly detection model.
[$sel:dimensions:AnomalyDetector'] :: AnomalyDetector -> Maybe [Dimension]
-- | The CloudWatch metric math expression for this anomaly detector.
[$sel:metricMathAnomalyDetector:AnomalyDetector'] :: AnomalyDetector -> Maybe MetricMathAnomalyDetector
-- | The name of the metric associated with the anomaly detection model.
[$sel:metricName:AnomalyDetector'] :: AnomalyDetector -> Maybe Text
-- | The namespace of the metric associated with the anomaly detection
-- model.
[$sel:namespace:AnomalyDetector'] :: AnomalyDetector -> Maybe Text
-- | The CloudWatch metric and statistic for this anomaly detector.
[$sel:singleMetricAnomalyDetector:AnomalyDetector'] :: AnomalyDetector -> Maybe SingleMetricAnomalyDetector
-- | The statistic associated with the anomaly detection model.
[$sel:stat:AnomalyDetector'] :: AnomalyDetector -> Maybe Text
-- | The current status of the anomaly detector's training. The possible
-- values are TRAINED | PENDING_TRAINING |
-- TRAINED_INSUFFICIENT_DATA
[$sel:stateValue:AnomalyDetector'] :: AnomalyDetector -> Maybe AnomalyDetectorStateValue
-- | 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: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.
--
-- AnomalyDetector, anomalyDetector_dimensions - The metric
-- dimensions associated with the anomaly detection model.
--
-- $sel:metricMathAnomalyDetector:AnomalyDetector',
-- anomalyDetector_metricMathAnomalyDetector - The CloudWatch
-- metric math expression for this anomaly detector.
--
-- AnomalyDetector, anomalyDetector_metricName - The name
-- of the metric associated with the anomaly detection model.
--
-- AnomalyDetector, anomalyDetector_namespace - The
-- namespace of the metric associated with the anomaly detection model.
--
-- $sel:singleMetricAnomalyDetector:AnomalyDetector',
-- anomalyDetector_singleMetricAnomalyDetector - The CloudWatch
-- metric and statistic for this anomaly detector.
--
-- AnomalyDetector, anomalyDetector_stat - The statistic
-- 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
newAnomalyDetector :: AnomalyDetector
-- | The configuration specifies details about how the anomaly detection
-- model is to be trained, including time ranges to exclude from use for
-- training the model, and the time zone to use for the metric.
anomalyDetector_configuration :: Lens' AnomalyDetector (Maybe AnomalyDetectorConfiguration)
-- | The metric dimensions associated with the anomaly detection model.
anomalyDetector_dimensions :: Lens' AnomalyDetector (Maybe [Dimension])
-- | The CloudWatch metric math expression for this anomaly detector.
anomalyDetector_metricMathAnomalyDetector :: Lens' AnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The name of the metric associated with the anomaly detection model.
anomalyDetector_metricName :: Lens' AnomalyDetector (Maybe Text)
-- | The namespace of the metric associated with the anomaly detection
-- model.
anomalyDetector_namespace :: Lens' AnomalyDetector (Maybe Text)
-- | The CloudWatch metric and statistic for this anomaly detector.
anomalyDetector_singleMetricAnomalyDetector :: Lens' AnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic associated with the anomaly detection model.
anomalyDetector_stat :: Lens' AnomalyDetector (Maybe Text)
-- | The current status of the anomaly detector's training. The possible
-- values are TRAINED | PENDING_TRAINING |
-- TRAINED_INSUFFICIENT_DATA
anomalyDetector_stateValue :: Lens' AnomalyDetector (Maybe AnomalyDetectorStateValue)
-- | 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.
data AnomalyDetectorConfiguration
AnomalyDetectorConfiguration' :: Maybe [Range] -> Maybe Text -> AnomalyDetectorConfiguration
-- | 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.
[$sel:excludedTimeRanges:AnomalyDetectorConfiguration'] :: AnomalyDetectorConfiguration -> Maybe [Range]
-- | 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:metricTimezone:AnomalyDetectorConfiguration'] :: AnomalyDetectorConfiguration -> Maybe Text
-- | 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: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.
--
-- $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.
newAnomalyDetectorConfiguration :: AnomalyDetectorConfiguration
-- | An array of time ranges to exclude from use when the anomaly detection
-- model is trained. Use this to make sure that events that could cause
-- unusual values for the metric, such as deployments, aren't used when
-- CloudWatch creates the model.
anomalyDetectorConfiguration_excludedTimeRanges :: Lens' AnomalyDetectorConfiguration (Maybe [Range])
-- | The time zone to use for the metric. This is useful to enable the
-- model to automatically account for daylight savings time changes if
-- the metric is sensitive to such time changes.
--
-- To specify a time zone, use the name of the time zone as specified in
-- the standard tz database. For more information, see tz
-- database.
anomalyDetectorConfiguration_metricTimezone :: Lens' AnomalyDetectorConfiguration (Maybe Text)
-- | The details about a composite alarm.
--
-- See: newCompositeAlarm smart constructor.
data CompositeAlarm
CompositeAlarm' :: Maybe Bool -> Maybe ActionsSuppressedBy -> Maybe Text -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe [Text] -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe ISO8601 -> Maybe StateValue -> CompositeAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
[$sel:actionsEnabled:CompositeAlarm'] :: CompositeAlarm -> Maybe Bool
-- | When the value is ALARM, it means that the actions are
-- suppressed because the suppressor alarm is in ALARM When the
-- value is WaitPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting for the suppressor alarm to go
-- into into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
[$sel:actionsSuppressedBy:CompositeAlarm'] :: CompositeAlarm -> Maybe ActionsSuppressedBy
-- | Captures the reason for action suppression.
[$sel:actionsSuppressedReason:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
[$sel:actionsSuppressor:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
[$sel:actionsSuppressorExtensionPeriod:CompositeAlarm'] :: CompositeAlarm -> Maybe Int
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
[$sel:actionsSuppressorWaitPeriod:CompositeAlarm'] :: CompositeAlarm -> Maybe Int
-- | 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:alarmActions:CompositeAlarm'] :: CompositeAlarm -> Maybe [Text]
-- | The Amazon Resource Name (ARN) of the alarm.
[$sel:alarmArn:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The time stamp of the last update to the alarm configuration.
[$sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm'] :: CompositeAlarm -> Maybe ISO8601
-- | The description of the alarm.
[$sel:alarmDescription:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The name of the alarm.
[$sel:alarmName:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The rule that this alarm uses to evaluate its alarm state.
[$sel:alarmRule:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | 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:insufficientDataActions:CompositeAlarm'] :: CompositeAlarm -> Maybe [Text]
-- | 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:oKActions:CompositeAlarm'] :: CompositeAlarm -> Maybe [Text]
-- | An explanation for the alarm state, in text format.
[$sel:stateReason:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | An explanation for the alarm state, in JSON format.
[$sel:stateReasonData:CompositeAlarm'] :: CompositeAlarm -> Maybe Text
-- | The timestamp of the last change to the alarm's StateValue.
[$sel:stateTransitionedTimestamp:CompositeAlarm'] :: CompositeAlarm -> Maybe ISO8601
-- | Tracks the timestamp of any state update, even if StateValue
-- doesn't change.
[$sel:stateUpdatedTimestamp:CompositeAlarm'] :: CompositeAlarm -> Maybe ISO8601
-- | The state value for the alarm.
[$sel:stateValue:CompositeAlarm'] :: CompositeAlarm -> Maybe StateValue
-- | 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:actionsEnabled:CompositeAlarm',
-- compositeAlarm_actionsEnabled - Indicates whether actions
-- should be executed during any changes to the alarm state.
--
-- $sel:actionsSuppressedBy:CompositeAlarm',
-- compositeAlarm_actionsSuppressedBy - When the value is
-- ALARM, it means that the actions are suppressed because the
-- suppressor alarm is in ALARM When the value is
-- WaitPeriod, it means that the actions are suppressed because
-- the composite alarm is waiting for the suppressor alarm to go into
-- into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
--
-- $sel:actionsSuppressedReason:CompositeAlarm',
-- compositeAlarm_actionsSuppressedReason - Captures the reason
-- for action suppression.
--
-- $sel:actionsSuppressor:CompositeAlarm',
-- compositeAlarm_actionsSuppressor - Actions will be suppressed
-- if the suppressor alarm is in the ALARM state.
-- ActionsSuppressor can be an AlarmName or an Amazon Resource
-- Name (ARN) from an existing alarm.
--
-- $sel:actionsSuppressorExtensionPeriod:CompositeAlarm',
-- compositeAlarm_actionsSuppressorExtensionPeriod - The maximum
-- time in seconds that the composite alarm waits after suppressor alarm
-- goes out of the ALARM state. After this time, the composite
-- alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
--
-- $sel:actionsSuppressorWaitPeriod:CompositeAlarm',
-- compositeAlarm_actionsSuppressorWaitPeriod - The maximum time
-- in seconds that the composite alarm waits for the suppressor alarm to
-- go into the ALARM state. After this time, the composite alarm
-- performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
--
-- $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).
--
-- $sel:alarmArn:CompositeAlarm', compositeAlarm_alarmArn -
-- The Amazon Resource Name (ARN) of the alarm.
--
-- $sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm',
-- compositeAlarm_alarmConfigurationUpdatedTimestamp - The time
-- stamp of the last update to the alarm configuration.
--
-- $sel:alarmDescription:CompositeAlarm',
-- compositeAlarm_alarmDescription - The description of the alarm.
--
-- $sel:alarmName:CompositeAlarm', compositeAlarm_alarmName
-- - The name of the alarm.
--
-- $sel:alarmRule:CompositeAlarm', compositeAlarm_alarmRule
-- - The rule that this alarm uses to evaluate its 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: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: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:stateTransitionedTimestamp:CompositeAlarm',
-- compositeAlarm_stateTransitionedTimestamp - The timestamp of
-- the last change to the alarm's StateValue.
--
-- $sel:stateUpdatedTimestamp:CompositeAlarm',
-- compositeAlarm_stateUpdatedTimestamp - Tracks the timestamp of
-- any state update, even if StateValue doesn't change.
--
-- $sel:stateValue:CompositeAlarm',
-- compositeAlarm_stateValue - The state value for the alarm.
newCompositeAlarm :: CompositeAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool)
-- | When the value is ALARM, it means that the actions are
-- suppressed because the suppressor alarm is in ALARM When the
-- value is WaitPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting for the suppressor alarm to go
-- into into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
compositeAlarm_actionsSuppressedBy :: Lens' CompositeAlarm (Maybe ActionsSuppressedBy)
-- | Captures the reason for action suppression.
compositeAlarm_actionsSuppressedReason :: Lens' CompositeAlarm (Maybe Text)
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
compositeAlarm_actionsSuppressor :: Lens' CompositeAlarm (Maybe Text)
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
compositeAlarm_actionsSuppressorExtensionPeriod :: Lens' CompositeAlarm (Maybe Int)
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
compositeAlarm_actionsSuppressorWaitPeriod :: Lens' CompositeAlarm (Maybe Int)
-- | The actions to execute when this alarm transitions to the ALARM state
-- from any other state. Each action is specified as an Amazon Resource
-- Name (ARN).
compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text])
-- | The Amazon Resource Name (ARN) of the alarm.
compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text)
-- | The time stamp of the last update to the alarm configuration.
compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | The description of the alarm.
compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text)
-- | The name of the alarm.
compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text)
-- | The rule that this alarm uses to evaluate its alarm state.
compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the
-- INSUFFICIENT_DATA state from any other state. Each action is specified
-- as an Amazon Resource Name (ARN).
compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text])
-- | The actions to execute when this alarm transitions to the OK state
-- from any other state. Each action is specified as an Amazon Resource
-- Name (ARN).
compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text])
-- | An explanation for the alarm state, in text format.
compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text)
-- | An explanation for the alarm state, in JSON format.
compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text)
-- | The timestamp of the last change to the alarm's StateValue.
compositeAlarm_stateTransitionedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | Tracks the timestamp of any state update, even if StateValue
-- doesn't change.
compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | The state value for the alarm.
compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue)
-- | Represents a specific dashboard.
--
-- See: newDashboardEntry smart constructor.
data DashboardEntry
DashboardEntry' :: Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe Integer -> DashboardEntry
-- | The Amazon Resource Name (ARN) of the dashboard.
[$sel:dashboardArn:DashboardEntry'] :: DashboardEntry -> Maybe Text
-- | The name of the dashboard.
[$sel:dashboardName:DashboardEntry'] :: DashboardEntry -> Maybe Text
-- | 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:lastModified:DashboardEntry'] :: DashboardEntry -> Maybe ISO8601
-- | The size of the dashboard, in bytes.
[$sel:size:DashboardEntry'] :: DashboardEntry -> Maybe Integer
-- | 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:dashboardArn:DashboardEntry',
-- dashboardEntry_dashboardArn - The Amazon Resource Name (ARN) of
-- the dashboard.
--
-- $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:size:DashboardEntry', dashboardEntry_size - The
-- size of the dashboard, in bytes.
newDashboardEntry :: DashboardEntry
-- | The Amazon Resource Name (ARN) of the dashboard.
dashboardEntry_dashboardArn :: Lens' DashboardEntry (Maybe Text)
-- | The name of the dashboard.
dashboardEntry_dashboardName :: Lens' DashboardEntry (Maybe Text)
-- | The time stamp of when the dashboard was last modified, either by an
-- API call or through the console. This number is expressed as the
-- number of milliseconds since Jan 1, 1970 00:00:00 UTC.
dashboardEntry_lastModified :: Lens' DashboardEntry (Maybe UTCTime)
-- | The size of the dashboard, in bytes.
dashboardEntry_size :: Lens' DashboardEntry (Maybe Integer)
-- | An error or warning for the operation.
--
-- See: newDashboardValidationMessage smart constructor.
data DashboardValidationMessage
DashboardValidationMessage' :: Maybe Text -> Maybe Text -> DashboardValidationMessage
-- | The data path related to the message.
[$sel:dataPath:DashboardValidationMessage'] :: DashboardValidationMessage -> Maybe Text
-- | A message describing the error or warning.
[$sel:message:DashboardValidationMessage'] :: DashboardValidationMessage -> Maybe Text
-- | 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.
newDashboardValidationMessage :: DashboardValidationMessage
-- | The data path related to the message.
dashboardValidationMessage_dataPath :: Lens' DashboardValidationMessage (Maybe Text)
-- | A message describing the error or warning.
dashboardValidationMessage_message :: Lens' DashboardValidationMessage (Maybe Text)
-- | Encapsulates the statistical data that CloudWatch computes from metric
-- data.
--
-- See: newDatapoint smart constructor.
data Datapoint
Datapoint' :: Maybe Double -> Maybe (HashMap Text Double) -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe ISO8601 -> Maybe StandardUnit -> Datapoint
-- | The average of the metric values that correspond to the data point.
[$sel:average:Datapoint'] :: Datapoint -> Maybe Double
-- | The percentile statistic for the data point.
[$sel:extendedStatistics:Datapoint'] :: Datapoint -> Maybe (HashMap Text Double)
-- | The maximum metric value for the data point.
[$sel:maximum:Datapoint'] :: Datapoint -> Maybe Double
-- | The minimum metric value for the data point.
[$sel:minimum:Datapoint'] :: Datapoint -> Maybe Double
-- | The number of metric values that contributed to the aggregate value of
-- this data point.
[$sel:sampleCount:Datapoint'] :: Datapoint -> Maybe Double
-- | The sum of the metric values for the data point.
[$sel:sum:Datapoint'] :: Datapoint -> Maybe Double
-- | The time stamp used for the data point.
[$sel:timestamp:Datapoint'] :: Datapoint -> Maybe ISO8601
-- | The standard unit for the data point.
[$sel:unit:Datapoint'] :: Datapoint -> Maybe StandardUnit
-- | 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:average:Datapoint', datapoint_average - The average
-- of the metric values that correspond to the data point.
--
-- $sel:extendedStatistics:Datapoint',
-- datapoint_extendedStatistics - The percentile statistic for the
-- data point.
--
-- $sel:maximum:Datapoint', datapoint_maximum - The maximum
-- metric value for the data point.
--
-- $sel:minimum:Datapoint', datapoint_minimum - The minimum
-- metric value for the data point.
--
-- $sel:sampleCount:Datapoint', datapoint_sampleCount - The
-- number of metric values that contributed to the aggregate value of
-- this data point.
--
-- $sel:sum:Datapoint', datapoint_sum - The sum of the
-- metric values for the data point.
--
-- $sel:timestamp:Datapoint', datapoint_timestamp - The
-- time stamp used for the data point.
--
-- $sel:unit:Datapoint', datapoint_unit - The standard unit
-- for the data point.
newDatapoint :: Datapoint
-- | The average of the metric values that correspond to the data point.
datapoint_average :: Lens' Datapoint (Maybe Double)
-- | The percentile statistic for the data point.
datapoint_extendedStatistics :: Lens' Datapoint (Maybe (HashMap Text Double))
-- | The maximum metric value for the data point.
datapoint_maximum :: Lens' Datapoint (Maybe Double)
-- | The minimum metric value for the data point.
datapoint_minimum :: Lens' Datapoint (Maybe Double)
-- | The number of metric values that contributed to the aggregate value of
-- this data point.
datapoint_sampleCount :: Lens' Datapoint (Maybe Double)
-- | The sum of the metric values for the data point.
datapoint_sum :: Lens' Datapoint (Maybe Double)
-- | The time stamp used for the data point.
datapoint_timestamp :: Lens' Datapoint (Maybe UTCTime)
-- | The standard unit for the data point.
datapoint_unit :: Lens' Datapoint (Maybe StandardUnit)
-- | A dimension is a name/value pair that is part of the identity of a
-- metric. Because dimensions are part of the unique identifier for a
-- metric, whenever you add a unique name/value pair to one of your
-- metrics, you are creating a new variation of that metric. For example,
-- many Amazon EC2 metrics publish InstanceId as a dimension
-- name, and the actual instance ID as the value for that dimension.
--
-- You can assign up to 30 dimensions to a metric.
--
-- See: newDimension smart constructor.
data Dimension
Dimension' :: Text -> Text -> Dimension
-- | The name of the dimension. Dimension names must contain only ASCII
-- characters, must include at least one non-whitespace character, and
-- cannot start with a colon (:).
[$sel:name:Dimension'] :: Dimension -> Text
-- | The value of the dimension. Dimension values must contain only ASCII
-- characters and must include at least one non-whitespace character.
[$sel:value:Dimension'] :: Dimension -> 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, must
-- include at least one non-whitespace character, and cannot start with a
-- colon (:).
--
-- $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.
newDimension :: Text -> Text -> Dimension
-- | The name of the dimension. Dimension names must contain only ASCII
-- characters, must include at least one non-whitespace character, and
-- cannot start with a colon (:).
dimension_name :: Lens' Dimension Text
-- | The value of the dimension. Dimension values must contain only ASCII
-- characters and must include at least one non-whitespace character.
dimension_value :: Lens' Dimension Text
-- | Represents filters for a dimension.
--
-- See: newDimensionFilter smart constructor.
data DimensionFilter
DimensionFilter' :: Maybe Text -> Text -> DimensionFilter
-- | The value of the dimension to be matched.
[$sel:value:DimensionFilter'] :: DimensionFilter -> Maybe Text
-- | The dimension name to be matched.
[$sel:name:DimensionFilter'] :: DimensionFilter -> Text
-- | 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.
newDimensionFilter :: Text -> DimensionFilter
-- | The value of the dimension to be matched.
dimensionFilter_value :: Lens' DimensionFilter (Maybe Text)
-- | The dimension name to be matched.
dimensionFilter_name :: Lens' DimensionFilter Text
-- | This structure contains the definition for a Contributor Insights
-- rule. For more information about this rule, see Using Constributor
-- Insights to analyze high-cardinality data in the Amazon
-- CloudWatch User Guide.
--
-- See: newInsightRule smart constructor.
data InsightRule
InsightRule' :: Maybe Bool -> Text -> Text -> Text -> Text -> InsightRule
-- | An optional built-in rule that Amazon Web Services manages.
[$sel:managedRule:InsightRule'] :: InsightRule -> Maybe Bool
-- | The name of the rule.
[$sel:name:InsightRule'] :: InsightRule -> Text
-- | Indicates whether the rule is enabled or disabled.
[$sel:state:InsightRule'] :: InsightRule -> Text
-- | For rules that you create, this is always {"Name":
-- "CloudWatchLogRule", "Version": 1}. For managed rules, this is
-- {"Name": "ServiceLogRule", "Version": 1}
[$sel:schema:InsightRule'] :: InsightRule -> Text
-- | 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.
[$sel:definition:InsightRule'] :: InsightRule -> Text
-- | 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:managedRule:InsightRule', insightRule_managedRule -
-- An optional built-in rule that Amazon Web Services manages.
--
-- $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 managed 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.
newInsightRule :: Text -> Text -> Text -> Text -> InsightRule
-- | An optional built-in rule that Amazon Web Services manages.
insightRule_managedRule :: Lens' InsightRule (Maybe Bool)
-- | The name of the rule.
insightRule_name :: Lens' InsightRule Text
-- | Indicates whether the rule is enabled or disabled.
insightRule_state :: Lens' InsightRule Text
-- | For rules that you create, this is always {"Name":
-- "CloudWatchLogRule", "Version": 1}. For managed rules, this is
-- {"Name": "ServiceLogRule", "Version": 1}
insightRule_schema :: Lens' InsightRule Text
-- | The definition of the rule, as a JSON object. The definition contains
-- the keywords used to define contributors, the value to aggregate on if
-- this rule returns a sum instead of a count, and the filters. For
-- details on the valid syntax, see Contributor Insights Rule
-- Syntax.
insightRule_definition :: Lens' InsightRule Text
-- | 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.
data InsightRuleContributor
InsightRuleContributor' :: [Text] -> Double -> [InsightRuleContributorDatapoint] -> InsightRuleContributor
-- | One of the log entry field keywords that is used to define
-- contributors for this rule.
[$sel:keys:InsightRuleContributor'] :: InsightRuleContributor -> [Text]
-- | An approximation of the aggregate value that comes from this
-- contributor.
[$sel:approximateAggregateValue:InsightRuleContributor'] :: InsightRuleContributor -> Double
-- | An array of the data points where this contributor is present. Only
-- the data points when this contributor appeared are included in the
-- array.
[$sel:datapoints:InsightRuleContributor'] :: InsightRuleContributor -> [InsightRuleContributorDatapoint]
-- | 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.
newInsightRuleContributor :: Double -> InsightRuleContributor
-- | One of the log entry field keywords that is used to define
-- contributors for this rule.
insightRuleContributor_keys :: Lens' InsightRuleContributor [Text]
-- | An approximation of the aggregate value that comes from this
-- contributor.
insightRuleContributor_approximateAggregateValue :: Lens' InsightRuleContributor Double
-- | An array of the data points where this contributor is present. Only
-- the data points when this contributor appeared are included in the
-- array.
insightRuleContributor_datapoints :: Lens' InsightRuleContributor [InsightRuleContributorDatapoint]
-- | One data point related to one contributor.
--
-- For more information, see GetInsightRuleReport and
-- InsightRuleContributor.
--
-- See: newInsightRuleContributorDatapoint smart
-- constructor.
data InsightRuleContributorDatapoint
InsightRuleContributorDatapoint' :: ISO8601 -> Double -> InsightRuleContributorDatapoint
-- | The timestamp of the data point.
[$sel:timestamp:InsightRuleContributorDatapoint'] :: InsightRuleContributorDatapoint -> ISO8601
-- | The approximate value that this contributor added during this
-- timestamp.
[$sel:approximateValue:InsightRuleContributorDatapoint'] :: InsightRuleContributorDatapoint -> Double
-- | 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.
newInsightRuleContributorDatapoint :: UTCTime -> Double -> InsightRuleContributorDatapoint
-- | The timestamp of the data point.
insightRuleContributorDatapoint_timestamp :: Lens' InsightRuleContributorDatapoint UTCTime
-- | The approximate value that this contributor added during this
-- timestamp.
insightRuleContributorDatapoint_approximateValue :: Lens' InsightRuleContributorDatapoint Double
-- | One data point from the metric time series returned in a Contributor
-- Insights rule report.
--
-- For more information, see GetInsightRuleReport.
--
-- See: newInsightRuleMetricDatapoint smart constructor.
data InsightRuleMetricDatapoint
InsightRuleMetricDatapoint' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> ISO8601 -> InsightRuleMetricDatapoint
-- | 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:average:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:maxContributorValue:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:maximum:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:minimum:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:sampleCount:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:sum:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | 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:uniqueContributors:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> Maybe Double
-- | The timestamp of the data point.
[$sel:timestamp:InsightRuleMetricDatapoint'] :: InsightRuleMetricDatapoint -> ISO8601
-- | 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: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: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: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: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: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: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: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:timestamp:InsightRuleMetricDatapoint',
-- insightRuleMetricDatapoint_timestamp - The timestamp of the
-- data point.
newInsightRuleMetricDatapoint :: UTCTime -> InsightRuleMetricDatapoint
-- | The average value from all contributors during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_average :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The maximum value provided by one contributor during this timestamp.
-- Each timestamp is evaluated separately, so the identity of the max
-- contributor could be different for each timestamp.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_maxContributorValue :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The maximum value from a single occurence from a single contributor
-- during the time period represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_maximum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The minimum value from a single contributor during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_minimum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The number of occurrences that matched the rule during this data
-- point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_sampleCount :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The sum of the values from all contributors during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_sum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The number of unique contributors who published data during this
-- timestamp.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_uniqueContributors :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The timestamp of the data point.
insightRuleMetricDatapoint_timestamp :: Lens' InsightRuleMetricDatapoint UTCTime
-- | 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.
data LabelOptions
LabelOptions' :: Maybe Text -> LabelOptions
-- | 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.
[$sel:timezone:LabelOptions'] :: LabelOptions -> Maybe Text
-- | 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.
newLabelOptions :: LabelOptions
-- | The time zone to use for metric data return in this operation. The
-- format is + or - followed by four digits. The first
-- two digits indicate the number of hours ahead or behind of UTC, and
-- the final two digits are the number of minutes. For example, +0130
-- indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The
-- default is +0000.
labelOptions_timezone :: Lens' LabelOptions (Maybe Text)
-- | Contains the information that's required to enable a managed
-- Contributor Insights rule for an Amazon Web Services resource.
--
-- See: newManagedRule smart constructor.
data ManagedRule
ManagedRule' :: Maybe [Tag] -> Text -> Text -> ManagedRule
-- | A list of key-value pairs that you can associate with a managed
-- Contributor Insights rule. You can associate as many as 50 tags with a
-- rule. Tags can help you organize and categorize your resources. You
-- also can use them to scope user permissions by granting a user
-- permission to access or change only the resources that have certain
-- tag values. To associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
[$sel:tags:ManagedRule'] :: ManagedRule -> Maybe [Tag]
-- | The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
[$sel:templateName:ManagedRule'] :: ManagedRule -> Text
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
[$sel:resourceARN:ManagedRule'] :: ManagedRule -> Text
-- | Create a value of ManagedRule 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:ManagedRule', managedRule_tags - A list of
-- key-value pairs that you can associate with a managed Contributor
-- Insights rule. You can associate as many as 50 tags with a rule. Tags
-- can help you organize and categorize your resources. You also can use
-- them to scope user permissions by granting a user permission to access
-- or change only the resources that have certain tag values. To
-- associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
--
-- $sel:templateName:ManagedRule', managedRule_templateName
-- - The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
--
-- $sel:resourceARN:ManagedRule', managedRule_resourceARN -
-- The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
newManagedRule :: Text -> Text -> ManagedRule
-- | A list of key-value pairs that you can associate with a managed
-- Contributor Insights rule. You can associate as many as 50 tags with a
-- rule. Tags can help you organize and categorize your resources. You
-- also can use them to scope user permissions by granting a user
-- permission to access or change only the resources that have certain
-- tag values. To associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
managedRule_tags :: Lens' ManagedRule (Maybe [Tag])
-- | The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
managedRule_templateName :: Lens' ManagedRule Text
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
managedRule_resourceARN :: Lens' ManagedRule Text
-- | Contains information about managed Contributor Insights rules, as
-- returned by ListManagedInsightRules.
--
-- See: newManagedRuleDescription smart constructor.
data ManagedRuleDescription
ManagedRuleDescription' :: Maybe Text -> Maybe ManagedRuleState -> Maybe Text -> ManagedRuleDescription
-- | If a managed rule is enabled, this is the ARN for the related Amazon
-- Web Services resource.
[$sel:resourceARN:ManagedRuleDescription'] :: ManagedRuleDescription -> Maybe Text
-- | Describes the state of a managed rule. If present, it contains
-- information about the Contributor Insights rule that contains
-- information about the related Amazon Web Services resource.
[$sel:ruleState:ManagedRuleDescription'] :: ManagedRuleDescription -> Maybe ManagedRuleState
-- | The template name for the managed rule. Used to enable managed rules
-- using PutManagedInsightRules.
[$sel:templateName:ManagedRuleDescription'] :: ManagedRuleDescription -> Maybe Text
-- | Create a value of ManagedRuleDescription 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:ManagedRuleDescription',
-- managedRuleDescription_resourceARN - If a managed rule is
-- enabled, this is the ARN for the related Amazon Web Services resource.
--
-- $sel:ruleState:ManagedRuleDescription',
-- managedRuleDescription_ruleState - Describes the state of a
-- managed rule. If present, it contains information about the
-- Contributor Insights rule that contains information about the related
-- Amazon Web Services resource.
--
-- $sel:templateName:ManagedRuleDescription',
-- managedRuleDescription_templateName - The template name for the
-- managed rule. Used to enable managed rules using
-- PutManagedInsightRules.
newManagedRuleDescription :: ManagedRuleDescription
-- | If a managed rule is enabled, this is the ARN for the related Amazon
-- Web Services resource.
managedRuleDescription_resourceARN :: Lens' ManagedRuleDescription (Maybe Text)
-- | Describes the state of a managed rule. If present, it contains
-- information about the Contributor Insights rule that contains
-- information about the related Amazon Web Services resource.
managedRuleDescription_ruleState :: Lens' ManagedRuleDescription (Maybe ManagedRuleState)
-- | The template name for the managed rule. Used to enable managed rules
-- using PutManagedInsightRules.
managedRuleDescription_templateName :: Lens' ManagedRuleDescription (Maybe Text)
-- | The status of a managed Contributor Insights rule.
--
-- See: newManagedRuleState smart constructor.
data ManagedRuleState
ManagedRuleState' :: Text -> Text -> ManagedRuleState
-- | The name of the Contributor Insights rule that contains data for the
-- specified Amazon Web Services resource.
[$sel:ruleName:ManagedRuleState'] :: ManagedRuleState -> Text
-- | Indicates whether the rule is enabled or disabled.
[$sel:state:ManagedRuleState'] :: ManagedRuleState -> Text
-- | Create a value of ManagedRuleState 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:ruleName:ManagedRuleState',
-- managedRuleState_ruleName - The name of the Contributor
-- Insights rule that contains data for the specified Amazon Web Services
-- resource.
--
-- $sel:state:ManagedRuleState', managedRuleState_state -
-- Indicates whether the rule is enabled or disabled.
newManagedRuleState :: Text -> Text -> ManagedRuleState
-- | The name of the Contributor Insights rule that contains data for the
-- specified Amazon Web Services resource.
managedRuleState_ruleName :: Lens' ManagedRuleState Text
-- | Indicates whether the rule is enabled or disabled.
managedRuleState_state :: Lens' ManagedRuleState Text
-- | A message returned by the GetMetricDataAPI, including a code
-- and a description.
--
-- If a cross-Region GetMetricData operation fails with a code
-- of Forbidden and a value of Authentication too complex to
-- retrieve cross region data, you can correct the problem by
-- running the GetMetricData operation in the same Region where
-- the metric data is.
--
-- See: newMessageData smart constructor.
data MessageData
MessageData' :: Maybe Text -> Maybe Text -> MessageData
-- | The error code or status code associated with the message.
[$sel:code:MessageData'] :: MessageData -> Maybe Text
-- | The message text.
[$sel:value:MessageData'] :: MessageData -> Maybe Text
-- | 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:code:MessageData', messageData_code - The error
-- code or status code associated with the message.
--
-- $sel:value:MessageData', messageData_value - The message
-- text.
newMessageData :: MessageData
-- | The error code or status code associated with the message.
messageData_code :: Lens' MessageData (Maybe Text)
-- | The message text.
messageData_value :: Lens' MessageData (Maybe Text)
-- | Represents a specific metric.
--
-- See: newMetric smart constructor.
data Metric
Metric' :: Maybe [Dimension] -> Maybe Text -> Maybe Text -> Metric
-- | The dimensions for the metric.
[$sel:dimensions:Metric'] :: Metric -> Maybe [Dimension]
-- | The name of the metric. This is a required field.
[$sel:metricName:Metric'] :: Metric -> Maybe Text
-- | The namespace of the metric.
[$sel:namespace:Metric'] :: Metric -> Maybe Text
-- | 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:dimensions:Metric', metric_dimensions - The
-- dimensions for the metric.
--
-- $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.
newMetric :: Metric
-- | The dimensions for the metric.
metric_dimensions :: Lens' Metric (Maybe [Dimension])
-- | The name of the metric. This is a required field.
metric_metricName :: Lens' Metric (Maybe Text)
-- | The namespace of the metric.
metric_namespace :: Lens' Metric (Maybe Text)
-- | The details about a metric alarm.
--
-- See: newMetricAlarm smart constructor.
data MetricAlarm
MetricAlarm' :: Maybe Bool -> Maybe [Text] -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe Text -> Maybe ComparisonOperator -> Maybe Natural -> Maybe [Dimension] -> Maybe Text -> Maybe Natural -> Maybe EvaluationState -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe [MetricDataQuery] -> Maybe Text -> Maybe [Text] -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe ISO8601 -> Maybe StateValue -> Maybe Statistic -> Maybe Double -> Maybe Text -> Maybe Text -> Maybe StandardUnit -> MetricAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
[$sel:actionsEnabled:MetricAlarm'] :: MetricAlarm -> Maybe Bool
-- | 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:alarmActions:MetricAlarm'] :: MetricAlarm -> Maybe [Text]
-- | The Amazon Resource Name (ARN) of the alarm.
[$sel:alarmArn:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The time stamp of the last update to the alarm configuration.
[$sel:alarmConfigurationUpdatedTimestamp:MetricAlarm'] :: MetricAlarm -> Maybe ISO8601
-- | The description of the alarm.
[$sel:alarmDescription:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The name of the alarm.
[$sel:alarmName:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The arithmetic operation to use when comparing the specified statistic
-- and threshold. The specified statistic value is used as the first
-- operand.
[$sel:comparisonOperator:MetricAlarm'] :: MetricAlarm -> Maybe ComparisonOperator
-- | The number of data points that must be breaching to trigger the alarm.
[$sel:datapointsToAlarm:MetricAlarm'] :: MetricAlarm -> Maybe Natural
-- | The dimensions for the metric associated with the alarm.
[$sel:dimensions:MetricAlarm'] :: MetricAlarm -> Maybe [Dimension]
-- | 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:evaluateLowSampleCountPercentile:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The number of periods over which data is compared to the specified
-- threshold.
[$sel:evaluationPeriods:MetricAlarm'] :: MetricAlarm -> Maybe Natural
-- | If the value of this field is PARTIAL_DATA, the alarm is
-- being evaluated based on only partial data. This happens if the query
-- used for the alarm returns more than 10,000 metrics. For more
-- information, see Create alarms on Metrics Insights queries.
[$sel:evaluationState:MetricAlarm'] :: MetricAlarm -> Maybe EvaluationState
-- | The percentile statistic for the metric associated with the alarm.
-- Specify a value between p0.0 and p100.
[$sel:extendedStatistic:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | 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:insufficientDataActions:MetricAlarm'] :: MetricAlarm -> Maybe [Text]
-- | The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
[$sel:metricName:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | 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:metrics:MetricAlarm'] :: MetricAlarm -> Maybe [MetricDataQuery]
-- | The namespace of the metric associated with the alarm.
[$sel:namespace:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | 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:oKActions:MetricAlarm'] :: MetricAlarm -> Maybe [Text]
-- | The period, in seconds, over which the statistic is applied.
[$sel:period:MetricAlarm'] :: MetricAlarm -> Maybe Natural
-- | An explanation for the alarm state, in text format.
[$sel:stateReason:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | An explanation for the alarm state, in JSON format.
[$sel:stateReasonData:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The date and time that the alarm's StateValue most recently
-- changed.
[$sel:stateTransitionedTimestamp:MetricAlarm'] :: MetricAlarm -> Maybe ISO8601
-- | The time stamp of the last update to the value of either the
-- StateValue or EvaluationState parameters.
[$sel:stateUpdatedTimestamp:MetricAlarm'] :: MetricAlarm -> Maybe ISO8601
-- | The state value for the alarm.
[$sel:stateValue:MetricAlarm'] :: MetricAlarm -> Maybe StateValue
-- | The statistic for the metric associated with the alarm, other than
-- percentile. For percentile statistics, use ExtendedStatistic.
[$sel:statistic:MetricAlarm'] :: MetricAlarm -> Maybe Statistic
-- | The value to compare with the specified statistic.
[$sel:threshold:MetricAlarm'] :: MetricAlarm -> Maybe Double
-- | 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:thresholdMetricId:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | Sets how this alarm is to handle missing data points. The valid values
-- are breaching, notBreaching, ignore, and
-- missing. For more information, see Configuring how
-- CloudWatch alarms treat missing data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
[$sel:treatMissingData:MetricAlarm'] :: MetricAlarm -> Maybe Text
-- | The unit of the metric associated with the alarm.
[$sel:unit:MetricAlarm'] :: MetricAlarm -> Maybe StandardUnit
-- | 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:actionsEnabled:MetricAlarm',
-- metricAlarm_actionsEnabled - Indicates whether actions should
-- be executed during any changes to the alarm state.
--
-- $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:alarmArn:MetricAlarm', metricAlarm_alarmArn - The
-- Amazon Resource Name (ARN) of the alarm.
--
-- $sel:alarmConfigurationUpdatedTimestamp:MetricAlarm',
-- metricAlarm_alarmConfigurationUpdatedTimestamp - The time stamp
-- of the last update to the alarm configuration.
--
-- $sel:alarmDescription:MetricAlarm',
-- metricAlarm_alarmDescription - The description of the alarm.
--
-- $sel:alarmName:MetricAlarm', metricAlarm_alarmName - The
-- name of 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:datapointsToAlarm:MetricAlarm',
-- metricAlarm_datapointsToAlarm - The number of data points that
-- must be breaching to trigger the alarm.
--
-- $sel:dimensions:MetricAlarm', metricAlarm_dimensions -
-- The dimensions for the metric associated with the alarm.
--
-- $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:evaluationPeriods:MetricAlarm',
-- metricAlarm_evaluationPeriods - The number of periods over
-- which data is compared to the specified threshold.
--
-- $sel:evaluationState:MetricAlarm',
-- metricAlarm_evaluationState - If the value of this field is
-- PARTIAL_DATA, the alarm is being evaluated based on only
-- partial data. This happens if the query used for the alarm returns
-- more than 10,000 metrics. For more information, see Create alarms
-- on Metrics Insights queries.
--
-- $sel:extendedStatistic:MetricAlarm',
-- metricAlarm_extendedStatistic - The percentile statistic for
-- the metric associated with the alarm. Specify a value between p0.0 and
-- p100.
--
-- $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:metricName:MetricAlarm', metricAlarm_metricName -
-- The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
--
-- $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:namespace:MetricAlarm', metricAlarm_namespace - The
-- namespace of the metric associated with the alarm.
--
-- $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).
--
-- MetricAlarm, metricAlarm_period - The period, in
-- seconds, over which the statistic is applied.
--
-- $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:stateTransitionedTimestamp:MetricAlarm',
-- metricAlarm_stateTransitionedTimestamp - The date and time that
-- the alarm's StateValue most recently changed.
--
-- $sel:stateUpdatedTimestamp:MetricAlarm',
-- metricAlarm_stateUpdatedTimestamp - The time stamp of the last
-- update to the value of either the StateValue or
-- EvaluationState parameters.
--
-- $sel:stateValue:MetricAlarm', metricAlarm_stateValue -
-- The state value for 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:threshold:MetricAlarm', metricAlarm_threshold - The
-- value to compare with the specified statistic.
--
-- $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:treatMissingData:MetricAlarm',
-- metricAlarm_treatMissingData - Sets how this alarm is to handle
-- missing data points. The valid values are breaching,
-- notBreaching, ignore, and missing. For more
-- information, see Configuring how CloudWatch alarms treat missing
-- data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
--
-- $sel:unit:MetricAlarm', metricAlarm_unit - The unit of
-- the metric associated with the alarm.
newMetricAlarm :: MetricAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool)
-- | The actions to execute when this alarm transitions to the
-- ALARM state from any other state. Each action is specified as
-- an Amazon Resource Name (ARN).
metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text])
-- | The Amazon Resource Name (ARN) of the alarm.
metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text)
-- | The time stamp of the last update to the alarm configuration.
metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The description of the alarm.
metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text)
-- | The name of the alarm.
metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text)
-- | The arithmetic operation to use when comparing the specified statistic
-- and threshold. The specified statistic value is used as the first
-- operand.
metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
-- | The number of data points that must be breaching to trigger the alarm.
metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
-- | The dimensions for the metric associated with the alarm.
metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension])
-- | Used only for alarms based on percentiles. If ignore, the
-- alarm state does not change during periods with too few data points to
-- be statistically significant. If evaluate or this parameter
-- is not used, the alarm is always evaluated and possibly changes state
-- no matter how many data points are available.
metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
-- | The number of periods over which data is compared to the specified
-- threshold.
metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
-- | If the value of this field is PARTIAL_DATA, the alarm is
-- being evaluated based on only partial data. This happens if the query
-- used for the alarm returns more than 10,000 metrics. For more
-- information, see Create alarms on Metrics Insights queries.
metricAlarm_evaluationState :: Lens' MetricAlarm (Maybe EvaluationState)
-- | The percentile statistic for the metric associated with the alarm.
-- Specify a value between p0.0 and p100.
metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the
-- INSUFFICIENT_DATA state from any other state. Each action is
-- specified as an Amazon Resource Name (ARN).
metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text])
-- | The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text)
-- | An array of MetricDataQuery structures, used in an alarm based on a
-- metric math expression. Each structure either retrieves a metric or
-- performs a math expression. One item in the Metrics array is the math
-- expression that the alarm watches. This expression by designated by
-- having ReturnData set to true.
metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery])
-- | The namespace of the metric associated with the alarm.
metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the OK
-- state from any other state. Each action is specified as an Amazon
-- Resource Name (ARN).
metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text])
-- | The period, in seconds, over which the statistic is applied.
metricAlarm_period :: Lens' MetricAlarm (Maybe Natural)
-- | An explanation for the alarm state, in text format.
metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text)
-- | An explanation for the alarm state, in JSON format.
metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text)
-- | The date and time that the alarm's StateValue most recently
-- changed.
metricAlarm_stateTransitionedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The time stamp of the last update to the value of either the
-- StateValue or EvaluationState parameters.
metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The state value for the alarm.
metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue)
-- | The statistic for the metric associated with the alarm, other than
-- percentile. For percentile statistics, use ExtendedStatistic.
metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic)
-- | The value to compare with the specified statistic.
metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double)
-- | In an alarm based on an anomaly detection model, this is the ID of the
-- ANOMALY_DETECTION_BAND function used as the threshold for the
-- alarm.
metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text)
-- | Sets how this alarm is to handle missing data points. The valid values
-- are breaching, notBreaching, ignore, and
-- missing. For more information, see Configuring how
-- CloudWatch alarms treat missing data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text)
-- | The unit of the metric associated with the alarm.
metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit)
-- | This structure is used in both GetMetricData and
-- PutMetricAlarm. The supported use of this structure is
-- different for those two operations.
--
-- When used in GetMetricData, it indicates the metric data to
-- return, and whether this call is just retrieving a batch set of data
-- for one metric, or is performing a Metrics Insights query or a math
-- expression. A single GetMetricData call can include up to 500
-- MetricDataQuery structures.
--
-- When used in PutMetricAlarm, it enables you to create an
-- alarm based on a metric math expression. Each MetricDataQuery
-- in the array specifies either a metric to retrieve, or a math
-- expression to be performed on retrieved metrics. A single
-- PutMetricAlarm call can include up to 20
-- MetricDataQuery structures in the array. The 20 structures
-- can include as many as 10 structures that contain a
-- MetricStat parameter to retrieve a metric, and as many as 10
-- structures that contain the Expression parameter to perform a
-- math expression. Of those Expression structures, one must
-- have true as the value for ReturnData. The result of
-- this expression is the value the alarm watches.
--
-- Any expression used in a PutMetricAlarm operation must return
-- a single time series. For more information, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Some of the parameters of this structure also have different uses
-- whether you are using this structure in a GetMetricData
-- operation or a PutMetricAlarm operation. These differences
-- are explained in the following parameter list.
--
-- See: newMetricDataQuery smart constructor.
data MetricDataQuery
MetricDataQuery' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe MetricStat -> Maybe Natural -> Maybe Bool -> Text -> MetricDataQuery
-- | The ID of the account where the metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
[$sel:accountId:MetricDataQuery'] :: MetricDataQuery -> Maybe Text
-- | This field can contain either a Metrics Insights query, or a metric
-- math expression to be performed on the returned data. For more
-- information about Metrics Insights queries, see Metrics Insights
-- query components and syntax in the Amazon CloudWatch User
-- Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
[$sel:expression:MetricDataQuery'] :: MetricDataQuery -> Maybe Text
-- | 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:label:MetricDataQuery'] :: MetricDataQuery -> Maybe Text
-- | 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:metricStat:MetricDataQuery'] :: MetricDataQuery -> Maybe MetricStat
-- | 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:period:MetricDataQuery'] :: MetricDataQuery -> Maybe Natural
-- | 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:returnData:MetricDataQuery'] :: MetricDataQuery -> Maybe Bool
-- | 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.
[$sel:id:MetricDataQuery'] :: MetricDataQuery -> Text
-- | 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:accountId:MetricDataQuery',
-- metricDataQuery_accountId - The ID of the account where the
-- metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
--
-- $sel:expression:MetricDataQuery',
-- metricDataQuery_expression - This field can contain either a
-- Metrics Insights query, or a metric math expression to be performed on
-- the returned data. For more information about Metrics Insights
-- queries, see Metrics Insights query components and syntax in
-- the Amazon CloudWatch User Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
--
-- $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.
--
-- 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: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: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.
newMetricDataQuery :: Text -> MetricDataQuery
-- | The ID of the account where the metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
metricDataQuery_accountId :: Lens' MetricDataQuery (Maybe Text)
-- | This field can contain either a Metrics Insights query, or a metric
-- math expression to be performed on the returned data. For more
-- information about Metrics Insights queries, see Metrics Insights
-- query components and syntax in the Amazon CloudWatch User
-- Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text)
-- | A human-readable label for this metric or expression. This is
-- especially useful if this is an expression, so that you know what the
-- value represents. If the metric or expression is shown in a CloudWatch
-- dashboard widget, the label is shown. If Label is omitted, CloudWatch
-- generates a default.
--
-- You can put dynamic expressions into a label, so that it is more
-- descriptive. For more information, see Using Dynamic Labels.
metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text)
-- | The metric to be returned, along with statistics, period, and units.
-- Use this parameter only if this object is retrieving a metric and not
-- performing a math expression on returned data.
--
-- Within one MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat)
-- | The granularity, in seconds, of the returned data points. For metrics
-- with regular resolution, a period can be as short as one minute (60
-- seconds) and must be a multiple of 60. For high-resolution metrics
-- that are collected at intervals of less than one minute, the period
-- can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
-- metrics are those metrics stored by a PutMetricData operation
-- that includes a StorageResolution of 1 second.
metricDataQuery_period :: Lens' MetricDataQuery (Maybe Natural)
-- | When used in GetMetricData, this option indicates whether to
-- return the timestamps and raw data values of this metric. If you are
-- performing this call just to do math expressions and do not also need
-- the raw data returned, you can specify false. If you omit
-- this, the default of true is used.
--
-- When used in PutMetricAlarm, specify true for the
-- one expression result to use as the alarm. For all other metrics and
-- expressions in the same PutMetricAlarm operation, specify
-- ReturnData as False.
metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool)
-- | A short name used to tie this object to the results in the response.
-- This name must be unique within a single call to
-- GetMetricData. If you are performing math expressions on this
-- set of data, this name represents that data and can serve as a
-- variable in the mathematical expression. The valid characters are
-- letters, numbers, and underscore. The first character must be a
-- lowercase letter.
metricDataQuery_id :: Lens' MetricDataQuery Text
-- | 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.
data MetricDataResult
MetricDataResult' :: Maybe Text -> Maybe Text -> Maybe [MessageData] -> Maybe StatusCode -> Maybe [ISO8601] -> Maybe [Double] -> MetricDataResult
-- | The short name you specified to represent this metric.
[$sel:id:MetricDataResult'] :: MetricDataResult -> Maybe Text
-- | The human-readable label associated with the data.
[$sel:label:MetricDataResult'] :: MetricDataResult -> Maybe Text
-- | A list of messages with additional information about the data
-- returned.
[$sel:messages:MetricDataResult'] :: MetricDataResult -> Maybe [MessageData]
-- | 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.
[$sel:statusCode:MetricDataResult'] :: MetricDataResult -> Maybe StatusCode
-- | 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:timestamps:MetricDataResult'] :: MetricDataResult -> Maybe [ISO8601]
-- | 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:values:MetricDataResult'] :: MetricDataResult -> Maybe [Double]
-- | 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:id:MetricDataResult', metricDataResult_id - The
-- short name you specified to represent this metric.
--
-- $sel:label:MetricDataResult', metricDataResult_label -
-- The human-readable label associated with the data.
--
-- $sel:messages:MetricDataResult',
-- metricDataResult_messages - A list of messages with additional
-- information about the data returned.
--
-- $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.
--
-- $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: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].
newMetricDataResult :: MetricDataResult
-- | The short name you specified to represent this metric.
metricDataResult_id :: Lens' MetricDataResult (Maybe Text)
-- | The human-readable label associated with the data.
metricDataResult_label :: Lens' MetricDataResult (Maybe Text)
-- | A list of messages with additional information about the data
-- returned.
metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData])
-- | The status of the returned data. Complete indicates that all
-- data points in the requested time range were returned.
-- PartialData means that an incomplete set of data points were
-- returned. You can use the NextToken value that was returned
-- and repeat your request to get more data points. NextToken is
-- not returned if you are performing a math expression.
-- InternalError indicates that an error occurred. Retry your
-- request using NextToken, if present.
metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode)
-- | The timestamps for the data points, formatted in Unix timestamp
-- format. The number of timestamps always matches the number of values
-- and the value for Timestamps[x] is Values[x].
metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime])
-- | The data points for the metric corresponding to Timestamps.
-- The number of values always matches the number of timestamps and the
-- timestamp for Values[x] is Timestamps[x].
metricDataResult_values :: Lens' MetricDataResult (Maybe [Double])
-- | Encapsulates the information sent to either create a metric or add new
-- values to be aggregated into an existing metric.
--
-- See: newMetricDatum smart constructor.
data MetricDatum
MetricDatum' :: Maybe [Double] -> Maybe [Dimension] -> Maybe StatisticSet -> Maybe Natural -> Maybe ISO8601 -> Maybe StandardUnit -> Maybe Double -> Maybe [Double] -> Text -> MetricDatum
-- | 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:counts:MetricDatum'] :: MetricDatum -> Maybe [Double]
-- | The dimensions associated with the metric.
[$sel:dimensions:MetricDatum'] :: MetricDatum -> Maybe [Dimension]
-- | The statistical values for the metric.
[$sel:statisticValues:MetricDatum'] :: MetricDatum -> Maybe StatisticSet
-- | 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:storageResolution:MetricDatum'] :: MetricDatum -> Maybe Natural
-- | The time the metric data was received, expressed as the number of
-- milliseconds since Jan 1, 1970 00:00:00 UTC.
[$sel:timestamp:MetricDatum'] :: MetricDatum -> Maybe ISO8601
-- | 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:unit:MetricDatum'] :: MetricDatum -> Maybe StandardUnit
-- | 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:value:MetricDatum'] :: MetricDatum -> Maybe Double
-- | 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:values:MetricDatum'] :: MetricDatum -> Maybe [Double]
-- | The name of the metric.
[$sel:metricName:MetricDatum'] :: MetricDatum -> Text
-- | 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: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:dimensions:MetricDatum', metricDatum_dimensions -
-- The dimensions associated with the metric.
--
-- $sel:statisticValues:MetricDatum',
-- metricDatum_statisticValues - The statistical values for the
-- metric.
--
-- $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: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: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.
--
-- 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: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:metricName:MetricDatum', metricDatum_metricName -
-- The name of the metric.
newMetricDatum :: Text -> MetricDatum
-- | Array of numbers that is used along with the Values array.
-- Each number in the Count array is the number of times the
-- corresponding value in the Values array occurred during the
-- period.
--
-- If you omit the Counts array, the default of 1 is used as the
-- value for each count. If you include a Counts array, it must
-- include the same amount of values as the Values array.
metricDatum_counts :: Lens' MetricDatum (Maybe [Double])
-- | The dimensions associated with the metric.
metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])
-- | The statistical values for the metric.
metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)
-- | Valid values are 1 and 60. Setting this to 1 specifies this metric as
-- a high-resolution metric, so that CloudWatch stores the metric with
-- sub-minute resolution down to one second. Setting this to 60 specifies
-- this metric as a regular-resolution metric, which CloudWatch stores at
-- 1-minute resolution. Currently, high resolution is available only for
-- custom metrics. For more information about high-resolution metrics,
-- see High-Resolution Metrics in the Amazon CloudWatch User
-- Guide.
--
-- This field is optional, if you do not specify it the default of 60 is
-- used.
metricDatum_storageResolution :: Lens' MetricDatum (Maybe Natural)
-- | The time the metric data was received, expressed as the number of
-- milliseconds since Jan 1, 1970 00:00:00 UTC.
metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime)
-- | When you are using a Put operation, this defines what unit
-- you want to use when storing the metric.
--
-- In a Get operation, this displays the unit that is used for
-- the metric.
metricDatum_unit :: Lens' MetricDatum (Maybe StandardUnit)
-- | The value for the metric.
--
-- Although the parameter accepts numbers of type Double, CloudWatch
-- rejects values that are either too small or too large. Values must be
-- in the range of -2^360 to 2^360. In addition, special values (for
-- example, NaN, +Infinity, -Infinity) are not supported.
metricDatum_value :: Lens' MetricDatum (Maybe Double)
-- | Array of numbers representing the values for the metric during the
-- period. Each unique value is listed just once in this array, and the
-- corresponding number in the Counts array specifies the number
-- of times that value occurred during the period. You can include up to
-- 150 unique values in each PutMetricData action that specifies
-- a Values array.
--
-- Although the Values array accepts numbers of type
-- Double, CloudWatch rejects values that are either too small
-- or too large. Values must be in the range of -2^360 to 2^360. In
-- addition, special values (for example, NaN, +Infinity, -Infinity) are
-- not supported.
metricDatum_values :: Lens' MetricDatum (Maybe [Double])
-- | The name of the metric.
metricDatum_metricName :: Lens' MetricDatum Text
-- | Indicates the CloudWatch math expression that provides the time series
-- the anomaly detector uses as input. The designated math expression
-- must return a single time series.
--
-- See: newMetricMathAnomalyDetector smart constructor.
data MetricMathAnomalyDetector
MetricMathAnomalyDetector' :: Maybe [MetricDataQuery] -> MetricMathAnomalyDetector
-- | An array of metric data query structures that enables you to create an
-- anomaly detector based on the result of a metric math expression. Each
-- item in MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
[$sel:metricDataQueries:MetricMathAnomalyDetector'] :: MetricMathAnomalyDetector -> Maybe [MetricDataQuery]
-- | Create a value of MetricMathAnomalyDetector 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:metricDataQueries:MetricMathAnomalyDetector',
-- metricMathAnomalyDetector_metricDataQueries - An array of
-- metric data query structures that enables you to create an anomaly
-- detector based on the result of a metric math expression. Each item in
-- MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
newMetricMathAnomalyDetector :: MetricMathAnomalyDetector
-- | An array of metric data query structures that enables you to create an
-- anomaly detector based on the result of a metric math expression. Each
-- item in MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
metricMathAnomalyDetector_metricDataQueries :: Lens' MetricMathAnomalyDetector (Maybe [MetricDataQuery])
-- | This structure defines the metric to be returned, along with the
-- statistics, period, and units.
--
-- See: newMetricStat smart constructor.
data MetricStat
MetricStat' :: Maybe StandardUnit -> Metric -> Natural -> Text -> MetricStat
-- | 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:unit:MetricStat'] :: MetricStat -> Maybe StandardUnit
-- | The metric to return, including the metric name, namespace, and
-- dimensions.
[$sel:metric:MetricStat'] :: MetricStat -> Metric
-- | 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:period:MetricStat'] :: MetricStat -> Natural
-- | The statistic to return. It can include any CloudWatch statistic or
-- extended statistic.
[$sel:stat:MetricStat'] :: MetricStat -> Text
-- | 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.
newMetricStat :: Metric -> Natural -> Text -> MetricStat
-- | When you are using a Put operation, this defines what unit
-- you want to use when storing the metric.
--
-- In a Get operation, if you omit Unit then all data
-- that was collected with any unit is returned, along with the
-- corresponding units that were specified when the data was reported to
-- CloudWatch. If you specify a unit, the operation returns only data
-- that was collected with that unit specified. If you specify a unit
-- that does not match the data collected, the results of the operation
-- are null. CloudWatch does not perform unit conversions.
metricStat_unit :: Lens' MetricStat (Maybe StandardUnit)
-- | The metric to return, including the metric name, namespace, and
-- dimensions.
metricStat_metric :: Lens' MetricStat Metric
-- | The granularity, in seconds, of the returned data points. For metrics
-- with regular resolution, a period can be as short as one minute (60
-- seconds) and must be a multiple of 60. For high-resolution metrics
-- that are collected at intervals of less than one minute, the period
-- can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
-- metrics are those metrics stored by a PutMetricData call that
-- includes a StorageResolution of 1 second.
--
-- If the StartTime parameter specifies a time stamp that is
-- greater than 3 hours ago, you must specify the period as follows or no
-- data points in that time range is returned:
--
--
-- - Start time between 3 hours and 15 days ago - Use a multiple of 60
-- seconds (1 minute).
-- - Start time between 15 and 63 days ago - Use a multiple of 300
-- seconds (5 minutes).
-- - Start time greater than 63 days ago - Use a multiple of 3600
-- seconds (1 hour).
--
metricStat_period :: Lens' MetricStat Natural
-- | The statistic to return. It can include any CloudWatch statistic or
-- extended statistic.
metricStat_stat :: Lens' MetricStat Text
-- | This structure contains the configuration information about one metric
-- stream.
--
-- See: newMetricStreamEntry smart constructor.
data MetricStreamEntry
MetricStreamEntry' :: Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe MetricStreamOutputFormat -> Maybe Text -> MetricStreamEntry
-- | The ARN of the metric stream.
[$sel:arn:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | The date that the metric stream was originally created.
[$sel:creationDate:MetricStreamEntry'] :: MetricStreamEntry -> Maybe ISO8601
-- | The ARN of the Kinesis Firehose devlivery stream that is used for this
-- metric stream.
[$sel:firehoseArn:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | The date that the configuration of this metric stream was most
-- recently updated.
[$sel:lastUpdateDate:MetricStreamEntry'] :: MetricStreamEntry -> Maybe ISO8601
-- | The name of the metric stream.
[$sel:name:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | The output format of this metric stream. Valid values are
-- json and opentelemetry0.7.
[$sel:outputFormat:MetricStreamEntry'] :: MetricStreamEntry -> Maybe MetricStreamOutputFormat
-- | The current state of this stream. Valid values are running
-- and stopped.
[$sel:state:MetricStreamEntry'] :: MetricStreamEntry -> Maybe Text
-- | 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:arn:MetricStreamEntry', metricStreamEntry_arn - The
-- ARN of the metric stream.
--
-- $sel:creationDate:MetricStreamEntry',
-- metricStreamEntry_creationDate - The date that the metric
-- stream was originally created.
--
-- $sel:firehoseArn:MetricStreamEntry',
-- metricStreamEntry_firehoseArn - The ARN of the Kinesis Firehose
-- devlivery stream that is used for this metric stream.
--
-- $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:outputFormat:MetricStreamEntry',
-- metricStreamEntry_outputFormat - The output format of this
-- metric stream. Valid values are json and
-- opentelemetry0.7.
--
-- $sel:state:MetricStreamEntry', metricStreamEntry_state -
-- The current state of this stream. Valid values are running
-- and stopped.
newMetricStreamEntry :: MetricStreamEntry
-- | The ARN of the metric stream.
metricStreamEntry_arn :: Lens' MetricStreamEntry (Maybe Text)
-- | The date that the metric stream was originally created.
metricStreamEntry_creationDate :: Lens' MetricStreamEntry (Maybe UTCTime)
-- | The ARN of the Kinesis Firehose devlivery stream that is used for this
-- metric stream.
metricStreamEntry_firehoseArn :: Lens' MetricStreamEntry (Maybe Text)
-- | The date that the configuration of this metric stream was most
-- recently updated.
metricStreamEntry_lastUpdateDate :: Lens' MetricStreamEntry (Maybe UTCTime)
-- | The name of the metric stream.
metricStreamEntry_name :: Lens' MetricStreamEntry (Maybe Text)
-- | The output format of this metric stream. Valid values are
-- json and opentelemetry0.7.
metricStreamEntry_outputFormat :: Lens' MetricStreamEntry (Maybe MetricStreamOutputFormat)
-- | The current state of this stream. Valid values are running
-- and stopped.
metricStreamEntry_state :: Lens' MetricStreamEntry (Maybe Text)
-- | 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.
data MetricStreamFilter
MetricStreamFilter' :: Maybe Text -> MetricStreamFilter
-- | The name of the metric namespace in the filter.
[$sel:namespace:MetricStreamFilter'] :: MetricStreamFilter -> Maybe Text
-- | 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.
newMetricStreamFilter :: MetricStreamFilter
-- | The name of the metric namespace in the filter.
metricStreamFilter_namespace :: Lens' MetricStreamFilter (Maybe Text)
-- | By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. This structure contains information for
-- one metric that includes additional statistics in the stream. For more
-- information about statistics, see CloudWatch, listed in CloudWatch
-- statistics definitions.
--
-- See: newMetricStreamStatisticsConfiguration smart
-- constructor.
data MetricStreamStatisticsConfiguration
MetricStreamStatisticsConfiguration' :: [MetricStreamStatisticsMetric] -> [Text] -> MetricStreamStatisticsConfiguration
-- | An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
[$sel:includeMetrics:MetricStreamStatisticsConfiguration'] :: MetricStreamStatisticsConfiguration -> [MetricStreamStatisticsMetric]
-- | The list of additional statistics that are to be streamed for the
-- metrics listed in the IncludeMetrics array in this structure.
-- This list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
[$sel:additionalStatistics:MetricStreamStatisticsConfiguration'] :: MetricStreamStatisticsConfiguration -> [Text]
-- | Create a value of MetricStreamStatisticsConfiguration 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:includeMetrics:MetricStreamStatisticsConfiguration',
-- metricStreamStatisticsConfiguration_includeMetrics - An array
-- of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
--
-- $sel:additionalStatistics:MetricStreamStatisticsConfiguration',
-- metricStreamStatisticsConfiguration_additionalStatistics - The
-- list of additional statistics that are to be streamed for the metrics
-- listed in the IncludeMetrics array in this structure. This
-- list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
newMetricStreamStatisticsConfiguration :: MetricStreamStatisticsConfiguration
-- | An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
metricStreamStatisticsConfiguration_includeMetrics :: Lens' MetricStreamStatisticsConfiguration [MetricStreamStatisticsMetric]
-- | The list of additional statistics that are to be streamed for the
-- metrics listed in the IncludeMetrics array in this structure.
-- This list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
metricStreamStatisticsConfiguration_additionalStatistics :: Lens' MetricStreamStatisticsConfiguration [Text]
-- | This object contains the information for one metric that is to be
-- streamed with additional statistics.
--
-- See: newMetricStreamStatisticsMetric smart constructor.
data MetricStreamStatisticsMetric
MetricStreamStatisticsMetric' :: Text -> Text -> MetricStreamStatisticsMetric
-- | The namespace of the metric.
[$sel:namespace:MetricStreamStatisticsMetric'] :: MetricStreamStatisticsMetric -> Text
-- | The name of the metric.
[$sel:metricName:MetricStreamStatisticsMetric'] :: MetricStreamStatisticsMetric -> Text
-- | Create a value of MetricStreamStatisticsMetric 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:MetricStreamStatisticsMetric',
-- metricStreamStatisticsMetric_namespace - The namespace of the
-- metric.
--
-- $sel:metricName:MetricStreamStatisticsMetric',
-- metricStreamStatisticsMetric_metricName - The name of the
-- metric.
newMetricStreamStatisticsMetric :: Text -> Text -> MetricStreamStatisticsMetric
-- | The namespace of the metric.
metricStreamStatisticsMetric_namespace :: Lens' MetricStreamStatisticsMetric Text
-- | The name of the metric.
metricStreamStatisticsMetric_metricName :: Lens' MetricStreamStatisticsMetric Text
-- | 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.
data PartialFailure
PartialFailure' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> PartialFailure
-- | The type of error.
[$sel:exceptionType:PartialFailure'] :: PartialFailure -> Maybe Text
-- | The code of the error.
[$sel:failureCode:PartialFailure'] :: PartialFailure -> Maybe Text
-- | A description of the error.
[$sel:failureDescription:PartialFailure'] :: PartialFailure -> Maybe Text
-- | The specified rule that could not be deleted.
[$sel:failureResource:PartialFailure'] :: PartialFailure -> Maybe Text
-- | 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:exceptionType:PartialFailure',
-- partialFailure_exceptionType - The type of error.
--
-- $sel:failureCode:PartialFailure',
-- partialFailure_failureCode - The code of the error.
--
-- $sel:failureDescription:PartialFailure',
-- partialFailure_failureDescription - A description of the error.
--
-- $sel:failureResource:PartialFailure',
-- partialFailure_failureResource - The specified rule that could
-- not be deleted.
newPartialFailure :: PartialFailure
-- | The type of error.
partialFailure_exceptionType :: Lens' PartialFailure (Maybe Text)
-- | The code of the error.
partialFailure_failureCode :: Lens' PartialFailure (Maybe Text)
-- | A description of the error.
partialFailure_failureDescription :: Lens' PartialFailure (Maybe Text)
-- | The specified rule that could not be deleted.
partialFailure_failureResource :: Lens' PartialFailure (Maybe Text)
-- | Specifies one range of days or times to exclude from use for training
-- an anomaly detection model.
--
-- See: newRange smart constructor.
data Range
Range' :: ISO8601 -> ISO8601 -> Range
-- | 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:startTime:Range'] :: Range -> ISO8601
-- | 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.
[$sel:endTime:Range'] :: Range -> 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.
newRange :: UTCTime -> UTCTime -> Range
-- | The start time of the range to exclude. The format is
-- yyyy-MM-dd'T'HH:mm:ss. For example,
-- 2019-07-01T23:59:59.
range_startTime :: Lens' Range UTCTime
-- | The end time of the range to exclude. The format is
-- yyyy-MM-dd'T'HH:mm:ss. For example,
-- 2019-07-01T23:59:59.
range_endTime :: Lens' Range UTCTime
-- | Designates the CloudWatch metric and statistic that provides the time
-- series the anomaly detector uses as input.
--
-- See: newSingleMetricAnomalyDetector smart constructor.
data SingleMetricAnomalyDetector
SingleMetricAnomalyDetector' :: Maybe [Dimension] -> Maybe Text -> Maybe Text -> Maybe Text -> SingleMetricAnomalyDetector
-- | The metric dimensions to create the anomaly detection model for.
[$sel:dimensions:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe [Dimension]
-- | The name of the metric to create the anomaly detection model for.
[$sel:metricName:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe Text
-- | The namespace of the metric to create the anomaly detection model for.
[$sel:namespace:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe Text
-- | The statistic to use for the metric and anomaly detection model.
[$sel:stat:SingleMetricAnomalyDetector'] :: SingleMetricAnomalyDetector -> Maybe Text
-- | Create a value of SingleMetricAnomalyDetector 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:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_dimensions - The metric dimensions
-- to create the anomaly detection model for.
--
-- $sel:metricName:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_metricName - The name of the metric
-- to create the anomaly detection model for.
--
-- $sel:namespace:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_namespace - The namespace of the
-- metric to create the anomaly detection model for.
--
-- $sel:stat:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_stat - The statistic to use for the
-- metric and anomaly detection model.
newSingleMetricAnomalyDetector :: SingleMetricAnomalyDetector
-- | The metric dimensions to create the anomaly detection model for.
singleMetricAnomalyDetector_dimensions :: Lens' SingleMetricAnomalyDetector (Maybe [Dimension])
-- | The name of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector_metricName :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The namespace of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector_namespace :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The statistic to use for the metric and anomaly detection model.
singleMetricAnomalyDetector_stat :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | Represents a set of statistics that describes a specific metric.
--
-- See: newStatisticSet smart constructor.
data StatisticSet
StatisticSet' :: Double -> Double -> Double -> Double -> StatisticSet
-- | The number of samples used for the statistic set.
[$sel:sampleCount:StatisticSet'] :: StatisticSet -> Double
-- | The sum of values for the sample set.
[$sel:sum:StatisticSet'] :: StatisticSet -> Double
-- | The minimum value of the sample set.
[$sel:minimum:StatisticSet'] :: StatisticSet -> Double
-- | The maximum value of the sample set.
[$sel:maximum:StatisticSet'] :: StatisticSet -> Double
-- | 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.
newStatisticSet :: Double -> Double -> Double -> Double -> StatisticSet
-- | The number of samples used for the statistic set.
statisticSet_sampleCount :: Lens' StatisticSet Double
-- | The sum of values for the sample set.
statisticSet_sum :: Lens' StatisticSet Double
-- | The minimum value of the sample set.
statisticSet_minimum :: Lens' StatisticSet Double
-- | The maximum value of the sample set.
statisticSet_maximum :: Lens' StatisticSet Double
-- | A key-value pair associated with a CloudWatch resource.
--
-- See: newTag smart constructor.
data Tag
Tag' :: Text -> Text -> Tag
-- | 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:key:Tag'] :: Tag -> Text
-- | The value for the specified tag key.
[$sel:value:Tag'] :: Tag -> 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.
newTag :: Text -> Text -> Tag
-- | 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.
tag_key :: Lens' Tag Text
-- | The value for the specified tag key.
tag_value :: Lens' Tag Text
-- | Assigns one or more tags (key-value pairs) to the specified CloudWatch
-- resource. Currently, the only CloudWatch resources that can be tagged
-- are alarms and Contributor Insights rules.
--
-- Tags can help you organize and categorize your resources. You can also
-- use them to scope user permissions by granting a user permission to
-- access or change only resources with certain tag values.
--
-- Tags don't have any semantic meaning to Amazon Web Services and are
-- interpreted strictly as strings of characters.
--
-- You can use the TagResource action with an alarm that already
-- has tags. If you specify a new tag key for the alarm, this tag is
-- appended to the list of tags associated with the alarm. If you specify
-- a tag key that is already associated with the alarm, the new tag value
-- that you specify replaces the previous value for that tag.
--
-- You can associate as many as 50 tags with a CloudWatch resource.
module Amazonka.CloudWatch.TagResource
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> [Tag] -> TagResource
-- | 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:resourceARN:TagResource'] :: TagResource -> Text
-- | The list of key-value pairs to associate with the alarm.
[$sel:tags:TagResource'] :: TagResource -> [Tag]
-- | 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:
--
-- 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.
--
-- TagResource, tagResource_tags - The list of key-value
-- pairs to associate with the alarm.
newTagResource :: Text -> TagResource
-- | 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.
tagResource_resourceARN :: Lens' TagResource Text
-- | The list of key-value pairs to associate with the alarm.
tagResource_tags :: Lens' TagResource [Tag]
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:TagResourceResponse'] :: TagResourceResponse -> Int
-- | 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.
newTagResourceResponse :: Int -> TagResourceResponse
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.TagResource.TagResource
instance GHC.Show.Show Amazonka.CloudWatch.TagResource.TagResource
instance GHC.Read.Read Amazonka.CloudWatch.TagResource.TagResource
instance GHC.Classes.Eq Amazonka.CloudWatch.TagResource.TagResource
instance GHC.Generics.Generic Amazonka.CloudWatch.TagResource.TagResourceResponse
instance GHC.Show.Show Amazonka.CloudWatch.TagResource.TagResourceResponse
instance GHC.Read.Read Amazonka.CloudWatch.TagResource.TagResourceResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.TagResource.TagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.CloudWatch.TagResource.TagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.CloudWatch.TagResource.TagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.TagResource.TagResource
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.TagResource.TagResource
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.TagResource.TagResource
-- | Stops the streaming of metrics for one or more of your metric streams.
module Amazonka.CloudWatch.StopMetricStreams
-- | See: newStopMetricStreams smart constructor.
data StopMetricStreams
StopMetricStreams' :: [Text] -> StopMetricStreams
-- | 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.
[$sel:names:StopMetricStreams'] :: StopMetricStreams -> [Text]
-- | 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.
newStopMetricStreams :: StopMetricStreams
-- | 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.
stopMetricStreams_names :: Lens' StopMetricStreams [Text]
-- | See: newStopMetricStreamsResponse smart constructor.
data StopMetricStreamsResponse
StopMetricStreamsResponse' :: Int -> StopMetricStreamsResponse
-- | The response's http status code.
[$sel:httpStatus:StopMetricStreamsResponse'] :: StopMetricStreamsResponse -> Int
-- | 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.
newStopMetricStreamsResponse :: Int -> StopMetricStreamsResponse
-- | The response's http status code.
stopMetricStreamsResponse_httpStatus :: Lens' StopMetricStreamsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance GHC.Show.Show Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance GHC.Read.Read Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance GHC.Classes.Eq Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance GHC.Generics.Generic Amazonka.CloudWatch.StopMetricStreams.StopMetricStreamsResponse
instance GHC.Show.Show Amazonka.CloudWatch.StopMetricStreams.StopMetricStreamsResponse
instance GHC.Read.Read Amazonka.CloudWatch.StopMetricStreams.StopMetricStreamsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.StopMetricStreams.StopMetricStreamsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance Control.DeepSeq.NFData Amazonka.CloudWatch.StopMetricStreams.StopMetricStreamsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance Control.DeepSeq.NFData Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.StopMetricStreams.StopMetricStreams
-- | Starts the streaming of metrics for one or more of your metric
-- streams.
module Amazonka.CloudWatch.StartMetricStreams
-- | See: newStartMetricStreams smart constructor.
data StartMetricStreams
StartMetricStreams' :: [Text] -> StartMetricStreams
-- | 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.
[$sel:names:StartMetricStreams'] :: StartMetricStreams -> [Text]
-- | 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.
newStartMetricStreams :: StartMetricStreams
-- | 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.
startMetricStreams_names :: Lens' StartMetricStreams [Text]
-- | See: newStartMetricStreamsResponse smart constructor.
data StartMetricStreamsResponse
StartMetricStreamsResponse' :: Int -> StartMetricStreamsResponse
-- | The response's http status code.
[$sel:httpStatus:StartMetricStreamsResponse'] :: StartMetricStreamsResponse -> Int
-- | 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.
newStartMetricStreamsResponse :: Int -> StartMetricStreamsResponse
-- | The response's http status code.
startMetricStreamsResponse_httpStatus :: Lens' StartMetricStreamsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance GHC.Show.Show Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance GHC.Read.Read Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance GHC.Classes.Eq Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance GHC.Generics.Generic Amazonka.CloudWatch.StartMetricStreams.StartMetricStreamsResponse
instance GHC.Show.Show Amazonka.CloudWatch.StartMetricStreams.StartMetricStreamsResponse
instance GHC.Read.Read Amazonka.CloudWatch.StartMetricStreams.StartMetricStreamsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.StartMetricStreams.StartMetricStreamsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance Control.DeepSeq.NFData Amazonka.CloudWatch.StartMetricStreams.StartMetricStreamsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance Control.DeepSeq.NFData Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.StartMetricStreams.StartMetricStreams
-- | Temporarily sets the state of an alarm for testing purposes. When the
-- updated state differs from the previous value, the action configured
-- for the appropriate state is invoked. For example, if your alarm is
-- configured to send an Amazon SNS message when an alarm is triggered,
-- temporarily changing the alarm state to ALARM sends an SNS
-- message.
--
-- Metric alarms returns to their actual state quickly, often within
-- seconds. Because the metric alarm state change happens quickly, it is
-- typically only visible in the alarm's History tab in the Amazon
-- CloudWatch console or through DescribeAlarmHistory.
--
-- If you use SetAlarmState on a composite alarm, the composite
-- alarm is not guaranteed to return to its actual state. It returns to
-- its actual state only once any of its children alarms change state. It
-- is also reevaluated if you update its configuration.
--
-- If an alarm triggers EC2 Auto Scaling policies or application Auto
-- Scaling policies, you must include information in the
-- StateReasonData parameter to enable the policy to take the
-- correct action.
module Amazonka.CloudWatch.SetAlarmState
-- | See: newSetAlarmState smart constructor.
data SetAlarmState
SetAlarmState' :: Maybe Text -> Text -> StateValue -> Text -> SetAlarmState
-- | 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:stateReasonData:SetAlarmState'] :: SetAlarmState -> Maybe Text
-- | The name of the alarm.
[$sel:alarmName:SetAlarmState'] :: SetAlarmState -> Text
-- | The value of the state.
[$sel:stateValue:SetAlarmState'] :: SetAlarmState -> StateValue
-- | The reason that this alarm is set to this specific state, in text
-- format.
[$sel:stateReason:SetAlarmState'] :: SetAlarmState -> Text
-- | 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:
--
-- 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.
--
-- SetAlarmState, setAlarmState_alarmName - The name of the
-- alarm.
--
-- SetAlarmState, setAlarmState_stateValue - The value of
-- the state.
--
-- SetAlarmState, setAlarmState_stateReason - The reason
-- that this alarm is set to this specific state, in text format.
newSetAlarmState :: Text -> StateValue -> Text -> SetAlarmState
-- | 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.
setAlarmState_stateReasonData :: Lens' SetAlarmState (Maybe Text)
-- | The name of the alarm.
setAlarmState_alarmName :: Lens' SetAlarmState Text
-- | The value of the state.
setAlarmState_stateValue :: Lens' SetAlarmState StateValue
-- | The reason that this alarm is set to this specific state, in text
-- format.
setAlarmState_stateReason :: Lens' SetAlarmState Text
-- | See: newSetAlarmStateResponse smart constructor.
data SetAlarmStateResponse
SetAlarmStateResponse' :: SetAlarmStateResponse
-- | Create a value of SetAlarmStateResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newSetAlarmStateResponse :: SetAlarmStateResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance GHC.Show.Show Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance GHC.Read.Read Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance GHC.Classes.Eq Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance GHC.Generics.Generic Amazonka.CloudWatch.SetAlarmState.SetAlarmStateResponse
instance GHC.Show.Show Amazonka.CloudWatch.SetAlarmState.SetAlarmStateResponse
instance GHC.Read.Read Amazonka.CloudWatch.SetAlarmState.SetAlarmStateResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.SetAlarmState.SetAlarmStateResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance Control.DeepSeq.NFData Amazonka.CloudWatch.SetAlarmState.SetAlarmStateResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance Control.DeepSeq.NFData Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.SetAlarmState.SetAlarmState
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.SetAlarmState.SetAlarmState
-- | Creates or updates a metric stream. Metric streams can automatically
-- stream CloudWatch metrics to Amazon Web Services destinations,
-- including Amazon S3, and to many third-party solutions.
--
-- For more information, see Using Metric Streams.
--
-- To create a metric stream, you must be signed in to an account that
-- has the iam:PassRole permission and either the
-- CloudWatchFullAccess policy or the
-- cloudwatch:PutMetricStream permission.
--
-- When you create or update a metric stream, you choose one of the
-- following:
--
--
-- - Stream metrics from all metric namespaces in the account.
-- - Stream metrics from all metric namespaces in the account, except
-- for the namespaces that you list in ExcludeFilters.
-- - Stream metrics from only the metric namespaces that you list in
-- IncludeFilters.
--
--
-- By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. You can use the
-- StatisticsConfigurations parameter to have the metric stream
-- send additional statistics in the stream. Streaming additional
-- statistics incurs additional costs. For more information, see
-- Amazon CloudWatch Pricing.
--
-- When you use PutMetricStream to create a new metric stream,
-- the stream is created in the running state. If you use it to
-- update an existing stream, the state of the stream is not changed.
module Amazonka.CloudWatch.PutMetricStream
-- | See: newPutMetricStream smart constructor.
data PutMetricStream
PutMetricStream' :: Maybe [MetricStreamFilter] -> Maybe [MetricStreamFilter] -> Maybe [MetricStreamStatisticsConfiguration] -> Maybe [Tag] -> Text -> Text -> Text -> MetricStreamOutputFormat -> PutMetricStream
-- | 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:excludeFilters:PutMetricStream'] :: PutMetricStream -> Maybe [MetricStreamFilter]
-- | 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:includeFilters:PutMetricStream'] :: PutMetricStream -> Maybe [MetricStreamFilter]
-- | By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. You can use this parameter to have the
-- metric stream also send additional statistics in the stream. This
-- array can have up to 100 members.
--
-- For each entry in this array, you specify one or more metrics and the
-- list of additional statistics to stream for those metrics. The
-- additional statistics that you can stream depend on the stream's
-- OutputFormat. If the OutputFormat is json,
-- you can stream any additional statistic that is supported by
-- CloudWatch, listed in CloudWatch statistics definitions. If the
-- OutputFormat is opentelemetry0.7, you can stream
-- percentile statistics such as p95, p99.9, and so on.
[$sel:statisticsConfigurations:PutMetricStream'] :: PutMetricStream -> Maybe [MetricStreamStatisticsConfiguration]
-- | 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:tags:PutMetricStream'] :: PutMetricStream -> Maybe [Tag]
-- | 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:name:PutMetricStream'] :: PutMetricStream -> Text
-- | The ARN of the Amazon Kinesis Data Firehose delivery stream to use for
-- this metric stream. This Amazon Kinesis Data Firehose delivery stream
-- must already exist and must be in the same account as the metric
-- stream.
[$sel:firehoseArn:PutMetricStream'] :: PutMetricStream -> Text
-- | The ARN of an IAM role that this metric stream will use to access
-- Amazon Kinesis Data Firehose resources. This IAM role must already
-- exist and must be in the same account as the metric stream. This IAM
-- role must include the following permissions:
--
--
-- - firehose:PutRecord
-- - firehose:PutRecordBatch
--
[$sel:roleArn:PutMetricStream'] :: PutMetricStream -> Text
-- | 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.
[$sel:outputFormat:PutMetricStream'] :: PutMetricStream -> MetricStreamOutputFormat
-- | 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: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: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:statisticsConfigurations:PutMetricStream',
-- putMetricStream_statisticsConfigurations - By default, a metric
-- stream always sends the MAX, MIN, SUM, and
-- SAMPLECOUNT statistics for each metric that is streamed. You
-- can use this parameter to have the metric stream also send additional
-- statistics in the stream. This array can have up to 100 members.
--
-- For each entry in this array, you specify one or more metrics and the
-- list of additional statistics to stream for those metrics. The
-- additional statistics that you can stream depend on the stream's
-- OutputFormat. If the OutputFormat is json,
-- you can stream any additional statistic that is supported by
-- CloudWatch, listed in CloudWatch statistics definitions. If the
-- OutputFormat is opentelemetry0.7, you can stream
-- percentile statistics such as p95, p99.9, and so on.
--
-- 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.
--
-- 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 "_".
--
-- PutMetricStream, putMetricStream_firehoseArn - The ARN
-- of the Amazon Kinesis Data Firehose delivery stream to use for this
-- metric stream. This Amazon Kinesis Data Firehose delivery stream must
-- already exist and must be in the same account as the metric stream.
--
-- $sel:roleArn:PutMetricStream', putMetricStream_roleArn -
-- The ARN of an IAM role that this metric stream will use to access
-- Amazon Kinesis Data Firehose resources. This IAM role must already
-- exist and must be in the same account as the metric stream. This IAM
-- role must include the following permissions:
--
--
-- - firehose:PutRecord
-- - firehose:PutRecordBatch
--
--
-- 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.
newPutMetricStream :: Text -> Text -> Text -> MetricStreamOutputFormat -> PutMetricStream
-- | 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.
putMetricStream_excludeFilters :: Lens' PutMetricStream (Maybe [MetricStreamFilter])
-- | 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.
putMetricStream_includeFilters :: Lens' PutMetricStream (Maybe [MetricStreamFilter])
-- | By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. You can use this parameter to have the
-- metric stream also send additional statistics in the stream. This
-- array can have up to 100 members.
--
-- For each entry in this array, you specify one or more metrics and the
-- list of additional statistics to stream for those metrics. The
-- additional statistics that you can stream depend on the stream's
-- OutputFormat. If the OutputFormat is json,
-- you can stream any additional statistic that is supported by
-- CloudWatch, listed in CloudWatch statistics definitions. If the
-- OutputFormat is opentelemetry0.7, you can stream
-- percentile statistics such as p95, p99.9, and so on.
putMetricStream_statisticsConfigurations :: Lens' PutMetricStream (Maybe [MetricStreamStatisticsConfiguration])
-- | 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.
putMetricStream_tags :: Lens' PutMetricStream (Maybe [Tag])
-- | 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 "_".
putMetricStream_name :: Lens' PutMetricStream Text
-- | The ARN of the Amazon Kinesis Data Firehose delivery stream to use for
-- this metric stream. This Amazon Kinesis Data Firehose delivery stream
-- must already exist and must be in the same account as the metric
-- stream.
putMetricStream_firehoseArn :: Lens' PutMetricStream Text
-- | The ARN of an IAM role that this metric stream will use to access
-- Amazon Kinesis Data Firehose resources. This IAM role must already
-- exist and must be in the same account as the metric stream. This IAM
-- role must include the following permissions:
--
--
-- - firehose:PutRecord
-- - firehose:PutRecordBatch
--
putMetricStream_roleArn :: Lens' PutMetricStream Text
-- | 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.
putMetricStream_outputFormat :: Lens' PutMetricStream MetricStreamOutputFormat
-- | See: newPutMetricStreamResponse smart constructor.
data PutMetricStreamResponse
PutMetricStreamResponse' :: Maybe Text -> Int -> PutMetricStreamResponse
-- | The ARN of the metric stream.
[$sel:arn:PutMetricStreamResponse'] :: PutMetricStreamResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:PutMetricStreamResponse'] :: PutMetricStreamResponse -> Int
-- | 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:
--
-- PutMetricStreamResponse, putMetricStreamResponse_arn -
-- The ARN of the metric stream.
--
-- $sel:httpStatus:PutMetricStreamResponse',
-- putMetricStreamResponse_httpStatus - The response's http status
-- code.
newPutMetricStreamResponse :: Int -> PutMetricStreamResponse
-- | The ARN of the metric stream.
putMetricStreamResponse_arn :: Lens' PutMetricStreamResponse (Maybe Text)
-- | The response's http status code.
putMetricStreamResponse_httpStatus :: Lens' PutMetricStreamResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance GHC.Show.Show Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance GHC.Read.Read Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance GHC.Classes.Eq Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance GHC.Generics.Generic Amazonka.CloudWatch.PutMetricStream.PutMetricStreamResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutMetricStream.PutMetricStreamResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutMetricStream.PutMetricStreamResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutMetricStream.PutMetricStreamResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutMetricStream.PutMetricStreamResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutMetricStream.PutMetricStream
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutMetricStream.PutMetricStream
-- | Publishes metric data points to Amazon CloudWatch. CloudWatch
-- associates the data points with the specified metric. If the specified
-- metric does not exist, CloudWatch creates the metric. When CloudWatch
-- creates a metric, it can take up to fifteen minutes for the metric to
-- appear in calls to ListMetrics.
--
-- You can publish either individual data points in the Value
-- field, or arrays of values and the number of times each value occurred
-- during the period by using the Values and Counts
-- fields in the MetricDatum structure. Using the
-- Values and Counts method enables you to publish up
-- to 150 values per metric with one PutMetricData request, and
-- supports retrieving percentile statistics on this data.
--
-- Each PutMetricData request is limited to 1 MB in size for
-- HTTP POST requests. You can send a payload compressed by gzip. Each
-- request is also limited to no more than 1000 different metrics.
--
-- Although the Value parameter accepts numbers of type
-- Double, CloudWatch rejects values that are either too small
-- or too large. Values must be in the range of -2^360 to 2^360. In
-- addition, special values (for example, NaN, +Infinity, -Infinity) are
-- not supported.
--
-- You can use up to 30 dimensions per metric to further clarify what
-- data the metric collects. Each dimension consists of a Name and Value
-- pair. For more information about specifying dimensions, see
-- Publishing Metrics in the Amazon CloudWatch User Guide.
--
-- You specify the time stamp to be associated with each data point. You
-- can specify time stamps that are as much as two weeks before the
-- current date, and as much as 2 hours after the current day and time.
--
-- Data points with time stamps from 24 hours ago or longer can take at
-- least 48 hours to become available for GetMetricData or
-- GetMetricStatistics from the time they are submitted. Data
-- points with time stamps between 3 and 24 hours ago can take as much as
-- 2 hours to become available for for GetMetricData or
-- GetMetricStatistics.
--
-- CloudWatch needs raw data points to calculate percentile statistics.
-- If you publish data using a statistic set instead, you can only
-- retrieve percentile statistics for this data if one of the following
-- conditions is true:
--
--
-- - The SampleCount value of the statistic set is 1 and
-- Min, Max, and Sum are all equal.
-- - The Min and Max are equal, and Sum is
-- equal to Min multiplied by SampleCount.
--
module Amazonka.CloudWatch.PutMetricData
-- | See: newPutMetricData smart constructor.
data PutMetricData
PutMetricData' :: Text -> [MetricDatum] -> PutMetricData
-- | 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:namespace:PutMetricData'] :: PutMetricData -> Text
-- | The data for the metric. The array can include no more than 1000
-- metrics per call.
[$sel:metricData:PutMetricData'] :: PutMetricData -> [MetricDatum]
-- | 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:
--
-- 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 1000
-- metrics per call.
newPutMetricData :: Text -> PutMetricData
-- | 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/
putMetricData_namespace :: Lens' PutMetricData Text
-- | The data for the metric. The array can include no more than 1000
-- metrics per call.
putMetricData_metricData :: Lens' PutMetricData [MetricDatum]
-- | See: newPutMetricDataResponse smart constructor.
data PutMetricDataResponse
PutMetricDataResponse' :: PutMetricDataResponse
-- | Create a value of PutMetricDataResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newPutMetricDataResponse :: PutMetricDataResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.PutMetricData.PutMetricData
instance GHC.Show.Show Amazonka.CloudWatch.PutMetricData.PutMetricData
instance GHC.Read.Read Amazonka.CloudWatch.PutMetricData.PutMetricData
instance GHC.Classes.Eq Amazonka.CloudWatch.PutMetricData.PutMetricData
instance GHC.Generics.Generic Amazonka.CloudWatch.PutMetricData.PutMetricDataResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutMetricData.PutMetricDataResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutMetricData.PutMetricDataResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutMetricData.PutMetricDataResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutMetricData.PutMetricData
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutMetricData.PutMetricDataResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutMetricData.PutMetricData
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutMetricData.PutMetricData
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutMetricData.PutMetricData
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutMetricData.PutMetricData
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutMetricData.PutMetricData
-- | Creates or updates an alarm and associates it with the specified
-- metric, metric math expression, anomaly detection model, or Metrics
-- Insights query. For more information about using a Metrics Insights
-- query for an alarm, see Create alarms on Metrics Insights
-- queries.
--
-- Alarms based on anomaly detection models cannot have Auto Scaling
-- actions.
--
-- When this operation creates an alarm, the alarm state is immediately
-- set to INSUFFICIENT_DATA. The alarm is then evaluated and its
-- state is set appropriately. Any actions associated with the new state
-- are then executed.
--
-- When you update an existing alarm, its state is left unchanged, but
-- the update completely overwrites the previous configuration of the
-- alarm.
--
-- If you are an IAM user, you must have Amazon EC2 permissions for some
-- alarm operations:
--
--
-- - The iam:CreateServiceLinkedRole for all alarms with EC2
-- actions
-- - The iam:CreateServiceLinkedRole to create an alarm with
-- Systems Manager OpsItem actions.
--
--
-- The first time you create an alarm in the Amazon Web Services
-- Management Console, the CLI, or by using the PutMetricAlarm API,
-- CloudWatch creates the necessary service-linked role for you. The
-- service-linked roles are called
-- AWSServiceRoleForCloudWatchEvents and
-- AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more
-- information, see Amazon Web Services service-linked role.
--
-- Cross-account alarms
--
-- You can set an alarm on metrics in the current account, or in another
-- account. To create a cross-account alarm that watches a metric in a
-- different account, you must have completed the following
-- pre-requisites:
--
--
-- - The account where the metrics are located (the sharing
-- account) must already have a sharing role named
-- CloudWatch-CrossAccountSharingRole. If it does not already have
-- this role, you must create it using the instructions in __Set up a
-- sharing account__ in Cross-account cross-Region CloudWatch
-- console. The policy for that role must grant access to the ID of
-- the account where you are creating the alarm.
-- - The account where you are creating the alarm (the /monitoring
-- account/) must already have a service-linked role named
-- AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to
-- assume the sharing role in the sharing account. If it does not, you
-- must create it following the directions in __Set up a monitoring
-- account__ in Cross-account cross-Region CloudWatch
-- console.
--
module Amazonka.CloudWatch.PutMetricAlarm
-- | See: newPutMetricAlarm smart constructor.
data PutMetricAlarm
PutMetricAlarm' :: Maybe Bool -> Maybe [Text] -> Maybe Text -> Maybe Natural -> Maybe [Dimension] -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe [MetricDataQuery] -> Maybe Text -> Maybe [Text] -> Maybe Natural -> Maybe Statistic -> Maybe [Tag] -> Maybe Double -> Maybe Text -> Maybe Text -> Maybe StandardUnit -> Text -> Natural -> ComparisonOperator -> PutMetricAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state. The default is TRUE.
[$sel:actionsEnabled:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Bool
-- | 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:alarmActions:PutMetricAlarm'] :: PutMetricAlarm -> Maybe [Text]
-- | The description for the alarm.
[$sel:alarmDescription:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | 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:datapointsToAlarm:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Natural
-- | The dimensions for the metric specified in MetricName.
[$sel:dimensions:PutMetricAlarm'] :: PutMetricAlarm -> Maybe [Dimension]
-- | 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:evaluateLowSampleCountPercentile:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | 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:extendedStatistic:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | 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:insufficientDataActions:PutMetricAlarm'] :: PutMetricAlarm -> Maybe [Text]
-- | 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:metricName:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | 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:metrics:PutMetricAlarm'] :: PutMetricAlarm -> Maybe [MetricDataQuery]
-- | The namespace for the metric associated specified in
-- MetricName.
[$sel:namespace:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | 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:oKActions:PutMetricAlarm'] :: PutMetricAlarm -> Maybe [Text]
-- | 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:period:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Natural
-- | 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:statistic:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Statistic
-- | 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:tags:PutMetricAlarm'] :: PutMetricAlarm -> Maybe [Tag]
-- | 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:threshold:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Double
-- | 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:thresholdMetricId:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | Sets how this alarm is to handle missing data points. If
-- TreatMissingData is omitted, the default behavior of
-- missing is used. For more information, see Configuring How
-- CloudWatch Alarms Treats Missing Data.
--
-- Valid Values: breaching | notBreaching | ignore | missing
--
-- Alarms that evaluate metrics in the AWS/DynamoDB namespace
-- always ignore missing data even if you choose a different
-- option for TreatMissingData. When an AWS/DynamoDB
-- metric has missing data, alarms that evaluate that metric remain in
-- their current state.
[$sel:treatMissingData:PutMetricAlarm'] :: PutMetricAlarm -> Maybe Text
-- | 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 unpredictably.
--
-- We recommend omitting Unit so that you don't inadvertently
-- specify an incorrect unit that is not published for this metric. Doing
-- so causes the alarm to be stuck in the INSUFFICIENT DATA
-- state.
[$sel:unit:PutMetricAlarm'] :: PutMetricAlarm -> Maybe StandardUnit
-- | The name for the alarm. This name must be unique within the Region.
[$sel:alarmName:PutMetricAlarm'] :: PutMetricAlarm -> Text
-- | 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:evaluationPeriods:PutMetricAlarm'] :: PutMetricAlarm -> Natural
-- | 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.
[$sel:comparisonOperator:PutMetricAlarm'] :: PutMetricAlarm -> ComparisonOperator
-- | 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:
--
-- PutMetricAlarm, putMetricAlarm_actionsEnabled -
-- Indicates whether actions should be executed during any changes to the
-- alarm state. The default is TRUE.
--
-- 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
--
-- PutMetricAlarm, putMetricAlarm_alarmDescription - The
-- description for the alarm.
--
-- 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.
--
-- PutMetricAlarm, putMetricAlarm_dimensions - The
-- dimensions for the metric specified in MetricName.
--
-- 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
--
-- 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.
--
-- 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
--
-- 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.
--
-- 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.
--
-- PutMetricAlarm, putMetricAlarm_namespace - The namespace
-- for the metric associated specified in MetricName.
--
-- 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
--
-- 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.
--
-- 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.
--
-- 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.
--
-- 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.
--
-- 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.
--
-- 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
--
-- Alarms that evaluate metrics in the AWS/DynamoDB namespace
-- always ignore missing data even if you choose a different
-- option for TreatMissingData. When an AWS/DynamoDB
-- metric has missing data, alarms that evaluate that metric remain in
-- their current state.
--
-- 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 unpredictably.
--
-- We recommend omitting Unit so that you don't inadvertently
-- specify an incorrect unit that is not published for this metric. Doing
-- so causes the alarm to be stuck in the INSUFFICIENT DATA
-- state.
--
-- PutMetricAlarm, putMetricAlarm_alarmName - The name for
-- the alarm. This name must be unique within the Region.
--
-- 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.
--
-- 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.
newPutMetricAlarm :: Text -> Natural -> ComparisonOperator -> PutMetricAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state. The default is TRUE.
putMetricAlarm_actionsEnabled :: Lens' PutMetricAlarm (Maybe Bool)
-- | 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
putMetricAlarm_alarmActions :: Lens' PutMetricAlarm (Maybe [Text])
-- | The description for the alarm.
putMetricAlarm_alarmDescription :: Lens' PutMetricAlarm (Maybe Text)
-- | 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.
putMetricAlarm_datapointsToAlarm :: Lens' PutMetricAlarm (Maybe Natural)
-- | The dimensions for the metric specified in MetricName.
putMetricAlarm_dimensions :: Lens' PutMetricAlarm (Maybe [Dimension])
-- | 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
putMetricAlarm_evaluateLowSampleCountPercentile :: Lens' PutMetricAlarm (Maybe Text)
-- | 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.
putMetricAlarm_extendedStatistic :: Lens' PutMetricAlarm (Maybe Text)
-- | 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
putMetricAlarm_insufficientDataActions :: Lens' PutMetricAlarm (Maybe [Text])
-- | 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.
putMetricAlarm_metricName :: Lens' PutMetricAlarm (Maybe Text)
-- | 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.
putMetricAlarm_metrics :: Lens' PutMetricAlarm (Maybe [MetricDataQuery])
-- | The namespace for the metric associated specified in
-- MetricName.
putMetricAlarm_namespace :: Lens' PutMetricAlarm (Maybe Text)
-- | 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
putMetricAlarm_oKActions :: Lens' PutMetricAlarm (Maybe [Text])
-- | 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.
putMetricAlarm_period :: Lens' PutMetricAlarm (Maybe Natural)
-- | 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.
putMetricAlarm_statistic :: Lens' PutMetricAlarm (Maybe Statistic)
-- | 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.
putMetricAlarm_tags :: Lens' PutMetricAlarm (Maybe [Tag])
-- | 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.
putMetricAlarm_threshold :: Lens' PutMetricAlarm (Maybe Double)
-- | 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.
putMetricAlarm_thresholdMetricId :: Lens' PutMetricAlarm (Maybe Text)
-- | Sets how this alarm is to handle missing data points. If
-- TreatMissingData is omitted, the default behavior of
-- missing is used. For more information, see Configuring How
-- CloudWatch Alarms Treats Missing Data.
--
-- Valid Values: breaching | notBreaching | ignore | missing
--
-- Alarms that evaluate metrics in the AWS/DynamoDB namespace
-- always ignore missing data even if you choose a different
-- option for TreatMissingData. When an AWS/DynamoDB
-- metric has missing data, alarms that evaluate that metric remain in
-- their current state.
putMetricAlarm_treatMissingData :: Lens' PutMetricAlarm (Maybe Text)
-- | 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 unpredictably.
--
-- We recommend omitting Unit so that you don't inadvertently
-- specify an incorrect unit that is not published for this metric. Doing
-- so causes the alarm to be stuck in the INSUFFICIENT DATA
-- state.
putMetricAlarm_unit :: Lens' PutMetricAlarm (Maybe StandardUnit)
-- | The name for the alarm. This name must be unique within the Region.
putMetricAlarm_alarmName :: Lens' PutMetricAlarm Text
-- | 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.
putMetricAlarm_evaluationPeriods :: Lens' PutMetricAlarm Natural
-- | 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.
putMetricAlarm_comparisonOperator :: Lens' PutMetricAlarm ComparisonOperator
-- | See: newPutMetricAlarmResponse smart constructor.
data PutMetricAlarmResponse
PutMetricAlarmResponse' :: PutMetricAlarmResponse
-- | Create a value of PutMetricAlarmResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newPutMetricAlarmResponse :: PutMetricAlarmResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance GHC.Show.Show Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance GHC.Read.Read Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance GHC.Classes.Eq Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance GHC.Generics.Generic Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarmResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarmResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarmResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarmResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarmResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutMetricAlarm.PutMetricAlarm
-- | Creates a managed Contributor Insights rule for a specified Amazon Web
-- Services resource. When you enable a managed rule, you create a
-- Contributor Insights rule that collects data from Amazon Web Services
-- services. You cannot edit these rules with PutInsightRule.
-- The rules can be enabled, disabled, and deleted using
-- EnableInsightRules, DisableInsightRules, and
-- DeleteInsightRules. If a previously created managed rule is
-- currently disabled, a subsequent call to this API will re-enable it.
-- Use ListManagedInsightRules to describe all available rules.
module Amazonka.CloudWatch.PutManagedInsightRules
-- | See: newPutManagedInsightRules smart constructor.
data PutManagedInsightRules
PutManagedInsightRules' :: [ManagedRule] -> PutManagedInsightRules
-- | A list of ManagedRules to enable.
[$sel:managedRules:PutManagedInsightRules'] :: PutManagedInsightRules -> [ManagedRule]
-- | Create a value of PutManagedInsightRules 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:managedRules:PutManagedInsightRules',
-- putManagedInsightRules_managedRules - A list of
-- ManagedRules to enable.
newPutManagedInsightRules :: PutManagedInsightRules
-- | A list of ManagedRules to enable.
putManagedInsightRules_managedRules :: Lens' PutManagedInsightRules [ManagedRule]
-- | See: newPutManagedInsightRulesResponse smart
-- constructor.
data PutManagedInsightRulesResponse
PutManagedInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> PutManagedInsightRulesResponse
-- | An array that lists the rules that could not be enabled.
[$sel:failures:PutManagedInsightRulesResponse'] :: PutManagedInsightRulesResponse -> Maybe [PartialFailure]
-- | The response's http status code.
[$sel:httpStatus:PutManagedInsightRulesResponse'] :: PutManagedInsightRulesResponse -> Int
-- | Create a value of PutManagedInsightRulesResponse 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:PutManagedInsightRulesResponse',
-- putManagedInsightRulesResponse_failures - An array that lists
-- the rules that could not be enabled.
--
-- $sel:httpStatus:PutManagedInsightRulesResponse',
-- putManagedInsightRulesResponse_httpStatus - The response's http
-- status code.
newPutManagedInsightRulesResponse :: Int -> PutManagedInsightRulesResponse
-- | An array that lists the rules that could not be enabled.
putManagedInsightRulesResponse_failures :: Lens' PutManagedInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
putManagedInsightRulesResponse_httpStatus :: Lens' PutManagedInsightRulesResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance GHC.Show.Show Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance GHC.Read.Read Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance GHC.Classes.Eq Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance GHC.Generics.Generic Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRulesResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRulesResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRulesResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRulesResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRulesResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutManagedInsightRules.PutManagedInsightRules
-- | Creates a Contributor Insights rule. Rules evaluate log events in a
-- CloudWatch Logs log group, enabling you to find contributor data for
-- the log events in that log group. For more information, see Using
-- Contributor Insights to Analyze High-Cardinality Data.
--
-- If you create a rule, delete it, and then re-create it with the same
-- name, historical data from the first time the rule was created might
-- not be available.
module Amazonka.CloudWatch.PutInsightRule
-- | See: newPutInsightRule smart constructor.
data PutInsightRule
PutInsightRule' :: Maybe Text -> Maybe [Tag] -> Text -> Text -> PutInsightRule
-- | The state of the rule. Valid values are ENABLED and DISABLED.
[$sel:ruleState:PutInsightRule'] :: PutInsightRule -> Maybe Text
-- | 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:tags:PutInsightRule'] :: PutInsightRule -> Maybe [Tag]
-- | A unique name for the rule.
[$sel:ruleName:PutInsightRule'] :: PutInsightRule -> Text
-- | The definition of the rule, as a JSON object. For details on the valid
-- syntax, see Contributor Insights Rule Syntax.
[$sel:ruleDefinition:PutInsightRule'] :: PutInsightRule -> Text
-- | 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:
--
-- PutInsightRule, putInsightRule_ruleState - The state of
-- the rule. Valid values are ENABLED and DISABLED.
--
-- 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.
--
-- 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.
newPutInsightRule :: Text -> Text -> PutInsightRule
-- | The state of the rule. Valid values are ENABLED and DISABLED.
putInsightRule_ruleState :: Lens' PutInsightRule (Maybe Text)
-- | 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.
putInsightRule_tags :: Lens' PutInsightRule (Maybe [Tag])
-- | A unique name for the rule.
putInsightRule_ruleName :: Lens' PutInsightRule Text
-- | The definition of the rule, as a JSON object. For details on the valid
-- syntax, see Contributor Insights Rule Syntax.
putInsightRule_ruleDefinition :: Lens' PutInsightRule Text
-- | See: newPutInsightRuleResponse smart constructor.
data PutInsightRuleResponse
PutInsightRuleResponse' :: Int -> PutInsightRuleResponse
-- | The response's http status code.
[$sel:httpStatus:PutInsightRuleResponse'] :: PutInsightRuleResponse -> Int
-- | 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.
newPutInsightRuleResponse :: Int -> PutInsightRuleResponse
-- | The response's http status code.
putInsightRuleResponse_httpStatus :: Lens' PutInsightRuleResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance GHC.Show.Show Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance GHC.Read.Read Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance GHC.Classes.Eq Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance GHC.Generics.Generic Amazonka.CloudWatch.PutInsightRule.PutInsightRuleResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutInsightRule.PutInsightRuleResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutInsightRule.PutInsightRuleResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutInsightRule.PutInsightRuleResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutInsightRule.PutInsightRuleResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutInsightRule.PutInsightRule
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutInsightRule.PutInsightRule
-- | Creates a dashboard if it does not already exist, or updates an
-- existing dashboard. If you update a dashboard, the entire contents are
-- replaced with what you specify here.
--
-- All dashboards in your account are global, not region-specific.
--
-- A simple way to create a dashboard using PutDashboard is to
-- copy an existing dashboard. To copy an existing dashboard using the
-- console, you can load the dashboard and then use the View/edit source
-- command in the Actions menu to display the JSON block for that
-- dashboard. Another way to copy a dashboard is to use
-- GetDashboard, and then use the data returned within
-- DashboardBody as the template for the new dashboard when you
-- call PutDashboard.
--
-- When you create a dashboard with PutDashboard, a good
-- practice is to add a text widget at the top of the dashboard with a
-- message that the dashboard was created by script and should not be
-- changed in the console. This message could also point console users to
-- the location of the DashboardBody script or the
-- CloudFormation template used to create the dashboard.
module Amazonka.CloudWatch.PutDashboard
-- | See: newPutDashboard smart constructor.
data PutDashboard
PutDashboard' :: Text -> Text -> PutDashboard
-- | 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:dashboardName:PutDashboard'] :: PutDashboard -> Text
-- | 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.
[$sel:dashboardBody:PutDashboard'] :: PutDashboard -> Text
-- | 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:
--
-- 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.
newPutDashboard :: Text -> Text -> PutDashboard
-- | 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.
putDashboard_dashboardName :: Lens' PutDashboard Text
-- | 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.
putDashboard_dashboardBody :: Lens' PutDashboard Text
-- | See: newPutDashboardResponse smart constructor.
data PutDashboardResponse
PutDashboardResponse' :: Maybe [DashboardValidationMessage] -> Int -> PutDashboardResponse
-- | 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:dashboardValidationMessages:PutDashboardResponse'] :: PutDashboardResponse -> Maybe [DashboardValidationMessage]
-- | The response's http status code.
[$sel:httpStatus:PutDashboardResponse'] :: PutDashboardResponse -> Int
-- | 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.
newPutDashboardResponse :: Int -> PutDashboardResponse
-- | 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.
putDashboardResponse_dashboardValidationMessages :: Lens' PutDashboardResponse (Maybe [DashboardValidationMessage])
-- | The response's http status code.
putDashboardResponse_httpStatus :: Lens' PutDashboardResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.PutDashboard.PutDashboard
instance GHC.Show.Show Amazonka.CloudWatch.PutDashboard.PutDashboard
instance GHC.Read.Read Amazonka.CloudWatch.PutDashboard.PutDashboard
instance GHC.Classes.Eq Amazonka.CloudWatch.PutDashboard.PutDashboard
instance GHC.Generics.Generic Amazonka.CloudWatch.PutDashboard.PutDashboardResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutDashboard.PutDashboardResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutDashboard.PutDashboardResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutDashboard.PutDashboardResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutDashboard.PutDashboard
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutDashboard.PutDashboardResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutDashboard.PutDashboard
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutDashboard.PutDashboard
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutDashboard.PutDashboard
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutDashboard.PutDashboard
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutDashboard.PutDashboard
-- | Creates or updates a composite alarm. When you create a
-- composite alarm, you specify a rule expression for the alarm that
-- takes into account the alarm states of other alarms that you have
-- created. The composite alarm goes into ALARM state only if all
-- conditions of the rule are met.
--
-- The alarms specified in a composite alarm's rule expression can
-- include metric alarms and other composite alarms. The rule expression
-- of a composite alarm can include as many as 100 underlying alarms. Any
-- single alarm can be included in the rule expressions of as many as 150
-- composite alarms.
--
-- Using composite alarms can reduce alarm noise. You can create multiple
-- metric alarms, and also create a composite alarm and set up alerts
-- only for the composite alarm. For example, you could create a
-- composite alarm that goes into ALARM state only when more than one of
-- the underlying metric alarms are in ALARM state.
--
-- Currently, the only alarm actions that can be taken by composite
-- alarms are notifying SNS topics.
--
-- It is possible to create a loop or cycle of composite alarms, where
-- composite alarm A depends on composite alarm B, and composite alarm B
-- also depends on composite alarm A. In this scenario, you can't delete
-- any composite alarm that is part of the cycle because there is always
-- still a composite alarm that depends on that alarm that you want to
-- delete.
--
-- To get out of such a situation, you must break the cycle by changing
-- the rule of one of the composite alarms in the cycle to remove a
-- dependency that creates the cycle. The simplest change to make to
-- break a cycle is to change the AlarmRule of one of the alarms
-- to false.
--
-- Additionally, the evaluation of composite alarms stops if CloudWatch
-- detects a cycle in the evaluation path.
--
-- When this operation creates an alarm, the alarm state is immediately
-- set to INSUFFICIENT_DATA. The alarm is then evaluated and its
-- state is set appropriately. Any actions associated with the new state
-- are then executed. For a composite alarm, this initial time after
-- creation is the only time that the alarm can be in
-- INSUFFICIENT_DATA state.
--
-- When you update an existing alarm, its state is left unchanged, but
-- the update completely overwrites the previous configuration of the
-- alarm.
--
-- To use this operation, you must be signed on with the
-- cloudwatch:PutCompositeAlarm permission that is scoped to
-- *. You can't create a composite alarms if your
-- cloudwatch:PutCompositeAlarm permission has a narrower scope.
--
-- If you are an IAM user, you must have
-- iam:CreateServiceLinkedRole to create a composite alarm that
-- has Systems Manager OpsItem actions.
module Amazonka.CloudWatch.PutCompositeAlarm
-- | See: newPutCompositeAlarm smart constructor.
data PutCompositeAlarm
PutCompositeAlarm' :: Maybe Bool -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe [Text] -> Maybe Text -> Maybe [Text] -> Maybe [Text] -> Maybe [Tag] -> Text -> Text -> PutCompositeAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state of the composite alarm. The default is TRUE.
[$sel:actionsEnabled:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe Bool
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
[$sel:actionsSuppressor:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe Text
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
[$sel:actionsSuppressorExtensionPeriod:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe Int
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
[$sel:actionsSuppressorWaitPeriod:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe Int
-- | 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:alarmActions:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe [Text]
-- | The description for the composite alarm.
[$sel:alarmDescription:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe Text
-- | 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:insufficientDataActions:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe [Text]
-- | 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:oKActions:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe [Text]
-- | 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:tags:PutCompositeAlarm'] :: PutCompositeAlarm -> Maybe [Tag]
-- | The name for the composite alarm. This name must be unique within the
-- Region.
[$sel:alarmName:PutCompositeAlarm'] :: PutCompositeAlarm -> Text
-- | 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.
[$sel:alarmRule:PutCompositeAlarm'] :: PutCompositeAlarm -> Text
-- | 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:
--
-- PutCompositeAlarm, putCompositeAlarm_actionsEnabled -
-- Indicates whether actions should be executed during any changes to the
-- alarm state of the composite alarm. The default is TRUE.
--
-- PutCompositeAlarm, putCompositeAlarm_actionsSuppressor -
-- Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
--
-- PutCompositeAlarm,
-- putCompositeAlarm_actionsSuppressorExtensionPeriod - The
-- maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
--
-- PutCompositeAlarm,
-- putCompositeAlarm_actionsSuppressorWaitPeriod - The maximum
-- time in seconds that the composite alarm waits for the suppressor
-- alarm to go into the ALARM state. After this time, the
-- composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
--
-- 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
--
--
-- PutCompositeAlarm, putCompositeAlarm_alarmDescription -
-- The description for the composite alarm.
--
-- 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
--
--
-- 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
--
--
-- 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.
--
-- PutCompositeAlarm, putCompositeAlarm_alarmName - The
-- name for the composite alarm. This name must be unique within the
-- Region.
--
-- 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.
newPutCompositeAlarm :: Text -> Text -> PutCompositeAlarm
-- | Indicates whether actions should be executed during any changes to the
-- alarm state of the composite alarm. The default is TRUE.
putCompositeAlarm_actionsEnabled :: Lens' PutCompositeAlarm (Maybe Bool)
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
putCompositeAlarm_actionsSuppressor :: Lens' PutCompositeAlarm (Maybe Text)
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
putCompositeAlarm_actionsSuppressorExtensionPeriod :: Lens' PutCompositeAlarm (Maybe Int)
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
putCompositeAlarm_actionsSuppressorWaitPeriod :: Lens' PutCompositeAlarm (Maybe Int)
-- | 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
--
putCompositeAlarm_alarmActions :: Lens' PutCompositeAlarm (Maybe [Text])
-- | The description for the composite alarm.
putCompositeAlarm_alarmDescription :: Lens' PutCompositeAlarm (Maybe Text)
-- | 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
--
putCompositeAlarm_insufficientDataActions :: Lens' PutCompositeAlarm (Maybe [Text])
-- | 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
--
putCompositeAlarm_oKActions :: Lens' PutCompositeAlarm (Maybe [Text])
-- | 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.
putCompositeAlarm_tags :: Lens' PutCompositeAlarm (Maybe [Tag])
-- | The name for the composite alarm. This name must be unique within the
-- Region.
putCompositeAlarm_alarmName :: Lens' PutCompositeAlarm Text
-- | 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.
putCompositeAlarm_alarmRule :: Lens' PutCompositeAlarm Text
-- | See: newPutCompositeAlarmResponse smart constructor.
data PutCompositeAlarmResponse
PutCompositeAlarmResponse' :: PutCompositeAlarmResponse
-- | Create a value of PutCompositeAlarmResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newPutCompositeAlarmResponse :: PutCompositeAlarmResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance GHC.Show.Show Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance GHC.Read.Read Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance GHC.Classes.Eq Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance GHC.Generics.Generic Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarmResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarmResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarmResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarmResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarmResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutCompositeAlarm.PutCompositeAlarm
-- | Creates an anomaly detection model for a CloudWatch metric. You can
-- use the model to display a band of expected normal values when the
-- metric is graphed.
--
-- For more information, see CloudWatch Anomaly Detection.
module Amazonka.CloudWatch.PutAnomalyDetector
-- | See: newPutAnomalyDetector smart constructor.
data PutAnomalyDetector
PutAnomalyDetector' :: Maybe AnomalyDetectorConfiguration -> Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe Text -> PutAnomalyDetector
-- | 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:configuration:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe AnomalyDetectorConfiguration
-- | The metric dimensions to create the anomaly detection model for.
[$sel:dimensions:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe [Dimension]
-- | The metric math anomaly detector to be created.
--
-- When using MetricMathAnomalyDetector, you cannot include the
-- following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the property MetricMathAnomalyDetector.
[$sel:metricMathAnomalyDetector:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe MetricMathAnomalyDetector
-- | The name of the metric to create the anomaly detection model for.
[$sel:metricName:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe Text
-- | The namespace of the metric to create the anomaly detection model for.
[$sel:namespace:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe Text
-- | A single metric anomaly detector to be created.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the MetricMatchAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the property SingleMetricAnomalyDetector.
[$sel:singleMetricAnomalyDetector:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe SingleMetricAnomalyDetector
-- | The statistic to use for the metric and the anomaly detection model.
[$sel:stat:PutAnomalyDetector'] :: PutAnomalyDetector -> Maybe Text
-- | 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:
--
-- 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.
--
-- PutAnomalyDetector, putAnomalyDetector_dimensions - The
-- metric dimensions to create the anomaly detection model for.
--
-- PutAnomalyDetector,
-- putAnomalyDetector_metricMathAnomalyDetector - The metric math
-- anomaly detector to be created.
--
-- When using MetricMathAnomalyDetector, you cannot include the
-- following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the property MetricMathAnomalyDetector.
--
-- PutAnomalyDetector, putAnomalyDetector_metricName - The
-- name of the metric to create the anomaly detection model for.
--
-- PutAnomalyDetector, putAnomalyDetector_namespace - The
-- namespace of the metric to create the anomaly detection model for.
--
-- PutAnomalyDetector,
-- putAnomalyDetector_singleMetricAnomalyDetector - A single
-- metric anomaly detector to be created.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the MetricMatchAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the property SingleMetricAnomalyDetector.
--
-- PutAnomalyDetector, putAnomalyDetector_stat - The
-- statistic to use for the metric and the anomaly detection model.
newPutAnomalyDetector :: PutAnomalyDetector
-- | 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.
putAnomalyDetector_configuration :: Lens' PutAnomalyDetector (Maybe AnomalyDetectorConfiguration)
-- | The metric dimensions to create the anomaly detection model for.
putAnomalyDetector_dimensions :: Lens' PutAnomalyDetector (Maybe [Dimension])
-- | The metric math anomaly detector to be created.
--
-- When using MetricMathAnomalyDetector, you cannot include the
-- following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the property MetricMathAnomalyDetector.
putAnomalyDetector_metricMathAnomalyDetector :: Lens' PutAnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The name of the metric to create the anomaly detection model for.
putAnomalyDetector_metricName :: Lens' PutAnomalyDetector (Maybe Text)
-- | The namespace of the metric to create the anomaly detection model for.
putAnomalyDetector_namespace :: Lens' PutAnomalyDetector (Maybe Text)
-- | A single metric anomaly detector to be created.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the MetricMatchAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the property SingleMetricAnomalyDetector.
putAnomalyDetector_singleMetricAnomalyDetector :: Lens' PutAnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic to use for the metric and the anomaly detection model.
putAnomalyDetector_stat :: Lens' PutAnomalyDetector (Maybe Text)
-- | See: newPutAnomalyDetectorResponse smart constructor.
data PutAnomalyDetectorResponse
PutAnomalyDetectorResponse' :: Int -> PutAnomalyDetectorResponse
-- | The response's http status code.
[$sel:httpStatus:PutAnomalyDetectorResponse'] :: PutAnomalyDetectorResponse -> Int
-- | 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.
newPutAnomalyDetectorResponse :: Int -> PutAnomalyDetectorResponse
-- | The response's http status code.
putAnomalyDetectorResponse_httpStatus :: Lens' PutAnomalyDetectorResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance GHC.Show.Show Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance GHC.Read.Read Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance GHC.Classes.Eq Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance GHC.Generics.Generic Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetectorResponse
instance GHC.Show.Show Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetectorResponse
instance GHC.Read.Read Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetectorResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetectorResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetectorResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.PutAnomalyDetector.PutAnomalyDetector
-- | Displays the tags associated with a CloudWatch resource. Currently,
-- alarms and Contributor Insights rules support tagging.
module Amazonka.CloudWatch.ListTagsForResource
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Text -> ListTagsForResource
-- | 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.
[$sel:resourceARN:ListTagsForResource'] :: ListTagsForResource -> Text
-- | 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:
--
-- 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.
newListTagsForResource :: Text -> ListTagsForResource
-- | 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.
listTagsForResource_resourceARN :: Lens' ListTagsForResource Text
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Maybe [Tag] -> Int -> ListTagsForResourceResponse
-- | The list of tag keys and values associated with the resource you
-- specified.
[$sel:tags:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Maybe [Tag]
-- | The response's http status code.
[$sel:httpStatus:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Int
-- | 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:
--
-- 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.
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
-- | The list of tag keys and values associated with the resource you
-- specified.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance GHC.Show.Show Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance GHC.Read.Read Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance GHC.Classes.Eq Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance GHC.Generics.Generic Amazonka.CloudWatch.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Show.Show Amazonka.CloudWatch.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Read.Read Amazonka.CloudWatch.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.ListTagsForResource.ListTagsForResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListTagsForResource.ListTagsForResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.ListTagsForResource.ListTagsForResource
-- | List the specified metrics. You can use the returned metrics with
-- GetMetricData or GetMetricStatistics to get statistical
-- data.
--
-- Up to 500 results are returned for any one call. To retrieve
-- additional results, use the returned token with subsequent calls.
--
-- After you create a metric, allow up to 15 minutes for the metric to
-- appear. To see metric statistics sooner, use GetMetricData or
-- GetMetricStatistics.
--
-- If you are using CloudWatch cross-account observability, you can use
-- this operation in a monitoring account and view metrics from the
-- linked source accounts. For more information, see CloudWatch
-- cross-account observability.
--
-- ListMetrics doesn't return information about metrics if those
-- metrics haven't reported data in the past two weeks. To retrieve those
-- metrics, use GetMetricData or GetMetricStatistics.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.ListMetrics
-- | See: newListMetrics smart constructor.
data ListMetrics
ListMetrics' :: Maybe [DimensionFilter] -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe RecentlyActive -> ListMetrics
-- | The dimensions to filter against. Only the dimensions that match
-- exactly will be returned.
[$sel:dimensions:ListMetrics'] :: ListMetrics -> Maybe [DimensionFilter]
-- | If you are using this operation in a monitoring account, specify
-- true to include metrics from source accounts in the returned
-- data.
--
-- The default is false.
[$sel:includeLinkedAccounts:ListMetrics'] :: ListMetrics -> Maybe Bool
-- | The name of the metric to filter against. Only the metrics with names
-- that match exactly will be returned.
[$sel:metricName:ListMetrics'] :: ListMetrics -> Maybe Text
-- | The metric namespace to filter against. Only the namespace that
-- matches exactly will be returned.
[$sel:namespace:ListMetrics'] :: ListMetrics -> Maybe Text
-- | The token returned by a previous call to indicate that there is more
-- data available.
[$sel:nextToken:ListMetrics'] :: ListMetrics -> Maybe Text
-- | When you use this operation in a monitoring account, use this field to
-- return metrics only from one source account. To do so, specify that
-- source account ID in this field, and also specify true for
-- IncludeLinkedAccounts.
[$sel:owningAccount:ListMetrics'] :: ListMetrics -> Maybe Text
-- | 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:recentlyActive:ListMetrics'] :: ListMetrics -> Maybe RecentlyActive
-- | 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:
--
-- ListMetrics, listMetrics_dimensions - The dimensions to
-- filter against. Only the dimensions that match exactly will be
-- returned.
--
-- $sel:includeLinkedAccounts:ListMetrics',
-- listMetrics_includeLinkedAccounts - If you are using this
-- operation in a monitoring account, specify true to include
-- metrics from source accounts in the returned data.
--
-- The default is false.
--
-- ListMetrics, listMetrics_metricName - The name of the
-- metric to filter against. Only the metrics with names that match
-- exactly will be returned.
--
-- ListMetrics, listMetrics_namespace - The metric
-- namespace to filter against. Only the namespace that matches exactly
-- will be returned.
--
-- ListMetrics, listMetrics_nextToken - The token returned
-- by a previous call to indicate that there is more data available.
--
-- $sel:owningAccount:ListMetrics',
-- listMetrics_owningAccount - When you use this operation in a
-- monitoring account, use this field to return metrics only from one
-- source account. To do so, specify that source account ID in this
-- field, and also specify true for
-- IncludeLinkedAccounts.
--
-- $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.
newListMetrics :: ListMetrics
-- | The dimensions to filter against. Only the dimensions that match
-- exactly will be returned.
listMetrics_dimensions :: Lens' ListMetrics (Maybe [DimensionFilter])
-- | If you are using this operation in a monitoring account, specify
-- true to include metrics from source accounts in the returned
-- data.
--
-- The default is false.
listMetrics_includeLinkedAccounts :: Lens' ListMetrics (Maybe Bool)
-- | The name of the metric to filter against. Only the metrics with names
-- that match exactly will be returned.
listMetrics_metricName :: Lens' ListMetrics (Maybe Text)
-- | The metric namespace to filter against. Only the namespace that
-- matches exactly will be returned.
listMetrics_namespace :: Lens' ListMetrics (Maybe Text)
-- | The token returned by a previous call to indicate that there is more
-- data available.
listMetrics_nextToken :: Lens' ListMetrics (Maybe Text)
-- | When you use this operation in a monitoring account, use this field to
-- return metrics only from one source account. To do so, specify that
-- source account ID in this field, and also specify true for
-- IncludeLinkedAccounts.
listMetrics_owningAccount :: Lens' ListMetrics (Maybe Text)
-- | 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.
listMetrics_recentlyActive :: Lens' ListMetrics (Maybe RecentlyActive)
-- | See: newListMetricsResponse smart constructor.
data ListMetricsResponse
ListMetricsResponse' :: Maybe [Metric] -> Maybe Text -> Maybe [Text] -> Int -> ListMetricsResponse
-- | The metrics that match your request.
[$sel:metrics:ListMetricsResponse'] :: ListMetricsResponse -> Maybe [Metric]
-- | The token that marks the start of the next batch of returned results.
[$sel:nextToken:ListMetricsResponse'] :: ListMetricsResponse -> Maybe Text
-- | If you are using this operation in a monitoring account, this array
-- contains the account IDs of the source accounts where the metrics in
-- the returned data are from.
--
-- This field is a 1:1 mapping between each metric that is returned and
-- the ID of the owning account.
[$sel:owningAccounts:ListMetricsResponse'] :: ListMetricsResponse -> Maybe [Text]
-- | The response's http status code.
[$sel:httpStatus:ListMetricsResponse'] :: ListMetricsResponse -> Int
-- | 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:
--
-- ListMetricsResponse, listMetricsResponse_metrics - The
-- metrics that match your request.
--
-- ListMetrics, listMetricsResponse_nextToken - The token
-- that marks the start of the next batch of returned results.
--
-- $sel:owningAccounts:ListMetricsResponse',
-- listMetricsResponse_owningAccounts - If you are using this
-- operation in a monitoring account, this array contains the account IDs
-- of the source accounts where the metrics in the returned data are
-- from.
--
-- This field is a 1:1 mapping between each metric that is returned and
-- the ID of the owning account.
--
-- $sel:httpStatus:ListMetricsResponse',
-- listMetricsResponse_httpStatus - The response's http status
-- code.
newListMetricsResponse :: Int -> ListMetricsResponse
-- | The metrics that match your request.
listMetricsResponse_metrics :: Lens' ListMetricsResponse (Maybe [Metric])
-- | The token that marks the start of the next batch of returned results.
listMetricsResponse_nextToken :: Lens' ListMetricsResponse (Maybe Text)
-- | If you are using this operation in a monitoring account, this array
-- contains the account IDs of the source accounts where the metrics in
-- the returned data are from.
--
-- This field is a 1:1 mapping between each metric that is returned and
-- the ID of the owning account.
listMetricsResponse_owningAccounts :: Lens' ListMetricsResponse (Maybe [Text])
-- | The response's http status code.
listMetricsResponse_httpStatus :: Lens' ListMetricsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.ListMetrics.ListMetrics
instance GHC.Show.Show Amazonka.CloudWatch.ListMetrics.ListMetrics
instance GHC.Read.Read Amazonka.CloudWatch.ListMetrics.ListMetrics
instance GHC.Classes.Eq Amazonka.CloudWatch.ListMetrics.ListMetrics
instance GHC.Generics.Generic Amazonka.CloudWatch.ListMetrics.ListMetricsResponse
instance GHC.Show.Show Amazonka.CloudWatch.ListMetrics.ListMetricsResponse
instance GHC.Read.Read Amazonka.CloudWatch.ListMetrics.ListMetricsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.ListMetrics.ListMetricsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.ListMetrics.ListMetrics
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListMetrics.ListMetricsResponse
instance Amazonka.Pager.AWSPager Amazonka.CloudWatch.ListMetrics.ListMetrics
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.ListMetrics.ListMetrics
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListMetrics.ListMetrics
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.ListMetrics.ListMetrics
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.ListMetrics.ListMetrics
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.ListMetrics.ListMetrics
-- | Returns a list of metric streams in this account.
module Amazonka.CloudWatch.ListMetricStreams
-- | See: newListMetricStreams smart constructor.
data ListMetricStreams
ListMetricStreams' :: Maybe Natural -> Maybe Text -> ListMetricStreams
-- | The maximum number of results to return in one operation.
[$sel:maxResults:ListMetricStreams'] :: ListMetricStreams -> Maybe Natural
-- | Include this value, if it was returned by the previous call, to get
-- the next set of metric streams.
[$sel:nextToken:ListMetricStreams'] :: ListMetricStreams -> Maybe Text
-- | 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:maxResults:ListMetricStreams',
-- listMetricStreams_maxResults - The maximum number of results to
-- return in one operation.
--
-- ListMetricStreams, listMetricStreams_nextToken - Include
-- this value, if it was returned by the previous call, to get the next
-- set of metric streams.
newListMetricStreams :: ListMetricStreams
-- | The maximum number of results to return in one operation.
listMetricStreams_maxResults :: Lens' ListMetricStreams (Maybe Natural)
-- | Include this value, if it was returned by the previous call, to get
-- the next set of metric streams.
listMetricStreams_nextToken :: Lens' ListMetricStreams (Maybe Text)
-- | See: newListMetricStreamsResponse smart constructor.
data ListMetricStreamsResponse
ListMetricStreamsResponse' :: Maybe [MetricStreamEntry] -> Maybe Text -> Int -> ListMetricStreamsResponse
-- | The array of metric stream information.
[$sel:entries:ListMetricStreamsResponse'] :: ListMetricStreamsResponse -> Maybe [MetricStreamEntry]
-- | 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:nextToken:ListMetricStreamsResponse'] :: ListMetricStreamsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:ListMetricStreamsResponse'] :: ListMetricStreamsResponse -> Int
-- | 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.
--
-- 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.
newListMetricStreamsResponse :: Int -> ListMetricStreamsResponse
-- | The array of metric stream information.
listMetricStreamsResponse_entries :: Lens' ListMetricStreamsResponse (Maybe [MetricStreamEntry])
-- | 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.
listMetricStreamsResponse_nextToken :: Lens' ListMetricStreamsResponse (Maybe Text)
-- | The response's http status code.
listMetricStreamsResponse_httpStatus :: Lens' ListMetricStreamsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance GHC.Show.Show Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance GHC.Read.Read Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance GHC.Classes.Eq Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance GHC.Generics.Generic Amazonka.CloudWatch.ListMetricStreams.ListMetricStreamsResponse
instance GHC.Show.Show Amazonka.CloudWatch.ListMetricStreams.ListMetricStreamsResponse
instance GHC.Read.Read Amazonka.CloudWatch.ListMetricStreams.ListMetricStreamsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.ListMetricStreams.ListMetricStreamsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListMetricStreams.ListMetricStreamsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.ListMetricStreams.ListMetricStreams
-- | Returns a list that contains the number of managed Contributor
-- Insights rules in your account.
module Amazonka.CloudWatch.ListManagedInsightRules
-- | See: newListManagedInsightRules smart constructor.
data ListManagedInsightRules
ListManagedInsightRules' :: Maybe Natural -> Maybe Text -> Text -> ListManagedInsightRules
-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default number is used. The default number is
-- 100.
[$sel:maxResults:ListManagedInsightRules'] :: ListManagedInsightRules -> Maybe Natural
-- | Include this value to get the next set of rules if the value was
-- returned by the previous operation.
[$sel:nextToken:ListManagedInsightRules'] :: ListManagedInsightRules -> Maybe Text
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
[$sel:resourceARN:ListManagedInsightRules'] :: ListManagedInsightRules -> Text
-- | Create a value of ListManagedInsightRules 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:maxResults:ListManagedInsightRules',
-- listManagedInsightRules_maxResults - The maximum number of
-- results to return in one operation. If you omit this parameter, the
-- default number is used. The default number is 100.
--
-- ListManagedInsightRules,
-- listManagedInsightRules_nextToken - Include this value to get
-- the next set of rules if the value was returned by the previous
-- operation.
--
-- ListManagedInsightRules,
-- listManagedInsightRules_resourceARN - The ARN of an Amazon Web
-- Services resource that has managed Contributor Insights rules.
newListManagedInsightRules :: Text -> ListManagedInsightRules
-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default number is used. The default number is
-- 100.
listManagedInsightRules_maxResults :: Lens' ListManagedInsightRules (Maybe Natural)
-- | Include this value to get the next set of rules if the value was
-- returned by the previous operation.
listManagedInsightRules_nextToken :: Lens' ListManagedInsightRules (Maybe Text)
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
listManagedInsightRules_resourceARN :: Lens' ListManagedInsightRules Text
-- | See: newListManagedInsightRulesResponse smart
-- constructor.
data ListManagedInsightRulesResponse
ListManagedInsightRulesResponse' :: Maybe [ManagedRuleDescription] -> Maybe Text -> Int -> ListManagedInsightRulesResponse
-- | The managed rules that are available for the specified Amazon Web
-- Services resource.
[$sel:managedRules:ListManagedInsightRulesResponse'] :: ListManagedInsightRulesResponse -> Maybe [ManagedRuleDescription]
-- | Include this value to get the next set of rules if the value was
-- returned by the previous operation.
[$sel:nextToken:ListManagedInsightRulesResponse'] :: ListManagedInsightRulesResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:ListManagedInsightRulesResponse'] :: ListManagedInsightRulesResponse -> Int
-- | Create a value of ListManagedInsightRulesResponse 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:managedRules:ListManagedInsightRulesResponse',
-- listManagedInsightRulesResponse_managedRules - The managed
-- rules that are available for the specified Amazon Web Services
-- resource.
--
-- ListManagedInsightRules,
-- listManagedInsightRulesResponse_nextToken - Include this value
-- to get the next set of rules if the value was returned by the previous
-- operation.
--
-- $sel:httpStatus:ListManagedInsightRulesResponse',
-- listManagedInsightRulesResponse_httpStatus - The response's
-- http status code.
newListManagedInsightRulesResponse :: Int -> ListManagedInsightRulesResponse
-- | The managed rules that are available for the specified Amazon Web
-- Services resource.
listManagedInsightRulesResponse_managedRules :: Lens' ListManagedInsightRulesResponse (Maybe [ManagedRuleDescription])
-- | Include this value to get the next set of rules if the value was
-- returned by the previous operation.
listManagedInsightRulesResponse_nextToken :: Lens' ListManagedInsightRulesResponse (Maybe Text)
-- | The response's http status code.
listManagedInsightRulesResponse_httpStatus :: Lens' ListManagedInsightRulesResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance GHC.Show.Show Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance GHC.Read.Read Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance GHC.Classes.Eq Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance GHC.Generics.Generic Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRulesResponse
instance GHC.Show.Show Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRulesResponse
instance GHC.Read.Read Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRulesResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRulesResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRulesResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.ListManagedInsightRules.ListManagedInsightRules
-- | Returns a list of the dashboards for your account. If you include
-- DashboardNamePrefix, only those dashboards with names
-- starting with the prefix are listed. Otherwise, all dashboards in your
-- account are listed.
--
-- ListDashboards returns up to 1000 results on one page. If
-- there are more than 1000 dashboards, you can call
-- ListDashboards again and include the value you received for
-- NextToken in the first call, to receive the next 1000
-- results.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.ListDashboards
-- | See: newListDashboards smart constructor.
data ListDashboards
ListDashboards' :: Maybe Text -> Maybe Text -> ListDashboards
-- | 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:dashboardNamePrefix:ListDashboards'] :: ListDashboards -> Maybe Text
-- | The token returned by a previous call to indicate that there is more
-- data available.
[$sel:nextToken:ListDashboards'] :: ListDashboards -> Maybe Text
-- | 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 "_".
--
-- ListDashboards, listDashboards_nextToken - The token
-- returned by a previous call to indicate that there is more data
-- available.
newListDashboards :: ListDashboards
-- | 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 "_".
listDashboards_dashboardNamePrefix :: Lens' ListDashboards (Maybe Text)
-- | The token returned by a previous call to indicate that there is more
-- data available.
listDashboards_nextToken :: Lens' ListDashboards (Maybe Text)
-- | See: newListDashboardsResponse smart constructor.
data ListDashboardsResponse
ListDashboardsResponse' :: Maybe [DashboardEntry] -> Maybe Text -> Int -> ListDashboardsResponse
-- | The list of matching dashboards.
[$sel:dashboardEntries:ListDashboardsResponse'] :: ListDashboardsResponse -> Maybe [DashboardEntry]
-- | The token that marks the start of the next batch of returned results.
[$sel:nextToken:ListDashboardsResponse'] :: ListDashboardsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:ListDashboardsResponse'] :: ListDashboardsResponse -> Int
-- | 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.
--
-- 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.
newListDashboardsResponse :: Int -> ListDashboardsResponse
-- | The list of matching dashboards.
listDashboardsResponse_dashboardEntries :: Lens' ListDashboardsResponse (Maybe [DashboardEntry])
-- | The token that marks the start of the next batch of returned results.
listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text)
-- | The response's http status code.
listDashboardsResponse_httpStatus :: Lens' ListDashboardsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.ListDashboards.ListDashboards
instance GHC.Show.Show Amazonka.CloudWatch.ListDashboards.ListDashboards
instance GHC.Read.Read Amazonka.CloudWatch.ListDashboards.ListDashboards
instance GHC.Classes.Eq Amazonka.CloudWatch.ListDashboards.ListDashboards
instance GHC.Generics.Generic Amazonka.CloudWatch.ListDashboards.ListDashboardsResponse
instance GHC.Show.Show Amazonka.CloudWatch.ListDashboards.ListDashboardsResponse
instance GHC.Read.Read Amazonka.CloudWatch.ListDashboards.ListDashboardsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.ListDashboards.ListDashboardsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.ListDashboards.ListDashboards
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListDashboards.ListDashboardsResponse
instance Amazonka.Pager.AWSPager Amazonka.CloudWatch.ListDashboards.ListDashboards
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.ListDashboards.ListDashboards
instance Control.DeepSeq.NFData Amazonka.CloudWatch.ListDashboards.ListDashboards
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.ListDashboards.ListDashboards
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.ListDashboards.ListDashboards
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.ListDashboards.ListDashboards
-- | You can use the GetMetricWidgetImage API to retrieve a
-- snapshot graph of one or more Amazon CloudWatch metrics as a bitmap
-- image. You can then embed this image into your services and products,
-- such as wiki pages, reports, and documents. You could also retrieve
-- images regularly, such as every minute, and create your own custom
-- live dashboard.
--
-- The graph you retrieve can include all CloudWatch metric graph
-- features, including metric math and horizontal and vertical
-- annotations.
--
-- There is a limit of 20 transactions per second for this API. Each
-- GetMetricWidgetImage action has the following limits:
--
--
-- - As many as 100 metrics in the graph.
-- - Up to 100 KB uncompressed payload.
--
module Amazonka.CloudWatch.GetMetricWidgetImage
-- | See: newGetMetricWidgetImage smart constructor.
data GetMetricWidgetImage
GetMetricWidgetImage' :: Maybe Text -> Text -> GetMetricWidgetImage
-- | 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:outputFormat:GetMetricWidgetImage'] :: GetMetricWidgetImage -> Maybe Text
-- | 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.
[$sel:metricWidget:GetMetricWidgetImage'] :: GetMetricWidgetImage -> Text
-- | 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:
--
-- 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.
newGetMetricWidgetImage :: Text -> GetMetricWidgetImage
-- | 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.
getMetricWidgetImage_outputFormat :: Lens' GetMetricWidgetImage (Maybe Text)
-- | 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.
getMetricWidgetImage_metricWidget :: Lens' GetMetricWidgetImage Text
-- | See: newGetMetricWidgetImageResponse smart constructor.
data GetMetricWidgetImageResponse
GetMetricWidgetImageResponse' :: Maybe Base64 -> Int -> GetMetricWidgetImageResponse
-- | The image of the graph, in the output format specified. The output is
-- base64-encoded.
[$sel:metricWidgetImage:GetMetricWidgetImageResponse'] :: GetMetricWidgetImageResponse -> Maybe Base64
-- | The response's http status code.
[$sel:httpStatus:GetMetricWidgetImageResponse'] :: GetMetricWidgetImageResponse -> Int
-- | 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.
newGetMetricWidgetImageResponse :: Int -> GetMetricWidgetImageResponse
-- | 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.
getMetricWidgetImageResponse_metricWidgetImage :: Lens' GetMetricWidgetImageResponse (Maybe ByteString)
-- | The response's http status code.
getMetricWidgetImageResponse_httpStatus :: Lens' GetMetricWidgetImageResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImageResponse
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImageResponse
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImageResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImageResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImageResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.GetMetricWidgetImage.GetMetricWidgetImage
-- | Returns information about the metric stream that you specify.
module Amazonka.CloudWatch.GetMetricStream
-- | See: newGetMetricStream smart constructor.
data GetMetricStream
GetMetricStream' :: Text -> GetMetricStream
-- | The name of the metric stream to retrieve information about.
[$sel:name:GetMetricStream'] :: GetMetricStream -> Text
-- | 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:
--
-- GetMetricStream, getMetricStream_name - The name of the
-- metric stream to retrieve information about.
newGetMetricStream :: Text -> GetMetricStream
-- | The name of the metric stream to retrieve information about.
getMetricStream_name :: Lens' GetMetricStream Text
-- | See: newGetMetricStreamResponse smart constructor.
data GetMetricStreamResponse
GetMetricStreamResponse' :: Maybe Text -> Maybe ISO8601 -> Maybe [MetricStreamFilter] -> Maybe Text -> Maybe [MetricStreamFilter] -> Maybe ISO8601 -> Maybe Text -> Maybe MetricStreamOutputFormat -> Maybe Text -> Maybe Text -> Maybe [MetricStreamStatisticsConfiguration] -> Int -> GetMetricStreamResponse
-- | The ARN of the metric stream.
[$sel:arn:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe Text
-- | The date that the metric stream was created.
[$sel:creationDate:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe ISO8601
-- | 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:excludeFilters:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe [MetricStreamFilter]
-- | The ARN of the Amazon Kinesis Data Firehose delivery stream that is
-- used by this metric stream.
[$sel:firehoseArn:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe Text
-- | If this array of metric namespaces is present, then these namespaces
-- are the only metric namespaces that are streamed by this metric
-- stream.
[$sel:includeFilters:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe [MetricStreamFilter]
-- | The date of the most recent update to the metric stream's
-- configuration.
[$sel:lastUpdateDate:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe ISO8601
-- | The name of the metric stream.
[$sel:name:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe Text
-- | 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.
[$sel:outputFormat:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe MetricStreamOutputFormat
-- | The ARN of the IAM role that is used by this metric stream.
[$sel:roleArn:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe Text
-- | The state of the metric stream. The possible values are
-- running and stopped.
[$sel:state:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe Text
-- | Each entry in this array displays information about one or more
-- metrics that include additional statistics in the metric stream. For
-- more information about the additional statistics, see CloudWatch
-- statistics definitions.
[$sel:statisticsConfigurations:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Maybe [MetricStreamStatisticsConfiguration]
-- | The response's http status code.
[$sel:httpStatus:GetMetricStreamResponse'] :: GetMetricStreamResponse -> Int
-- | 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:
--
-- GetMetricStreamResponse, getMetricStreamResponse_arn -
-- The ARN of the metric stream.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_creationDate - The date that the metric
-- stream was created.
--
-- $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.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_firehoseArn - The ARN of the Amazon
-- Kinesis Data Firehose delivery stream that is used by this metric
-- stream.
--
-- $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.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_lastUpdateDate - The date of the most
-- recent update to the metric stream's configuration.
--
-- GetMetricStream, getMetricStreamResponse_name - The name
-- of the metric stream.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_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.
--
-- $sel:roleArn:GetMetricStreamResponse',
-- getMetricStreamResponse_roleArn - The ARN of the IAM role that
-- is used by this metric stream.
--
-- GetMetricStreamResponse, getMetricStreamResponse_state -
-- The state of the metric stream. The possible values are
-- running and stopped.
--
-- $sel:statisticsConfigurations:GetMetricStreamResponse',
-- getMetricStreamResponse_statisticsConfigurations - Each entry
-- in this array displays information about one or more metrics that
-- include additional statistics in the metric stream. For more
-- information about the additional statistics, see CloudWatch
-- statistics definitions.
--
-- $sel:httpStatus:GetMetricStreamResponse',
-- getMetricStreamResponse_httpStatus - The response's http status
-- code.
newGetMetricStreamResponse :: Int -> GetMetricStreamResponse
-- | The ARN of the metric stream.
getMetricStreamResponse_arn :: Lens' GetMetricStreamResponse (Maybe Text)
-- | The date that the metric stream was created.
getMetricStreamResponse_creationDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
-- | 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.
getMetricStreamResponse_excludeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
-- | The ARN of the Amazon Kinesis Data Firehose delivery stream that is
-- used by this metric stream.
getMetricStreamResponse_firehoseArn :: Lens' GetMetricStreamResponse (Maybe Text)
-- | If this array of metric namespaces is present, then these namespaces
-- are the only metric namespaces that are streamed by this metric
-- stream.
getMetricStreamResponse_includeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
-- | The date of the most recent update to the metric stream's
-- configuration.
getMetricStreamResponse_lastUpdateDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
-- | The name of the metric stream.
getMetricStreamResponse_name :: Lens' GetMetricStreamResponse (Maybe Text)
-- | 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.
getMetricStreamResponse_outputFormat :: Lens' GetMetricStreamResponse (Maybe MetricStreamOutputFormat)
-- | The ARN of the IAM role that is used by this metric stream.
getMetricStreamResponse_roleArn :: Lens' GetMetricStreamResponse (Maybe Text)
-- | The state of the metric stream. The possible values are
-- running and stopped.
getMetricStreamResponse_state :: Lens' GetMetricStreamResponse (Maybe Text)
-- | Each entry in this array displays information about one or more
-- metrics that include additional statistics in the metric stream. For
-- more information about the additional statistics, see CloudWatch
-- statistics definitions.
getMetricStreamResponse_statisticsConfigurations :: Lens' GetMetricStreamResponse (Maybe [MetricStreamStatisticsConfiguration])
-- | The response's http status code.
getMetricStreamResponse_httpStatus :: Lens' GetMetricStreamResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricStream.GetMetricStreamResponse
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricStream.GetMetricStreamResponse
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricStream.GetMetricStreamResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricStream.GetMetricStreamResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricStream.GetMetricStreamResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.GetMetricStream.GetMetricStream
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.GetMetricStream.GetMetricStream
-- | Gets statistics for the specified metric.
--
-- The maximum number of data points returned from a single call is
-- 1,440. If you request more than 1,440 data points, CloudWatch returns
-- an error. To reduce the number of data points, you can narrow the
-- specified time range and make multiple requests across adjacent time
-- ranges, or you can increase the specified period. Data points are not
-- returned in chronological order.
--
-- CloudWatch aggregates data points based on the length of the period
-- that you specify. For example, if you request statistics with a
-- one-hour period, CloudWatch aggregates all data points with time
-- stamps that fall within each one-hour period. Therefore, the number of
-- values aggregated by CloudWatch is larger than the number of data
-- points returned.
--
-- CloudWatch needs raw data points to calculate percentile statistics.
-- If you publish data using a statistic set instead, you can only
-- retrieve percentile statistics for this data if one of the following
-- conditions is true:
--
--
-- - The SampleCount value of the statistic set is 1.
-- - The Min and the Max values of the statistic set are equal.
--
--
-- Percentile statistics are not available for metrics when any of the
-- metric values are negative numbers.
--
-- Amazon CloudWatch retains metric data as follows:
--
--
-- - Data points with a period of less than 60 seconds are available
-- for 3 hours. These data points are high-resolution metrics and are
-- available only for custom metrics that have been defined with a
-- StorageResolution of 1.
-- - Data points with a period of 60 seconds (1-minute) are available
-- for 15 days.
-- - Data points with a period of 300 seconds (5-minute) are available
-- for 63 days.
-- - Data points with a period of 3600 seconds (1 hour) are available
-- for 455 days (15 months).
--
--
-- Data points that are initially published with a shorter period are
-- aggregated together for long-term storage. For example, if you collect
-- data using a period of 1 minute, the data remains available for 15
-- days with 1-minute resolution. After 15 days, this data is still
-- available, but is aggregated and retrievable only with a resolution of
-- 5 minutes. After 63 days, the data is further aggregated and is
-- available with a resolution of 1 hour.
--
-- CloudWatch started retaining 5-minute and 1-hour metric data as of
-- July 9, 2016.
--
-- For information about metrics and dimensions supported by Amazon Web
-- Services services, see the Amazon CloudWatch Metrics and Dimensions
-- Reference in the Amazon CloudWatch User Guide.
module Amazonka.CloudWatch.GetMetricStatistics
-- | See: newGetMetricStatistics smart constructor.
data GetMetricStatistics
GetMetricStatistics' :: Maybe [Dimension] -> Maybe (NonEmpty Text) -> Maybe (NonEmpty Statistic) -> Maybe StandardUnit -> Text -> Text -> ISO8601 -> ISO8601 -> Natural -> GetMetricStatistics
-- | 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:dimensions:GetMetricStatistics'] :: GetMetricStatistics -> Maybe [Dimension]
-- | 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:extendedStatistics:GetMetricStatistics'] :: GetMetricStatistics -> Maybe (NonEmpty Text)
-- | 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:statistics:GetMetricStatistics'] :: GetMetricStatistics -> Maybe (NonEmpty Statistic)
-- | 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:unit:GetMetricStatistics'] :: GetMetricStatistics -> Maybe StandardUnit
-- | The namespace of the metric, with or without spaces.
[$sel:namespace:GetMetricStatistics'] :: GetMetricStatistics -> Text
-- | The name of the metric, with or without spaces.
[$sel:metricName:GetMetricStatistics'] :: GetMetricStatistics -> Text
-- | 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:startTime:GetMetricStatistics'] :: GetMetricStatistics -> ISO8601
-- | 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:endTime:GetMetricStatistics'] :: GetMetricStatistics -> ISO8601
-- | 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:period:GetMetricStatistics'] :: GetMetricStatistics -> Natural
-- | 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:
--
-- 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.
--
-- 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.
--
-- 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.
--
-- GetMetricStatistics, getMetricStatistics_namespace - The
-- namespace of the metric, with or without spaces.
--
-- GetMetricStatistics, getMetricStatistics_metricName -
-- The name of the metric, with or without spaces.
--
-- 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.
--
-- 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).
--
-- 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).
--
newGetMetricStatistics :: Text -> Text -> UTCTime -> UTCTime -> Natural -> GetMetricStatistics
-- | 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.
getMetricStatistics_dimensions :: Lens' GetMetricStatistics (Maybe [Dimension])
-- | 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.
getMetricStatistics_extendedStatistics :: Lens' GetMetricStatistics (Maybe (NonEmpty Text))
-- | The metric statistics, other than percentile. For percentile
-- statistics, use ExtendedStatistics. When calling
-- GetMetricStatistics, you must specify either
-- Statistics or ExtendedStatistics, but not both.
getMetricStatistics_statistics :: Lens' GetMetricStatistics (Maybe (NonEmpty Statistic))
-- | 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.
getMetricStatistics_unit :: Lens' GetMetricStatistics (Maybe StandardUnit)
-- | The namespace of the metric, with or without spaces.
getMetricStatistics_namespace :: Lens' GetMetricStatistics Text
-- | The name of the metric, with or without spaces.
getMetricStatistics_metricName :: Lens' GetMetricStatistics Text
-- | 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.
getMetricStatistics_startTime :: Lens' GetMetricStatistics UTCTime
-- | 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).
getMetricStatistics_endTime :: Lens' GetMetricStatistics UTCTime
-- | 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).
--
getMetricStatistics_period :: Lens' GetMetricStatistics Natural
-- | See: newGetMetricStatisticsResponse smart constructor.
data GetMetricStatisticsResponse
GetMetricStatisticsResponse' :: Maybe [Datapoint] -> Maybe Text -> Int -> GetMetricStatisticsResponse
-- | The data points for the specified metric.
[$sel:datapoints:GetMetricStatisticsResponse'] :: GetMetricStatisticsResponse -> Maybe [Datapoint]
-- | A label for the specified metric.
[$sel:label:GetMetricStatisticsResponse'] :: GetMetricStatisticsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:GetMetricStatisticsResponse'] :: GetMetricStatisticsResponse -> Int
-- | 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:
--
-- GetMetricStatisticsResponse,
-- getMetricStatisticsResponse_datapoints - The data points for
-- the specified metric.
--
-- GetMetricStatisticsResponse,
-- getMetricStatisticsResponse_label - A label for the specified
-- metric.
--
-- $sel:httpStatus:GetMetricStatisticsResponse',
-- getMetricStatisticsResponse_httpStatus - The response's http
-- status code.
newGetMetricStatisticsResponse :: Int -> GetMetricStatisticsResponse
-- | The data points for the specified metric.
getMetricStatisticsResponse_datapoints :: Lens' GetMetricStatisticsResponse (Maybe [Datapoint])
-- | A label for the specified metric.
getMetricStatisticsResponse_label :: Lens' GetMetricStatisticsResponse (Maybe Text)
-- | The response's http status code.
getMetricStatisticsResponse_httpStatus :: Lens' GetMetricStatisticsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatisticsResponse
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatisticsResponse
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatisticsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatisticsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatisticsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.GetMetricStatistics.GetMetricStatistics
-- | You can use the GetMetricData API to retrieve CloudWatch
-- metric values. The operation can also include a CloudWatch Metrics
-- Insights query, and one or more metric math functions.
--
-- A GetMetricData operation that does not include a query can
-- retrieve as many as 500 different metrics in a single request, with a
-- total of as many as 100,800 data points. You can also optionally
-- perform metric math expressions on the values of the returned
-- statistics, to create new time series that represent new insights into
-- your data. For example, using Lambda metrics, you could divide the
-- Errors metric by the Invocations metric to get an error rate time
-- series. For more information about metric math expressions, see
-- Metric Math Syntax and Functions in the Amazon CloudWatch
-- User Guide.
--
-- If you include a Metrics Insights query, each GetMetricData
-- operation can include only one query. But the same
-- GetMetricData operation can also retrieve other metrics.
-- Metrics Insights queries can query only the most recent three hours of
-- metric data. For more information about Metrics Insights, see Query
-- your metrics with CloudWatch Metrics Insights.
--
-- Calls to the GetMetricData API have a different pricing
-- structure than calls to GetMetricStatistics. For more
-- information about pricing, see Amazon CloudWatch Pricing.
--
-- Amazon CloudWatch retains metric data as follows:
--
--
-- - Data points with a period of less than 60 seconds are available
-- for 3 hours. These data points are high-resolution metrics and are
-- available only for custom metrics that have been defined with a
-- StorageResolution of 1.
-- - Data points with a period of 60 seconds (1-minute) are available
-- for 15 days.
-- - Data points with a period of 300 seconds (5-minute) are available
-- for 63 days.
-- - Data points with a period of 3600 seconds (1 hour) are available
-- for 455 days (15 months).
--
--
-- Data points that are initially published with a shorter period are
-- aggregated together for long-term storage. For example, if you collect
-- data using a period of 1 minute, the data remains available for 15
-- days with 1-minute resolution. After 15 days, this data is still
-- available, but is aggregated and retrievable only with a resolution of
-- 5 minutes. After 63 days, the data is further aggregated and is
-- available with a resolution of 1 hour.
--
-- If you omit Unit in your request, all data that was collected
-- with any unit is returned, along with the corresponding units that
-- were specified when the data was reported to CloudWatch. If you
-- specify a unit, the operation returns only data that was collected
-- with that unit specified. If you specify a unit that does not match
-- the data collected, the results of the operation are null. CloudWatch
-- does not perform unit conversions.
--
-- Using Metrics Insights queries with metric math
--
-- You can't mix a Metric Insights query and metric math syntax in the
-- same expression, but you can reference results from a Metrics Insights
-- query within other Metric math expressions. A Metrics Insights query
-- without a GROUP BY clause returns a single time-series (TS),
-- and can be used as input for a metric math expression that expects a
-- single time series. A Metrics Insights query with a GROUP BY
-- clause returns an array of time-series (TS[]), and can be used as
-- input for a metric math expression that expects an array of time
-- series.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.GetMetricData
-- | See: newGetMetricData smart constructor.
data GetMetricData
GetMetricData' :: Maybe LabelOptions -> Maybe Int -> Maybe Text -> Maybe ScanBy -> [MetricDataQuery] -> ISO8601 -> ISO8601 -> GetMetricData
-- | 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:labelOptions:GetMetricData'] :: GetMetricData -> Maybe LabelOptions
-- | The maximum number of data points the request should return before
-- paginating. If you omit this, the default of 100,800 is used.
[$sel:maxDatapoints:GetMetricData'] :: GetMetricData -> Maybe Int
-- | Include this value, if it was returned by the previous
-- GetMetricData operation, to get the next set of data points.
[$sel:nextToken:GetMetricData'] :: GetMetricData -> Maybe Text
-- | 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:scanBy:GetMetricData'] :: GetMetricData -> Maybe ScanBy
-- | The metric queries to be returned. A single GetMetricData
-- call can include as many as 500 MetricDataQuery structures.
-- Each of these structures can specify either a metric to retrieve, a
-- Metrics Insights query, or a math expression to perform on retrieved
-- data.
[$sel:metricDataQueries:GetMetricData'] :: GetMetricData -> [MetricDataQuery]
-- | 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:startTime:GetMetricData'] :: GetMetricData -> ISO8601
-- | 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.
[$sel:endTime:GetMetricData'] :: GetMetricData -> ISO8601
-- | 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: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: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.
--
-- 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.
--
-- 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, a Metrics
-- Insights query, or a math expression to perform on retrieved data.
--
-- 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.
--
-- 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.
newGetMetricData :: UTCTime -> UTCTime -> GetMetricData
-- | 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.
getMetricData_labelOptions :: Lens' GetMetricData (Maybe LabelOptions)
-- | The maximum number of data points the request should return before
-- paginating. If you omit this, the default of 100,800 is used.
getMetricData_maxDatapoints :: Lens' GetMetricData (Maybe Int)
-- | Include this value, if it was returned by the previous
-- GetMetricData operation, to get the next set of data points.
getMetricData_nextToken :: Lens' GetMetricData (Maybe Text)
-- | 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.
getMetricData_scanBy :: Lens' GetMetricData (Maybe ScanBy)
-- | The metric queries to be returned. A single GetMetricData
-- call can include as many as 500 MetricDataQuery structures.
-- Each of these structures can specify either a metric to retrieve, a
-- Metrics Insights query, or a math expression to perform on retrieved
-- data.
getMetricData_metricDataQueries :: Lens' GetMetricData [MetricDataQuery]
-- | 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.
getMetricData_startTime :: Lens' GetMetricData UTCTime
-- | 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.
getMetricData_endTime :: Lens' GetMetricData UTCTime
-- | See: newGetMetricDataResponse smart constructor.
data GetMetricDataResponse
GetMetricDataResponse' :: Maybe [MessageData] -> Maybe [MetricDataResult] -> Maybe Text -> Int -> GetMetricDataResponse
-- | 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:messages:GetMetricDataResponse'] :: GetMetricDataResponse -> Maybe [MessageData]
-- | The metrics that are returned, including the metric name, namespace,
-- and dimensions.
[$sel:metricDataResults:GetMetricDataResponse'] :: GetMetricDataResponse -> Maybe [MetricDataResult]
-- | A token that marks the next batch of returned results.
[$sel:nextToken:GetMetricDataResponse'] :: GetMetricDataResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:GetMetricDataResponse'] :: GetMetricDataResponse -> Int
-- | 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:
--
-- 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:metricDataResults:GetMetricDataResponse',
-- getMetricDataResponse_metricDataResults - The metrics that are
-- returned, including the metric name, namespace, and dimensions.
--
-- GetMetricData, getMetricDataResponse_nextToken - A token
-- that marks the next batch of returned results.
--
-- $sel:httpStatus:GetMetricDataResponse',
-- getMetricDataResponse_httpStatus - The response's http status
-- code.
newGetMetricDataResponse :: Int -> GetMetricDataResponse
-- | 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.
getMetricDataResponse_messages :: Lens' GetMetricDataResponse (Maybe [MessageData])
-- | The metrics that are returned, including the metric name, namespace,
-- and dimensions.
getMetricDataResponse_metricDataResults :: Lens' GetMetricDataResponse (Maybe [MetricDataResult])
-- | A token that marks the next batch of returned results.
getMetricDataResponse_nextToken :: Lens' GetMetricDataResponse (Maybe Text)
-- | The response's http status code.
getMetricDataResponse_httpStatus :: Lens' GetMetricDataResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricData.GetMetricData
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricData.GetMetricData
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricData.GetMetricData
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricData.GetMetricData
instance GHC.Generics.Generic Amazonka.CloudWatch.GetMetricData.GetMetricDataResponse
instance GHC.Show.Show Amazonka.CloudWatch.GetMetricData.GetMetricDataResponse
instance GHC.Read.Read Amazonka.CloudWatch.GetMetricData.GetMetricDataResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.GetMetricData.GetMetricDataResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.GetMetricData.GetMetricData
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricData.GetMetricDataResponse
instance Amazonka.Pager.AWSPager Amazonka.CloudWatch.GetMetricData.GetMetricData
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.GetMetricData.GetMetricData
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetMetricData.GetMetricData
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.GetMetricData.GetMetricData
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.GetMetricData.GetMetricData
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.GetMetricData.GetMetricData
-- | This operation returns the time series data collected by a Contributor
-- Insights rule. The data includes the identity and number of
-- contributors to the log group.
--
-- You can also optionally return one or more statistics about each data
-- point in the time series. These statistics can include the following:
--
--
-- - UniqueContributors -- the number of unique contributors
-- for each data point.
-- - MaxContributorValue -- the value of the top contributor
-- for each data point. The identity of the contributor might change for
-- each data point in the graph.If this rule aggregates by COUNT, the top
-- contributor for each data point is the contributor with the most
-- occurrences in that period. If the rule aggregates by SUM, the top
-- contributor is the contributor with the highest sum in the log field
-- specified by the rule's Value, during that period.
-- - SampleCount -- the number of data points matched by the
-- rule.
-- - Sum -- the sum of the values from all contributors during
-- the time period represented by that data point.
-- - Minimum -- the minimum value from a single observation
-- during the time period represented by that data point.
-- - Maximum -- the maximum value from a single observation
-- during the time period represented by that data point.
-- - Average -- the average value from all contributors during
-- the time period represented by that data point.
--
module Amazonka.CloudWatch.GetInsightRuleReport
-- | See: newGetInsightRuleReport smart constructor.
data GetInsightRuleReport
GetInsightRuleReport' :: Maybe Int -> Maybe [Text] -> Maybe Text -> Text -> ISO8601 -> ISO8601 -> Natural -> GetInsightRuleReport
-- | 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:maxContributorCount:GetInsightRuleReport'] :: GetInsightRuleReport -> Maybe Int
-- | 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:metrics:GetInsightRuleReport'] :: GetInsightRuleReport -> Maybe [Text]
-- | Determines what statistic to use to rank the contributors. Valid
-- values are SUM and MAXIMUM.
[$sel:orderBy:GetInsightRuleReport'] :: GetInsightRuleReport -> Maybe Text
-- | The name of the rule that you want to see data from.
[$sel:ruleName:GetInsightRuleReport'] :: GetInsightRuleReport -> Text
-- | 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:startTime:GetInsightRuleReport'] :: GetInsightRuleReport -> ISO8601
-- | 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:endTime:GetInsightRuleReport'] :: GetInsightRuleReport -> ISO8601
-- | The period, in seconds, to use for the statistics in the
-- InsightRuleMetricDatapoint results.
[$sel:period:GetInsightRuleReport'] :: GetInsightRuleReport -> Natural
-- | 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.
--
-- 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.
--
-- GetInsightRuleReport, getInsightRuleReport_ruleName -
-- The name of the rule that you want to see data from.
--
-- 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.
--
-- 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.
--
-- GetInsightRuleReport, getInsightRuleReport_period - The
-- period, in seconds, to use for the statistics in the
-- InsightRuleMetricDatapoint results.
newGetInsightRuleReport :: Text -> UTCTime -> UTCTime -> Natural -> GetInsightRuleReport
-- | 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.
getInsightRuleReport_maxContributorCount :: Lens' GetInsightRuleReport (Maybe Int)
-- | 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.
--
getInsightRuleReport_metrics :: Lens' GetInsightRuleReport (Maybe [Text])
-- | Determines what statistic to use to rank the contributors. Valid
-- values are SUM and MAXIMUM.
getInsightRuleReport_orderBy :: Lens' GetInsightRuleReport (Maybe Text)
-- | The name of the rule that you want to see data from.
getInsightRuleReport_ruleName :: Lens' GetInsightRuleReport Text
-- | 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.
getInsightRuleReport_startTime :: Lens' GetInsightRuleReport UTCTime
-- | 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.
getInsightRuleReport_endTime :: Lens' GetInsightRuleReport UTCTime
-- | The period, in seconds, to use for the statistics in the
-- InsightRuleMetricDatapoint results.
getInsightRuleReport_period :: Lens' GetInsightRuleReport Natural
-- | See: newGetInsightRuleReportResponse smart constructor.
data GetInsightRuleReportResponse
GetInsightRuleReportResponse' :: Maybe Double -> Maybe Text -> Maybe Integer -> Maybe [InsightRuleContributor] -> Maybe [Text] -> Maybe [InsightRuleMetricDatapoint] -> Int -> GetInsightRuleReportResponse
-- | The sum of the values from all individual contributors that match the
-- rule.
[$sel:aggregateValue:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Maybe Double
-- | Specifies whether this rule aggregates contributor data by COUNT or
-- SUM.
[$sel:aggregationStatistic:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Maybe Text
-- | An approximate count of the unique contributors found by this rule in
-- this time period.
[$sel:approximateUniqueCount:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Maybe Integer
-- | 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:contributors:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Maybe [InsightRuleContributor]
-- | 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:keyLabels:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Maybe [Text]
-- | A time series of metric data points that matches the time period in
-- the rule request.
[$sel:metricDatapoints:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Maybe [InsightRuleMetricDatapoint]
-- | The response's http status code.
[$sel:httpStatus:GetInsightRuleReportResponse'] :: GetInsightRuleReportResponse -> Int
-- | 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:aggregateValue:GetInsightRuleReportResponse',
-- getInsightRuleReportResponse_aggregateValue - The sum of the
-- values from all individual contributors that match the rule.
--
-- $sel:aggregationStatistic:GetInsightRuleReportResponse',
-- getInsightRuleReportResponse_aggregationStatistic - Specifies
-- whether this rule aggregates contributor data by COUNT or SUM.
--
-- $sel:approximateUniqueCount:GetInsightRuleReportResponse',
-- getInsightRuleReportResponse_approximateUniqueCount - An
-- approximate count of the unique contributors found by this rule in
-- this time period.
--
-- $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: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: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.
newGetInsightRuleReportResponse :: Int -> GetInsightRuleReportResponse
-- | The sum of the values from all individual contributors that match the
-- rule.
getInsightRuleReportResponse_aggregateValue :: Lens' GetInsightRuleReportResponse (Maybe Double)
-- | Specifies whether this rule aggregates contributor data by COUNT or
-- SUM.
getInsightRuleReportResponse_aggregationStatistic :: Lens' GetInsightRuleReportResponse (Maybe Text)
-- | An approximate count of the unique contributors found by this rule in
-- this time period.
getInsightRuleReportResponse_approximateUniqueCount :: Lens' GetInsightRuleReportResponse (Maybe Integer)
-- | 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.
getInsightRuleReportResponse_contributors :: Lens' GetInsightRuleReportResponse (Maybe [InsightRuleContributor])
-- | 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.
getInsightRuleReportResponse_keyLabels :: Lens' GetInsightRuleReportResponse (Maybe [Text])
-- | A time series of metric data points that matches the time period in
-- the rule request.
getInsightRuleReportResponse_metricDatapoints :: Lens' GetInsightRuleReportResponse (Maybe [InsightRuleMetricDatapoint])
-- | The response's http status code.
getInsightRuleReportResponse_httpStatus :: Lens' GetInsightRuleReportResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance GHC.Show.Show Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance GHC.Read.Read Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance GHC.Classes.Eq Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance GHC.Generics.Generic Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReportResponse
instance GHC.Show.Show Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReportResponse
instance GHC.Read.Read Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReportResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReportResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReportResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.GetInsightRuleReport.GetInsightRuleReport
-- | Displays the details of the dashboard that you specify.
--
-- To copy an existing dashboard, use GetDashboard, and then use
-- the data returned within DashboardBody as the template for
-- the new dashboard when you call PutDashboard to create the
-- copy.
module Amazonka.CloudWatch.GetDashboard
-- | See: newGetDashboard smart constructor.
data GetDashboard
GetDashboard' :: Text -> GetDashboard
-- | The name of the dashboard to be described.
[$sel:dashboardName:GetDashboard'] :: GetDashboard -> Text
-- | 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:
--
-- GetDashboard, getDashboard_dashboardName - The name of
-- the dashboard to be described.
newGetDashboard :: Text -> GetDashboard
-- | The name of the dashboard to be described.
getDashboard_dashboardName :: Lens' GetDashboard Text
-- | See: newGetDashboardResponse smart constructor.
data GetDashboardResponse
GetDashboardResponse' :: Maybe Text -> Maybe Text -> Maybe Text -> Int -> GetDashboardResponse
-- | The Amazon Resource Name (ARN) of the dashboard.
[$sel:dashboardArn:GetDashboardResponse'] :: GetDashboardResponse -> Maybe Text
-- | 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:dashboardBody:GetDashboardResponse'] :: GetDashboardResponse -> Maybe Text
-- | The name of the dashboard.
[$sel:dashboardName:GetDashboardResponse'] :: GetDashboardResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:GetDashboardResponse'] :: GetDashboardResponse -> Int
-- | 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:
--
-- GetDashboardResponse, getDashboardResponse_dashboardArn
-- - The Amazon Resource Name (ARN) 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.
--
-- GetDashboard, getDashboardResponse_dashboardName - The
-- name of the dashboard.
--
-- $sel:httpStatus:GetDashboardResponse',
-- getDashboardResponse_httpStatus - The response's http status
-- code.
newGetDashboardResponse :: Int -> GetDashboardResponse
-- | The Amazon Resource Name (ARN) of the dashboard.
getDashboardResponse_dashboardArn :: Lens' GetDashboardResponse (Maybe Text)
-- | 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.
getDashboardResponse_dashboardBody :: Lens' GetDashboardResponse (Maybe Text)
-- | The name of the dashboard.
getDashboardResponse_dashboardName :: Lens' GetDashboardResponse (Maybe Text)
-- | The response's http status code.
getDashboardResponse_httpStatus :: Lens' GetDashboardResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.GetDashboard.GetDashboard
instance GHC.Show.Show Amazonka.CloudWatch.GetDashboard.GetDashboard
instance GHC.Read.Read Amazonka.CloudWatch.GetDashboard.GetDashboard
instance GHC.Classes.Eq Amazonka.CloudWatch.GetDashboard.GetDashboard
instance GHC.Generics.Generic Amazonka.CloudWatch.GetDashboard.GetDashboardResponse
instance GHC.Show.Show Amazonka.CloudWatch.GetDashboard.GetDashboardResponse
instance GHC.Read.Read Amazonka.CloudWatch.GetDashboard.GetDashboardResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.GetDashboard.GetDashboardResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.GetDashboard.GetDashboard
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetDashboard.GetDashboardResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.GetDashboard.GetDashboard
instance Control.DeepSeq.NFData Amazonka.CloudWatch.GetDashboard.GetDashboard
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.GetDashboard.GetDashboard
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.GetDashboard.GetDashboard
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.GetDashboard.GetDashboard
-- | Enables the specified Contributor Insights rules. When rules are
-- enabled, they immediately begin analyzing log data.
module Amazonka.CloudWatch.EnableInsightRules
-- | See: newEnableInsightRules smart constructor.
data EnableInsightRules
EnableInsightRules' :: [Text] -> EnableInsightRules
-- | An array of the rule names to enable. If you need to find out the
-- names of your rules, use DescribeInsightRules.
[$sel:ruleNames:EnableInsightRules'] :: EnableInsightRules -> [Text]
-- | 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.
newEnableInsightRules :: EnableInsightRules
-- | An array of the rule names to enable. If you need to find out the
-- names of your rules, use DescribeInsightRules.
enableInsightRules_ruleNames :: Lens' EnableInsightRules [Text]
-- | See: newEnableInsightRulesResponse smart constructor.
data EnableInsightRulesResponse
EnableInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> EnableInsightRulesResponse
-- | An array listing the rules that could not be enabled. You cannot
-- disable or enable built-in rules.
[$sel:failures:EnableInsightRulesResponse'] :: EnableInsightRulesResponse -> Maybe [PartialFailure]
-- | The response's http status code.
[$sel:httpStatus:EnableInsightRulesResponse'] :: EnableInsightRulesResponse -> Int
-- | 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.
newEnableInsightRulesResponse :: Int -> EnableInsightRulesResponse
-- | An array listing the rules that could not be enabled. You cannot
-- disable or enable built-in rules.
enableInsightRulesResponse_failures :: Lens' EnableInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
enableInsightRulesResponse_httpStatus :: Lens' EnableInsightRulesResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance GHC.Show.Show Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance GHC.Read.Read Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance GHC.Classes.Eq Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance GHC.Generics.Generic Amazonka.CloudWatch.EnableInsightRules.EnableInsightRulesResponse
instance GHC.Show.Show Amazonka.CloudWatch.EnableInsightRules.EnableInsightRulesResponse
instance GHC.Read.Read Amazonka.CloudWatch.EnableInsightRules.EnableInsightRulesResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.EnableInsightRules.EnableInsightRulesResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.EnableInsightRules.EnableInsightRulesResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.EnableInsightRules.EnableInsightRules
-- | Enables the actions for the specified alarms.
module Amazonka.CloudWatch.EnableAlarmActions
-- | See: newEnableAlarmActions smart constructor.
data EnableAlarmActions
EnableAlarmActions' :: [Text] -> EnableAlarmActions
-- | The names of the alarms.
[$sel:alarmNames:EnableAlarmActions'] :: EnableAlarmActions -> [Text]
-- | 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.
newEnableAlarmActions :: EnableAlarmActions
-- | The names of the alarms.
enableAlarmActions_alarmNames :: Lens' EnableAlarmActions [Text]
-- | See: newEnableAlarmActionsResponse smart constructor.
data EnableAlarmActionsResponse
EnableAlarmActionsResponse' :: EnableAlarmActionsResponse
-- | Create a value of EnableAlarmActionsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newEnableAlarmActionsResponse :: EnableAlarmActionsResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance GHC.Show.Show Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance GHC.Read.Read Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance GHC.Classes.Eq Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance GHC.Generics.Generic Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActionsResponse
instance GHC.Show.Show Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActionsResponse
instance GHC.Read.Read Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActionsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActionsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance Control.DeepSeq.NFData Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActionsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance Control.DeepSeq.NFData Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.EnableAlarmActions.EnableAlarmActions
-- | Disables the specified Contributor Insights rules. When rules are
-- disabled, they do not analyze log groups and do not incur costs.
module Amazonka.CloudWatch.DisableInsightRules
-- | See: newDisableInsightRules smart constructor.
data DisableInsightRules
DisableInsightRules' :: [Text] -> DisableInsightRules
-- | An array of the rule names to disable. If you need to find out the
-- names of your rules, use DescribeInsightRules.
[$sel:ruleNames:DisableInsightRules'] :: DisableInsightRules -> [Text]
-- | 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.
newDisableInsightRules :: DisableInsightRules
-- | An array of the rule names to disable. If you need to find out the
-- names of your rules, use DescribeInsightRules.
disableInsightRules_ruleNames :: Lens' DisableInsightRules [Text]
-- | See: newDisableInsightRulesResponse smart constructor.
data DisableInsightRulesResponse
DisableInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> DisableInsightRulesResponse
-- | An array listing the rules that could not be disabled. You cannot
-- disable built-in rules.
[$sel:failures:DisableInsightRulesResponse'] :: DisableInsightRulesResponse -> Maybe [PartialFailure]
-- | The response's http status code.
[$sel:httpStatus:DisableInsightRulesResponse'] :: DisableInsightRulesResponse -> Int
-- | 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.
newDisableInsightRulesResponse :: Int -> DisableInsightRulesResponse
-- | An array listing the rules that could not be disabled. You cannot
-- disable built-in rules.
disableInsightRulesResponse_failures :: Lens' DisableInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
disableInsightRulesResponse_httpStatus :: Lens' DisableInsightRulesResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance GHC.Show.Show Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance GHC.Read.Read Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance GHC.Classes.Eq Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance GHC.Generics.Generic Amazonka.CloudWatch.DisableInsightRules.DisableInsightRulesResponse
instance GHC.Show.Show Amazonka.CloudWatch.DisableInsightRules.DisableInsightRulesResponse
instance GHC.Read.Read Amazonka.CloudWatch.DisableInsightRules.DisableInsightRulesResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DisableInsightRules.DisableInsightRulesResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DisableInsightRules.DisableInsightRulesResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DisableInsightRules.DisableInsightRules
-- | Disables the actions for the specified alarms. When an alarm's actions
-- are disabled, the alarm actions do not execute when the alarm state
-- changes.
module Amazonka.CloudWatch.DisableAlarmActions
-- | See: newDisableAlarmActions smart constructor.
data DisableAlarmActions
DisableAlarmActions' :: [Text] -> DisableAlarmActions
-- | The names of the alarms.
[$sel:alarmNames:DisableAlarmActions'] :: DisableAlarmActions -> [Text]
-- | 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.
newDisableAlarmActions :: DisableAlarmActions
-- | The names of the alarms.
disableAlarmActions_alarmNames :: Lens' DisableAlarmActions [Text]
-- | See: newDisableAlarmActionsResponse smart constructor.
data DisableAlarmActionsResponse
DisableAlarmActionsResponse' :: DisableAlarmActionsResponse
-- | Create a value of DisableAlarmActionsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDisableAlarmActionsResponse :: DisableAlarmActionsResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance GHC.Show.Show Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance GHC.Read.Read Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance GHC.Classes.Eq Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance GHC.Generics.Generic Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActionsResponse
instance GHC.Show.Show Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActionsResponse
instance GHC.Read.Read Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActionsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActionsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActionsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DisableAlarmActions.DisableAlarmActions
-- | Returns a list of all the Contributor Insights rules in your account.
--
-- For more information about Contributor Insights, see Using
-- Contributor Insights to Analyze High-Cardinality Data.
module Amazonka.CloudWatch.DescribeInsightRules
-- | See: newDescribeInsightRules smart constructor.
data DescribeInsightRules
DescribeInsightRules' :: Maybe Natural -> Maybe Text -> DescribeInsightRules
-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default of 500 is used.
[$sel:maxResults:DescribeInsightRules'] :: DescribeInsightRules -> Maybe Natural
-- | Include this value, if it was returned by the previous operation, to
-- get the next set of rules.
[$sel:nextToken:DescribeInsightRules'] :: DescribeInsightRules -> Maybe Text
-- | 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: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.
--
-- DescribeInsightRules, describeInsightRules_nextToken -
-- Include this value, if it was returned by the previous operation, to
-- get the next set of rules.
newDescribeInsightRules :: DescribeInsightRules
-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default of 500 is used.
describeInsightRules_maxResults :: Lens' DescribeInsightRules (Maybe Natural)
-- | Include this value, if it was returned by the previous operation, to
-- get the next set of rules.
describeInsightRules_nextToken :: Lens' DescribeInsightRules (Maybe Text)
-- | See: newDescribeInsightRulesResponse smart constructor.
data DescribeInsightRulesResponse
DescribeInsightRulesResponse' :: Maybe [InsightRule] -> Maybe Text -> Int -> DescribeInsightRulesResponse
-- | The rules returned by the operation.
[$sel:insightRules:DescribeInsightRulesResponse'] :: DescribeInsightRulesResponse -> Maybe [InsightRule]
-- | If this parameter is present, it is a token that marks the start of
-- the next batch of returned results.
[$sel:nextToken:DescribeInsightRulesResponse'] :: DescribeInsightRulesResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeInsightRulesResponse'] :: DescribeInsightRulesResponse -> Int
-- | 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:insightRules:DescribeInsightRulesResponse',
-- describeInsightRulesResponse_insightRules - The rules returned
-- by the operation.
--
-- DescribeInsightRules,
-- describeInsightRulesResponse_nextToken - If this parameter is
-- present, it is a token that marks the start of the next batch of
-- returned results.
--
-- $sel:httpStatus:DescribeInsightRulesResponse',
-- describeInsightRulesResponse_httpStatus - The response's http
-- status code.
newDescribeInsightRulesResponse :: Int -> DescribeInsightRulesResponse
-- | The rules returned by the operation.
describeInsightRulesResponse_insightRules :: Lens' DescribeInsightRulesResponse (Maybe [InsightRule])
-- | If this parameter is present, it is a token that marks the start of
-- the next batch of returned results.
describeInsightRulesResponse_nextToken :: Lens' DescribeInsightRulesResponse (Maybe Text)
-- | The response's http status code.
describeInsightRulesResponse_httpStatus :: Lens' DescribeInsightRulesResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance GHC.Show.Show Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance GHC.Read.Read Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRulesResponse
instance GHC.Show.Show Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRulesResponse
instance GHC.Read.Read Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRulesResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRulesResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRulesResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DescribeInsightRules.DescribeInsightRules
-- | Lists the anomaly detection models that you have created in your
-- account. For single metric anomaly detectors, you can list all of the
-- models in your account or filter the results to only the models that
-- are related to a certain namespace, metric name, or metric dimension.
-- For metric math anomaly detectors, you can list them by adding
-- METRIC_MATH to the AnomalyDetectorTypes array. This
-- will return all metric math anomaly detectors in your account.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.DescribeAnomalyDetectors
-- | See: newDescribeAnomalyDetectors smart constructor.
data DescribeAnomalyDetectors
DescribeAnomalyDetectors' :: Maybe [AnomalyDetectorType] -> Maybe [Dimension] -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> DescribeAnomalyDetectors
-- | The anomaly detector types to request when using
-- DescribeAnomalyDetectorsInput. If empty, defaults to
-- SINGLE_METRIC.
[$sel:anomalyDetectorTypes:DescribeAnomalyDetectors'] :: DescribeAnomalyDetectors -> Maybe [AnomalyDetectorType]
-- | 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:dimensions:DescribeAnomalyDetectors'] :: DescribeAnomalyDetectors -> Maybe [Dimension]
-- | 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.
[$sel:maxResults:DescribeAnomalyDetectors'] :: DescribeAnomalyDetectors -> Maybe Natural
-- | 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:metricName:DescribeAnomalyDetectors'] :: DescribeAnomalyDetectors -> Maybe Text
-- | Limits the results to only the anomaly detection models that are
-- associated with the specified namespace.
[$sel:namespace:DescribeAnomalyDetectors'] :: DescribeAnomalyDetectors -> Maybe Text
-- | Use the token returned by the previous operation to request the next
-- page of results.
[$sel:nextToken:DescribeAnomalyDetectors'] :: DescribeAnomalyDetectors -> Maybe Text
-- | 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:anomalyDetectorTypes:DescribeAnomalyDetectors',
-- describeAnomalyDetectors_anomalyDetectorTypes - The anomaly
-- detector types to request when using
-- DescribeAnomalyDetectorsInput. If empty, defaults to
-- SINGLE_METRIC.
--
-- 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.
--
-- 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.
--
-- DescribeAnomalyDetectors,
-- describeAnomalyDetectors_namespace - Limits the results to only
-- the anomaly detection models that are associated with the specified
-- namespace.
--
-- DescribeAnomalyDetectors,
-- describeAnomalyDetectors_nextToken - Use the token returned by
-- the previous operation to request the next page of results.
newDescribeAnomalyDetectors :: DescribeAnomalyDetectors
-- | The anomaly detector types to request when using
-- DescribeAnomalyDetectorsInput. If empty, defaults to
-- SINGLE_METRIC.
describeAnomalyDetectors_anomalyDetectorTypes :: Lens' DescribeAnomalyDetectors (Maybe [AnomalyDetectorType])
-- | 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.
describeAnomalyDetectors_dimensions :: Lens' DescribeAnomalyDetectors (Maybe [Dimension])
-- | 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.
describeAnomalyDetectors_maxResults :: Lens' DescribeAnomalyDetectors (Maybe Natural)
-- | 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.
describeAnomalyDetectors_metricName :: Lens' DescribeAnomalyDetectors (Maybe Text)
-- | Limits the results to only the anomaly detection models that are
-- associated with the specified namespace.
describeAnomalyDetectors_namespace :: Lens' DescribeAnomalyDetectors (Maybe Text)
-- | Use the token returned by the previous operation to request the next
-- page of results.
describeAnomalyDetectors_nextToken :: Lens' DescribeAnomalyDetectors (Maybe Text)
-- | See: newDescribeAnomalyDetectorsResponse smart
-- constructor.
data DescribeAnomalyDetectorsResponse
DescribeAnomalyDetectorsResponse' :: Maybe [AnomalyDetector] -> Maybe Text -> Int -> DescribeAnomalyDetectorsResponse
-- | The list of anomaly detection models returned by the operation.
[$sel:anomalyDetectors:DescribeAnomalyDetectorsResponse'] :: DescribeAnomalyDetectorsResponse -> Maybe [AnomalyDetector]
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
[$sel:nextToken:DescribeAnomalyDetectorsResponse'] :: DescribeAnomalyDetectorsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeAnomalyDetectorsResponse'] :: DescribeAnomalyDetectorsResponse -> Int
-- | 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.
--
-- 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.
newDescribeAnomalyDetectorsResponse :: Int -> DescribeAnomalyDetectorsResponse
-- | The list of anomaly detection models returned by the operation.
describeAnomalyDetectorsResponse_anomalyDetectors :: Lens' DescribeAnomalyDetectorsResponse (Maybe [AnomalyDetector])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
describeAnomalyDetectorsResponse_nextToken :: Lens' DescribeAnomalyDetectorsResponse (Maybe Text)
-- | The response's http status code.
describeAnomalyDetectorsResponse_httpStatus :: Lens' DescribeAnomalyDetectorsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectorsResponse
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectorsResponse
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectorsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectorsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectorsResponse
instance Amazonka.Pager.AWSPager Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DescribeAnomalyDetectors.DescribeAnomalyDetectors
-- | Retrieves the alarms for the specified metric. To filter the results,
-- specify a statistic, period, or unit.
--
-- This operation retrieves only standard alarms that are based on the
-- specified metric. It does not return alarms based on math expressions
-- that use the specified metric, or composite alarms that use the
-- specified metric.
module Amazonka.CloudWatch.DescribeAlarmsForMetric
-- | See: newDescribeAlarmsForMetric smart constructor.
data DescribeAlarmsForMetric
DescribeAlarmsForMetric' :: Maybe [Dimension] -> Maybe Text -> Maybe Natural -> Maybe Statistic -> Maybe StandardUnit -> Text -> Text -> DescribeAlarmsForMetric
-- | 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:dimensions:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Maybe [Dimension]
-- | The percentile statistic for the metric. Specify a value between p0.0
-- and p100.
[$sel:extendedStatistic:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Maybe Text
-- | The period, in seconds, over which the statistic is applied.
[$sel:period:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Maybe Natural
-- | The statistic for the metric, other than percentiles. For percentile
-- statistics, use ExtendedStatistics.
[$sel:statistic:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Maybe Statistic
-- | The unit for the metric.
[$sel:unit:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Maybe StandardUnit
-- | The name of the metric.
[$sel:metricName:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Text
-- | The namespace of the metric.
[$sel:namespace:DescribeAlarmsForMetric'] :: DescribeAlarmsForMetric -> Text
-- | 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:
--
-- 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.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_extendedStatistic - The percentile
-- statistic for the metric. Specify a value between p0.0 and p100.
--
-- DescribeAlarmsForMetric, describeAlarmsForMetric_period
-- - The period, in seconds, over which the statistic is applied.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_statistic - The statistic for the
-- metric, other than percentiles. For percentile statistics, use
-- ExtendedStatistics.
--
-- DescribeAlarmsForMetric, describeAlarmsForMetric_unit -
-- The unit for the metric.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_metricName - The name of the metric.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_namespace - The namespace of the
-- metric.
newDescribeAlarmsForMetric :: Text -> Text -> DescribeAlarmsForMetric
-- | The dimensions associated with the metric. If the metric has any
-- associated dimensions, you must specify them in order for the call to
-- succeed.
describeAlarmsForMetric_dimensions :: Lens' DescribeAlarmsForMetric (Maybe [Dimension])
-- | The percentile statistic for the metric. Specify a value between p0.0
-- and p100.
describeAlarmsForMetric_extendedStatistic :: Lens' DescribeAlarmsForMetric (Maybe Text)
-- | The period, in seconds, over which the statistic is applied.
describeAlarmsForMetric_period :: Lens' DescribeAlarmsForMetric (Maybe Natural)
-- | The statistic for the metric, other than percentiles. For percentile
-- statistics, use ExtendedStatistics.
describeAlarmsForMetric_statistic :: Lens' DescribeAlarmsForMetric (Maybe Statistic)
-- | The unit for the metric.
describeAlarmsForMetric_unit :: Lens' DescribeAlarmsForMetric (Maybe StandardUnit)
-- | The name of the metric.
describeAlarmsForMetric_metricName :: Lens' DescribeAlarmsForMetric Text
-- | The namespace of the metric.
describeAlarmsForMetric_namespace :: Lens' DescribeAlarmsForMetric Text
-- | See: newDescribeAlarmsForMetricResponse smart
-- constructor.
data DescribeAlarmsForMetricResponse
DescribeAlarmsForMetricResponse' :: Maybe [MetricAlarm] -> Int -> DescribeAlarmsForMetricResponse
-- | The information for each alarm with the specified metric.
[$sel:metricAlarms:DescribeAlarmsForMetricResponse'] :: DescribeAlarmsForMetricResponse -> Maybe [MetricAlarm]
-- | The response's http status code.
[$sel:httpStatus:DescribeAlarmsForMetricResponse'] :: DescribeAlarmsForMetricResponse -> Int
-- | 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.
newDescribeAlarmsForMetricResponse :: Int -> DescribeAlarmsForMetricResponse
-- | The information for each alarm with the specified metric.
describeAlarmsForMetricResponse_metricAlarms :: Lens' DescribeAlarmsForMetricResponse (Maybe [MetricAlarm])
-- | The response's http status code.
describeAlarmsForMetricResponse_httpStatus :: Lens' DescribeAlarmsForMetricResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetricResponse
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetricResponse
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetricResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetricResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetricResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DescribeAlarmsForMetric.DescribeAlarmsForMetric
-- | Retrieves the specified alarms. You can filter the results by
-- specifying a prefix for the alarm name, the alarm state, or a prefix
-- for any action.
--
-- To use this operation and return information about composite alarms,
-- you must be signed on with the cloudwatch:DescribeAlarms
-- permission that is scoped to *. You can't return information
-- about composite alarms if your cloudwatch:DescribeAlarms
-- permission has a narrower scope.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.DescribeAlarms
-- | See: newDescribeAlarms smart constructor.
data DescribeAlarms
DescribeAlarms' :: Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe [AlarmType] -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe StateValue -> DescribeAlarms
-- | 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:actionPrefix:DescribeAlarms'] :: DescribeAlarms -> Maybe Text
-- | 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:alarmNamePrefix:DescribeAlarms'] :: DescribeAlarms -> Maybe Text
-- | The names of the alarms to retrieve information about.
[$sel:alarmNames:DescribeAlarms'] :: DescribeAlarms -> Maybe [Text]
-- | 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:alarmTypes:DescribeAlarms'] :: DescribeAlarms -> Maybe [AlarmType]
-- | 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.
[$sel:childrenOfAlarmName:DescribeAlarms'] :: DescribeAlarms -> Maybe Text
-- | The maximum number of alarm descriptions to retrieve.
[$sel:maxRecords:DescribeAlarms'] :: DescribeAlarms -> Maybe Natural
-- | The token returned by a previous call to indicate that there is more
-- data available.
[$sel:nextToken:DescribeAlarms'] :: DescribeAlarms -> Maybe Text
-- | 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:parentsOfAlarmName:DescribeAlarms'] :: DescribeAlarms -> Maybe Text
-- | Specify this parameter to receive information only about alarms that
-- are currently in the state that you specify.
[$sel:stateValue:DescribeAlarms'] :: DescribeAlarms -> Maybe StateValue
-- | 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: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: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:alarmNames:DescribeAlarms',
-- describeAlarms_alarmNames - The names of the alarms to retrieve
-- information about.
--
-- $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: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.
--
-- $sel:maxRecords:DescribeAlarms',
-- describeAlarms_maxRecords - The maximum number of alarm
-- descriptions to retrieve.
--
-- DescribeAlarms, describeAlarms_nextToken - The token
-- returned by a previous call to indicate that there is more data
-- available.
--
-- $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.
--
-- DescribeAlarms, describeAlarms_stateValue - Specify this
-- parameter to receive information only about alarms that are currently
-- in the state that you specify.
newDescribeAlarms :: DescribeAlarms
-- | 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.
describeAlarms_actionPrefix :: Lens' DescribeAlarms (Maybe Text)
-- | 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.
describeAlarms_alarmNamePrefix :: Lens' DescribeAlarms (Maybe Text)
-- | The names of the alarms to retrieve information about.
describeAlarms_alarmNames :: Lens' DescribeAlarms (Maybe [Text])
-- | 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.
describeAlarms_alarmTypes :: Lens' DescribeAlarms (Maybe [AlarmType])
-- | 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.
describeAlarms_childrenOfAlarmName :: Lens' DescribeAlarms (Maybe Text)
-- | The maximum number of alarm descriptions to retrieve.
describeAlarms_maxRecords :: Lens' DescribeAlarms (Maybe Natural)
-- | The token returned by a previous call to indicate that there is more
-- data available.
describeAlarms_nextToken :: Lens' DescribeAlarms (Maybe Text)
-- | 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.
describeAlarms_parentsOfAlarmName :: Lens' DescribeAlarms (Maybe Text)
-- | Specify this parameter to receive information only about alarms that
-- are currently in the state that you specify.
describeAlarms_stateValue :: Lens' DescribeAlarms (Maybe StateValue)
-- | See: newDescribeAlarmsResponse smart constructor.
data DescribeAlarmsResponse
DescribeAlarmsResponse' :: Maybe [CompositeAlarm] -> Maybe [MetricAlarm] -> Maybe Text -> Int -> DescribeAlarmsResponse
-- | The information about any composite alarms returned by the operation.
[$sel:compositeAlarms:DescribeAlarmsResponse'] :: DescribeAlarmsResponse -> Maybe [CompositeAlarm]
-- | The information about any metric alarms returned by the operation.
[$sel:metricAlarms:DescribeAlarmsResponse'] :: DescribeAlarmsResponse -> Maybe [MetricAlarm]
-- | The token that marks the start of the next batch of returned results.
[$sel:nextToken:DescribeAlarmsResponse'] :: DescribeAlarmsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeAlarmsResponse'] :: DescribeAlarmsResponse -> Int
-- | 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:compositeAlarms:DescribeAlarmsResponse',
-- describeAlarmsResponse_compositeAlarms - The information about
-- any composite alarms returned by the operation.
--
-- $sel:metricAlarms:DescribeAlarmsResponse',
-- describeAlarmsResponse_metricAlarms - The information about any
-- metric alarms returned by the operation.
--
-- 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.
newDescribeAlarmsResponse :: Int -> DescribeAlarmsResponse
-- | The information about any composite alarms returned by the operation.
describeAlarmsResponse_compositeAlarms :: Lens' DescribeAlarmsResponse (Maybe [CompositeAlarm])
-- | The information about any metric alarms returned by the operation.
describeAlarmsResponse_metricAlarms :: Lens' DescribeAlarmsResponse (Maybe [MetricAlarm])
-- | The token that marks the start of the next batch of returned results.
describeAlarmsResponse_nextToken :: Lens' DescribeAlarmsResponse (Maybe Text)
-- | The response's http status code.
describeAlarmsResponse_httpStatus :: Lens' DescribeAlarmsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAlarms.DescribeAlarmsResponse
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAlarms.DescribeAlarmsResponse
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAlarms.DescribeAlarmsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAlarms.DescribeAlarmsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAlarms.DescribeAlarmsResponse
instance Amazonka.Pager.AWSPager Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DescribeAlarms.DescribeAlarms
-- | Retrieves the history for the specified alarm. You can filter the
-- results by date range or item type. If an alarm name is not specified,
-- the histories for either all metric alarms or all composite alarms are
-- returned.
--
-- CloudWatch retains the history of an alarm even if you delete the
-- alarm.
--
-- To use this operation and return information about a composite alarm,
-- you must be signed on with the
-- cloudwatch:DescribeAlarmHistory permission that is scoped to
-- *. You can't return information about composite alarms if
-- your cloudwatch:DescribeAlarmHistory permission has a
-- narrower scope.
--
-- This operation returns paginated results.
module Amazonka.CloudWatch.DescribeAlarmHistory
-- | See: newDescribeAlarmHistory smart constructor.
data DescribeAlarmHistory
DescribeAlarmHistory' :: Maybe Text -> Maybe [AlarmType] -> Maybe ISO8601 -> Maybe HistoryItemType -> Maybe Natural -> Maybe Text -> Maybe ScanBy -> Maybe ISO8601 -> DescribeAlarmHistory
-- | The name of the alarm.
[$sel:alarmName:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe Text
-- | 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:alarmTypes:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe [AlarmType]
-- | The ending date to retrieve alarm history.
[$sel:endDate:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe ISO8601
-- | The type of alarm histories to retrieve.
[$sel:historyItemType:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe HistoryItemType
-- | The maximum number of alarm history records to retrieve.
[$sel:maxRecords:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe Natural
-- | The token returned by a previous call to indicate that there is more
-- data available.
[$sel:nextToken:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe Text
-- | 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:scanBy:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe ScanBy
-- | The starting date to retrieve alarm history.
[$sel:startDate:DescribeAlarmHistory'] :: DescribeAlarmHistory -> Maybe ISO8601
-- | 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:
--
-- DescribeAlarmHistory, describeAlarmHistory_alarmName -
-- The name of the alarm.
--
-- $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.
--
-- DescribeAlarmHistory,
-- describeAlarmHistory_historyItemType - The type of alarm
-- histories to retrieve.
--
-- $sel:maxRecords:DescribeAlarmHistory',
-- describeAlarmHistory_maxRecords - The maximum number of alarm
-- history records to retrieve.
--
-- 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:startDate:DescribeAlarmHistory',
-- describeAlarmHistory_startDate - The starting date to retrieve
-- alarm history.
newDescribeAlarmHistory :: DescribeAlarmHistory
-- | The name of the alarm.
describeAlarmHistory_alarmName :: Lens' DescribeAlarmHistory (Maybe Text)
-- | 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.
describeAlarmHistory_alarmTypes :: Lens' DescribeAlarmHistory (Maybe [AlarmType])
-- | The ending date to retrieve alarm history.
describeAlarmHistory_endDate :: Lens' DescribeAlarmHistory (Maybe UTCTime)
-- | The type of alarm histories to retrieve.
describeAlarmHistory_historyItemType :: Lens' DescribeAlarmHistory (Maybe HistoryItemType)
-- | The maximum number of alarm history records to retrieve.
describeAlarmHistory_maxRecords :: Lens' DescribeAlarmHistory (Maybe Natural)
-- | The token returned by a previous call to indicate that there is more
-- data available.
describeAlarmHistory_nextToken :: Lens' DescribeAlarmHistory (Maybe Text)
-- | 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.
describeAlarmHistory_scanBy :: Lens' DescribeAlarmHistory (Maybe ScanBy)
-- | The starting date to retrieve alarm history.
describeAlarmHistory_startDate :: Lens' DescribeAlarmHistory (Maybe UTCTime)
-- | See: newDescribeAlarmHistoryResponse smart constructor.
data DescribeAlarmHistoryResponse
DescribeAlarmHistoryResponse' :: Maybe [AlarmHistoryItem] -> Maybe Text -> Int -> DescribeAlarmHistoryResponse
-- | The alarm histories, in JSON format.
[$sel:alarmHistoryItems:DescribeAlarmHistoryResponse'] :: DescribeAlarmHistoryResponse -> Maybe [AlarmHistoryItem]
-- | The token that marks the start of the next batch of returned results.
[$sel:nextToken:DescribeAlarmHistoryResponse'] :: DescribeAlarmHistoryResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:DescribeAlarmHistoryResponse'] :: DescribeAlarmHistoryResponse -> Int
-- | 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.
--
-- 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.
newDescribeAlarmHistoryResponse :: Int -> DescribeAlarmHistoryResponse
-- | The alarm histories, in JSON format.
describeAlarmHistoryResponse_alarmHistoryItems :: Lens' DescribeAlarmHistoryResponse (Maybe [AlarmHistoryItem])
-- | The token that marks the start of the next batch of returned results.
describeAlarmHistoryResponse_nextToken :: Lens' DescribeAlarmHistoryResponse (Maybe Text)
-- | The response's http status code.
describeAlarmHistoryResponse_httpStatus :: Lens' DescribeAlarmHistoryResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance GHC.Generics.Generic Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistoryResponse
instance GHC.Show.Show Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistoryResponse
instance GHC.Read.Read Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistoryResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistoryResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistoryResponse
instance Amazonka.Pager.AWSPager Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DescribeAlarmHistory.DescribeAlarmHistory
-- | Permanently deletes the metric stream that you specify.
module Amazonka.CloudWatch.DeleteMetricStream
-- | See: newDeleteMetricStream smart constructor.
data DeleteMetricStream
DeleteMetricStream' :: Text -> DeleteMetricStream
-- | The name of the metric stream to delete.
[$sel:name:DeleteMetricStream'] :: DeleteMetricStream -> Text
-- | 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:
--
-- DeleteMetricStream, deleteMetricStream_name - The name
-- of the metric stream to delete.
newDeleteMetricStream :: Text -> DeleteMetricStream
-- | The name of the metric stream to delete.
deleteMetricStream_name :: Lens' DeleteMetricStream Text
-- | See: newDeleteMetricStreamResponse smart constructor.
data DeleteMetricStreamResponse
DeleteMetricStreamResponse' :: Int -> DeleteMetricStreamResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteMetricStreamResponse'] :: DeleteMetricStreamResponse -> Int
-- | 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.
newDeleteMetricStreamResponse :: Int -> DeleteMetricStreamResponse
-- | The response's http status code.
deleteMetricStreamResponse_httpStatus :: Lens' DeleteMetricStreamResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance GHC.Show.Show Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance GHC.Read.Read Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStreamResponse
instance GHC.Show.Show Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStreamResponse
instance GHC.Read.Read Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStreamResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStreamResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStreamResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DeleteMetricStream.DeleteMetricStream
-- | Permanently deletes the specified Contributor Insights rules.
--
-- If you create a rule, delete it, and then re-create it with the same
-- name, historical data from the first time the rule was created might
-- not be available.
module Amazonka.CloudWatch.DeleteInsightRules
-- | See: newDeleteInsightRules smart constructor.
data DeleteInsightRules
DeleteInsightRules' :: [Text] -> DeleteInsightRules
-- | An array of the rule names to delete. If you need to find out the
-- names of your rules, use DescribeInsightRules.
[$sel:ruleNames:DeleteInsightRules'] :: DeleteInsightRules -> [Text]
-- | 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.
newDeleteInsightRules :: DeleteInsightRules
-- | An array of the rule names to delete. If you need to find out the
-- names of your rules, use DescribeInsightRules.
deleteInsightRules_ruleNames :: Lens' DeleteInsightRules [Text]
-- | See: newDeleteInsightRulesResponse smart constructor.
data DeleteInsightRulesResponse
DeleteInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> DeleteInsightRulesResponse
-- | An array listing the rules that could not be deleted. You cannot
-- delete built-in rules.
[$sel:failures:DeleteInsightRulesResponse'] :: DeleteInsightRulesResponse -> Maybe [PartialFailure]
-- | The response's http status code.
[$sel:httpStatus:DeleteInsightRulesResponse'] :: DeleteInsightRulesResponse -> Int
-- | 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.
newDeleteInsightRulesResponse :: Int -> DeleteInsightRulesResponse
-- | An array listing the rules that could not be deleted. You cannot
-- delete built-in rules.
deleteInsightRulesResponse_failures :: Lens' DeleteInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
deleteInsightRulesResponse_httpStatus :: Lens' DeleteInsightRulesResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance GHC.Show.Show Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance GHC.Read.Read Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRulesResponse
instance GHC.Show.Show Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRulesResponse
instance GHC.Read.Read Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRulesResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRulesResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRulesResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DeleteInsightRules.DeleteInsightRules
-- | Deletes all dashboards that you specify. You can specify up to 100
-- dashboards to delete. If there is an error during this call, no
-- dashboards are deleted.
module Amazonka.CloudWatch.DeleteDashboards
-- | See: newDeleteDashboards smart constructor.
data DeleteDashboards
DeleteDashboards' :: [Text] -> DeleteDashboards
-- | The dashboards to be deleted. This parameter is required.
[$sel:dashboardNames:DeleteDashboards'] :: DeleteDashboards -> [Text]
-- | 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.
newDeleteDashboards :: DeleteDashboards
-- | The dashboards to be deleted. This parameter is required.
deleteDashboards_dashboardNames :: Lens' DeleteDashboards [Text]
-- | See: newDeleteDashboardsResponse smart constructor.
data DeleteDashboardsResponse
DeleteDashboardsResponse' :: Int -> DeleteDashboardsResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteDashboardsResponse'] :: DeleteDashboardsResponse -> Int
-- | 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.
newDeleteDashboardsResponse :: Int -> DeleteDashboardsResponse
-- | The response's http status code.
deleteDashboardsResponse_httpStatus :: Lens' DeleteDashboardsResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance GHC.Show.Show Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance GHC.Read.Read Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteDashboards.DeleteDashboardsResponse
instance GHC.Show.Show Amazonka.CloudWatch.DeleteDashboards.DeleteDashboardsResponse
instance GHC.Read.Read Amazonka.CloudWatch.DeleteDashboards.DeleteDashboardsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteDashboards.DeleteDashboardsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteDashboards.DeleteDashboardsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DeleteDashboards.DeleteDashboards
-- | Deletes the specified anomaly detection model from your account. For
-- more information about how to delete an anomaly detection model, see
-- Deleting an anomaly detection model in the CloudWatch User
-- Guide.
module Amazonka.CloudWatch.DeleteAnomalyDetector
-- | See: newDeleteAnomalyDetector smart constructor.
data DeleteAnomalyDetector
DeleteAnomalyDetector' :: Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe Text -> DeleteAnomalyDetector
-- | The metric dimensions associated with the anomaly detection model to
-- delete.
[$sel:dimensions:DeleteAnomalyDetector'] :: DeleteAnomalyDetector -> Maybe [Dimension]
-- | The metric math anomaly detector to be deleted.
--
-- When using MetricMathAnomalyDetector, you cannot include
-- following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the MetricMathAnomalyDetector property.
[$sel:metricMathAnomalyDetector:DeleteAnomalyDetector'] :: DeleteAnomalyDetector -> Maybe MetricMathAnomalyDetector
-- | The metric name associated with the anomaly detection model to delete.
[$sel:metricName:DeleteAnomalyDetector'] :: DeleteAnomalyDetector -> Maybe Text
-- | The namespace associated with the anomaly detection model to delete.
[$sel:namespace:DeleteAnomalyDetector'] :: DeleteAnomalyDetector -> Maybe Text
-- | A single metric anomaly detector to be deleted.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the MetricMathAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the SingleMetricAnomalyDetector property.
[$sel:singleMetricAnomalyDetector:DeleteAnomalyDetector'] :: DeleteAnomalyDetector -> Maybe SingleMetricAnomalyDetector
-- | The statistic associated with the anomaly detection model to delete.
[$sel:stat:DeleteAnomalyDetector'] :: DeleteAnomalyDetector -> Maybe Text
-- | 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:
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_dimensions
-- - The metric dimensions associated with the anomaly detection model to
-- delete.
--
-- DeleteAnomalyDetector,
-- deleteAnomalyDetector_metricMathAnomalyDetector - The metric
-- math anomaly detector to be deleted.
--
-- When using MetricMathAnomalyDetector, you cannot include
-- following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the MetricMathAnomalyDetector property.
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_metricName
-- - The metric name associated with the anomaly detection model to
-- delete.
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_namespace -
-- The namespace associated with the anomaly detection model to delete.
--
-- DeleteAnomalyDetector,
-- deleteAnomalyDetector_singleMetricAnomalyDetector - A single
-- metric anomaly detector to be deleted.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the MetricMathAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the SingleMetricAnomalyDetector property.
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_stat - The
-- statistic associated with the anomaly detection model to delete.
newDeleteAnomalyDetector :: DeleteAnomalyDetector
-- | The metric dimensions associated with the anomaly detection model to
-- delete.
deleteAnomalyDetector_dimensions :: Lens' DeleteAnomalyDetector (Maybe [Dimension])
-- | The metric math anomaly detector to be deleted.
--
-- When using MetricMathAnomalyDetector, you cannot include
-- following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the MetricMathAnomalyDetector property.
deleteAnomalyDetector_metricMathAnomalyDetector :: Lens' DeleteAnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The metric name associated with the anomaly detection model to delete.
deleteAnomalyDetector_metricName :: Lens' DeleteAnomalyDetector (Maybe Text)
-- | The namespace associated with the anomaly detection model to delete.
deleteAnomalyDetector_namespace :: Lens' DeleteAnomalyDetector (Maybe Text)
-- | A single metric anomaly detector to be deleted.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the MetricMathAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the SingleMetricAnomalyDetector property.
deleteAnomalyDetector_singleMetricAnomalyDetector :: Lens' DeleteAnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic associated with the anomaly detection model to delete.
deleteAnomalyDetector_stat :: Lens' DeleteAnomalyDetector (Maybe Text)
-- | See: newDeleteAnomalyDetectorResponse smart constructor.
data DeleteAnomalyDetectorResponse
DeleteAnomalyDetectorResponse' :: Int -> DeleteAnomalyDetectorResponse
-- | The response's http status code.
[$sel:httpStatus:DeleteAnomalyDetectorResponse'] :: DeleteAnomalyDetectorResponse -> Int
-- | 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.
newDeleteAnomalyDetectorResponse :: Int -> DeleteAnomalyDetectorResponse
-- | The response's http status code.
deleteAnomalyDetectorResponse_httpStatus :: Lens' DeleteAnomalyDetectorResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance GHC.Show.Show Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance GHC.Read.Read Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetectorResponse
instance GHC.Show.Show Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetectorResponse
instance GHC.Read.Read Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetectorResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetectorResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetectorResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DeleteAnomalyDetector.DeleteAnomalyDetector
-- | Deletes the specified alarms. You can delete up to 100 alarms in one
-- operation. However, this total can include no more than one composite
-- alarm. For example, you could delete 99 metric alarms and one
-- composite alarms with one operation, but you can't delete two
-- composite alarms with one operation.
--
-- In the event of an error, no alarms are deleted.
--
-- It is possible to create a loop or cycle of composite alarms, where
-- composite alarm A depends on composite alarm B, and composite alarm B
-- also depends on composite alarm A. In this scenario, you can't delete
-- any composite alarm that is part of the cycle because there is always
-- still a composite alarm that depends on that alarm that you want to
-- delete.
--
-- To get out of such a situation, you must break the cycle by changing
-- the rule of one of the composite alarms in the cycle to remove a
-- dependency that creates the cycle. The simplest change to make to
-- break a cycle is to change the AlarmRule of one of the alarms
-- to false.
--
-- Additionally, the evaluation of composite alarms stops if CloudWatch
-- detects a cycle in the evaluation path.
module Amazonka.CloudWatch.DeleteAlarms
-- | See: newDeleteAlarms smart constructor.
data DeleteAlarms
DeleteAlarms' :: [Text] -> DeleteAlarms
-- | The alarms to be deleted.
[$sel:alarmNames:DeleteAlarms'] :: DeleteAlarms -> [Text]
-- | 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.
newDeleteAlarms :: DeleteAlarms
-- | The alarms to be deleted.
deleteAlarms_alarmNames :: Lens' DeleteAlarms [Text]
-- | See: newDeleteAlarmsResponse smart constructor.
data DeleteAlarmsResponse
DeleteAlarmsResponse' :: DeleteAlarmsResponse
-- | Create a value of DeleteAlarmsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteAlarmsResponse :: DeleteAlarmsResponse
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance GHC.Show.Show Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance GHC.Read.Read Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance GHC.Generics.Generic Amazonka.CloudWatch.DeleteAlarms.DeleteAlarmsResponse
instance GHC.Show.Show Amazonka.CloudWatch.DeleteAlarms.DeleteAlarmsResponse
instance GHC.Read.Read Amazonka.CloudWatch.DeleteAlarms.DeleteAlarmsResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.DeleteAlarms.DeleteAlarmsResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteAlarms.DeleteAlarmsResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance Control.DeepSeq.NFData Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.DeleteAlarms.DeleteAlarms
-- | Removes one or more tags from the specified resource.
module Amazonka.CloudWatch.UntagResource
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> [Text] -> UntagResource
-- | 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:resourceARN:UntagResource'] :: UntagResource -> Text
-- | The list of tag keys to remove from the resource.
[$sel:tagKeys:UntagResource'] :: UntagResource -> [Text]
-- | 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:
--
-- 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.
newUntagResource :: Text -> UntagResource
-- | 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.
untagResource_resourceARN :: Lens' UntagResource Text
-- | The list of tag keys to remove from the resource.
untagResource_tagKeys :: Lens' UntagResource [Text]
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:UntagResourceResponse'] :: UntagResourceResponse -> Int
-- | 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.
newUntagResourceResponse :: Int -> UntagResourceResponse
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
instance GHC.Generics.Generic Amazonka.CloudWatch.UntagResource.UntagResource
instance GHC.Show.Show Amazonka.CloudWatch.UntagResource.UntagResource
instance GHC.Read.Read Amazonka.CloudWatch.UntagResource.UntagResource
instance GHC.Classes.Eq Amazonka.CloudWatch.UntagResource.UntagResource
instance GHC.Generics.Generic Amazonka.CloudWatch.UntagResource.UntagResourceResponse
instance GHC.Show.Show Amazonka.CloudWatch.UntagResource.UntagResourceResponse
instance GHC.Read.Read Amazonka.CloudWatch.UntagResource.UntagResourceResponse
instance GHC.Classes.Eq Amazonka.CloudWatch.UntagResource.UntagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.CloudWatch.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.CloudWatch.UntagResource.UntagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.CloudWatch.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.CloudWatch.UntagResource.UntagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.CloudWatch.UntagResource.UntagResource
instance Amazonka.Data.Path.ToPath Amazonka.CloudWatch.UntagResource.UntagResource
instance Amazonka.Data.Query.ToQuery Amazonka.CloudWatch.UntagResource.UntagResource
module Amazonka.CloudWatch.Lens
-- | The alarms to be deleted.
deleteAlarms_alarmNames :: Lens' DeleteAlarms [Text]
-- | The metric dimensions associated with the anomaly detection model to
-- delete.
deleteAnomalyDetector_dimensions :: Lens' DeleteAnomalyDetector (Maybe [Dimension])
-- | The metric math anomaly detector to be deleted.
--
-- When using MetricMathAnomalyDetector, you cannot include
-- following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the MetricMathAnomalyDetector property.
deleteAnomalyDetector_metricMathAnomalyDetector :: Lens' DeleteAnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The metric name associated with the anomaly detection model to delete.
deleteAnomalyDetector_metricName :: Lens' DeleteAnomalyDetector (Maybe Text)
-- | The namespace associated with the anomaly detection model to delete.
deleteAnomalyDetector_namespace :: Lens' DeleteAnomalyDetector (Maybe Text)
-- | A single metric anomaly detector to be deleted.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the MetricMathAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the SingleMetricAnomalyDetector property.
deleteAnomalyDetector_singleMetricAnomalyDetector :: Lens' DeleteAnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic associated with the anomaly detection model to delete.
deleteAnomalyDetector_stat :: Lens' DeleteAnomalyDetector (Maybe Text)
-- | The response's http status code.
deleteAnomalyDetectorResponse_httpStatus :: Lens' DeleteAnomalyDetectorResponse Int
-- | The dashboards to be deleted. This parameter is required.
deleteDashboards_dashboardNames :: Lens' DeleteDashboards [Text]
-- | The response's http status code.
deleteDashboardsResponse_httpStatus :: Lens' DeleteDashboardsResponse Int
-- | An array of the rule names to delete. If you need to find out the
-- names of your rules, use DescribeInsightRules.
deleteInsightRules_ruleNames :: Lens' DeleteInsightRules [Text]
-- | An array listing the rules that could not be deleted. You cannot
-- delete built-in rules.
deleteInsightRulesResponse_failures :: Lens' DeleteInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
deleteInsightRulesResponse_httpStatus :: Lens' DeleteInsightRulesResponse Int
-- | The name of the metric stream to delete.
deleteMetricStream_name :: Lens' DeleteMetricStream Text
-- | The response's http status code.
deleteMetricStreamResponse_httpStatus :: Lens' DeleteMetricStreamResponse Int
-- | The name of the alarm.
describeAlarmHistory_alarmName :: Lens' DescribeAlarmHistory (Maybe Text)
-- | 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.
describeAlarmHistory_alarmTypes :: Lens' DescribeAlarmHistory (Maybe [AlarmType])
-- | The ending date to retrieve alarm history.
describeAlarmHistory_endDate :: Lens' DescribeAlarmHistory (Maybe UTCTime)
-- | The type of alarm histories to retrieve.
describeAlarmHistory_historyItemType :: Lens' DescribeAlarmHistory (Maybe HistoryItemType)
-- | The maximum number of alarm history records to retrieve.
describeAlarmHistory_maxRecords :: Lens' DescribeAlarmHistory (Maybe Natural)
-- | The token returned by a previous call to indicate that there is more
-- data available.
describeAlarmHistory_nextToken :: Lens' DescribeAlarmHistory (Maybe Text)
-- | 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.
describeAlarmHistory_scanBy :: Lens' DescribeAlarmHistory (Maybe ScanBy)
-- | The starting date to retrieve alarm history.
describeAlarmHistory_startDate :: Lens' DescribeAlarmHistory (Maybe UTCTime)
-- | The alarm histories, in JSON format.
describeAlarmHistoryResponse_alarmHistoryItems :: Lens' DescribeAlarmHistoryResponse (Maybe [AlarmHistoryItem])
-- | The token that marks the start of the next batch of returned results.
describeAlarmHistoryResponse_nextToken :: Lens' DescribeAlarmHistoryResponse (Maybe Text)
-- | The response's http status code.
describeAlarmHistoryResponse_httpStatus :: Lens' DescribeAlarmHistoryResponse Int
-- | 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.
describeAlarms_actionPrefix :: Lens' DescribeAlarms (Maybe Text)
-- | 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.
describeAlarms_alarmNamePrefix :: Lens' DescribeAlarms (Maybe Text)
-- | The names of the alarms to retrieve information about.
describeAlarms_alarmNames :: Lens' DescribeAlarms (Maybe [Text])
-- | 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.
describeAlarms_alarmTypes :: Lens' DescribeAlarms (Maybe [AlarmType])
-- | 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.
describeAlarms_childrenOfAlarmName :: Lens' DescribeAlarms (Maybe Text)
-- | The maximum number of alarm descriptions to retrieve.
describeAlarms_maxRecords :: Lens' DescribeAlarms (Maybe Natural)
-- | The token returned by a previous call to indicate that there is more
-- data available.
describeAlarms_nextToken :: Lens' DescribeAlarms (Maybe Text)
-- | 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.
describeAlarms_parentsOfAlarmName :: Lens' DescribeAlarms (Maybe Text)
-- | Specify this parameter to receive information only about alarms that
-- are currently in the state that you specify.
describeAlarms_stateValue :: Lens' DescribeAlarms (Maybe StateValue)
-- | The information about any composite alarms returned by the operation.
describeAlarmsResponse_compositeAlarms :: Lens' DescribeAlarmsResponse (Maybe [CompositeAlarm])
-- | The information about any metric alarms returned by the operation.
describeAlarmsResponse_metricAlarms :: Lens' DescribeAlarmsResponse (Maybe [MetricAlarm])
-- | The token that marks the start of the next batch of returned results.
describeAlarmsResponse_nextToken :: Lens' DescribeAlarmsResponse (Maybe Text)
-- | The response's http status code.
describeAlarmsResponse_httpStatus :: Lens' DescribeAlarmsResponse Int
-- | The dimensions associated with the metric. If the metric has any
-- associated dimensions, you must specify them in order for the call to
-- succeed.
describeAlarmsForMetric_dimensions :: Lens' DescribeAlarmsForMetric (Maybe [Dimension])
-- | The percentile statistic for the metric. Specify a value between p0.0
-- and p100.
describeAlarmsForMetric_extendedStatistic :: Lens' DescribeAlarmsForMetric (Maybe Text)
-- | The period, in seconds, over which the statistic is applied.
describeAlarmsForMetric_period :: Lens' DescribeAlarmsForMetric (Maybe Natural)
-- | The statistic for the metric, other than percentiles. For percentile
-- statistics, use ExtendedStatistics.
describeAlarmsForMetric_statistic :: Lens' DescribeAlarmsForMetric (Maybe Statistic)
-- | The unit for the metric.
describeAlarmsForMetric_unit :: Lens' DescribeAlarmsForMetric (Maybe StandardUnit)
-- | The name of the metric.
describeAlarmsForMetric_metricName :: Lens' DescribeAlarmsForMetric Text
-- | The namespace of the metric.
describeAlarmsForMetric_namespace :: Lens' DescribeAlarmsForMetric Text
-- | The information for each alarm with the specified metric.
describeAlarmsForMetricResponse_metricAlarms :: Lens' DescribeAlarmsForMetricResponse (Maybe [MetricAlarm])
-- | The response's http status code.
describeAlarmsForMetricResponse_httpStatus :: Lens' DescribeAlarmsForMetricResponse Int
-- | The anomaly detector types to request when using
-- DescribeAnomalyDetectorsInput. If empty, defaults to
-- SINGLE_METRIC.
describeAnomalyDetectors_anomalyDetectorTypes :: Lens' DescribeAnomalyDetectors (Maybe [AnomalyDetectorType])
-- | 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.
describeAnomalyDetectors_dimensions :: Lens' DescribeAnomalyDetectors (Maybe [Dimension])
-- | 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.
describeAnomalyDetectors_maxResults :: Lens' DescribeAnomalyDetectors (Maybe Natural)
-- | 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.
describeAnomalyDetectors_metricName :: Lens' DescribeAnomalyDetectors (Maybe Text)
-- | Limits the results to only the anomaly detection models that are
-- associated with the specified namespace.
describeAnomalyDetectors_namespace :: Lens' DescribeAnomalyDetectors (Maybe Text)
-- | Use the token returned by the previous operation to request the next
-- page of results.
describeAnomalyDetectors_nextToken :: Lens' DescribeAnomalyDetectors (Maybe Text)
-- | The list of anomaly detection models returned by the operation.
describeAnomalyDetectorsResponse_anomalyDetectors :: Lens' DescribeAnomalyDetectorsResponse (Maybe [AnomalyDetector])
-- | A token that you can use in a subsequent operation to retrieve the
-- next set of results.
describeAnomalyDetectorsResponse_nextToken :: Lens' DescribeAnomalyDetectorsResponse (Maybe Text)
-- | The response's http status code.
describeAnomalyDetectorsResponse_httpStatus :: Lens' DescribeAnomalyDetectorsResponse Int
-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default of 500 is used.
describeInsightRules_maxResults :: Lens' DescribeInsightRules (Maybe Natural)
-- | Include this value, if it was returned by the previous operation, to
-- get the next set of rules.
describeInsightRules_nextToken :: Lens' DescribeInsightRules (Maybe Text)
-- | The rules returned by the operation.
describeInsightRulesResponse_insightRules :: Lens' DescribeInsightRulesResponse (Maybe [InsightRule])
-- | If this parameter is present, it is a token that marks the start of
-- the next batch of returned results.
describeInsightRulesResponse_nextToken :: Lens' DescribeInsightRulesResponse (Maybe Text)
-- | The response's http status code.
describeInsightRulesResponse_httpStatus :: Lens' DescribeInsightRulesResponse Int
-- | The names of the alarms.
disableAlarmActions_alarmNames :: Lens' DisableAlarmActions [Text]
-- | An array of the rule names to disable. If you need to find out the
-- names of your rules, use DescribeInsightRules.
disableInsightRules_ruleNames :: Lens' DisableInsightRules [Text]
-- | An array listing the rules that could not be disabled. You cannot
-- disable built-in rules.
disableInsightRulesResponse_failures :: Lens' DisableInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
disableInsightRulesResponse_httpStatus :: Lens' DisableInsightRulesResponse Int
-- | The names of the alarms.
enableAlarmActions_alarmNames :: Lens' EnableAlarmActions [Text]
-- | An array of the rule names to enable. If you need to find out the
-- names of your rules, use DescribeInsightRules.
enableInsightRules_ruleNames :: Lens' EnableInsightRules [Text]
-- | An array listing the rules that could not be enabled. You cannot
-- disable or enable built-in rules.
enableInsightRulesResponse_failures :: Lens' EnableInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
enableInsightRulesResponse_httpStatus :: Lens' EnableInsightRulesResponse Int
-- | The name of the dashboard to be described.
getDashboard_dashboardName :: Lens' GetDashboard Text
-- | The Amazon Resource Name (ARN) of the dashboard.
getDashboardResponse_dashboardArn :: Lens' GetDashboardResponse (Maybe Text)
-- | 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.
getDashboardResponse_dashboardBody :: Lens' GetDashboardResponse (Maybe Text)
-- | The name of the dashboard.
getDashboardResponse_dashboardName :: Lens' GetDashboardResponse (Maybe Text)
-- | The response's http status code.
getDashboardResponse_httpStatus :: Lens' GetDashboardResponse Int
-- | 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.
getInsightRuleReport_maxContributorCount :: Lens' GetInsightRuleReport (Maybe Int)
-- | 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.
--
getInsightRuleReport_metrics :: Lens' GetInsightRuleReport (Maybe [Text])
-- | Determines what statistic to use to rank the contributors. Valid
-- values are SUM and MAXIMUM.
getInsightRuleReport_orderBy :: Lens' GetInsightRuleReport (Maybe Text)
-- | The name of the rule that you want to see data from.
getInsightRuleReport_ruleName :: Lens' GetInsightRuleReport Text
-- | 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.
getInsightRuleReport_startTime :: Lens' GetInsightRuleReport UTCTime
-- | 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.
getInsightRuleReport_endTime :: Lens' GetInsightRuleReport UTCTime
-- | The period, in seconds, to use for the statistics in the
-- InsightRuleMetricDatapoint results.
getInsightRuleReport_period :: Lens' GetInsightRuleReport Natural
-- | The sum of the values from all individual contributors that match the
-- rule.
getInsightRuleReportResponse_aggregateValue :: Lens' GetInsightRuleReportResponse (Maybe Double)
-- | Specifies whether this rule aggregates contributor data by COUNT or
-- SUM.
getInsightRuleReportResponse_aggregationStatistic :: Lens' GetInsightRuleReportResponse (Maybe Text)
-- | An approximate count of the unique contributors found by this rule in
-- this time period.
getInsightRuleReportResponse_approximateUniqueCount :: Lens' GetInsightRuleReportResponse (Maybe Integer)
-- | 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.
getInsightRuleReportResponse_contributors :: Lens' GetInsightRuleReportResponse (Maybe [InsightRuleContributor])
-- | 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.
getInsightRuleReportResponse_keyLabels :: Lens' GetInsightRuleReportResponse (Maybe [Text])
-- | A time series of metric data points that matches the time period in
-- the rule request.
getInsightRuleReportResponse_metricDatapoints :: Lens' GetInsightRuleReportResponse (Maybe [InsightRuleMetricDatapoint])
-- | The response's http status code.
getInsightRuleReportResponse_httpStatus :: Lens' GetInsightRuleReportResponse Int
-- | 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.
getMetricData_labelOptions :: Lens' GetMetricData (Maybe LabelOptions)
-- | The maximum number of data points the request should return before
-- paginating. If you omit this, the default of 100,800 is used.
getMetricData_maxDatapoints :: Lens' GetMetricData (Maybe Int)
-- | Include this value, if it was returned by the previous
-- GetMetricData operation, to get the next set of data points.
getMetricData_nextToken :: Lens' GetMetricData (Maybe Text)
-- | 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.
getMetricData_scanBy :: Lens' GetMetricData (Maybe ScanBy)
-- | The metric queries to be returned. A single GetMetricData
-- call can include as many as 500 MetricDataQuery structures.
-- Each of these structures can specify either a metric to retrieve, a
-- Metrics Insights query, or a math expression to perform on retrieved
-- data.
getMetricData_metricDataQueries :: Lens' GetMetricData [MetricDataQuery]
-- | 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.
getMetricData_startTime :: Lens' GetMetricData UTCTime
-- | 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.
getMetricData_endTime :: Lens' GetMetricData UTCTime
-- | 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.
getMetricDataResponse_messages :: Lens' GetMetricDataResponse (Maybe [MessageData])
-- | The metrics that are returned, including the metric name, namespace,
-- and dimensions.
getMetricDataResponse_metricDataResults :: Lens' GetMetricDataResponse (Maybe [MetricDataResult])
-- | A token that marks the next batch of returned results.
getMetricDataResponse_nextToken :: Lens' GetMetricDataResponse (Maybe Text)
-- | The response's http status code.
getMetricDataResponse_httpStatus :: Lens' GetMetricDataResponse Int
-- | 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.
getMetricStatistics_dimensions :: Lens' GetMetricStatistics (Maybe [Dimension])
-- | 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.
getMetricStatistics_extendedStatistics :: Lens' GetMetricStatistics (Maybe (NonEmpty Text))
-- | The metric statistics, other than percentile. For percentile
-- statistics, use ExtendedStatistics. When calling
-- GetMetricStatistics, you must specify either
-- Statistics or ExtendedStatistics, but not both.
getMetricStatistics_statistics :: Lens' GetMetricStatistics (Maybe (NonEmpty Statistic))
-- | 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.
getMetricStatistics_unit :: Lens' GetMetricStatistics (Maybe StandardUnit)
-- | The namespace of the metric, with or without spaces.
getMetricStatistics_namespace :: Lens' GetMetricStatistics Text
-- | The name of the metric, with or without spaces.
getMetricStatistics_metricName :: Lens' GetMetricStatistics Text
-- | 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.
getMetricStatistics_startTime :: Lens' GetMetricStatistics UTCTime
-- | 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).
getMetricStatistics_endTime :: Lens' GetMetricStatistics UTCTime
-- | 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).
--
getMetricStatistics_period :: Lens' GetMetricStatistics Natural
-- | The data points for the specified metric.
getMetricStatisticsResponse_datapoints :: Lens' GetMetricStatisticsResponse (Maybe [Datapoint])
-- | A label for the specified metric.
getMetricStatisticsResponse_label :: Lens' GetMetricStatisticsResponse (Maybe Text)
-- | The response's http status code.
getMetricStatisticsResponse_httpStatus :: Lens' GetMetricStatisticsResponse Int
-- | The name of the metric stream to retrieve information about.
getMetricStream_name :: Lens' GetMetricStream Text
-- | The ARN of the metric stream.
getMetricStreamResponse_arn :: Lens' GetMetricStreamResponse (Maybe Text)
-- | The date that the metric stream was created.
getMetricStreamResponse_creationDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
-- | 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.
getMetricStreamResponse_excludeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
-- | The ARN of the Amazon Kinesis Data Firehose delivery stream that is
-- used by this metric stream.
getMetricStreamResponse_firehoseArn :: Lens' GetMetricStreamResponse (Maybe Text)
-- | If this array of metric namespaces is present, then these namespaces
-- are the only metric namespaces that are streamed by this metric
-- stream.
getMetricStreamResponse_includeFilters :: Lens' GetMetricStreamResponse (Maybe [MetricStreamFilter])
-- | The date of the most recent update to the metric stream's
-- configuration.
getMetricStreamResponse_lastUpdateDate :: Lens' GetMetricStreamResponse (Maybe UTCTime)
-- | The name of the metric stream.
getMetricStreamResponse_name :: Lens' GetMetricStreamResponse (Maybe Text)
-- | 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.
getMetricStreamResponse_outputFormat :: Lens' GetMetricStreamResponse (Maybe MetricStreamOutputFormat)
-- | The ARN of the IAM role that is used by this metric stream.
getMetricStreamResponse_roleArn :: Lens' GetMetricStreamResponse (Maybe Text)
-- | The state of the metric stream. The possible values are
-- running and stopped.
getMetricStreamResponse_state :: Lens' GetMetricStreamResponse (Maybe Text)
-- | Each entry in this array displays information about one or more
-- metrics that include additional statistics in the metric stream. For
-- more information about the additional statistics, see CloudWatch
-- statistics definitions.
getMetricStreamResponse_statisticsConfigurations :: Lens' GetMetricStreamResponse (Maybe [MetricStreamStatisticsConfiguration])
-- | The response's http status code.
getMetricStreamResponse_httpStatus :: Lens' GetMetricStreamResponse Int
-- | 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.
getMetricWidgetImage_outputFormat :: Lens' GetMetricWidgetImage (Maybe Text)
-- | 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.
getMetricWidgetImage_metricWidget :: Lens' GetMetricWidgetImage Text
-- | 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.
getMetricWidgetImageResponse_metricWidgetImage :: Lens' GetMetricWidgetImageResponse (Maybe ByteString)
-- | The response's http status code.
getMetricWidgetImageResponse_httpStatus :: Lens' GetMetricWidgetImageResponse Int
-- | 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 "_".
listDashboards_dashboardNamePrefix :: Lens' ListDashboards (Maybe Text)
-- | The token returned by a previous call to indicate that there is more
-- data available.
listDashboards_nextToken :: Lens' ListDashboards (Maybe Text)
-- | The list of matching dashboards.
listDashboardsResponse_dashboardEntries :: Lens' ListDashboardsResponse (Maybe [DashboardEntry])
-- | The token that marks the start of the next batch of returned results.
listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text)
-- | The response's http status code.
listDashboardsResponse_httpStatus :: Lens' ListDashboardsResponse Int
-- | The maximum number of results to return in one operation. If you omit
-- this parameter, the default number is used. The default number is
-- 100.
listManagedInsightRules_maxResults :: Lens' ListManagedInsightRules (Maybe Natural)
-- | Include this value to get the next set of rules if the value was
-- returned by the previous operation.
listManagedInsightRules_nextToken :: Lens' ListManagedInsightRules (Maybe Text)
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
listManagedInsightRules_resourceARN :: Lens' ListManagedInsightRules Text
-- | The managed rules that are available for the specified Amazon Web
-- Services resource.
listManagedInsightRulesResponse_managedRules :: Lens' ListManagedInsightRulesResponse (Maybe [ManagedRuleDescription])
-- | Include this value to get the next set of rules if the value was
-- returned by the previous operation.
listManagedInsightRulesResponse_nextToken :: Lens' ListManagedInsightRulesResponse (Maybe Text)
-- | The response's http status code.
listManagedInsightRulesResponse_httpStatus :: Lens' ListManagedInsightRulesResponse Int
-- | The maximum number of results to return in one operation.
listMetricStreams_maxResults :: Lens' ListMetricStreams (Maybe Natural)
-- | Include this value, if it was returned by the previous call, to get
-- the next set of metric streams.
listMetricStreams_nextToken :: Lens' ListMetricStreams (Maybe Text)
-- | The array of metric stream information.
listMetricStreamsResponse_entries :: Lens' ListMetricStreamsResponse (Maybe [MetricStreamEntry])
-- | 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.
listMetricStreamsResponse_nextToken :: Lens' ListMetricStreamsResponse (Maybe Text)
-- | The response's http status code.
listMetricStreamsResponse_httpStatus :: Lens' ListMetricStreamsResponse Int
-- | The dimensions to filter against. Only the dimensions that match
-- exactly will be returned.
listMetrics_dimensions :: Lens' ListMetrics (Maybe [DimensionFilter])
-- | If you are using this operation in a monitoring account, specify
-- true to include metrics from source accounts in the returned
-- data.
--
-- The default is false.
listMetrics_includeLinkedAccounts :: Lens' ListMetrics (Maybe Bool)
-- | The name of the metric to filter against. Only the metrics with names
-- that match exactly will be returned.
listMetrics_metricName :: Lens' ListMetrics (Maybe Text)
-- | The metric namespace to filter against. Only the namespace that
-- matches exactly will be returned.
listMetrics_namespace :: Lens' ListMetrics (Maybe Text)
-- | The token returned by a previous call to indicate that there is more
-- data available.
listMetrics_nextToken :: Lens' ListMetrics (Maybe Text)
-- | When you use this operation in a monitoring account, use this field to
-- return metrics only from one source account. To do so, specify that
-- source account ID in this field, and also specify true for
-- IncludeLinkedAccounts.
listMetrics_owningAccount :: Lens' ListMetrics (Maybe Text)
-- | 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.
listMetrics_recentlyActive :: Lens' ListMetrics (Maybe RecentlyActive)
-- | The metrics that match your request.
listMetricsResponse_metrics :: Lens' ListMetricsResponse (Maybe [Metric])
-- | The token that marks the start of the next batch of returned results.
listMetricsResponse_nextToken :: Lens' ListMetricsResponse (Maybe Text)
-- | If you are using this operation in a monitoring account, this array
-- contains the account IDs of the source accounts where the metrics in
-- the returned data are from.
--
-- This field is a 1:1 mapping between each metric that is returned and
-- the ID of the owning account.
listMetricsResponse_owningAccounts :: Lens' ListMetricsResponse (Maybe [Text])
-- | The response's http status code.
listMetricsResponse_httpStatus :: Lens' ListMetricsResponse Int
-- | 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.
listTagsForResource_resourceARN :: Lens' ListTagsForResource Text
-- | The list of tag keys and values associated with the resource you
-- specified.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
-- | 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.
putAnomalyDetector_configuration :: Lens' PutAnomalyDetector (Maybe AnomalyDetectorConfiguration)
-- | The metric dimensions to create the anomaly detection model for.
putAnomalyDetector_dimensions :: Lens' PutAnomalyDetector (Maybe [Dimension])
-- | The metric math anomaly detector to be created.
--
-- When using MetricMathAnomalyDetector, you cannot include the
-- following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the property MetricMathAnomalyDetector.
putAnomalyDetector_metricMathAnomalyDetector :: Lens' PutAnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The name of the metric to create the anomaly detection model for.
putAnomalyDetector_metricName :: Lens' PutAnomalyDetector (Maybe Text)
-- | The namespace of the metric to create the anomaly detection model for.
putAnomalyDetector_namespace :: Lens' PutAnomalyDetector (Maybe Text)
-- | A single metric anomaly detector to be created.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the MetricMatchAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the property SingleMetricAnomalyDetector.
putAnomalyDetector_singleMetricAnomalyDetector :: Lens' PutAnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic to use for the metric and the anomaly detection model.
putAnomalyDetector_stat :: Lens' PutAnomalyDetector (Maybe Text)
-- | The response's http status code.
putAnomalyDetectorResponse_httpStatus :: Lens' PutAnomalyDetectorResponse Int
-- | Indicates whether actions should be executed during any changes to the
-- alarm state of the composite alarm. The default is TRUE.
putCompositeAlarm_actionsEnabled :: Lens' PutCompositeAlarm (Maybe Bool)
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
putCompositeAlarm_actionsSuppressor :: Lens' PutCompositeAlarm (Maybe Text)
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
putCompositeAlarm_actionsSuppressorExtensionPeriod :: Lens' PutCompositeAlarm (Maybe Int)
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
putCompositeAlarm_actionsSuppressorWaitPeriod :: Lens' PutCompositeAlarm (Maybe Int)
-- | 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
--
putCompositeAlarm_alarmActions :: Lens' PutCompositeAlarm (Maybe [Text])
-- | The description for the composite alarm.
putCompositeAlarm_alarmDescription :: Lens' PutCompositeAlarm (Maybe Text)
-- | 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
--
putCompositeAlarm_insufficientDataActions :: Lens' PutCompositeAlarm (Maybe [Text])
-- | 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
--
putCompositeAlarm_oKActions :: Lens' PutCompositeAlarm (Maybe [Text])
-- | 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.
putCompositeAlarm_tags :: Lens' PutCompositeAlarm (Maybe [Tag])
-- | The name for the composite alarm. This name must be unique within the
-- Region.
putCompositeAlarm_alarmName :: Lens' PutCompositeAlarm Text
-- | 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.
putCompositeAlarm_alarmRule :: Lens' PutCompositeAlarm Text
-- | 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.
putDashboard_dashboardName :: Lens' PutDashboard Text
-- | 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.
putDashboard_dashboardBody :: Lens' PutDashboard Text
-- | 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.
putDashboardResponse_dashboardValidationMessages :: Lens' PutDashboardResponse (Maybe [DashboardValidationMessage])
-- | The response's http status code.
putDashboardResponse_httpStatus :: Lens' PutDashboardResponse Int
-- | The state of the rule. Valid values are ENABLED and DISABLED.
putInsightRule_ruleState :: Lens' PutInsightRule (Maybe Text)
-- | 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.
putInsightRule_tags :: Lens' PutInsightRule (Maybe [Tag])
-- | A unique name for the rule.
putInsightRule_ruleName :: Lens' PutInsightRule Text
-- | The definition of the rule, as a JSON object. For details on the valid
-- syntax, see Contributor Insights Rule Syntax.
putInsightRule_ruleDefinition :: Lens' PutInsightRule Text
-- | The response's http status code.
putInsightRuleResponse_httpStatus :: Lens' PutInsightRuleResponse Int
-- | A list of ManagedRules to enable.
putManagedInsightRules_managedRules :: Lens' PutManagedInsightRules [ManagedRule]
-- | An array that lists the rules that could not be enabled.
putManagedInsightRulesResponse_failures :: Lens' PutManagedInsightRulesResponse (Maybe [PartialFailure])
-- | The response's http status code.
putManagedInsightRulesResponse_httpStatus :: Lens' PutManagedInsightRulesResponse Int
-- | Indicates whether actions should be executed during any changes to the
-- alarm state. The default is TRUE.
putMetricAlarm_actionsEnabled :: Lens' PutMetricAlarm (Maybe Bool)
-- | 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
putMetricAlarm_alarmActions :: Lens' PutMetricAlarm (Maybe [Text])
-- | The description for the alarm.
putMetricAlarm_alarmDescription :: Lens' PutMetricAlarm (Maybe Text)
-- | 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.
putMetricAlarm_datapointsToAlarm :: Lens' PutMetricAlarm (Maybe Natural)
-- | The dimensions for the metric specified in MetricName.
putMetricAlarm_dimensions :: Lens' PutMetricAlarm (Maybe [Dimension])
-- | 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
putMetricAlarm_evaluateLowSampleCountPercentile :: Lens' PutMetricAlarm (Maybe Text)
-- | 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.
putMetricAlarm_extendedStatistic :: Lens' PutMetricAlarm (Maybe Text)
-- | 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
putMetricAlarm_insufficientDataActions :: Lens' PutMetricAlarm (Maybe [Text])
-- | 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.
putMetricAlarm_metricName :: Lens' PutMetricAlarm (Maybe Text)
-- | 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.
putMetricAlarm_metrics :: Lens' PutMetricAlarm (Maybe [MetricDataQuery])
-- | The namespace for the metric associated specified in
-- MetricName.
putMetricAlarm_namespace :: Lens' PutMetricAlarm (Maybe Text)
-- | 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
putMetricAlarm_oKActions :: Lens' PutMetricAlarm (Maybe [Text])
-- | 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.
putMetricAlarm_period :: Lens' PutMetricAlarm (Maybe Natural)
-- | 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.
putMetricAlarm_statistic :: Lens' PutMetricAlarm (Maybe Statistic)
-- | 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.
putMetricAlarm_tags :: Lens' PutMetricAlarm (Maybe [Tag])
-- | 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.
putMetricAlarm_threshold :: Lens' PutMetricAlarm (Maybe Double)
-- | 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.
putMetricAlarm_thresholdMetricId :: Lens' PutMetricAlarm (Maybe Text)
-- | Sets how this alarm is to handle missing data points. If
-- TreatMissingData is omitted, the default behavior of
-- missing is used. For more information, see Configuring How
-- CloudWatch Alarms Treats Missing Data.
--
-- Valid Values: breaching | notBreaching | ignore | missing
--
-- Alarms that evaluate metrics in the AWS/DynamoDB namespace
-- always ignore missing data even if you choose a different
-- option for TreatMissingData. When an AWS/DynamoDB
-- metric has missing data, alarms that evaluate that metric remain in
-- their current state.
putMetricAlarm_treatMissingData :: Lens' PutMetricAlarm (Maybe Text)
-- | 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 unpredictably.
--
-- We recommend omitting Unit so that you don't inadvertently
-- specify an incorrect unit that is not published for this metric. Doing
-- so causes the alarm to be stuck in the INSUFFICIENT DATA
-- state.
putMetricAlarm_unit :: Lens' PutMetricAlarm (Maybe StandardUnit)
-- | The name for the alarm. This name must be unique within the Region.
putMetricAlarm_alarmName :: Lens' PutMetricAlarm Text
-- | 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.
putMetricAlarm_evaluationPeriods :: Lens' PutMetricAlarm Natural
-- | 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.
putMetricAlarm_comparisonOperator :: Lens' PutMetricAlarm ComparisonOperator
-- | 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/
putMetricData_namespace :: Lens' PutMetricData Text
-- | The data for the metric. The array can include no more than 1000
-- metrics per call.
putMetricData_metricData :: Lens' PutMetricData [MetricDatum]
-- | 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.
putMetricStream_excludeFilters :: Lens' PutMetricStream (Maybe [MetricStreamFilter])
-- | 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.
putMetricStream_includeFilters :: Lens' PutMetricStream (Maybe [MetricStreamFilter])
-- | By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. You can use this parameter to have the
-- metric stream also send additional statistics in the stream. This
-- array can have up to 100 members.
--
-- For each entry in this array, you specify one or more metrics and the
-- list of additional statistics to stream for those metrics. The
-- additional statistics that you can stream depend on the stream's
-- OutputFormat. If the OutputFormat is json,
-- you can stream any additional statistic that is supported by
-- CloudWatch, listed in CloudWatch statistics definitions. If the
-- OutputFormat is opentelemetry0.7, you can stream
-- percentile statistics such as p95, p99.9, and so on.
putMetricStream_statisticsConfigurations :: Lens' PutMetricStream (Maybe [MetricStreamStatisticsConfiguration])
-- | 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.
putMetricStream_tags :: Lens' PutMetricStream (Maybe [Tag])
-- | 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 "_".
putMetricStream_name :: Lens' PutMetricStream Text
-- | The ARN of the Amazon Kinesis Data Firehose delivery stream to use for
-- this metric stream. This Amazon Kinesis Data Firehose delivery stream
-- must already exist and must be in the same account as the metric
-- stream.
putMetricStream_firehoseArn :: Lens' PutMetricStream Text
-- | The ARN of an IAM role that this metric stream will use to access
-- Amazon Kinesis Data Firehose resources. This IAM role must already
-- exist and must be in the same account as the metric stream. This IAM
-- role must include the following permissions:
--
--
-- - firehose:PutRecord
-- - firehose:PutRecordBatch
--
putMetricStream_roleArn :: Lens' PutMetricStream Text
-- | 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.
putMetricStream_outputFormat :: Lens' PutMetricStream MetricStreamOutputFormat
-- | The ARN of the metric stream.
putMetricStreamResponse_arn :: Lens' PutMetricStreamResponse (Maybe Text)
-- | The response's http status code.
putMetricStreamResponse_httpStatus :: Lens' PutMetricStreamResponse Int
-- | 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.
setAlarmState_stateReasonData :: Lens' SetAlarmState (Maybe Text)
-- | The name of the alarm.
setAlarmState_alarmName :: Lens' SetAlarmState Text
-- | The value of the state.
setAlarmState_stateValue :: Lens' SetAlarmState StateValue
-- | The reason that this alarm is set to this specific state, in text
-- format.
setAlarmState_stateReason :: Lens' SetAlarmState Text
-- | 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.
startMetricStreams_names :: Lens' StartMetricStreams [Text]
-- | The response's http status code.
startMetricStreamsResponse_httpStatus :: Lens' StartMetricStreamsResponse Int
-- | 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.
stopMetricStreams_names :: Lens' StopMetricStreams [Text]
-- | The response's http status code.
stopMetricStreamsResponse_httpStatus :: Lens' StopMetricStreamsResponse Int
-- | 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.
tagResource_resourceARN :: Lens' TagResource Text
-- | The list of key-value pairs to associate with the alarm.
tagResource_tags :: Lens' TagResource [Tag]
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
-- | 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.
untagResource_resourceARN :: Lens' UntagResource Text
-- | The list of tag keys to remove from the resource.
untagResource_tagKeys :: Lens' UntagResource [Text]
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
-- | The descriptive name for the alarm.
alarmHistoryItem_alarmName :: Lens' AlarmHistoryItem (Maybe Text)
-- | The type of alarm, either metric alarm or composite alarm.
alarmHistoryItem_alarmType :: Lens' AlarmHistoryItem (Maybe AlarmType)
-- | Data about the alarm, in JSON format.
alarmHistoryItem_historyData :: Lens' AlarmHistoryItem (Maybe Text)
-- | The type of alarm history item.
alarmHistoryItem_historyItemType :: Lens' AlarmHistoryItem (Maybe HistoryItemType)
-- | A summary of the alarm history, in text format.
alarmHistoryItem_historySummary :: Lens' AlarmHistoryItem (Maybe Text)
-- | The time stamp for the alarm history item.
alarmHistoryItem_timestamp :: Lens' AlarmHistoryItem (Maybe UTCTime)
-- | The configuration specifies details about how the anomaly detection
-- model is to be trained, including time ranges to exclude from use for
-- training the model, and the time zone to use for the metric.
anomalyDetector_configuration :: Lens' AnomalyDetector (Maybe AnomalyDetectorConfiguration)
-- | The metric dimensions associated with the anomaly detection model.
anomalyDetector_dimensions :: Lens' AnomalyDetector (Maybe [Dimension])
-- | The CloudWatch metric math expression for this anomaly detector.
anomalyDetector_metricMathAnomalyDetector :: Lens' AnomalyDetector (Maybe MetricMathAnomalyDetector)
-- | The name of the metric associated with the anomaly detection model.
anomalyDetector_metricName :: Lens' AnomalyDetector (Maybe Text)
-- | The namespace of the metric associated with the anomaly detection
-- model.
anomalyDetector_namespace :: Lens' AnomalyDetector (Maybe Text)
-- | The CloudWatch metric and statistic for this anomaly detector.
anomalyDetector_singleMetricAnomalyDetector :: Lens' AnomalyDetector (Maybe SingleMetricAnomalyDetector)
-- | The statistic associated with the anomaly detection model.
anomalyDetector_stat :: Lens' AnomalyDetector (Maybe Text)
-- | The current status of the anomaly detector's training. The possible
-- values are TRAINED | PENDING_TRAINING |
-- TRAINED_INSUFFICIENT_DATA
anomalyDetector_stateValue :: Lens' AnomalyDetector (Maybe AnomalyDetectorStateValue)
-- | An array of time ranges to exclude from use when the anomaly detection
-- model is trained. Use this to make sure that events that could cause
-- unusual values for the metric, such as deployments, aren't used when
-- CloudWatch creates the model.
anomalyDetectorConfiguration_excludedTimeRanges :: Lens' AnomalyDetectorConfiguration (Maybe [Range])
-- | The time zone to use for the metric. This is useful to enable the
-- model to automatically account for daylight savings time changes if
-- the metric is sensitive to such time changes.
--
-- To specify a time zone, use the name of the time zone as specified in
-- the standard tz database. For more information, see tz
-- database.
anomalyDetectorConfiguration_metricTimezone :: Lens' AnomalyDetectorConfiguration (Maybe Text)
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool)
-- | When the value is ALARM, it means that the actions are
-- suppressed because the suppressor alarm is in ALARM When the
-- value is WaitPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting for the suppressor alarm to go
-- into into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
compositeAlarm_actionsSuppressedBy :: Lens' CompositeAlarm (Maybe ActionsSuppressedBy)
-- | Captures the reason for action suppression.
compositeAlarm_actionsSuppressedReason :: Lens' CompositeAlarm (Maybe Text)
-- | Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
compositeAlarm_actionsSuppressor :: Lens' CompositeAlarm (Maybe Text)
-- | The maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
compositeAlarm_actionsSuppressorExtensionPeriod :: Lens' CompositeAlarm (Maybe Int)
-- | The maximum time in seconds that the composite alarm waits for the
-- suppressor alarm to go into the ALARM state. After this time,
-- the composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
compositeAlarm_actionsSuppressorWaitPeriod :: Lens' CompositeAlarm (Maybe Int)
-- | The actions to execute when this alarm transitions to the ALARM state
-- from any other state. Each action is specified as an Amazon Resource
-- Name (ARN).
compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text])
-- | The Amazon Resource Name (ARN) of the alarm.
compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text)
-- | The time stamp of the last update to the alarm configuration.
compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | The description of the alarm.
compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text)
-- | The name of the alarm.
compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text)
-- | The rule that this alarm uses to evaluate its alarm state.
compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the
-- INSUFFICIENT_DATA state from any other state. Each action is specified
-- as an Amazon Resource Name (ARN).
compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text])
-- | The actions to execute when this alarm transitions to the OK state
-- from any other state. Each action is specified as an Amazon Resource
-- Name (ARN).
compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text])
-- | An explanation for the alarm state, in text format.
compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text)
-- | An explanation for the alarm state, in JSON format.
compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text)
-- | The timestamp of the last change to the alarm's StateValue.
compositeAlarm_stateTransitionedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | Tracks the timestamp of any state update, even if StateValue
-- doesn't change.
compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
-- | The state value for the alarm.
compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue)
-- | The Amazon Resource Name (ARN) of the dashboard.
dashboardEntry_dashboardArn :: Lens' DashboardEntry (Maybe Text)
-- | The name of the dashboard.
dashboardEntry_dashboardName :: Lens' DashboardEntry (Maybe Text)
-- | The time stamp of when the dashboard was last modified, either by an
-- API call or through the console. This number is expressed as the
-- number of milliseconds since Jan 1, 1970 00:00:00 UTC.
dashboardEntry_lastModified :: Lens' DashboardEntry (Maybe UTCTime)
-- | The size of the dashboard, in bytes.
dashboardEntry_size :: Lens' DashboardEntry (Maybe Integer)
-- | The data path related to the message.
dashboardValidationMessage_dataPath :: Lens' DashboardValidationMessage (Maybe Text)
-- | A message describing the error or warning.
dashboardValidationMessage_message :: Lens' DashboardValidationMessage (Maybe Text)
-- | The average of the metric values that correspond to the data point.
datapoint_average :: Lens' Datapoint (Maybe Double)
-- | The percentile statistic for the data point.
datapoint_extendedStatistics :: Lens' Datapoint (Maybe (HashMap Text Double))
-- | The maximum metric value for the data point.
datapoint_maximum :: Lens' Datapoint (Maybe Double)
-- | The minimum metric value for the data point.
datapoint_minimum :: Lens' Datapoint (Maybe Double)
-- | The number of metric values that contributed to the aggregate value of
-- this data point.
datapoint_sampleCount :: Lens' Datapoint (Maybe Double)
-- | The sum of the metric values for the data point.
datapoint_sum :: Lens' Datapoint (Maybe Double)
-- | The time stamp used for the data point.
datapoint_timestamp :: Lens' Datapoint (Maybe UTCTime)
-- | The standard unit for the data point.
datapoint_unit :: Lens' Datapoint (Maybe StandardUnit)
-- | The name of the dimension. Dimension names must contain only ASCII
-- characters, must include at least one non-whitespace character, and
-- cannot start with a colon (:).
dimension_name :: Lens' Dimension Text
-- | The value of the dimension. Dimension values must contain only ASCII
-- characters and must include at least one non-whitespace character.
dimension_value :: Lens' Dimension Text
-- | The value of the dimension to be matched.
dimensionFilter_value :: Lens' DimensionFilter (Maybe Text)
-- | The dimension name to be matched.
dimensionFilter_name :: Lens' DimensionFilter Text
-- | An optional built-in rule that Amazon Web Services manages.
insightRule_managedRule :: Lens' InsightRule (Maybe Bool)
-- | The name of the rule.
insightRule_name :: Lens' InsightRule Text
-- | Indicates whether the rule is enabled or disabled.
insightRule_state :: Lens' InsightRule Text
-- | For rules that you create, this is always {"Name":
-- "CloudWatchLogRule", "Version": 1}. For managed rules, this is
-- {"Name": "ServiceLogRule", "Version": 1}
insightRule_schema :: Lens' InsightRule Text
-- | The definition of the rule, as a JSON object. The definition contains
-- the keywords used to define contributors, the value to aggregate on if
-- this rule returns a sum instead of a count, and the filters. For
-- details on the valid syntax, see Contributor Insights Rule
-- Syntax.
insightRule_definition :: Lens' InsightRule Text
-- | One of the log entry field keywords that is used to define
-- contributors for this rule.
insightRuleContributor_keys :: Lens' InsightRuleContributor [Text]
-- | An approximation of the aggregate value that comes from this
-- contributor.
insightRuleContributor_approximateAggregateValue :: Lens' InsightRuleContributor Double
-- | An array of the data points where this contributor is present. Only
-- the data points when this contributor appeared are included in the
-- array.
insightRuleContributor_datapoints :: Lens' InsightRuleContributor [InsightRuleContributorDatapoint]
-- | The timestamp of the data point.
insightRuleContributorDatapoint_timestamp :: Lens' InsightRuleContributorDatapoint UTCTime
-- | The approximate value that this contributor added during this
-- timestamp.
insightRuleContributorDatapoint_approximateValue :: Lens' InsightRuleContributorDatapoint Double
-- | The average value from all contributors during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_average :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The maximum value provided by one contributor during this timestamp.
-- Each timestamp is evaluated separately, so the identity of the max
-- contributor could be different for each timestamp.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_maxContributorValue :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The maximum value from a single occurence from a single contributor
-- during the time period represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_maximum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The minimum value from a single contributor during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_minimum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The number of occurrences that matched the rule during this data
-- point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_sampleCount :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The sum of the values from all contributors during the time period
-- represented by that data point.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_sum :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The number of unique contributors who published data during this
-- timestamp.
--
-- This statistic is returned only if you included it in the
-- Metrics array in your request.
insightRuleMetricDatapoint_uniqueContributors :: Lens' InsightRuleMetricDatapoint (Maybe Double)
-- | The timestamp of the data point.
insightRuleMetricDatapoint_timestamp :: Lens' InsightRuleMetricDatapoint UTCTime
-- | The time zone to use for metric data return in this operation. The
-- format is + or - followed by four digits. The first
-- two digits indicate the number of hours ahead or behind of UTC, and
-- the final two digits are the number of minutes. For example, +0130
-- indicates a time zone that is 1 hour and 30 minutes ahead of UTC. The
-- default is +0000.
labelOptions_timezone :: Lens' LabelOptions (Maybe Text)
-- | A list of key-value pairs that you can associate with a managed
-- Contributor Insights rule. You can associate as many as 50 tags with a
-- rule. Tags can help you organize and categorize your resources. You
-- also can use them to scope user permissions by granting a user
-- permission to access or change only the resources that have certain
-- tag values. To associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
managedRule_tags :: Lens' ManagedRule (Maybe [Tag])
-- | The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
managedRule_templateName :: Lens' ManagedRule Text
-- | The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
managedRule_resourceARN :: Lens' ManagedRule Text
-- | If a managed rule is enabled, this is the ARN for the related Amazon
-- Web Services resource.
managedRuleDescription_resourceARN :: Lens' ManagedRuleDescription (Maybe Text)
-- | Describes the state of a managed rule. If present, it contains
-- information about the Contributor Insights rule that contains
-- information about the related Amazon Web Services resource.
managedRuleDescription_ruleState :: Lens' ManagedRuleDescription (Maybe ManagedRuleState)
-- | The template name for the managed rule. Used to enable managed rules
-- using PutManagedInsightRules.
managedRuleDescription_templateName :: Lens' ManagedRuleDescription (Maybe Text)
-- | The name of the Contributor Insights rule that contains data for the
-- specified Amazon Web Services resource.
managedRuleState_ruleName :: Lens' ManagedRuleState Text
-- | Indicates whether the rule is enabled or disabled.
managedRuleState_state :: Lens' ManagedRuleState Text
-- | The error code or status code associated with the message.
messageData_code :: Lens' MessageData (Maybe Text)
-- | The message text.
messageData_value :: Lens' MessageData (Maybe Text)
-- | The dimensions for the metric.
metric_dimensions :: Lens' Metric (Maybe [Dimension])
-- | The name of the metric. This is a required field.
metric_metricName :: Lens' Metric (Maybe Text)
-- | The namespace of the metric.
metric_namespace :: Lens' Metric (Maybe Text)
-- | Indicates whether actions should be executed during any changes to the
-- alarm state.
metricAlarm_actionsEnabled :: Lens' MetricAlarm (Maybe Bool)
-- | The actions to execute when this alarm transitions to the
-- ALARM state from any other state. Each action is specified as
-- an Amazon Resource Name (ARN).
metricAlarm_alarmActions :: Lens' MetricAlarm (Maybe [Text])
-- | The Amazon Resource Name (ARN) of the alarm.
metricAlarm_alarmArn :: Lens' MetricAlarm (Maybe Text)
-- | The time stamp of the last update to the alarm configuration.
metricAlarm_alarmConfigurationUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The description of the alarm.
metricAlarm_alarmDescription :: Lens' MetricAlarm (Maybe Text)
-- | The name of the alarm.
metricAlarm_alarmName :: Lens' MetricAlarm (Maybe Text)
-- | The arithmetic operation to use when comparing the specified statistic
-- and threshold. The specified statistic value is used as the first
-- operand.
metricAlarm_comparisonOperator :: Lens' MetricAlarm (Maybe ComparisonOperator)
-- | The number of data points that must be breaching to trigger the alarm.
metricAlarm_datapointsToAlarm :: Lens' MetricAlarm (Maybe Natural)
-- | The dimensions for the metric associated with the alarm.
metricAlarm_dimensions :: Lens' MetricAlarm (Maybe [Dimension])
-- | Used only for alarms based on percentiles. If ignore, the
-- alarm state does not change during periods with too few data points to
-- be statistically significant. If evaluate or this parameter
-- is not used, the alarm is always evaluated and possibly changes state
-- no matter how many data points are available.
metricAlarm_evaluateLowSampleCountPercentile :: Lens' MetricAlarm (Maybe Text)
-- | The number of periods over which data is compared to the specified
-- threshold.
metricAlarm_evaluationPeriods :: Lens' MetricAlarm (Maybe Natural)
-- | If the value of this field is PARTIAL_DATA, the alarm is
-- being evaluated based on only partial data. This happens if the query
-- used for the alarm returns more than 10,000 metrics. For more
-- information, see Create alarms on Metrics Insights queries.
metricAlarm_evaluationState :: Lens' MetricAlarm (Maybe EvaluationState)
-- | The percentile statistic for the metric associated with the alarm.
-- Specify a value between p0.0 and p100.
metricAlarm_extendedStatistic :: Lens' MetricAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the
-- INSUFFICIENT_DATA state from any other state. Each action is
-- specified as an Amazon Resource Name (ARN).
metricAlarm_insufficientDataActions :: Lens' MetricAlarm (Maybe [Text])
-- | The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
metricAlarm_metricName :: Lens' MetricAlarm (Maybe Text)
-- | An array of MetricDataQuery structures, used in an alarm based on a
-- metric math expression. Each structure either retrieves a metric or
-- performs a math expression. One item in the Metrics array is the math
-- expression that the alarm watches. This expression by designated by
-- having ReturnData set to true.
metricAlarm_metrics :: Lens' MetricAlarm (Maybe [MetricDataQuery])
-- | The namespace of the metric associated with the alarm.
metricAlarm_namespace :: Lens' MetricAlarm (Maybe Text)
-- | The actions to execute when this alarm transitions to the OK
-- state from any other state. Each action is specified as an Amazon
-- Resource Name (ARN).
metricAlarm_oKActions :: Lens' MetricAlarm (Maybe [Text])
-- | The period, in seconds, over which the statistic is applied.
metricAlarm_period :: Lens' MetricAlarm (Maybe Natural)
-- | An explanation for the alarm state, in text format.
metricAlarm_stateReason :: Lens' MetricAlarm (Maybe Text)
-- | An explanation for the alarm state, in JSON format.
metricAlarm_stateReasonData :: Lens' MetricAlarm (Maybe Text)
-- | The date and time that the alarm's StateValue most recently
-- changed.
metricAlarm_stateTransitionedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The time stamp of the last update to the value of either the
-- StateValue or EvaluationState parameters.
metricAlarm_stateUpdatedTimestamp :: Lens' MetricAlarm (Maybe UTCTime)
-- | The state value for the alarm.
metricAlarm_stateValue :: Lens' MetricAlarm (Maybe StateValue)
-- | The statistic for the metric associated with the alarm, other than
-- percentile. For percentile statistics, use ExtendedStatistic.
metricAlarm_statistic :: Lens' MetricAlarm (Maybe Statistic)
-- | The value to compare with the specified statistic.
metricAlarm_threshold :: Lens' MetricAlarm (Maybe Double)
-- | In an alarm based on an anomaly detection model, this is the ID of the
-- ANOMALY_DETECTION_BAND function used as the threshold for the
-- alarm.
metricAlarm_thresholdMetricId :: Lens' MetricAlarm (Maybe Text)
-- | Sets how this alarm is to handle missing data points. The valid values
-- are breaching, notBreaching, ignore, and
-- missing. For more information, see Configuring how
-- CloudWatch alarms treat missing data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
metricAlarm_treatMissingData :: Lens' MetricAlarm (Maybe Text)
-- | The unit of the metric associated with the alarm.
metricAlarm_unit :: Lens' MetricAlarm (Maybe StandardUnit)
-- | The ID of the account where the metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
metricDataQuery_accountId :: Lens' MetricDataQuery (Maybe Text)
-- | This field can contain either a Metrics Insights query, or a metric
-- math expression to be performed on the returned data. For more
-- information about Metrics Insights queries, see Metrics Insights
-- query components and syntax in the Amazon CloudWatch User
-- Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
metricDataQuery_expression :: Lens' MetricDataQuery (Maybe Text)
-- | A human-readable label for this metric or expression. This is
-- especially useful if this is an expression, so that you know what the
-- value represents. If the metric or expression is shown in a CloudWatch
-- dashboard widget, the label is shown. If Label is omitted, CloudWatch
-- generates a default.
--
-- You can put dynamic expressions into a label, so that it is more
-- descriptive. For more information, see Using Dynamic Labels.
metricDataQuery_label :: Lens' MetricDataQuery (Maybe Text)
-- | The metric to be returned, along with statistics, period, and units.
-- Use this parameter only if this object is retrieving a metric and not
-- performing a math expression on returned data.
--
-- Within one MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
metricDataQuery_metricStat :: Lens' MetricDataQuery (Maybe MetricStat)
-- | The granularity, in seconds, of the returned data points. For metrics
-- with regular resolution, a period can be as short as one minute (60
-- seconds) and must be a multiple of 60. For high-resolution metrics
-- that are collected at intervals of less than one minute, the period
-- can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
-- metrics are those metrics stored by a PutMetricData operation
-- that includes a StorageResolution of 1 second.
metricDataQuery_period :: Lens' MetricDataQuery (Maybe Natural)
-- | When used in GetMetricData, this option indicates whether to
-- return the timestamps and raw data values of this metric. If you are
-- performing this call just to do math expressions and do not also need
-- the raw data returned, you can specify false. If you omit
-- this, the default of true is used.
--
-- When used in PutMetricAlarm, specify true for the
-- one expression result to use as the alarm. For all other metrics and
-- expressions in the same PutMetricAlarm operation, specify
-- ReturnData as False.
metricDataQuery_returnData :: Lens' MetricDataQuery (Maybe Bool)
-- | A short name used to tie this object to the results in the response.
-- This name must be unique within a single call to
-- GetMetricData. If you are performing math expressions on this
-- set of data, this name represents that data and can serve as a
-- variable in the mathematical expression. The valid characters are
-- letters, numbers, and underscore. The first character must be a
-- lowercase letter.
metricDataQuery_id :: Lens' MetricDataQuery Text
-- | The short name you specified to represent this metric.
metricDataResult_id :: Lens' MetricDataResult (Maybe Text)
-- | The human-readable label associated with the data.
metricDataResult_label :: Lens' MetricDataResult (Maybe Text)
-- | A list of messages with additional information about the data
-- returned.
metricDataResult_messages :: Lens' MetricDataResult (Maybe [MessageData])
-- | The status of the returned data. Complete indicates that all
-- data points in the requested time range were returned.
-- PartialData means that an incomplete set of data points were
-- returned. You can use the NextToken value that was returned
-- and repeat your request to get more data points. NextToken is
-- not returned if you are performing a math expression.
-- InternalError indicates that an error occurred. Retry your
-- request using NextToken, if present.
metricDataResult_statusCode :: Lens' MetricDataResult (Maybe StatusCode)
-- | The timestamps for the data points, formatted in Unix timestamp
-- format. The number of timestamps always matches the number of values
-- and the value for Timestamps[x] is Values[x].
metricDataResult_timestamps :: Lens' MetricDataResult (Maybe [UTCTime])
-- | The data points for the metric corresponding to Timestamps.
-- The number of values always matches the number of timestamps and the
-- timestamp for Values[x] is Timestamps[x].
metricDataResult_values :: Lens' MetricDataResult (Maybe [Double])
-- | Array of numbers that is used along with the Values array.
-- Each number in the Count array is the number of times the
-- corresponding value in the Values array occurred during the
-- period.
--
-- If you omit the Counts array, the default of 1 is used as the
-- value for each count. If you include a Counts array, it must
-- include the same amount of values as the Values array.
metricDatum_counts :: Lens' MetricDatum (Maybe [Double])
-- | The dimensions associated with the metric.
metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])
-- | The statistical values for the metric.
metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)
-- | Valid values are 1 and 60. Setting this to 1 specifies this metric as
-- a high-resolution metric, so that CloudWatch stores the metric with
-- sub-minute resolution down to one second. Setting this to 60 specifies
-- this metric as a regular-resolution metric, which CloudWatch stores at
-- 1-minute resolution. Currently, high resolution is available only for
-- custom metrics. For more information about high-resolution metrics,
-- see High-Resolution Metrics in the Amazon CloudWatch User
-- Guide.
--
-- This field is optional, if you do not specify it the default of 60 is
-- used.
metricDatum_storageResolution :: Lens' MetricDatum (Maybe Natural)
-- | The time the metric data was received, expressed as the number of
-- milliseconds since Jan 1, 1970 00:00:00 UTC.
metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime)
-- | When you are using a Put operation, this defines what unit
-- you want to use when storing the metric.
--
-- In a Get operation, this displays the unit that is used for
-- the metric.
metricDatum_unit :: Lens' MetricDatum (Maybe StandardUnit)
-- | The value for the metric.
--
-- Although the parameter accepts numbers of type Double, CloudWatch
-- rejects values that are either too small or too large. Values must be
-- in the range of -2^360 to 2^360. In addition, special values (for
-- example, NaN, +Infinity, -Infinity) are not supported.
metricDatum_value :: Lens' MetricDatum (Maybe Double)
-- | Array of numbers representing the values for the metric during the
-- period. Each unique value is listed just once in this array, and the
-- corresponding number in the Counts array specifies the number
-- of times that value occurred during the period. You can include up to
-- 150 unique values in each PutMetricData action that specifies
-- a Values array.
--
-- Although the Values array accepts numbers of type
-- Double, CloudWatch rejects values that are either too small
-- or too large. Values must be in the range of -2^360 to 2^360. In
-- addition, special values (for example, NaN, +Infinity, -Infinity) are
-- not supported.
metricDatum_values :: Lens' MetricDatum (Maybe [Double])
-- | The name of the metric.
metricDatum_metricName :: Lens' MetricDatum Text
-- | An array of metric data query structures that enables you to create an
-- anomaly detector based on the result of a metric math expression. Each
-- item in MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
metricMathAnomalyDetector_metricDataQueries :: Lens' MetricMathAnomalyDetector (Maybe [MetricDataQuery])
-- | When you are using a Put operation, this defines what unit
-- you want to use when storing the metric.
--
-- In a Get operation, if you omit Unit then all data
-- that was collected with any unit is returned, along with the
-- corresponding units that were specified when the data was reported to
-- CloudWatch. If you specify a unit, the operation returns only data
-- that was collected with that unit specified. If you specify a unit
-- that does not match the data collected, the results of the operation
-- are null. CloudWatch does not perform unit conversions.
metricStat_unit :: Lens' MetricStat (Maybe StandardUnit)
-- | The metric to return, including the metric name, namespace, and
-- dimensions.
metricStat_metric :: Lens' MetricStat Metric
-- | The granularity, in seconds, of the returned data points. For metrics
-- with regular resolution, a period can be as short as one minute (60
-- seconds) and must be a multiple of 60. For high-resolution metrics
-- that are collected at intervals of less than one minute, the period
-- can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
-- metrics are those metrics stored by a PutMetricData call that
-- includes a StorageResolution of 1 second.
--
-- If the StartTime parameter specifies a time stamp that is
-- greater than 3 hours ago, you must specify the period as follows or no
-- data points in that time range is returned:
--
--
-- - Start time between 3 hours and 15 days ago - Use a multiple of 60
-- seconds (1 minute).
-- - Start time between 15 and 63 days ago - Use a multiple of 300
-- seconds (5 minutes).
-- - Start time greater than 63 days ago - Use a multiple of 3600
-- seconds (1 hour).
--
metricStat_period :: Lens' MetricStat Natural
-- | The statistic to return. It can include any CloudWatch statistic or
-- extended statistic.
metricStat_stat :: Lens' MetricStat Text
-- | The ARN of the metric stream.
metricStreamEntry_arn :: Lens' MetricStreamEntry (Maybe Text)
-- | The date that the metric stream was originally created.
metricStreamEntry_creationDate :: Lens' MetricStreamEntry (Maybe UTCTime)
-- | The ARN of the Kinesis Firehose devlivery stream that is used for this
-- metric stream.
metricStreamEntry_firehoseArn :: Lens' MetricStreamEntry (Maybe Text)
-- | The date that the configuration of this metric stream was most
-- recently updated.
metricStreamEntry_lastUpdateDate :: Lens' MetricStreamEntry (Maybe UTCTime)
-- | The name of the metric stream.
metricStreamEntry_name :: Lens' MetricStreamEntry (Maybe Text)
-- | The output format of this metric stream. Valid values are
-- json and opentelemetry0.7.
metricStreamEntry_outputFormat :: Lens' MetricStreamEntry (Maybe MetricStreamOutputFormat)
-- | The current state of this stream. Valid values are running
-- and stopped.
metricStreamEntry_state :: Lens' MetricStreamEntry (Maybe Text)
-- | The name of the metric namespace in the filter.
metricStreamFilter_namespace :: Lens' MetricStreamFilter (Maybe Text)
-- | An array of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
metricStreamStatisticsConfiguration_includeMetrics :: Lens' MetricStreamStatisticsConfiguration [MetricStreamStatisticsMetric]
-- | The list of additional statistics that are to be streamed for the
-- metrics listed in the IncludeMetrics array in this structure.
-- This list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
metricStreamStatisticsConfiguration_additionalStatistics :: Lens' MetricStreamStatisticsConfiguration [Text]
-- | The namespace of the metric.
metricStreamStatisticsMetric_namespace :: Lens' MetricStreamStatisticsMetric Text
-- | The name of the metric.
metricStreamStatisticsMetric_metricName :: Lens' MetricStreamStatisticsMetric Text
-- | The type of error.
partialFailure_exceptionType :: Lens' PartialFailure (Maybe Text)
-- | The code of the error.
partialFailure_failureCode :: Lens' PartialFailure (Maybe Text)
-- | A description of the error.
partialFailure_failureDescription :: Lens' PartialFailure (Maybe Text)
-- | The specified rule that could not be deleted.
partialFailure_failureResource :: Lens' PartialFailure (Maybe Text)
-- | The start time of the range to exclude. The format is
-- yyyy-MM-dd'T'HH:mm:ss. For example,
-- 2019-07-01T23:59:59.
range_startTime :: Lens' Range UTCTime
-- | The end time of the range to exclude. The format is
-- yyyy-MM-dd'T'HH:mm:ss. For example,
-- 2019-07-01T23:59:59.
range_endTime :: Lens' Range UTCTime
-- | The metric dimensions to create the anomaly detection model for.
singleMetricAnomalyDetector_dimensions :: Lens' SingleMetricAnomalyDetector (Maybe [Dimension])
-- | The name of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector_metricName :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The namespace of the metric to create the anomaly detection model for.
singleMetricAnomalyDetector_namespace :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The statistic to use for the metric and anomaly detection model.
singleMetricAnomalyDetector_stat :: Lens' SingleMetricAnomalyDetector (Maybe Text)
-- | The number of samples used for the statistic set.
statisticSet_sampleCount :: Lens' StatisticSet Double
-- | The sum of values for the sample set.
statisticSet_sum :: Lens' StatisticSet Double
-- | The minimum value of the sample set.
statisticSet_minimum :: Lens' StatisticSet Double
-- | The maximum value of the sample set.
statisticSet_maximum :: Lens' StatisticSet Double
-- | 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.
tag_key :: Lens' Tag Text
-- | The value for the specified tag key.
tag_value :: Lens' Tag Text
module Amazonka.CloudWatch.Waiters
-- | Polls DescribeAlarms every 5 seconds until a successful state
-- is reached. An error is returned after 40 failed checks.
newAlarmExists :: Wait DescribeAlarms
-- | Polls DescribeAlarms every 5 seconds until a successful state
-- is reached. An error is returned after 40 failed checks.
newCompositeAlarmExists :: Wait DescribeAlarms
-- | 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.
module Amazonka.CloudWatch
-- | API version 2010-08-01 of the Amazon CloudWatch SDK
-- configuration.
defaultService :: Service
-- | More than one process tried to modify a resource at the same time.
_ConcurrentModificationException :: AsError a => Fold a ServiceError
-- | Some part of the dashboard data is invalid.
_DashboardInvalidInputError :: AsError a => Fold a ServiceError
-- | The specified dashboard does not exist.
_DashboardNotFoundError :: AsError a => Fold a ServiceError
-- | Request processing has failed due to some unknown error, exception, or
-- failure.
_InternalServiceFault :: AsError a => Fold a ServiceError
-- | Data was not syntactically valid JSON.
_InvalidFormatFault :: AsError a => Fold a ServiceError
-- | The next token specified is invalid.
_InvalidNextToken :: AsError a => Fold a ServiceError
-- | Parameters were used together that cannot be used together.
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError
-- | The value of an input parameter is bad or out-of-range.
_InvalidParameterValueException :: AsError a => Fold a ServiceError
-- | The operation exceeded one or more limits.
_LimitExceededException :: AsError a => Fold a ServiceError
-- | The quota for alarms for this customer has already been reached.
_LimitExceededFault :: AsError a => Fold a ServiceError
-- | An input parameter that is required is missing.
_MissingRequiredParameterException :: AsError a => Fold a ServiceError
-- | The named resource does not exist.
_ResourceNotFound :: AsError a => Fold a ServiceError
-- | The named resource does not exist.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | Polls DescribeAlarms every 5 seconds until a successful state
-- is reached. An error is returned after 40 failed checks.
newAlarmExists :: Wait DescribeAlarms
-- | Polls DescribeAlarms every 5 seconds until a successful state
-- is reached. An error is returned after 40 failed checks.
newCompositeAlarmExists :: Wait DescribeAlarms
-- | See: newDeleteAlarms smart constructor.
data DeleteAlarms
DeleteAlarms' :: [Text] -> DeleteAlarms
-- | 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.
newDeleteAlarms :: DeleteAlarms
-- | See: newDeleteAlarmsResponse smart constructor.
data DeleteAlarmsResponse
DeleteAlarmsResponse' :: DeleteAlarmsResponse
-- | Create a value of DeleteAlarmsResponse with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDeleteAlarmsResponse :: DeleteAlarmsResponse
-- | See: newDeleteAnomalyDetector smart constructor.
data DeleteAnomalyDetector
DeleteAnomalyDetector' :: Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe 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:
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_dimensions
-- - The metric dimensions associated with the anomaly detection model to
-- delete.
--
-- DeleteAnomalyDetector,
-- deleteAnomalyDetector_metricMathAnomalyDetector - The metric
-- math anomaly detector to be deleted.
--
-- When using MetricMathAnomalyDetector, you cannot include
-- following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the MetricMathAnomalyDetector property.
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_metricName
-- - The metric name associated with the anomaly detection model to
-- delete.
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_namespace -
-- The namespace associated with the anomaly detection model to delete.
--
-- DeleteAnomalyDetector,
-- deleteAnomalyDetector_singleMetricAnomalyDetector - A single
-- metric anomaly detector to be deleted.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- - Dimensions,
-- MetricName
-- Namespace
-- Stat
-- - the MetricMathAnomalyDetector parameters of
-- DeleteAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the SingleMetricAnomalyDetector property.
--
-- DeleteAnomalyDetector, deleteAnomalyDetector_stat - The
-- statistic associated with the anomaly detection model to delete.
newDeleteAnomalyDetector :: DeleteAnomalyDetector
-- | See: newDeleteAnomalyDetectorResponse smart constructor.
data DeleteAnomalyDetectorResponse
DeleteAnomalyDetectorResponse' :: Int -> DeleteAnomalyDetectorResponse
-- | 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.
newDeleteAnomalyDetectorResponse :: Int -> DeleteAnomalyDetectorResponse
-- | See: newDeleteDashboards smart constructor.
data DeleteDashboards
DeleteDashboards' :: [Text] -> DeleteDashboards
-- | 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.
newDeleteDashboards :: DeleteDashboards
-- | See: newDeleteDashboardsResponse smart constructor.
data DeleteDashboardsResponse
DeleteDashboardsResponse' :: Int -> DeleteDashboardsResponse
-- | 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.
newDeleteDashboardsResponse :: Int -> DeleteDashboardsResponse
-- | See: newDeleteInsightRules smart constructor.
data DeleteInsightRules
DeleteInsightRules' :: [Text] -> DeleteInsightRules
-- | 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.
newDeleteInsightRules :: DeleteInsightRules
-- | See: newDeleteInsightRulesResponse smart constructor.
data DeleteInsightRulesResponse
DeleteInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> DeleteInsightRulesResponse
-- | 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.
newDeleteInsightRulesResponse :: Int -> DeleteInsightRulesResponse
-- | See: newDeleteMetricStream smart constructor.
data DeleteMetricStream
DeleteMetricStream' :: Text -> DeleteMetricStream
-- | 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:
--
-- DeleteMetricStream, deleteMetricStream_name - The name
-- of the metric stream to delete.
newDeleteMetricStream :: Text -> DeleteMetricStream
-- | See: newDeleteMetricStreamResponse smart constructor.
data DeleteMetricStreamResponse
DeleteMetricStreamResponse' :: Int -> DeleteMetricStreamResponse
-- | 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.
newDeleteMetricStreamResponse :: Int -> DeleteMetricStreamResponse
-- | See: newDescribeAlarmHistory smart constructor.
data DescribeAlarmHistory
DescribeAlarmHistory' :: Maybe Text -> Maybe [AlarmType] -> Maybe ISO8601 -> Maybe HistoryItemType -> Maybe Natural -> Maybe Text -> Maybe ScanBy -> Maybe ISO8601 -> DescribeAlarmHistory
-- | 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:
--
-- DescribeAlarmHistory, describeAlarmHistory_alarmName -
-- The name of the alarm.
--
-- $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.
--
-- DescribeAlarmHistory,
-- describeAlarmHistory_historyItemType - The type of alarm
-- histories to retrieve.
--
-- $sel:maxRecords:DescribeAlarmHistory',
-- describeAlarmHistory_maxRecords - The maximum number of alarm
-- history records to retrieve.
--
-- 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:startDate:DescribeAlarmHistory',
-- describeAlarmHistory_startDate - The starting date to retrieve
-- alarm history.
newDescribeAlarmHistory :: DescribeAlarmHistory
-- | See: newDescribeAlarmHistoryResponse smart constructor.
data DescribeAlarmHistoryResponse
DescribeAlarmHistoryResponse' :: Maybe [AlarmHistoryItem] -> Maybe Text -> Int -> DescribeAlarmHistoryResponse
-- | 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.
--
-- 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.
newDescribeAlarmHistoryResponse :: Int -> DescribeAlarmHistoryResponse
-- | See: newDescribeAlarms smart constructor.
data DescribeAlarms
DescribeAlarms' :: Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe [AlarmType] -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe StateValue -> DescribeAlarms
-- | 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: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: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:alarmNames:DescribeAlarms',
-- describeAlarms_alarmNames - The names of the alarms to retrieve
-- information about.
--
-- $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: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.
--
-- $sel:maxRecords:DescribeAlarms',
-- describeAlarms_maxRecords - The maximum number of alarm
-- descriptions to retrieve.
--
-- DescribeAlarms, describeAlarms_nextToken - The token
-- returned by a previous call to indicate that there is more data
-- available.
--
-- $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.
--
-- DescribeAlarms, describeAlarms_stateValue - Specify this
-- parameter to receive information only about alarms that are currently
-- in the state that you specify.
newDescribeAlarms :: DescribeAlarms
-- | See: newDescribeAlarmsResponse smart constructor.
data DescribeAlarmsResponse
DescribeAlarmsResponse' :: Maybe [CompositeAlarm] -> Maybe [MetricAlarm] -> Maybe Text -> Int -> DescribeAlarmsResponse
-- | 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:compositeAlarms:DescribeAlarmsResponse',
-- describeAlarmsResponse_compositeAlarms - The information about
-- any composite alarms returned by the operation.
--
-- $sel:metricAlarms:DescribeAlarmsResponse',
-- describeAlarmsResponse_metricAlarms - The information about any
-- metric alarms returned by the operation.
--
-- 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.
newDescribeAlarmsResponse :: Int -> DescribeAlarmsResponse
-- | See: newDescribeAlarmsForMetric smart constructor.
data DescribeAlarmsForMetric
DescribeAlarmsForMetric' :: Maybe [Dimension] -> Maybe Text -> Maybe Natural -> Maybe Statistic -> Maybe StandardUnit -> 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:
--
-- 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.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_extendedStatistic - The percentile
-- statistic for the metric. Specify a value between p0.0 and p100.
--
-- DescribeAlarmsForMetric, describeAlarmsForMetric_period
-- - The period, in seconds, over which the statistic is applied.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_statistic - The statistic for the
-- metric, other than percentiles. For percentile statistics, use
-- ExtendedStatistics.
--
-- DescribeAlarmsForMetric, describeAlarmsForMetric_unit -
-- The unit for the metric.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_metricName - The name of the metric.
--
-- DescribeAlarmsForMetric,
-- describeAlarmsForMetric_namespace - The namespace of the
-- metric.
newDescribeAlarmsForMetric :: Text -> Text -> DescribeAlarmsForMetric
-- | See: newDescribeAlarmsForMetricResponse smart
-- constructor.
data DescribeAlarmsForMetricResponse
DescribeAlarmsForMetricResponse' :: Maybe [MetricAlarm] -> Int -> DescribeAlarmsForMetricResponse
-- | 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.
newDescribeAlarmsForMetricResponse :: Int -> DescribeAlarmsForMetricResponse
-- | See: newDescribeAnomalyDetectors smart constructor.
data DescribeAnomalyDetectors
DescribeAnomalyDetectors' :: Maybe [AnomalyDetectorType] -> Maybe [Dimension] -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> DescribeAnomalyDetectors
-- | 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:anomalyDetectorTypes:DescribeAnomalyDetectors',
-- describeAnomalyDetectors_anomalyDetectorTypes - The anomaly
-- detector types to request when using
-- DescribeAnomalyDetectorsInput. If empty, defaults to
-- SINGLE_METRIC.
--
-- 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.
--
-- 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.
--
-- DescribeAnomalyDetectors,
-- describeAnomalyDetectors_namespace - Limits the results to only
-- the anomaly detection models that are associated with the specified
-- namespace.
--
-- DescribeAnomalyDetectors,
-- describeAnomalyDetectors_nextToken - Use the token returned by
-- the previous operation to request the next page of results.
newDescribeAnomalyDetectors :: DescribeAnomalyDetectors
-- | See: newDescribeAnomalyDetectorsResponse smart
-- constructor.
data DescribeAnomalyDetectorsResponse
DescribeAnomalyDetectorsResponse' :: Maybe [AnomalyDetector] -> Maybe Text -> Int -> DescribeAnomalyDetectorsResponse
-- | 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.
--
-- 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.
newDescribeAnomalyDetectorsResponse :: Int -> DescribeAnomalyDetectorsResponse
-- | See: newDescribeInsightRules smart constructor.
data DescribeInsightRules
DescribeInsightRules' :: Maybe Natural -> Maybe Text -> DescribeInsightRules
-- | 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: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.
--
-- DescribeInsightRules, describeInsightRules_nextToken -
-- Include this value, if it was returned by the previous operation, to
-- get the next set of rules.
newDescribeInsightRules :: DescribeInsightRules
-- | See: newDescribeInsightRulesResponse smart constructor.
data DescribeInsightRulesResponse
DescribeInsightRulesResponse' :: Maybe [InsightRule] -> Maybe Text -> Int -> DescribeInsightRulesResponse
-- | 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:insightRules:DescribeInsightRulesResponse',
-- describeInsightRulesResponse_insightRules - The rules returned
-- by the operation.
--
-- DescribeInsightRules,
-- describeInsightRulesResponse_nextToken - If this parameter is
-- present, it is a token that marks the start of the next batch of
-- returned results.
--
-- $sel:httpStatus:DescribeInsightRulesResponse',
-- describeInsightRulesResponse_httpStatus - The response's http
-- status code.
newDescribeInsightRulesResponse :: Int -> DescribeInsightRulesResponse
-- | See: newDisableAlarmActions smart constructor.
data DisableAlarmActions
DisableAlarmActions' :: [Text] -> DisableAlarmActions
-- | 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.
newDisableAlarmActions :: DisableAlarmActions
-- | See: newDisableAlarmActionsResponse smart constructor.
data DisableAlarmActionsResponse
DisableAlarmActionsResponse' :: DisableAlarmActionsResponse
-- | Create a value of DisableAlarmActionsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newDisableAlarmActionsResponse :: DisableAlarmActionsResponse
-- | See: newDisableInsightRules smart constructor.
data DisableInsightRules
DisableInsightRules' :: [Text] -> DisableInsightRules
-- | 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.
newDisableInsightRules :: DisableInsightRules
-- | See: newDisableInsightRulesResponse smart constructor.
data DisableInsightRulesResponse
DisableInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> DisableInsightRulesResponse
-- | 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.
newDisableInsightRulesResponse :: Int -> DisableInsightRulesResponse
-- | See: newEnableAlarmActions smart constructor.
data EnableAlarmActions
EnableAlarmActions' :: [Text] -> EnableAlarmActions
-- | 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.
newEnableAlarmActions :: EnableAlarmActions
-- | See: newEnableAlarmActionsResponse smart constructor.
data EnableAlarmActionsResponse
EnableAlarmActionsResponse' :: EnableAlarmActionsResponse
-- | Create a value of EnableAlarmActionsResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newEnableAlarmActionsResponse :: EnableAlarmActionsResponse
-- | See: newEnableInsightRules smart constructor.
data EnableInsightRules
EnableInsightRules' :: [Text] -> EnableInsightRules
-- | 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.
newEnableInsightRules :: EnableInsightRules
-- | See: newEnableInsightRulesResponse smart constructor.
data EnableInsightRulesResponse
EnableInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> EnableInsightRulesResponse
-- | 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.
newEnableInsightRulesResponse :: Int -> EnableInsightRulesResponse
-- | See: newGetDashboard smart constructor.
data GetDashboard
GetDashboard' :: Text -> GetDashboard
-- | 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:
--
-- GetDashboard, getDashboard_dashboardName - The name of
-- the dashboard to be described.
newGetDashboard :: Text -> GetDashboard
-- | See: newGetDashboardResponse smart constructor.
data GetDashboardResponse
GetDashboardResponse' :: Maybe Text -> Maybe Text -> Maybe Text -> Int -> GetDashboardResponse
-- | 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:
--
-- GetDashboardResponse, getDashboardResponse_dashboardArn
-- - The Amazon Resource Name (ARN) 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.
--
-- GetDashboard, getDashboardResponse_dashboardName - The
-- name of the dashboard.
--
-- $sel:httpStatus:GetDashboardResponse',
-- getDashboardResponse_httpStatus - The response's http status
-- code.
newGetDashboardResponse :: Int -> GetDashboardResponse
-- | See: newGetInsightRuleReport smart constructor.
data GetInsightRuleReport
GetInsightRuleReport' :: Maybe Int -> Maybe [Text] -> Maybe Text -> Text -> ISO8601 -> ISO8601 -> 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.
--
-- 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.
--
-- GetInsightRuleReport, getInsightRuleReport_ruleName -
-- The name of the rule that you want to see data from.
--
-- 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.
--
-- 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.
--
-- GetInsightRuleReport, getInsightRuleReport_period - The
-- period, in seconds, to use for the statistics in the
-- InsightRuleMetricDatapoint results.
newGetInsightRuleReport :: Text -> UTCTime -> UTCTime -> Natural -> GetInsightRuleReport
-- | See: newGetInsightRuleReportResponse smart constructor.
data GetInsightRuleReportResponse
GetInsightRuleReportResponse' :: Maybe Double -> Maybe Text -> Maybe Integer -> Maybe [InsightRuleContributor] -> Maybe [Text] -> Maybe [InsightRuleMetricDatapoint] -> Int -> GetInsightRuleReportResponse
-- | 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:aggregateValue:GetInsightRuleReportResponse',
-- getInsightRuleReportResponse_aggregateValue - The sum of the
-- values from all individual contributors that match the rule.
--
-- $sel:aggregationStatistic:GetInsightRuleReportResponse',
-- getInsightRuleReportResponse_aggregationStatistic - Specifies
-- whether this rule aggregates contributor data by COUNT or SUM.
--
-- $sel:approximateUniqueCount:GetInsightRuleReportResponse',
-- getInsightRuleReportResponse_approximateUniqueCount - An
-- approximate count of the unique contributors found by this rule in
-- this time period.
--
-- $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: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: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.
newGetInsightRuleReportResponse :: Int -> GetInsightRuleReportResponse
-- | See: newGetMetricData smart constructor.
data GetMetricData
GetMetricData' :: Maybe LabelOptions -> Maybe Int -> Maybe Text -> Maybe ScanBy -> [MetricDataQuery] -> ISO8601 -> ISO8601 -> GetMetricData
-- | 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: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: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.
--
-- 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.
--
-- 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, a Metrics
-- Insights query, or a math expression to perform on retrieved data.
--
-- 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.
--
-- 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.
newGetMetricData :: UTCTime -> UTCTime -> GetMetricData
-- | See: newGetMetricDataResponse smart constructor.
data GetMetricDataResponse
GetMetricDataResponse' :: Maybe [MessageData] -> Maybe [MetricDataResult] -> Maybe Text -> Int -> GetMetricDataResponse
-- | 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:
--
-- 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:metricDataResults:GetMetricDataResponse',
-- getMetricDataResponse_metricDataResults - The metrics that are
-- returned, including the metric name, namespace, and dimensions.
--
-- GetMetricData, getMetricDataResponse_nextToken - A token
-- that marks the next batch of returned results.
--
-- $sel:httpStatus:GetMetricDataResponse',
-- getMetricDataResponse_httpStatus - The response's http status
-- code.
newGetMetricDataResponse :: Int -> GetMetricDataResponse
-- | See: newGetMetricStatistics smart constructor.
data GetMetricStatistics
GetMetricStatistics' :: Maybe [Dimension] -> Maybe (NonEmpty Text) -> Maybe (NonEmpty Statistic) -> Maybe StandardUnit -> Text -> Text -> ISO8601 -> ISO8601 -> Natural -> GetMetricStatistics
-- | 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:
--
-- 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.
--
-- 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.
--
-- 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.
--
-- GetMetricStatistics, getMetricStatistics_namespace - The
-- namespace of the metric, with or without spaces.
--
-- GetMetricStatistics, getMetricStatistics_metricName -
-- The name of the metric, with or without spaces.
--
-- 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.
--
-- 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).
--
-- 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).
--
newGetMetricStatistics :: Text -> Text -> UTCTime -> UTCTime -> Natural -> GetMetricStatistics
-- | See: newGetMetricStatisticsResponse smart constructor.
data GetMetricStatisticsResponse
GetMetricStatisticsResponse' :: Maybe [Datapoint] -> Maybe Text -> Int -> GetMetricStatisticsResponse
-- | 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:
--
-- GetMetricStatisticsResponse,
-- getMetricStatisticsResponse_datapoints - The data points for
-- the specified metric.
--
-- GetMetricStatisticsResponse,
-- getMetricStatisticsResponse_label - A label for the specified
-- metric.
--
-- $sel:httpStatus:GetMetricStatisticsResponse',
-- getMetricStatisticsResponse_httpStatus - The response's http
-- status code.
newGetMetricStatisticsResponse :: Int -> GetMetricStatisticsResponse
-- | See: newGetMetricStream smart constructor.
data GetMetricStream
GetMetricStream' :: Text -> GetMetricStream
-- | 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:
--
-- GetMetricStream, getMetricStream_name - The name of the
-- metric stream to retrieve information about.
newGetMetricStream :: Text -> GetMetricStream
-- | See: newGetMetricStreamResponse smart constructor.
data GetMetricStreamResponse
GetMetricStreamResponse' :: Maybe Text -> Maybe ISO8601 -> Maybe [MetricStreamFilter] -> Maybe Text -> Maybe [MetricStreamFilter] -> Maybe ISO8601 -> Maybe Text -> Maybe MetricStreamOutputFormat -> Maybe Text -> Maybe Text -> Maybe [MetricStreamStatisticsConfiguration] -> Int -> GetMetricStreamResponse
-- | 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:
--
-- GetMetricStreamResponse, getMetricStreamResponse_arn -
-- The ARN of the metric stream.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_creationDate - The date that the metric
-- stream was created.
--
-- $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.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_firehoseArn - The ARN of the Amazon
-- Kinesis Data Firehose delivery stream that is used by this metric
-- stream.
--
-- $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.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_lastUpdateDate - The date of the most
-- recent update to the metric stream's configuration.
--
-- GetMetricStream, getMetricStreamResponse_name - The name
-- of the metric stream.
--
-- GetMetricStreamResponse,
-- getMetricStreamResponse_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.
--
-- $sel:roleArn:GetMetricStreamResponse',
-- getMetricStreamResponse_roleArn - The ARN of the IAM role that
-- is used by this metric stream.
--
-- GetMetricStreamResponse, getMetricStreamResponse_state -
-- The state of the metric stream. The possible values are
-- running and stopped.
--
-- $sel:statisticsConfigurations:GetMetricStreamResponse',
-- getMetricStreamResponse_statisticsConfigurations - Each entry
-- in this array displays information about one or more metrics that
-- include additional statistics in the metric stream. For more
-- information about the additional statistics, see CloudWatch
-- statistics definitions.
--
-- $sel:httpStatus:GetMetricStreamResponse',
-- getMetricStreamResponse_httpStatus - The response's http status
-- code.
newGetMetricStreamResponse :: Int -> GetMetricStreamResponse
-- | See: newGetMetricWidgetImage smart constructor.
data GetMetricWidgetImage
GetMetricWidgetImage' :: Maybe Text -> Text -> GetMetricWidgetImage
-- | 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:
--
-- 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.
newGetMetricWidgetImage :: Text -> GetMetricWidgetImage
-- | See: newGetMetricWidgetImageResponse smart constructor.
data GetMetricWidgetImageResponse
GetMetricWidgetImageResponse' :: Maybe Base64 -> Int -> GetMetricWidgetImageResponse
-- | 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.
newGetMetricWidgetImageResponse :: Int -> GetMetricWidgetImageResponse
-- | See: newListDashboards smart constructor.
data ListDashboards
ListDashboards' :: Maybe Text -> Maybe Text -> ListDashboards
-- | 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 "_".
--
-- ListDashboards, listDashboards_nextToken - The token
-- returned by a previous call to indicate that there is more data
-- available.
newListDashboards :: ListDashboards
-- | See: newListDashboardsResponse smart constructor.
data ListDashboardsResponse
ListDashboardsResponse' :: Maybe [DashboardEntry] -> Maybe Text -> Int -> ListDashboardsResponse
-- | 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.
--
-- 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.
newListDashboardsResponse :: Int -> ListDashboardsResponse
-- | See: newListManagedInsightRules smart constructor.
data ListManagedInsightRules
ListManagedInsightRules' :: Maybe Natural -> Maybe Text -> Text -> ListManagedInsightRules
-- | Create a value of ListManagedInsightRules 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:maxResults:ListManagedInsightRules',
-- listManagedInsightRules_maxResults - The maximum number of
-- results to return in one operation. If you omit this parameter, the
-- default number is used. The default number is 100.
--
-- ListManagedInsightRules,
-- listManagedInsightRules_nextToken - Include this value to get
-- the next set of rules if the value was returned by the previous
-- operation.
--
-- ListManagedInsightRules,
-- listManagedInsightRules_resourceARN - The ARN of an Amazon Web
-- Services resource that has managed Contributor Insights rules.
newListManagedInsightRules :: Text -> ListManagedInsightRules
-- | See: newListManagedInsightRulesResponse smart
-- constructor.
data ListManagedInsightRulesResponse
ListManagedInsightRulesResponse' :: Maybe [ManagedRuleDescription] -> Maybe Text -> Int -> ListManagedInsightRulesResponse
-- | Create a value of ListManagedInsightRulesResponse 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:managedRules:ListManagedInsightRulesResponse',
-- listManagedInsightRulesResponse_managedRules - The managed
-- rules that are available for the specified Amazon Web Services
-- resource.
--
-- ListManagedInsightRules,
-- listManagedInsightRulesResponse_nextToken - Include this value
-- to get the next set of rules if the value was returned by the previous
-- operation.
--
-- $sel:httpStatus:ListManagedInsightRulesResponse',
-- listManagedInsightRulesResponse_httpStatus - The response's
-- http status code.
newListManagedInsightRulesResponse :: Int -> ListManagedInsightRulesResponse
-- | See: newListMetricStreams smart constructor.
data ListMetricStreams
ListMetricStreams' :: Maybe Natural -> Maybe Text -> ListMetricStreams
-- | 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:maxResults:ListMetricStreams',
-- listMetricStreams_maxResults - The maximum number of results to
-- return in one operation.
--
-- ListMetricStreams, listMetricStreams_nextToken - Include
-- this value, if it was returned by the previous call, to get the next
-- set of metric streams.
newListMetricStreams :: ListMetricStreams
-- | See: newListMetricStreamsResponse smart constructor.
data ListMetricStreamsResponse
ListMetricStreamsResponse' :: Maybe [MetricStreamEntry] -> Maybe Text -> Int -> ListMetricStreamsResponse
-- | 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.
--
-- 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.
newListMetricStreamsResponse :: Int -> ListMetricStreamsResponse
-- | See: newListMetrics smart constructor.
data ListMetrics
ListMetrics' :: Maybe [DimensionFilter] -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe RecentlyActive -> ListMetrics
-- | 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:
--
-- ListMetrics, listMetrics_dimensions - The dimensions to
-- filter against. Only the dimensions that match exactly will be
-- returned.
--
-- $sel:includeLinkedAccounts:ListMetrics',
-- listMetrics_includeLinkedAccounts - If you are using this
-- operation in a monitoring account, specify true to include
-- metrics from source accounts in the returned data.
--
-- The default is false.
--
-- ListMetrics, listMetrics_metricName - The name of the
-- metric to filter against. Only the metrics with names that match
-- exactly will be returned.
--
-- ListMetrics, listMetrics_namespace - The metric
-- namespace to filter against. Only the namespace that matches exactly
-- will be returned.
--
-- ListMetrics, listMetrics_nextToken - The token returned
-- by a previous call to indicate that there is more data available.
--
-- $sel:owningAccount:ListMetrics',
-- listMetrics_owningAccount - When you use this operation in a
-- monitoring account, use this field to return metrics only from one
-- source account. To do so, specify that source account ID in this
-- field, and also specify true for
-- IncludeLinkedAccounts.
--
-- $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.
newListMetrics :: ListMetrics
-- | See: newListMetricsResponse smart constructor.
data ListMetricsResponse
ListMetricsResponse' :: Maybe [Metric] -> Maybe Text -> Maybe [Text] -> Int -> ListMetricsResponse
-- | 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:
--
-- ListMetricsResponse, listMetricsResponse_metrics - The
-- metrics that match your request.
--
-- ListMetrics, listMetricsResponse_nextToken - The token
-- that marks the start of the next batch of returned results.
--
-- $sel:owningAccounts:ListMetricsResponse',
-- listMetricsResponse_owningAccounts - If you are using this
-- operation in a monitoring account, this array contains the account IDs
-- of the source accounts where the metrics in the returned data are
-- from.
--
-- This field is a 1:1 mapping between each metric that is returned and
-- the ID of the owning account.
--
-- $sel:httpStatus:ListMetricsResponse',
-- listMetricsResponse_httpStatus - The response's http status
-- code.
newListMetricsResponse :: Int -> ListMetricsResponse
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Text -> ListTagsForResource
-- | 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:
--
-- 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.
newListTagsForResource :: Text -> ListTagsForResource
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Maybe [Tag] -> Int -> ListTagsForResourceResponse
-- | 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:
--
-- 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.
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
-- | See: newPutAnomalyDetector smart constructor.
data PutAnomalyDetector
PutAnomalyDetector' :: Maybe AnomalyDetectorConfiguration -> Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe 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:
--
-- 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.
--
-- PutAnomalyDetector, putAnomalyDetector_dimensions - The
-- metric dimensions to create the anomaly detection model for.
--
-- PutAnomalyDetector,
-- putAnomalyDetector_metricMathAnomalyDetector - The metric math
-- anomaly detector to be created.
--
-- When using MetricMathAnomalyDetector, you cannot include the
-- following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the SingleMetricAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the metric math anomaly detector attributes as part
-- of the property MetricMathAnomalyDetector.
--
-- PutAnomalyDetector, putAnomalyDetector_metricName - The
-- name of the metric to create the anomaly detection model for.
--
-- PutAnomalyDetector, putAnomalyDetector_namespace - The
-- namespace of the metric to create the anomaly detection model for.
--
-- PutAnomalyDetector,
-- putAnomalyDetector_singleMetricAnomalyDetector - A single
-- metric anomaly detector to be created.
--
-- When using SingleMetricAnomalyDetector, you cannot include
-- the following parameters in the same operation:
--
--
-- Dimensions
-- MetricName
-- Namespace
-- Stat
-- - the MetricMatchAnomalyDetector parameters of
-- PutAnomalyDetectorInput
--
--
-- Instead, specify the single metric anomaly detector attributes as part
-- of the property SingleMetricAnomalyDetector.
--
-- PutAnomalyDetector, putAnomalyDetector_stat - The
-- statistic to use for the metric and the anomaly detection model.
newPutAnomalyDetector :: PutAnomalyDetector
-- | See: newPutAnomalyDetectorResponse smart constructor.
data PutAnomalyDetectorResponse
PutAnomalyDetectorResponse' :: Int -> PutAnomalyDetectorResponse
-- | 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.
newPutAnomalyDetectorResponse :: Int -> PutAnomalyDetectorResponse
-- | See: newPutCompositeAlarm smart constructor.
data PutCompositeAlarm
PutCompositeAlarm' :: Maybe Bool -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe [Text] -> Maybe Text -> Maybe [Text] -> Maybe [Text] -> Maybe [Tag] -> 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:
--
-- PutCompositeAlarm, putCompositeAlarm_actionsEnabled -
-- Indicates whether actions should be executed during any changes to the
-- alarm state of the composite alarm. The default is TRUE.
--
-- PutCompositeAlarm, putCompositeAlarm_actionsSuppressor -
-- Actions will be suppressed if the suppressor alarm is in the
-- ALARM state. ActionsSuppressor can be an AlarmName
-- or an Amazon Resource Name (ARN) from an existing alarm.
--
-- PutCompositeAlarm,
-- putCompositeAlarm_actionsSuppressorExtensionPeriod - The
-- maximum time in seconds that the composite alarm waits after
-- suppressor alarm goes out of the ALARM state. After this
-- time, the composite alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
--
-- PutCompositeAlarm,
-- putCompositeAlarm_actionsSuppressorWaitPeriod - The maximum
-- time in seconds that the composite alarm waits for the suppressor
-- alarm to go into the ALARM state. After this time, the
-- composite alarm performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
--
-- 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
--
--
-- PutCompositeAlarm, putCompositeAlarm_alarmDescription -
-- The description for the composite alarm.
--
-- 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
--
--
-- 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
--
--
-- 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.
--
-- PutCompositeAlarm, putCompositeAlarm_alarmName - The
-- name for the composite alarm. This name must be unique within the
-- Region.
--
-- 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.
newPutCompositeAlarm :: Text -> Text -> PutCompositeAlarm
-- | See: newPutCompositeAlarmResponse smart constructor.
data PutCompositeAlarmResponse
PutCompositeAlarmResponse' :: PutCompositeAlarmResponse
-- | Create a value of PutCompositeAlarmResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newPutCompositeAlarmResponse :: PutCompositeAlarmResponse
-- | See: newPutDashboard smart constructor.
data PutDashboard
PutDashboard' :: Text -> Text -> PutDashboard
-- | 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:
--
-- 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.
newPutDashboard :: Text -> Text -> PutDashboard
-- | See: newPutDashboardResponse smart constructor.
data PutDashboardResponse
PutDashboardResponse' :: Maybe [DashboardValidationMessage] -> Int -> PutDashboardResponse
-- | 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.
newPutDashboardResponse :: Int -> PutDashboardResponse
-- | See: newPutInsightRule smart constructor.
data PutInsightRule
PutInsightRule' :: Maybe Text -> Maybe [Tag] -> Text -> Text -> PutInsightRule
-- | 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:
--
-- PutInsightRule, putInsightRule_ruleState - The state of
-- the rule. Valid values are ENABLED and DISABLED.
--
-- 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.
--
-- 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.
newPutInsightRule :: Text -> Text -> PutInsightRule
-- | See: newPutInsightRuleResponse smart constructor.
data PutInsightRuleResponse
PutInsightRuleResponse' :: Int -> PutInsightRuleResponse
-- | 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.
newPutInsightRuleResponse :: Int -> PutInsightRuleResponse
-- | See: newPutManagedInsightRules smart constructor.
data PutManagedInsightRules
PutManagedInsightRules' :: [ManagedRule] -> PutManagedInsightRules
-- | Create a value of PutManagedInsightRules 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:managedRules:PutManagedInsightRules',
-- putManagedInsightRules_managedRules - A list of
-- ManagedRules to enable.
newPutManagedInsightRules :: PutManagedInsightRules
-- | See: newPutManagedInsightRulesResponse smart
-- constructor.
data PutManagedInsightRulesResponse
PutManagedInsightRulesResponse' :: Maybe [PartialFailure] -> Int -> PutManagedInsightRulesResponse
-- | Create a value of PutManagedInsightRulesResponse 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:PutManagedInsightRulesResponse',
-- putManagedInsightRulesResponse_failures - An array that lists
-- the rules that could not be enabled.
--
-- $sel:httpStatus:PutManagedInsightRulesResponse',
-- putManagedInsightRulesResponse_httpStatus - The response's http
-- status code.
newPutManagedInsightRulesResponse :: Int -> PutManagedInsightRulesResponse
-- | See: newPutMetricAlarm smart constructor.
data PutMetricAlarm
PutMetricAlarm' :: Maybe Bool -> Maybe [Text] -> Maybe Text -> Maybe Natural -> Maybe [Dimension] -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe [MetricDataQuery] -> Maybe Text -> Maybe [Text] -> Maybe Natural -> Maybe Statistic -> Maybe [Tag] -> Maybe Double -> Maybe Text -> Maybe Text -> Maybe StandardUnit -> 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:
--
-- PutMetricAlarm, putMetricAlarm_actionsEnabled -
-- Indicates whether actions should be executed during any changes to the
-- alarm state. The default is TRUE.
--
-- 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
--
-- PutMetricAlarm, putMetricAlarm_alarmDescription - The
-- description for the alarm.
--
-- 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.
--
-- PutMetricAlarm, putMetricAlarm_dimensions - The
-- dimensions for the metric specified in MetricName.
--
-- 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
--
-- 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.
--
-- 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
--
-- 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.
--
-- 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.
--
-- PutMetricAlarm, putMetricAlarm_namespace - The namespace
-- for the metric associated specified in MetricName.
--
-- 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
--
-- 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.
--
-- 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.
--
-- 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.
--
-- 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.
--
-- 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.
--
-- 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
--
-- Alarms that evaluate metrics in the AWS/DynamoDB namespace
-- always ignore missing data even if you choose a different
-- option for TreatMissingData. When an AWS/DynamoDB
-- metric has missing data, alarms that evaluate that metric remain in
-- their current state.
--
-- 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 unpredictably.
--
-- We recommend omitting Unit so that you don't inadvertently
-- specify an incorrect unit that is not published for this metric. Doing
-- so causes the alarm to be stuck in the INSUFFICIENT DATA
-- state.
--
-- PutMetricAlarm, putMetricAlarm_alarmName - The name for
-- the alarm. This name must be unique within the Region.
--
-- 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.
--
-- 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.
newPutMetricAlarm :: Text -> Natural -> ComparisonOperator -> PutMetricAlarm
-- | See: newPutMetricAlarmResponse smart constructor.
data PutMetricAlarmResponse
PutMetricAlarmResponse' :: PutMetricAlarmResponse
-- | Create a value of PutMetricAlarmResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newPutMetricAlarmResponse :: PutMetricAlarmResponse
-- | See: newPutMetricData smart constructor.
data PutMetricData
PutMetricData' :: Text -> [MetricDatum] -> PutMetricData
-- | 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:
--
-- 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 1000
-- metrics per call.
newPutMetricData :: Text -> PutMetricData
-- | See: newPutMetricDataResponse smart constructor.
data PutMetricDataResponse
PutMetricDataResponse' :: PutMetricDataResponse
-- | Create a value of PutMetricDataResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newPutMetricDataResponse :: PutMetricDataResponse
-- | See: newPutMetricStream smart constructor.
data PutMetricStream
PutMetricStream' :: Maybe [MetricStreamFilter] -> Maybe [MetricStreamFilter] -> Maybe [MetricStreamStatisticsConfiguration] -> Maybe [Tag] -> 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: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: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:statisticsConfigurations:PutMetricStream',
-- putMetricStream_statisticsConfigurations - By default, a metric
-- stream always sends the MAX, MIN, SUM, and
-- SAMPLECOUNT statistics for each metric that is streamed. You
-- can use this parameter to have the metric stream also send additional
-- statistics in the stream. This array can have up to 100 members.
--
-- For each entry in this array, you specify one or more metrics and the
-- list of additional statistics to stream for those metrics. The
-- additional statistics that you can stream depend on the stream's
-- OutputFormat. If the OutputFormat is json,
-- you can stream any additional statistic that is supported by
-- CloudWatch, listed in CloudWatch statistics definitions. If the
-- OutputFormat is opentelemetry0.7, you can stream
-- percentile statistics such as p95, p99.9, and so on.
--
-- 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.
--
-- 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 "_".
--
-- PutMetricStream, putMetricStream_firehoseArn - The ARN
-- of the Amazon Kinesis Data Firehose delivery stream to use for this
-- metric stream. This Amazon Kinesis Data Firehose delivery stream must
-- already exist and must be in the same account as the metric stream.
--
-- $sel:roleArn:PutMetricStream', putMetricStream_roleArn -
-- The ARN of an IAM role that this metric stream will use to access
-- Amazon Kinesis Data Firehose resources. This IAM role must already
-- exist and must be in the same account as the metric stream. This IAM
-- role must include the following permissions:
--
--
-- - firehose:PutRecord
-- - firehose:PutRecordBatch
--
--
-- 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.
newPutMetricStream :: Text -> Text -> Text -> MetricStreamOutputFormat -> PutMetricStream
-- | See: newPutMetricStreamResponse smart constructor.
data PutMetricStreamResponse
PutMetricStreamResponse' :: Maybe Text -> Int -> PutMetricStreamResponse
-- | 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:
--
-- PutMetricStreamResponse, putMetricStreamResponse_arn -
-- The ARN of the metric stream.
--
-- $sel:httpStatus:PutMetricStreamResponse',
-- putMetricStreamResponse_httpStatus - The response's http status
-- code.
newPutMetricStreamResponse :: Int -> PutMetricStreamResponse
-- | See: newSetAlarmState smart constructor.
data SetAlarmState
SetAlarmState' :: Maybe Text -> 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:
--
-- 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.
--
-- SetAlarmState, setAlarmState_alarmName - The name of the
-- alarm.
--
-- SetAlarmState, setAlarmState_stateValue - The value of
-- the state.
--
-- SetAlarmState, setAlarmState_stateReason - The reason
-- that this alarm is set to this specific state, in text format.
newSetAlarmState :: Text -> StateValue -> Text -> SetAlarmState
-- | See: newSetAlarmStateResponse smart constructor.
data SetAlarmStateResponse
SetAlarmStateResponse' :: SetAlarmStateResponse
-- | Create a value of SetAlarmStateResponse with all optional
-- fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
newSetAlarmStateResponse :: SetAlarmStateResponse
-- | See: newStartMetricStreams smart constructor.
data StartMetricStreams
StartMetricStreams' :: [Text] -> StartMetricStreams
-- | 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.
newStartMetricStreams :: StartMetricStreams
-- | See: newStartMetricStreamsResponse smart constructor.
data StartMetricStreamsResponse
StartMetricStreamsResponse' :: Int -> StartMetricStreamsResponse
-- | 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.
newStartMetricStreamsResponse :: Int -> StartMetricStreamsResponse
-- | See: newStopMetricStreams smart constructor.
data StopMetricStreams
StopMetricStreams' :: [Text] -> StopMetricStreams
-- | 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.
newStopMetricStreams :: StopMetricStreams
-- | See: newStopMetricStreamsResponse smart constructor.
data StopMetricStreamsResponse
StopMetricStreamsResponse' :: Int -> StopMetricStreamsResponse
-- | 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.
newStopMetricStreamsResponse :: Int -> StopMetricStreamsResponse
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> [Tag] -> TagResource
-- | 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:
--
-- 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.
--
-- TagResource, tagResource_tags - The list of key-value
-- pairs to associate with the alarm.
newTagResource :: Text -> TagResource
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | 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.
newTagResourceResponse :: Int -> TagResourceResponse
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> [Text] -> UntagResource
-- | 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:
--
-- 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.
newUntagResource :: Text -> UntagResource
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | 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.
newUntagResourceResponse :: Int -> UntagResourceResponse
newtype ActionsSuppressedBy
ActionsSuppressedBy' :: Text -> ActionsSuppressedBy
[fromActionsSuppressedBy] :: ActionsSuppressedBy -> Text
pattern ActionsSuppressedBy_Alarm :: ActionsSuppressedBy
pattern ActionsSuppressedBy_ExtensionPeriod :: ActionsSuppressedBy
pattern ActionsSuppressedBy_WaitPeriod :: ActionsSuppressedBy
newtype AlarmType
AlarmType' :: Text -> AlarmType
[fromAlarmType] :: AlarmType -> Text
pattern AlarmType_CompositeAlarm :: AlarmType
pattern AlarmType_MetricAlarm :: AlarmType
newtype AnomalyDetectorStateValue
AnomalyDetectorStateValue' :: Text -> AnomalyDetectorStateValue
[fromAnomalyDetectorStateValue] :: AnomalyDetectorStateValue -> Text
pattern AnomalyDetectorStateValue_PENDING_TRAINING :: AnomalyDetectorStateValue
pattern AnomalyDetectorStateValue_TRAINED :: AnomalyDetectorStateValue
pattern AnomalyDetectorStateValue_TRAINED_INSUFFICIENT_DATA :: AnomalyDetectorStateValue
newtype AnomalyDetectorType
AnomalyDetectorType' :: Text -> AnomalyDetectorType
[fromAnomalyDetectorType] :: AnomalyDetectorType -> Text
pattern AnomalyDetectorType_METRIC_MATH :: AnomalyDetectorType
pattern AnomalyDetectorType_SINGLE_METRIC :: AnomalyDetectorType
newtype ComparisonOperator
ComparisonOperator' :: Text -> ComparisonOperator
[fromComparisonOperator] :: ComparisonOperator -> Text
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 EvaluationState
EvaluationState' :: Text -> EvaluationState
[fromEvaluationState] :: EvaluationState -> Text
pattern EvaluationState_PARTIAL_DATA :: EvaluationState
newtype HistoryItemType
HistoryItemType' :: Text -> HistoryItemType
[fromHistoryItemType] :: HistoryItemType -> Text
pattern HistoryItemType_Action :: HistoryItemType
pattern HistoryItemType_ConfigurationUpdate :: HistoryItemType
pattern HistoryItemType_StateUpdate :: HistoryItemType
newtype MetricStreamOutputFormat
MetricStreamOutputFormat' :: Text -> MetricStreamOutputFormat
[fromMetricStreamOutputFormat] :: MetricStreamOutputFormat -> Text
pattern MetricStreamOutputFormat_Json :: MetricStreamOutputFormat
pattern MetricStreamOutputFormat_Opentelemetry0_7 :: MetricStreamOutputFormat
newtype RecentlyActive
RecentlyActive' :: Text -> RecentlyActive
[fromRecentlyActive] :: RecentlyActive -> Text
pattern RecentlyActive_PT3H :: RecentlyActive
newtype ScanBy
ScanBy' :: Text -> ScanBy
[fromScanBy] :: ScanBy -> Text
pattern ScanBy_TimestampAscending :: ScanBy
pattern ScanBy_TimestampDescending :: ScanBy
newtype StandardUnit
StandardUnit' :: Text -> StandardUnit
[fromStandardUnit] :: StandardUnit -> Text
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
StateValue' :: Text -> StateValue
[fromStateValue] :: StateValue -> Text
pattern StateValue_ALARM :: StateValue
pattern StateValue_INSUFFICIENT_DATA :: StateValue
pattern StateValue_OK :: StateValue
newtype Statistic
Statistic' :: Text -> Statistic
[fromStatistic] :: Statistic -> Text
pattern Statistic_Average :: Statistic
pattern Statistic_Maximum :: Statistic
pattern Statistic_Minimum :: Statistic
pattern Statistic_SampleCount :: Statistic
pattern Statistic_Sum :: Statistic
newtype StatusCode
StatusCode' :: Text -> StatusCode
[fromStatusCode] :: StatusCode -> Text
pattern StatusCode_Complete :: StatusCode
pattern StatusCode_Forbidden :: StatusCode
pattern StatusCode_InternalError :: StatusCode
pattern StatusCode_PartialData :: StatusCode
-- | Represents the history of a specific alarm.
--
-- See: newAlarmHistoryItem smart constructor.
data AlarmHistoryItem
AlarmHistoryItem' :: Maybe Text -> Maybe AlarmType -> Maybe Text -> Maybe HistoryItemType -> Maybe Text -> Maybe ISO8601 -> AlarmHistoryItem
-- | 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:alarmType:AlarmHistoryItem',
-- alarmHistoryItem_alarmType - The type of alarm, either metric
-- alarm or composite alarm.
--
-- $sel:historyData:AlarmHistoryItem',
-- alarmHistoryItem_historyData - Data about the alarm, in JSON
-- format.
--
-- $sel:historyItemType:AlarmHistoryItem',
-- alarmHistoryItem_historyItemType - The type of alarm history
-- item.
--
-- $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.
newAlarmHistoryItem :: AlarmHistoryItem
-- | An anomaly detection model associated with a particular CloudWatch
-- metric, statistic, or metric math expression. You can use the model to
-- display a band of expected, normal values when the metric is graphed.
--
-- See: newAnomalyDetector smart constructor.
data AnomalyDetector
AnomalyDetector' :: Maybe AnomalyDetectorConfiguration -> Maybe [Dimension] -> Maybe MetricMathAnomalyDetector -> Maybe Text -> Maybe Text -> Maybe SingleMetricAnomalyDetector -> Maybe Text -> Maybe AnomalyDetectorStateValue -> AnomalyDetector
-- | 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: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.
--
-- AnomalyDetector, anomalyDetector_dimensions - The metric
-- dimensions associated with the anomaly detection model.
--
-- $sel:metricMathAnomalyDetector:AnomalyDetector',
-- anomalyDetector_metricMathAnomalyDetector - The CloudWatch
-- metric math expression for this anomaly detector.
--
-- AnomalyDetector, anomalyDetector_metricName - The name
-- of the metric associated with the anomaly detection model.
--
-- AnomalyDetector, anomalyDetector_namespace - The
-- namespace of the metric associated with the anomaly detection model.
--
-- $sel:singleMetricAnomalyDetector:AnomalyDetector',
-- anomalyDetector_singleMetricAnomalyDetector - The CloudWatch
-- metric and statistic for this anomaly detector.
--
-- AnomalyDetector, anomalyDetector_stat - The statistic
-- 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
newAnomalyDetector :: AnomalyDetector
-- | 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.
data AnomalyDetectorConfiguration
AnomalyDetectorConfiguration' :: Maybe [Range] -> Maybe Text -> AnomalyDetectorConfiguration
-- | 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: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.
--
-- $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.
newAnomalyDetectorConfiguration :: AnomalyDetectorConfiguration
-- | The details about a composite alarm.
--
-- See: newCompositeAlarm smart constructor.
data CompositeAlarm
CompositeAlarm' :: Maybe Bool -> Maybe ActionsSuppressedBy -> Maybe Text -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe [Text] -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Text] -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe ISO8601 -> Maybe StateValue -> CompositeAlarm
-- | 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:actionsEnabled:CompositeAlarm',
-- compositeAlarm_actionsEnabled - Indicates whether actions
-- should be executed during any changes to the alarm state.
--
-- $sel:actionsSuppressedBy:CompositeAlarm',
-- compositeAlarm_actionsSuppressedBy - When the value is
-- ALARM, it means that the actions are suppressed because the
-- suppressor alarm is in ALARM When the value is
-- WaitPeriod, it means that the actions are suppressed because
-- the composite alarm is waiting for the suppressor alarm to go into
-- into the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorWaitPeriod. After this time,
-- the composite alarm performs its actions. When the value is
-- ExtensionPeriod, it means that the actions are suppressed
-- because the composite alarm is waiting after the suppressor alarm went
-- out of the ALARM state. The maximum waiting time is as
-- specified in ActionsSuppressorExtensionPeriod. After this
-- time, the composite alarm performs its actions.
--
-- $sel:actionsSuppressedReason:CompositeAlarm',
-- compositeAlarm_actionsSuppressedReason - Captures the reason
-- for action suppression.
--
-- $sel:actionsSuppressor:CompositeAlarm',
-- compositeAlarm_actionsSuppressor - Actions will be suppressed
-- if the suppressor alarm is in the ALARM state.
-- ActionsSuppressor can be an AlarmName or an Amazon Resource
-- Name (ARN) from an existing alarm.
--
-- $sel:actionsSuppressorExtensionPeriod:CompositeAlarm',
-- compositeAlarm_actionsSuppressorExtensionPeriod - The maximum
-- time in seconds that the composite alarm waits after suppressor alarm
-- goes out of the ALARM state. After this time, the composite
-- alarm performs its actions.
--
-- ExtensionPeriod is required only when
-- ActionsSuppressor is specified.
--
-- $sel:actionsSuppressorWaitPeriod:CompositeAlarm',
-- compositeAlarm_actionsSuppressorWaitPeriod - The maximum time
-- in seconds that the composite alarm waits for the suppressor alarm to
-- go into the ALARM state. After this time, the composite alarm
-- performs its actions.
--
-- WaitPeriod is required only when ActionsSuppressor
-- is specified.
--
-- $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).
--
-- $sel:alarmArn:CompositeAlarm', compositeAlarm_alarmArn -
-- The Amazon Resource Name (ARN) of the alarm.
--
-- $sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm',
-- compositeAlarm_alarmConfigurationUpdatedTimestamp - The time
-- stamp of the last update to the alarm configuration.
--
-- $sel:alarmDescription:CompositeAlarm',
-- compositeAlarm_alarmDescription - The description of the alarm.
--
-- $sel:alarmName:CompositeAlarm', compositeAlarm_alarmName
-- - The name of the alarm.
--
-- $sel:alarmRule:CompositeAlarm', compositeAlarm_alarmRule
-- - The rule that this alarm uses to evaluate its 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: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: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:stateTransitionedTimestamp:CompositeAlarm',
-- compositeAlarm_stateTransitionedTimestamp - The timestamp of
-- the last change to the alarm's StateValue.
--
-- $sel:stateUpdatedTimestamp:CompositeAlarm',
-- compositeAlarm_stateUpdatedTimestamp - Tracks the timestamp of
-- any state update, even if StateValue doesn't change.
--
-- $sel:stateValue:CompositeAlarm',
-- compositeAlarm_stateValue - The state value for the alarm.
newCompositeAlarm :: CompositeAlarm
-- | Represents a specific dashboard.
--
-- See: newDashboardEntry smart constructor.
data DashboardEntry
DashboardEntry' :: Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe Integer -> DashboardEntry
-- | 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:dashboardArn:DashboardEntry',
-- dashboardEntry_dashboardArn - The Amazon Resource Name (ARN) of
-- the dashboard.
--
-- $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:size:DashboardEntry', dashboardEntry_size - The
-- size of the dashboard, in bytes.
newDashboardEntry :: DashboardEntry
-- | An error or warning for the operation.
--
-- See: newDashboardValidationMessage smart constructor.
data DashboardValidationMessage
DashboardValidationMessage' :: Maybe Text -> Maybe Text -> DashboardValidationMessage
-- | 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.
newDashboardValidationMessage :: DashboardValidationMessage
-- | Encapsulates the statistical data that CloudWatch computes from metric
-- data.
--
-- See: newDatapoint smart constructor.
data Datapoint
Datapoint' :: Maybe Double -> Maybe (HashMap Text Double) -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe ISO8601 -> Maybe StandardUnit -> Datapoint
-- | 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:average:Datapoint', datapoint_average - The average
-- of the metric values that correspond to the data point.
--
-- $sel:extendedStatistics:Datapoint',
-- datapoint_extendedStatistics - The percentile statistic for the
-- data point.
--
-- $sel:maximum:Datapoint', datapoint_maximum - The maximum
-- metric value for the data point.
--
-- $sel:minimum:Datapoint', datapoint_minimum - The minimum
-- metric value for the data point.
--
-- $sel:sampleCount:Datapoint', datapoint_sampleCount - The
-- number of metric values that contributed to the aggregate value of
-- this data point.
--
-- $sel:sum:Datapoint', datapoint_sum - The sum of the
-- metric values for the data point.
--
-- $sel:timestamp:Datapoint', datapoint_timestamp - The
-- time stamp used for the data point.
--
-- $sel:unit:Datapoint', datapoint_unit - The standard unit
-- for the data point.
newDatapoint :: Datapoint
-- | A dimension is a name/value pair that is part of the identity of a
-- metric. Because dimensions are part of the unique identifier for a
-- metric, whenever you add a unique name/value pair to one of your
-- metrics, you are creating a new variation of that metric. For example,
-- many Amazon EC2 metrics publish InstanceId as a dimension
-- name, and the actual instance ID as the value for that dimension.
--
-- You can assign up to 30 dimensions to a metric.
--
-- See: newDimension smart constructor.
data Dimension
Dimension' :: Text -> Text -> Dimension
-- | 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, must
-- include at least one non-whitespace character, and cannot start with a
-- colon (:).
--
-- $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.
newDimension :: Text -> Text -> Dimension
-- | Represents filters for a dimension.
--
-- See: newDimensionFilter smart constructor.
data DimensionFilter
DimensionFilter' :: Maybe Text -> Text -> DimensionFilter
-- | Create a value of DimensionFilter with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:value:DimensionFilter', dimensionFilter_value - The
-- value of the dimension to be matched.
--
-- $sel:name:DimensionFilter', dimensionFilter_name - The
-- dimension name to be matched.
newDimensionFilter :: Text -> DimensionFilter
-- | This structure contains the definition for a Contributor Insights
-- rule. For more information about this rule, see Using Constributor
-- Insights to analyze high-cardinality data in the Amazon
-- CloudWatch User Guide.
--
-- See: newInsightRule smart constructor.
data InsightRule
InsightRule' :: Maybe Bool -> 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:managedRule:InsightRule', insightRule_managedRule -
-- An optional built-in rule that Amazon Web Services manages.
--
-- $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 managed 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.
newInsightRule :: Text -> Text -> Text -> Text -> InsightRule
-- | 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.
data InsightRuleContributor
InsightRuleContributor' :: [Text] -> Double -> [InsightRuleContributorDatapoint] -> InsightRuleContributor
-- | 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.
newInsightRuleContributor :: Double -> InsightRuleContributor
-- | One data point related to one contributor.
--
-- For more information, see GetInsightRuleReport and
-- InsightRuleContributor.
--
-- See: newInsightRuleContributorDatapoint smart
-- constructor.
data InsightRuleContributorDatapoint
InsightRuleContributorDatapoint' :: ISO8601 -> Double -> InsightRuleContributorDatapoint
-- | Create a value of InsightRuleContributorDatapoint with all
-- optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:timestamp:InsightRuleContributorDatapoint',
-- insightRuleContributorDatapoint_timestamp - The timestamp of
-- the data point.
--
-- $sel:approximateValue:InsightRuleContributorDatapoint',
-- insightRuleContributorDatapoint_approximateValue - The
-- approximate value that this contributor added during this timestamp.
newInsightRuleContributorDatapoint :: UTCTime -> Double -> InsightRuleContributorDatapoint
-- | One data point from the metric time series returned in a Contributor
-- Insights rule report.
--
-- For more information, see GetInsightRuleReport.
--
-- See: newInsightRuleMetricDatapoint smart constructor.
data InsightRuleMetricDatapoint
InsightRuleMetricDatapoint' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> ISO8601 -> InsightRuleMetricDatapoint
-- | 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: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: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: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: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: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: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: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:timestamp:InsightRuleMetricDatapoint',
-- insightRuleMetricDatapoint_timestamp - The timestamp of the
-- data point.
newInsightRuleMetricDatapoint :: UTCTime -> InsightRuleMetricDatapoint
-- | 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.
data LabelOptions
LabelOptions' :: Maybe Text -> LabelOptions
-- | 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.
newLabelOptions :: LabelOptions
-- | Contains the information that's required to enable a managed
-- Contributor Insights rule for an Amazon Web Services resource.
--
-- See: newManagedRule smart constructor.
data ManagedRule
ManagedRule' :: Maybe [Tag] -> Text -> Text -> ManagedRule
-- | Create a value of ManagedRule 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:ManagedRule', managedRule_tags - A list of
-- key-value pairs that you can associate with a managed Contributor
-- Insights rule. You can associate as many as 50 tags with a rule. Tags
-- can help you organize and categorize your resources. You also can use
-- them to scope user permissions by granting a user permission to access
-- or change only the resources that have certain tag values. To
-- associate tags with a rule, you must have the
-- cloudwatch:TagResource permission in addition to the
-- cloudwatch:PutInsightRule permission. If you are using this
-- operation to update an existing Contributor Insights rule, any tags
-- that you specify in this parameter are ignored. To change the tags of
-- an existing rule, use TagResource.
--
-- $sel:templateName:ManagedRule', managedRule_templateName
-- - The template name for the managed Contributor Insights rule, as
-- returned by ListManagedInsightRules.
--
-- $sel:resourceARN:ManagedRule', managedRule_resourceARN -
-- The ARN of an Amazon Web Services resource that has managed
-- Contributor Insights rules.
newManagedRule :: Text -> Text -> ManagedRule
-- | Contains information about managed Contributor Insights rules, as
-- returned by ListManagedInsightRules.
--
-- See: newManagedRuleDescription smart constructor.
data ManagedRuleDescription
ManagedRuleDescription' :: Maybe Text -> Maybe ManagedRuleState -> Maybe Text -> ManagedRuleDescription
-- | Create a value of ManagedRuleDescription 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:ManagedRuleDescription',
-- managedRuleDescription_resourceARN - If a managed rule is
-- enabled, this is the ARN for the related Amazon Web Services resource.
--
-- $sel:ruleState:ManagedRuleDescription',
-- managedRuleDescription_ruleState - Describes the state of a
-- managed rule. If present, it contains information about the
-- Contributor Insights rule that contains information about the related
-- Amazon Web Services resource.
--
-- $sel:templateName:ManagedRuleDescription',
-- managedRuleDescription_templateName - The template name for the
-- managed rule. Used to enable managed rules using
-- PutManagedInsightRules.
newManagedRuleDescription :: ManagedRuleDescription
-- | The status of a managed Contributor Insights rule.
--
-- See: newManagedRuleState smart constructor.
data ManagedRuleState
ManagedRuleState' :: Text -> Text -> ManagedRuleState
-- | Create a value of ManagedRuleState 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:ruleName:ManagedRuleState',
-- managedRuleState_ruleName - The name of the Contributor
-- Insights rule that contains data for the specified Amazon Web Services
-- resource.
--
-- $sel:state:ManagedRuleState', managedRuleState_state -
-- Indicates whether the rule is enabled or disabled.
newManagedRuleState :: Text -> Text -> ManagedRuleState
-- | A message returned by the GetMetricDataAPI, including a code
-- and a description.
--
-- If a cross-Region GetMetricData operation fails with a code
-- of Forbidden and a value of Authentication too complex to
-- retrieve cross region data, you can correct the problem by
-- running the GetMetricData operation in the same Region where
-- the metric data is.
--
-- See: newMessageData smart constructor.
data MessageData
MessageData' :: Maybe Text -> Maybe Text -> MessageData
-- | 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:code:MessageData', messageData_code - The error
-- code or status code associated with the message.
--
-- $sel:value:MessageData', messageData_value - The message
-- text.
newMessageData :: MessageData
-- | Represents a specific metric.
--
-- See: newMetric smart constructor.
data Metric
Metric' :: Maybe [Dimension] -> Maybe Text -> Maybe Text -> Metric
-- | 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:dimensions:Metric', metric_dimensions - The
-- dimensions for the metric.
--
-- $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.
newMetric :: Metric
-- | The details about a metric alarm.
--
-- See: newMetricAlarm smart constructor.
data MetricAlarm
MetricAlarm' :: Maybe Bool -> Maybe [Text] -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe Text -> Maybe ComparisonOperator -> Maybe Natural -> Maybe [Dimension] -> Maybe Text -> Maybe Natural -> Maybe EvaluationState -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe [MetricDataQuery] -> Maybe Text -> Maybe [Text] -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe ISO8601 -> Maybe ISO8601 -> Maybe StateValue -> Maybe Statistic -> Maybe Double -> Maybe Text -> Maybe Text -> Maybe StandardUnit -> MetricAlarm
-- | 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:actionsEnabled:MetricAlarm',
-- metricAlarm_actionsEnabled - Indicates whether actions should
-- be executed during any changes to the alarm state.
--
-- $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:alarmArn:MetricAlarm', metricAlarm_alarmArn - The
-- Amazon Resource Name (ARN) of the alarm.
--
-- $sel:alarmConfigurationUpdatedTimestamp:MetricAlarm',
-- metricAlarm_alarmConfigurationUpdatedTimestamp - The time stamp
-- of the last update to the alarm configuration.
--
-- $sel:alarmDescription:MetricAlarm',
-- metricAlarm_alarmDescription - The description of the alarm.
--
-- $sel:alarmName:MetricAlarm', metricAlarm_alarmName - The
-- name of 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:datapointsToAlarm:MetricAlarm',
-- metricAlarm_datapointsToAlarm - The number of data points that
-- must be breaching to trigger the alarm.
--
-- $sel:dimensions:MetricAlarm', metricAlarm_dimensions -
-- The dimensions for the metric associated with the alarm.
--
-- $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:evaluationPeriods:MetricAlarm',
-- metricAlarm_evaluationPeriods - The number of periods over
-- which data is compared to the specified threshold.
--
-- $sel:evaluationState:MetricAlarm',
-- metricAlarm_evaluationState - If the value of this field is
-- PARTIAL_DATA, the alarm is being evaluated based on only
-- partial data. This happens if the query used for the alarm returns
-- more than 10,000 metrics. For more information, see Create alarms
-- on Metrics Insights queries.
--
-- $sel:extendedStatistic:MetricAlarm',
-- metricAlarm_extendedStatistic - The percentile statistic for
-- the metric associated with the alarm. Specify a value between p0.0 and
-- p100.
--
-- $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:metricName:MetricAlarm', metricAlarm_metricName -
-- The name of the metric associated with the alarm, if this is an alarm
-- based on a single metric.
--
-- $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:namespace:MetricAlarm', metricAlarm_namespace - The
-- namespace of the metric associated with the alarm.
--
-- $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).
--
-- MetricAlarm, metricAlarm_period - The period, in
-- seconds, over which the statistic is applied.
--
-- $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:stateTransitionedTimestamp:MetricAlarm',
-- metricAlarm_stateTransitionedTimestamp - The date and time that
-- the alarm's StateValue most recently changed.
--
-- $sel:stateUpdatedTimestamp:MetricAlarm',
-- metricAlarm_stateUpdatedTimestamp - The time stamp of the last
-- update to the value of either the StateValue or
-- EvaluationState parameters.
--
-- $sel:stateValue:MetricAlarm', metricAlarm_stateValue -
-- The state value for 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:threshold:MetricAlarm', metricAlarm_threshold - The
-- value to compare with the specified statistic.
--
-- $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:treatMissingData:MetricAlarm',
-- metricAlarm_treatMissingData - Sets how this alarm is to handle
-- missing data points. The valid values are breaching,
-- notBreaching, ignore, and missing. For more
-- information, see Configuring how CloudWatch alarms treat missing
-- data.
--
-- If this parameter is omitted, the default behavior of missing
-- is used.
--
-- $sel:unit:MetricAlarm', metricAlarm_unit - The unit of
-- the metric associated with the alarm.
newMetricAlarm :: MetricAlarm
-- | This structure is used in both GetMetricData and
-- PutMetricAlarm. The supported use of this structure is
-- different for those two operations.
--
-- When used in GetMetricData, it indicates the metric data to
-- return, and whether this call is just retrieving a batch set of data
-- for one metric, or is performing a Metrics Insights query or a math
-- expression. A single GetMetricData call can include up to 500
-- MetricDataQuery structures.
--
-- When used in PutMetricAlarm, it enables you to create an
-- alarm based on a metric math expression. Each MetricDataQuery
-- in the array specifies either a metric to retrieve, or a math
-- expression to be performed on retrieved metrics. A single
-- PutMetricAlarm call can include up to 20
-- MetricDataQuery structures in the array. The 20 structures
-- can include as many as 10 structures that contain a
-- MetricStat parameter to retrieve a metric, and as many as 10
-- structures that contain the Expression parameter to perform a
-- math expression. Of those Expression structures, one must
-- have true as the value for ReturnData. The result of
-- this expression is the value the alarm watches.
--
-- Any expression used in a PutMetricAlarm operation must return
-- a single time series. For more information, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Some of the parameters of this structure also have different uses
-- whether you are using this structure in a GetMetricData
-- operation or a PutMetricAlarm operation. These differences
-- are explained in the following parameter list.
--
-- See: newMetricDataQuery smart constructor.
data MetricDataQuery
MetricDataQuery' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe MetricStat -> Maybe Natural -> Maybe Bool -> Text -> MetricDataQuery
-- | Create a value of MetricDataQuery with all optional fields
-- omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel:accountId:MetricDataQuery',
-- metricDataQuery_accountId - The ID of the account where the
-- metrics are located.
--
-- If you are performing a GetMetricData operation in a
-- monitoring account, use this to specify which account to retrieve this
-- metric from.
--
-- If you are performing a PutMetricAlarm operation, use this to
-- specify which account contains the metric that the alarm is watching.
--
-- $sel:expression:MetricDataQuery',
-- metricDataQuery_expression - This field can contain either a
-- Metrics Insights query, or a metric math expression to be performed on
-- the returned data. For more information about Metrics Insights
-- queries, see Metrics Insights query components and syntax in
-- the Amazon CloudWatch User Guide.
--
-- A math expression can use the Id of the other metrics or
-- queries to refer to those metrics, and can also use the Id of
-- other expressions to use the result of those expressions. For more
-- information about metric math expressions, see Metric Math Syntax
-- and Functions in the Amazon CloudWatch User Guide.
--
-- Within each MetricDataQuery object, you must specify either
-- Expression or MetricStat but not both.
--
-- $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.
--
-- 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: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: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.
newMetricDataQuery :: Text -> MetricDataQuery
-- | 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.
data MetricDataResult
MetricDataResult' :: Maybe Text -> Maybe Text -> Maybe [MessageData] -> Maybe StatusCode -> Maybe [ISO8601] -> Maybe [Double] -> MetricDataResult
-- | 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:id:MetricDataResult', metricDataResult_id - The
-- short name you specified to represent this metric.
--
-- $sel:label:MetricDataResult', metricDataResult_label -
-- The human-readable label associated with the data.
--
-- $sel:messages:MetricDataResult',
-- metricDataResult_messages - A list of messages with additional
-- information about the data returned.
--
-- $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.
--
-- $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: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].
newMetricDataResult :: MetricDataResult
-- | Encapsulates the information sent to either create a metric or add new
-- values to be aggregated into an existing metric.
--
-- See: newMetricDatum smart constructor.
data MetricDatum
MetricDatum' :: Maybe [Double] -> Maybe [Dimension] -> Maybe StatisticSet -> Maybe Natural -> Maybe ISO8601 -> Maybe StandardUnit -> Maybe Double -> Maybe [Double] -> Text -> MetricDatum
-- | Create a value of MetricDatum with all optional fields omitted.
--
-- Use generic-lens or optics to modify other optional
-- fields.
--
-- The following record fields are available, with the corresponding
-- lenses provided for backwards compatibility:
--
-- $sel: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:dimensions:MetricDatum', metricDatum_dimensions -
-- The dimensions associated with the metric.
--
-- $sel:statisticValues:MetricDatum',
-- metricDatum_statisticValues - The statistical values for the
-- metric.
--
-- $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: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: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.
--
-- 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: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:metricName:MetricDatum', metricDatum_metricName -
-- The name of the metric.
newMetricDatum :: Text -> MetricDatum
-- | Indicates the CloudWatch math expression that provides the time series
-- the anomaly detector uses as input. The designated math expression
-- must return a single time series.
--
-- See: newMetricMathAnomalyDetector smart constructor.
data MetricMathAnomalyDetector
MetricMathAnomalyDetector' :: Maybe [MetricDataQuery] -> MetricMathAnomalyDetector
-- | Create a value of MetricMathAnomalyDetector 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:metricDataQueries:MetricMathAnomalyDetector',
-- metricMathAnomalyDetector_metricDataQueries - An array of
-- metric data query structures that enables you to create an anomaly
-- detector based on the result of a metric math expression. Each item in
-- MetricDataQueries gets a metric or performs a math
-- expression. One item in MetricDataQueries is the expression
-- that provides the time series that the anomaly detector uses as input.
-- Designate the expression by setting ReturnData to
-- true for this object in the array. For all other expressions
-- and metrics, set ReturnData to false. The designated
-- expression must return a single time series.
newMetricMathAnomalyDetector :: MetricMathAnomalyDetector
-- | This structure defines the metric to be returned, along with the
-- statistics, period, and units.
--
-- See: newMetricStat smart constructor.
data MetricStat
MetricStat' :: Maybe StandardUnit -> 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.
newMetricStat :: Metric -> Natural -> Text -> MetricStat
-- | This structure contains the configuration information about one metric
-- stream.
--
-- See: newMetricStreamEntry smart constructor.
data MetricStreamEntry
MetricStreamEntry' :: Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe ISO8601 -> Maybe Text -> Maybe MetricStreamOutputFormat -> Maybe Text -> MetricStreamEntry
-- | 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:arn:MetricStreamEntry', metricStreamEntry_arn - The
-- ARN of the metric stream.
--
-- $sel:creationDate:MetricStreamEntry',
-- metricStreamEntry_creationDate - The date that the metric
-- stream was originally created.
--
-- $sel:firehoseArn:MetricStreamEntry',
-- metricStreamEntry_firehoseArn - The ARN of the Kinesis Firehose
-- devlivery stream that is used for this metric stream.
--
-- $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:outputFormat:MetricStreamEntry',
-- metricStreamEntry_outputFormat - The output format of this
-- metric stream. Valid values are json and
-- opentelemetry0.7.
--
-- $sel:state:MetricStreamEntry', metricStreamEntry_state -
-- The current state of this stream. Valid values are running
-- and stopped.
newMetricStreamEntry :: MetricStreamEntry
-- | 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.
data MetricStreamFilter
MetricStreamFilter' :: Maybe Text -> MetricStreamFilter
-- | 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.
newMetricStreamFilter :: MetricStreamFilter
-- | By default, a metric stream always sends the MAX,
-- MIN, SUM, and SAMPLECOUNT statistics for
-- each metric that is streamed. This structure contains information for
-- one metric that includes additional statistics in the stream. For more
-- information about statistics, see CloudWatch, listed in CloudWatch
-- statistics definitions.
--
-- See: newMetricStreamStatisticsConfiguration smart
-- constructor.
data MetricStreamStatisticsConfiguration
MetricStreamStatisticsConfiguration' :: [MetricStreamStatisticsMetric] -> [Text] -> MetricStreamStatisticsConfiguration
-- | Create a value of MetricStreamStatisticsConfiguration 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:includeMetrics:MetricStreamStatisticsConfiguration',
-- metricStreamStatisticsConfiguration_includeMetrics - An array
-- of metric name and namespace pairs that stream the additional
-- statistics listed in the value of the AdditionalStatistics
-- parameter. There can be as many as 100 pairs in the array.
--
-- All metrics that match the combination of metric name and namespace
-- will be streamed with the additional statistics, no matter their
-- dimensions.
--
-- $sel:additionalStatistics:MetricStreamStatisticsConfiguration',
-- metricStreamStatisticsConfiguration_additionalStatistics - The
-- list of additional statistics that are to be streamed for the metrics
-- listed in the IncludeMetrics array in this structure. This
-- list can include as many as 20 statistics.
--
-- If the OutputFormat for the stream is
-- opentelemetry0.7, the only valid values are
-- p?? percentile statistics such as
-- p90, p99 and so on.
--
-- If the OutputFormat for the stream is json, the
-- valid values include the abbreviations for all of the statistics
-- listed in CloudWatch statistics definitions. For example, this
-- includes tm98, wm90, PR(:300), and so on.
newMetricStreamStatisticsConfiguration :: MetricStreamStatisticsConfiguration
-- | This object contains the information for one metric that is to be
-- streamed with additional statistics.
--
-- See: newMetricStreamStatisticsMetric smart constructor.
data MetricStreamStatisticsMetric
MetricStreamStatisticsMetric' :: Text -> Text -> MetricStreamStatisticsMetric
-- | Create a value of MetricStreamStatisticsMetric 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:MetricStreamStatisticsMetric',
-- metricStreamStatisticsMetric_namespace - The namespace of the
-- metric.
--
-- $sel:metricName:MetricStreamStatisticsMetric',
-- metricStreamStatisticsMetric_metricName - The name of the
-- metric.
newMetricStreamStatisticsMetric :: Text -> Text -> MetricStreamStatisticsMetric
-- | 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.
data PartialFailure
PartialFailure' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> PartialFailure
-- | 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:exceptionType:PartialFailure',
-- partialFailure_exceptionType - The type of error.
--
-- $sel:failureCode:PartialFailure',
-- partialFailure_failureCode - The code of the error.
--
-- $sel:failureDescription:PartialFailure',
-- partialFailure_failureDescription - A description of the error.
--
-- $sel:failureResource:PartialFailure',
-- partialFailure_failureResource - The specified rule that could
-- not be deleted.
newPartialFailure :: PartialFailure
-- | Specifies one range of days or times to exclude from use for training
-- an anomaly detection model.
--
-- See: newRange smart constructor.
data Range
Range' :: ISO8601 -> ISO8601 -> Range
-- | 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.
newRange :: UTCTime -> UTCTime -> Range
-- | Designates the CloudWatch metric and statistic that provides the time
-- series the anomaly detector uses as input.
--
-- See: newSingleMetricAnomalyDetector smart constructor.
data SingleMetricAnomalyDetector
SingleMetricAnomalyDetector' :: Maybe [Dimension] -> Maybe Text -> Maybe Text -> Maybe Text -> SingleMetricAnomalyDetector
-- | Create a value of SingleMetricAnomalyDetector 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:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_dimensions - The metric dimensions
-- to create the anomaly detection model for.
--
-- $sel:metricName:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_metricName - The name of the metric
-- to create the anomaly detection model for.
--
-- $sel:namespace:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_namespace - The namespace of the
-- metric to create the anomaly detection model for.
--
-- $sel:stat:SingleMetricAnomalyDetector',
-- singleMetricAnomalyDetector_stat - The statistic to use for the
-- metric and anomaly detection model.
newSingleMetricAnomalyDetector :: SingleMetricAnomalyDetector
-- | Represents a set of statistics that describes a specific metric.
--
-- See: newStatisticSet smart constructor.
data StatisticSet
StatisticSet' :: 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.
newStatisticSet :: Double -> Double -> Double -> Double -> StatisticSet
-- | A key-value pair associated with a CloudWatch resource.
--
-- See: newTag smart constructor.
data Tag
Tag' :: Text -> Text -> Tag
-- | 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.
newTag :: Text -> Text -> Tag