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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

Synopsis

data ListReplays = ListReplays' {
- eventSourceArn :: Maybe Text
- limit :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe Text
- state :: Maybe ReplayState
}
newListReplays :: ListReplays
listReplays_eventSourceArn :: Lens' ListReplays (Maybe Text)
listReplays_limit :: Lens' ListReplays (Maybe Natural)
listReplays_namePrefix :: Lens' ListReplays (Maybe Text)
listReplays_nextToken :: Lens' ListReplays (Maybe Text)
listReplays_state :: Lens' ListReplays (Maybe ReplayState)
data ListReplaysResponse = ListReplaysResponse' {
- nextToken :: Maybe Text
- replays :: Maybe [Replay]
- httpStatus :: Int
}
newListReplaysResponse :: Int -> ListReplaysResponse
listReplaysResponse_nextToken :: Lens' ListReplaysResponse (Maybe Text)
listReplaysResponse_replays :: Lens' ListReplaysResponse (Maybe [Replay])
listReplaysResponse_httpStatus :: Lens' ListReplaysResponse Int

Creating a Request

data ListReplays Source #

See: newListReplays smart constructor.

Constructors

ListReplays'

Fields

eventSourceArn :: Maybe Text
The ARN of the archive from which the events are replayed.
limit :: Maybe Natural
The maximum number of replays to retrieve.
namePrefix :: Maybe Text
A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.
nextToken :: Maybe Text
The token returned by a previous call to retrieve the next set of results.
state :: Maybe ReplayState
The state of the replay.

Instances

Instances details

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

newListReplays :: ListReplays Source #

Create a value of ListReplays 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:

ListReplays, listReplays_eventSourceArn - The ARN of the archive from which the events are replayed.

$sel:limit:ListReplays', listReplays_limit - The maximum number of replays to retrieve.

$sel:namePrefix:ListReplays', listReplays_namePrefix - A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

ListReplays, listReplays_nextToken - The token returned by a previous call to retrieve the next set of results.

ListReplays, listReplays_state - The state of the replay.

Request Lenses

listReplays_eventSourceArn :: Lens' ListReplays (Maybe Text) Source #

The ARN of the archive from which the events are replayed.

listReplays_limit :: Lens' ListReplays (Maybe Natural) Source #

The maximum number of replays to retrieve.

listReplays_namePrefix :: Lens' ListReplays (Maybe Text) Source #

A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

listReplays_nextToken :: Lens' ListReplays (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listReplays_state :: Lens' ListReplays (Maybe ReplayState) Source #

The state of the replay.

Destructuring the Response

data ListReplaysResponse Source #

See: newListReplaysResponse smart constructor.

Constructors

ListReplaysResponse'
Fields nextToken :: Maybe Text The token returned by a previous call to retrieve the next set of results. replays :: Maybe [Replay] An array of `Replay` objects that contain information about the replay. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListReplaysResponse Source #

Arguments

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

Create a value of ListReplaysResponse 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:

ListReplays, listReplaysResponse_nextToken - The token returned by a previous call to retrieve the next set of results.

$sel:replays:ListReplaysResponse', listReplaysResponse_replays - An array of Replay objects that contain information about the replay.

$sel:httpStatus:ListReplaysResponse', listReplaysResponse_httpStatus - The response's http status code.

Response Lenses

listReplaysResponse_nextToken :: Lens' ListReplaysResponse (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listReplaysResponse_replays :: Lens' ListReplaysResponse (Maybe [Replay]) Source #

An array of Replay objects that contain information about the replay.

listReplaysResponse_httpStatus :: Lens' ListReplaysResponse Int Source #

The response's http status code.