aws-sdk-timestreamquery 1.45.0 → 1.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamquery/client.rb +126 -7
- data/lib/aws-sdk-timestreamquery/client_api.rb +94 -0
- data/lib/aws-sdk-timestreamquery/types.rb +543 -15
- data/lib/aws-sdk-timestreamquery.rb +1 -1
- data/sig/client.rbs +24 -3
- data/sig/types.rbs +99 -0
- metadata +2 -2
@@ -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
|
@@ -392,12 +430,21 @@ module Aws::TimestreamQuery
|
|
392
430
|
# not need to pass this option.
|
393
431
|
# @return [String]
|
394
432
|
#
|
433
|
+
# @!attribute [rw] query_insights
|
434
|
+
# Encapsulates settings for enabling `QueryInsights`.
|
435
|
+
#
|
436
|
+
# Enabling `QueryInsights` returns insights and metrics as a part of
|
437
|
+
# the Amazon SNS notification for the query that you executed. You can
|
438
|
+
# use `QueryInsights` to tune your query performance and cost.
|
439
|
+
# @return [Types::ScheduledQueryInsights]
|
440
|
+
#
|
395
441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ExecuteScheduledQueryRequest AWS API Documentation
|
396
442
|
#
|
397
443
|
class ExecuteScheduledQueryRequest < Struct.new(
|
398
444
|
:scheduled_query_arn,
|
399
445
|
:invocation_time,
|
400
|
-
:client_token
|
446
|
+
:client_token,
|
447
|
+
:query_insights)
|
401
448
|
SENSITIVE = [:client_token]
|
402
449
|
include Aws::Structure
|
403
450
|
end
|
@@ -444,8 +491,7 @@ module Aws::TimestreamQuery
|
|
444
491
|
include Aws::Structure
|
445
492
|
end
|
446
493
|
|
447
|
-
#
|
448
|
-
# internal server error.
|
494
|
+
# An internal server error occurred while processing the request.
|
449
495
|
#
|
450
496
|
# @!attribute [rw] message
|
451
497
|
# @return [String]
|
@@ -458,7 +504,7 @@ module Aws::TimestreamQuery
|
|
458
504
|
include Aws::Structure
|
459
505
|
end
|
460
506
|
|
461
|
-
# The requested endpoint
|
507
|
+
# The requested endpoint is invalid.
|
462
508
|
#
|
463
509
|
# @!attribute [rw] message
|
464
510
|
# @return [String]
|
@@ -471,6 +517,34 @@ module Aws::TimestreamQuery
|
|
471
517
|
include Aws::Structure
|
472
518
|
end
|
473
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
|
+
|
474
548
|
# @!attribute [rw] max_results
|
475
549
|
# The maximum number of items to return in the output. If the total
|
476
550
|
# number of items available is more than the value specified, a
|
@@ -647,7 +721,9 @@ module Aws::TimestreamQuery
|
|
647
721
|
# updated or when it is deleted.
|
648
722
|
#
|
649
723
|
# @!attribute [rw] sns_configuration
|
650
|
-
# 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.
|
651
727
|
# @return [Types::SnsConfiguration]
|
652
728
|
#
|
653
729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/NotificationConfiguration AWS API Documentation
|
@@ -724,6 +800,104 @@ module Aws::TimestreamQuery
|
|
724
800
|
include Aws::Structure
|
725
801
|
end
|
726
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
|
+
|
727
901
|
# Timestream was unable to run the query successfully.
|
728
902
|
#
|
729
903
|
# @!attribute [rw] message
|
@@ -737,6 +911,130 @@ module Aws::TimestreamQuery
|
|
737
911
|
include Aws::Structure
|
738
912
|
end
|
739
913
|
|
914
|
+
# `QueryInsights` is a performance tuning feature that helps you
|
915
|
+
# optimize your queries, reducing costs and improving performance. With
|
916
|
+
# `QueryInsights`, you can assess the pruning efficiency of your queries
|
917
|
+
# and identify areas for improvement to enhance query performance. With
|
918
|
+
# `QueryInsights`, you can also analyze the effectiveness of your
|
919
|
+
# queries in terms of temporal and spatial pruning, and identify
|
920
|
+
# opportunities to improve performance. Specifically, you can evaluate
|
921
|
+
# how well your queries use time-based and partition key-based indexing
|
922
|
+
# strategies to optimize data retrieval. To optimize query performance,
|
923
|
+
# it's essential that you fine-tune both the temporal and spatial
|
924
|
+
# parameters that govern query execution.
|
925
|
+
#
|
926
|
+
# The key metrics provided by `QueryInsights` are `QuerySpatialCoverage`
|
927
|
+
# and `QueryTemporalRange`. `QuerySpatialCoverage` indicates how much of
|
928
|
+
# the spatial axis the query scans, with lower values being more
|
929
|
+
# efficient. `QueryTemporalRange` shows the time range scanned, with
|
930
|
+
# narrower ranges being more performant.
|
931
|
+
#
|
932
|
+
# **Benefits of QueryInsights**
|
933
|
+
#
|
934
|
+
# The following are the key benefits of using `QueryInsights`:
|
935
|
+
#
|
936
|
+
# * **Identifying inefficient queries** – `QueryInsights` provides
|
937
|
+
# information on the time-based and attribute-based pruning of the
|
938
|
+
# tables accessed by the query. This information helps you identify
|
939
|
+
# the tables that are sub-optimally accessed.
|
940
|
+
#
|
941
|
+
# * **Optimizing your data model and partitioning** – You can use the
|
942
|
+
# `QueryInsights` information to access and fine-tune your data model
|
943
|
+
# and partitioning strategy.
|
944
|
+
#
|
945
|
+
# * **Tuning queries** – `QueryInsights` highlights opportunities to use
|
946
|
+
# indexes more effectively.
|
947
|
+
#
|
948
|
+
# <note markdown="1"> The maximum number of `Query` API requests you're allowed to make
|
949
|
+
# with `QueryInsights` enabled is 1 query per second (QPS). If you
|
950
|
+
# exceed this query rate, it might result in throttling.
|
951
|
+
#
|
952
|
+
# </note>
|
953
|
+
#
|
954
|
+
# @!attribute [rw] mode
|
955
|
+
# Provides the following modes to enable `QueryInsights`:
|
956
|
+
#
|
957
|
+
# * `ENABLED_WITH_RATE_CONTROL` – Enables `QueryInsights` for the
|
958
|
+
# queries being processed. This mode also includes a rate control
|
959
|
+
# mechanism, which limits the `QueryInsights` feature to 1 query per
|
960
|
+
# second (QPS).
|
961
|
+
#
|
962
|
+
# * `DISABLED` – Disables `QueryInsights`.
|
963
|
+
# @return [String]
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryInsights AWS API Documentation
|
966
|
+
#
|
967
|
+
class QueryInsights < Struct.new(
|
968
|
+
:mode)
|
969
|
+
SENSITIVE = []
|
970
|
+
include Aws::Structure
|
971
|
+
end
|
972
|
+
|
973
|
+
# Provides various insights and metrics related to the query that you
|
974
|
+
# executed.
|
975
|
+
#
|
976
|
+
# @!attribute [rw] query_spatial_coverage
|
977
|
+
# Provides insights into the spatial coverage of the query, including
|
978
|
+
# the table with sub-optimal (max) spatial pruning. This information
|
979
|
+
# can help you identify areas for improvement in your partitioning
|
980
|
+
# strategy to enhance spatial pruning.
|
981
|
+
# @return [Types::QuerySpatialCoverage]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] query_temporal_range
|
984
|
+
# Provides insights into the temporal range of the query, including
|
985
|
+
# the table with the largest (max) time range. Following are some of
|
986
|
+
# the potential options for optimizing time-based pruning:
|
987
|
+
#
|
988
|
+
# * Add missing time-predicates.
|
989
|
+
#
|
990
|
+
# * Remove functions around the time predicates.
|
991
|
+
#
|
992
|
+
# * Add time predicates to all the sub-queries.
|
993
|
+
# @return [Types::QueryTemporalRange]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] query_table_count
|
996
|
+
# Indicates the number of tables in the query.
|
997
|
+
# @return [Integer]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] output_rows
|
1000
|
+
# Indicates the total number of rows returned as part of the query
|
1001
|
+
# result set. You can use this data to validate if the number of rows
|
1002
|
+
# in the result set have changed as part of the query tuning exercise.
|
1003
|
+
# @return [Integer]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] output_bytes
|
1006
|
+
# Indicates the size of query result set in bytes. You can use this
|
1007
|
+
# data to validate if the result set has changed as part of the query
|
1008
|
+
# tuning exercise.
|
1009
|
+
# @return [Integer]
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] unload_partition_count
|
1012
|
+
# Indicates the partitions created by the `Unload` operation.
|
1013
|
+
# @return [Integer]
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] unload_written_rows
|
1016
|
+
# Indicates the rows written by the `Unload` query.
|
1017
|
+
# @return [Integer]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] unload_written_bytes
|
1020
|
+
# Indicates the size, in bytes, written by the `Unload` operation.
|
1021
|
+
# @return [Integer]
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryInsightsResponse AWS API Documentation
|
1024
|
+
#
|
1025
|
+
class QueryInsightsResponse < Struct.new(
|
1026
|
+
:query_spatial_coverage,
|
1027
|
+
:query_temporal_range,
|
1028
|
+
:query_table_count,
|
1029
|
+
:output_rows,
|
1030
|
+
:output_bytes,
|
1031
|
+
:unload_partition_count,
|
1032
|
+
:unload_written_rows,
|
1033
|
+
:unload_written_bytes)
|
1034
|
+
SENSITIVE = []
|
1035
|
+
include Aws::Structure
|
1036
|
+
end
|
1037
|
+
|
740
1038
|
# @!attribute [rw] query_string
|
741
1039
|
# The query to be run by Timestream.
|
742
1040
|
# @return [String]
|
@@ -822,13 +1120,22 @@ module Aws::TimestreamQuery
|
|
822
1120
|
# necessary number of rows to meet the 1 MB limit.
|
823
1121
|
# @return [Integer]
|
824
1122
|
#
|
1123
|
+
# @!attribute [rw] query_insights
|
1124
|
+
# Encapsulates settings for enabling `QueryInsights`.
|
1125
|
+
#
|
1126
|
+
# Enabling `QueryInsights` returns insights and metrics in addition to
|
1127
|
+
# query results for the query that you executed. You can use
|
1128
|
+
# `QueryInsights` to tune your query performance.
|
1129
|
+
# @return [Types::QueryInsights]
|
1130
|
+
#
|
825
1131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryRequest AWS API Documentation
|
826
1132
|
#
|
827
1133
|
class QueryRequest < Struct.new(
|
828
1134
|
:query_string,
|
829
1135
|
:client_token,
|
830
1136
|
:next_token,
|
831
|
-
:max_rows
|
1137
|
+
:max_rows,
|
1138
|
+
:query_insights)
|
832
1139
|
SENSITIVE = [:query_string, :client_token]
|
833
1140
|
include Aws::Structure
|
834
1141
|
end
|
@@ -855,6 +1162,11 @@ module Aws::TimestreamQuery
|
|
855
1162
|
# bytes scanned.
|
856
1163
|
# @return [Types::QueryStatus]
|
857
1164
|
#
|
1165
|
+
# @!attribute [rw] query_insights_response
|
1166
|
+
# Encapsulates `QueryInsights` containing insights and metrics related
|
1167
|
+
# to the query that you executed.
|
1168
|
+
# @return [Types::QueryInsightsResponse]
|
1169
|
+
#
|
858
1170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryResponse AWS API Documentation
|
859
1171
|
#
|
860
1172
|
class QueryResponse < Struct.new(
|
@@ -862,7 +1174,78 @@ module Aws::TimestreamQuery
|
|
862
1174
|
:next_token,
|
863
1175
|
:rows,
|
864
1176
|
:column_info,
|
865
|
-
:query_status
|
1177
|
+
:query_status,
|
1178
|
+
:query_insights_response)
|
1179
|
+
SENSITIVE = []
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# Provides insights into the spatial coverage of the query, including
|
1184
|
+
# the table with sub-optimal (max) spatial pruning. This information can
|
1185
|
+
# help you identify areas for improvement in your partitioning strategy
|
1186
|
+
# to enhance spatial pruning
|
1187
|
+
#
|
1188
|
+
# For example, you can do the following with the `QuerySpatialCoverage`
|
1189
|
+
# information:
|
1190
|
+
#
|
1191
|
+
# * Add measure\_name or use [customer-defined partition key][1] (CDPK)
|
1192
|
+
# predicates.
|
1193
|
+
#
|
1194
|
+
# * If you've already done the preceding action, remove functions
|
1195
|
+
# around them or clauses, such as `LIKE`.
|
1196
|
+
#
|
1197
|
+
#
|
1198
|
+
#
|
1199
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] max
|
1202
|
+
# Provides insights into the spatial coverage of the executed query
|
1203
|
+
# and the table with the most inefficient spatial pruning.
|
1204
|
+
#
|
1205
|
+
# * `Value` – The maximum ratio of spatial coverage.
|
1206
|
+
#
|
1207
|
+
# * `TableArn` – The Amazon Resource Name (ARN) of the table with
|
1208
|
+
# sub-optimal spatial pruning.
|
1209
|
+
#
|
1210
|
+
# * `PartitionKey` – The partition key used for partitioning, which
|
1211
|
+
# can be a default `measure_name` or a CDPK.
|
1212
|
+
# @return [Types::QuerySpatialCoverageMax]
|
1213
|
+
#
|
1214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QuerySpatialCoverage AWS API Documentation
|
1215
|
+
#
|
1216
|
+
class QuerySpatialCoverage < Struct.new(
|
1217
|
+
:max)
|
1218
|
+
SENSITIVE = []
|
1219
|
+
include Aws::Structure
|
1220
|
+
end
|
1221
|
+
|
1222
|
+
# Provides insights into the table with the most sub-optimal spatial
|
1223
|
+
# range scanned by your query.
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] value
|
1226
|
+
# The maximum ratio of spatial coverage.
|
1227
|
+
# @return [Float]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] table_arn
|
1230
|
+
# The Amazon Resource Name (ARN) of the table with the most
|
1231
|
+
# sub-optimal spatial pruning.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] partition_key
|
1235
|
+
# The partition key used for partitioning, which can be a default
|
1236
|
+
# `measure_name` or a [customer defined partition key][1].
|
1237
|
+
#
|
1238
|
+
#
|
1239
|
+
#
|
1240
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html
|
1241
|
+
# @return [Array<String>]
|
1242
|
+
#
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QuerySpatialCoverageMax AWS API Documentation
|
1244
|
+
#
|
1245
|
+
class QuerySpatialCoverageMax < Struct.new(
|
1246
|
+
:value,
|
1247
|
+
:table_arn,
|
1248
|
+
:partition_key)
|
866
1249
|
SENSITIVE = []
|
867
1250
|
include Aws::Structure
|
868
1251
|
end
|
@@ -898,6 +1281,50 @@ module Aws::TimestreamQuery
|
|
898
1281
|
include Aws::Structure
|
899
1282
|
end
|
900
1283
|
|
1284
|
+
# Provides insights into the temporal range of the query, including the
|
1285
|
+
# table with the largest (max) time range.
|
1286
|
+
#
|
1287
|
+
# @!attribute [rw] max
|
1288
|
+
# Encapsulates the following properties that provide insights into the
|
1289
|
+
# most sub-optimal performing table on the temporal axis:
|
1290
|
+
#
|
1291
|
+
# * `Value` – The maximum duration in nanoseconds between the start
|
1292
|
+
# and end of the query.
|
1293
|
+
#
|
1294
|
+
# * `TableArn` – The Amazon Resource Name (ARN) of the table which is
|
1295
|
+
# queried with the largest time range.
|
1296
|
+
# @return [Types::QueryTemporalRangeMax]
|
1297
|
+
#
|
1298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryTemporalRange AWS API Documentation
|
1299
|
+
#
|
1300
|
+
class QueryTemporalRange < Struct.new(
|
1301
|
+
:max)
|
1302
|
+
SENSITIVE = []
|
1303
|
+
include Aws::Structure
|
1304
|
+
end
|
1305
|
+
|
1306
|
+
# Provides insights into the table with the most sub-optimal temporal
|
1307
|
+
# pruning scanned by your query.
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] value
|
1310
|
+
# The maximum duration in nanoseconds between the start and end of the
|
1311
|
+
# query.
|
1312
|
+
# @return [Integer]
|
1313
|
+
#
|
1314
|
+
# @!attribute [rw] table_arn
|
1315
|
+
# The Amazon Resource Name (ARN) of the table which is queried with
|
1316
|
+
# the largest time range.
|
1317
|
+
# @return [String]
|
1318
|
+
#
|
1319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryTemporalRangeMax AWS API Documentation
|
1320
|
+
#
|
1321
|
+
class QueryTemporalRangeMax < Struct.new(
|
1322
|
+
:value,
|
1323
|
+
:table_arn)
|
1324
|
+
SENSITIVE = []
|
1325
|
+
include Aws::Structure
|
1326
|
+
end
|
1327
|
+
|
901
1328
|
# The requested resource could not be found.
|
902
1329
|
#
|
903
1330
|
# @!attribute [rw] message
|
@@ -1131,6 +1558,78 @@ module Aws::TimestreamQuery
|
|
1131
1558
|
include Aws::Structure
|
1132
1559
|
end
|
1133
1560
|
|
1561
|
+
# Encapsulates settings for enabling `QueryInsights` on an
|
1562
|
+
# `ExecuteScheduledQueryRequest`.
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] mode
|
1565
|
+
# Provides the following modes to enable `ScheduledQueryInsights`:
|
1566
|
+
#
|
1567
|
+
# * `ENABLED_WITH_RATE_CONTROL` – Enables `ScheduledQueryInsights` for
|
1568
|
+
# the queries being processed. This mode also includes a rate
|
1569
|
+
# control mechanism, which limits the `QueryInsights` feature to 1
|
1570
|
+
# query per second (QPS).
|
1571
|
+
#
|
1572
|
+
# * `DISABLED` – Disables `ScheduledQueryInsights`.
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQueryInsights AWS API Documentation
|
1576
|
+
#
|
1577
|
+
class ScheduledQueryInsights < Struct.new(
|
1578
|
+
:mode)
|
1579
|
+
SENSITIVE = []
|
1580
|
+
include Aws::Structure
|
1581
|
+
end
|
1582
|
+
|
1583
|
+
# Provides various insights and metrics related to the
|
1584
|
+
# `ExecuteScheduledQueryRequest` that was executed.
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] query_spatial_coverage
|
1587
|
+
# Provides insights into the spatial coverage of the query, including
|
1588
|
+
# the table with sub-optimal (max) spatial pruning. This information
|
1589
|
+
# can help you identify areas for improvement in your partitioning
|
1590
|
+
# strategy to enhance spatial pruning.
|
1591
|
+
# @return [Types::QuerySpatialCoverage]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] query_temporal_range
|
1594
|
+
# Provides insights into the temporal range of the query, including
|
1595
|
+
# the table with the largest (max) time range. Following are some of
|
1596
|
+
# the potential options for optimizing time-based pruning:
|
1597
|
+
#
|
1598
|
+
# * Add missing time-predicates.
|
1599
|
+
#
|
1600
|
+
# * Remove functions around the time predicates.
|
1601
|
+
#
|
1602
|
+
# * Add time predicates to all the sub-queries.
|
1603
|
+
# @return [Types::QueryTemporalRange]
|
1604
|
+
#
|
1605
|
+
# @!attribute [rw] query_table_count
|
1606
|
+
# Indicates the number of tables in the query.
|
1607
|
+
# @return [Integer]
|
1608
|
+
#
|
1609
|
+
# @!attribute [rw] output_rows
|
1610
|
+
# Indicates the total number of rows returned as part of the query
|
1611
|
+
# result set. You can use this data to validate if the number of rows
|
1612
|
+
# in the result set have changed as part of the query tuning exercise.
|
1613
|
+
# @return [Integer]
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] output_bytes
|
1616
|
+
# Indicates the size of query result set in bytes. You can use this
|
1617
|
+
# data to validate if the result set has changed as part of the query
|
1618
|
+
# tuning exercise.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQueryInsightsResponse AWS API Documentation
|
1622
|
+
#
|
1623
|
+
class ScheduledQueryInsightsResponse < Struct.new(
|
1624
|
+
:query_spatial_coverage,
|
1625
|
+
:query_temporal_range,
|
1626
|
+
:query_table_count,
|
1627
|
+
:output_rows,
|
1628
|
+
:output_bytes)
|
1629
|
+
SENSITIVE = []
|
1630
|
+
include Aws::Structure
|
1631
|
+
end
|
1632
|
+
|
1134
1633
|
# Run summary for the scheduled query
|
1135
1634
|
#
|
1136
1635
|
# @!attribute [rw] invocation_time
|
@@ -1151,6 +1650,11 @@ module Aws::TimestreamQuery
|
|
1151
1650
|
# Runtime statistics for a scheduled run.
|
1152
1651
|
# @return [Types::ExecutionStats]
|
1153
1652
|
#
|
1653
|
+
# @!attribute [rw] query_insights_response
|
1654
|
+
# Provides various insights and metrics related to the run summary of
|
1655
|
+
# the scheduled query.
|
1656
|
+
# @return [Types::ScheduledQueryInsightsResponse]
|
1657
|
+
#
|
1154
1658
|
# @!attribute [rw] error_report_location
|
1155
1659
|
# S3 location for error report.
|
1156
1660
|
# @return [Types::ErrorReportLocation]
|
@@ -1167,6 +1671,7 @@ module Aws::TimestreamQuery
|
|
1167
1671
|
:trigger_time,
|
1168
1672
|
:run_status,
|
1169
1673
|
:execution_stats,
|
1674
|
+
:query_insights_response,
|
1170
1675
|
:error_report_location,
|
1171
1676
|
:failure_reason)
|
1172
1677
|
SENSITIVE = []
|
@@ -1313,7 +1818,7 @@ module Aws::TimestreamQuery
|
|
1313
1818
|
include Aws::Structure
|
1314
1819
|
end
|
1315
1820
|
|
1316
|
-
# The request was
|
1821
|
+
# The request was throttled due to excessive requests.
|
1317
1822
|
#
|
1318
1823
|
# @!attribute [rw] message
|
1319
1824
|
# @return [String]
|
@@ -1485,11 +1990,16 @@ module Aws::TimestreamQuery
|
|
1485
1990
|
# The maximum number of compute units the service will use at any
|
1486
1991
|
# point in time to serve your queries. To run queries, you must set a
|
1487
1992
|
# minimum capacity of 4 TCU. You can set the maximum number of TCU in
|
1488
|
-
# 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).
|
1489
1999
|
#
|
1490
2000
|
# The maximum value supported for `MaxQueryTCU` is 1000. To request an
|
1491
2001
|
# increase to this soft limit, contact Amazon Web Services Support.
|
1492
|
-
# For information about the default quota for maxQueryTCU
|
2002
|
+
# For information about the default quota for `maxQueryTCU`, see
|
1493
2003
|
# [Default quotas][1].
|
1494
2004
|
#
|
1495
2005
|
#
|
@@ -1507,11 +2017,23 @@ module Aws::TimestreamQuery
|
|
1507
2017
|
# </note>
|
1508
2018
|
# @return [String]
|
1509
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
|
+
#
|
1510
2031
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UpdateAccountSettingsRequest AWS API Documentation
|
1511
2032
|
#
|
1512
2033
|
class UpdateAccountSettingsRequest < Struct.new(
|
1513
2034
|
:max_query_tcu,
|
1514
|
-
:query_pricing_model
|
2035
|
+
:query_pricing_model,
|
2036
|
+
:query_compute)
|
1515
2037
|
SENSITIVE = []
|
1516
2038
|
include Aws::Structure
|
1517
2039
|
end
|
@@ -1525,11 +2047,17 @@ module Aws::TimestreamQuery
|
|
1525
2047
|
# The pricing model for an account.
|
1526
2048
|
# @return [String]
|
1527
2049
|
#
|
2050
|
+
# @!attribute [rw] query_compute
|
2051
|
+
# Confirms the updated account settings for querying data in your
|
2052
|
+
# account.
|
2053
|
+
# @return [Types::QueryComputeResponse]
|
2054
|
+
#
|
1528
2055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UpdateAccountSettingsResponse AWS API Documentation
|
1529
2056
|
#
|
1530
2057
|
class UpdateAccountSettingsResponse < Struct.new(
|
1531
2058
|
:max_query_tcu,
|
1532
|
-
:query_pricing_model
|
2059
|
+
:query_pricing_model,
|
2060
|
+
:query_compute)
|
1533
2061
|
SENSITIVE = []
|
1534
2062
|
include Aws::Structure
|
1535
2063
|
end
|