data_export_configurations

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

Overview

Name	data_export_configurations
Type	Resource
Id	aws.datazone.data_export_configurations

Fields

The following fields are returned by SELECT queries:

get_data_export_configuration

Name	Datatype	Description
created_at	string (date-time)	The timestamp at which the data export configuration report was created.
encryption_configuration	object	The encryption configuration as part of the data export configuration details.
is_export_enabled	boolean	Specifies whether the export is enabled.
s_3_table_bucket_arn	string	The Amazon S3 table bucket ARN as part of the data export configuration details.
status	string	The status of the data export configuration. (COMPLETED, FAILED)
updated_at	string (date-time)	The timestamp at which the data export configuration report was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_export_configuration	select	domain_identifier, region		Gets data export configuration details.
put_data_export_configuration	replace	domain_identifier, region, enableExport		Creates data export configuration details. If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table. You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps: Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation. Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion. Call the PutDataExportConfiguration API to enable export for the new domain.
delete_data_export_configuration	delete	domain_identifier, region		Deletes data export configuration for a domain. This operation does not delete the S3 table created by the PutDataExportConfiguration operation. To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the --no-enable-export flag instead. This allows you to re-enable export for the same domain using the --enable-export flag without deleting S3 table.

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
domain_identifier	string	The domain ID for which you want to delete the data export configuration.
region	string	AWS region (default: us-east-1)

SELECT examples

get_data_export_configuration

Gets data export configuration details.

SELECT
created_at,
encryption_configuration,
is_export_enabled,
s_3_table_bucket_arn,
status,
updated_at
FROM aws.datazone.data_export_configurations
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_data_export_configuration

Creates data export configuration details. If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table. You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps: Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation. Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion. Call the PutDataExportConfiguration API to enable export for the new domain.

REPLACE aws.datazone.data_export_configurations
SET 
enableExport = {{ enableExport }},
encryptionConfiguration = '{{ encryptionConfiguration }}',
clientToken = '{{ clientToken }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND region = '{{ region }}' --required
AND enableExport = {{ enableExport }} --required;

DELETE examples

delete_data_export_configuration

Deletes data export configuration for a domain. This operation does not delete the S3 table created by the PutDataExportConfiguration operation. To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the --no-enable-export flag instead. This allows you to re-enable export for the same domain using the --enable-export flag without deleting S3 table.

DELETE FROM aws.datazone.data_export_configurations
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND region = '{{ region }}' --required
;