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.CloudWatchEvents.DescribeReplay

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

Synopsis

data DescribeReplay = DescribeReplay' {
- replayName :: Text
}
newDescribeReplay :: Text -> DescribeReplay
describeReplay_replayName :: Lens' DescribeReplay Text
data DescribeReplayResponse = DescribeReplayResponse' {
- eventSourceArn :: Maybe Text
- destination :: Maybe ReplayDestination
- state :: Maybe ReplayState
- eventEndTime :: Maybe POSIX
- replayStartTime :: Maybe POSIX
- replayArn :: Maybe Text
- replayEndTime :: Maybe POSIX
- eventLastReplayedTime :: Maybe POSIX
- eventStartTime :: Maybe POSIX
- replayName :: Maybe Text
- stateReason :: Maybe Text
- description :: Maybe Text
- httpStatus :: Int
}
newDescribeReplayResponse :: Int -> DescribeReplayResponse
describeReplayResponse_eventSourceArn :: Lens' DescribeReplayResponse (Maybe Text)
describeReplayResponse_destination :: Lens' DescribeReplayResponse (Maybe ReplayDestination)
describeReplayResponse_state :: Lens' DescribeReplayResponse (Maybe ReplayState)
describeReplayResponse_eventEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime)
describeReplayResponse_replayStartTime :: Lens' DescribeReplayResponse (Maybe UTCTime)
describeReplayResponse_replayArn :: Lens' DescribeReplayResponse (Maybe Text)
describeReplayResponse_replayEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime)
describeReplayResponse_eventLastReplayedTime :: Lens' DescribeReplayResponse (Maybe UTCTime)
describeReplayResponse_eventStartTime :: Lens' DescribeReplayResponse (Maybe UTCTime)
describeReplayResponse_replayName :: Lens' DescribeReplayResponse (Maybe Text)
describeReplayResponse_stateReason :: Lens' DescribeReplayResponse (Maybe Text)
describeReplayResponse_description :: Lens' DescribeReplayResponse (Maybe Text)
describeReplayResponse_httpStatus :: Lens' DescribeReplayResponse Int

Creating a Request

data DescribeReplay Source #

See: newDescribeReplay smart constructor.

Constructors

DescribeReplay'
Fields replayName :: Text The name of the replay to retrieve.

Instances

Instances details

Eq DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods (==) :: DescribeReplay -> DescribeReplay -> Bool # (/=) :: DescribeReplay -> DescribeReplay -> Bool #
Read DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods readsPrec :: Int -> ReadS DescribeReplay # readList :: ReadS [DescribeReplay] # readPrec :: ReadPrec DescribeReplay # readListPrec :: ReadPrec [DescribeReplay] #
Show DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods showsPrec :: Int -> DescribeReplay -> ShowS # show :: DescribeReplay -> String # showList :: [DescribeReplay] -> ShowS #
Generic DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Associated Types type Rep DescribeReplay :: Type -> Type # Methods from :: DescribeReplay -> Rep DescribeReplay x # to :: Rep DescribeReplay x -> DescribeReplay #
NFData DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods rnf :: DescribeReplay -> () #
Hashable DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods hashWithSalt :: Int -> DescribeReplay -> Int # hash :: DescribeReplay -> Int #
ToJSON DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods toJSON :: DescribeReplay -> Value # toEncoding :: DescribeReplay -> Encoding # toJSONList :: [DescribeReplay] -> Value # toEncodingList :: [DescribeReplay] -> Encoding #
AWSRequest DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Associated Types type AWSResponse DescribeReplay # Methods request :: DescribeReplay -> Request DescribeReplay # response :: MonadResource m => Logger -> Service -> Proxy DescribeReplay -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReplay))) #
ToHeaders DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods toHeaders :: DescribeReplay -> [Header] #
ToPath DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods toPath :: DescribeReplay -> ByteString #
ToQuery DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods toQuery :: DescribeReplay -> QueryString #
type Rep DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay type Rep DescribeReplay = D1 ('MetaData "DescribeReplay" "Amazonka.CloudWatchEvents.DescribeReplay" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DescribeReplay'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeReplay Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay type AWSResponse DescribeReplay = DescribeReplayResponse

newDescribeReplay Source #

Arguments

:: Text	`$sel:replayName:DescribeReplay'`
-> DescribeReplay

Create a value of DescribeReplay with all optional fields omitted.

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

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

$sel:replayName:DescribeReplay', describeReplay_replayName - The name of the replay to retrieve.

Request Lenses

describeReplay_replayName :: Lens' DescribeReplay Text Source #

The name of the replay to retrieve.

Destructuring the Response

data DescribeReplayResponse Source #

See: newDescribeReplayResponse smart constructor.

Constructors

DescribeReplayResponse'

Fields

eventSourceArn :: Maybe Text
The ARN of the archive events were replayed from.
destination :: Maybe ReplayDestination
A ReplayDestination object that contains details about the replay.
state :: Maybe ReplayState
The current state of the replay.
eventEndTime :: Maybe POSIX
The time stamp for the last event that was replayed from the archive.
replayStartTime :: Maybe POSIX
A time stamp for the time that the replay started.
replayArn :: Maybe Text
The ARN of the replay.
replayEndTime :: Maybe POSIX
A time stamp for the time that the replay stopped.
eventLastReplayedTime :: Maybe POSIX
The time that the event was last replayed.
eventStartTime :: Maybe POSIX
The time stamp of the first event that was last replayed from the archive.
replayName :: Maybe Text
The name of the replay.
stateReason :: Maybe Text
The reason that the replay is in the current state.
description :: Maybe Text
The description of the replay.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeReplayResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods (==) :: DescribeReplayResponse -> DescribeReplayResponse -> Bool # (/=) :: DescribeReplayResponse -> DescribeReplayResponse -> Bool #
Read DescribeReplayResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods readsPrec :: Int -> ReadS DescribeReplayResponse # readList :: ReadS [DescribeReplayResponse] # readPrec :: ReadPrec DescribeReplayResponse # readListPrec :: ReadPrec [DescribeReplayResponse] #
Show DescribeReplayResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods showsPrec :: Int -> DescribeReplayResponse -> ShowS # show :: DescribeReplayResponse -> String # showList :: [DescribeReplayResponse] -> ShowS #
Generic DescribeReplayResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Associated Types type Rep DescribeReplayResponse :: Type -> Type # Methods from :: DescribeReplayResponse -> Rep DescribeReplayResponse x # to :: Rep DescribeReplayResponse x -> DescribeReplayResponse #
NFData DescribeReplayResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay Methods rnf :: DescribeReplayResponse -> () #
type Rep DescribeReplayResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeReplay type Rep DescribeReplayResponse = D1 ('MetaData "DescribeReplayResponse" "Amazonka.CloudWatchEvents.DescribeReplay" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DescribeReplayResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplayDestination)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplayState)))) :: (S1 ('MetaSel ('Just "eventEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "replayStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "replayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "replayEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "eventLastReplayedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "eventStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "replayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeReplayResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeReplayResponse'`
-> DescribeReplayResponse

Create a value of DescribeReplayResponse with all optional fields omitted.

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

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

$sel:eventSourceArn:DescribeReplayResponse', describeReplayResponse_eventSourceArn - The ARN of the archive events were replayed from.

$sel:destination:DescribeReplayResponse', describeReplayResponse_destination - A ReplayDestination object that contains details about the replay.

$sel:state:DescribeReplayResponse', describeReplayResponse_state - The current state of the replay.

$sel:eventEndTime:DescribeReplayResponse', describeReplayResponse_eventEndTime - The time stamp for the last event that was replayed from the archive.

$sel:replayStartTime:DescribeReplayResponse', describeReplayResponse_replayStartTime - A time stamp for the time that the replay started.

$sel:replayArn:DescribeReplayResponse', describeReplayResponse_replayArn - The ARN of the replay.

$sel:replayEndTime:DescribeReplayResponse', describeReplayResponse_replayEndTime - A time stamp for the time that the replay stopped.

$sel:eventLastReplayedTime:DescribeReplayResponse', describeReplayResponse_eventLastReplayedTime - The time that the event was last replayed.

$sel:eventStartTime:DescribeReplayResponse', describeReplayResponse_eventStartTime - The time stamp of the first event that was last replayed from the archive.

$sel:replayName:DescribeReplay', describeReplayResponse_replayName - The name of the replay.

$sel:stateReason:DescribeReplayResponse', describeReplayResponse_stateReason - The reason that the replay is in the current state.

$sel:description:DescribeReplayResponse', describeReplayResponse_description - The description of the replay.

$sel:httpStatus:DescribeReplayResponse', describeReplayResponse_httpStatus - The response's http status code.

Response Lenses

describeReplayResponse_eventSourceArn :: Lens' DescribeReplayResponse (Maybe Text) Source #

The ARN of the archive events were replayed from.

describeReplayResponse_destination :: Lens' DescribeReplayResponse (Maybe ReplayDestination) Source #

A ReplayDestination object that contains details about the replay.

describeReplayResponse_state :: Lens' DescribeReplayResponse (Maybe ReplayState) Source #

The current state of the replay.

describeReplayResponse_eventEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

The time stamp for the last event that was replayed from the archive.

describeReplayResponse_replayStartTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

A time stamp for the time that the replay started.

describeReplayResponse_replayArn :: Lens' DescribeReplayResponse (Maybe Text) Source #

The ARN of the replay.

describeReplayResponse_replayEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

A time stamp for the time that the replay stopped.

describeReplayResponse_eventLastReplayedTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

The time that the event was last replayed.

describeReplayResponse_eventStartTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

The time stamp of the first event that was last replayed from the archive.

describeReplayResponse_replayName :: Lens' DescribeReplayResponse (Maybe Text) Source #

The name of the replay.

describeReplayResponse_stateReason :: Lens' DescribeReplayResponse (Maybe Text) Source #

The reason that the replay is in the current state.

describeReplayResponse_description :: Lens' DescribeReplayResponse (Maybe Text) Source #

The description of the replay.

describeReplayResponse_httpStatus :: Lens' DescribeReplayResponse Int Source #

The response's http status code.