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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of API destination in the account in the current Region.

Synopsis

data ListApiDestinations = ListApiDestinations' {
- nextToken :: Maybe Text
- namePrefix :: Maybe Text
- limit :: Maybe Natural
- connectionArn :: Maybe Text
}
newListApiDestinations :: ListApiDestinations
listApiDestinations_nextToken :: Lens' ListApiDestinations (Maybe Text)
listApiDestinations_namePrefix :: Lens' ListApiDestinations (Maybe Text)
listApiDestinations_limit :: Lens' ListApiDestinations (Maybe Natural)
listApiDestinations_connectionArn :: Lens' ListApiDestinations (Maybe Text)
data ListApiDestinationsResponse = ListApiDestinationsResponse' {
- apiDestinations :: Maybe [ApiDestination]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListApiDestinationsResponse :: Int -> ListApiDestinationsResponse
listApiDestinationsResponse_apiDestinations :: Lens' ListApiDestinationsResponse (Maybe [ApiDestination])
listApiDestinationsResponse_nextToken :: Lens' ListApiDestinationsResponse (Maybe Text)
listApiDestinationsResponse_httpStatus :: Lens' ListApiDestinationsResponse Int

Creating a Request

data ListApiDestinations Source #

See: newListApiDestinations smart constructor.

Constructors

ListApiDestinations'

Fields

nextToken :: Maybe Text
The token returned by a previous call to retrieve the next set of results.
namePrefix :: Maybe Text
A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.
limit :: Maybe Natural
The maximum number of API destinations to include in the response.
connectionArn :: Maybe Text
The ARN of the connection specified for the API destination.

Instances

Instances details

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

newListApiDestinations :: ListApiDestinations Source #

Create a value of ListApiDestinations 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:nextToken:ListApiDestinations', listApiDestinations_nextToken - The token returned by a previous call to retrieve the next set of results.

$sel:namePrefix:ListApiDestinations', listApiDestinations_namePrefix - A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

$sel:limit:ListApiDestinations', listApiDestinations_limit - The maximum number of API destinations to include in the response.

$sel:connectionArn:ListApiDestinations', listApiDestinations_connectionArn - The ARN of the connection specified for the API destination.

Request Lenses

listApiDestinations_nextToken :: Lens' ListApiDestinations (Maybe Text) Source #

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

listApiDestinations_namePrefix :: Lens' ListApiDestinations (Maybe Text) Source #

A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

listApiDestinations_limit :: Lens' ListApiDestinations (Maybe Natural) Source #

The maximum number of API destinations to include in the response.

listApiDestinations_connectionArn :: Lens' ListApiDestinations (Maybe Text) Source #

The ARN of the connection specified for the API destination.

Destructuring the Response

data ListApiDestinationsResponse Source #

See: newListApiDestinationsResponse smart constructor.

Constructors

ListApiDestinationsResponse'
Fields apiDestinations :: Maybe [ApiDestination] An array of `ApiDestination` objects that include information about an API destination. nextToken :: Maybe Text A token you can use in a subsequent request to retrieve the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListApiDestinationsResponse Source #

Arguments

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

Create a value of ListApiDestinationsResponse 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:apiDestinations:ListApiDestinationsResponse', listApiDestinationsResponse_apiDestinations - An array of ApiDestination objects that include information about an API destination.

$sel:nextToken:ListApiDestinations', listApiDestinationsResponse_nextToken - A token you can use in a subsequent request to retrieve the next set of results.

$sel:httpStatus:ListApiDestinationsResponse', listApiDestinationsResponse_httpStatus - The response's http status code.

Response Lenses

listApiDestinationsResponse_apiDestinations :: Lens' ListApiDestinationsResponse (Maybe [ApiDestination]) Source #

An array of ApiDestination objects that include information about an API destination.

listApiDestinationsResponse_nextToken :: Lens' ListApiDestinationsResponse (Maybe Text) Source #

A token you can use in a subsequent request to retrieve the next set of results.

listApiDestinationsResponse_httpStatus :: Lens' ListApiDestinationsResponse Int Source #

The response's http status code.