| 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.AssociateEntityToThing
Description
Associates a device with a concrete thing that is in the user's registry.
A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.
Synopsis
- data AssociateEntityToThing = AssociateEntityToThing' {}
- newAssociateEntityToThing :: Text -> Text -> AssociateEntityToThing
- associateEntityToThing_namespaceVersion :: Lens' AssociateEntityToThing (Maybe Integer)
- associateEntityToThing_thingName :: Lens' AssociateEntityToThing Text
- associateEntityToThing_entityId :: Lens' AssociateEntityToThing Text
- data AssociateEntityToThingResponse = AssociateEntityToThingResponse' {
- httpStatus :: Int
- newAssociateEntityToThingResponse :: Int -> AssociateEntityToThingResponse
- associateEntityToThingResponse_httpStatus :: Lens' AssociateEntityToThingResponse Int
Creating a Request
data AssociateEntityToThing Source #
See: newAssociateEntityToThing smart constructor.
Constructors
| AssociateEntityToThing' | |
Fields
| |
Instances
newAssociateEntityToThing Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssociateEntityToThing |
Create a value of AssociateEntityToThing 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:AssociateEntityToThing', associateEntityToThing_namespaceVersion - The version of the user's namespace. Defaults to the latest version of
the user's namespace.
$sel:thingName:AssociateEntityToThing', associateEntityToThing_thingName - The name of the thing to which the entity is to be associated.
$sel:entityId:AssociateEntityToThing', associateEntityToThing_entityId - The ID of the device to be associated with the thing.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
Request Lenses
associateEntityToThing_namespaceVersion :: Lens' AssociateEntityToThing (Maybe Integer) Source #
The version of the user's namespace. Defaults to the latest version of the user's namespace.
associateEntityToThing_thingName :: Lens' AssociateEntityToThing Text Source #
The name of the thing to which the entity is to be associated.
associateEntityToThing_entityId :: Lens' AssociateEntityToThing Text Source #
The ID of the device to be associated with the thing.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
Destructuring the Response
data AssociateEntityToThingResponse Source #
See: newAssociateEntityToThingResponse smart constructor.
Constructors
| AssociateEntityToThingResponse' | |
Fields
| |
Instances
newAssociateEntityToThingResponse Source #
Create a value of AssociateEntityToThingResponse 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:httpStatus:AssociateEntityToThingResponse', associateEntityToThingResponse_httpStatus - The response's http status code.
Response Lenses
associateEntityToThingResponse_httpStatus :: Lens' AssociateEntityToThingResponse Int Source #
The response's http status code.