data_automation_projects

Creates, updates, deletes or gets a data_automation_project resource or lists data_automation_projects in a region

Overview

Name	data_automation_projects
Type	Resource
Description	Definition of AWS::Bedrock::DataAutomationProject Resource Type
Id	awscc.bedrock.data_automation_projects

Fields

get (all properties)

Name	Datatype	Description
creation_time	string	Time Stamp
▶custom_output_configuration	object	Custom output configuration
last_modified_time	string	Time Stamp
▶override_configuration	object	Override configuration
project_arn	string	ARN of a DataAutomationProject
project_description	string	Description of the DataAutomationProject
project_name	string	Name of the DataAutomationProject
project_stage	string	Stage of the Project
▶standard_output_configuration	object	Standard output configuration
status	string
kms_key_id	string	KMS key identifier
kms_encryption_context	object	KMS encryption context
▶tags	array	List of Tags
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
project_arn	string	ARN of a DataAutomationProject
region	string	AWS region.

For more information, see AWS::Bedrock::DataAutomationProject.

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_automation_projects	INSERT	ProjectName, region
delete_resource	data_automation_projects	DELETE	Identifier, region
update_resource	data_automation_projects	UPDATE	Identifier, PatchDocument, region
list_resources	data_automation_projects_list_only	SELECT	region
get_resource	data_automation_projects	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual data_automation_project.

SELECT
  region,
  creation_time,
  custom_output_configuration,
  last_modified_time,
  override_configuration,
  project_arn,
  project_description,
  project_name,
  project_stage,
  standard_output_configuration,
  status,
  kms_key_id,
  kms_encryption_context,
  tags
FROM awscc.bedrock.data_automation_projects
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ project_arn }}';

list (identifiers only)

Lists all data_automation_projects in a region.

SELECT
  region,
  project_arn
FROM awscc.bedrock.data_automation_projects_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.bedrock.data_automation_projects (
  ProjectName,
  region
)
SELECT
  '{{ project_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.bedrock.data_automation_projects (
  CustomOutputConfiguration,
  OverrideConfiguration,
  ProjectDescription,
  ProjectName,
  StandardOutputConfiguration,
  KmsKeyId,
  KmsEncryptionContext,
  Tags,
  region
)
SELECT
  '{{ custom_output_configuration }}',
  '{{ override_configuration }}',
  '{{ project_description }}',
  '{{ project_name }}',
  '{{ standard_output_configuration }}',
  '{{ kms_key_id }}',
  '{{ kms_encryption_context }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_automation_project
    props:
      - name: custom_output_configuration
        value:
          blueprints:
            - blueprint_arn: '{{ blueprint_arn }}'
              blueprint_version: '{{ blueprint_version }}'
              blueprint_stage: '{{ blueprint_stage }}'
      - name: override_configuration
        value:
          document:
            splitter:
              state: '{{ state }}'
            modality_processing:
              state: null
          audio:
            modality_processing: null
          video:
            modality_processing: null
          image:
            modality_processing: null
          modality_routing:
            jpeg: '{{ jpeg }}'
            png: null
            mp4: null
            mov: null
      - name: project_description
        value: '{{ project_description }}'
      - name: project_name
        value: '{{ project_name }}'
      - name: standard_output_configuration
        value:
          document:
            extraction:
              granularity:
                types:
                  - '{{ types[0] }}'
              bounding_box:
                state: null
            generative_field:
              state: null
            output_format:
              text_format:
                types:
                  - '{{ types[0] }}'
              additional_file_format:
                state: null
          image:
            extraction:
              category:
                state: null
                types:
                  - '{{ types[0] }}'
              bounding_box:
                state: null
            generative_field:
              state: null
              types:
                - '{{ types[0] }}'
          video:
            extraction:
              category:
                state: null
                types:
                  - '{{ types[0] }}'
              bounding_box:
                state: null
            generative_field:
              state: null
              types:
                - '{{ types[0] }}'
          audio:
            extraction:
              category:
                state: null
                types:
                  - '{{ types[0] }}'
            generative_field:
              state: null
              types:
                - '{{ types[0] }}'
      - name: kms_key_id
        value: '{{ kms_key_id }}'
      - name: kms_encryption_context
        value: {}
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.bedrock.data_automation_projects
SET PatchDocument = string('{{ {
    "CustomOutputConfiguration": custom_output_configuration,
    "OverrideConfiguration": override_configuration,
    "ProjectDescription": project_description,
    "StandardOutputConfiguration": standard_output_configuration,
    "KmsKeyId": kms_key_id,
    "KmsEncryptionContext": kms_encryption_context,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ project_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.bedrock.data_automation_projects
WHERE
  Identifier = '{{ project_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

bedrock:CreateDataAutomationProject,
bedrock:GetDataAutomationProject,
bedrock:TagResource,
bedrock:ListTagsForResource,
kms:DescribeKey,
kms:Decrypt,
kms:GenerateDataKey

Read

bedrock:GetDataAutomationProject,
bedrock:ListTagsForResource,
kms:DescribeKey,
kms:Decrypt

Update

bedrock:UpdateDataAutomationProject,
bedrock:GetDataAutomationProject,
bedrock:TagResource,
bedrock:UntagResource,
bedrock:ListTagsForResource,
kms:DescribeKey,
kms:Decrypt,
kms:GenerateDataKey

Delete

bedrock:DeleteDataAutomationProject,
bedrock:GetDataAutomationProject,
kms:DescribeKey,
kms:Decrypt

List

bedrock:ListDataAutomationProjects