TimestreamWrite.Client.describe_batch_load_task(**kwargs)¶Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.
See also: AWS API Documentation
Request Syntax
response = client.describe_batch_load_task(
TaskId='string'
)
[REQUIRED]
The ID of the batch load task.
{
'BatchLoadTaskDescription': {
'TaskId': 'string',
'ErrorMessage': 'string',
'DataSourceConfiguration': {
'DataSourceS3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string'
},
'CsvConfiguration': {
'ColumnSeparator': 'string',
'EscapeChar': 'string',
'QuoteChar': 'string',
'NullValue': 'string',
'TrimWhiteSpace': True|False
},
'DataFormat': 'CSV'
},
'ProgressReport': {
'RecordsProcessed': 123,
'RecordsIngested': 123,
'ParseFailures': 123,
'RecordIngestionFailures': 123,
'FileFailures': 123,
'BytesMetered': 123
},
'ReportConfiguration': {
'ReportS3Configuration': {
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'EncryptionOption': 'SSE_S3'|'SSE_KMS',
'KmsKeyId': 'string'
}
},
'DataModelConfiguration': {
'DataModel': {
'TimeColumn': 'string',
'TimeUnit': 'MILLISECONDS'|'SECONDS'|'MICROSECONDS'|'NANOSECONDS',
'DimensionMappings': [
{
'SourceColumn': 'string',
'DestinationColumn': 'string'
},
],
'MultiMeasureMappings': {
'TargetMultiMeasureName': 'string',
'MultiMeasureAttributeMappings': [
{
'SourceColumn': 'string',
'TargetMultiMeasureAttributeName': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'BOOLEAN'|'VARCHAR'|'TIMESTAMP'
},
]
},
'MixedMeasureMappings': [
{
'MeasureName': 'string',
'SourceColumn': 'string',
'TargetMeasureName': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'VARCHAR'|'BOOLEAN'|'TIMESTAMP'|'MULTI',
'MultiMeasureAttributeMappings': [
{
'SourceColumn': 'string',
'TargetMultiMeasureAttributeName': 'string',
'MeasureValueType': 'DOUBLE'|'BIGINT'|'BOOLEAN'|'VARCHAR'|'TIMESTAMP'
},
]
},
],
'MeasureNameColumn': 'string'
},
'DataModelS3Configuration': {
'BucketName': 'string',
'ObjectKey': 'string'
}
},
'TargetDatabaseName': 'string',
'TargetTableName': 'string',
'TaskStatus': 'CREATED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'PROGRESS_STOPPED'|'PENDING_RESUME',
'RecordVersion': 123,
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ResumableUntil': datetime(2015, 1, 1)
}
}
Response Structure
Description of the batch load task.
The ID of the batch load task.
Configuration details about the data source for a batch load task.
Configuration of an S3 location for a file which contains data to load.
The bucket name of the customer S3 bucket.
A delimited data format where the column separator can be a comma and the record separator is a newline character.
Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'), or blank space (' ').
Escape character can be one of
Can be single quote (') or double quote (").
Can be blank space (' ').
Specifies to trim leading and trailing white space.
This is currently CSV.
Report configuration for a batch load task. This contains details about where error reports are stored.
Configuration of an S3 location to write error reports and events for a batch load.
Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.
Source column to be mapped to time.
The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or other supported values. Default is MILLISECONDS .
Source to target mappings for dimensions.
Source to target mappings for multi-measure records.
Source to target mappings for measures.
Status of the batch load task.
The time when the Timestream batch load task was created.
The time when the Timestream batch load task was last updated.
Exceptions
TimestreamWrite.Client.exceptions.InternalServerExceptionTimestreamWrite.Client.exceptions.ThrottlingExceptionTimestreamWrite.Client.exceptions.AccessDeniedExceptionTimestreamWrite.Client.exceptions.ResourceNotFoundExceptionTimestreamWrite.Client.exceptions.InvalidEndpointException