Skip to main content

export_tasks

Creates, updates, deletes, gets or lists an export_tasks resource.

Overview​

Nameexport_tasks
TypeResource
Idaws.logs.export_tasks

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
destinationstringThe name of the S3 bucket to which the log data was exported.
destination_prefixstringThe prefix that was used as the start of Amazon S3 key for every object exported.
execution_infoobjectExecution information about the export task.
frominteger (int64)The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported.
log_group_namestringThe name of the log group from which logs data was exported. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
statusobjectThe status of the export task.
task_idstringThe ID of the export task.
task_namestringThe name of the export task.
tointeger (int64)The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_export_tasksselectregionLists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
create_export_taskinsertregion, logGroupName, from, to, destinationCreates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination. Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. Exporting to S3 buckets that are encrypted with AES-256 is supported. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects. We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instead recommend that you use subscriptions. For more information about subscriptions, see Real-time processing of log data with subscriptions. Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

SELECT
destination,
destination_prefix,
execution_info,
from,
log_group_name,
status,
task_id,
task_name,
to
FROM aws.logs.export_tasks
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination. Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. Exporting to S3 buckets that are encrypted with AES-256 is supported. This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects. We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instead recommend that you use subscriptions. For more information about subscriptions, see Real-time processing of log data with subscriptions. Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

INSERT INTO aws.logs.export_tasks (
taskName,
logGroupName,
logStreamNamePrefix,
from,
to,
destination,
destinationPrefix,
region
)
SELECT 
'{{ taskName }}',
'{{ logGroupName }}' /* required */,
'{{ logStreamNamePrefix }}',
{{ from }} /* required */,
{{ to }} /* required */,
'{{ destination }}' /* required */,
'{{ destinationPrefix }}',
'{{ region }}'
RETURNING
task_id
;
Last updated on