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	awscc.personalize.dataset_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	dataset_groups	INSERT	Name, region
delete_resource	dataset_groups	DELETE	Identifier, region
list_resources	dataset_groups_list_only	SELECT	region
get_resource	dataset_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual dataset_group.

SELECT
  region,
  dataset_group_arn,
  name,
  kms_key_arn,
  role_arn,
  domain
FROM awscc.personalize.dataset_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ dataset_group_arn }}';

list (identifiers only)

Lists all dataset_groups in a region.

SELECT
  region,
  dataset_group_arn
FROM awscc.personalize.dataset_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.personalize.dataset_groups (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.personalize.dataset_groups (
  Name,
  KmsKeyArn,
  RoleArn,
  Domain,
  region
)
SELECT
  '{{ name }}',
  '{{ kms_key_arn }}',
  '{{ role_arn }}',
  '{{ 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: kms_key_arn
        value: '{{ kms_key_arn }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: domain
        value: '{{ domain }}'

DELETE example

/*+ delete */
DELETE FROM awscc.personalize.dataset_groups
WHERE
  Identifier = '{{ dataset_group_arn }}' 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