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.OAM.ListSinks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation in a monitoring account to return the list of sinks created in that account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSinks Source #

See: newListSinks smart constructor.

Constructors

ListSinks'
Fields maxResults :: Maybe Natural Limits the number of returned links to the specified number. nextToken :: Maybe Text The token for the next set of items to return. You received this token from a previous call.

Instances

Instances details

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

newListSinks :: ListSinks Source #

Create a value of ListSinks 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:maxResults:ListSinks', listSinks_maxResults - Limits the number of returned links to the specified number.

ListSinks, listSinks_nextToken - The token for the next set of items to return. You received this token from a previous call.

Request Lenses

listSinks_maxResults :: Lens' ListSinks (Maybe Natural) Source #

Limits the number of returned links to the specified number.

listSinks_nextToken :: Lens' ListSinks (Maybe Text) Source #

The token for the next set of items to return. You received this token from a previous call.

Destructuring the Response

data ListSinksResponse Source #

See: newListSinksResponse smart constructor.

Constructors

ListSinksResponse'
Fields nextToken :: Maybe Text The token to use when requesting the next set of sinks. httpStatus :: Int The response's http status code. items :: [ListSinksItem] An array of structures that contain the information about the returned sinks.

Instances

Instances details

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

newListSinksResponse Source #

Arguments

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

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

ListSinks, listSinksResponse_nextToken - The token to use when requesting the next set of sinks.

$sel:httpStatus:ListSinksResponse', listSinksResponse_httpStatus - The response's http status code.

$sel:items:ListSinksResponse', listSinksResponse_items - An array of structures that contain the information about the returned sinks.

Response Lenses

listSinksResponse_nextToken :: Lens' ListSinksResponse (Maybe Text) Source #

The token to use when requesting the next set of sinks.

listSinksResponse_httpStatus :: Lens' ListSinksResponse Int Source #

The response's http status code.

listSinksResponse_items :: Lens' ListSinksResponse [ListSinksItem] Source #

An array of structures that contain the information about the returned sinks.