training_datasets

Creates, updates, deletes or gets a training_dataset resource or lists training_datasets in a region

Overview

Name	training_datasets
Type	Resource
Description	Definition of AWS::CleanRoomsML::TrainingDataset Resource Type
Id	awscc.cleanroomsml.training_datasets

Fields

get (all properties)

Name	Datatype	Description
description	string
name	string
role_arn	string
▶tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.
▶training_data	array
training_dataset_arn	string
status	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
▶training_data	array
training_dataset_arn	string
region	string	AWS region.

For more information, see AWS::CleanRoomsML::TrainingDataset.

Methods

Name	Resource	Accessible by	Required Params
create_resource	training_datasets	INSERT	Name, RoleArn, TrainingData, region
delete_resource	training_datasets	DELETE	Identifier, region
update_resource	training_datasets	UPDATE	Identifier, PatchDocument, region
list_resources	training_datasets_list_only	SELECT	region
get_resource	training_datasets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual training_dataset.

SELECT
  region,
  description,
  name,
  role_arn,
  tags,
  training_data,
  training_dataset_arn,
  status
FROM awscc.cleanroomsml.training_datasets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ training_dataset_arn }}';

list (identifiers only)

Lists all training_datasets in a region.

SELECT
  region,
  training_dataset_arn
FROM awscc.cleanroomsml.training_datasets_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cleanroomsml.training_datasets (
  Name,
  RoleArn,
  TrainingData,
  region
)
SELECT
  '{{ name }}',
  '{{ role_arn }}',
  '{{ training_data }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cleanroomsml.training_datasets (
  Description,
  Name,
  RoleArn,
  Tags,
  TrainingData,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ training_data }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: training_dataset
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: training_data
      value:
        - type: '{{ type }}'
          input_config:
            schema:
              - column_name: '{{ column_name }}'
                column_types:
                  - '{{ column_types[0] }}'
            data_source:
              glue_data_source:
                table_name: '{{ table_name }}'
                database_name: '{{ database_name }}'
                catalog_id: '{{ catalog_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cleanroomsml.training_datasets
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ training_dataset_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cleanroomsml.training_datasets
WHERE
  Identifier = '{{ training_dataset_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

cleanrooms-ml:CreateTrainingDataset,
cleanrooms-ml:GetTrainingDataset,
cleanrooms-ml:TagResource,
iam:PassRole

Read

cleanrooms-ml:GetTrainingDataset

Delete

cleanrooms-ml:DeleteTrainingDataset

List

cleanrooms-ml:ListTrainingDatasets

Update

cleanrooms-ml:TagResource,
cleanrooms-ml:UntagResource