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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of devices.

Synopsis

data ListDevices = ListDevices' {
- deviceAggregatedStatusFilter :: Maybe DeviceAggregatedStatus
- maxResults :: Maybe Natural
- nameFilter :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe ListDevicesSortBy
- sortOrder :: Maybe SortOrder
}
newListDevices :: ListDevices
listDevices_deviceAggregatedStatusFilter :: Lens' ListDevices (Maybe DeviceAggregatedStatus)
listDevices_maxResults :: Lens' ListDevices (Maybe Natural)
listDevices_nameFilter :: Lens' ListDevices (Maybe Text)
listDevices_nextToken :: Lens' ListDevices (Maybe Text)
listDevices_sortBy :: Lens' ListDevices (Maybe ListDevicesSortBy)
listDevices_sortOrder :: Lens' ListDevices (Maybe SortOrder)
data ListDevicesResponse = ListDevicesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- devices :: [Device]
}
newListDevicesResponse :: Int -> ListDevicesResponse
listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text)
listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int
listDevicesResponse_devices :: Lens' ListDevicesResponse [Device]

Creating a Request

data ListDevices Source #

See: newListDevices smart constructor.

Constructors

ListDevices'

Fields

deviceAggregatedStatusFilter :: Maybe DeviceAggregatedStatus
Filter based on a device's status.
maxResults :: Maybe Natural
The maximum number of devices to return in one page of results.
nameFilter :: Maybe Text
Filter based on device's name. Prefixes supported.
nextToken :: Maybe Text
Specify the pagination token from a previous request to retrieve the next page of results.
sortBy :: Maybe ListDevicesSortBy
The target column to be sorted on. Default column sort is CREATED_TIME.
sortOrder :: Maybe SortOrder
The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Instances

Instances details

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

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:deviceAggregatedStatusFilter:ListDevices', listDevices_deviceAggregatedStatusFilter - Filter based on a device's status.

$sel:maxResults:ListDevices', listDevices_maxResults - The maximum number of devices to return in one page of results.

$sel:nameFilter:ListDevices', listDevices_nameFilter - Filter based on device's name. Prefixes supported.

ListDevices, listDevices_nextToken - Specify the pagination token from a previous request to retrieve the next page of results.

$sel:sortBy:ListDevices', listDevices_sortBy - The target column to be sorted on. Default column sort is CREATED_TIME.

$sel:sortOrder:ListDevices', listDevices_sortOrder - The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Request Lenses

listDevices_deviceAggregatedStatusFilter :: Lens' ListDevices (Maybe DeviceAggregatedStatus) Source #

Filter based on a device's status.

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

The maximum number of devices to return in one page of results.

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

Filter based on device's name. Prefixes supported.

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

Specify the pagination token from a previous request to retrieve the next page of results.

listDevices_sortBy :: Lens' ListDevices (Maybe ListDevicesSortBy) Source #

The target column to be sorted on. Default column sort is CREATED_TIME.

listDevices_sortOrder :: Lens' ListDevices (Maybe SortOrder) Source #

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Destructuring the Response

data ListDevicesResponse Source #

See: newListDevicesResponse smart constructor.

Constructors

ListDevicesResponse'
Fields nextToken :: Maybe Text A pagination token that's included if more results are available. httpStatus :: Int The response's http status code. devices :: [Device] A list of devices.

Instances

Instances details

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

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:

ListDevices, listDevicesResponse_nextToken - A pagination token that's included if more results are available.

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

$sel:devices:ListDevicesResponse', listDevicesResponse_devices - A list of devices.

Response Lenses

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

A pagination token that's included if more results are available.

listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #

The response's http status code.

listDevicesResponse_devices :: Lens' ListDevicesResponse [Device] Source #

A list of devices.