projects

Creates, updates, deletes, gets or lists a projects resource.

Overview

Name	projects
Type	Resource
Id	aws.iotsitewise.projects

Fields

The following fields are returned by SELECT queries:

list_projects

Name	Datatype	Description
id	string	The ID of the project. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
name	string	The name of the project. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
creation_date	string (date-time)	The date the project was created, in Unix epoch time.
description	string	The project's description. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_update_date	string (date-time)	The date the project was last updated, in Unix epoch time.

describe_project

Name	Datatype	Description
portal_id	string	The ID of the portal that the project is in. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
project_arn	string	The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
project_creation_date	string (date-time)	The date the project was created, in Unix epoch time.
project_description	string	The project's description. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
project_id	string	The ID of the project. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
project_last_update_date	string (date-time)	The date the project was last updated, in Unix epoch time.
project_name	string	The name of the project. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_projects	select	portalId, region	nextToken, maxResults	Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
describe_project	select	project_id, region		Retrieves information about a project.
create_project	insert	region, portalId, projectName		The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information.
update_project	update	project_id, region, projectName		The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise Monitor project.
delete_project	delete	project_id, region	clientToken	Deletes a project from IoT SiteWise Monitor.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
portalId	string	The ID of the portal.
project_id	string	The ID of the project.
region	string	AWS region (default: us-east-1)
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.
maxResults	integer	The maximum number of results to return for each paginated request. Default: 50
nextToken	string	The token to be used for the next set of paginated results.

SELECT examples

list_projects

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

SELECT
id,
name,
creation_date,
description,
last_update_date
FROM aws.iotsitewise.projects
WHERE portalId = '{{ portalId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

describe_project

Retrieves information about a project.

SELECT
portal_id,
project_arn,
project_creation_date,
project_description,
project_id,
project_last_update_date,
project_name
FROM aws.iotsitewise.projects
WHERE project_id = '{{ project_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_project

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a project in the specified portal. Make sure that the project name and description don't contain confidential information.

INSERT INTO aws.iotsitewise.projects (
portalId,
projectName,
projectDescription,
clientToken,
tags,
region
)
SELECT 
'{{ portalId }}' /* required */,
'{{ projectName }}' /* required */,
'{{ projectDescription }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
project_arn,
project_id
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the projects resource.
  - name: portalId
    value: "{{ portalId }}"
  - name: projectName
    value: "{{ projectName }}"
  - name: projectDescription
    value: "{{ projectDescription }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_project

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise Monitor project.

UPDATE aws.iotsitewise.projects
SET 
projectName = '{{ projectName }}',
projectDescription = '{{ projectDescription }}',
clientToken = '{{ clientToken }}'
WHERE 
project_id = '{{ project_id }}' --required
AND region = '{{ region }}' --required
AND projectName = '{{ projectName }}' --required;

DELETE examples

delete_project

Deletes a project from IoT SiteWise Monitor.

DELETE FROM aws.iotsitewise.projects
WHERE project_id = '{{ project_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;