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

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

Read GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Show GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Generic GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Associated Types

type Rep GetEntities :: Type -> Type #

NFData GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Methods

rnf :: GetEntities -> () #

Hashable GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

ToJSON GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

AWSRequest GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Associated Types

type 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

ToQuery GetEntities Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

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

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

Instances

Instances details
Eq GetEntitiesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Read GetEntitiesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Show GetEntitiesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Generic GetEntitiesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.GetEntities

Associated Types

type Rep GetEntitiesResponse :: Type -> Type #

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 #

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.