datasets

Creates, updates, deletes or gets a dataset resource or lists datasets in a region

Overview

Name	datasets
Type	Resource
Description	Resource schema for AWS::IoTSiteWise::Dataset.
Id	awscc.iotsitewise.datasets

Fields

get (all properties)

Name	Datatype	Description
dataset_id	string	The ID of the dataset.
dataset_arn	string	The ARN of the dataset.
dataset_name	string	The name of the dataset.
dataset_description	string	A description about the dataset, and its functionality.
▶dataset_source	object	The data source for the dataset.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
dataset_id	string	The ID of the dataset.
region	string	AWS region.

For more information, see AWS::IoTSiteWise::Dataset.

Methods

Name	Resource	Accessible by	Required Params
create_resource	datasets	INSERT	DatasetName, DatasetSource, region
delete_resource	datasets	DELETE	Identifier, region
update_resource	datasets	UPDATE	Identifier, PatchDocument, region
list_resources	datasets_list_only	SELECT	region
get_resource	datasets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual dataset.

SELECT
  region,
  dataset_id,
  dataset_arn,
  dataset_name,
  dataset_description,
  dataset_source,
  tags
FROM awscc.iotsitewise.datasets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ dataset_id }}';

list (identifiers only)

Lists all datasets in a region.

SELECT
  region,
  dataset_id
FROM awscc.iotsitewise.datasets_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new dataset resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.iotsitewise.datasets (
  DatasetName,
  DatasetSource,
  region
)
SELECT
  '{{ dataset_name }}',
  '{{ dataset_source }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iotsitewise.datasets (
  DatasetName,
  DatasetDescription,
  DatasetSource,
  Tags,
  region
)
SELECT
  '{{ dataset_name }}',
  '{{ dataset_description }}',
  '{{ dataset_source }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: dataset
    props:
      - name: dataset_name
        value: '{{ dataset_name }}'
      - name: dataset_description
        value: '{{ dataset_description }}'
      - name: dataset_source
        value:
          source_format: '{{ source_format }}'
          source_type: '{{ source_type }}'
          source_detail:
            kendra:
              knowledge_base_arn: '{{ knowledge_base_arn }}'
              role_arn: '{{ role_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a dataset resource, using stack-deploy.

/*+ update */
UPDATE awscc.iotsitewise.datasets
SET PatchDocument = string('{{ {
    "DatasetName": dataset_name,
    "DatasetDescription": dataset_description,
    "DatasetSource": dataset_source,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ dataset_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iotsitewise.datasets
WHERE
  Identifier = '{{ dataset_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the datasets resource, the following permissions are required:

Create

iotsitewise:CreateDataset,
iotsitewise:DescribeDataset,
iam:PassRole,
iotsitewise:ListTagsForResource,
iotsitewise:TagResource

Read

iotsitewise:DescribeDataset,
iotsitewise:ListTagsForResource

Update

iotsitewise:UpdateDataset,
iotsitewise:DescribeDataset,
iam:PassRole,
iotsitewise:ListTagsForResource,
iotsitewise:TagResource,
iotsitewise:UntagResource

Delete

iotsitewise:DeleteDataset,
iotsitewise:DescribeDataset,
iotsitewise:ListTagsForResource

List

iotsitewise:ListDatasets,
iotsitewise:ListTagsForResource