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.StartReplay

Description

Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you 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 StartReplay Source #

See: newStartReplay smart constructor.

Constructors

StartReplay' 

Fields

  • description :: Maybe Text

    A description for the replay to start.

  • replayName :: Text

    The name of the replay to start.

  • eventSourceArn :: Text

    The ARN of the archive to replay events from.

  • eventStartTime :: POSIX

    A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

  • eventEndTime :: POSIX

    A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

  • destination :: ReplayDestination

    A ReplayDestination object that includes details about the destination for the replay.

Instances

Instances details
Eq StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Read StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Show StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Generic StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Associated Types

type Rep StartReplay :: Type -> Type #

NFData StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Methods

rnf :: StartReplay -> () #

Hashable StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

ToJSON StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

AWSRequest StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Associated Types

type AWSResponse StartReplay #

ToHeaders StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Methods

toHeaders :: StartReplay -> [Header] #

ToPath StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

ToQuery StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

type Rep StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

type Rep StartReplay = D1 ('MetaData "StartReplay" "Amazonka.CloudWatchEvents.StartReplay" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "StartReplay'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "eventStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "eventEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReplayDestination)))))
type AWSResponse StartReplay Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

newStartReplay Source #

Create a value of StartReplay 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:description:StartReplay', startReplay_description - A description for the replay to start.

$sel:replayName:StartReplay', startReplay_replayName - The name of the replay to start.

$sel:eventSourceArn:StartReplay', startReplay_eventSourceArn - The ARN of the archive to replay events from.

$sel:eventStartTime:StartReplay', startReplay_eventStartTime - A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

$sel:eventEndTime:StartReplay', startReplay_eventEndTime - A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

$sel:destination:StartReplay', startReplay_destination - A ReplayDestination object that includes details about the destination for the replay.

Request Lenses

startReplay_description :: Lens' StartReplay (Maybe Text) Source #

A description for the replay to start.

startReplay_replayName :: Lens' StartReplay Text Source #

The name of the replay to start.

startReplay_eventSourceArn :: Lens' StartReplay Text Source #

The ARN of the archive to replay events from.

startReplay_eventStartTime :: Lens' StartReplay UTCTime Source #

A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

startReplay_eventEndTime :: Lens' StartReplay UTCTime Source #

A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

startReplay_destination :: Lens' StartReplay ReplayDestination Source #

A ReplayDestination object that includes details about the destination for the replay.

Destructuring the Response

data StartReplayResponse Source #

See: newStartReplayResponse smart constructor.

Constructors

StartReplayResponse' 

Fields

Instances

Instances details
Eq StartReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Read StartReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Show StartReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Generic StartReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Associated Types

type Rep StartReplayResponse :: Type -> Type #

NFData StartReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

Methods

rnf :: StartReplayResponse -> () #

type Rep StartReplayResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.StartReplay

type Rep StartReplayResponse = D1 ('MetaData "StartReplayResponse" "Amazonka.CloudWatchEvents.StartReplay" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "StartReplayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplayState)) :*: S1 ('MetaSel ('Just "replayStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "replayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newStartReplayResponse Source #

Create a value of StartReplayResponse 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:state:StartReplayResponse', startReplayResponse_state - The state of the replay.

$sel:replayStartTime:StartReplayResponse', startReplayResponse_replayStartTime - The time at which the replay started.

$sel:replayArn:StartReplayResponse', startReplayResponse_replayArn - The ARN of the replay.

$sel:stateReason:StartReplayResponse', startReplayResponse_stateReason - The reason that the replay is in the state.

$sel:httpStatus:StartReplayResponse', startReplayResponse_httpStatus - The response's http status code.

Response Lenses

startReplayResponse_stateReason :: Lens' StartReplayResponse (Maybe Text) Source #

The reason that the replay is in the state.