create_project

IoT1ClickProjects.Client.create_project(**kwargs)

Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The name of the project to create.

  • description (string) -- An optional description for the project.
  • placementTemplate (dict) --

    The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject 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) --
  • tags (dict) --

    Optional tags (metadata key/value pairs) to be associated with the project. For example, { {"key1": "value1", "key2": "value2"} } . For more information, see AWS Tagging Strategies.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoT1ClickProjects.Client.exceptions.InternalFailureException
  • IoT1ClickProjects.Client.exceptions.InvalidRequestException
  • IoT1ClickProjects.Client.exceptions.ResourceConflictException