Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimestreamQuery

Amazon Timestream Query

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of TimestreamQueryClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

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.

    Parameters

    Returns Promise<CancelQueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: CancelQueryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CancelQueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

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.

    Parameters

    Returns Promise<CreateScheduledQueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: CreateScheduledQueryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateScheduledQueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

deleteScheduledQuery

describeEndpoints

describeScheduledQuery

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

executeScheduledQuery

listScheduledQueries

listTagsForResource

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.

    Parameters

    Returns Promise<PrepareQueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: PrepareQueryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PrepareQueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

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.

    Parameters

    Returns Promise<QueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: QueryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<QueryCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

send

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.

    Parameters

    Returns Promise<TagResourceCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    • args: TagResourceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<TagResourceCommandOutput>

  • 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.

    Parameters

    Returns void

  • 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.

    Parameters

    Returns void

untagResource

updateScheduledQuery