Client — AWS SDK for Ruby V3 (original) (raw)

Class: Aws::TimestreamQuery::Client

Overview

An API client for TimestreamQuery. To construct a client, you need to configure a :region and :credentials.

client = Aws::TimestreamQuery::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operationscollapse

• #cancel_query(params = {}) ⇒ Types::CancelQueryResponse
  Cancels a query that has been issued.
• #create_scheduled_query(params = {}) ⇒ Types::CreateScheduledQueryResponse
  Create a scheduled query that will be run on your behalf at the configured schedule.
• #delete_scheduled_query(params = {}) ⇒ Struct
  Deletes a given scheduled query.
• #describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse
  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.
• #describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
  DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
• #describe_scheduled_query(params = {}) ⇒ Types::DescribeScheduledQueryResponse
  Provides detailed information about a scheduled query.
• #execute_scheduled_query(params = {}) ⇒ Struct
  You can use this API to run a scheduled query manually.
• #list_scheduled_queries(params = {}) ⇒ Types::ListScheduledQueriesResponse
  Gets a list of all scheduled queries in the caller's Amazon account and Region.
• #list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
  List all tags on a Timestream query resource.
• #prepare_query(params = {}) ⇒ Types::PrepareQueryResponse
  A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.
• #query(params = {}) ⇒ Types::QueryResponse
  Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.
• #tag_resource(params = {}) ⇒ Struct
  Associate a set of tags with a Timestream resource.
• #untag_resource(params = {}) ⇒ Struct
  Removes the association of tags from a Timestream query resource.
• #update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
  Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured.
• #update_scheduled_query(params = {}) ⇒ Struct
  Update a scheduled query.

Instance Method Summarycollapse

• #initialize(options) ⇒ Client constructor
  A new instance of Client.

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Instance Method Details

#cancel_query(params = {}) ⇒ Types::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.

#create_scheduled_query(params = {}) ⇒ Types::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.

#delete_scheduled_query(params = {}) ⇒ Struct

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

#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse

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.

#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse

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.

#describe_scheduled_query(params = {}) ⇒ Types::DescribeScheduledQueryResponse

Provides detailed information about a scheduled query.

#execute_scheduled_query(params = {}) ⇒ Struct

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

If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream.

#list_scheduled_queries(params = {}) ⇒ Types::ListScheduledQueriesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List all tags on a Timestream query resource.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#prepare_query(params = {}) ⇒ Types::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 ValidateOnly set to true.

#query(params = {}) ⇒ Types::QueryResponse

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data.

If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed. QueryInsights helps with performance tuning of your query. For more information aboutQueryInsights, see Using query insights to optimize queries in Amazon Timestream.

The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

#tag_resource(params = {}) ⇒ Struct

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.

#untag_resource(params = {}) ⇒ Struct

Removes the association of tags from a Timestream query resource.

#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse

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.

#update_scheduled_query(params = {}) ⇒ Struct

Update a scheduled query.