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.GetEntities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

Properties
States
Events
Actions
Capabilities
Mappings
Devices
Device Models
Services

This action doesn't return definitions for systems, flows, and deployments.

Synopsis

Creating a Request

data GetEntities Source #

See: newGetEntities smart constructor.

Constructors

GetEntities'
Fields namespaceVersion :: Maybe Integer The version of the user's namespace. Defaults to the latest version of the user's namespace. ids :: [Text] An array of entity IDs. The IDs should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Instances

Instances details

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

newGetEntities :: GetEntities Source #

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

$sel:ids:GetEntities', getEntities_ids - An array of entity IDs.

The IDs should be in the following format.

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

Request Lenses

getEntities_namespaceVersion :: Lens' GetEntities (Maybe Integer) Source #

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

getEntities_ids :: Lens' GetEntities [Text] Source #

An array of entity IDs.

The IDs should be in the following format.

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

Destructuring the Response

data GetEntitiesResponse Source #

See: newGetEntitiesResponse smart constructor.

Constructors

GetEntitiesResponse'
Fields descriptions :: Maybe [EntityDescription] An array of descriptions for the specified entities. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetEntitiesResponse Source #

Arguments

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

Create a value of GetEntitiesResponse 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:descriptions:GetEntitiesResponse', getEntitiesResponse_descriptions - An array of descriptions for the specified entities.

$sel:httpStatus:GetEntitiesResponse', getEntitiesResponse_httpStatus - The response's http status code.

Response Lenses

getEntitiesResponse_descriptions :: Lens' GetEntitiesResponse (Maybe [EntityDescription]) Source #

An array of descriptions for the specified entities.

getEntitiesResponse_httpStatus :: Lens' GetEntitiesResponse Int Source #

The response's http status code.