amazonaws.com – timestream-query

Tools (15)

Extracted live via the executor SDK.

• xAmzTargetTimestream20181101CancelQuery.cancelQuery

  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.

• xAmzTargetTimestream20181101CreateScheduledQuery.createScheduledQuery

  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.

• xAmzTargetTimestream20181101DeleteScheduledQuery.deleteScheduledQuery

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

• xAmzTargetTimestream20181101DescribeEndpoints.describeEndpoints

  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.

• xAmzTargetTimestream20181101DescribeScheduledQuery.describeScheduledQuery

  Provides detailed information about a scheduled query.

• xAmzTargetTimestream20181101ExecuteScheduledQuery.executeScheduledQuery

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

• xAmzTargetTimestream20181101ListScheduledQueries.listScheduledQueries

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

• xAmzTargetTimestream20181101ListTagsForResource.listTagsForResource

  List all tags on a Timestream query resource.

• xAmzTargetTimestream20181101PrepareQuery.prepareQuery

  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.

• xAmzTargetTimestream20181101Query.query

  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.

• xAmzTargetTimestream20181101TagResource.tagResource

  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.

• xAmzTargetTimestream20181101UntagResource.untagResource

  Removes the association of tags from a Timestream query resource.

• xAmzTargetTimestream20181101UpdateScheduledQuery.updateScheduledQuery

  Update a scheduled query.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools