View Source AWS.TimestreamQuery (aws-elixir v0.13.3)
Amazon Timestream Query
Link to this section Summary
Functions
Cancels a query that has been issued.
Create a scheduled query that will be run on your behalf at the configured schedule.
Deletes a given scheduled query.
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
Provides detailed information about a scheduled query.
You can use this API to run a scheduled query manually.
Gets a list of all scheduled queries in the caller's Amazon account and Region.
List all tags on a Timestream query resource.
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.
Query
is a synchronous operation that enables you to run a query against your
Amazon Timestream data.
Associate a set of tags with a Timestream resource.
Removes the association of tags from a Timestream query resource.
Update a scheduled query.
Link to this section Functions
Cancels a query that has been issued.
Cancellation is provided only if the query has not completed running before the
cancellation request was issued. Because cancellation is an idempotent
operation, subsequent cancellation requests will return a CancellationMessage
,
indicating that the query has already been canceled. See code sample
for details.
Create a scheduled query that will be run on your behalf at the configured schedule.
Timestream assumes the execution role provided as part of the
ScheduledQueryExecutionRoleArn
parameter to run the query. You can use the
NotificationConfiguration
parameter to configure notification for your
scheduled query operations.
Deletes a given scheduled query.
This is an irreversible operation.
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API 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.
Provides detailed information about a scheduled query.
You can use this API to run a scheduled query manually.
Gets a list of all scheduled queries in the caller's Amazon account and Region.
ListScheduledQueries
is eventually consistent.
List all tags on a Timestream query resource.
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 the
PrepareQueryRequest$ValidateOnly
set to true
.
Query
is a synchronous operation that enables you to run a query against your
Amazon Timestream data.
Query
will time out after 60 seconds. You must update the default timeout in
the SDK to support a timeout of 60 seconds. See the code sample
for details.
Your query request will fail in the following cases:
If you submit a
Query
request with the same client token outside of the 5-minute idempotency window.If you submit a
Query
request with the same client token, but change other parameters, within the 5-minute idempotency window.If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
- If the IAM principal of the query initiator and the result reader
are not the same and/or the query initiator and the result reader do not have
the same query string in the query requests, the query will fail with an
Invalid pagination token
error.
Associate 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.
Removes the association of tags from a Timestream query resource.
Update a scheduled query.