IoT1ClickProjects / Client / associate_device_with_placement

associate_device_with_placement#

IoT1ClickProjects.Client.associate_device_with_placement(**kwargs)#

Associates a physical device with a placement.

See also: AWS API Documentation

Request Syntax

response = client.associate_device_with_placement(
    projectName='string',
    placementName='string',
    deviceId='string',
    deviceTemplateName='string'
)
Parameters:

  • projectName (string) –

    [REQUIRED]

    The name of the project containing the placement in which to associate the device.

  • placementName (string) –

    [REQUIRED]

    The name of the placement in which to associate the device.

  • deviceId (string) –

    [REQUIRED]

    The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

  • deviceTemplateName (string) –

    [REQUIRED]

    The device template name to associate with the device ID.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoT1ClickProjects.Client.exceptions.InternalFailureException

  • IoT1ClickProjects.Client.exceptions.InvalidRequestException

  • IoT1ClickProjects.Client.exceptions.ResourceConflictException

  • IoT1ClickProjects.Client.exceptions.ResourceNotFoundException