data_automation_libraries

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

Overview

Name	data_automation_libraries
Type	Resource
Id	aws.bedrock_data_automation.data_automation_libraries

Fields

The following fields are returned by SELECT queries:

get_data_automation_library

Name	Datatype	Description
creation_time	string (date-time)	Time Stamp
entity_types	array	List of info for each entity type in the DataAutomationLibrary
kms_encryption_context	object
kms_key_id	string	KMS Key Identifier (pattern: <code>[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+</code>)
library_arn	string	ARN generated at the server side when a DataAutomationLibrary is created (pattern: <code>arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}</code>)
library_description	string	Description of the DataAutomationLibrary (pattern: <code>[a-zA-Z0-9\s!"#$%'&()*+,-./:;=?@&#91;\&#93;^_`&#123;|&#125;~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*</code>)
library_name	string	Name of the DataAutomationLibrary (pattern: <code>[a-zA-Z0-9-_]+</code>)
status	string	Status of DataAutomationLibrary (ACTIVE, DELETING)

list_data_automation_libraries

Name	Datatype	Description
creation_time	string (date-time)	Time Stamp
library_arn	string	ARN generated at the server side when a DataAutomationLibrary is created (pattern: <code>arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}</code>)
library_name	string	Name of the DataAutomationLibrary (pattern: <code>[a-zA-Z0-9-_]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_automation_library	select	library_arn, region		Gets an existing Amazon Bedrock Data Automation Library
list_data_automation_libraries	select	region		Lists all existing Amazon Bedrock Data Automation Libraries
create_data_automation_library	insert	region, libraryName		Creates an Amazon Bedrock Data Automation Library
update_data_automation_library	update	library_arn, region		Updates an existing Amazon Bedrock Data Automation Library
delete_data_automation_library	delete	library_arn, region		Deletes an existing Amazon Bedrock Data Automation Library
invoke_data_automation_library_ingestion_job	exec	library_arn, region, inputConfiguration, entityType, operationType, outputConfiguration		Async API: Invoke data automation library ingestion job

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

SELECT examples

get_data_automation_library

Gets an existing Amazon Bedrock Data Automation Library

SELECT
creation_time,
entity_types,
kms_encryption_context,
kms_key_id,
library_arn,
library_description,
library_name,
status
FROM aws.bedrock_data_automation.data_automation_libraries
WHERE library_arn = '{{ library_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_data_automation_libraries

Lists all existing Amazon Bedrock Data Automation Libraries

SELECT
creation_time,
library_arn,
library_name
FROM aws.bedrock_data_automation.data_automation_libraries
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_automation_library

Creates an Amazon Bedrock Data Automation Library

INSERT INTO aws.bedrock_data_automation.data_automation_libraries (
libraryName,
libraryDescription,
clientToken,
encryptionConfiguration,
tags,
region
)
SELECT 
'{{ libraryName }}' /* required */,
'{{ libraryDescription }}',
'{{ clientToken }}',
'{{ encryptionConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
library_arn,
status
;

Manifest

# Description fields are for documentation purposes
- name: data_automation_libraries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_automation_libraries resource.
  - name: libraryName
    value: "{{ libraryName }}"
    description: |
      Name of the DataAutomationLibrary
  - name: libraryDescription
    value: "{{ libraryDescription }}"
    description: |
      Description of the DataAutomationLibrary
  - 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_library

Updates an existing Amazon Bedrock Data Automation Library

UPDATE aws.bedrock_data_automation.data_automation_libraries
SET 
libraryDescription = '{{ libraryDescription }}',
clientToken = '{{ clientToken }}'
WHERE 
library_arn = '{{ library_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
library_arn,
status;

DELETE examples

delete_data_automation_library

Deletes an existing Amazon Bedrock Data Automation Library

DELETE FROM aws.bedrock_data_automation.data_automation_libraries
WHERE library_arn = '{{ library_arn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

invoke_data_automation_library_ingestion_job

Async API: Invoke data automation library ingestion job

EXEC aws.bedrock_data_automation.data_automation_libraries.invoke_data_automation_library_ingestion_job 
@library_arn='{{ library_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientToken": "{{ clientToken }}", 
"inputConfiguration": "{{ inputConfiguration }}", 
"entityType": "{{ entityType }}", 
"operationType": "{{ operationType }}", 
"outputConfiguration": "{{ outputConfiguration }}", 
"notificationConfiguration": "{{ notificationConfiguration }}", 
"tags": "{{ tags }}"
}'
;