aws-sdk-timestreamquery 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39c918c88743d7a60ecb65c177f04f1695348dd02a391895b34cf26c88dea97
-  data.tar.gz: fae881f8ca767b245fcef19494598c9a730632071579a0f7464cc2584dd0ec34
+  metadata.gz: fb59ed80152c28419c4294a46f6c5f19d5e42f0bdb5b3ca722ed8e28a2c5ad6b
+  data.tar.gz: c1e00cdb5ffe446e2010b6347ed03e975ac7c77f69f79733d6f1958037b12455
 SHA512:
-  metadata.gz: 531ff9cfd18b0f42b7e7b84f4d0e1b1892c077255a4465a920e2fc6594996f3fb75bc13cdd343b797075399f8f0477b65812130cb1e79f7898de18e72931f6df
-  data.tar.gz: daa2de32ef02725c20b53334779ef4dbe3d03b35a6d5361a308b9a709db47823014e0aeb3f0c1f8269a0f60a9a775550026a9279d8d8147e6c06ff1d2666283a
+  metadata.gz: 95159c2b95fbaecd30729f8a74c3d310a4ac4f677854c4e4c4eddc71f8d6ee5d94a7679d7996dff83578f3670cd57088f85e09cccfae166f0c354118219f8c16
+  data.tar.gz: 2930945cfcdd863fc7780eda3e463f1640161d581ce5d680f9f74ff20eca0817f231e1f747de875f5c9a7072a263ea86c885c5d156476dc568ec25ac45167f01

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.46.0 (2024-10-22)
+------------------
+
+* Feature - This release adds support for Query Insights, a feature that provides details of query execution, enabling users to identify areas for improvement to optimize their queries, resulting in improved query performance and lower query costs.
+
 1.45.0 (2024-10-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.45.0
+1.46.0

data/lib/aws-sdk-timestreamquery/client.rb

@@ -801,6 +801,15 @@ module Aws::TimestreamQuery
     #   resp.scheduled_query.last_run_summary.execution_stats.cumulative_bytes_scanned #=> Integer
     #   resp.scheduled_query.last_run_summary.execution_stats.records_ingested #=> Integer
     #   resp.scheduled_query.last_run_summary.execution_stats.query_result_rows #=> Integer
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_spatial_coverage.max.value #=> Float
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_spatial_coverage.max.table_arn #=> String
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_spatial_coverage.max.partition_key #=> Array
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_spatial_coverage.max.partition_key[0] #=> String
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_temporal_range.max.value #=> Integer
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_temporal_range.max.table_arn #=> String
+    #   resp.scheduled_query.last_run_summary.query_insights_response.query_table_count #=> Integer
+    #   resp.scheduled_query.last_run_summary.query_insights_response.output_rows #=> Integer
+    #   resp.scheduled_query.last_run_summary.query_insights_response.output_bytes #=> Integer
     #   resp.scheduled_query.last_run_summary.error_report_location.s3_report_location.bucket_name #=> String
     #   resp.scheduled_query.last_run_summary.error_report_location.s3_report_location.object_key #=> String
     #   resp.scheduled_query.last_run_summary.failure_reason #=> String
@@ -814,6 +823,15 @@ module Aws::TimestreamQuery
     #   resp.scheduled_query.recently_failed_runs[0].execution_stats.cumulative_bytes_scanned #=> Integer
     #   resp.scheduled_query.recently_failed_runs[0].execution_stats.records_ingested #=> Integer
     #   resp.scheduled_query.recently_failed_runs[0].execution_stats.query_result_rows #=> Integer
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_spatial_coverage.max.value #=> Float
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_spatial_coverage.max.table_arn #=> String
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_spatial_coverage.max.partition_key #=> Array
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_spatial_coverage.max.partition_key[0] #=> String
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_temporal_range.max.value #=> Integer
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_temporal_range.max.table_arn #=> String
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.query_table_count #=> Integer
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.output_rows #=> Integer
+    #   resp.scheduled_query.recently_failed_runs[0].query_insights_response.output_bytes #=> Integer
     #   resp.scheduled_query.recently_failed_runs[0].error_report_location.s3_report_location.bucket_name #=> String
     #   resp.scheduled_query.recently_failed_runs[0].error_report_location.s3_report_location.object_key #=> String
     #   resp.scheduled_query.recently_failed_runs[0].failure_reason #=> String
@@ -829,6 +847,11 @@ module Aws::TimestreamQuery
 
     # 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.
+    #
     # @option params [required, String] :scheduled_query_arn
     #   ARN of the scheduled query.
     #
@@ -842,6 +865,13 @@ module Aws::TimestreamQuery
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
     #
+    # @option params [Types::ScheduledQueryInsights] :query_insights
+    #   Encapsulates settings for enabling `QueryInsights`.
+    #
+    #   Enabling `QueryInsights` returns insights and metrics as a part of the
+    #   Amazon SNS notification for the query that you executed. You can use
+    #   `QueryInsights` to tune your query performance and cost.
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -850,6 +880,9 @@ module Aws::TimestreamQuery
     #     scheduled_query_arn: "AmazonResourceName", # required
     #     invocation_time: Time.now, # required
     #     client_token: "ClientToken",
+    #     query_insights: {
+    #       mode: "ENABLED_WITH_RATE_CONTROL", # required, accepts ENABLED_WITH_RATE_CONTROL, DISABLED
+    #     },
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ExecuteScheduledQuery AWS API Documentation
@@ -1021,9 +1054,21 @@ module Aws::TimestreamQuery
     end
 
     # `Query` is a synchronous operation that enables you to run a query
-    # against your Amazon Timestream data. `Query` will time out after 60
-    # seconds. You must update the default timeout in the SDK to support a
-    # timeout of 60 seconds. See the [code sample][1] for details.
+    # 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.
+    #
+    # <note markdown="1"> 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.
+    #
+    #  </note>
+    #
+    # `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][1] for details.
     #
     # Your query request will fail in the following cases:
     #
@@ -1129,6 +1174,13 @@ module Aws::TimestreamQuery
     #   limit. If `MaxRows` is not provided, Timestream will send the
     #   necessary number of rows to meet the 1 MB limit.
     #
+    # @option params [Types::QueryInsights] :query_insights
+    #   Encapsulates settings for enabling `QueryInsights`.
+    #
+    #   Enabling `QueryInsights` returns insights and metrics in addition to
+    #   query results for the query that you executed. You can use
+    #   `QueryInsights` to tune your query performance.
+    #
     # @return [Types::QueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::QueryResponse#query_id #query_id} => String
@@ -1136,6 +1188,7 @@ module Aws::TimestreamQuery
     #   * {Types::QueryResponse#rows #rows} => Array&lt;Types::Row&gt;
     #   * {Types::QueryResponse#column_info #column_info} => Array&lt;Types::ColumnInfo&gt;
     #   * {Types::QueryResponse#query_status #query_status} => Types::QueryStatus
+    #   * {Types::QueryResponse#query_insights_response #query_insights_response} => Types::QueryInsightsResponse
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
@@ -1146,6 +1199,9 @@ module Aws::TimestreamQuery
     #     client_token: "ClientRequestToken",
     #     next_token: "PaginationToken",
     #     max_rows: 1,
+    #     query_insights: {
+    #       mode: "ENABLED_WITH_RATE_CONTROL", # required, accepts ENABLED_WITH_RATE_CONTROL, DISABLED
+    #     },
     #   })
     #
     # @example Response structure
@@ -1170,6 +1226,18 @@ module Aws::TimestreamQuery
     #   resp.query_status.progress_percentage #=> Float
     #   resp.query_status.cumulative_bytes_scanned #=> Integer
     #   resp.query_status.cumulative_bytes_metered #=> Integer
+    #   resp.query_insights_response.query_spatial_coverage.max.value #=> Float
+    #   resp.query_insights_response.query_spatial_coverage.max.table_arn #=> String
+    #   resp.query_insights_response.query_spatial_coverage.max.partition_key #=> Array
+    #   resp.query_insights_response.query_spatial_coverage.max.partition_key[0] #=> String
+    #   resp.query_insights_response.query_temporal_range.max.value #=> Integer
+    #   resp.query_insights_response.query_temporal_range.max.table_arn #=> String
+    #   resp.query_insights_response.query_table_count #=> Integer
+    #   resp.query_insights_response.output_rows #=> Integer
+    #   resp.query_insights_response.output_bytes #=> Integer
+    #   resp.query_insights_response.unload_partition_count #=> Integer
+    #   resp.query_insights_response.unload_written_rows #=> Integer
+    #   resp.query_insights_response.unload_written_bytes #=> Integer
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/Query AWS API Documentation
     #
@@ -1346,7 +1414,7 @@ module Aws::TimestreamQuery
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-timestreamquery'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-timestreamquery/client_api.rb

@@ -69,15 +69,24 @@ module Aws::TimestreamQuery
     PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
     ParameterMapping = Shapes::StructureShape.new(name: 'ParameterMapping')
     ParameterMappingList = Shapes::ListShape.new(name: 'ParameterMappingList')
+    PartitionKey = Shapes::StringShape.new(name: 'PartitionKey')
+    PartitionKeyList = Shapes::ListShape.new(name: 'PartitionKeyList')
     PrepareQueryRequest = Shapes::StructureShape.new(name: 'PrepareQueryRequest')
     PrepareQueryResponse = Shapes::StructureShape.new(name: 'PrepareQueryResponse')
     QueryExecutionException = Shapes::StructureShape.new(name: 'QueryExecutionException')
     QueryId = Shapes::StringShape.new(name: 'QueryId')
+    QueryInsights = Shapes::StructureShape.new(name: 'QueryInsights')
+    QueryInsightsMode = Shapes::StringShape.new(name: 'QueryInsightsMode')
+    QueryInsightsResponse = Shapes::StructureShape.new(name: 'QueryInsightsResponse')
     QueryPricingModel = Shapes::StringShape.new(name: 'QueryPricingModel')
     QueryRequest = Shapes::StructureShape.new(name: 'QueryRequest')
     QueryResponse = Shapes::StructureShape.new(name: 'QueryResponse')
+    QuerySpatialCoverage = Shapes::StructureShape.new(name: 'QuerySpatialCoverage')
+    QuerySpatialCoverageMax = Shapes::StructureShape.new(name: 'QuerySpatialCoverageMax')
     QueryStatus = Shapes::StructureShape.new(name: 'QueryStatus')
     QueryString = Shapes::StringShape.new(name: 'QueryString')
+    QueryTemporalRange = Shapes::StructureShape.new(name: 'QueryTemporalRange')
+    QueryTemporalRangeMax = Shapes::StructureShape.new(name: 'QueryTemporalRangeMax')
     ResourceName = Shapes::StringShape.new(name: 'ResourceName')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Row = Shapes::StructureShape.new(name: 'Row')
@@ -95,6 +104,9 @@ module Aws::TimestreamQuery
     ScheduleExpression = Shapes::StringShape.new(name: 'ScheduleExpression')
     ScheduledQuery = Shapes::StructureShape.new(name: 'ScheduledQuery')
     ScheduledQueryDescription = Shapes::StructureShape.new(name: 'ScheduledQueryDescription')
+    ScheduledQueryInsights = Shapes::StructureShape.new(name: 'ScheduledQueryInsights')
+    ScheduledQueryInsightsMode = Shapes::StringShape.new(name: 'ScheduledQueryInsightsMode')
+    ScheduledQueryInsightsResponse = Shapes::StructureShape.new(name: 'ScheduledQueryInsightsResponse')
     ScheduledQueryList = Shapes::ListShape.new(name: 'ScheduledQueryList')
     ScheduledQueryName = Shapes::StringShape.new(name: 'ScheduledQueryName')
     ScheduledQueryRunStatus = Shapes::StringShape.new(name: 'ScheduledQueryRunStatus')
@@ -216,6 +228,7 @@ module Aws::TimestreamQuery
     ExecuteScheduledQueryRequest.add_member(:scheduled_query_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "ScheduledQueryArn"))
     ExecuteScheduledQueryRequest.add_member(:invocation_time, Shapes::ShapeRef.new(shape: Time, required: true, location_name: "InvocationTime"))
     ExecuteScheduledQueryRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
+    ExecuteScheduledQueryRequest.add_member(:query_insights, Shapes::ShapeRef.new(shape: ScheduledQueryInsights, location_name: "QueryInsights"))
     ExecuteScheduledQueryRequest.struct_class = Types::ExecuteScheduledQueryRequest
 
     ExecutionStats.add_member(:execution_time_in_millis, Shapes::ShapeRef.new(shape: Long, location_name: "ExecutionTimeInMillis"))
@@ -278,6 +291,8 @@ module Aws::TimestreamQuery
 
     ParameterMappingList.member = Shapes::ShapeRef.new(shape: ParameterMapping)
 
+    PartitionKeyList.member = Shapes::ShapeRef.new(shape: PartitionKey)
+
     PrepareQueryRequest.add_member(:query_string, Shapes::ShapeRef.new(shape: QueryString, required: true, location_name: "QueryString"))
     PrepareQueryRequest.add_member(:validate_only, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ValidateOnly"))
     PrepareQueryRequest.struct_class = Types::PrepareQueryRequest
@@ -290,10 +305,24 @@ module Aws::TimestreamQuery
     QueryExecutionException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     QueryExecutionException.struct_class = Types::QueryExecutionException
 
+    QueryInsights.add_member(:mode, Shapes::ShapeRef.new(shape: QueryInsightsMode, required: true, location_name: "Mode"))
+    QueryInsights.struct_class = Types::QueryInsights
+
+    QueryInsightsResponse.add_member(:query_spatial_coverage, Shapes::ShapeRef.new(shape: QuerySpatialCoverage, location_name: "QuerySpatialCoverage"))
+    QueryInsightsResponse.add_member(:query_temporal_range, Shapes::ShapeRef.new(shape: QueryTemporalRange, location_name: "QueryTemporalRange"))
+    QueryInsightsResponse.add_member(:query_table_count, Shapes::ShapeRef.new(shape: Long, location_name: "QueryTableCount", metadata: {"box"=>true}))
+    QueryInsightsResponse.add_member(:output_rows, Shapes::ShapeRef.new(shape: Long, location_name: "OutputRows", metadata: {"box"=>true}))
+    QueryInsightsResponse.add_member(:output_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "OutputBytes", metadata: {"box"=>true}))
+    QueryInsightsResponse.add_member(:unload_partition_count, Shapes::ShapeRef.new(shape: Long, location_name: "UnloadPartitionCount", metadata: {"box"=>true}))
+    QueryInsightsResponse.add_member(:unload_written_rows, Shapes::ShapeRef.new(shape: Long, location_name: "UnloadWrittenRows", metadata: {"box"=>true}))
+    QueryInsightsResponse.add_member(:unload_written_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "UnloadWrittenBytes", metadata: {"box"=>true}))
+    QueryInsightsResponse.struct_class = Types::QueryInsightsResponse
+
     QueryRequest.add_member(:query_string, Shapes::ShapeRef.new(shape: QueryString, required: true, location_name: "QueryString"))
     QueryRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
     QueryRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
     QueryRequest.add_member(:max_rows, Shapes::ShapeRef.new(shape: MaxQueryResults, location_name: "MaxRows"))
+    QueryRequest.add_member(:query_insights, Shapes::ShapeRef.new(shape: QueryInsights, location_name: "QueryInsights"))
     QueryRequest.struct_class = Types::QueryRequest
 
     QueryResponse.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, required: true, location_name: "QueryId"))
@@ -301,13 +330,29 @@ module Aws::TimestreamQuery
     QueryResponse.add_member(:rows, Shapes::ShapeRef.new(shape: RowList, required: true, location_name: "Rows"))
     QueryResponse.add_member(:column_info, Shapes::ShapeRef.new(shape: ColumnInfoList, required: true, location_name: "ColumnInfo"))
     QueryResponse.add_member(:query_status, Shapes::ShapeRef.new(shape: QueryStatus, location_name: "QueryStatus"))
+    QueryResponse.add_member(:query_insights_response, Shapes::ShapeRef.new(shape: QueryInsightsResponse, location_name: "QueryInsightsResponse"))
     QueryResponse.struct_class = Types::QueryResponse
 
+    QuerySpatialCoverage.add_member(:max, Shapes::ShapeRef.new(shape: QuerySpatialCoverageMax, location_name: "Max"))
+    QuerySpatialCoverage.struct_class = Types::QuerySpatialCoverage
+
+    QuerySpatialCoverageMax.add_member(:value, Shapes::ShapeRef.new(shape: Double, location_name: "Value"))
+    QuerySpatialCoverageMax.add_member(:table_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, location_name: "TableArn"))
+    QuerySpatialCoverageMax.add_member(:partition_key, Shapes::ShapeRef.new(shape: PartitionKeyList, location_name: "PartitionKey"))
+    QuerySpatialCoverageMax.struct_class = Types::QuerySpatialCoverageMax
+
     QueryStatus.add_member(:progress_percentage, Shapes::ShapeRef.new(shape: Double, location_name: "ProgressPercentage"))
     QueryStatus.add_member(:cumulative_bytes_scanned, Shapes::ShapeRef.new(shape: Long, location_name: "CumulativeBytesScanned"))
     QueryStatus.add_member(:cumulative_bytes_metered, Shapes::ShapeRef.new(shape: Long, location_name: "CumulativeBytesMetered"))
     QueryStatus.struct_class = Types::QueryStatus
 
+    QueryTemporalRange.add_member(:max, Shapes::ShapeRef.new(shape: QueryTemporalRangeMax, location_name: "Max"))
+    QueryTemporalRange.struct_class = Types::QueryTemporalRange
+
+    QueryTemporalRangeMax.add_member(:value, Shapes::ShapeRef.new(shape: Long, location_name: "Value"))
+    QueryTemporalRangeMax.add_member(:table_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, location_name: "TableArn"))
+    QueryTemporalRangeMax.struct_class = Types::QueryTemporalRangeMax
+
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ResourceNotFoundException.add_member(:scheduled_query_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, location_name: "ScheduledQueryArn"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
@@ -357,12 +402,23 @@ module Aws::TimestreamQuery
     ScheduledQueryDescription.add_member(:recently_failed_runs, Shapes::ShapeRef.new(shape: ScheduledQueryRunSummaryList, location_name: "RecentlyFailedRuns"))
     ScheduledQueryDescription.struct_class = Types::ScheduledQueryDescription
 
+    ScheduledQueryInsights.add_member(:mode, Shapes::ShapeRef.new(shape: ScheduledQueryInsightsMode, required: true, location_name: "Mode"))
+    ScheduledQueryInsights.struct_class = Types::ScheduledQueryInsights
+
+    ScheduledQueryInsightsResponse.add_member(:query_spatial_coverage, Shapes::ShapeRef.new(shape: QuerySpatialCoverage, location_name: "QuerySpatialCoverage"))
+    ScheduledQueryInsightsResponse.add_member(:query_temporal_range, Shapes::ShapeRef.new(shape: QueryTemporalRange, location_name: "QueryTemporalRange"))
+    ScheduledQueryInsightsResponse.add_member(:query_table_count, Shapes::ShapeRef.new(shape: Long, location_name: "QueryTableCount", metadata: {"box"=>true}))
+    ScheduledQueryInsightsResponse.add_member(:output_rows, Shapes::ShapeRef.new(shape: Long, location_name: "OutputRows", metadata: {"box"=>true}))
+    ScheduledQueryInsightsResponse.add_member(:output_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "OutputBytes", metadata: {"box"=>true}))
+    ScheduledQueryInsightsResponse.struct_class = Types::ScheduledQueryInsightsResponse
+
     ScheduledQueryList.member = Shapes::ShapeRef.new(shape: ScheduledQuery)
 
     ScheduledQueryRunSummary.add_member(:invocation_time, Shapes::ShapeRef.new(shape: Time, location_name: "InvocationTime"))
     ScheduledQueryRunSummary.add_member(:trigger_time, Shapes::ShapeRef.new(shape: Time, location_name: "TriggerTime"))
     ScheduledQueryRunSummary.add_member(:run_status, Shapes::ShapeRef.new(shape: ScheduledQueryRunStatus, location_name: "RunStatus"))
     ScheduledQueryRunSummary.add_member(:execution_stats, Shapes::ShapeRef.new(shape: ExecutionStats, location_name: "ExecutionStats"))
+    ScheduledQueryRunSummary.add_member(:query_insights_response, Shapes::ShapeRef.new(shape: ScheduledQueryInsightsResponse, location_name: "QueryInsightsResponse"))
     ScheduledQueryRunSummary.add_member(:error_report_location, Shapes::ShapeRef.new(shape: ErrorReportLocation, location_name: "ErrorReportLocation"))
     ScheduledQueryRunSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "FailureReason"))
     ScheduledQueryRunSummary.struct_class = Types::ScheduledQueryRunSummary

data/lib/aws-sdk-timestreamquery/types.rb

@@ -392,12 +392,21 @@ module Aws::TimestreamQuery
     #   not need to pass this option.
     #   @return [String]
     #
+    # @!attribute [rw] query_insights
+    #   Encapsulates settings for enabling `QueryInsights`.
+    #
+    #   Enabling `QueryInsights` returns insights and metrics as a part of
+    #   the Amazon SNS notification for the query that you executed. You can
+    #   use `QueryInsights` to tune your query performance and cost.
+    #   @return [Types::ScheduledQueryInsights]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ExecuteScheduledQueryRequest AWS API Documentation
     #
     class ExecuteScheduledQueryRequest < Struct.new(
       :scheduled_query_arn,
       :invocation_time,
-      :client_token)
+      :client_token,
+      :query_insights)
       SENSITIVE = [:client_token]
       include Aws::Structure
     end
@@ -737,6 +746,130 @@ module Aws::TimestreamQuery
       include Aws::Structure
     end
 
+    # `QueryInsights` is a performance tuning feature that helps you
+    # optimize your queries, reducing costs and improving performance. With
+    # `QueryInsights`, you can assess the pruning efficiency of your queries
+    # and identify areas for improvement to enhance query performance. With
+    # `QueryInsights`, you can also analyze the effectiveness of your
+    # queries in terms of temporal and spatial pruning, and identify
+    # opportunities to improve performance. Specifically, you can evaluate
+    # how well your queries use time-based and partition key-based indexing
+    # strategies to optimize data retrieval. To optimize query performance,
+    # it's essential that you fine-tune both the temporal and spatial
+    # parameters that govern query execution.
+    #
+    # The key metrics provided by `QueryInsights` are `QuerySpatialCoverage`
+    # and `QueryTemporalRange`. `QuerySpatialCoverage` indicates how much of
+    # the spatial axis the query scans, with lower values being more
+    # efficient. `QueryTemporalRange` shows the time range scanned, with
+    # narrower ranges being more performant.
+    #
+    # **Benefits of QueryInsights**
+    #
+    # The following are the key benefits of using `QueryInsights`:
+    #
+    # * **Identifying inefficient queries** – `QueryInsights` provides
+    #   information on the time-based and attribute-based pruning of the
+    #   tables accessed by the query. This information helps you identify
+    #   the tables that are sub-optimally accessed.
+    #
+    # * **Optimizing your data model and partitioning** – You can use the
+    #   `QueryInsights` information to access and fine-tune your data model
+    #   and partitioning strategy.
+    #
+    # * **Tuning queries** – `QueryInsights` highlights opportunities to use
+    #   indexes more effectively.
+    #
+    # <note markdown="1"> 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.
+    #
+    #  </note>
+    #
+    # @!attribute [rw] mode
+    #   Provides the following modes to enable `QueryInsights`:
+    #
+    #   * `ENABLED_WITH_RATE_CONTROL` – Enables `QueryInsights` for the
+    #     queries being processed. This mode also includes a rate control
+    #     mechanism, which limits the `QueryInsights` feature to 1 query per
+    #     second (QPS).
+    #
+    #   * `DISABLED` – Disables `QueryInsights`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryInsights AWS API Documentation
+    #
+    class QueryInsights < Struct.new(
+      :mode)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides various insights and metrics related to the query that you
+    # executed.
+    #
+    # @!attribute [rw] query_spatial_coverage
+    #   Provides insights into the spatial coverage of the query, including
+    #   the table with sub-optimal (max) spatial pruning. This information
+    #   can help you identify areas for improvement in your partitioning
+    #   strategy to enhance spatial pruning.
+    #   @return [Types::QuerySpatialCoverage]
+    #
+    # @!attribute [rw] query_temporal_range
+    #   Provides insights into the temporal range of the query, including
+    #   the table with the largest (max) time range. Following are some of
+    #   the potential options for optimizing time-based pruning:
+    #
+    #   * Add missing time-predicates.
+    #
+    #   * Remove functions around the time predicates.
+    #
+    #   * Add time predicates to all the sub-queries.
+    #   @return [Types::QueryTemporalRange]
+    #
+    # @!attribute [rw] query_table_count
+    #   Indicates the number of tables in the query.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] output_rows
+    #   Indicates the total number of rows returned as part of the query
+    #   result set. You can use this data to validate if the number of rows
+    #   in the result set have changed as part of the query tuning exercise.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] output_bytes
+    #   Indicates the size of query result set in bytes. You can use this
+    #   data to validate if the result set has changed as part of the query
+    #   tuning exercise.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] unload_partition_count
+    #   Indicates the partitions created by the `Unload` operation.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] unload_written_rows
+    #   Indicates the rows written by the `Unload` query.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] unload_written_bytes
+    #   Indicates the size, in bytes, written by the `Unload` operation.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryInsightsResponse AWS API Documentation
+    #
+    class QueryInsightsResponse < Struct.new(
+      :query_spatial_coverage,
+      :query_temporal_range,
+      :query_table_count,
+      :output_rows,
+      :output_bytes,
+      :unload_partition_count,
+      :unload_written_rows,
+      :unload_written_bytes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] query_string
     #   The query to be run by Timestream.
     #   @return [String]
@@ -822,13 +955,22 @@ module Aws::TimestreamQuery
     #   necessary number of rows to meet the 1 MB limit.
     #   @return [Integer]
     #
+    # @!attribute [rw] query_insights
+    #   Encapsulates settings for enabling `QueryInsights`.
+    #
+    #   Enabling `QueryInsights` returns insights and metrics in addition to
+    #   query results for the query that you executed. You can use
+    #   `QueryInsights` to tune your query performance.
+    #   @return [Types::QueryInsights]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryRequest AWS API Documentation
     #
     class QueryRequest < Struct.new(
       :query_string,
       :client_token,
       :next_token,
-      :max_rows)
+      :max_rows,
+      :query_insights)
       SENSITIVE = [:query_string, :client_token]
       include Aws::Structure
     end
@@ -855,6 +997,11 @@ module Aws::TimestreamQuery
     #   bytes scanned.
     #   @return [Types::QueryStatus]
     #
+    # @!attribute [rw] query_insights_response
+    #   Encapsulates `QueryInsights` containing insights and metrics related
+    #   to the query that you executed.
+    #   @return [Types::QueryInsightsResponse]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryResponse AWS API Documentation
     #
     class QueryResponse < Struct.new(
@@ -862,7 +1009,78 @@ module Aws::TimestreamQuery
       :next_token,
       :rows,
       :column_info,
-      :query_status)
+      :query_status,
+      :query_insights_response)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides insights into the spatial coverage of the query, including
+    # the table with sub-optimal (max) spatial pruning. This information can
+    # help you identify areas for improvement in your partitioning strategy
+    # to enhance spatial pruning
+    #
+    # For example, you can do the following with the `QuerySpatialCoverage`
+    # information:
+    #
+    # * Add measure\_name or use [customer-defined partition key][1] (CDPK)
+    #   predicates.
+    #
+    # * If you've already done the preceding action, remove functions
+    #   around them or clauses, such as `LIKE`.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html
+    #
+    # @!attribute [rw] max
+    #   Provides insights into the spatial coverage of the executed query
+    #   and the table with the most inefficient spatial pruning.
+    #
+    #   * `Value` – The maximum ratio of spatial coverage.
+    #
+    #   * `TableArn` – The Amazon Resource Name (ARN) of the table with
+    #     sub-optimal spatial pruning.
+    #
+    #   * `PartitionKey` – The partition key used for partitioning, which
+    #     can be a default `measure_name` or a CDPK.
+    #   @return [Types::QuerySpatialCoverageMax]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QuerySpatialCoverage AWS API Documentation
+    #
+    class QuerySpatialCoverage < Struct.new(
+      :max)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides insights into the table with the most sub-optimal spatial
+    # range scanned by your query.
+    #
+    # @!attribute [rw] value
+    #   The maximum ratio of spatial coverage.
+    #   @return [Float]
+    #
+    # @!attribute [rw] table_arn
+    #   The Amazon Resource Name (ARN) of the table with the most
+    #   sub-optimal spatial pruning.
+    #   @return [String]
+    #
+    # @!attribute [rw] partition_key
+    #   The partition key used for partitioning, which can be a default
+    #   `measure_name` or a [customer defined partition key][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QuerySpatialCoverageMax AWS API Documentation
+    #
+    class QuerySpatialCoverageMax < Struct.new(
+      :value,
+      :table_arn,
+      :partition_key)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -898,6 +1116,50 @@ module Aws::TimestreamQuery
       include Aws::Structure
     end
 
+    # Provides insights into the temporal range of the query, including the
+    # table with the largest (max) time range.
+    #
+    # @!attribute [rw] max
+    #   Encapsulates the following properties that provide insights into the
+    #   most sub-optimal performing table on the temporal axis:
+    #
+    #   * `Value` – The maximum duration in nanoseconds between the start
+    #     and end of the query.
+    #
+    #   * `TableArn` – The Amazon Resource Name (ARN) of the table which is
+    #     queried with the largest time range.
+    #   @return [Types::QueryTemporalRangeMax]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryTemporalRange AWS API Documentation
+    #
+    class QueryTemporalRange < Struct.new(
+      :max)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides insights into the table with the most sub-optimal temporal
+    # pruning scanned by your query.
+    #
+    # @!attribute [rw] value
+    #   The maximum duration in nanoseconds between the start and end of the
+    #   query.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] table_arn
+    #   The Amazon Resource Name (ARN) of the table which is queried with
+    #   the largest time range.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryTemporalRangeMax AWS API Documentation
+    #
+    class QueryTemporalRangeMax < Struct.new(
+      :value,
+      :table_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The requested resource could not be found.
     #
     # @!attribute [rw] message
@@ -1131,6 +1393,78 @@ module Aws::TimestreamQuery
       include Aws::Structure
     end
 
+    # Encapsulates settings for enabling `QueryInsights` on an
+    # `ExecuteScheduledQueryRequest`.
+    #
+    # @!attribute [rw] mode
+    #   Provides the following modes to enable `ScheduledQueryInsights`:
+    #
+    #   * `ENABLED_WITH_RATE_CONTROL` – Enables `ScheduledQueryInsights` for
+    #     the queries being processed. This mode also includes a rate
+    #     control mechanism, which limits the `QueryInsights` feature to 1
+    #     query per second (QPS).
+    #
+    #   * `DISABLED` – Disables `ScheduledQueryInsights`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQueryInsights AWS API Documentation
+    #
+    class ScheduledQueryInsights < Struct.new(
+      :mode)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides various insights and metrics related to the
+    # `ExecuteScheduledQueryRequest` that was executed.
+    #
+    # @!attribute [rw] query_spatial_coverage
+    #   Provides insights into the spatial coverage of the query, including
+    #   the table with sub-optimal (max) spatial pruning. This information
+    #   can help you identify areas for improvement in your partitioning
+    #   strategy to enhance spatial pruning.
+    #   @return [Types::QuerySpatialCoverage]
+    #
+    # @!attribute [rw] query_temporal_range
+    #   Provides insights into the temporal range of the query, including
+    #   the table with the largest (max) time range. Following are some of
+    #   the potential options for optimizing time-based pruning:
+    #
+    #   * Add missing time-predicates.
+    #
+    #   * Remove functions around the time predicates.
+    #
+    #   * Add time predicates to all the sub-queries.
+    #   @return [Types::QueryTemporalRange]
+    #
+    # @!attribute [rw] query_table_count
+    #   Indicates the number of tables in the query.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] output_rows
+    #   Indicates the total number of rows returned as part of the query
+    #   result set. You can use this data to validate if the number of rows
+    #   in the result set have changed as part of the query tuning exercise.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] output_bytes
+    #   Indicates the size of query result set in bytes. You can use this
+    #   data to validate if the result set has changed as part of the query
+    #   tuning exercise.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQueryInsightsResponse AWS API Documentation
+    #
+    class ScheduledQueryInsightsResponse < Struct.new(
+      :query_spatial_coverage,
+      :query_temporal_range,
+      :query_table_count,
+      :output_rows,
+      :output_bytes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Run summary for the scheduled query
     #
     # @!attribute [rw] invocation_time
@@ -1151,6 +1485,11 @@ module Aws::TimestreamQuery
     #   Runtime statistics for a scheduled run.
     #   @return [Types::ExecutionStats]
     #
+    # @!attribute [rw] query_insights_response
+    #   Provides various insights and metrics related to the run summary of
+    #   the scheduled query.
+    #   @return [Types::ScheduledQueryInsightsResponse]
+    #
     # @!attribute [rw] error_report_location
     #   S3 location for error report.
     #   @return [Types::ErrorReportLocation]
@@ -1167,6 +1506,7 @@ module Aws::TimestreamQuery
       :trigger_time,
       :run_status,
       :execution_stats,
+      :query_insights_response,
       :error_report_location,
       :failure_reason)
       SENSITIVE = []

data/lib/aws-sdk-timestreamquery.rb

@@ -54,7 +54,7 @@ module Aws::TimestreamQuery
   autoload :EndpointProvider, 'aws-sdk-timestreamquery/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-timestreamquery/endpoints'
 
-  GEM_VERSION = '1.45.0'
+  GEM_VERSION = '1.46.0'
 
 end
 

data/sig/client.rbs

@@ -199,7 +199,10 @@ module Aws
       def execute_scheduled_query: (
                                      scheduled_query_arn: ::String,
                                      invocation_time: ::Time,
-                                     ?client_token: ::String
+                                     ?client_token: ::String,
+                                     ?query_insights: {
+                                       mode: ("ENABLED_WITH_RATE_CONTROL" | "DISABLED")
+                                     }
                                    ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
                                  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
 
@@ -248,13 +251,17 @@ module Aws
         def rows: () -> ::Array[Types::Row]
         def column_info: () -> ::Array[Types::ColumnInfo]
         def query_status: () -> Types::QueryStatus
+        def query_insights_response: () -> Types::QueryInsightsResponse
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/TimestreamQuery/Client.html#query-instance_method
       def query: (
                    query_string: ::String,
                    ?client_token: ::String,
                    ?next_token: ::String,
-                   ?max_rows: ::Integer
+                   ?max_rows: ::Integer,
+                   ?query_insights: {
+                     mode: ("ENABLED_WITH_RATE_CONTROL" | "DISABLED")
+                   }
                  ) -> _QueryResponseSuccess
                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _QueryResponseSuccess
 

data/sig/types.rbs

@@ -120,6 +120,7 @@ module Aws::TimestreamQuery
       attr_accessor scheduled_query_arn: ::String
       attr_accessor invocation_time: ::Time
       attr_accessor client_token: ::String
+      attr_accessor query_insights: Types::ScheduledQueryInsights
       SENSITIVE: [:client_token]
     end
 
@@ -219,11 +220,29 @@ module Aws::TimestreamQuery
       SENSITIVE: []
     end
 
+    class QueryInsights
+      attr_accessor mode: ("ENABLED_WITH_RATE_CONTROL" | "DISABLED")
+      SENSITIVE: []
+    end
+
+    class QueryInsightsResponse
+      attr_accessor query_spatial_coverage: Types::QuerySpatialCoverage
+      attr_accessor query_temporal_range: Types::QueryTemporalRange
+      attr_accessor query_table_count: ::Integer
+      attr_accessor output_rows: ::Integer
+      attr_accessor output_bytes: ::Integer
+      attr_accessor unload_partition_count: ::Integer
+      attr_accessor unload_written_rows: ::Integer
+      attr_accessor unload_written_bytes: ::Integer
+      SENSITIVE: []
+    end
+
     class QueryRequest
       attr_accessor query_string: ::String
       attr_accessor client_token: ::String
       attr_accessor next_token: ::String
       attr_accessor max_rows: ::Integer
+      attr_accessor query_insights: Types::QueryInsights
       SENSITIVE: [:query_string, :client_token]
     end
 
@@ -233,6 +252,19 @@ module Aws::TimestreamQuery
       attr_accessor rows: ::Array[Types::Row]
       attr_accessor column_info: ::Array[Types::ColumnInfo]
       attr_accessor query_status: Types::QueryStatus
+      attr_accessor query_insights_response: Types::QueryInsightsResponse
+      SENSITIVE: []
+    end
+
+    class QuerySpatialCoverage
+      attr_accessor max: Types::QuerySpatialCoverageMax
+      SENSITIVE: []
+    end
+
+    class QuerySpatialCoverageMax
+      attr_accessor value: ::Float
+      attr_accessor table_arn: ::String
+      attr_accessor partition_key: ::Array[::String]
       SENSITIVE: []
     end
 
@@ -243,6 +275,17 @@ module Aws::TimestreamQuery
       SENSITIVE: []
     end
 
+    class QueryTemporalRange
+      attr_accessor max: Types::QueryTemporalRangeMax
+      SENSITIVE: []
+    end
+
+    class QueryTemporalRangeMax
+      attr_accessor value: ::Integer
+      attr_accessor table_arn: ::String
+      SENSITIVE: []
+    end
+
     class ResourceNotFoundException
       attr_accessor message: ::String
       attr_accessor scheduled_query_arn: ::String
@@ -304,11 +347,26 @@ module Aws::TimestreamQuery
       SENSITIVE: [:query_string]
     end
 
+    class ScheduledQueryInsights
+      attr_accessor mode: ("ENABLED_WITH_RATE_CONTROL" | "DISABLED")
+      SENSITIVE: []
+    end
+
+    class ScheduledQueryInsightsResponse
+      attr_accessor query_spatial_coverage: Types::QuerySpatialCoverage
+      attr_accessor query_temporal_range: Types::QueryTemporalRange
+      attr_accessor query_table_count: ::Integer
+      attr_accessor output_rows: ::Integer
+      attr_accessor output_bytes: ::Integer
+      SENSITIVE: []
+    end
+
     class ScheduledQueryRunSummary
       attr_accessor invocation_time: ::Time
       attr_accessor trigger_time: ::Time
       attr_accessor run_status: ("AUTO_TRIGGER_SUCCESS" | "AUTO_TRIGGER_FAILURE" | "MANUAL_TRIGGER_SUCCESS" | "MANUAL_TRIGGER_FAILURE")
       attr_accessor execution_stats: Types::ExecutionStats
+      attr_accessor query_insights_response: Types::ScheduledQueryInsightsResponse
       attr_accessor error_report_location: Types::ErrorReportLocation
       attr_accessor failure_reason: ::String
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-timestreamquery
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core