libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTThingsGraph.SearchThings

Description

Searches for things associated with the specified entity. You can search by both device and device model.

For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

This action searches for exact matches and doesn't perform partial text matching.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchThings Source #

See: newSearchThings smart constructor.

Constructors

SearchThings' 

Fields

  • namespaceVersion :: Maybe Integer

    The version of the user's namespace. Defaults to the latest version of the user's namespace.

  • nextToken :: Maybe Text

    The string that specifies the next page of results. Use this when you're paginating results.

  • maxResults :: Maybe Natural

    The maximum number of results to return in the response.

  • entityId :: Text

    The ID of the entity to which the things are associated.

    The IDs should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Instances

Instances details
Eq SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

(==) :: SearchThings -> SearchThings -> Bool #

(/=) :: SearchThings -> SearchThings -> Bool #

Read SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

readsPrec :: Int -> ReadS SearchThings #

readList :: ReadS [SearchThings] #

readPrec :: ReadPrec SearchThings #

readListPrec :: ReadPrec [SearchThings] #

Show SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

showsPrec :: Int -> SearchThings -> ShowS #

show :: SearchThings -> String #

showList :: [SearchThings] -> ShowS #

Generic SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Associated Types

type Rep SearchThings :: Type -> Type #

Methods

from :: SearchThings -> Rep SearchThings x #

to :: Rep SearchThings x -> SearchThings #

NFData SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

rnf :: SearchThings -> () #

Hashable SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

hashWithSalt :: Int -> SearchThings -> Int #

hash :: SearchThings -> Int #

ToJSON SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

toJSON :: SearchThings -> Value #

toEncoding :: SearchThings -> Encoding #

toJSONList :: [SearchThings] -> Value #

toEncodingList :: [SearchThings] -> Encoding #

AWSPager SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

page :: SearchThings -> AWSResponse SearchThings -> Maybe SearchThings #

AWSRequest SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Associated Types

type AWSResponse SearchThings #

Methods

request :: SearchThings -> Request SearchThings #

response :: MonadResource m => Logger -> Service -> Proxy SearchThings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchThings))) #

ToHeaders SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

toHeaders :: SearchThings -> [Header] #

ToPath SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

toPath :: SearchThings -> ByteString #

ToQuery SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

toQuery :: SearchThings -> QueryString #

type Rep SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

type Rep SearchThings = D1 ('MetaData "SearchThings" "Amazonka.IoTThingsGraph.SearchThings" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchThings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namespaceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SearchThings Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

type AWSResponse SearchThings = SearchThingsResponse

newSearchThings Source #

Arguments

:: Text

$sel:entityId:SearchThings'

-> SearchThings 

Create a value of SearchThings 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:namespaceVersion:SearchThings', searchThings_namespaceVersion - The version of the user's namespace. Defaults to the latest version of the user's namespace.

$sel:nextToken:SearchThings', searchThings_nextToken - The string that specifies the next page of results. Use this when you're paginating results.

$sel:maxResults:SearchThings', searchThings_maxResults - The maximum number of results to return in the response.

$sel:entityId:SearchThings', searchThings_entityId - The ID of the entity to which the things are associated.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Request Lenses

searchThings_namespaceVersion :: Lens' SearchThings (Maybe Integer) Source #

The version of the user's namespace. Defaults to the latest version of the user's namespace.

searchThings_nextToken :: Lens' SearchThings (Maybe Text) Source #

The string that specifies the next page of results. Use this when you're paginating results.

searchThings_maxResults :: Lens' SearchThings (Maybe Natural) Source #

The maximum number of results to return in the response.

searchThings_entityId :: Lens' SearchThings Text Source #

The ID of the entity to which the things are associated.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Destructuring the Response

data SearchThingsResponse Source #

See: newSearchThingsResponse smart constructor.

Constructors

SearchThingsResponse' 

Fields

Instances

Instances details
Eq SearchThingsResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

(==) :: SearchThingsResponse -> SearchThingsResponse -> Bool #

(/=) :: SearchThingsResponse -> SearchThingsResponse -> Bool #

Read SearchThingsResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

readsPrec :: Int -> ReadS SearchThingsResponse #

readList :: ReadS [SearchThingsResponse] #

readPrec :: ReadPrec SearchThingsResponse #

readListPrec :: ReadPrec [SearchThingsResponse] #

Show SearchThingsResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

showsPrec :: Int -> SearchThingsResponse -> ShowS #

show :: SearchThingsResponse -> String #

showList :: [SearchThingsResponse] -> ShowS #

Generic SearchThingsResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Associated Types

type Rep SearchThingsResponse :: Type -> Type #

Methods

from :: SearchThingsResponse -> Rep SearchThingsResponse x #

to :: Rep SearchThingsResponse x -> SearchThingsResponse #

NFData SearchThingsResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

Methods

rnf :: SearchThingsResponse -> () #

type Rep SearchThingsResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchThings

type Rep SearchThingsResponse = D1 ('MetaData "SearchThingsResponse" "Amazonka.IoTThingsGraph.SearchThings" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchThingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "things") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Thing])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchThingsResponse Source #

Arguments

:: Int

$sel:httpStatus:SearchThingsResponse'

-> SearchThingsResponse 

Create a value of SearchThingsResponse 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:SearchThings', searchThingsResponse_nextToken - The string to specify as nextToken when you request the next page of results.

$sel:things:SearchThingsResponse', searchThingsResponse_things - An array of things in the result set.

$sel:httpStatus:SearchThingsResponse', searchThingsResponse_httpStatus - The response's http status code.

Response Lenses

searchThingsResponse_nextToken :: Lens' SearchThingsResponse (Maybe Text) Source #

The string to specify as nextToken when you request the next page of results.

searchThingsResponse_things :: Lens' SearchThingsResponse (Maybe [Thing]) Source #

An array of things in the result set.

searchThingsResponse_httpStatus :: Lens' SearchThingsResponse Int Source #

The response's http status code.