libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatchEvents.DescribeReplay

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

Creating a Request

data DescribeReplay Source #

See: newDescribeReplay smart constructor.

Constructors

DescribeReplay' 

Fields

Instances

Instances details
Eq DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Read DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Show DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Generic DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Associated Types

type Rep DescribeReplay :: Type -> Type #

NFData DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Methods

rnf :: DescribeReplay -> () #

Hashable DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

ToJSON DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

AWSRequest DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Associated Types

type AWSResponse DescribeReplay #

ToHeaders DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

ToPath DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

ToQuery DescribeReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

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

newDescribeReplay Source #

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

Instances

Instances details
Eq DescribeReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Read DescribeReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Show DescribeReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Generic DescribeReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeReplay

Associated Types

type Rep DescribeReplayResponse :: Type -> Type #

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 #

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_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_replayEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

A time stamp for the time that the replay stopped.

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

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

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

The reason that the replay is in the current state.