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.SnowDeviceManagement.ListDevices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDevices Source #

See: newListDevices smart constructor.

Constructors

ListDevices'
Fields jobId :: Maybe Text The ID of the job used to order the device. nextToken :: Maybe Text A pagination token to continue to the next page of results. maxResults :: Maybe Natural The maximum number of devices to list per page.

Instances

Instances details

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

newListDevices :: ListDevices Source #

Create a value of ListDevices 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:jobId:ListDevices', listDevices_jobId - The ID of the job used to order the device.

$sel:nextToken:ListDevices', listDevices_nextToken - A pagination token to continue to the next page of results.

$sel:maxResults:ListDevices', listDevices_maxResults - The maximum number of devices to list per page.

Request Lenses

listDevices_jobId :: Lens' ListDevices (Maybe Text) Source #

The ID of the job used to order the device.

listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #

A pagination token to continue to the next page of results.

listDevices_maxResults :: Lens' ListDevices (Maybe Natural) Source #

The maximum number of devices to list per page.

Destructuring the Response

data ListDevicesResponse Source #

See: newListDevicesResponse smart constructor.

Constructors

ListDevicesResponse'
Fields nextToken :: Maybe Text A pagination token to continue to the next page of devices. devices :: Maybe [DeviceSummary] A list of device structures that contain information about the device. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListDevicesResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.ListDevices Methods (==) :: ListDevicesResponse -> ListDevicesResponse -> Bool # (/=) :: ListDevicesResponse -> ListDevicesResponse -> Bool #
Read ListDevicesResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.ListDevices Methods readsPrec :: Int -> ReadS ListDevicesResponse # readList :: ReadS [ListDevicesResponse] # readPrec :: ReadPrec ListDevicesResponse # readListPrec :: ReadPrec [ListDevicesResponse] #
Show ListDevicesResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.ListDevices Methods showsPrec :: Int -> ListDevicesResponse -> ShowS # show :: ListDevicesResponse -> String # showList :: [ListDevicesResponse] -> ShowS #
Generic ListDevicesResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.ListDevices Associated Types type Rep ListDevicesResponse :: Type -> Type # Methods from :: ListDevicesResponse -> Rep ListDevicesResponse x # to :: Rep ListDevicesResponse x -> ListDevicesResponse #
NFData ListDevicesResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.ListDevices Methods rnf :: ListDevicesResponse -> () #
type Rep ListDevicesResponse Source #
Instance details Defined in Amazonka.SnowDeviceManagement.ListDevices type Rep ListDevicesResponse = D1 ('MetaData "ListDevicesResponse" "Amazonka.SnowDeviceManagement.ListDevices" "libZSservicesZSamazonka-snow-device-managementZSamazonka-snow-device-management" 'False) (C1 ('MetaCons "ListDevicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDevicesResponse Source #

Arguments

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

Create a value of ListDevicesResponse 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:ListDevices', listDevicesResponse_nextToken - A pagination token to continue to the next page of devices.

$sel:devices:ListDevicesResponse', listDevicesResponse_devices - A list of device structures that contain information about the device.

$sel:httpStatus:ListDevicesResponse', listDevicesResponse_httpStatus - The response's http status code.

Response Lenses

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #

A pagination token to continue to the next page of devices.

listDevicesResponse_devices :: Lens' ListDevicesResponse (Maybe [DeviceSummary]) Source #

A list of device structures that contain information about the device.

listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #

The response's http status code.