IoT1ClickProjects / Client / update_project

update_project#

IoT1ClickProjects.Client.update_project(**kwargs)#

Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").

See also: AWS API Documentation

Request Syntax

response = client.update_project(
    projectName='string',
    description='string',
    placementTemplate={
        'defaultAttributes': {
            'string': 'string'
        },
        'deviceTemplates': {
            'string': {
                'deviceType': 'string',
                'callbackOverrides': {
                    'string': 'string'
                }
            }
        }
    }
)
Parameters:

  • projectName (string) –

    [REQUIRED]

    The name of the project to be updated.

  • description (string) – An optional user-defined description for the project.

  • placementTemplate (dict) –

    An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

    • defaultAttributes (dict) –

      The default attributes (key/value pairs) to be applied to all placements using this template.

      • (string) –

        • (string) –

    • deviceTemplates (dict) –

      An object specifying the DeviceTemplate for all placements using this ( PlacementTemplate) template.

      • (string) –

        • (dict) –

          An object representing a device for a placement template (see PlacementTemplate).

          • deviceType (string) –

            The device type, which currently must be "button".

          • callbackOverrides (dict) –

            An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

            • (string) –

              • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoT1ClickProjects.Client.exceptions.InternalFailureException

  • IoT1ClickProjects.Client.exceptions.InvalidRequestException

  • IoT1ClickProjects.Client.exceptions.ResourceNotFoundException

  • IoT1ClickProjects.Client.exceptions.TooManyRequestsException