Network.AWS.AlexaBusiness.SearchDevices

Searches devices and lists the ones that meet a set of filter criteria.

This operation returns paginated results.

Creating a Request

searchDevices :: SearchDevices

Creates a value of SearchDevices with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sdFilters - The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).
• sdSortCriteria - The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
• sdNextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
• sdMaxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

data SearchDevices

See: searchDevices smart constructor.

Instances

Eq SearchDevices

Methods

(==) :: SearchDevices -> SearchDevices -> Bool

(/=) :: SearchDevices -> SearchDevices -> Bool

Data SearchDevices

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchDevices -> c SearchDevices

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchDevices

toConstr :: SearchDevices -> Constr

dataTypeOf :: SearchDevices -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchDevices)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchDevices)

gmapT :: (forall b. Data b => b -> b) -> SearchDevices -> SearchDevices

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchDevices -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchDevices -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchDevices -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchDevices -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchDevices -> m SearchDevices

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchDevices -> m SearchDevices

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchDevices -> m SearchDevices

Read SearchDevices

Methods

readsPrec :: Int -> ReadS SearchDevices

readList :: ReadS [SearchDevices]

readPrec :: ReadPrec SearchDevices

readListPrec :: ReadPrec [SearchDevices]

Show SearchDevices

Methods

showsPrec :: Int -> SearchDevices -> ShowS

show :: SearchDevices -> String

showList :: [SearchDevices] -> ShowS

Generic SearchDevices

Associated Types

type Rep SearchDevices :: * -> *

Methods

from :: SearchDevices -> Rep SearchDevices x

to :: Rep SearchDevices x -> SearchDevices

Hashable SearchDevices

Methods

hashWithSalt :: Int -> SearchDevices -> Int

hash :: SearchDevices -> Int

ToJSON SearchDevices

Methods

toJSON :: SearchDevices -> Value

toEncoding :: SearchDevices -> Encoding

toJSONList :: [SearchDevices] -> Value

toEncodingList :: [SearchDevices] -> Encoding

NFData SearchDevices

Methods

rnf :: SearchDevices -> ()

AWSPager SearchDevices

Methods

page :: SearchDevices -> Rs SearchDevices -> Maybe SearchDevices

AWSRequest SearchDevices

Associated Types

type Rs SearchDevices :: *

Methods

request :: SearchDevices -> Request SearchDevices

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SearchDevices -> ClientResponse -> m (Response SearchDevices)

ToHeaders SearchDevices

Methods

toHeaders :: SearchDevices -> [Header]

ToPath SearchDevices

Methods

toPath :: SearchDevices -> ByteString

ToQuery SearchDevices

Methods

toQuery :: SearchDevices -> QueryString

type Rep SearchDevices

type Rep SearchDevices = D1 * (MetaData "SearchDevices" "Network.AWS.AlexaBusiness.SearchDevices" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchDevices'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sdFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) (S1 * (MetaSel (Just Symbol "_sdSortCriteria") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Sort])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sdMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs SearchDevices

type Rs SearchDevices = SearchDevicesResponse

Request Lenses

sdFilters :: Lens' SearchDevices [Filter]

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).

sdSortCriteria :: Lens' SearchDevices [Sort]

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.

sdNextToken :: Lens' SearchDevices (Maybe Text)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

sdMaxResults :: Lens' SearchDevices (Maybe Natural)

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Destructuring the Response

searchDevicesResponse

Arguments

:: Int

sdrsResponseStatus

-> SearchDevicesResponse

Creates a value of SearchDevicesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sdrsNextToken - The token returned to indicate that there is more data available.
• sdrsDevices - The devices that meet the specified set of filter criteria, in sort order.
• sdrsTotalCount - The total number of devices returned.
• sdrsResponseStatus - -- | The response status code.

data SearchDevicesResponse

See: searchDevicesResponse smart constructor.

Instances

Eq SearchDevicesResponse

Methods

(==) :: SearchDevicesResponse -> SearchDevicesResponse -> Bool

(/=) :: SearchDevicesResponse -> SearchDevicesResponse -> Bool

Data SearchDevicesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchDevicesResponse -> c SearchDevicesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchDevicesResponse

toConstr :: SearchDevicesResponse -> Constr

dataTypeOf :: SearchDevicesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchDevicesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchDevicesResponse)

gmapT :: (forall b. Data b => b -> b) -> SearchDevicesResponse -> SearchDevicesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchDevicesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchDevicesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchDevicesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchDevicesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchDevicesResponse -> m SearchDevicesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchDevicesResponse -> m SearchDevicesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchDevicesResponse -> m SearchDevicesResponse

Read SearchDevicesResponse

Methods

readsPrec :: Int -> ReadS SearchDevicesResponse

readList :: ReadS [SearchDevicesResponse]

readPrec :: ReadPrec SearchDevicesResponse

readListPrec :: ReadPrec [SearchDevicesResponse]

Show SearchDevicesResponse

Methods

showsPrec :: Int -> SearchDevicesResponse -> ShowS

show :: SearchDevicesResponse -> String

showList :: [SearchDevicesResponse] -> ShowS

Generic SearchDevicesResponse

Associated Types

type Rep SearchDevicesResponse :: * -> *

Methods

from :: SearchDevicesResponse -> Rep SearchDevicesResponse x

to :: Rep SearchDevicesResponse x -> SearchDevicesResponse

NFData SearchDevicesResponse

Methods

rnf :: SearchDevicesResponse -> ()

type Rep SearchDevicesResponse

type Rep SearchDevicesResponse = D1 * (MetaData "SearchDevicesResponse" "Network.AWS.AlexaBusiness.SearchDevices" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchDevicesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sdrsDevices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DeviceData])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdrsTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_sdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

sdrsNextToken :: Lens' SearchDevicesResponse (Maybe Text)

The token returned to indicate that there is more data available.

sdrsDevices :: Lens' SearchDevicesResponse [DeviceData]

The devices that meet the specified set of filter criteria, in sort order.

sdrsTotalCount :: Lens' SearchDevicesResponse (Maybe Int)

The total number of devices returned.

sdrsResponseStatus :: Lens' SearchDevicesResponse Int

• - | The response status code.