create_project

IoTSiteWise.Client.create_project(**kwargs)

Creates a project in the specified portal.

Note

Make sure that the project name and description don't contain confidential information.

See also: AWS API Documentation

Request Syntax

response = client.create_project(
    portalId='string',
    projectName='string',
    projectDescription='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)

Parameters

• portalId (string) --

  [REQUIRED]

  The ID of the portal in which to create the project.

• projectName (string) --

  [REQUIRED]

  A friendly name for the project.

• projectDescription (string) -- A description for the project.
• clientToken (string) --

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

  This field is autopopulated if not provided.

• tags (dict) --

  A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide .

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'projectId': 'string',
    'projectArn': 'string'
}

Response Structure

• (dict) --

  • projectId (string) --

    The ID of the project.

  • projectArn (string) --

    The ARN of the project, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException
• IoTSiteWise.Client.exceptions.ResourceNotFoundException
• IoTSiteWise.Client.exceptions.InternalFailureException
• IoTSiteWise.Client.exceptions.ThrottlingException
• IoTSiteWise.Client.exceptions.LimitExceededException