data_catalog_export_configurations
Creates, updates, deletes, gets or lists a data_catalog_export_configurations resource.
Overview
| Name | data_catalog_export_configurations |
| Type | Resource |
| Id | aws.glue.data_catalog_export_configurations |
Fields
The following fields are returned by SELECT queries:
- get_data_catalog_export_configuration
| Name | Datatype | Description |
|---|---|---|
created_at | string (date-time) | The timestamp at which the export configuration was created. |
encryption_configuration | object | The encryption configuration for the exported data. |
export_setting | string | The export setting for the data catalog. Valid values are ENABLED and DISABLED. (ENABLED, DISABLED) |
s3_table_bucket_arn | string | The ARN of the S3 Tables bucket where catalog metadata is exported. |
status | string | The current status of the export. Valid values are ENABLING, ENABLED, DISABLING, DISABLED, and FAILED. (ENABLING, ENABLED, DISABLING, DISABLED, FAILED) |
updated_at | string (date-time) | The timestamp at which the export configuration was last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_data_catalog_export_configuration | select | region | Retrieves the current export configuration for the Glue Data Catalog. The export configuration controls whether catalog metadata is exported to S3 Tables. | |
put_data_catalog_export_configuration | replace | region, ExportSetting | Creates or updates the export configuration for the Glue Data Catalog. Use this operation to enable or disable the export of catalog metadata to S3 Tables. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_data_catalog_export_configuration
Retrieves the current export configuration for the Glue Data Catalog. The export configuration controls whether catalog metadata is exported to S3 Tables.
SELECT
created_at,
encryption_configuration,
export_setting,
s3_table_bucket_arn,
status,
updated_at
FROM aws.glue.data_catalog_export_configurations
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_data_catalog_export_configuration
Creates or updates the export configuration for the Glue Data Catalog. Use this operation to enable or disable the export of catalog metadata to S3 Tables.
REPLACE aws.glue.data_catalog_export_configurations
SET
ExportSetting = '{{ ExportSetting }}',
EncryptionConfiguration = '{{ EncryptionConfiguration }}',
ClientToken = '{{ ClientToken }}'
WHERE
region = '{{ region }}' --required
AND ExportSetting = '{{ ExportSetting }}' --required
RETURNING
encryption_configuration,
export_setting;