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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListLinks Source #

See: newListLinks smart constructor.

Constructors

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

newListLinks :: ListLinks Source #

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

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

Request Lenses

listLinks_maxResults :: Lens' ListLinks (Maybe Natural) Source #

Limits the number of returned links to the specified number.

listLinks_nextToken :: Lens' ListLinks (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 ListLinksResponse Source #

See: newListLinksResponse smart constructor.

Constructors

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

Instances

Instances details

Generic ListLinksResponse Source #
Instance details Defined in Amazonka.OAM.ListLinks Associated Types type Rep ListLinksResponse :: Type -> Type # Methods from :: ListLinksResponse -> Rep ListLinksResponse x # to :: Rep ListLinksResponse x -> ListLinksResponse #
Read ListLinksResponse Source #
Instance details Defined in Amazonka.OAM.ListLinks Methods readsPrec :: Int -> ReadS ListLinksResponse # readList :: ReadS [ListLinksResponse] # readPrec :: ReadPrec ListLinksResponse # readListPrec :: ReadPrec [ListLinksResponse] #
Show ListLinksResponse Source #
Instance details Defined in Amazonka.OAM.ListLinks Methods showsPrec :: Int -> ListLinksResponse -> ShowS # show :: ListLinksResponse -> String # showList :: [ListLinksResponse] -> ShowS #
NFData ListLinksResponse Source #
Instance details Defined in Amazonka.OAM.ListLinks Methods rnf :: ListLinksResponse -> () #
Eq ListLinksResponse Source #
Instance details Defined in Amazonka.OAM.ListLinks Methods (==) :: ListLinksResponse -> ListLinksResponse -> Bool # (/=) :: ListLinksResponse -> ListLinksResponse -> Bool #
type Rep ListLinksResponse Source #
Instance details Defined in Amazonka.OAM.ListLinks type Rep ListLinksResponse = D1 ('MetaData "ListLinksResponse" "Amazonka.OAM.ListLinks" "amazonka-oam-2.0-2r3dTellrOe218sRY2Qi5h" 'False) (C1 ('MetaCons "ListLinksResponse'" '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 [ListLinksItem]))))

newListLinksResponse Source #

Arguments

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

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

ListLinks, listLinksResponse_nextToken - The token to use when requesting the next set of links.

$sel:httpStatus:ListLinksResponse', listLinksResponse_httpStatus - The response's http status code.

$sel:items:ListLinksResponse', listLinksResponse_items - An array of structures that contain the information about the returned links.

Response Lenses

listLinksResponse_nextToken :: Lens' ListLinksResponse (Maybe Text) Source #

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

listLinksResponse_httpStatus :: Lens' ListLinksResponse Int Source #

The response's http status code.

listLinksResponse_items :: Lens' ListLinksResponse [ListLinksItem] Source #

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