Amazon Timestream Timestream Operations API
The Timestream Operations API from Amazon Timestream — 8 operation(s) for timestream operations.
The Timestream Operations API from Amazon Timestream — 8 operation(s) for timestream operations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-timestream:amazon-timestream-operations-api"
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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon Timestream Write Operations API
version: '2018-11-01'
description: Generated from AWS's published Smithy model for Amazon Timestream Write. 8 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: Operations
paths:
/#ResumeBatchLoadTask:
post:
operationId: ResumeBatchLoadTask
summary: Resume Batch Load Task
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResumeBatchLoadTaskResponse'
'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.ResumeBatchLoadTask
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResumeBatchLoadTaskRequest'
tags:
- Operations
/#PrepareQuery:
post:
operationId: PrepareQuery
summary: Prepare Query
description: A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with ValidateOnly set to true.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/PrepareQueryResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamAccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamInternalServerException'
'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/QueryTimestreamThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Timestream_20181101.PrepareQuery
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/PrepareQueryRequest'
tags:
- Operations
servers:
- url: https://query.timestream.{region}.amazonaws.com
variables:
region:
default: us-east-1
/#DescribeEndpoints:
post:
operationId: DescribeEndpoints
summary: Describe Endpoints
description: 'Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs. Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, we don''t recommend that you use this API operation unless: You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream Your application uses a programming language that does not yet have SDK support You require better control over the client-side implementation For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeEndpointsResponse'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'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.DescribeEndpoints
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeEndpointsRequest'
tags:
- Operations
/#ListTagsForResource:
post:
operationId: ListTagsForResource
summary: List Tags For Resource
description: Lists all tags on a Timestream resource.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
'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.ListTagsForResource
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListTagsForResourceRequest'
tags:
- Operations
/#TagResource:
post:
operationId: TagResource
summary: Tag Resource
description: Associates a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/TagResourceResponse'
'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.TagResource
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/TagResourceRequest'
tags:
- Operations
/#UntagResource:
post:
operationId: UntagResource
summary: Untag Resource
description: Removes the association of tags from a Timestream resource.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
'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.UntagResource
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/UntagResourceRequest'
tags:
- Operations
/#DescribeAccountSettings:
post:
operationId: DescribeAccountSettings
summary: Describe Account Settings
description: Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload. You're charged only for the duration of compute units used for your workloads.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeAccountSettingsResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamAccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamInternalServerException'
'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/QueryTimestreamThrottlingException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Timestream_20181101.DescribeAccountSettings
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeAccountSettingsRequest'
tags:
- Operations
servers:
- url: https://query.timestream.{region}.amazonaws.com
variables:
region:
default: us-east-1
/#UpdateAccountSettings:
post:
operationId: UpdateAccountSettings
summary: Update Account Settings
description: Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective. After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/UpdateAccountSettingsResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamAccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamInternalServerException'
'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/QueryTimestreamThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/QueryTimestreamValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Timestream_20181101.UpdateAccountSettings
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/UpdateAccountSettingsRequest'
tags:
- Operations
servers:
- url: https://query.timestream.{region}.amazonaws.com
variables:
region:
default: us-east-1
components:
schemas:
ParameterMapping:
type: object
properties:
Name:
type: string
description: Parameter name.
Type:
$ref: '#/components/schemas/Type'
required:
- Name
- Type
ResumeBatchLoadTaskResponse:
type: object
properties: {}
Tag:
type: object
properties:
Key:
type: string
description: The key of the tag. Tag keys are case sensitive.
Value:
type: string
description: The value of the tag. Tag values are case-sensitive and can be null.
required:
- Key
- Value
InvalidEndpointException:
type: object
properties:
Message:
type: string
UpdateAccountSettingsResponse:
type: object
properties:
MaxQueryTCU:
type: integer
description: The configured maximum number of compute units the service will use at any point in time to serve your queries.
QueryPricingModel:
type: string
enum:
- BYTES_SCANNED
- COMPUTE_UNITS
description: The pricing model for an account.
QueryCompute:
$ref: '#/components/schemas/QueryComputeResponse'
ListTagsForResourceRequest:
type: object
properties:
ResourceARN:
type: string
description: The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).
required:
- ResourceARN
SnsConfiguration:
type: object
properties:
TopicArn:
type: string
description: SNS topic ARN that the scheduled query status notifications will be sent to.
required:
- TopicArn
ResumeBatchLoadTaskRequest:
type: object
properties:
TaskId:
type: string
description: The ID of the batch load task to resume.
required:
- TaskId
ListTagsForResourceResponse:
type: object
properties:
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags currently associated with the Timestream resource.
ColumnInfo:
type: object
properties:
Name:
type: string
description: The name of the result set column. The name of the result set is available for columns of all data types except for arrays.
Type:
$ref: '#/components/schemas/Type'
required:
- Type
Type:
type: object
properties:
ScalarType:
type: string
enum:
- VARCHAR
- BOOLEAN
- BIGINT
- DOUBLE
- TIMESTAMP
- DATE
- TIME
- INTERVAL_DAY_TO_SECOND
- INTERVAL_YEAR_TO_MONTH
- UNKNOWN
- INTEGER
description: Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see Supported data types.
ArrayColumnInfo:
$ref: '#/components/schemas/ColumnInfo'
TimeSeriesMeasureValueColumnInfo:
$ref: '#/components/schemas/ColumnInfo'
RowColumnInfo:
type: array
items:
$ref: '#/components/schemas/ColumnInfo'
description: Indicates if the column is a row.
QueryComputeRequest:
type: object
properties:
ComputeMode:
type: string
enum:
- ON_DEMAND
- PROVISIONED
description: The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED.
ProvisionedCapacity:
$ref: '#/components/schemas/ProvisionedCapacityRequest'
ValidationException:
type: object
properties:
Message:
type: string
required:
- Message
QueryTimestreamThrottlingException:
type: object
properties:
Message:
type: string
ProvisionedCapacityRequest:
type: object
properties:
TargetQueryTCU:
type: integer
description: The target compute capacity for querying data, specified in Timestream Compute Units (TCUs).
NotificationConfiguration:
$ref: '#/components/schemas/AccountSettingsNotificationConfiguration'
required:
- TargetQueryTCU
DescribeEndpointsResponse:
type: object
properties:
Endpoints:
type: array
items:
$ref: '#/components/schemas/Endpoint'
description: An Endpoints object is returned when a DescribeEndpoints request is made.
required:
- Endpoints
QueryTimestreamValidationException:
type: object
properties:
Message:
type: string
DescribeAccountSettingsRequest:
type: object
properties: {}
Endpoint:
type: object
properties:
Address:
type: string
description: An endpoint address.
CachePeriodInMinutes:
type: integer
description: The TTL for the endpoint, in minutes.
required:
- Address
- CachePeriodInMinutes
ResourceNotFoundException:
type: object
properties:
Message:
type: string
ThrottlingException:
type: object
properties:
Message:
type: string
required:
- Message
UpdateAccountSettingsRequest:
type: object
properties:
MaxQueryTCU:
type: integer
description: The maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum value supported for MaxQueryTCU is 1000. To request an increase to this soft limit, contact Amazon Web Services Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs). The maximum value supported for MaxQueryTC
QueryPricingModel:
type: string
enum:
- BYTES_SCANNED
- COMPUTE_UNITS
description: The pricing model for queries in an account. The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.
QueryCompute:
$ref: '#/components/schemas/QueryComputeRequest'
TagResourceResponse:
type: object
properties: {}
QueryTimestreamAccessDeniedException:
type: object
properties:
Message:
type: string
UntagResourceRequest:
type: object
properties:
ResourceARN:
type: string
description: The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
TagKeys:
type: array
items:
type: string
description: A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.
required:
- ResourceARN
- TagKeys
UntagResourceResponse:
type: object
properties: {}
LastUpdate:
type: object
properties:
TargetQueryTCU:
type: integer
description: The number of TimeStream Compute Units (TCUs) requested in the last account settings update.
Status:
type: string
enum:
- PENDING
- FAILED
- SUCCEEDED
description: The status of the last update. Can be either PENDING, FAILED, or SUCCEEDED.
StatusMessage:
type: string
description: Error message describing the last account settings update status, visible only if an error occurred.
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
PrepareQueryRequest:
type: object
properties:
QueryString:
type: string
description: The Timestream query string that you want to use as a prepared statement. Parameter names can be specified in the query string @ character followed by an identifier.
ValidateOnly:
type: boolean
description: By setting this value to true, Timestream will only validate that the query string is a valid Timestream query, and not store the prepared query for later use.
required:
- QueryString
TagResourceRequest:
type: object
properties:
ResourceARN:
type: string
description: Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags to be assigned to the Timestream resource.
required:
- ResourceARN
- Tags
AccountSettingsNotificationConfiguration:
type: object
properties:
SnsConfiguration:
$ref: '#/components/schemas/SnsConfiguration'
RoleArn:
type: string
description: An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.
required:
- RoleArn
DescribeEndpointsRequest:
type: object
properties: {}
SelectColumn:
type: object
properties:
Name:
type: string
description: Name of the column.
Type:
$ref: '#/components/schemas/Type'
DatabaseName:
type: string
description: Database that has this column.
TableName:
type: string
description: Table within the database that has this column.
Aliased:
type: boolean
description: True, if the column name was aliased by the query. False otherwise.
QueryTimestreamInternalServerException:
type: object
properties:
Message:
type: string
ProvisionedCapacityResponse:
type: object
properties:
ActiveQueryTCU:
type: integer
description: The number of Timestream Compute Units (TCUs) provisioned in the account. This field is only visible when the compute mode is PROVISIONED.
NotificationConfiguration:
$ref: '#/components/schemas/AccountSettingsNotificationConfiguration'
LastUpdate:
$ref: '#/components/schemas/LastUpdate'
InternalServerException:
type: object
properties:
Message:
type: string
required:
- Message
AccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
PrepareQueryResponse:
type: object
properties:
QueryString:
type: string
description: The query string that you want prepare.
Columns:
type: array
items:
$ref: '#/components/schemas/SelectColumn'
description: A list of SELECT clause columns of the submitted query string.
Parameters:
type: array
items:
$ref: '#/components/schemas/ParameterMapping'
description: A list of parameters used in the submitted query string.
required:
- QueryString
- Columns
- Parameters
QueryComputeResponse:
type: object
properties:
ComputeMode:
type: string
enum:
- ON_DEMAND
- PROVISIONED
description: The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value PROVISIONED.
ProvisionedCapacity:
$ref: '#/components/schemas/ProvisionedCapacityResponse'
DescribeAccountSettingsResponse:
type: object
properties:
MaxQueryTCU:
type: integer
description: The maximum number of Timestream compute units (TCUs) the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. This configuration is applicable only for on-demand usage of (TCUs).
QueryPricingModel:
type: string
enum:
- BYTES_SCANNED
- COMPUTE_UNITS
description: The pricing model for queries in your account. The QueryPricingModel parameter is used by several Timestream operations; however, the UpdateAccountSettings API operation doesn't recognize any values other than COMPUTE_UNITS.
QueryCompute:
$ref: '#/components/schemas/QueryComputeResponse'
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)
sources:
- https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/timestream-write/service/2018-11-01/timestream-write-2018-11-01.json
- https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/timestream-query/service/2018-11-01/timestream-query-2018-11-01.json