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.AlexaBusiness.SearchDevices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data SearchDevices = SearchDevices' {
- filters :: Maybe [Filter]
- sortCriteria :: Maybe [Sort]
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newSearchDevices :: SearchDevices
searchDevices_filters :: Lens' SearchDevices (Maybe [Filter])
searchDevices_sortCriteria :: Lens' SearchDevices (Maybe [Sort])
searchDevices_nextToken :: Lens' SearchDevices (Maybe Text)
searchDevices_maxResults :: Lens' SearchDevices (Maybe Natural)
data SearchDevicesResponse = SearchDevicesResponse' {
- nextToken :: Maybe Text
- devices :: Maybe [DeviceData]
- totalCount :: Maybe Int
- httpStatus :: Int
}
newSearchDevicesResponse :: Int -> SearchDevicesResponse
searchDevicesResponse_nextToken :: Lens' SearchDevicesResponse (Maybe Text)
searchDevicesResponse_devices :: Lens' SearchDevicesResponse (Maybe [DeviceData])
searchDevicesResponse_totalCount :: Lens' SearchDevicesResponse (Maybe Int)
searchDevicesResponse_httpStatus :: Lens' SearchDevicesResponse Int

Creating a Request

data SearchDevices Source #

See: newSearchDevices smart constructor.

Constructors

SearchDevices'

Fields

filters :: Maybe [Filter]
The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
sortCriteria :: Maybe [Sort]
The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
nextToken :: 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.
maxResults :: 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.

Instances

Instances details

Eq SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods (==) :: SearchDevices -> SearchDevices -> Bool # (/=) :: SearchDevices -> SearchDevices -> Bool #
Read SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods readsPrec :: Int -> ReadS SearchDevices # readList :: ReadS [SearchDevices] # readPrec :: ReadPrec SearchDevices # readListPrec :: ReadPrec [SearchDevices] #
Show SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods showsPrec :: Int -> SearchDevices -> ShowS # show :: SearchDevices -> String # showList :: [SearchDevices] -> ShowS #
Generic SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Associated Types type Rep SearchDevices :: Type -> Type # Methods from :: SearchDevices -> Rep SearchDevices x # to :: Rep SearchDevices x -> SearchDevices #
NFData SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods rnf :: SearchDevices -> () #
Hashable SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods hashWithSalt :: Int -> SearchDevices -> Int # hash :: SearchDevices -> Int #
ToJSON SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods toJSON :: SearchDevices -> Value # toEncoding :: SearchDevices -> Encoding # toJSONList :: [SearchDevices] -> Value # toEncodingList :: [SearchDevices] -> Encoding #
AWSPager SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods page :: SearchDevices -> AWSResponse SearchDevices -> Maybe SearchDevices #
AWSRequest SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Associated Types type AWSResponse SearchDevices # Methods request :: SearchDevices -> Request SearchDevices # response :: MonadResource m => Logger -> Service -> Proxy SearchDevices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchDevices))) #
ToHeaders SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods toHeaders :: SearchDevices -> [Header] #
ToPath SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods toPath :: SearchDevices -> ByteString #
ToQuery SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods toQuery :: SearchDevices -> QueryString #
type Rep SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices type Rep SearchDevices = D1 ('MetaData "SearchDevices" "Amazonka.AlexaBusiness.SearchDevices" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "SearchDevices'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Sort]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse SearchDevices Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices type AWSResponse SearchDevices = SearchDevicesResponse

newSearchDevices :: SearchDevices Source #

Create a value of SearchDevices 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:filters:SearchDevices', searchDevices_filters - The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

$sel:sortCriteria:SearchDevices', searchDevices_sortCriteria - The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

$sel:nextToken:SearchDevices', searchDevices_nextToken - 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.

$sel:maxResults:SearchDevices', searchDevices_maxResults - 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.

Request Lenses

searchDevices_filters :: Lens' SearchDevices (Maybe [Filter]) Source #

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

searchDevices_sortCriteria :: Lens' SearchDevices (Maybe [Sort]) Source #

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

searchDevices_nextToken :: Lens' SearchDevices (Maybe Text) Source #

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.

searchDevices_maxResults :: Lens' SearchDevices (Maybe Natural) Source #

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

data SearchDevicesResponse Source #

See: newSearchDevicesResponse smart constructor.

Constructors

SearchDevicesResponse'
Fields nextToken :: Maybe Text The token returned to indicate that there is more data available. devices :: Maybe [DeviceData] The devices that meet the specified set of filter criteria, in sort order. totalCount :: Maybe Int The total number of devices returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchDevicesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods (==) :: SearchDevicesResponse -> SearchDevicesResponse -> Bool # (/=) :: SearchDevicesResponse -> SearchDevicesResponse -> Bool #
Read SearchDevicesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods readsPrec :: Int -> ReadS SearchDevicesResponse # readList :: ReadS [SearchDevicesResponse] # readPrec :: ReadPrec SearchDevicesResponse # readListPrec :: ReadPrec [SearchDevicesResponse] #
Show SearchDevicesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods showsPrec :: Int -> SearchDevicesResponse -> ShowS # show :: SearchDevicesResponse -> String # showList :: [SearchDevicesResponse] -> ShowS #
Generic SearchDevicesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Associated Types type Rep SearchDevicesResponse :: Type -> Type # Methods from :: SearchDevicesResponse -> Rep SearchDevicesResponse x # to :: Rep SearchDevicesResponse x -> SearchDevicesResponse #
NFData SearchDevicesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices Methods rnf :: SearchDevicesResponse -> () #
type Rep SearchDevicesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchDevices type Rep SearchDevicesResponse = D1 ('MetaData "SearchDevicesResponse" "Amazonka.AlexaBusiness.SearchDevices" "libZSservicesZSamazonka-alexa-businessZSamazonka-alexa-business" 'False) (C1 ('MetaCons "SearchDevicesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceData]))) :: (S1 ('MetaSel ('Just "totalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchDevicesResponse Source #

Arguments

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

Create a value of SearchDevicesResponse 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:SearchDevices', searchDevicesResponse_nextToken - The token returned to indicate that there is more data available.

$sel:devices:SearchDevicesResponse', searchDevicesResponse_devices - The devices that meet the specified set of filter criteria, in sort order.

$sel:totalCount:SearchDevicesResponse', searchDevicesResponse_totalCount - The total number of devices returned.

$sel:httpStatus:SearchDevicesResponse', searchDevicesResponse_httpStatus - The response's http status code.

Response Lenses

searchDevicesResponse_nextToken :: Lens' SearchDevicesResponse (Maybe Text) Source #

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

searchDevicesResponse_devices :: Lens' SearchDevicesResponse (Maybe [DeviceData]) Source #

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

searchDevicesResponse_totalCount :: Lens' SearchDevicesResponse (Maybe Int) Source #

The total number of devices returned.

searchDevicesResponse_httpStatus :: Lens' SearchDevicesResponse Int Source #

The response's http status code.