{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.NetworkManager.GetLinks -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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. module Amazonka.NetworkManager.GetLinks ( -- * Creating a Request GetLinks (..), newGetLinks, -- * Request Lenses getLinks_linkIds, getLinks_maxResults, getLinks_nextToken, getLinks_provider, getLinks_siteId, getLinks_type, getLinks_globalNetworkId, -- * Destructuring the Response GetLinksResponse (..), newGetLinksResponse, -- * Response Lenses getLinksResponse_links, getLinksResponse_nextToken, getLinksResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.NetworkManager.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newGetLinks' smart constructor. data GetLinks = GetLinks' { -- | One or more link IDs. The maximum is 10. linkIds :: Prelude.Maybe [Prelude.Text], -- | The maximum number of results to return. maxResults :: Prelude.Maybe Prelude.Natural, -- | The token for the next page of results. nextToken :: Prelude.Maybe Prelude.Text, -- | The link provider. provider :: Prelude.Maybe Prelude.Text, -- | The ID of the site. siteId :: Prelude.Maybe Prelude.Text, -- | The link type. type' :: Prelude.Maybe Prelude.Text, -- | The ID of the global network. globalNetworkId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetLinks' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'linkIds', 'getLinks_linkIds' - One or more link IDs. The maximum is 10. -- -- 'maxResults', 'getLinks_maxResults' - The maximum number of results to return. -- -- 'nextToken', 'getLinks_nextToken' - The token for the next page of results. -- -- 'provider', 'getLinks_provider' - The link provider. -- -- 'siteId', 'getLinks_siteId' - The ID of the site. -- -- 'type'', 'getLinks_type' - The link type. -- -- 'globalNetworkId', 'getLinks_globalNetworkId' - The ID of the global network. newGetLinks :: -- | 'globalNetworkId' Prelude.Text -> GetLinks newGetLinks pGlobalNetworkId_ = GetLinks' { linkIds = Prelude.Nothing, maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, provider = Prelude.Nothing, siteId = Prelude.Nothing, type' = Prelude.Nothing, globalNetworkId = pGlobalNetworkId_ } -- | One or more link IDs. The maximum is 10. getLinks_linkIds :: Lens.Lens' GetLinks (Prelude.Maybe [Prelude.Text]) getLinks_linkIds = Lens.lens (\GetLinks' {linkIds} -> linkIds) (\s@GetLinks' {} a -> s {linkIds = a} :: GetLinks) Prelude.. Lens.mapping Lens.coerced -- | The maximum number of results to return. getLinks_maxResults :: Lens.Lens' GetLinks (Prelude.Maybe Prelude.Natural) getLinks_maxResults = Lens.lens (\GetLinks' {maxResults} -> maxResults) (\s@GetLinks' {} a -> s {maxResults = a} :: GetLinks) -- | The token for the next page of results. getLinks_nextToken :: Lens.Lens' GetLinks (Prelude.Maybe Prelude.Text) getLinks_nextToken = Lens.lens (\GetLinks' {nextToken} -> nextToken) (\s@GetLinks' {} a -> s {nextToken = a} :: GetLinks) -- | The link provider. getLinks_provider :: Lens.Lens' GetLinks (Prelude.Maybe Prelude.Text) getLinks_provider = Lens.lens (\GetLinks' {provider} -> provider) (\s@GetLinks' {} a -> s {provider = a} :: GetLinks) -- | The ID of the site. getLinks_siteId :: Lens.Lens' GetLinks (Prelude.Maybe Prelude.Text) getLinks_siteId = Lens.lens (\GetLinks' {siteId} -> siteId) (\s@GetLinks' {} a -> s {siteId = a} :: GetLinks) -- | The link type. getLinks_type :: Lens.Lens' GetLinks (Prelude.Maybe Prelude.Text) getLinks_type = Lens.lens (\GetLinks' {type'} -> type') (\s@GetLinks' {} a -> s {type' = a} :: GetLinks) -- | The ID of the global network. getLinks_globalNetworkId :: Lens.Lens' GetLinks Prelude.Text getLinks_globalNetworkId = Lens.lens (\GetLinks' {globalNetworkId} -> globalNetworkId) (\s@GetLinks' {} a -> s {globalNetworkId = a} :: GetLinks) instance Core.AWSPager GetLinks where page rq rs | Core.stop ( rs Lens.^? getLinksResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? getLinksResponse_links Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& getLinks_nextToken Lens..~ rs Lens.^? getLinksResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest GetLinks where type AWSResponse GetLinks = GetLinksResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> GetLinksResponse' Prelude.<$> (x Data..?> "Links" Core..!@ Prelude.mempty) Prelude.<*> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable GetLinks where hashWithSalt _salt GetLinks' {..} = _salt `Prelude.hashWithSalt` linkIds `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` provider `Prelude.hashWithSalt` siteId `Prelude.hashWithSalt` type' `Prelude.hashWithSalt` globalNetworkId instance Prelude.NFData GetLinks where rnf GetLinks' {..} = Prelude.rnf linkIds `Prelude.seq` Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf provider `Prelude.seq` Prelude.rnf siteId `Prelude.seq` Prelude.rnf type' `Prelude.seq` Prelude.rnf globalNetworkId instance Data.ToHeaders GetLinks where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath GetLinks where toPath GetLinks' {..} = Prelude.mconcat [ "/global-networks/", Data.toBS globalNetworkId, "/links" ] instance Data.ToQuery GetLinks where toQuery GetLinks' {..} = Prelude.mconcat [ "linkIds" Data.=: Data.toQuery (Data.toQueryList "member" Prelude.<$> linkIds), "maxResults" Data.=: maxResults, "nextToken" Data.=: nextToken, "provider" Data.=: provider, "siteId" Data.=: siteId, "type" Data.=: type' ] -- | /See:/ 'newGetLinksResponse' smart constructor. data GetLinksResponse = GetLinksResponse' { -- | The links. links :: Prelude.Maybe [Link], -- | The token for the next page of results. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetLinksResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'links', 'getLinksResponse_links' - The links. -- -- 'nextToken', 'getLinksResponse_nextToken' - The token for the next page of results. -- -- 'httpStatus', 'getLinksResponse_httpStatus' - The response's http status code. newGetLinksResponse :: -- | 'httpStatus' Prelude.Int -> GetLinksResponse newGetLinksResponse pHttpStatus_ = GetLinksResponse' { links = Prelude.Nothing, nextToken = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The links. getLinksResponse_links :: Lens.Lens' GetLinksResponse (Prelude.Maybe [Link]) getLinksResponse_links = Lens.lens (\GetLinksResponse' {links} -> links) (\s@GetLinksResponse' {} a -> s {links = a} :: GetLinksResponse) Prelude.. Lens.mapping Lens.coerced -- | The token for the next page of results. getLinksResponse_nextToken :: Lens.Lens' GetLinksResponse (Prelude.Maybe Prelude.Text) getLinksResponse_nextToken = Lens.lens (\GetLinksResponse' {nextToken} -> nextToken) (\s@GetLinksResponse' {} a -> s {nextToken = a} :: GetLinksResponse) -- | The response's http status code. getLinksResponse_httpStatus :: Lens.Lens' GetLinksResponse Prelude.Int getLinksResponse_httpStatus = Lens.lens (\GetLinksResponse' {httpStatus} -> httpStatus) (\s@GetLinksResponse' {} a -> s {httpStatus = a} :: GetLinksResponse) instance Prelude.NFData GetLinksResponse where rnf GetLinksResponse' {..} = Prelude.rnf links `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus