dataset_groups

Creates, updates, deletes or gets a dataset_group resource or lists dataset_groups in a region

Overview

Name	dataset_groups
Type	Resource
Description	Resource Schema for AWS::Personalize::DatasetGroup.
Id	aws.personalize.dataset_groups

Fields

Name	Datatype	Description
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group.
name	string	The name for the new dataset group.
kms_key_arn	string	The Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets.
role_arn	string	The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
domain	string	The domain of a Domain dataset group.
region	string	AWS region.

For more information, see AWS::Personalize::DatasetGroup.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all dataset_groups in a region.

SELECT
region,
dataset_group_arn,
name,
kms_key_arn,
role_arn,
domain
FROM aws.personalize.dataset_groups
WHERE region = 'us-east-1';

Gets all properties from an individual dataset_group.

SELECT
region,
dataset_group_arn,
name,
kms_key_arn,
role_arn,
domain
FROM aws.personalize.dataset_groups
WHERE region = 'us-east-1' AND data__Identifier = '<DatasetGroupArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.personalize.dataset_groups (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.personalize.dataset_groups (
 Name,
 KmsKeyArn,
 RoleArn,
 Domain,
 region
)
SELECT 
 '{{ Name }}',
 '{{ KmsKeyArn }}',
 '{{ RoleArn }}',
 '{{ Domain }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: dataset_group
    props:
      - name: Name
        value: '{{ Name }}'
      - name: KmsKeyArn
        value: '{{ KmsKeyArn }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Domain
        value: '{{ Domain }}'

DELETE example

/*+ delete */
DELETE FROM aws.personalize.dataset_groups
WHERE data__Identifier = '<DatasetGroupArn>'
AND region = 'us-east-1';

Permissions

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

Create

personalize:CreateDatasetGroup,
personalize:DescribeDatasetGroup,
iam:PassRole

Read

personalize:DescribeDatasetGroup

Delete

personalize:DescribeDatasetGroup,
personalize:DeleteDatasetGroup

List

personalize:ListDatasetGroups