aws-sdk-timestreamquery 1.46.0 → 1.47.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamquery/client.rb +58 -7
- data/lib/aws-sdk-timestreamquery/client_api.rb +38 -0
- data/lib/aws-sdk-timestreamquery/types.rb +200 -12
- data/lib/aws-sdk-timestreamquery.rb +1 -1
- data/sig/client.rbs +15 -1
- data/sig/types.rbs +41 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 20a5befd2bef29efe6f726b8b3a7ba52955e7da8c64f68f5c3c02f5813658941
|
4
|
+
data.tar.gz: 2d38a61b8906e52bc5c4b325c87ccfcdfd3d2136834d081dd26b7eacf6837a5a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3151a28a83abeeabcaf2bc8775a571ed889c7b5d99f505f0c0bca118761857ca8c099d038ad1a6fca33b7564167998a9ffcd1216711a020641b58a5a457c4f23
|
7
|
+
data.tar.gz: 2e4718112884ddc5ef1f99d84097034012166bd77bb3619710ae7bbf60e7888a1ec8de6ee5c4bdf5fbadfa2c39cd1b2c37e43241e5073dafc37952496baba5c7
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.47.0 (2024-11-20)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for Provisioning Timestream Compute Units (TCUs), a new feature that allows provisioning dedicated compute resources for your queries, providing predictable and cost-effective query performance.
|
8
|
+
|
4
9
|
1.46.0 (2024-10-22)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.47.0
|
@@ -681,11 +681,19 @@ module Aws::TimestreamQuery
|
|
681
681
|
#
|
682
682
|
# * {Types::DescribeAccountSettingsResponse#max_query_tcu #max_query_tcu} => Integer
|
683
683
|
# * {Types::DescribeAccountSettingsResponse#query_pricing_model #query_pricing_model} => String
|
684
|
+
# * {Types::DescribeAccountSettingsResponse#query_compute #query_compute} => Types::QueryComputeResponse
|
684
685
|
#
|
685
686
|
# @example Response structure
|
686
687
|
#
|
687
688
|
# resp.max_query_tcu #=> Integer
|
688
689
|
# resp.query_pricing_model #=> String, one of "BYTES_SCANNED", "COMPUTE_UNITS"
|
690
|
+
# resp.query_compute.compute_mode #=> String, one of "ON_DEMAND", "PROVISIONED"
|
691
|
+
# resp.query_compute.provisioned_capacity.active_query_tcu #=> Integer
|
692
|
+
# resp.query_compute.provisioned_capacity.notification_configuration.sns_configuration.topic_arn #=> String
|
693
|
+
# resp.query_compute.provisioned_capacity.notification_configuration.role_arn #=> String
|
694
|
+
# resp.query_compute.provisioned_capacity.last_update.target_query_tcu #=> Integer
|
695
|
+
# resp.query_compute.provisioned_capacity.last_update.status #=> String, one of "PENDING", "FAILED", "SUCCEEDED"
|
696
|
+
# resp.query_compute.provisioned_capacity.last_update.status_message #=> String
|
689
697
|
#
|
690
698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeAccountSettings AWS API Documentation
|
691
699
|
#
|
@@ -850,7 +858,12 @@ module Aws::TimestreamQuery
|
|
850
858
|
# If you enabled `QueryInsights`, this API also returns insights and
|
851
859
|
# metrics related to the query that you executed as part of an Amazon
|
852
860
|
# SNS notification. `QueryInsights` helps with performance tuning of
|
853
|
-
# your query.
|
861
|
+
# your query. For more information about `QueryInsights`, see [Using
|
862
|
+
# query insights to optimize queries in Amazon Timestream][1].
|
863
|
+
#
|
864
|
+
#
|
865
|
+
#
|
866
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html
|
854
867
|
#
|
855
868
|
# @option params [required, String] :scheduled_query_arn
|
856
869
|
# ARN of the scheduled query.
|
@@ -1058,7 +1071,9 @@ module Aws::TimestreamQuery
|
|
1058
1071
|
#
|
1059
1072
|
# If you enabled `QueryInsights`, this API also returns insights and
|
1060
1073
|
# metrics related to the query that you executed. `QueryInsights` helps
|
1061
|
-
# with performance tuning of your query.
|
1074
|
+
# with performance tuning of your query. For more information about
|
1075
|
+
# `QueryInsights`, see [Using query insights to optimize queries in
|
1076
|
+
# Amazon Timestream][1].
|
1062
1077
|
#
|
1063
1078
|
# <note markdown="1"> The maximum number of `Query` API requests you're allowed to make
|
1064
1079
|
# with `QueryInsights` enabled is 1 query per second (QPS). If you
|
@@ -1068,7 +1083,7 @@ module Aws::TimestreamQuery
|
|
1068
1083
|
#
|
1069
1084
|
# `Query` will time out after 60 seconds. You must update the default
|
1070
1085
|
# timeout in the SDK to support a timeout of 60 seconds. See the [code
|
1071
|
-
# sample][
|
1086
|
+
# sample][2] for details.
|
1072
1087
|
#
|
1073
1088
|
# Your query request will fail in the following cases:
|
1074
1089
|
#
|
@@ -1091,7 +1106,8 @@ module Aws::TimestreamQuery
|
|
1091
1106
|
#
|
1092
1107
|
#
|
1093
1108
|
#
|
1094
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
1109
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html
|
1110
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html
|
1095
1111
|
#
|
1096
1112
|
# @option params [required, String] :query_string
|
1097
1113
|
# The query to be run by Timestream.
|
@@ -1324,11 +1340,16 @@ module Aws::TimestreamQuery
|
|
1324
1340
|
# The maximum number of compute units the service will use at any point
|
1325
1341
|
# in time to serve your queries. To run queries, you must set a minimum
|
1326
1342
|
# capacity of 4 TCU. You can set the maximum number of TCU in multiples
|
1327
|
-
# of 4, for example, 4, 8, 16, 32, and so on.
|
1343
|
+
# of 4, for example, 4, 8, 16, 32, and so on. The maximum value
|
1344
|
+
# supported for `MaxQueryTCU` is 1000. To request an increase to this
|
1345
|
+
# soft limit, contact Amazon Web Services Support. For information about
|
1346
|
+
# the default quota for maxQueryTCU, see Default quotas. This
|
1347
|
+
# configuration is applicable only for on-demand usage of Timestream
|
1348
|
+
# Compute Units (TCUs).
|
1328
1349
|
#
|
1329
1350
|
# The maximum value supported for `MaxQueryTCU` is 1000. To request an
|
1330
1351
|
# increase to this soft limit, contact Amazon Web Services Support. For
|
1331
|
-
# information about the default quota for maxQueryTCU
|
1352
|
+
# information about the default quota for `maxQueryTCU`, see [Default
|
1332
1353
|
# quotas][1].
|
1333
1354
|
#
|
1334
1355
|
#
|
@@ -1344,22 +1365,52 @@ module Aws::TimestreamQuery
|
|
1344
1365
|
#
|
1345
1366
|
# </note>
|
1346
1367
|
#
|
1368
|
+
# @option params [Types::QueryComputeRequest] :query_compute
|
1369
|
+
# Modifies the query compute settings configured in your account,
|
1370
|
+
# including the query pricing model and provisioned Timestream Compute
|
1371
|
+
# Units (TCUs) in your account.
|
1372
|
+
#
|
1373
|
+
# <note markdown="1"> This API is idempotent, meaning that making the same request multiple
|
1374
|
+
# times will have the same effect as making the request once.
|
1375
|
+
#
|
1376
|
+
# </note>
|
1377
|
+
#
|
1347
1378
|
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1348
1379
|
#
|
1349
1380
|
# * {Types::UpdateAccountSettingsResponse#max_query_tcu #max_query_tcu} => Integer
|
1350
1381
|
# * {Types::UpdateAccountSettingsResponse#query_pricing_model #query_pricing_model} => String
|
1382
|
+
# * {Types::UpdateAccountSettingsResponse#query_compute #query_compute} => Types::QueryComputeResponse
|
1351
1383
|
#
|
1352
1384
|
# @example Request syntax with placeholder values
|
1353
1385
|
#
|
1354
1386
|
# resp = client.update_account_settings({
|
1355
1387
|
# max_query_tcu: 1,
|
1356
1388
|
# query_pricing_model: "BYTES_SCANNED", # accepts BYTES_SCANNED, COMPUTE_UNITS
|
1389
|
+
# query_compute: {
|
1390
|
+
# compute_mode: "ON_DEMAND", # accepts ON_DEMAND, PROVISIONED
|
1391
|
+
# provisioned_capacity: {
|
1392
|
+
# target_query_tcu: 1, # required
|
1393
|
+
# notification_configuration: {
|
1394
|
+
# sns_configuration: {
|
1395
|
+
# topic_arn: "AmazonResourceName", # required
|
1396
|
+
# },
|
1397
|
+
# role_arn: "AmazonResourceName", # required
|
1398
|
+
# },
|
1399
|
+
# },
|
1400
|
+
# },
|
1357
1401
|
# })
|
1358
1402
|
#
|
1359
1403
|
# @example Response structure
|
1360
1404
|
#
|
1361
1405
|
# resp.max_query_tcu #=> Integer
|
1362
1406
|
# resp.query_pricing_model #=> String, one of "BYTES_SCANNED", "COMPUTE_UNITS"
|
1407
|
+
# resp.query_compute.compute_mode #=> String, one of "ON_DEMAND", "PROVISIONED"
|
1408
|
+
# resp.query_compute.provisioned_capacity.active_query_tcu #=> Integer
|
1409
|
+
# resp.query_compute.provisioned_capacity.notification_configuration.sns_configuration.topic_arn #=> String
|
1410
|
+
# resp.query_compute.provisioned_capacity.notification_configuration.role_arn #=> String
|
1411
|
+
# resp.query_compute.provisioned_capacity.last_update.target_query_tcu #=> Integer
|
1412
|
+
# resp.query_compute.provisioned_capacity.last_update.status #=> String, one of "PENDING", "FAILED", "SUCCEEDED"
|
1413
|
+
# resp.query_compute.provisioned_capacity.last_update.status_message #=> String
|
1363
1414
|
#
|
1364
1415
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UpdateAccountSettings AWS API Documentation
|
1365
1416
|
#
|
@@ -1414,7 +1465,7 @@ module Aws::TimestreamQuery
|
|
1414
1465
|
tracer: tracer
|
1415
1466
|
)
|
1416
1467
|
context[:gem_name] = 'aws-sdk-timestreamquery'
|
1417
|
-
context[:gem_version] = '1.
|
1468
|
+
context[:gem_version] = '1.47.0'
|
1418
1469
|
Seahorse::Client::Request.new(handlers, context)
|
1419
1470
|
end
|
1420
1471
|
|
@@ -15,6 +15,7 @@ module Aws::TimestreamQuery
|
|
15
15
|
include Seahorse::Model
|
16
16
|
|
17
17
|
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
18
|
+
AccountSettingsNotificationConfiguration = Shapes::StructureShape.new(name: 'AccountSettingsNotificationConfiguration')
|
18
19
|
AmazonResourceName = Shapes::StringShape.new(name: 'AmazonResourceName')
|
19
20
|
CancelQueryRequest = Shapes::StructureShape.new(name: 'CancelQueryRequest')
|
20
21
|
CancelQueryResponse = Shapes::StructureShape.new(name: 'CancelQueryResponse')
|
@@ -22,6 +23,7 @@ module Aws::TimestreamQuery
|
|
22
23
|
ClientToken = Shapes::StringShape.new(name: 'ClientToken')
|
23
24
|
ColumnInfo = Shapes::StructureShape.new(name: 'ColumnInfo')
|
24
25
|
ColumnInfoList = Shapes::ListShape.new(name: 'ColumnInfoList')
|
26
|
+
ComputeMode = Shapes::StringShape.new(name: 'ComputeMode')
|
25
27
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
26
28
|
CreateScheduledQueryRequest = Shapes::StructureShape.new(name: 'CreateScheduledQueryRequest')
|
27
29
|
CreateScheduledQueryResponse = Shapes::StructureShape.new(name: 'CreateScheduledQueryResponse')
|
@@ -47,6 +49,8 @@ module Aws::TimestreamQuery
|
|
47
49
|
ExecutionStats = Shapes::StructureShape.new(name: 'ExecutionStats')
|
48
50
|
InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
|
49
51
|
InvalidEndpointException = Shapes::StructureShape.new(name: 'InvalidEndpointException')
|
52
|
+
LastUpdate = Shapes::StructureShape.new(name: 'LastUpdate')
|
53
|
+
LastUpdateStatus = Shapes::StringShape.new(name: 'LastUpdateStatus')
|
50
54
|
ListScheduledQueriesRequest = Shapes::StructureShape.new(name: 'ListScheduledQueriesRequest')
|
51
55
|
ListScheduledQueriesResponse = Shapes::StructureShape.new(name: 'ListScheduledQueriesResponse')
|
52
56
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -73,6 +77,10 @@ module Aws::TimestreamQuery
|
|
73
77
|
PartitionKeyList = Shapes::ListShape.new(name: 'PartitionKeyList')
|
74
78
|
PrepareQueryRequest = Shapes::StructureShape.new(name: 'PrepareQueryRequest')
|
75
79
|
PrepareQueryResponse = Shapes::StructureShape.new(name: 'PrepareQueryResponse')
|
80
|
+
ProvisionedCapacityRequest = Shapes::StructureShape.new(name: 'ProvisionedCapacityRequest')
|
81
|
+
ProvisionedCapacityResponse = Shapes::StructureShape.new(name: 'ProvisionedCapacityResponse')
|
82
|
+
QueryComputeRequest = Shapes::StructureShape.new(name: 'QueryComputeRequest')
|
83
|
+
QueryComputeResponse = Shapes::StructureShape.new(name: 'QueryComputeResponse')
|
76
84
|
QueryExecutionException = Shapes::StructureShape.new(name: 'QueryExecutionException')
|
77
85
|
QueryId = Shapes::StringShape.new(name: 'QueryId')
|
78
86
|
QueryInsights = Shapes::StructureShape.new(name: 'QueryInsights')
|
@@ -85,6 +93,7 @@ module Aws::TimestreamQuery
|
|
85
93
|
QuerySpatialCoverageMax = Shapes::StructureShape.new(name: 'QuerySpatialCoverageMax')
|
86
94
|
QueryStatus = Shapes::StructureShape.new(name: 'QueryStatus')
|
87
95
|
QueryString = Shapes::StringShape.new(name: 'QueryString')
|
96
|
+
QueryTCU = Shapes::IntegerShape.new(name: 'QueryTCU')
|
88
97
|
QueryTemporalRange = Shapes::StructureShape.new(name: 'QueryTemporalRange')
|
89
98
|
QueryTemporalRangeMax = Shapes::StructureShape.new(name: 'QueryTemporalRangeMax')
|
90
99
|
ResourceName = Shapes::StringShape.new(name: 'ResourceName')
|
@@ -148,6 +157,10 @@ module Aws::TimestreamQuery
|
|
148
157
|
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: ServiceErrorMessage, location_name: "Message"))
|
149
158
|
AccessDeniedException.struct_class = Types::AccessDeniedException
|
150
159
|
|
160
|
+
AccountSettingsNotificationConfiguration.add_member(:sns_configuration, Shapes::ShapeRef.new(shape: SnsConfiguration, location_name: "SnsConfiguration"))
|
161
|
+
AccountSettingsNotificationConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "RoleArn"))
|
162
|
+
AccountSettingsNotificationConfiguration.struct_class = Types::AccountSettingsNotificationConfiguration
|
163
|
+
|
151
164
|
CancelQueryRequest.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, required: true, location_name: "QueryId"))
|
152
165
|
CancelQueryRequest.struct_class = Types::CancelQueryRequest
|
153
166
|
|
@@ -194,6 +207,7 @@ module Aws::TimestreamQuery
|
|
194
207
|
|
195
208
|
DescribeAccountSettingsResponse.add_member(:max_query_tcu, Shapes::ShapeRef.new(shape: MaxQueryCapacity, location_name: "MaxQueryTCU"))
|
196
209
|
DescribeAccountSettingsResponse.add_member(:query_pricing_model, Shapes::ShapeRef.new(shape: QueryPricingModel, location_name: "QueryPricingModel"))
|
210
|
+
DescribeAccountSettingsResponse.add_member(:query_compute, Shapes::ShapeRef.new(shape: QueryComputeResponse, location_name: "QueryCompute"))
|
197
211
|
DescribeAccountSettingsResponse.struct_class = Types::DescribeAccountSettingsResponse
|
198
212
|
|
199
213
|
DescribeEndpointsRequest.struct_class = Types::DescribeEndpointsRequest
|
@@ -245,6 +259,11 @@ module Aws::TimestreamQuery
|
|
245
259
|
InvalidEndpointException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
246
260
|
InvalidEndpointException.struct_class = Types::InvalidEndpointException
|
247
261
|
|
262
|
+
LastUpdate.add_member(:target_query_tcu, Shapes::ShapeRef.new(shape: QueryTCU, location_name: "TargetQueryTCU"))
|
263
|
+
LastUpdate.add_member(:status, Shapes::ShapeRef.new(shape: LastUpdateStatus, location_name: "Status"))
|
264
|
+
LastUpdate.add_member(:status_message, Shapes::ShapeRef.new(shape: String, location_name: "StatusMessage"))
|
265
|
+
LastUpdate.struct_class = Types::LastUpdate
|
266
|
+
|
248
267
|
ListScheduledQueriesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxScheduledQueriesResults, location_name: "MaxResults"))
|
249
268
|
ListScheduledQueriesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextScheduledQueriesResultsToken, location_name: "NextToken"))
|
250
269
|
ListScheduledQueriesRequest.struct_class = Types::ListScheduledQueriesRequest
|
@@ -302,6 +321,23 @@ module Aws::TimestreamQuery
|
|
302
321
|
PrepareQueryResponse.add_member(:parameters, Shapes::ShapeRef.new(shape: ParameterMappingList, required: true, location_name: "Parameters"))
|
303
322
|
PrepareQueryResponse.struct_class = Types::PrepareQueryResponse
|
304
323
|
|
324
|
+
ProvisionedCapacityRequest.add_member(:target_query_tcu, Shapes::ShapeRef.new(shape: QueryTCU, required: true, location_name: "TargetQueryTCU"))
|
325
|
+
ProvisionedCapacityRequest.add_member(:notification_configuration, Shapes::ShapeRef.new(shape: AccountSettingsNotificationConfiguration, location_name: "NotificationConfiguration"))
|
326
|
+
ProvisionedCapacityRequest.struct_class = Types::ProvisionedCapacityRequest
|
327
|
+
|
328
|
+
ProvisionedCapacityResponse.add_member(:active_query_tcu, Shapes::ShapeRef.new(shape: QueryTCU, location_name: "ActiveQueryTCU"))
|
329
|
+
ProvisionedCapacityResponse.add_member(:notification_configuration, Shapes::ShapeRef.new(shape: AccountSettingsNotificationConfiguration, location_name: "NotificationConfiguration"))
|
330
|
+
ProvisionedCapacityResponse.add_member(:last_update, Shapes::ShapeRef.new(shape: LastUpdate, location_name: "LastUpdate"))
|
331
|
+
ProvisionedCapacityResponse.struct_class = Types::ProvisionedCapacityResponse
|
332
|
+
|
333
|
+
QueryComputeRequest.add_member(:compute_mode, Shapes::ShapeRef.new(shape: ComputeMode, location_name: "ComputeMode"))
|
334
|
+
QueryComputeRequest.add_member(:provisioned_capacity, Shapes::ShapeRef.new(shape: ProvisionedCapacityRequest, location_name: "ProvisionedCapacity"))
|
335
|
+
QueryComputeRequest.struct_class = Types::QueryComputeRequest
|
336
|
+
|
337
|
+
QueryComputeResponse.add_member(:compute_mode, Shapes::ShapeRef.new(shape: ComputeMode, location_name: "ComputeMode"))
|
338
|
+
QueryComputeResponse.add_member(:provisioned_capacity, Shapes::ShapeRef.new(shape: ProvisionedCapacityResponse, location_name: "ProvisionedCapacity"))
|
339
|
+
QueryComputeResponse.struct_class = Types::QueryComputeResponse
|
340
|
+
|
305
341
|
QueryExecutionException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
306
342
|
QueryExecutionException.struct_class = Types::QueryExecutionException
|
307
343
|
|
@@ -496,10 +532,12 @@ module Aws::TimestreamQuery
|
|
496
532
|
|
497
533
|
UpdateAccountSettingsRequest.add_member(:max_query_tcu, Shapes::ShapeRef.new(shape: MaxQueryCapacity, location_name: "MaxQueryTCU"))
|
498
534
|
UpdateAccountSettingsRequest.add_member(:query_pricing_model, Shapes::ShapeRef.new(shape: QueryPricingModel, location_name: "QueryPricingModel"))
|
535
|
+
UpdateAccountSettingsRequest.add_member(:query_compute, Shapes::ShapeRef.new(shape: QueryComputeRequest, location_name: "QueryCompute"))
|
499
536
|
UpdateAccountSettingsRequest.struct_class = Types::UpdateAccountSettingsRequest
|
500
537
|
|
501
538
|
UpdateAccountSettingsResponse.add_member(:max_query_tcu, Shapes::ShapeRef.new(shape: MaxQueryCapacity, location_name: "MaxQueryTCU"))
|
502
539
|
UpdateAccountSettingsResponse.add_member(:query_pricing_model, Shapes::ShapeRef.new(shape: QueryPricingModel, location_name: "QueryPricingModel"))
|
540
|
+
UpdateAccountSettingsResponse.add_member(:query_compute, Shapes::ShapeRef.new(shape: QueryComputeResponse, location_name: "QueryCompute"))
|
503
541
|
UpdateAccountSettingsResponse.struct_class = Types::UpdateAccountSettingsResponse
|
504
542
|
|
505
543
|
UpdateScheduledQueryRequest.add_member(:scheduled_query_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "ScheduledQueryArn"))
|
@@ -10,7 +10,8 @@
|
|
10
10
|
module Aws::TimestreamQuery
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# You
|
13
|
+
# You do not have the necessary permissions to access the account
|
14
|
+
# settings.
|
14
15
|
#
|
15
16
|
# @!attribute [rw] message
|
16
17
|
# @return [String]
|
@@ -23,6 +24,27 @@ module Aws::TimestreamQuery
|
|
23
24
|
include Aws::Structure
|
24
25
|
end
|
25
26
|
|
27
|
+
# Configuration settings for notifications related to account settings.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] sns_configuration
|
30
|
+
# Details on SNS that are required to send the notification.
|
31
|
+
# @return [Types::SnsConfiguration]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] role_arn
|
34
|
+
# An Amazon Resource Name (ARN) that grants Timestream permission to
|
35
|
+
# publish notifications. This field is only visible if SNS Topic is
|
36
|
+
# provided when updating the account settings.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration AWS API Documentation
|
40
|
+
#
|
41
|
+
class AccountSettingsNotificationConfiguration < Struct.new(
|
42
|
+
:sns_configuration,
|
43
|
+
:role_arn)
|
44
|
+
SENSITIVE = []
|
45
|
+
include Aws::Structure
|
46
|
+
end
|
47
|
+
|
26
48
|
# @!attribute [rw] query_id
|
27
49
|
# The ID of the query that needs to be cancelled. `QueryID` is
|
28
50
|
# returned as part of the query result.
|
@@ -244,7 +266,11 @@ module Aws::TimestreamQuery
|
|
244
266
|
|
245
267
|
# @!attribute [rw] max_query_tcu
|
246
268
|
# The maximum number of [Timestream compute units][1] (TCUs) the
|
247
|
-
# service will use at any point in time to serve your queries.
|
269
|
+
# service will use at any point in time to serve your queries. To run
|
270
|
+
# queries, you must set a minimum capacity of 4 TCU. You can set the
|
271
|
+
# maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32,
|
272
|
+
# and so on. This configuration is applicable only for on-demand usage
|
273
|
+
# of (TCUs).
|
248
274
|
#
|
249
275
|
#
|
250
276
|
#
|
@@ -253,13 +279,25 @@ module Aws::TimestreamQuery
|
|
253
279
|
#
|
254
280
|
# @!attribute [rw] query_pricing_model
|
255
281
|
# The pricing model for queries in your account.
|
282
|
+
#
|
283
|
+
# <note markdown="1"> The `QueryPricingModel` parameter is used by several Timestream
|
284
|
+
# operations; however, the `UpdateAccountSettings` API operation
|
285
|
+
# doesn't recognize any values other than `COMPUTE_UNITS`.
|
286
|
+
#
|
287
|
+
# </note>
|
256
288
|
# @return [String]
|
257
289
|
#
|
290
|
+
# @!attribute [rw] query_compute
|
291
|
+
# An object that contains the usage settings for Timestream Compute
|
292
|
+
# Units (TCUs) in your account for the query workload.
|
293
|
+
# @return [Types::QueryComputeResponse]
|
294
|
+
#
|
258
295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeAccountSettingsResponse AWS API Documentation
|
259
296
|
#
|
260
297
|
class DescribeAccountSettingsResponse < Struct.new(
|
261
298
|
:max_query_tcu,
|
262
|
-
:query_pricing_model
|
299
|
+
:query_pricing_model,
|
300
|
+
:query_compute)
|
263
301
|
SENSITIVE = []
|
264
302
|
include Aws::Structure
|
265
303
|
end
|
@@ -453,8 +491,7 @@ module Aws::TimestreamQuery
|
|
453
491
|
include Aws::Structure
|
454
492
|
end
|
455
493
|
|
456
|
-
#
|
457
|
-
# internal server error.
|
494
|
+
# An internal server error occurred while processing the request.
|
458
495
|
#
|
459
496
|
# @!attribute [rw] message
|
460
497
|
# @return [String]
|
@@ -467,7 +504,7 @@ module Aws::TimestreamQuery
|
|
467
504
|
include Aws::Structure
|
468
505
|
end
|
469
506
|
|
470
|
-
# The requested endpoint
|
507
|
+
# The requested endpoint is invalid.
|
471
508
|
#
|
472
509
|
# @!attribute [rw] message
|
473
510
|
# @return [String]
|
@@ -480,6 +517,34 @@ module Aws::TimestreamQuery
|
|
480
517
|
include Aws::Structure
|
481
518
|
end
|
482
519
|
|
520
|
+
# Configuration object that contains the most recent account settings
|
521
|
+
# update, visible only if settings have been updated previously.
|
522
|
+
#
|
523
|
+
# @!attribute [rw] target_query_tcu
|
524
|
+
# The number of TimeStream Compute Units (TCUs) requested in the last
|
525
|
+
# account settings update.
|
526
|
+
# @return [Integer]
|
527
|
+
#
|
528
|
+
# @!attribute [rw] status
|
529
|
+
# The status of the last update. Can be either `PENDING`, `FAILED`, or
|
530
|
+
# `SUCCEEDED`.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @!attribute [rw] status_message
|
534
|
+
# Error message describing the last account settings update status,
|
535
|
+
# visible only if an error occurred.
|
536
|
+
# @return [String]
|
537
|
+
#
|
538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/LastUpdate AWS API Documentation
|
539
|
+
#
|
540
|
+
class LastUpdate < Struct.new(
|
541
|
+
:target_query_tcu,
|
542
|
+
:status,
|
543
|
+
:status_message)
|
544
|
+
SENSITIVE = []
|
545
|
+
include Aws::Structure
|
546
|
+
end
|
547
|
+
|
483
548
|
# @!attribute [rw] max_results
|
484
549
|
# The maximum number of items to return in the output. If the total
|
485
550
|
# number of items available is more than the value specified, a
|
@@ -656,7 +721,9 @@ module Aws::TimestreamQuery
|
|
656
721
|
# updated or when it is deleted.
|
657
722
|
#
|
658
723
|
# @!attribute [rw] sns_configuration
|
659
|
-
# Details
|
724
|
+
# Details about the Amazon Simple Notification Service (SNS)
|
725
|
+
# configuration. This field is visible only when SNS Topic is provided
|
726
|
+
# when updating the account settings.
|
660
727
|
# @return [Types::SnsConfiguration]
|
661
728
|
#
|
662
729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/NotificationConfiguration AWS API Documentation
|
@@ -733,6 +800,104 @@ module Aws::TimestreamQuery
|
|
733
800
|
include Aws::Structure
|
734
801
|
end
|
735
802
|
|
803
|
+
# A request to update the provisioned capacity settings for querying
|
804
|
+
# data.
|
805
|
+
#
|
806
|
+
# @!attribute [rw] target_query_tcu
|
807
|
+
# The target compute capacity for querying data, specified in
|
808
|
+
# Timestream Compute Units (TCUs).
|
809
|
+
# @return [Integer]
|
810
|
+
#
|
811
|
+
# @!attribute [rw] notification_configuration
|
812
|
+
# Configuration settings for notifications related to the provisioned
|
813
|
+
# capacity update.
|
814
|
+
# @return [Types::AccountSettingsNotificationConfiguration]
|
815
|
+
#
|
816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ProvisionedCapacityRequest AWS API Documentation
|
817
|
+
#
|
818
|
+
class ProvisionedCapacityRequest < Struct.new(
|
819
|
+
:target_query_tcu,
|
820
|
+
:notification_configuration)
|
821
|
+
SENSITIVE = []
|
822
|
+
include Aws::Structure
|
823
|
+
end
|
824
|
+
|
825
|
+
# The response to a request to update the provisioned capacity settings
|
826
|
+
# for querying data.
|
827
|
+
#
|
828
|
+
# @!attribute [rw] active_query_tcu
|
829
|
+
# The number of Timestream Compute Units (TCUs) provisioned in the
|
830
|
+
# account. This field is only visible when the compute mode is
|
831
|
+
# `PROVISIONED`.
|
832
|
+
# @return [Integer]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] notification_configuration
|
835
|
+
# An object that contains settings for notifications that are sent
|
836
|
+
# whenever the provisioned capacity settings are modified. This field
|
837
|
+
# is only visible when the compute mode is `PROVISIONED`.
|
838
|
+
# @return [Types::AccountSettingsNotificationConfiguration]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] last_update
|
841
|
+
# Information about the last update to the provisioned capacity
|
842
|
+
# settings.
|
843
|
+
# @return [Types::LastUpdate]
|
844
|
+
#
|
845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ProvisionedCapacityResponse AWS API Documentation
|
846
|
+
#
|
847
|
+
class ProvisionedCapacityResponse < Struct.new(
|
848
|
+
:active_query_tcu,
|
849
|
+
:notification_configuration,
|
850
|
+
:last_update)
|
851
|
+
SENSITIVE = []
|
852
|
+
include Aws::Structure
|
853
|
+
end
|
854
|
+
|
855
|
+
# A request to retrieve or update the compute capacity settings for
|
856
|
+
# querying data.
|
857
|
+
#
|
858
|
+
# @!attribute [rw] compute_mode
|
859
|
+
# The mode in which Timestream Compute Units (TCUs) are allocated and
|
860
|
+
# utilized within an account. Note that in the Asia Pacific (Mumbai)
|
861
|
+
# region, the API operation only recognizes the value `PROVISIONED`.
|
862
|
+
# @return [String]
|
863
|
+
#
|
864
|
+
# @!attribute [rw] provisioned_capacity
|
865
|
+
# Configuration object that contains settings for provisioned
|
866
|
+
# Timestream Compute Units (TCUs) in your account.
|
867
|
+
# @return [Types::ProvisionedCapacityRequest]
|
868
|
+
#
|
869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryComputeRequest AWS API Documentation
|
870
|
+
#
|
871
|
+
class QueryComputeRequest < Struct.new(
|
872
|
+
:compute_mode,
|
873
|
+
:provisioned_capacity)
|
874
|
+
SENSITIVE = []
|
875
|
+
include Aws::Structure
|
876
|
+
end
|
877
|
+
|
878
|
+
# The response to a request to retrieve or update the compute capacity
|
879
|
+
# settings for querying data.
|
880
|
+
#
|
881
|
+
# @!attribute [rw] compute_mode
|
882
|
+
# The mode in which Timestream Compute Units (TCUs) are allocated and
|
883
|
+
# utilized within an account. Note that in the Asia Pacific (Mumbai)
|
884
|
+
# region, the API operation only recognizes the value `PROVISIONED`.
|
885
|
+
# @return [String]
|
886
|
+
#
|
887
|
+
# @!attribute [rw] provisioned_capacity
|
888
|
+
# Configuration object that contains settings for provisioned
|
889
|
+
# Timestream Compute Units (TCUs) in your account.
|
890
|
+
# @return [Types::ProvisionedCapacityResponse]
|
891
|
+
#
|
892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryComputeResponse AWS API Documentation
|
893
|
+
#
|
894
|
+
class QueryComputeResponse < Struct.new(
|
895
|
+
:compute_mode,
|
896
|
+
:provisioned_capacity)
|
897
|
+
SENSITIVE = []
|
898
|
+
include Aws::Structure
|
899
|
+
end
|
900
|
+
|
736
901
|
# Timestream was unable to run the query successfully.
|
737
902
|
#
|
738
903
|
# @!attribute [rw] message
|
@@ -1653,7 +1818,7 @@ module Aws::TimestreamQuery
|
|
1653
1818
|
include Aws::Structure
|
1654
1819
|
end
|
1655
1820
|
|
1656
|
-
# The request was
|
1821
|
+
# The request was throttled due to excessive requests.
|
1657
1822
|
#
|
1658
1823
|
# @!attribute [rw] message
|
1659
1824
|
# @return [String]
|
@@ -1825,11 +1990,16 @@ module Aws::TimestreamQuery
|
|
1825
1990
|
# The maximum number of compute units the service will use at any
|
1826
1991
|
# point in time to serve your queries. To run queries, you must set a
|
1827
1992
|
# minimum capacity of 4 TCU. You can set the maximum number of TCU in
|
1828
|
-
# multiples of 4, for example, 4, 8, 16, 32, and so on.
|
1993
|
+
# multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum
|
1994
|
+
# value supported for `MaxQueryTCU` is 1000. To request an increase to
|
1995
|
+
# this soft limit, contact Amazon Web Services Support. For
|
1996
|
+
# information about the default quota for maxQueryTCU, see Default
|
1997
|
+
# quotas. This configuration is applicable only for on-demand usage of
|
1998
|
+
# Timestream Compute Units (TCUs).
|
1829
1999
|
#
|
1830
2000
|
# The maximum value supported for `MaxQueryTCU` is 1000. To request an
|
1831
2001
|
# increase to this soft limit, contact Amazon Web Services Support.
|
1832
|
-
# For information about the default quota for maxQueryTCU
|
2002
|
+
# For information about the default quota for `maxQueryTCU`, see
|
1833
2003
|
# [Default quotas][1].
|
1834
2004
|
#
|
1835
2005
|
#
|
@@ -1847,11 +2017,23 @@ module Aws::TimestreamQuery
|
|
1847
2017
|
# </note>
|
1848
2018
|
# @return [String]
|
1849
2019
|
#
|
2020
|
+
# @!attribute [rw] query_compute
|
2021
|
+
# Modifies the query compute settings configured in your account,
|
2022
|
+
# including the query pricing model and provisioned Timestream Compute
|
2023
|
+
# Units (TCUs) in your account.
|
2024
|
+
#
|
2025
|
+
# <note markdown="1"> This API is idempotent, meaning that making the same request
|
2026
|
+
# multiple times will have the same effect as making the request once.
|
2027
|
+
#
|
2028
|
+
# </note>
|
2029
|
+
# @return [Types::QueryComputeRequest]
|
2030
|
+
#
|
1850
2031
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UpdateAccountSettingsRequest AWS API Documentation
|
1851
2032
|
#
|
1852
2033
|
class UpdateAccountSettingsRequest < Struct.new(
|
1853
2034
|
:max_query_tcu,
|
1854
|
-
:query_pricing_model
|
2035
|
+
:query_pricing_model,
|
2036
|
+
:query_compute)
|
1855
2037
|
SENSITIVE = []
|
1856
2038
|
include Aws::Structure
|
1857
2039
|
end
|
@@ -1865,11 +2047,17 @@ module Aws::TimestreamQuery
|
|
1865
2047
|
# The pricing model for an account.
|
1866
2048
|
# @return [String]
|
1867
2049
|
#
|
2050
|
+
# @!attribute [rw] query_compute
|
2051
|
+
# Confirms the updated account settings for querying data in your
|
2052
|
+
# account.
|
2053
|
+
# @return [Types::QueryComputeResponse]
|
2054
|
+
#
|
1868
2055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UpdateAccountSettingsResponse AWS API Documentation
|
1869
2056
|
#
|
1870
2057
|
class UpdateAccountSettingsResponse < Struct.new(
|
1871
2058
|
:max_query_tcu,
|
1872
|
-
:query_pricing_model
|
2059
|
+
:query_pricing_model,
|
2060
|
+
:query_compute)
|
1873
2061
|
SENSITIVE = []
|
1874
2062
|
include Aws::Structure
|
1875
2063
|
end
|
data/sig/client.rbs
CHANGED
@@ -170,6 +170,7 @@ module Aws
|
|
170
170
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeAccountSettingsResponse]
|
171
171
|
def max_query_tcu: () -> ::Integer
|
172
172
|
def query_pricing_model: () -> ("BYTES_SCANNED" | "COMPUTE_UNITS")
|
173
|
+
def query_compute: () -> Types::QueryComputeResponse
|
173
174
|
end
|
174
175
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/TimestreamQuery/Client.html#describe_account_settings-instance_method
|
175
176
|
def describe_account_settings: (
|
@@ -294,11 +295,24 @@ module Aws
|
|
294
295
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAccountSettingsResponse]
|
295
296
|
def max_query_tcu: () -> ::Integer
|
296
297
|
def query_pricing_model: () -> ("BYTES_SCANNED" | "COMPUTE_UNITS")
|
298
|
+
def query_compute: () -> Types::QueryComputeResponse
|
297
299
|
end
|
298
300
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/TimestreamQuery/Client.html#update_account_settings-instance_method
|
299
301
|
def update_account_settings: (
|
300
302
|
?max_query_tcu: ::Integer,
|
301
|
-
?query_pricing_model: ("BYTES_SCANNED" | "COMPUTE_UNITS")
|
303
|
+
?query_pricing_model: ("BYTES_SCANNED" | "COMPUTE_UNITS"),
|
304
|
+
?query_compute: {
|
305
|
+
compute_mode: ("ON_DEMAND" | "PROVISIONED")?,
|
306
|
+
provisioned_capacity: {
|
307
|
+
target_query_tcu: ::Integer,
|
308
|
+
notification_configuration: {
|
309
|
+
sns_configuration: {
|
310
|
+
topic_arn: ::String
|
311
|
+
}?,
|
312
|
+
role_arn: ::String
|
313
|
+
}?
|
314
|
+
}?
|
315
|
+
}
|
302
316
|
) -> _UpdateAccountSettingsResponseSuccess
|
303
317
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAccountSettingsResponseSuccess
|
304
318
|
|
data/sig/types.rbs
CHANGED
@@ -13,6 +13,12 @@ module Aws::TimestreamQuery
|
|
13
13
|
SENSITIVE: []
|
14
14
|
end
|
15
15
|
|
16
|
+
class AccountSettingsNotificationConfiguration
|
17
|
+
attr_accessor sns_configuration: Types::SnsConfiguration
|
18
|
+
attr_accessor role_arn: ::String
|
19
|
+
SENSITIVE: []
|
20
|
+
end
|
21
|
+
|
16
22
|
class CancelQueryRequest
|
17
23
|
attr_accessor query_id: ::String
|
18
24
|
SENSITIVE: []
|
@@ -73,6 +79,7 @@ module Aws::TimestreamQuery
|
|
73
79
|
class DescribeAccountSettingsResponse
|
74
80
|
attr_accessor max_query_tcu: ::Integer
|
75
81
|
attr_accessor query_pricing_model: ("BYTES_SCANNED" | "COMPUTE_UNITS")
|
82
|
+
attr_accessor query_compute: Types::QueryComputeResponse
|
76
83
|
SENSITIVE: []
|
77
84
|
end
|
78
85
|
|
@@ -144,6 +151,13 @@ module Aws::TimestreamQuery
|
|
144
151
|
SENSITIVE: []
|
145
152
|
end
|
146
153
|
|
154
|
+
class LastUpdate
|
155
|
+
attr_accessor target_query_tcu: ::Integer
|
156
|
+
attr_accessor status: ("PENDING" | "FAILED" | "SUCCEEDED")
|
157
|
+
attr_accessor status_message: ::String
|
158
|
+
SENSITIVE: []
|
159
|
+
end
|
160
|
+
|
147
161
|
class ListScheduledQueriesRequest
|
148
162
|
attr_accessor max_results: ::Integer
|
149
163
|
attr_accessor next_token: ::String
|
@@ -215,6 +229,31 @@ module Aws::TimestreamQuery
|
|
215
229
|
SENSITIVE: [:query_string]
|
216
230
|
end
|
217
231
|
|
232
|
+
class ProvisionedCapacityRequest
|
233
|
+
attr_accessor target_query_tcu: ::Integer
|
234
|
+
attr_accessor notification_configuration: Types::AccountSettingsNotificationConfiguration
|
235
|
+
SENSITIVE: []
|
236
|
+
end
|
237
|
+
|
238
|
+
class ProvisionedCapacityResponse
|
239
|
+
attr_accessor active_query_tcu: ::Integer
|
240
|
+
attr_accessor notification_configuration: Types::AccountSettingsNotificationConfiguration
|
241
|
+
attr_accessor last_update: Types::LastUpdate
|
242
|
+
SENSITIVE: []
|
243
|
+
end
|
244
|
+
|
245
|
+
class QueryComputeRequest
|
246
|
+
attr_accessor compute_mode: ("ON_DEMAND" | "PROVISIONED")
|
247
|
+
attr_accessor provisioned_capacity: Types::ProvisionedCapacityRequest
|
248
|
+
SENSITIVE: []
|
249
|
+
end
|
250
|
+
|
251
|
+
class QueryComputeResponse
|
252
|
+
attr_accessor compute_mode: ("ON_DEMAND" | "PROVISIONED")
|
253
|
+
attr_accessor provisioned_capacity: Types::ProvisionedCapacityResponse
|
254
|
+
SENSITIVE: []
|
255
|
+
end
|
256
|
+
|
218
257
|
class QueryExecutionException
|
219
258
|
attr_accessor message: ::String
|
220
259
|
SENSITIVE: []
|
@@ -464,12 +503,14 @@ module Aws::TimestreamQuery
|
|
464
503
|
class UpdateAccountSettingsRequest
|
465
504
|
attr_accessor max_query_tcu: ::Integer
|
466
505
|
attr_accessor query_pricing_model: ("BYTES_SCANNED" | "COMPUTE_UNITS")
|
506
|
+
attr_accessor query_compute: Types::QueryComputeRequest
|
467
507
|
SENSITIVE: []
|
468
508
|
end
|
469
509
|
|
470
510
|
class UpdateAccountSettingsResponse
|
471
511
|
attr_accessor max_query_tcu: ::Integer
|
472
512
|
attr_accessor query_pricing_model: ("BYTES_SCANNED" | "COMPUTE_UNITS")
|
513
|
+
attr_accessor query_compute: Types::QueryComputeResponse
|
473
514
|
SENSITIVE: []
|
474
515
|
end
|
475
516
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-timestreamquery
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.47.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-11-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|