timestreamquery/aws.sdk.kotlin.services.timestreamquery

Package-level declarations

Types

TimestreamQueryClient

interface TimestreamQueryClient : SdkClient

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

cancelQuery

inline suspend fun TimestreamQueryClient.cancelQuery(crossinline block: CancelQueryRequest.Builder.() -> Unit): CancelQueryResponse

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.

createScheduledQuery

inline suspend fun TimestreamQueryClient.createScheduledQuery(crossinline block: CreateScheduledQueryRequest.Builder.() -> Unit): CreateScheduledQueryResponse

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.

deleteScheduledQuery

inline suspend fun TimestreamQueryClient.deleteScheduledQuery(crossinline block: DeleteScheduledQueryRequest.Builder.() -> Unit): DeleteScheduledQueryResponse

Deletes a given scheduled query. This is an irreversible operation.

describeEndpoints

inline suspend fun TimestreamQueryClient.describeEndpoints(crossinline block: DescribeEndpointsRequest.Builder.() -> Unit): DescribeEndpointsResponse

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

describeScheduledQuery

inline suspend fun TimestreamQueryClient.describeScheduledQuery(crossinline block: DescribeScheduledQueryRequest.Builder.() -> Unit): DescribeScheduledQueryResponse

Provides detailed information about a scheduled query.

executeScheduledQuery

inline suspend fun TimestreamQueryClient.executeScheduledQuery(crossinline block: ExecuteScheduledQueryRequest.Builder.() -> Unit): ExecuteScheduledQueryResponse

You can use this API to run a scheduled query manually.

listScheduledQueries

inline suspend fun TimestreamQueryClient.listScheduledQueries(crossinline block: ListScheduledQueriesRequest.Builder.() -> Unit): ListScheduledQueriesResponse

Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.

listTagsForResource

inline suspend fun TimestreamQueryClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List all tags on a Timestream query resource.

prepareQuery

inline suspend fun TimestreamQueryClient.prepareQuery(crossinline block: PrepareQueryRequest.Builder.() -> Unit): PrepareQueryResponse

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

inline suspend fun TimestreamQueryClient.query(crossinline block: QueryRequest.Builder.() -> Unit): QueryResponse

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.

tagResource

inline suspend fun TimestreamQueryClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun TimestreamQueryClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the association of tags from a Timestream query resource.

updateScheduledQuery

inline suspend fun TimestreamQueryClient.updateScheduledQuery(crossinline block: UpdateScheduledQueryRequest.Builder.() -> Unit): UpdateScheduledQueryResponse

Update a scheduled query.

withConfig

fun TimestreamQueryClient.withConfig(block: TimestreamQueryClient.Config.Builder.() -> Unit): TimestreamQueryClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.