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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data ListArchives = ListArchives' {
- eventSourceArn :: Maybe Text
- limit :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe Text
- state :: Maybe ArchiveState
}
newListArchives :: ListArchives
listArchives_eventSourceArn :: Lens' ListArchives (Maybe Text)
listArchives_limit :: Lens' ListArchives (Maybe Natural)
listArchives_namePrefix :: Lens' ListArchives (Maybe Text)
listArchives_nextToken :: Lens' ListArchives (Maybe Text)
listArchives_state :: Lens' ListArchives (Maybe ArchiveState)
data ListArchivesResponse = ListArchivesResponse' {
- archives :: Maybe [Archive]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListArchivesResponse :: Int -> ListArchivesResponse
listArchivesResponse_archives :: Lens' ListArchivesResponse (Maybe [Archive])
listArchivesResponse_nextToken :: Lens' ListArchivesResponse (Maybe Text)
listArchivesResponse_httpStatus :: Lens' ListArchivesResponse Int

Creating a Request

data ListArchives Source #

See: newListArchives smart constructor.

Constructors

ListArchives'

Fields

eventSourceArn :: Maybe Text
The ARN of the event source associated with the archive.
limit :: Maybe Natural
The maximum number of results to return.
namePrefix :: Maybe Text
A name prefix to filter the archives returned. Only archives 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 ArchiveState
The state of the archive.

Instances

Instances details

ToJSON ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods toJSON :: ListArchives -> Value # toEncoding :: ListArchives -> Encoding # toJSONList :: [ListArchives] -> Value # toEncodingList :: [ListArchives] -> Encoding #
ToHeaders ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods toHeaders :: ListArchives -> [Header] #
ToPath ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods toPath :: ListArchives -> ByteString #
ToQuery ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods toQuery :: ListArchives -> QueryString #
AWSRequest ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Associated Types type AWSResponse ListArchives # Methods request :: (Service -> Service) -> ListArchives -> Request ListArchives # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListArchives -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListArchives))) #
Generic ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Associated Types type Rep ListArchives :: Type -> Type # Methods from :: ListArchives -> Rep ListArchives x # to :: Rep ListArchives x -> ListArchives #
Read ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods readsPrec :: Int -> ReadS ListArchives # readList :: ReadS [ListArchives] # readPrec :: ReadPrec ListArchives # readListPrec :: ReadPrec [ListArchives] #
Show ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods showsPrec :: Int -> ListArchives -> ShowS # show :: ListArchives -> String # showList :: [ListArchives] -> ShowS #
NFData ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods rnf :: ListArchives -> () #
Eq ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods (==) :: ListArchives -> ListArchives -> Bool # (/=) :: ListArchives -> ListArchives -> Bool #
Hashable ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives Methods hashWithSalt :: Int -> ListArchives -> Int # hash :: ListArchives -> Int #
type AWSResponse ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives type AWSResponse ListArchives = ListArchivesResponse
type Rep ListArchives Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListArchives type Rep ListArchives = D1 ('MetaData "ListArchives" "Amazonka.CloudWatchEvents.ListArchives" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "ListArchives'" '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 ArchiveState))))))

newListArchives :: ListArchives Source #

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

ListArchives, listArchives_eventSourceArn - The ARN of the event source associated with the archive.

$sel:limit:ListArchives', listArchives_limit - The maximum number of results to return.

$sel:namePrefix:ListArchives', listArchives_namePrefix - A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

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

ListArchives, listArchives_state - The state of the archive.

Request Lenses

listArchives_eventSourceArn :: Lens' ListArchives (Maybe Text) Source #

The ARN of the event source associated with the archive.

listArchives_limit :: Lens' ListArchives (Maybe Natural) Source #

The maximum number of results to return.

listArchives_namePrefix :: Lens' ListArchives (Maybe Text) Source #

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

listArchives_nextToken :: Lens' ListArchives (Maybe Text) Source #

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

listArchives_state :: Lens' ListArchives (Maybe ArchiveState) Source #

The state of the archive.

Destructuring the Response

data ListArchivesResponse Source #

See: newListArchivesResponse smart constructor.

Constructors

ListArchivesResponse'
Fields archives :: Maybe [Archive] An array of `Archive` objects that include details about an archive. nextToken :: Maybe Text The token returned by a previous call to retrieve the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListArchivesResponse Source #

Arguments

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

Create a value of ListArchivesResponse 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:archives:ListArchivesResponse', listArchivesResponse_archives - An array of Archive objects that include details about an archive.

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

$sel:httpStatus:ListArchivesResponse', listArchivesResponse_httpStatus - The response's http status code.

Response Lenses

listArchivesResponse_archives :: Lens' ListArchivesResponse (Maybe [Archive]) Source #

An array of Archive objects that include details about an archive.

listArchivesResponse_nextToken :: Lens' ListArchivesResponse (Maybe Text) Source #

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

listArchivesResponse_httpStatus :: Lens' ListArchivesResponse Int Source #

The response's http status code.