Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatch.DescribeAlarmHistory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data DescribeAlarmHistory = DescribeAlarmHistory' {
- alarmName :: Maybe Text
- historyItemType :: Maybe HistoryItemType
- alarmTypes :: Maybe [AlarmType]
- endDate :: Maybe ISO8601
- startDate :: Maybe ISO8601
- nextToken :: Maybe Text
- scanBy :: Maybe ScanBy
- maxRecords :: Maybe Natural
}
newDescribeAlarmHistory :: DescribeAlarmHistory
describeAlarmHistory_alarmName :: Lens' DescribeAlarmHistory (Maybe Text)
describeAlarmHistory_historyItemType :: Lens' DescribeAlarmHistory (Maybe HistoryItemType)
describeAlarmHistory_alarmTypes :: Lens' DescribeAlarmHistory (Maybe [AlarmType])
describeAlarmHistory_endDate :: Lens' DescribeAlarmHistory (Maybe UTCTime)
describeAlarmHistory_startDate :: Lens' DescribeAlarmHistory (Maybe UTCTime)
describeAlarmHistory_nextToken :: Lens' DescribeAlarmHistory (Maybe Text)
describeAlarmHistory_scanBy :: Lens' DescribeAlarmHistory (Maybe ScanBy)
describeAlarmHistory_maxRecords :: Lens' DescribeAlarmHistory (Maybe Natural)
data DescribeAlarmHistoryResponse = DescribeAlarmHistoryResponse' {
- alarmHistoryItems :: Maybe [AlarmHistoryItem]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeAlarmHistoryResponse :: Int -> DescribeAlarmHistoryResponse
describeAlarmHistoryResponse_alarmHistoryItems :: Lens' DescribeAlarmHistoryResponse (Maybe [AlarmHistoryItem])
describeAlarmHistoryResponse_nextToken :: Lens' DescribeAlarmHistoryResponse (Maybe Text)
describeAlarmHistoryResponse_httpStatus :: Lens' DescribeAlarmHistoryResponse Int

Creating a Request

data DescribeAlarmHistory Source #

See: newDescribeAlarmHistory smart constructor.

Constructors

DescribeAlarmHistory'

Fields

alarmName :: Maybe Text
The name of the alarm.
historyItemType :: Maybe HistoryItemType
The type of alarm histories to retrieve.
alarmTypes :: Maybe [AlarmType]
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.
endDate :: Maybe ISO8601
The ending date to retrieve alarm history.
startDate :: Maybe ISO8601
The starting date to retrieve alarm history.
nextToken :: Maybe Text
The token returned by a previous call to indicate that there is more data available.
scanBy :: Maybe 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.
maxRecords :: Maybe Natural
The maximum number of alarm history records to retrieve.

Instances

Instances details

Eq DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods (==) :: DescribeAlarmHistory -> DescribeAlarmHistory -> Bool # (/=) :: DescribeAlarmHistory -> DescribeAlarmHistory -> Bool #
Read DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods readsPrec :: Int -> ReadS DescribeAlarmHistory # readList :: ReadS [DescribeAlarmHistory] # readPrec :: ReadPrec DescribeAlarmHistory # readListPrec :: ReadPrec [DescribeAlarmHistory] #
Show DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods showsPrec :: Int -> DescribeAlarmHistory -> ShowS # show :: DescribeAlarmHistory -> String # showList :: [DescribeAlarmHistory] -> ShowS #
Generic DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Associated Types type Rep DescribeAlarmHistory :: Type -> Type # Methods from :: DescribeAlarmHistory -> Rep DescribeAlarmHistory x # to :: Rep DescribeAlarmHistory x -> DescribeAlarmHistory #
NFData DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods rnf :: DescribeAlarmHistory -> () #
Hashable DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods hashWithSalt :: Int -> DescribeAlarmHistory -> Int # hash :: DescribeAlarmHistory -> Int #
AWSPager DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods page :: DescribeAlarmHistory -> AWSResponse DescribeAlarmHistory -> Maybe DescribeAlarmHistory #
AWSRequest DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Associated Types type AWSResponse DescribeAlarmHistory # Methods request :: DescribeAlarmHistory -> Request DescribeAlarmHistory # response :: MonadResource m => Logger -> Service -> Proxy DescribeAlarmHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAlarmHistory))) #
ToHeaders DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods toHeaders :: DescribeAlarmHistory -> [Header] #
ToPath DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods toPath :: DescribeAlarmHistory -> ByteString #
ToQuery DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods toQuery :: DescribeAlarmHistory -> QueryString #
type Rep DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory type Rep DescribeAlarmHistory = D1 ('MetaData "DescribeAlarmHistory" "Amazonka.CloudWatch.DescribeAlarmHistory" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "DescribeAlarmHistory'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "historyItemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HistoryItemType))) :: (S1 ('MetaSel ('Just "alarmTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AlarmType])) :: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: ((S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "scanBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScanBy)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory type AWSResponse DescribeAlarmHistory = DescribeAlarmHistoryResponse

newDescribeAlarmHistory :: DescribeAlarmHistory Source #

Create a value of DescribeAlarmHistory with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alarmName:DescribeAlarmHistory', describeAlarmHistory_alarmName - The name of the alarm.

$sel:historyItemType:DescribeAlarmHistory', describeAlarmHistory_historyItemType - The type of alarm histories to retrieve.

$sel:alarmTypes:DescribeAlarmHistory', describeAlarmHistory_alarmTypes - Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

$sel:endDate:DescribeAlarmHistory', describeAlarmHistory_endDate - The ending date to retrieve alarm history.

$sel:startDate:DescribeAlarmHistory', describeAlarmHistory_startDate - The starting date to retrieve alarm history.

$sel:nextToken:DescribeAlarmHistory', describeAlarmHistory_nextToken - The token returned by a previous call to indicate that there is more data available.

$sel:scanBy:DescribeAlarmHistory', describeAlarmHistory_scanBy - Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

$sel:maxRecords:DescribeAlarmHistory', describeAlarmHistory_maxRecords - The maximum number of alarm history records to retrieve.

Request Lenses

describeAlarmHistory_alarmName :: Lens' DescribeAlarmHistory (Maybe Text) Source #

The name of the alarm.

describeAlarmHistory_historyItemType :: Lens' DescribeAlarmHistory (Maybe HistoryItemType) Source #

The type of alarm histories to retrieve.

describeAlarmHistory_alarmTypes :: Lens' DescribeAlarmHistory (Maybe [AlarmType]) Source #

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_endDate :: Lens' DescribeAlarmHistory (Maybe UTCTime) Source #

The ending date to retrieve alarm history.

describeAlarmHistory_startDate :: Lens' DescribeAlarmHistory (Maybe UTCTime) Source #

The starting date to retrieve alarm history.

describeAlarmHistory_nextToken :: Lens' DescribeAlarmHistory (Maybe Text) Source #

The token returned by a previous call to indicate that there is more data available.

describeAlarmHistory_scanBy :: Lens' DescribeAlarmHistory (Maybe ScanBy) Source #

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_maxRecords :: Lens' DescribeAlarmHistory (Maybe Natural) Source #

The maximum number of alarm history records to retrieve.

Destructuring the Response

data DescribeAlarmHistoryResponse Source #

See: newDescribeAlarmHistoryResponse smart constructor.

Constructors

DescribeAlarmHistoryResponse'
Fields alarmHistoryItems :: Maybe [AlarmHistoryItem] The alarm histories, in JSON format. nextToken :: Maybe Text The token that marks the start of the next batch of returned results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods (==) :: DescribeAlarmHistoryResponse -> DescribeAlarmHistoryResponse -> Bool # (/=) :: DescribeAlarmHistoryResponse -> DescribeAlarmHistoryResponse -> Bool #
Read DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods readsPrec :: Int -> ReadS DescribeAlarmHistoryResponse # readList :: ReadS [DescribeAlarmHistoryResponse] # readPrec :: ReadPrec DescribeAlarmHistoryResponse # readListPrec :: ReadPrec [DescribeAlarmHistoryResponse] #
Show DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods showsPrec :: Int -> DescribeAlarmHistoryResponse -> ShowS # show :: DescribeAlarmHistoryResponse -> String # showList :: [DescribeAlarmHistoryResponse] -> ShowS #
Generic DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Associated Types type Rep DescribeAlarmHistoryResponse :: Type -> Type # Methods from :: DescribeAlarmHistoryResponse -> Rep DescribeAlarmHistoryResponse x # to :: Rep DescribeAlarmHistoryResponse x -> DescribeAlarmHistoryResponse #
NFData DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods rnf :: DescribeAlarmHistoryResponse -> () #
type Rep DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory type Rep DescribeAlarmHistoryResponse = D1 ('MetaData "DescribeAlarmHistoryResponse" "Amazonka.CloudWatch.DescribeAlarmHistory" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "DescribeAlarmHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmHistoryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AlarmHistoryItem])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeAlarmHistoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAlarmHistoryResponse'`
-> 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.

$sel:nextToken:DescribeAlarmHistory', describeAlarmHistoryResponse_nextToken - The token that marks the start of the next batch of returned results.

$sel:httpStatus:DescribeAlarmHistoryResponse', describeAlarmHistoryResponse_httpStatus - The response's http status code.

Response Lenses

describeAlarmHistoryResponse_alarmHistoryItems :: Lens' DescribeAlarmHistoryResponse (Maybe [AlarmHistoryItem]) Source #

The alarm histories, in JSON format.

describeAlarmHistoryResponse_nextToken :: Lens' DescribeAlarmHistoryResponse (Maybe Text) Source #

The token that marks the start of the next batch of returned results.

describeAlarmHistoryResponse_httpStatus :: Lens' DescribeAlarmHistoryResponse Int Source #

The response's http status code.