IoTThingsGraph / Client / associate_entity_to_thing

associate_entity_to_thing#

IoTThingsGraph.Client.associate_entity_to_thing(**kwargs)#

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.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.associate_entity_to_thing(
    thingName='string',
    entityId='string',
    namespaceVersion=123
)
Parameters:

  • thingName (string) –

    [REQUIRED]

    The name of the thing to which the entity is to be associated.

  • entityId (string) –

    [REQUIRED]

    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

  • namespaceVersion (integer) – The version of the user’s namespace. Defaults to the latest version of the user’s namespace.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoTThingsGraph.Client.exceptions.InvalidRequestException

  • IoTThingsGraph.Client.exceptions.ResourceNotFoundException

  • IoTThingsGraph.Client.exceptions.InternalFailureException

  • IoTThingsGraph.Client.exceptions.ThrottlingException