document_classifiers

Creates, updates, deletes or gets a document_classifier resource or lists document_classifiers in a region

Overview

Name	document_classifiers
Type	Resource
Description	Document Classifier enables training document classifier models.
Id	awscc.comprehend.document_classifiers

Fields

get (all properties)

Name	Datatype	Description
data_access_role_arn	string
▶input_data_config	object
▶output_data_config	object
language_code	string
model_kms_key_id	string
model_policy	string
document_classifier_name	string
mode	string
▶tags	array
version_name	string
▶vpc_config	object
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Comprehend::DocumentClassifier.

Methods

Name	Resource	Accessible by	Required Params
create_resource	document_classifiers	INSERT	DocumentClassifierName, DataAccessRoleArn, InputDataConfig, LanguageCode, region
delete_resource	document_classifiers	DELETE	Identifier, region
update_resource	document_classifiers	UPDATE	Identifier, PatchDocument, region
list_resources	document_classifiers_list_only	SELECT	region
get_resource	document_classifiers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual document_classifier.

SELECT
  region,
  data_access_role_arn,
  input_data_config,
  output_data_config,
  language_code,
  model_kms_key_id,
  model_policy,
  document_classifier_name,
  mode,
  tags,
  version_name,
  volume_kms_key_id,
  vpc_config,
  arn
FROM awscc.comprehend.document_classifiers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all document_classifiers in a region.

SELECT
  region,
  arn
FROM awscc.comprehend.document_classifiers_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.comprehend.document_classifiers (
  DataAccessRoleArn,
  InputDataConfig,
  LanguageCode,
  DocumentClassifierName,
  region
)
SELECT
  '{{ data_access_role_arn }}',
  '{{ input_data_config }}',
  '{{ language_code }}',
  '{{ document_classifier_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.comprehend.document_classifiers (
  DataAccessRoleArn,
  InputDataConfig,
  OutputDataConfig,
  LanguageCode,
  ModelKmsKeyId,
  ModelPolicy,
  DocumentClassifierName,
  Mode,
  Tags,
  VersionName,
  VolumeKmsKeyId,
  VpcConfig,
  region
)
SELECT
  '{{ data_access_role_arn }}',
  '{{ input_data_config }}',
  '{{ output_data_config }}',
  '{{ language_code }}',
  '{{ model_kms_key_id }}',
  '{{ model_policy }}',
  '{{ document_classifier_name }}',
  '{{ mode }}',
  '{{ tags }}',
  '{{ version_name }}',
  '{{ volume_kms_key_id }}',
  '{{ vpc_config }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: document_classifier
    props:
      - name: data_access_role_arn
        value: '{{ data_access_role_arn }}'
      - name: input_data_config
        value:
          augmented_manifests:
            - attribute_names:
                - '{{ attribute_names[0] }}'
              s3_uri: '{{ s3_uri }}'
              split: '{{ split }}'
          data_format: '{{ data_format }}'
          label_delimiter: '{{ label_delimiter }}'
          document_type: '{{ document_type }}'
          documents:
            s3_uri: null
            test_s3_uri: null
          document_reader_config:
            document_read_action: '{{ document_read_action }}'
            document_read_mode: '{{ document_read_mode }}'
            feature_types:
              - '{{ feature_types[0] }}'
          s3_uri: null
          test_s3_uri: null
      - name: output_data_config
        value:
          kms_key_id: '{{ kms_key_id }}'
          s3_uri: null
      - name: language_code
        value: '{{ language_code }}'
      - name: model_kms_key_id
        value: null
      - name: model_policy
        value: '{{ model_policy }}'
      - name: document_classifier_name
        value: '{{ document_classifier_name }}'
      - name: mode
        value: '{{ mode }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: version_name
        value: '{{ version_name }}'
      - name: volume_kms_key_id
        value: null
      - name: vpc_config
        value:
          security_group_ids:
            - '{{ security_group_ids[0] }}'
          subnets:
            - '{{ subnets[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.comprehend.document_classifiers
SET PatchDocument = string('{{ {
    "ModelPolicy": model_policy,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.comprehend.document_classifiers
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

iam:PassRole,
comprehend:CreateDocumentClassifier,
comprehend:DescribeDocumentClassifier,
comprehend:DescribeResourcePolicy,
comprehend:ListTagsForResource,
textract:DetectDocumentText

Read

comprehend:DescribeDocumentClassifier,
comprehend:DescribeResourcePolicy,
comprehend:ListTagsForResource

Update

iam:PassRole,
comprehend:PutResourcePolicy,
comprehend:DeleteResourcePolicy,
comprehend:DescribeResourcePolicy,
comprehend:DescribeDocumentClassifier,
comprehend:ListTagsForResource,
comprehend:TagResource,
comprehend:UntagResource

Delete

comprehend:DescribeDocumentClassifier,
comprehend:DeleteDocumentClassifier

List

comprehend:ListDocumentClassifiers