data_automation_projects

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

Overview

Name	data_automation_projects
Type	Resource
Id	aws.bedrock_data_automation.data_automation_projects

Fields

The following fields are returned by SELECT queries:

get_data_automation_project

Name	Datatype	Description
creation_time	string (date-time)	Time Stamp
custom_output_configuration	object	Custom output configuration
data_automation_library_configuration	object	DataAutomation Library configuration
kms_encryption_context	object
kms_key_id	string	KMS Key Identifier (pattern: <code>[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+</code>)
last_modified_time	string (date-time)	Time Stamp
override_configuration	object	Override configuration
project_arn	string	ARN of a DataAutomationProject (pattern: <code>arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}</code>)
project_description	string	Description of the DataAutomationProject
project_name	string	Name of the DataAutomationProject (pattern: <code>[a-zA-Z0-9-_]+</code>)
project_stage	string	Stage of the Project (DEVELOPMENT, LIVE)
project_type	string	Type of the DataAutomationProject (ASYNC, SYNC)
standard_output_configuration	object	Standard output configuration
status	string	Status of Data Automation Project (COMPLETED, IN_PROGRESS, FAILED)

list_data_automation_projects

Name	Datatype	Description
creation_time	string (date-time)	Time Stamp
project_arn	string	ARN of a DataAutomationProject (pattern: <code>arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}</code>)
project_name	string	Name of the DataAutomationProject (pattern: <code>[a-zA-Z0-9-_]+</code>)
project_stage	string	Stage of the Project (DEVELOPMENT, LIVE)
project_type	string	Type of the DataAutomationProject (ASYNC, SYNC)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_automation_project	select	project_arn, region		Gets an existing Amazon Bedrock Data Automation Project
list_data_automation_projects	select	region		Lists all existing Amazon Bedrock Data Automation Projects
create_data_automation_project	insert	region, projectName, standardOutputConfiguration		Creates an Amazon Bedrock Data Automation Project
update_data_automation_project	update	project_arn, region, standardOutputConfiguration		Updates an existing Amazon Bedrock Data Automation Project
delete_data_automation_project	delete	project_arn, region		Deletes an existing Amazon Bedrock Data Automation Project

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
project_arn	string	ARN generated at the server side when a DataAutomationProject is created
region	string	AWS region (default: us-east-1)

SELECT examples

get_data_automation_project

Gets an existing Amazon Bedrock Data Automation Project

SELECT
creation_time,
custom_output_configuration,
data_automation_library_configuration,
kms_encryption_context,
kms_key_id,
last_modified_time,
override_configuration,
project_arn,
project_description,
project_name,
project_stage,
project_type,
standard_output_configuration,
status
FROM aws.bedrock_data_automation.data_automation_projects
WHERE project_arn = '{{ project_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_data_automation_projects

Lists all existing Amazon Bedrock Data Automation Projects

SELECT
creation_time,
project_arn,
project_name,
project_stage,
project_type
FROM aws.bedrock_data_automation.data_automation_projects
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_automation_project

Creates an Amazon Bedrock Data Automation Project

INSERT INTO aws.bedrock_data_automation.data_automation_projects (
projectName,
projectDescription,
projectStage,
projectType,
standardOutputConfiguration,
customOutputConfiguration,
overrideConfiguration,
dataAutomationLibraryConfiguration,
clientToken,
encryptionConfiguration,
tags,
region
)
SELECT 
'{{ projectName }}' /* required */,
'{{ projectDescription }}',
'{{ projectStage }}',
'{{ projectType }}',
'{{ standardOutputConfiguration }}' /* required */,
'{{ customOutputConfiguration }}',
'{{ overrideConfiguration }}',
'{{ dataAutomationLibraryConfiguration }}',
'{{ clientToken }}',
'{{ encryptionConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
project_arn,
project_stage,
status
;

Manifest

# Description fields are for documentation purposes
- name: data_automation_projects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_automation_projects resource.
  - name: projectName
    value: "{{ projectName }}"
    description: |
      Name of the DataAutomationProject
  - name: projectDescription
    value: "{{ projectDescription }}"
    description: |
      Description of the DataAutomationProject
  - name: projectStage
    value: "{{ projectStage }}"
    description: |
      Stage of the Project
    valid_values: ['DEVELOPMENT', 'LIVE']
  - name: projectType
    value: "{{ projectType }}"
    description: |
      Type of the DataAutomationProject
    valid_values: ['ASYNC', 'SYNC']
  - name: standardOutputConfiguration
    description: |
      Standard output configuration
    value:
      document:
        extraction:
          granularity:
            types:
              - "{{ types }}"
          boundingBox:
            state: "{{ state }}"
        generativeField:
          state: "{{ state }}"
        outputFormat:
          textFormat:
            types:
              - "{{ types }}"
          additionalFileFormat:
            state: "{{ state }}"
      image:
        extraction:
          category:
            state: "{{ state }}"
            types:
              - "{{ types }}"
          boundingBox:
            state: "{{ state }}"
        generativeField:
          state: "{{ state }}"
          types:
            - "{{ types }}"
      video:
        extraction:
          category:
            state: "{{ state }}"
            types:
              - "{{ types }}"
          boundingBox:
            state: "{{ state }}"
        generativeField:
          state: "{{ state }}"
          types:
            - "{{ types }}"
      audio:
        extraction:
          category:
            state: "{{ state }}"
            types:
              - "{{ types }}"
            typeConfiguration:
              transcript: "{{ transcript }}"
        generativeField:
          state: "{{ state }}"
          types:
            - "{{ types }}"
  - name: customOutputConfiguration
    description: |
      Custom output configuration
    value:
      blueprints:
        - blueprintArn: "{{ blueprintArn }}"
          blueprintVersion: "{{ blueprintVersion }}"
          blueprintStage: "{{ blueprintStage }}"
      document:
        fallbackBlueprints:
          - blueprintArn: "{{ blueprintArn }}"
            blueprintVersion: "{{ blueprintVersion }}"
            blueprintStage: "{{ blueprintStage }}"
  - name: overrideConfiguration
    description: |
      Override configuration
    value:
      document:
        splitter:
          state: "{{ state }}"
        modalityProcessing:
          state: "{{ state }}"
        sensitiveDataConfiguration:
          detectionMode: "{{ detectionMode }}"
          detectionScope:
            - "{{ detectionScope }}"
          piiEntitiesConfiguration:
            piiEntityTypes:
              - "{{ piiEntityTypes }}"
            redactionMaskMode: "{{ redactionMaskMode }}"
      image:
        modalityProcessing:
          state: "{{ state }}"
        sensitiveDataConfiguration:
          detectionMode: "{{ detectionMode }}"
          detectionScope:
            - "{{ detectionScope }}"
          piiEntitiesConfiguration:
            piiEntityTypes:
              - "{{ piiEntityTypes }}"
            redactionMaskMode: "{{ redactionMaskMode }}"
      video:
        modalityProcessing:
          state: "{{ state }}"
        sensitiveDataConfiguration:
          detectionMode: "{{ detectionMode }}"
          detectionScope:
            - "{{ detectionScope }}"
          piiEntitiesConfiguration:
            piiEntityTypes:
              - "{{ piiEntityTypes }}"
            redactionMaskMode: "{{ redactionMaskMode }}"
      audio:
        modalityProcessing:
          state: "{{ state }}"
        languageConfiguration:
          inputLanguages:
            - "{{ inputLanguages }}"
          generativeOutputLanguage: "{{ generativeOutputLanguage }}"
          identifyMultipleLanguages: {{ identifyMultipleLanguages }}
        sensitiveDataConfiguration:
          detectionMode: "{{ detectionMode }}"
          detectionScope:
            - "{{ detectionScope }}"
          piiEntitiesConfiguration:
            piiEntityTypes:
              - "{{ piiEntityTypes }}"
            redactionMaskMode: "{{ redactionMaskMode }}"
      modalityRouting:
        jpeg: "{{ jpeg }}"
        png: "{{ png }}"
        mp4: "{{ mp4 }}"
        mov: "{{ mov }}"
  - name: dataAutomationLibraryConfiguration
    description: |
      DataAutomation Library configuration
    value:
      libraries:
        - libraryArn: "{{ libraryArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Client specified token used for idempotency checks
  - name: encryptionConfiguration
    description: |
      KMS Encryption Configuration
    value:
      kmsKeyId: "{{ kmsKeyId }}"
      kmsEncryptionContext: "{{ kmsEncryptionContext }}"
  - name: tags
    description: |
      List of tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_data_automation_project

Updates an existing Amazon Bedrock Data Automation Project

UPDATE aws.bedrock_data_automation.data_automation_projects
SET 
projectStage = '{{ projectStage }}',
projectDescription = '{{ projectDescription }}',
standardOutputConfiguration = '{{ standardOutputConfiguration }}',
customOutputConfiguration = '{{ customOutputConfiguration }}',
overrideConfiguration = '{{ overrideConfiguration }}',
dataAutomationLibraryConfiguration = '{{ dataAutomationLibraryConfiguration }}',
encryptionConfiguration = '{{ encryptionConfiguration }}'
WHERE 
project_arn = '{{ project_arn }}' --required
AND region = '{{ region }}' --required
AND standardOutputConfiguration = '{{ standardOutputConfiguration }}' --required
RETURNING
project_arn,
project_stage,
status;

DELETE examples

delete_data_automation_project

Deletes an existing Amazon Bedrock Data Automation Project

DELETE FROM aws.bedrock_data_automation.data_automation_projects
WHERE project_arn = '{{ project_arn }}' --required
AND region = '{{ region }}' --required
;