Amazon Timestream Tables API

openapi: 3.2.0
info:
  title: Amazon Timestream Tables API
  version: '2018-11-01'
  description: 'Operations tagged Tables across 2 of this provider''s published API definitions: amazon-timestream-openapi.yml, amazon-timestream-tables-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ingest.timestream.amazonaws.com
  description: Amazon Timestream Write API endpoint
- url: https://ingest.timestream.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Tables
  description: Operations for managing Timestream tables.
paths:
  /#CreateTable:
    post:
      operationId: CreateTable
      summary: Amazon Timestream Create Table
      description: Creates a new table in an existing database with configurable data retention policies for memory store and magnetic store.
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              type: object
              properties:
                DatabaseName:
                  type: string
                  description: The name of the Timestream database.
                TableName:
                  type: string
                  description: The name of the Timestream table.
                RetentionProperties:
                  type: object
                  properties:
                    MemoryStoreRetentionPeriodInHours:
                      type: integer
                      description: The duration for which data must be stored in the memory store.
                    MagneticStoreRetentionPeriodInDays:
                      type: integer
                      description: The duration for which data must be stored in the magnetic store.
                MagneticStoreWriteProperties:
                  type: object
                  properties:
                    EnableMagneticStoreWrites:
                      type: boolean
                Tags:
                  type: array
                  items:
                    type: object
                    properties:
                      Key:
                        type: string
                      Value:
                        type: string
              required:
              - DatabaseName
              - TableName
      responses:
        '200':
          description: Table created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Table:
                    type: object
                    properties:
                      Arn:
                        type: string
                      TableName:
                        type: string
                      DatabaseName:
                        type: string
                      TableStatus:
                        type: string
                      RetentionProperties:
                        type: object
      tags:
      - Tables
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://ingest.timestream.amazonaws.com
      description: Amazon Timestream Write API endpoint
  /#DescribeTable:
    post:
      operationId: DescribeTable
      summary: Amazon Timestream Describe Table
      description: Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store.
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              type: object
              properties:
                DatabaseName:
                  type: string
                TableName:
                  type: string
              required:
              - DatabaseName
              - TableName
      responses:
        '200':
          description: Table details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Table:
                    type: object
                    properties:
                      Arn:
                        type: string
                      TableName:
                        type: string
                      DatabaseName:
                        type: string
                      TableStatus:
                        type: string
                      RetentionProperties:
                        type: object
                      MagneticStoreWriteProperties:
                        type: object
      tags:
      - Tables
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://ingest.timestream.amazonaws.com
      description: Amazon Timestream Write API endpoint
  /#DeleteTable:
    post:
      operationId: DeleteTable
      summary: Delete Table
      description: Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time-series data stored in the table cannot be recovered. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. See code sample for details.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                type: string
        '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'
        '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.DeleteTable
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteTableRequest'
      tags:
      - Tables
      security:
      - sigv4: []
    servers:
    - url: https://ingest.timestream.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#ListTables:
    post:
      operationId: ListTables
      summary: List Tables
      description: Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListTablesResponse'
        '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'
        '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.ListTables
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListTablesRequest'
      tags:
      - Tables
      security:
      - sigv4: []
    servers:
    - url: https://ingest.timestream.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#UpdateTable:
    post:
      operationId: UpdateTable
      summary: Update Table
      description: Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store. See code sample for details.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateTableResponse'
        '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'
        '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.UpdateTable
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateTableRequest'
      tags:
      - Tables
      security:
      - sigv4: []
    servers:
    - url: https://ingest.timestream.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    PartitionKey:
      type: object
      properties:
        Type:
          type: string
          enum:
          - DIMENSION
          - MEASURE
          description: The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).
        Name:
          type: string
          description: The name of the attribute used for a dimension key.
        EnforcementInRecord:
          type: string
          enum:
          - REQUIRED
          - OPTIONAL
          description: The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).
      required:
      - Type
    RetentionProperties:
      type: object
      properties:
        MemoryStoreRetentionPeriodInHours:
          type: integer
          description: The duration for which data must be stored in the memory store.
        MagneticStoreRetentionPeriodInDays:
          type: integer
          description: The duration for which data must be stored in the magnetic store.
      required:
      - MemoryStoreRetentionPeriodInHours
      - MagneticStoreRetentionPeriodInDays
    UpdateTableResponse:
      type: object
      properties:
        Table:
          $ref: '#/components/schemas/Table'
    ListTablesRequest:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The name of the Timestream database.
        NextToken:
          type: string
          description: The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
        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.
    MagneticStoreWriteProperties:
      type: object
      properties:
        EnableMagneticStoreWrites:
          type: boolean
          description: A flag to enable magnetic store writes.
        MagneticStoreRejectedDataLocation:
          $ref: '#/components/schemas/MagneticStoreRejectedDataLocation'
      required:
      - EnableMagneticStoreWrites
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DeleteTableRequest:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The name of the database where the Timestream database is to be deleted.
        TableName:
          type: string
          description: The name of the Timestream table to be deleted.
      required:
      - DatabaseName
      - TableName
    ListTablesResponse:
      type: object
      properties:
        Tables:
          type: array
          items:
            $ref: '#/components/schemas/Table'
          description: A list of tables.
        NextToken:
          type: string
          description: A token to specify where to start paginating. This is the NextToken from a previously truncated response.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    S3Configuration:
      type: object
      properties:
        BucketName:
          type: string
          description: The bucket name of the customer S3 bucket.
        ObjectKeyPrefix:
          type: string
          description: The object key preview for the customer S3 location.
        EncryptionOption:
          type: string
          enum:
          - SSE_S3
          - SSE_KMS
          description: The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.
        KmsKeyId:
          type: string
          description: The KMS key ID for the customer S3 location when encrypting with an Amazon Web Services managed key.
    UpdateTableRequest:
      type: object
      properties:
        DatabaseName:
          type: string
          description: The name of the Timestream database.
        TableName:
          type: string
          description: The name of the Timestream table.
        RetentionProperties:
          $ref: '#/components/schemas/RetentionProperties'
        MagneticStoreWriteProperties:
          $ref: '#/components/schemas/MagneticStoreWriteProperties'
        Schema:
          $ref: '#/components/schemas/Schema'
      required:
      - DatabaseName
      - TableName
    ValidationException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    InvalidEndpointException:
      type: object
      properties:
        Message:
          type: string
    MagneticStoreRejectedDataLocation:
      type: object
      properties:
        S3Configuration:
          $ref: '#/components/schemas/S3Configuration'
    Table:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name that uniquely identifies this table.
        TableName:
          type: string
          description: The name of the Timestream table.
        DatabaseName:
          type: string
          description: The name of the Timestream database that contains this table.
        TableStatus:
          type: string
          enum:
          - ACTIVE
          - DELETING
          - RESTORING
          description: 'The current state of the table: DELETING - The table is being deleted. ACTIVE - The table is ready for use.'
        RetentionProperties:
          $ref: '#/components/schemas/RetentionProperties'
        CreationTime:
          type: string
          format: date-time
          description: The time when the Timestream table was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time when the Timestream table was last updated.
        MagneticStoreWriteProperties:
          $ref: '#/components/schemas/MagneticStoreWriteProperties'
        Schema:
          $ref: '#/components/schemas/Schema'
    Schema:
      type: object
      properties:
        CompositePartitionKey:
          type: array
          items:
            $ref: '#/components/schemas/PartitionKey'
          description: A non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed.
  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-refined-from:
- amazon-timestream-openapi.yml
- amazon-timestream-tables-api-openapi.yml