Skip to content
AWS for Query.Farm

aws.timestream_write.describe_batch_load_task

Example SQL Queries

SELECT * FROM
aws.timestream_write.describe_batch_load_task
WHERE
"task_id" = 'VALUE';

Description

Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.

Table Definition

Column NameColumn Data Type
task_id Required Input Column

The ID of the batch load task.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

batch_load_task_description

Description of the batch load task.

STRUCT(
    "task_id" VARCHAR,
    "error_message" VARCHAR,
    "data_source_configuration" STRUCT(
        "data_source_s3_configuration" STRUCT(
            "bucket_name" VARCHAR,
            "object_key_prefix" VARCHAR
        ),
        "csv_configuration" STRUCT(
            "column_separator" VARCHAR,
            "escape_char" VARCHAR,
            "quote_char" VARCHAR,
            "null_value" VARCHAR,
            "trim_white_space" BOOLEAN
        ),
        "data_format" VARCHAR
    ),
    "progress_report" STRUCT(
        "records_processed" BIGINT,
        "records_ingested" BIGINT,
        "parse_failures" BIGINT,
        "record_ingestion_failures" BIGINT,
        "file_failures" BIGINT,
        "bytes_metered" BIGINT
    ),
    "report_configuration" STRUCT(
        "report_s3_configuration" STRUCT(
            "bucket_name" VARCHAR,
            "object_key_prefix" VARCHAR,
            "encryption_option" VARCHAR,
            "kms_key_id" VARCHAR
        )
    ),
    "data_model_configuration" STRUCT(
        "data_model" STRUCT(
            "time_column" VARCHAR,
            "time_unit" VARCHAR,
            "dimension_mappings" STRUCT(
                "source_column" VARCHAR,
                "destination_column" VARCHAR
            )[],
            "multi_measure_mappings" STRUCT(
                "target_multi_measure_name" VARCHAR,
                "multi_measure_attribute_mappings" STRUCT(
                    "source_column" VARCHAR,
                    "target_multi_measure_attribute_name" VARCHAR,
                    "measure_value_type" VARCHAR
                )[]
            ),
            "mixed_measure_mappings" STRUCT(
                "measure_name" VARCHAR,
                "source_column" VARCHAR,
                "target_measure_name" VARCHAR,
                "measure_value_type" VARCHAR,
                "multi_measure_attribute_mappings" STRUCT(
                    "source_column" VARCHAR,
                    "target_multi_measure_attribute_name" VARCHAR,
                    "measure_value_type" VARCHAR
                )[]
            )[],
            "measure_name_column" VARCHAR
        ),
        "data_model_s3_configuration" STRUCT(
            "bucket_name" VARCHAR,
            "object_key" VARCHAR
        )
    ),
    "target_database_name" VARCHAR,
    "target_table_name" VARCHAR,
    "task_status" VARCHAR,
    "record_version" BIGINT,
    "creation_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "resumable_until" TIMESTAMP_S
)
Show child fields
batch_load_task_description.creation_time

The time when the Timestream batch load task was created.

batch_load_task_description.data_model_configuration

Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.

Show child fields
batch_load_task_description.data_model_configuration.data_model

Show child fields
batch_load_task_description.data_model_configuration.data_model.dimension_mappings[]
Show child fields
batch_load_task_description.data_model_configuration.data_model.dimension_mappings[].destination_column

batch_load_task_description.data_model_configuration.data_model.dimension_mappings[].source_column

batch_load_task_description.data_model_configuration.data_model.measure_name_column

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[]
Show child fields
batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].measure_name

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].measure_value_type

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].multi_measure_attribute_mappings[]
Show child fields
batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].multi_measure_attribute_mappings[].measure_value_type

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].multi_measure_attribute_mappings[].source_column

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].multi_measure_attribute_mappings[].target_multi_measure_attribute_name

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].source_column

batch_load_task_description.data_model_configuration.data_model.mixed_measure_mappings[].target_measure_name

batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings

Source to target mappings for multi-measure records.

Show child fields
batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[]
Show child fields
batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[].measure_value_type

batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[].source_column

batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.multi_measure_attribute_mappings[].target_multi_measure_attribute_name

batch_load_task_description.data_model_configuration.data_model.multi_measure_mappings.target_multi_measure_name

batch_load_task_description.data_model_configuration.data_model.time_column

Source column to be mapped to time.

batch_load_task_description.data_model_configuration.data_model.time_unit

The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or other supported values. Default is MILLISECONDS.

batch_load_task_description.data_model_configuration.data_model_s3_configuration

Show child fields
batch_load_task_description.data_model_configuration.data_model_s3_configuration.bucket_name

batch_load_task_description.data_model_configuration.data_model_s3_configuration.object_key

batch_load_task_description.data_source_configuration

Configuration details about the data source for a batch load task.

Show child fields
batch_load_task_description.data_source_configuration.csv_configuration

A delimited data format where the column separator can be a comma and the record separator is a newline character.

Show child fields
batch_load_task_description.data_source_configuration.csv_configuration.column_separator

Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'), or blank space (' ').

batch_load_task_description.data_source_configuration.csv_configuration.escape_char

Escape character can be one of

batch_load_task_description.data_source_configuration.csv_configuration.null_value

Can be blank space (' ').

batch_load_task_description.data_source_configuration.csv_configuration.quote_char

Can be single quote (') or double quote (").

batch_load_task_description.data_source_configuration.csv_configuration.trim_white_space

Specifies to trim leading and trailing white space.

batch_load_task_description.data_source_configuration.data_format

This is currently CSV.

batch_load_task_description.data_source_configuration.data_source_s3_configuration

Configuration of an S3 location for a file which contains data to load.

Show child fields
batch_load_task_description.data_source_configuration.data_source_s3_configuration.bucket_name

The bucket name of the customer S3 bucket.

batch_load_task_description.data_source_configuration.data_source_s3_configuration.object_key_prefix

batch_load_task_description.error_message

batch_load_task_description.last_updated_time

The time when the Timestream batch load task was last updated.

batch_load_task_description.progress_report

Show child fields
batch_load_task_description.progress_report.bytes_metered

batch_load_task_description.progress_report.file_failures

batch_load_task_description.progress_report.parse_failures

batch_load_task_description.progress_report.record_ingestion_failures

batch_load_task_description.progress_report.records_ingested

batch_load_task_description.progress_report.records_processed

batch_load_task_description.record_version

batch_load_task_description.report_configuration

Report configuration for a batch load task. This contains details about where error reports are stored.

Show child fields
batch_load_task_description.report_configuration.report_s3_configuration

Configuration of an S3 location to write error reports and events for a batch load.

Show child fields
batch_load_task_description.report_configuration.report_s3_configuration.bucket_name

batch_load_task_description.report_configuration.report_s3_configuration.encryption_option

batch_load_task_description.report_configuration.report_s3_configuration.kms_key_id

batch_load_task_description.report_configuration.report_s3_configuration.object_key_prefix

batch_load_task_description.resumable_until

batch_load_task_description.target_database_name

batch_load_task_description.target_table_name

batch_load_task_description.task_id

The ID of the batch load task.

batch_load_task_description.task_status

Status of the batch load task.