AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . timestream-write ]

describe-batch-load-task

Description

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

Synopsis

  describe-batch-load-task
--task-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--task-id (string)

The ID of the batch load task.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

BatchLoadTaskDescription -> (structure)

Description of the batch load task.

TaskId -> (string)

The ID of the batch load task.

ErrorMessage -> (string)

DataSourceConfiguration -> (structure)

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

DataSourceS3Configuration -> (structure)

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

BucketName -> (string)

The bucket name of the customer S3 bucket.

ObjectKeyPrefix -> (string)

CsvConfiguration -> (structure)

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

ColumnSeparator -> (string)

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

EscapeChar -> (string)

Escape character can be one of

QuoteChar -> (string)

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

NullValue -> (string)

Can be blank space (' ').

TrimWhiteSpace -> (boolean)

Specifies to trim leading and trailing white space.

DataFormat -> (string)

This is currently CSV.

ProgressReport -> (structure)

RecordsProcessed -> (long)

RecordsIngested -> (long)

ParseFailures -> (long)

RecordIngestionFailures -> (long)

FileFailures -> (long)

BytesMetered -> (long)

ReportConfiguration -> (structure)

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

ReportS3Configuration -> (structure)

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

BucketName -> (string)

ObjectKeyPrefix -> (string)

EncryptionOption -> (string)

KmsKeyId -> (string)

DataModelConfiguration -> (structure)

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

DataModel -> (structure)

TimeColumn -> (string)

Source column to be mapped to time.

TimeUnit -> (string)

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

DimensionMappings -> (list)

Source to target mappings for dimensions.

(structure)

SourceColumn -> (string)

DestinationColumn -> (string)

MultiMeasureMappings -> (structure)

Source to target mappings for multi-measure records.

TargetMultiMeasureName -> (string)

MultiMeasureAttributeMappings -> (list)

(structure)

SourceColumn -> (string)

TargetMultiMeasureAttributeName -> (string)

MeasureValueType -> (string)

MixedMeasureMappings -> (list)

Source to target mappings for measures.

(structure)

MeasureName -> (string)

SourceColumn -> (string)

TargetMeasureName -> (string)

MeasureValueType -> (string)

MultiMeasureAttributeMappings -> (list)

(structure)

SourceColumn -> (string)

TargetMultiMeasureAttributeName -> (string)

MeasureValueType -> (string)

MeasureNameColumn -> (string)

DataModelS3Configuration -> (structure)

BucketName -> (string)

ObjectKey -> (string)

TargetDatabaseName -> (string)

TargetTableName -> (string)

TaskStatus -> (string)

Status of the batch load task.

RecordVersion -> (long)

CreationTime -> (timestamp)

The time when the Timestream batch load task was created.

LastUpdatedTime -> (timestamp)

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

ResumableUntil -> (timestamp)