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.IoTThingsGraph.SearchEntities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

This operation returns paginated results.

Synopsis

data SearchEntities = SearchEntities' {
- filters :: Maybe [EntityFilter]
- namespaceVersion :: Maybe Integer
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- entityTypes :: [EntityType]
}
newSearchEntities :: SearchEntities
searchEntities_filters :: Lens' SearchEntities (Maybe [EntityFilter])
searchEntities_namespaceVersion :: Lens' SearchEntities (Maybe Integer)
searchEntities_nextToken :: Lens' SearchEntities (Maybe Text)
searchEntities_maxResults :: Lens' SearchEntities (Maybe Natural)
searchEntities_entityTypes :: Lens' SearchEntities [EntityType]
data SearchEntitiesResponse = SearchEntitiesResponse' {
- nextToken :: Maybe Text
- descriptions :: Maybe [EntityDescription]
- httpStatus :: Int
}
newSearchEntitiesResponse :: Int -> SearchEntitiesResponse
searchEntitiesResponse_nextToken :: Lens' SearchEntitiesResponse (Maybe Text)
searchEntitiesResponse_descriptions :: Lens' SearchEntitiesResponse (Maybe [EntityDescription])
searchEntitiesResponse_httpStatus :: Lens' SearchEntitiesResponse Int

Creating a Request

data SearchEntities Source #

See: newSearchEntities smart constructor.

Constructors

SearchEntities'

Fields

filters :: Maybe [EntityFilter]
Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.
Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
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.
entityTypes :: [EntityType]
The entity types for which to search.

Instances

Instances details

Eq SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods (==) :: SearchEntities -> SearchEntities -> Bool # (/=) :: SearchEntities -> SearchEntities -> Bool #
Read SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods readsPrec :: Int -> ReadS SearchEntities # readList :: ReadS [SearchEntities] # readPrec :: ReadPrec SearchEntities # readListPrec :: ReadPrec [SearchEntities] #
Show SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods showsPrec :: Int -> SearchEntities -> ShowS # show :: SearchEntities -> String # showList :: [SearchEntities] -> ShowS #
Generic SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Associated Types type Rep SearchEntities :: Type -> Type # Methods from :: SearchEntities -> Rep SearchEntities x # to :: Rep SearchEntities x -> SearchEntities #
NFData SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods rnf :: SearchEntities -> () #
Hashable SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods hashWithSalt :: Int -> SearchEntities -> Int # hash :: SearchEntities -> Int #
ToJSON SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods toJSON :: SearchEntities -> Value # toEncoding :: SearchEntities -> Encoding # toJSONList :: [SearchEntities] -> Value # toEncodingList :: [SearchEntities] -> Encoding #
AWSPager SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods page :: SearchEntities -> AWSResponse SearchEntities -> Maybe SearchEntities #
AWSRequest SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Associated Types type AWSResponse SearchEntities # Methods request :: SearchEntities -> Request SearchEntities # response :: MonadResource m => Logger -> Service -> Proxy SearchEntities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchEntities))) #
ToHeaders SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods toHeaders :: SearchEntities -> [Header] #
ToPath SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods toPath :: SearchEntities -> ByteString #
ToQuery SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods toQuery :: SearchEntities -> QueryString #
type Rep SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities type Rep SearchEntities = D1 ('MetaData "SearchEntities" "Amazonka.IoTThingsGraph.SearchEntities" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchEntities'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityFilter])) :: 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 "entityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EntityType])))))
type AWSResponse SearchEntities Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities type AWSResponse SearchEntities = SearchEntitiesResponse

newSearchEntities :: SearchEntities Source #

Create a value of SearchEntities 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:SearchEntities', searchEntities_filters - Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

$sel:namespaceVersion:SearchEntities', searchEntities_namespaceVersion - The version of the user's namespace. Defaults to the latest version of the user's namespace.

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

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

$sel:entityTypes:SearchEntities', searchEntities_entityTypes - The entity types for which to search.

Request Lenses

searchEntities_filters :: Lens' SearchEntities (Maybe [EntityFilter]) Source #

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

searchEntities_namespaceVersion :: Lens' SearchEntities (Maybe Integer) Source #

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

searchEntities_nextToken :: Lens' SearchEntities (Maybe Text) Source #

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

searchEntities_maxResults :: Lens' SearchEntities (Maybe Natural) Source #

The maximum number of results to return in the response.

searchEntities_entityTypes :: Lens' SearchEntities [EntityType] Source #

The entity types for which to search.

Destructuring the Response

data SearchEntitiesResponse Source #

See: newSearchEntitiesResponse smart constructor.

Constructors

SearchEntitiesResponse'
Fields nextToken :: Maybe Text The string to specify as `nextToken` when you request the next page of results. descriptions :: Maybe [EntityDescription] An array of descriptions for each entity returned in the search result. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchEntitiesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods (==) :: SearchEntitiesResponse -> SearchEntitiesResponse -> Bool # (/=) :: SearchEntitiesResponse -> SearchEntitiesResponse -> Bool #
Read SearchEntitiesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods readsPrec :: Int -> ReadS SearchEntitiesResponse # readList :: ReadS [SearchEntitiesResponse] # readPrec :: ReadPrec SearchEntitiesResponse # readListPrec :: ReadPrec [SearchEntitiesResponse] #
Show SearchEntitiesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods showsPrec :: Int -> SearchEntitiesResponse -> ShowS # show :: SearchEntitiesResponse -> String # showList :: [SearchEntitiesResponse] -> ShowS #
Generic SearchEntitiesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Associated Types type Rep SearchEntitiesResponse :: Type -> Type # Methods from :: SearchEntitiesResponse -> Rep SearchEntitiesResponse x # to :: Rep SearchEntitiesResponse x -> SearchEntitiesResponse #
NFData SearchEntitiesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities Methods rnf :: SearchEntitiesResponse -> () #
type Rep SearchEntitiesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchEntities type Rep SearchEntitiesResponse = D1 ('MetaData "SearchEntitiesResponse" "Amazonka.IoTThingsGraph.SearchEntities" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "descriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityDescription])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchEntitiesResponse Source #

Arguments

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

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

$sel:descriptions:SearchEntitiesResponse', searchEntitiesResponse_descriptions - An array of descriptions for each entity returned in the search result.

$sel:httpStatus:SearchEntitiesResponse', searchEntitiesResponse_httpStatus - The response's http status code.

Response Lenses

searchEntitiesResponse_nextToken :: Lens' SearchEntitiesResponse (Maybe Text) Source #

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

searchEntitiesResponse_descriptions :: Lens' SearchEntitiesResponse (Maybe [EntityDescription]) Source #

An array of descriptions for each entity returned in the search result.

searchEntitiesResponse_httpStatus :: Lens' SearchEntitiesResponse Int Source #

The response's http status code.