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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for devices using the specified filters.

This operation returns paginated results.

Creating a Request

data SearchDevices Source #

See: newSearchDevices smart constructor.

Constructors

SearchDevices'
Fields maxResults :: Maybe Natural The maximum number of results to return in the response. nextToken :: Maybe Text A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended. filters :: [SearchDevicesFilter] The filter values to use to search for a device.

Instances

Instances details

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

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:maxResults:SearchDevices', searchDevices_maxResults - The maximum number of results to return in the response.

SearchDevices, searchDevices_nextToken - A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

$sel:filters:SearchDevices', searchDevices_filters - The filter values to use to search for a device.

Request Lenses

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

The maximum number of results to return in the response.

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

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

searchDevices_filters :: Lens' SearchDevices [SearchDevicesFilter] Source #

The filter values to use to search for a device.

Destructuring the Response

data SearchDevicesResponse Source #

See: newSearchDevicesResponse smart constructor.

Constructors

SearchDevicesResponse'
Fields nextToken :: Maybe Text A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended. httpStatus :: Int The response's http status code. devices :: [DeviceSummary] An array of `DeviceSummary` objects for devices that match the specified filter values.

Instances

Instances details

Generic SearchDevicesResponse Source #
Instance details Defined in Amazonka.Braket.SearchDevices Associated Types type Rep SearchDevicesResponse :: Type -> Type # Methods from :: SearchDevicesResponse -> Rep SearchDevicesResponse x # to :: Rep SearchDevicesResponse x -> SearchDevicesResponse #
Read SearchDevicesResponse Source #
Instance details Defined in Amazonka.Braket.SearchDevices Methods readsPrec :: Int -> ReadS SearchDevicesResponse # readList :: ReadS [SearchDevicesResponse] # readPrec :: ReadPrec SearchDevicesResponse # readListPrec :: ReadPrec [SearchDevicesResponse] #
Show SearchDevicesResponse Source #
Instance details Defined in Amazonka.Braket.SearchDevices Methods showsPrec :: Int -> SearchDevicesResponse -> ShowS # show :: SearchDevicesResponse -> String # showList :: [SearchDevicesResponse] -> ShowS #
NFData SearchDevicesResponse Source #
Instance details Defined in Amazonka.Braket.SearchDevices Methods rnf :: SearchDevicesResponse -> () #
Eq SearchDevicesResponse Source #
Instance details Defined in Amazonka.Braket.SearchDevices Methods (==) :: SearchDevicesResponse -> SearchDevicesResponse -> Bool # (/=) :: SearchDevicesResponse -> SearchDevicesResponse -> Bool #
type Rep SearchDevicesResponse Source #
Instance details Defined in Amazonka.Braket.SearchDevices type Rep SearchDevicesResponse = D1 ('MetaData "SearchDevicesResponse" "Amazonka.Braket.SearchDevices" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "SearchDevicesResponse'" '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 [DeviceSummary]))))

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:

SearchDevices, searchDevicesResponse_nextToken - A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

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

$sel:devices:SearchDevicesResponse', searchDevicesResponse_devices - An array of DeviceSummary objects for devices that match the specified filter values.

Response Lenses

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

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

searchDevicesResponse_httpStatus :: Lens' SearchDevicesResponse Int Source #

The response's http status code.

searchDevicesResponse_devices :: Lens' SearchDevicesResponse [DeviceSummary] Source #

An array of DeviceSummary objects for devices that match the specified filter values.