Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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.

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.

Synopsis

Creating a Request

data DescribeAlarmHistory Source #

See: newDescribeAlarmHistory smart constructor.

Constructors

DescribeAlarmHistory'

Fields

alarmName :: Maybe Text
The name of the alarm.
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.
historyItemType :: Maybe HistoryItemType
The type of alarm histories to retrieve.
maxRecords :: Maybe Natural
The maximum number of alarm history records to retrieve.
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.
startDate :: Maybe ISO8601
The starting date to retrieve alarm history.

Instances

Instances details

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 #
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 :: (Service -> Service) -> DescribeAlarmHistory -> Request DescribeAlarmHistory # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAlarmHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAlarmHistory))) #
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 #
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 #
NFData DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods rnf :: DescribeAlarmHistory -> () #
Eq DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods (==) :: DescribeAlarmHistory -> DescribeAlarmHistory -> Bool # (/=) :: DescribeAlarmHistory -> DescribeAlarmHistory -> Bool #
Hashable DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods hashWithSalt :: Int -> DescribeAlarmHistory -> Int # hash :: DescribeAlarmHistory -> Int #
type AWSResponse DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory type AWSResponse DescribeAlarmHistory = DescribeAlarmHistoryResponse
type Rep DescribeAlarmHistory Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory type Rep DescribeAlarmHistory = D1 ('MetaData "DescribeAlarmHistory" "Amazonka.CloudWatch.DescribeAlarmHistory" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" 'False) (C1 ('MetaCons "DescribeAlarmHistory'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "alarmTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AlarmType]))) :: (S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "historyItemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HistoryItemType)))) :: ((S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "scanBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScanBy)) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))

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:

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.

Request Lenses

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

The name of the alarm.

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

The type of alarm histories to retrieve.

describeAlarmHistory_maxRecords :: Lens' DescribeAlarmHistory (Maybe Natural) Source #

The maximum number of alarm history records to retrieve.

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

The starting date to retrieve alarm history.

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

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 #
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 #
NFData DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods rnf :: DescribeAlarmHistoryResponse -> () #
Eq DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory Methods (==) :: DescribeAlarmHistoryResponse -> DescribeAlarmHistoryResponse -> Bool # (/=) :: DescribeAlarmHistoryResponse -> DescribeAlarmHistoryResponse -> Bool #
type Rep DescribeAlarmHistoryResponse Source #
Instance details Defined in Amazonka.CloudWatch.DescribeAlarmHistory type Rep DescribeAlarmHistoryResponse = D1 ('MetaData "DescribeAlarmHistoryResponse" "Amazonka.CloudWatch.DescribeAlarmHistory" "amazonka-cloudwatch-2.0-9xq2AWTkbYo3pEtgQNn4jD" '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.

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.