Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.NetworkManager.GetDevices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data GetDevices = GetDevices' {
- deviceIds :: Maybe [Text]
- nextToken :: Maybe Text
- siteId :: Maybe Text
- maxResults :: Maybe Natural
- globalNetworkId :: Text
}
newGetDevices :: Text -> GetDevices
getDevices_deviceIds :: Lens' GetDevices (Maybe [Text])
getDevices_nextToken :: Lens' GetDevices (Maybe Text)
getDevices_siteId :: Lens' GetDevices (Maybe Text)
getDevices_maxResults :: Lens' GetDevices (Maybe Natural)
getDevices_globalNetworkId :: Lens' GetDevices Text
data GetDevicesResponse = GetDevicesResponse' {
- nextToken :: Maybe Text
- devices :: Maybe [Device]
- httpStatus :: Int
}
newGetDevicesResponse :: Int -> GetDevicesResponse
getDevicesResponse_nextToken :: Lens' GetDevicesResponse (Maybe Text)
getDevicesResponse_devices :: Lens' GetDevicesResponse (Maybe [Device])
getDevicesResponse_httpStatus :: Lens' GetDevicesResponse Int

Creating a Request

data GetDevices Source #

See: newGetDevices smart constructor.

Constructors

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

Instances

Instances details

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

newGetDevices Source #

Arguments

:: Text	`$sel:globalNetworkId:GetDevices'`
-> GetDevices

Create a value of GetDevices 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:deviceIds:GetDevices', getDevices_deviceIds - One or more device IDs. The maximum is 10.

$sel:nextToken:GetDevices', getDevices_nextToken - The token for the next page of results.

$sel:siteId:GetDevices', getDevices_siteId - The ID of the site.

$sel:maxResults:GetDevices', getDevices_maxResults - The maximum number of results to return.

$sel:globalNetworkId:GetDevices', getDevices_globalNetworkId - The ID of the global network.

Request Lenses

getDevices_deviceIds :: Lens' GetDevices (Maybe [Text]) Source #

One or more device IDs. The maximum is 10.

getDevices_nextToken :: Lens' GetDevices (Maybe Text) Source #

The token for the next page of results.

getDevices_siteId :: Lens' GetDevices (Maybe Text) Source #

The ID of the site.

getDevices_maxResults :: Lens' GetDevices (Maybe Natural) Source #

The maximum number of results to return.

getDevices_globalNetworkId :: Lens' GetDevices Text Source #

The ID of the global network.

Destructuring the Response

data GetDevicesResponse Source #

See: newGetDevicesResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGetDevicesResponse Source #

Arguments

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

Create a value of GetDevicesResponse 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:nextToken:GetDevices', getDevicesResponse_nextToken - The token for the next page of results.

$sel:devices:GetDevicesResponse', getDevicesResponse_devices - The devices.

$sel:httpStatus:GetDevicesResponse', getDevicesResponse_httpStatus - The response's http status code.

Response Lenses

getDevicesResponse_nextToken :: Lens' GetDevicesResponse (Maybe Text) Source #

The token for the next page of results.

getDevicesResponse_devices :: Lens' GetDevicesResponse (Maybe [Device]) Source #

The devices.

getDevicesResponse_httpStatus :: Lens' GetDevicesResponse Int Source #

The response's http status code.