TimestreamWrite / Client / describe_batch_load_task

describe_batch_load_task

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'
)

Parameters:

TaskId (string) –

[REQUIRED]

The ID of the batch load task.

Return type:

dict

Returns:

Response Syntax

{
    '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

• (dict) –

  • BatchLoadTaskDescription (dict) –

    Description of the batch load task.

    • TaskId (string) –

      The ID of the batch load task.

    • ErrorMessage (string) –

    • DataSourceConfiguration (dict) –

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

      • DataSourceS3Configuration (dict) –

        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 (dict) –

        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 (dict) –

      • RecordsProcessed (integer) –

      • RecordsIngested (integer) –

      • ParseFailures (integer) –

      • RecordIngestionFailures (integer) –

      • FileFailures (integer) –

      • BytesMetered (integer) –

    • ReportConfiguration (dict) –

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

      • ReportS3Configuration (dict) –

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

        • BucketName (string) –

        • ObjectKeyPrefix (string) –

        • EncryptionOption (string) –

        • KmsKeyId (string) –

    • DataModelConfiguration (dict) –

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

      • DataModel (dict) –

        • 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.

          • (dict) –

            • SourceColumn (string) –

            • DestinationColumn (string) –

        • MultiMeasureMappings (dict) –

          Source to target mappings for multi-measure records.

          • TargetMultiMeasureName (string) –

          • MultiMeasureAttributeMappings (list) –

            • (dict) –

              • SourceColumn (string) –

              • TargetMultiMeasureAttributeName (string) –

              • MeasureValueType (string) –

        • MixedMeasureMappings (list) –

          Source to target mappings for measures.

          • (dict) –

            • MeasureName (string) –

            • SourceColumn (string) –

            • TargetMeasureName (string) –

            • MeasureValueType (string) –

            • MultiMeasureAttributeMappings (list) –

              • (dict) –

                • SourceColumn (string) –

                • TargetMultiMeasureAttributeName (string) –

                • MeasureValueType (string) –

        • MeasureNameColumn (string) –

      • DataModelS3Configuration (dict) –

        • BucketName (string) –

        • ObjectKey (string) –

    • TargetDatabaseName (string) –

    • TargetTableName (string) –

    • TaskStatus (string) –

      Status of the batch load task.

    • RecordVersion (integer) –

    • CreationTime (datetime) –

      The time when the Timestream batch load task was created.

    • LastUpdatedTime (datetime) –

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

    • ResumableUntil (datetime) –

Exceptions

• TimestreamWrite.Client.exceptions.InternalServerException

• TimestreamWrite.Client.exceptions.ThrottlingException

• TimestreamWrite.Client.exceptions.AccessDeniedException

• TimestreamWrite.Client.exceptions.ResourceNotFoundException

• TimestreamWrite.Client.exceptions.InvalidEndpointException