flywheels

Creates, updates, deletes or gets a flywheel resource or lists flywheels in a region

Overview

Name	flywheels
Type	Resource
Description	The AWS::Comprehend::Flywheel resource creates an Amazon Comprehend Flywheel that enables customer to train their model.
Id	aws.comprehend.flywheels

Fields

Name	Datatype	Description
active_model_arn	string
data_access_role_arn	string
data_lake_s3_uri	string
data_security_config	object
flywheel_name	string
model_type	string
tags	array
task_config	object
arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FlywheelName, DataAccessRoleArn, DataLakeS3Uri, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all flywheels in a region.

SELECT
region,
active_model_arn,
data_access_role_arn,
data_lake_s3_uri,
data_security_config,
flywheel_name,
model_type,
tags,
task_config,
arn
FROM aws.comprehend.flywheels
WHERE region = 'us-east-1';

Gets all properties from an individual flywheel.

SELECT
region,
active_model_arn,
data_access_role_arn,
data_lake_s3_uri,
data_security_config,
flywheel_name,
model_type,
tags,
task_config,
arn
FROM aws.comprehend.flywheels
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.comprehend.flywheels (
 DataAccessRoleArn,
 DataLakeS3Uri,
 FlywheelName,
 region
)
SELECT 
'{{ DataAccessRoleArn }}',
 '{{ DataLakeS3Uri }}',
 '{{ FlywheelName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.comprehend.flywheels (
 ActiveModelArn,
 DataAccessRoleArn,
 DataLakeS3Uri,
 DataSecurityConfig,
 FlywheelName,
 ModelType,
 Tags,
 TaskConfig,
 region
)
SELECT 
 '{{ ActiveModelArn }}',
 '{{ DataAccessRoleArn }}',
 '{{ DataLakeS3Uri }}',
 '{{ DataSecurityConfig }}',
 '{{ FlywheelName }}',
 '{{ ModelType }}',
 '{{ Tags }}',
 '{{ TaskConfig }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: flywheel
    props:
      - name: ActiveModelArn
        value: '{{ ActiveModelArn }}'
      - name: DataAccessRoleArn
        value: '{{ DataAccessRoleArn }}'
      - name: DataLakeS3Uri
        value: '{{ DataLakeS3Uri }}'
      - name: DataSecurityConfig
        value:
          ModelKmsKeyId: '{{ ModelKmsKeyId }}'
          VolumeKmsKeyId: null
          DataLakeKmsKeyId: null
          VpcConfig:
            SecurityGroupIds:
              - '{{ SecurityGroupIds[0] }}'
            Subnets:
              - '{{ Subnets[0] }}'
      - name: FlywheelName
        value: '{{ FlywheelName }}'
      - name: ModelType
        value: '{{ ModelType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: TaskConfig
        value:
          LanguageCode: '{{ LanguageCode }}'
          DocumentClassificationConfig:
            Mode: '{{ Mode }}'
            Labels:
              - '{{ Labels[0] }}'
          EntityRecognitionConfig:
            EntityTypes:
              - Type: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.comprehend.flywheels
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

iam:PassRole,
comprehend:CreateFlywheel,
comprehend:DescribeFlywheel,
comprehend:ListTagsForResource

Read

comprehend:DescribeFlywheel,
comprehend:ListTagsForResource

Update

iam:PassRole,
comprehend:DescribeFlywheel,
comprehend:UpdateFlywheel,
comprehend:ListTagsForResource,
comprehend:TagResource,
comprehend:UntagResource

Delete

comprehend:DeleteFlywheel,
comprehend:DescribeFlywheel

List

comprehend:ListFlywheels