find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-timestream:amazon-timestream-batch-load-task-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Timestream Write Batch Load Task API
  version: '2018-11-01'
  description: Generated from AWS's published Smithy model for Amazon Timestream Write. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ingest.timestream.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Batch Load Task
paths:
  /#CreateBatchLoadTask:
    post:
      operationId: CreateBatchLoadTask
      summary: Create Batch Load Task
      description: Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report will be encrypted with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateBatchLoadTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '421':
          description: InvalidEndpointException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidEndpointException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Timestream_20181101.CreateBatchLoadTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateBatchLoadTaskRequest'
      tags:
      - Batch Load Task
  /#DescribeBatchLoadTask:
    post:
      operationId: DescribeBatchLoadTask
      summary: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeBatchLoadTaskResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '421':
          description: InvalidEndpointException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidEndpointException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Timestream_20181101.DescribeBatchLoadTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeBatchLoadTaskRequest'
      tags:
      - Batch Load Task
  /#ListBatchLoadTasks:
    post:
      operationId: ListBatchLoadTasks
      summary: List Batch Load Tasks
      description: Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListBatchLoadTasksResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '421':
          description: InvalidEndpointException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidEndpointException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Timestream_20181101.ListBatchLoadTasks
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListBatchLoadTasksRequest'
      tags:
      - Batch Load Task
components:
  schemas:
    ListBatchLoadTasksRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
        MaxResults:
          type: integer
          description: The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
        TaskStatus:
          type: string
          enum:
          - CREATED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - PROGRESS_STOPPED
          - PENDING_RESUME
          description: Status of the batch load task.
    BatchLoadTaskDescription:
      type: object
      properties:
        TaskId:
          type: string
          description: The ID of the batch load task.
        ErrorMessage:
          type: string
        DataSourceConfiguration:
          $ref: '#/components/schemas/DataSourceConfiguration'
        ProgressReport:
          $ref: '#/components/schemas/BatchLoadProgressReport'
        ReportConfiguration:
          $ref: '#/components/schemas/ReportConfiguration'
        DataModelConfiguration:
          $ref: '#/components/schemas/DataModelConfiguration'
        TargetDatabaseName:
          type: string
        TargetTableName:
          type: string
        TaskStatus:
          type: string
          enum:
          - CREATED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - PROGRESS_STOPPED
          - PENDING_RESUME
          description: Status of the batch load task.
        RecordVersion:
          type: integer
        CreationTime:
          type: string
          format: date-time
          description: The time when the Timestream batch load task was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time when the Timestream batch load task was last updated.
        ResumableUntil:
          type: string
          format: date-time
    DataSourceS3Configuration:
      type: object
      properties:
        BucketName:
          type: string
          description: The bucket name of the customer S3 bucket.
        ObjectKeyPrefix:
          type: string
      required:
      - BucketName
    ListBatchLoadTasksResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: A token to specify where to start paginating. Provide the next ListBatchLoadTasksRequest.
        BatchLoadTasks:
          type: array
          items:
            $ref: '#/components/schemas/BatchLoadTask'
          description: A list of batch load task details.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    InvalidEndpointException:
      type: object
      properties:
        Message:
          type: string
    DescribeBatchLoadTaskRequest:
      type: object
      properties:
        TaskId:
          type: string
          description: The ID of the batch load task.
      required:
      - TaskId
    MixedMeasureMapping:
      type: object
      properties:
        MeasureName:
          type: string
        SourceColumn:
          type: string
        TargetMeasureName:
          type: string
        MeasureValueType:
          type: string
          enum:
          - DOUBLE
          - BIGINT
          - VARCHAR
          - BOOLEAN
          - TIMESTAMP
          - MULTI
        MultiMeasureAttributeMappings:
          type: array
          items:
            $ref: '#/components/schemas/MultiMeasureAttributeMapping'
      required:
      - MeasureValueType
    DescribeBatchLoadTaskResponse:
      type: object
      properties:
        BatchLoadTaskDescription:
          $ref: '#/components/schemas/BatchLoadTaskDescription'
      required:
      - BatchLoadTaskDescription
    BatchLoadTask:
      type: object
      properties:
        TaskId:
          type: string
          description: The ID of the batch load task.
        TaskStatus:
          type: string
          enum:
          - CREATED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - PROGRESS_STOPPED
          - PENDING_RESUME
          description: Status of the batch load task.
        DatabaseName:
          type: string
          description: Database name for the database into which a batch load task loads data.
        TableName:
          type: string
          description: Table name for the table into which a batch load task loads data.
        CreationTime:
          type: string
          format: date-time
          description: The time when the Timestream batch load task was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time when the Timestream batch load task was last updated.
        ResumableUntil:
          type: string
          format: date-time
    DataModelConfiguration:
      type: object
      properties:
        DataModel:
          $ref: '#/components/schemas/DataModel'
        DataModelS3Configuration:
          $ref: '#/components/schemas/DataModelS3Configuration'
    ValidationException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DimensionMapping:
      type: object
      properties:
        SourceColumn:
          type: string
        DestinationColumn:
          type: string
    DataModel:
      type: object
      properties:
        TimeColumn:
          type: string
          description: Source column to be mapped to time.
        TimeUnit:
          type: string
          enum:
          - MILLISECONDS
          - SECONDS
          - MICROSECONDS
          - NANOSECONDS
          description: 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:
          type: array
          items:
            $ref: '#/components/schemas/DimensionMapping'
          description: Source to target mappings for dimensions.
        MultiMeasureMappings:
          $ref: '#/components/schemas/MultiMeasureMappings'
        MixedMeasureMappings:
          type: array
          items:
            $ref: '#/components/schemas/MixedMeasureMapping'
          description: Source to target mappings for measures.
        MeasureNameColumn:
          type: string
      required:
      - DimensionMappings
    DataModelS3Configuration:
      type: object
      properties:
        BucketName:
          type: string
        ObjectKey:
          type: string
    MultiMeasureMappings:
      type: object
      properties:
        TargetMultiMeasureName:
          type: string
        MultiMeasureAttributeMappings:
          type: array
          items:
            $ref: '#/components/schemas/MultiMeasureAttributeMapping'
      required:
      - MultiMeasureAttributeMappings
    CreateBatchLoadTaskResponse:
      type: object
      properties:
        TaskId:
          type: string
          description: The ID of the batch load task.
      required:
      - TaskId
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ReportS3Configuration:
      type: object
      properties:
        BucketName:
          type: string
        ObjectKeyPrefix:
          type: string
        EncryptionOption:
          type: string
          enum:
          - SSE_S3
          - SSE_KMS
        KmsKeyId:
          type: string
      required:
      - BucketName
    BatchLoadProgressReport:
      type: object
      properties:
        RecordsProcessed:
          type: integer
        RecordsIngested:
          type: integer
        ParseFailures:
          type: integer
        RecordIngestionFailures:
          type: integer
        FileFailures:
          type: integer
        BytesMetered:
          type: integer
    ReportConfiguration:
      type: object
      properties:
        ReportS3Configuration:
          $ref: '#/components/schemas/ReportS3Configuration'
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    MultiMeasureAttributeMapping:
      type: object
      properties:
        SourceColumn:
          type: string
        TargetMultiMeasureAttributeName:
          type: string
        MeasureValueType:
          type: string
          enum:
          - DOUBLE
          - BIGINT
          - BOOLEAN
          - VARCHAR
          - TIMESTAMP
      required:
      - SourceColumn
    CsvConfiguration:
      type: object
      properties:
        ColumnSeparator:
          type: string
          description: Column separator can be one of comma (','), pipe ('|), semicolon (';'), tab('/t'), or blank space (' ').
        EscapeChar:
          type: string
          description: Escape character can be one of
        QuoteChar:
          type: string
          description: Can be single quote (') or double quote (").
        NullValue:
          type: string
          description: Can be blank space (' ').
        TrimWhiteSpace:
          type: boolean
          description: Specifies to trim leading and trailing white space.
    CreateBatchLoadTaskRequest:
      type: object
      properties:
        ClientToken:
          type: string
        DataModelConfiguration:
          $ref: '#/components/schemas/DataModelConfiguration'
        DataSourceConfiguration:
          $ref: '#/components/schemas/DataSourceConfiguration'
        ReportConfiguration:
          $ref: '#/components/schemas/ReportConfiguration'
        TargetDatabaseName:
          type: string
          description: Target Timestream database for a batch load task.
        TargetTableName:
          type: string
          description: Target Timestream table for a batch load task.
        RecordVersion:
          type: integer
      required:
      - DataSourceConfiguration
      - ReportConfiguration
      - TargetDatabaseName
      - TargetTableName
    DataSourceConfiguration:
      type: object
      properties:
        DataSourceS3Configuration:
          $ref: '#/components/schemas/DataSourceS3Configuration'
        CsvConfiguration:
          $ref: '#/components/schemas/CsvConfiguration'
        DataFormat:
          type: string
          enum:
          - CSV
          description: This is currently CSV.
      required:
      - DataSourceS3Configuration
      - DataFormat
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: timestream
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/timestream-write/service/2018-11-01/timestream-write-2018-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)