Class: Aws::TimestreamQuery::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::TimestreamQuery::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb
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
API Operations collapse
-
#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 Summary collapse
-
#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.
451 452 453 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 451 def initialize(*args) super end |
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.
490 491 492 493 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 490 def cancel_query(params = {}, = {}) req = build_request(:cancel_query, params) req.send_request() end |
#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.
646 647 648 649 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 646 def create_scheduled_query(params = {}, = {}) req = build_request(:create_scheduled_query, params) req.send_request() end |
#delete_scheduled_query(params = {}) ⇒ Struct
Deletes a given scheduled query. This is an irreversible operation.
668 669 670 671 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 668 def delete_scheduled_query(params = {}, = {}) req = build_request(:delete_scheduled_query, params) req.send_request() end |
#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.
694 695 696 697 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 694 def describe_account_settings(params = {}, = {}) req = build_request(:describe_account_settings, params) req.send_request() end |
#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.
738 739 740 741 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 738 def describe_endpoints(params = {}, = {}) req = build_request(:describe_endpoints, params) req.send_request() end |
#describe_scheduled_query(params = {}) ⇒ Types::DescribeScheduledQueryResponse
Provides detailed information about a scheduled query.
843 844 845 846 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 843 def describe_scheduled_query(params = {}, = {}) req = build_request(:describe_scheduled_query, params) req.send_request() end |
#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.
892 893 894 895 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 892 def execute_scheduled_query(params = {}, = {}) req = build_request(:execute_scheduled_query, params) req.send_request() end |
#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.
945 946 947 948 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 945 def list_scheduled_queries(params = {}, = {}) req = build_request(:list_scheduled_queries, params) req.send_request() end |
#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.
988 989 990 991 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 988 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#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
.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 1051 def prepare_query(params = {}, = {}) req = build_request(:prepare_query, params) req.send_request() end |
#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.
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.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 1246 def query(params = {}, = {}) req = build_request(:query, params) req.send_request() end |
#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.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 1280 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the association of tags from a Timestream query resource.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 1308 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#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.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 1368 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_scheduled_query(params = {}) ⇒ Struct
Update a scheduled query.
1394 1395 1396 1397 |
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/client.rb', line 1394 def update_scheduled_query(params = {}, = {}) req = build_request(:update_scheduled_query, params) req.send_request() end |