datasets

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

Overview

Name	datasets
Type	Resource
Description	Resource Type Definition for AWS::Forecast::Dataset
Id	awscc.forecast.datasets

Fields

get (all properties)

Name	Datatype	Description
arn	string
dataset_name	string	A name for the dataset
dataset_type	string	The dataset type
data_frequency	string	Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
domain	string	The domain associated with the dataset
▶encryption_config	object
▶schema	object
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	datasets	INSERT	DatasetName, DatasetType, Domain, Schema, region
delete_resource	datasets	DELETE	Identifier, 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,
  arn,
  dataset_name,
  dataset_type,
  data_frequency,
  domain,
  encryption_config,
  schema,
  tags
FROM awscc.forecast.datasets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all datasets in a region.

SELECT
  region,
  arn
FROM awscc.forecast.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.forecast.datasets (
  DatasetName,
  DatasetType,
  Domain,
  Schema,
  region
)
SELECT
  '{{ dataset_name }}',
  '{{ dataset_type }}',
  '{{ domain }}',
  '{{ schema }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.forecast.datasets (
  DatasetName,
  DatasetType,
  DataFrequency,
  Domain,
  EncryptionConfig,
  Schema,
  Tags,
  region
)
SELECT
  '{{ dataset_name }}',
  '{{ dataset_type }}',
  '{{ data_frequency }}',
  '{{ domain }}',
  '{{ encryption_config }}',
  '{{ schema }}',
  '{{ 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_type
        value: '{{ dataset_type }}'
      - name: data_frequency
        value: '{{ data_frequency }}'
      - name: domain
        value: '{{ domain }}'
      - name: encryption_config
        value:
          kms_key_arn: '{{ kms_key_arn }}'
          role_arn: '{{ role_arn }}'
      - name: schema
        value:
          attributes:
            - attribute_name: '{{ attribute_name }}'
              attribute_type: '{{ attribute_type }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

DELETE example

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

Permissions

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

Create

forecast:CreateDataset

Read

forecast:DescribeDataset

Delete

forecast:DeleteDataset

List

forecast:ListDatasets