dataset_groups

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

Overview

Name	dataset_groups
Type	Resource
Id	aws.personalize.dataset_groups

Fields

The following fields are returned by SELECT queries:

describe_dataset_group

Name	Datatype	Description
name	string	The name of the dataset group. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
creation_date_time	string (date-time)	The creation date and time (in Unix time) of the dataset group.
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
domain	string	The domain of a Domain dataset group. (ECOMMERCE, VIDEO_ON_DEMAND)
failure_reason	string	If creating a dataset group fails, provides the reason why.
kms_key_arn	string	The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets. (pattern: <code>arn:aws.:kms:.:[0-9]{12}:key/.*</code>)
last_updated_date_time	string (date-time)	The last update date and time (in Unix time) of the dataset group.
role_arn	string	The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key. (pattern: <code>arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
status	string	The current status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING

list_dataset_groups

Name	Datatype	Description
name	string	The name of the dataset group. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*</code>)
creation_date_time	string (date-time)	The date and time (in Unix time) that the dataset group was created.
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group. (pattern: <code>arn:([a-z\d-]+):personalize:.:.:.+</code>)
domain	string	The domain of a Domain dataset group. (ECOMMERCE, VIDEO_ON_DEMAND)
failure_reason	string	If creating a dataset group fails, the reason behind the failure.
last_updated_date_time	string (date-time)	The date and time (in Unix time) that the dataset group was last updated.
status	string	The status of the dataset group. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dataset_group	select	region		Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
list_dataset_groups	select	region		Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
create_dataset_group	insert	region, name		Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
delete_dataset_group	delete	region		Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_dataset_group

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

SELECT
name,
creation_date_time,
dataset_group_arn,
domain,
failure_reason,
kms_key_arn,
last_updated_date_time,
role_arn,
status
FROM aws.personalize.dataset_groups
WHERE region = '{{ region }}' -- required
;

list_dataset_groups

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

SELECT
name,
creation_date_time,
dataset_group_arn,
domain,
failure_reason,
last_updated_date_time,
status
FROM aws.personalize.dataset_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_dataset_group

Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset: Item interactions Items Users Actions Action interactions A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. A dataset group can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup

INSERT INTO aws.personalize.dataset_groups (
name,
roleArn,
kmsKeyArn,
domain,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ roleArn }}',
'{{ kmsKeyArn }}',
'{{ domain }}',
'{{ tags }}',
'{{ region }}'
RETURNING
dataset_group_arn,
domain
;

Manifest

# Description fields are for documentation purposes
- name: dataset_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dataset_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name for the new dataset group.
  - name: roleArn
    value: "{{ roleArn }}"
    description: |
      The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"
    description: |
      The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
  - name: domain
    value: "{{ domain }}"
    description: |
      The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
    valid_values: ['ECOMMERCE', 'VIDEO_ON_DEMAND']
  - name: tags
    description: |
      A list of tags to apply to the dataset group.
    value:
      - tagKey: "{{ tagKey }}"
        tagValue: "{{ tagValue }}"

DELETE examples

delete_dataset_group

Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All datasets in the dataset group.

DELETE FROM aws.personalize.dataset_groups
WHERE region = '{{ region }}' --required
;