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.NetworkManager.GetLinks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

This operation returns paginated results.

Synopsis

data GetLinks = GetLinks' {
- linkIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- provider :: Maybe Text
- siteId :: Maybe Text
- type' :: Maybe Text
- globalNetworkId :: Text
}
newGetLinks :: Text -> GetLinks
getLinks_linkIds :: Lens' GetLinks (Maybe [Text])
getLinks_maxResults :: Lens' GetLinks (Maybe Natural)
getLinks_nextToken :: Lens' GetLinks (Maybe Text)
getLinks_provider :: Lens' GetLinks (Maybe Text)
getLinks_siteId :: Lens' GetLinks (Maybe Text)
getLinks_type :: Lens' GetLinks (Maybe Text)
getLinks_globalNetworkId :: Lens' GetLinks Text
data GetLinksResponse = GetLinksResponse' {
- links :: Maybe [Link]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetLinksResponse :: Int -> GetLinksResponse
getLinksResponse_links :: Lens' GetLinksResponse (Maybe [Link])
getLinksResponse_nextToken :: Lens' GetLinksResponse (Maybe Text)
getLinksResponse_httpStatus :: Lens' GetLinksResponse Int

Creating a Request

data GetLinks Source #

See: newGetLinks smart constructor.

Constructors

GetLinks'
Fields linkIds :: Maybe [Text] One or more link IDs. The maximum is 10. maxResults :: Maybe Natural The maximum number of results to return. nextToken :: Maybe Text The token for the next page of results. provider :: Maybe Text The link provider. siteId :: Maybe Text The ID of the site. type' :: Maybe Text The link type. globalNetworkId :: Text The ID of the global network.

Instances

Instances details

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

newGetLinks Source #

Arguments

:: Text	`GetLinks`
-> GetLinks

Create a value of GetLinks 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:linkIds:GetLinks', getLinks_linkIds - One or more link IDs. The maximum is 10.

$sel:maxResults:GetLinks', getLinks_maxResults - The maximum number of results to return.

GetLinks, getLinks_nextToken - The token for the next page of results.

GetLinks, getLinks_provider - The link provider.

GetLinks, getLinks_siteId - The ID of the site.

GetLinks, getLinks_type - The link type.

GetLinks, getLinks_globalNetworkId - The ID of the global network.

Request Lenses

getLinks_linkIds :: Lens' GetLinks (Maybe [Text]) Source #

One or more link IDs. The maximum is 10.

getLinks_maxResults :: Lens' GetLinks (Maybe Natural) Source #

The maximum number of results to return.

getLinks_nextToken :: Lens' GetLinks (Maybe Text) Source #

The token for the next page of results.

getLinks_provider :: Lens' GetLinks (Maybe Text) Source #

The link provider.

getLinks_siteId :: Lens' GetLinks (Maybe Text) Source #

The ID of the site.

getLinks_type :: Lens' GetLinks (Maybe Text) Source #

The link type.

getLinks_globalNetworkId :: Lens' GetLinks Text Source #

The ID of the global network.

Destructuring the Response

data GetLinksResponse Source #

See: newGetLinksResponse smart constructor.

Constructors

GetLinksResponse'
Fields links :: Maybe [Link] The links. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetLinksResponse Source #

Arguments

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

Create a value of GetLinksResponse 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:links:GetLinksResponse', getLinksResponse_links - The links.

GetLinks, getLinksResponse_nextToken - The token for the next page of results.

$sel:httpStatus:GetLinksResponse', getLinksResponse_httpStatus - The response's http status code.

Response Lenses

getLinksResponse_links :: Lens' GetLinksResponse (Maybe [Link]) Source #

The links.

getLinksResponse_nextToken :: Lens' GetLinksResponse (Maybe Text) Source #

The token for the next page of results.

getLinksResponse_httpStatus :: Lens' GetLinksResponse Int Source #

The response's http status code.