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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about one or more of your sites in a global network.

This operation returns paginated results.

Synopsis

data GetSites = GetSites' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- siteIds :: Maybe [Text]
- globalNetworkId :: Text
}
newGetSites :: Text -> GetSites
getSites_maxResults :: Lens' GetSites (Maybe Natural)
getSites_nextToken :: Lens' GetSites (Maybe Text)
getSites_siteIds :: Lens' GetSites (Maybe [Text])
getSites_globalNetworkId :: Lens' GetSites Text
data GetSitesResponse = GetSitesResponse' {
- nextToken :: Maybe Text
- sites :: Maybe [Site]
- httpStatus :: Int
}
newGetSitesResponse :: Int -> GetSitesResponse
getSitesResponse_nextToken :: Lens' GetSitesResponse (Maybe Text)
getSitesResponse_sites :: Lens' GetSitesResponse (Maybe [Site])
getSitesResponse_httpStatus :: Lens' GetSitesResponse Int

Creating a Request

data GetSites Source #

See: newGetSites smart constructor.

Constructors

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

Instances

Instances details

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

newGetSites Source #

Arguments

:: Text	`GetSites`
-> GetSites

Create a value of GetSites 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:GetSites', getSites_maxResults - The maximum number of results to return.

GetSites, getSites_nextToken - The token for the next page of results.

$sel:siteIds:GetSites', getSites_siteIds - One or more site IDs. The maximum is 10.

GetSites, getSites_globalNetworkId - The ID of the global network.

Request Lenses

getSites_maxResults :: Lens' GetSites (Maybe Natural) Source #

The maximum number of results to return.

getSites_nextToken :: Lens' GetSites (Maybe Text) Source #

The token for the next page of results.

getSites_siteIds :: Lens' GetSites (Maybe [Text]) Source #

One or more site IDs. The maximum is 10.

getSites_globalNetworkId :: Lens' GetSites Text Source #

The ID of the global network.

Destructuring the Response

data GetSitesResponse Source #

See: newGetSitesResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGetSitesResponse Source #

Arguments

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

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

GetSites, getSitesResponse_nextToken - The token for the next page of results.

$sel:sites:GetSitesResponse', getSitesResponse_sites - The sites.

$sel:httpStatus:GetSitesResponse', getSitesResponse_httpStatus - The response's http status code.

Response Lenses

getSitesResponse_nextToken :: Lens' GetSitesResponse (Maybe Text) Source #

The token for the next page of results.

getSitesResponse_sites :: Lens' GetSitesResponse (Maybe [Site]) Source #

The sites.

getSitesResponse_httpStatus :: Lens' GetSitesResponse Int Source #

The response's http status code.