aws-sdk-timestreamquery 1.9.0 → 1.13.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamquery/client.rb +676 -39
- data/lib/aws-sdk-timestreamquery/client_api.rb +469 -2
- data/lib/aws-sdk-timestreamquery/errors.rb +37 -0
- data/lib/aws-sdk-timestreamquery/types.rb +1549 -155
- data/lib/aws-sdk-timestreamquery.rb +1 -1
- metadata +4 -4
@@ -31,8 +31,8 @@ module Aws::TimestreamQuery
|
|
31
31
|
# }
|
32
32
|
#
|
33
33
|
# @!attribute [rw] query_id
|
34
|
-
# The
|
35
|
-
# returned as part of
|
34
|
+
# The ID of the query that needs to be cancelled. `QueryID` is
|
35
|
+
# returned as part of the query result.
|
36
36
|
# @return [String]
|
37
37
|
#
|
38
38
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/CancelQueryRequest AWS API Documentation
|
@@ -56,8 +56,8 @@ module Aws::TimestreamQuery
|
|
56
56
|
include Aws::Structure
|
57
57
|
end
|
58
58
|
|
59
|
-
# Contains the
|
60
|
-
#
|
59
|
+
# Contains the metadata for query results such as the column names, data
|
60
|
+
# types, and other attributes.
|
61
61
|
#
|
62
62
|
# @!attribute [rw] name
|
63
63
|
# The name of the result set column. The name of the result set is
|
@@ -67,7 +67,7 @@ module Aws::TimestreamQuery
|
|
67
67
|
# @!attribute [rw] type
|
68
68
|
# The data type of the result set column. The data type can be a
|
69
69
|
# scalar or complex. Scalar data types are integers, strings, doubles,
|
70
|
-
#
|
70
|
+
# Booleans, and others. Complex data types are types such as arrays,
|
71
71
|
# rows, and others.
|
72
72
|
# @return [Types::Type]
|
73
73
|
#
|
@@ -93,253 +93,1480 @@ module Aws::TimestreamQuery
|
|
93
93
|
include Aws::Structure
|
94
94
|
end
|
95
95
|
|
96
|
+
# @note When making an API call, you may pass CreateScheduledQueryRequest
|
97
|
+
# data as a hash:
|
98
|
+
#
|
99
|
+
# {
|
100
|
+
# name: "ScheduledQueryName", # required
|
101
|
+
# query_string: "QueryString", # required
|
102
|
+
# schedule_configuration: { # required
|
103
|
+
# schedule_expression: "ScheduleExpression", # required
|
104
|
+
# },
|
105
|
+
# notification_configuration: { # required
|
106
|
+
# sns_configuration: { # required
|
107
|
+
# topic_arn: "AmazonResourceName", # required
|
108
|
+
# },
|
109
|
+
# },
|
110
|
+
# target_configuration: {
|
111
|
+
# timestream_configuration: { # required
|
112
|
+
# database_name: "ResourceName", # required
|
113
|
+
# table_name: "ResourceName", # required
|
114
|
+
# time_column: "SchemaName", # required
|
115
|
+
# dimension_mappings: [ # required
|
116
|
+
# {
|
117
|
+
# name: "SchemaName", # required
|
118
|
+
# dimension_value_type: "VARCHAR", # required, accepts VARCHAR
|
119
|
+
# },
|
120
|
+
# ],
|
121
|
+
# multi_measure_mappings: {
|
122
|
+
# target_multi_measure_name: "SchemaName",
|
123
|
+
# multi_measure_attribute_mappings: [ # required
|
124
|
+
# {
|
125
|
+
# source_column: "SchemaName", # required
|
126
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
127
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
128
|
+
# },
|
129
|
+
# ],
|
130
|
+
# },
|
131
|
+
# mixed_measure_mappings: [
|
132
|
+
# {
|
133
|
+
# measure_name: "SchemaName",
|
134
|
+
# source_column: "SchemaName",
|
135
|
+
# target_measure_name: "SchemaName",
|
136
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR, MULTI
|
137
|
+
# multi_measure_attribute_mappings: [
|
138
|
+
# {
|
139
|
+
# source_column: "SchemaName", # required
|
140
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
141
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
142
|
+
# },
|
143
|
+
# ],
|
144
|
+
# },
|
145
|
+
# ],
|
146
|
+
# measure_name_column: "SchemaName",
|
147
|
+
# },
|
148
|
+
# },
|
149
|
+
# client_token: "ClientToken",
|
150
|
+
# scheduled_query_execution_role_arn: "AmazonResourceName", # required
|
151
|
+
# tags: [
|
152
|
+
# {
|
153
|
+
# key: "TagKey", # required
|
154
|
+
# value: "TagValue", # required
|
155
|
+
# },
|
156
|
+
# ],
|
157
|
+
# kms_key_id: "StringValue2048",
|
158
|
+
# error_report_configuration: { # required
|
159
|
+
# s3_configuration: { # required
|
160
|
+
# bucket_name: "S3BucketName", # required
|
161
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
162
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
163
|
+
# },
|
164
|
+
# },
|
165
|
+
# }
|
166
|
+
#
|
167
|
+
# @!attribute [rw] name
|
168
|
+
# Name of the scheduled query.
|
169
|
+
# @return [String]
|
170
|
+
#
|
171
|
+
# @!attribute [rw] query_string
|
172
|
+
# The query string to run. Parameter names can be specified in the
|
173
|
+
# query string `@` character followed by an identifier. The named
|
174
|
+
# Parameter `@scheduled_runtime` is reserved and can be used in the
|
175
|
+
# query to get the time at which the query is scheduled to run.
|
176
|
+
#
|
177
|
+
# The timestamp calculated according to the ScheduleConfiguration
|
178
|
+
# parameter, will be the value of `@scheduled_runtime` paramater for
|
179
|
+
# each query run. For example, consider an instance of a scheduled
|
180
|
+
# query executing on 2021-12-01 00:00:00. For this instance, the
|
181
|
+
# `@scheduled_runtime` parameter is initialized to the timestamp
|
182
|
+
# 2021-12-01 00:00:00 when invoking the query.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] schedule_configuration
|
186
|
+
# The schedule configuration for the query.
|
187
|
+
# @return [Types::ScheduleConfiguration]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] notification_configuration
|
190
|
+
# Notification configuration for the scheduled query. A notification
|
191
|
+
# is sent by Timestream when a query run finishes, when the state is
|
192
|
+
# updated or when you delete it.
|
193
|
+
# @return [Types::NotificationConfiguration]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] target_configuration
|
196
|
+
# Configuration used for writing the result of a query.
|
197
|
+
# @return [Types::TargetConfiguration]
|
198
|
+
#
|
199
|
+
# @!attribute [rw] client_token
|
200
|
+
# Using a ClientToken makes the call to CreateScheduledQuery
|
201
|
+
# idempotent, in other words, making the same request repeatedly will
|
202
|
+
# produce the same result. Making multiple identical
|
203
|
+
# CreateScheduledQuery requests has the same effect as making a single
|
204
|
+
# request.
|
205
|
+
#
|
206
|
+
# * If CreateScheduledQuery is called without a `ClientToken`, the
|
207
|
+
# Query SDK generates a `ClientToken` on your behalf.
|
208
|
+
#
|
209
|
+
# * After 8 hours, any request with the same `ClientToken` is treated
|
210
|
+
# as a new request.
|
211
|
+
#
|
212
|
+
# **A suitable default value is auto-generated.** You should normally
|
213
|
+
# not need to pass this option.
|
214
|
+
# @return [String]
|
215
|
+
#
|
216
|
+
# @!attribute [rw] scheduled_query_execution_role_arn
|
217
|
+
# The ARN for the IAM role that Timestream will assume when running
|
218
|
+
# the scheduled query.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] tags
|
222
|
+
# A list of key-value pairs to label the scheduled query.
|
223
|
+
# @return [Array<Types::Tag>]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] kms_key_id
|
226
|
+
# The Amazon KMS key used to encrypt the scheduled query resource,
|
227
|
+
# at-rest. If the Amazon KMS key is not specified, the scheduled query
|
228
|
+
# resource will be encrypted with a Timestream owned Amazon KMS key.
|
229
|
+
# To specify a KMS key, use the key ID, key ARN, alias name, or alias
|
230
|
+
# ARN. When using an alias name, prefix the name with *alias/*
|
231
|
+
#
|
232
|
+
# If ErrorReportConfiguration uses `SSE_KMS` as encryption type, the
|
233
|
+
# same KmsKeyId is used to encrypt the error report at rest.
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] error_report_configuration
|
237
|
+
# Configuration for error reporting. Error reports will be generated
|
238
|
+
# when a problem is encountered when writing the query results.
|
239
|
+
# @return [Types::ErrorReportConfiguration]
|
240
|
+
#
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/CreateScheduledQueryRequest AWS API Documentation
|
242
|
+
#
|
243
|
+
class CreateScheduledQueryRequest < Struct.new(
|
244
|
+
:name,
|
245
|
+
:query_string,
|
246
|
+
:schedule_configuration,
|
247
|
+
:notification_configuration,
|
248
|
+
:target_configuration,
|
249
|
+
:client_token,
|
250
|
+
:scheduled_query_execution_role_arn,
|
251
|
+
:tags,
|
252
|
+
:kms_key_id,
|
253
|
+
:error_report_configuration)
|
254
|
+
SENSITIVE = [:query_string, :client_token]
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
258
|
+
# @!attribute [rw] arn
|
259
|
+
# ARN for the created scheduled query.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/CreateScheduledQueryResponse AWS API Documentation
|
263
|
+
#
|
264
|
+
class CreateScheduledQueryResponse < Struct.new(
|
265
|
+
:arn)
|
266
|
+
SENSITIVE = []
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
96
270
|
# Datum represents a single data point in a query result.
|
97
271
|
#
|
98
272
|
# @!attribute [rw] scalar_value
|
99
273
|
# Indicates if the data point is a scalar value such as integer,
|
100
|
-
# string, double, or
|
274
|
+
# string, double, or Boolean.
|
101
275
|
# @return [String]
|
102
276
|
#
|
103
277
|
# @!attribute [rw] time_series_value
|
104
|
-
# Indicates if the data point is
|
278
|
+
# Indicates if the data point is a timeseries data type.
|
105
279
|
# @return [Array<Types::TimeSeriesDataPoint>]
|
106
280
|
#
|
107
281
|
# @!attribute [rw] array_value
|
108
282
|
# Indicates if the data point is an array.
|
109
283
|
# @return [Array<Types::Datum>]
|
110
284
|
#
|
111
|
-
# @!attribute [rw] row_value
|
112
|
-
# Indicates if the data point is a row.
|
113
|
-
# @return [Types::Row]
|
285
|
+
# @!attribute [rw] row_value
|
286
|
+
# Indicates if the data point is a row.
|
287
|
+
# @return [Types::Row]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] null_value
|
290
|
+
# Indicates if the data point is null.
|
291
|
+
# @return [Boolean]
|
292
|
+
#
|
293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/Datum AWS API Documentation
|
294
|
+
#
|
295
|
+
class Datum < Struct.new(
|
296
|
+
:scalar_value,
|
297
|
+
:time_series_value,
|
298
|
+
:array_value,
|
299
|
+
:row_value,
|
300
|
+
:null_value)
|
301
|
+
SENSITIVE = []
|
302
|
+
include Aws::Structure
|
303
|
+
end
|
304
|
+
|
305
|
+
# @note When making an API call, you may pass DeleteScheduledQueryRequest
|
306
|
+
# data as a hash:
|
307
|
+
#
|
308
|
+
# {
|
309
|
+
# scheduled_query_arn: "AmazonResourceName", # required
|
310
|
+
# }
|
311
|
+
#
|
312
|
+
# @!attribute [rw] scheduled_query_arn
|
313
|
+
# The ARN of the scheduled query.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DeleteScheduledQueryRequest AWS API Documentation
|
317
|
+
#
|
318
|
+
class DeleteScheduledQueryRequest < Struct.new(
|
319
|
+
:scheduled_query_arn)
|
320
|
+
SENSITIVE = []
|
321
|
+
include Aws::Structure
|
322
|
+
end
|
323
|
+
|
324
|
+
# @api private
|
325
|
+
#
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeEndpointsRequest AWS API Documentation
|
327
|
+
#
|
328
|
+
class DescribeEndpointsRequest < Aws::EmptyStructure; end
|
329
|
+
|
330
|
+
# @!attribute [rw] endpoints
|
331
|
+
# An `Endpoints` object is returned when a `DescribeEndpoints` request
|
332
|
+
# is made.
|
333
|
+
# @return [Array<Types::Endpoint>]
|
334
|
+
#
|
335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeEndpointsResponse AWS API Documentation
|
336
|
+
#
|
337
|
+
class DescribeEndpointsResponse < Struct.new(
|
338
|
+
:endpoints)
|
339
|
+
SENSITIVE = []
|
340
|
+
include Aws::Structure
|
341
|
+
end
|
342
|
+
|
343
|
+
# @note When making an API call, you may pass DescribeScheduledQueryRequest
|
344
|
+
# data as a hash:
|
345
|
+
#
|
346
|
+
# {
|
347
|
+
# scheduled_query_arn: "AmazonResourceName", # required
|
348
|
+
# }
|
349
|
+
#
|
350
|
+
# @!attribute [rw] scheduled_query_arn
|
351
|
+
# The ARN of the scheduled query.
|
352
|
+
# @return [String]
|
353
|
+
#
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeScheduledQueryRequest AWS API Documentation
|
355
|
+
#
|
356
|
+
class DescribeScheduledQueryRequest < Struct.new(
|
357
|
+
:scheduled_query_arn)
|
358
|
+
SENSITIVE = []
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
362
|
+
# @!attribute [rw] scheduled_query
|
363
|
+
# The scheduled query.
|
364
|
+
# @return [Types::ScheduledQueryDescription]
|
365
|
+
#
|
366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DescribeScheduledQueryResponse AWS API Documentation
|
367
|
+
#
|
368
|
+
class DescribeScheduledQueryResponse < Struct.new(
|
369
|
+
:scheduled_query)
|
370
|
+
SENSITIVE = []
|
371
|
+
include Aws::Structure
|
372
|
+
end
|
373
|
+
|
374
|
+
# This type is used to map column(s) from the query result to a
|
375
|
+
# dimension in the destination table.
|
376
|
+
#
|
377
|
+
# @note When making an API call, you may pass DimensionMapping
|
378
|
+
# data as a hash:
|
379
|
+
#
|
380
|
+
# {
|
381
|
+
# name: "SchemaName", # required
|
382
|
+
# dimension_value_type: "VARCHAR", # required, accepts VARCHAR
|
383
|
+
# }
|
384
|
+
#
|
385
|
+
# @!attribute [rw] name
|
386
|
+
# Column name from query result.
|
387
|
+
# @return [String]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] dimension_value_type
|
390
|
+
# Type for the dimension.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/DimensionMapping AWS API Documentation
|
394
|
+
#
|
395
|
+
class DimensionMapping < Struct.new(
|
396
|
+
:name,
|
397
|
+
:dimension_value_type)
|
398
|
+
SENSITIVE = []
|
399
|
+
include Aws::Structure
|
400
|
+
end
|
401
|
+
|
402
|
+
# Represents an available endpoint against which to make API calls
|
403
|
+
# against, as well as the TTL for that endpoint.
|
404
|
+
#
|
405
|
+
# @!attribute [rw] address
|
406
|
+
# An endpoint address.
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] cache_period_in_minutes
|
410
|
+
# The TTL for the endpoint, in minutes.
|
411
|
+
# @return [Integer]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/Endpoint AWS API Documentation
|
414
|
+
#
|
415
|
+
class Endpoint < Struct.new(
|
416
|
+
:address,
|
417
|
+
:cache_period_in_minutes)
|
418
|
+
SENSITIVE = []
|
419
|
+
include Aws::Structure
|
420
|
+
end
|
421
|
+
|
422
|
+
# Configuration required for error reporting.
|
423
|
+
#
|
424
|
+
# @note When making an API call, you may pass ErrorReportConfiguration
|
425
|
+
# data as a hash:
|
426
|
+
#
|
427
|
+
# {
|
428
|
+
# s3_configuration: { # required
|
429
|
+
# bucket_name: "S3BucketName", # required
|
430
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
431
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
432
|
+
# },
|
433
|
+
# }
|
434
|
+
#
|
435
|
+
# @!attribute [rw] s3_configuration
|
436
|
+
# The S3 configuration for the error reports.
|
437
|
+
# @return [Types::S3Configuration]
|
438
|
+
#
|
439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ErrorReportConfiguration AWS API Documentation
|
440
|
+
#
|
441
|
+
class ErrorReportConfiguration < Struct.new(
|
442
|
+
:s3_configuration)
|
443
|
+
SENSITIVE = []
|
444
|
+
include Aws::Structure
|
445
|
+
end
|
446
|
+
|
447
|
+
# This contains the location of the error report for a single scheduled
|
448
|
+
# query call.
|
449
|
+
#
|
450
|
+
# @!attribute [rw] s3_report_location
|
451
|
+
# The S3 location where error reports are written.
|
452
|
+
# @return [Types::S3ReportLocation]
|
453
|
+
#
|
454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ErrorReportLocation AWS API Documentation
|
455
|
+
#
|
456
|
+
class ErrorReportLocation < Struct.new(
|
457
|
+
:s3_report_location)
|
458
|
+
SENSITIVE = []
|
459
|
+
include Aws::Structure
|
460
|
+
end
|
461
|
+
|
462
|
+
# @note When making an API call, you may pass ExecuteScheduledQueryRequest
|
463
|
+
# data as a hash:
|
464
|
+
#
|
465
|
+
# {
|
466
|
+
# scheduled_query_arn: "AmazonResourceName", # required
|
467
|
+
# invocation_time: Time.now, # required
|
468
|
+
# client_token: "ClientToken",
|
469
|
+
# }
|
470
|
+
#
|
471
|
+
# @!attribute [rw] scheduled_query_arn
|
472
|
+
# ARN of the scheduled query.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] invocation_time
|
476
|
+
# The timestamp in UTC. Query will be run as if it was invoked at this
|
477
|
+
# timestamp.
|
478
|
+
# @return [Time]
|
479
|
+
#
|
480
|
+
# @!attribute [rw] client_token
|
481
|
+
# Not used.
|
482
|
+
#
|
483
|
+
# **A suitable default value is auto-generated.** You should normally
|
484
|
+
# not need to pass this option.
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ExecuteScheduledQueryRequest AWS API Documentation
|
488
|
+
#
|
489
|
+
class ExecuteScheduledQueryRequest < Struct.new(
|
490
|
+
:scheduled_query_arn,
|
491
|
+
:invocation_time,
|
492
|
+
:client_token)
|
493
|
+
SENSITIVE = [:client_token]
|
494
|
+
include Aws::Structure
|
495
|
+
end
|
496
|
+
|
497
|
+
# Statistics for a single scheduled query run.
|
498
|
+
#
|
499
|
+
# @!attribute [rw] execution_time_in_millis
|
500
|
+
# Total time, measured in milliseconds, that was needed for the
|
501
|
+
# scheduled query run to complete.
|
502
|
+
# @return [Integer]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] data_writes
|
505
|
+
# Data writes metered for records ingested in a single scheduled query
|
506
|
+
# run.
|
507
|
+
# @return [Integer]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] bytes_metered
|
510
|
+
# Bytes metered for a single scheduled query run.
|
511
|
+
# @return [Integer]
|
512
|
+
#
|
513
|
+
# @!attribute [rw] records_ingested
|
514
|
+
# The number of records ingested for a single scheduled query run.
|
515
|
+
# @return [Integer]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] query_result_rows
|
518
|
+
# Number of rows present in the output from running a query before
|
519
|
+
# ingestion to destination data source.
|
520
|
+
# @return [Integer]
|
521
|
+
#
|
522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ExecutionStats AWS API Documentation
|
523
|
+
#
|
524
|
+
class ExecutionStats < Struct.new(
|
525
|
+
:execution_time_in_millis,
|
526
|
+
:data_writes,
|
527
|
+
:bytes_metered,
|
528
|
+
:records_ingested,
|
529
|
+
:query_result_rows)
|
530
|
+
SENSITIVE = []
|
531
|
+
include Aws::Structure
|
532
|
+
end
|
533
|
+
|
534
|
+
# Timestream was unable to fully process this request because of an
|
535
|
+
# internal server error.
|
536
|
+
#
|
537
|
+
# @!attribute [rw] message
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/InternalServerException AWS API Documentation
|
541
|
+
#
|
542
|
+
class InternalServerException < Struct.new(
|
543
|
+
:message)
|
544
|
+
SENSITIVE = []
|
545
|
+
include Aws::Structure
|
546
|
+
end
|
547
|
+
|
548
|
+
# The requested endpoint was not valid.
|
549
|
+
#
|
550
|
+
# @!attribute [rw] message
|
551
|
+
# @return [String]
|
552
|
+
#
|
553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/InvalidEndpointException AWS API Documentation
|
554
|
+
#
|
555
|
+
class InvalidEndpointException < Struct.new(
|
556
|
+
:message)
|
557
|
+
SENSITIVE = []
|
558
|
+
include Aws::Structure
|
559
|
+
end
|
560
|
+
|
561
|
+
# @note When making an API call, you may pass ListScheduledQueriesRequest
|
562
|
+
# data as a hash:
|
563
|
+
#
|
564
|
+
# {
|
565
|
+
# max_results: 1,
|
566
|
+
# next_token: "NextScheduledQueriesResultsToken",
|
567
|
+
# }
|
568
|
+
#
|
569
|
+
# @!attribute [rw] max_results
|
570
|
+
# The maximum number of items to return in the output. If the total
|
571
|
+
# number of items available is more than the value specified, a
|
572
|
+
# `NextToken` is provided in the output. To resume pagination, provide
|
573
|
+
# the `NextToken` value as the argument to the subsequent call to
|
574
|
+
# `ListScheduledQueriesRequest`.
|
575
|
+
# @return [Integer]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] next_token
|
578
|
+
# A pagination token to resume pagination.
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ListScheduledQueriesRequest AWS API Documentation
|
582
|
+
#
|
583
|
+
class ListScheduledQueriesRequest < Struct.new(
|
584
|
+
:max_results,
|
585
|
+
:next_token)
|
586
|
+
SENSITIVE = []
|
587
|
+
include Aws::Structure
|
588
|
+
end
|
589
|
+
|
590
|
+
# @!attribute [rw] scheduled_queries
|
591
|
+
# A list of scheduled queries.
|
592
|
+
# @return [Array<Types::ScheduledQuery>]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] next_token
|
595
|
+
# A token to specify where to start paginating. This is the NextToken
|
596
|
+
# from a previously truncated response.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ListScheduledQueriesResponse AWS API Documentation
|
600
|
+
#
|
601
|
+
class ListScheduledQueriesResponse < Struct.new(
|
602
|
+
:scheduled_queries,
|
603
|
+
:next_token)
|
604
|
+
SENSITIVE = []
|
605
|
+
include Aws::Structure
|
606
|
+
end
|
607
|
+
|
608
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
609
|
+
# data as a hash:
|
610
|
+
#
|
611
|
+
# {
|
612
|
+
# resource_arn: "AmazonResourceName", # required
|
613
|
+
# max_results: 1,
|
614
|
+
# next_token: "NextTagsForResourceResultsToken",
|
615
|
+
# }
|
616
|
+
#
|
617
|
+
# @!attribute [rw] resource_arn
|
618
|
+
# The Timestream resource with tags to be listed. This value is an
|
619
|
+
# Amazon Resource Name (ARN).
|
620
|
+
# @return [String]
|
621
|
+
#
|
622
|
+
# @!attribute [rw] max_results
|
623
|
+
# The maximum number of tags to return.
|
624
|
+
# @return [Integer]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] next_token
|
627
|
+
# A pagination token to resume pagination.
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ListTagsForResourceRequest AWS API Documentation
|
631
|
+
#
|
632
|
+
class ListTagsForResourceRequest < Struct.new(
|
633
|
+
:resource_arn,
|
634
|
+
:max_results,
|
635
|
+
:next_token)
|
636
|
+
SENSITIVE = []
|
637
|
+
include Aws::Structure
|
638
|
+
end
|
639
|
+
|
640
|
+
# @!attribute [rw] tags
|
641
|
+
# The tags currently associated with the Timestream resource.
|
642
|
+
# @return [Array<Types::Tag>]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] next_token
|
645
|
+
# A pagination token to resume pagination with a subsequent call to
|
646
|
+
# `ListTagsForResourceResponse`.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ListTagsForResourceResponse AWS API Documentation
|
650
|
+
#
|
651
|
+
class ListTagsForResourceResponse < Struct.new(
|
652
|
+
:tags,
|
653
|
+
:next_token)
|
654
|
+
SENSITIVE = []
|
655
|
+
include Aws::Structure
|
656
|
+
end
|
657
|
+
|
658
|
+
# MixedMeasureMappings are mappings that can be used to ingest data into
|
659
|
+
# a mixture of narrow and multi measures in the derived table.
|
660
|
+
#
|
661
|
+
# @note When making an API call, you may pass MixedMeasureMapping
|
662
|
+
# data as a hash:
|
663
|
+
#
|
664
|
+
# {
|
665
|
+
# measure_name: "SchemaName",
|
666
|
+
# source_column: "SchemaName",
|
667
|
+
# target_measure_name: "SchemaName",
|
668
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR, MULTI
|
669
|
+
# multi_measure_attribute_mappings: [
|
670
|
+
# {
|
671
|
+
# source_column: "SchemaName", # required
|
672
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
673
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
674
|
+
# },
|
675
|
+
# ],
|
676
|
+
# }
|
677
|
+
#
|
678
|
+
# @!attribute [rw] measure_name
|
679
|
+
# Refers to the value of measure\_name in a result row. This field is
|
680
|
+
# required if MeasureNameColumn is provided.
|
681
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] source_column
|
684
|
+
# This field refers to the source column from which measure-value is
|
685
|
+
# to be read for result materialization.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] target_measure_name
|
689
|
+
# Target measure name to be used. If not provided, the target measure
|
690
|
+
# name by default would be measure-name if provided, or sourceColumn
|
691
|
+
# otherwise.
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] measure_value_type
|
695
|
+
# Type of the value that is to be read from sourceColumn. If the
|
696
|
+
# mapping is for MULTI, use MeasureValueType.MULTI.
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] multi_measure_attribute_mappings
|
700
|
+
# Required when measureValueType is MULTI. Attribute mappings for
|
701
|
+
# MULTI value measures.
|
702
|
+
# @return [Array<Types::MultiMeasureAttributeMapping>]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/MixedMeasureMapping AWS API Documentation
|
705
|
+
#
|
706
|
+
class MixedMeasureMapping < Struct.new(
|
707
|
+
:measure_name,
|
708
|
+
:source_column,
|
709
|
+
:target_measure_name,
|
710
|
+
:measure_value_type,
|
711
|
+
:multi_measure_attribute_mappings)
|
712
|
+
SENSITIVE = []
|
713
|
+
include Aws::Structure
|
714
|
+
end
|
715
|
+
|
716
|
+
# Attribute mapping for MULTI value measures.
|
717
|
+
#
|
718
|
+
# @note When making an API call, you may pass MultiMeasureAttributeMapping
|
719
|
+
# data as a hash:
|
720
|
+
#
|
721
|
+
# {
|
722
|
+
# source_column: "SchemaName", # required
|
723
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
724
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
725
|
+
# }
|
726
|
+
#
|
727
|
+
# @!attribute [rw] source_column
|
728
|
+
# Source column from where the attribute value is to be read.
|
729
|
+
# @return [String]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] target_multi_measure_attribute_name
|
732
|
+
# Custom name to be used for attribute name in derived table. If not
|
733
|
+
# provided, source column name would be used.
|
734
|
+
# @return [String]
|
735
|
+
#
|
736
|
+
# @!attribute [rw] measure_value_type
|
737
|
+
# Type of the attribute to be read from the source column.
|
738
|
+
# @return [String]
|
739
|
+
#
|
740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/MultiMeasureAttributeMapping AWS API Documentation
|
741
|
+
#
|
742
|
+
class MultiMeasureAttributeMapping < Struct.new(
|
743
|
+
:source_column,
|
744
|
+
:target_multi_measure_attribute_name,
|
745
|
+
:measure_value_type)
|
746
|
+
SENSITIVE = []
|
747
|
+
include Aws::Structure
|
748
|
+
end
|
749
|
+
|
750
|
+
# Only one of MixedMeasureMappings or MultiMeasureMappings is to be
|
751
|
+
# provided. MultiMeasureMappings can be used to ingest data as multi
|
752
|
+
# measures in the derived table.
|
753
|
+
#
|
754
|
+
# @note When making an API call, you may pass MultiMeasureMappings
|
755
|
+
# data as a hash:
|
756
|
+
#
|
757
|
+
# {
|
758
|
+
# target_multi_measure_name: "SchemaName",
|
759
|
+
# multi_measure_attribute_mappings: [ # required
|
760
|
+
# {
|
761
|
+
# source_column: "SchemaName", # required
|
762
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
763
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
764
|
+
# },
|
765
|
+
# ],
|
766
|
+
# }
|
767
|
+
#
|
768
|
+
# @!attribute [rw] target_multi_measure_name
|
769
|
+
# The name of the target multi-measure name in the derived table. This
|
770
|
+
# input is required when measureNameColumn is not provided. If
|
771
|
+
# MeasureNameColumn is provided, then value from that column will be
|
772
|
+
# used as multi-measure name.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] multi_measure_attribute_mappings
|
776
|
+
# Required. Attribute mappings to be used for mapping query results to
|
777
|
+
# ingest data for multi-measure attributes.
|
778
|
+
# @return [Array<Types::MultiMeasureAttributeMapping>]
|
779
|
+
#
|
780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/MultiMeasureMappings AWS API Documentation
|
781
|
+
#
|
782
|
+
class MultiMeasureMappings < Struct.new(
|
783
|
+
:target_multi_measure_name,
|
784
|
+
:multi_measure_attribute_mappings)
|
785
|
+
SENSITIVE = []
|
786
|
+
include Aws::Structure
|
787
|
+
end
|
788
|
+
|
789
|
+
# Notification configuration for a scheduled query. A notification is
|
790
|
+
# sent by Timestream when a scheduled query is created, its state is
|
791
|
+
# updated or when it is deleted.
|
792
|
+
#
|
793
|
+
# @note When making an API call, you may pass NotificationConfiguration
|
794
|
+
# data as a hash:
|
795
|
+
#
|
796
|
+
# {
|
797
|
+
# sns_configuration: { # required
|
798
|
+
# topic_arn: "AmazonResourceName", # required
|
799
|
+
# },
|
800
|
+
# }
|
801
|
+
#
|
802
|
+
# @!attribute [rw] sns_configuration
|
803
|
+
# Details on SNS configuration.
|
804
|
+
# @return [Types::SnsConfiguration]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/NotificationConfiguration AWS API Documentation
|
807
|
+
#
|
808
|
+
class NotificationConfiguration < Struct.new(
|
809
|
+
:sns_configuration)
|
810
|
+
SENSITIVE = []
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# Mapping for named parameters.
|
815
|
+
#
|
816
|
+
# @!attribute [rw] name
|
817
|
+
# Parameter name.
|
818
|
+
# @return [String]
|
819
|
+
#
|
820
|
+
# @!attribute [rw] type
|
821
|
+
# Contains the data type of a column in a query result set. The data
|
822
|
+
# type can be scalar or complex. The supported scalar data types are
|
823
|
+
# integers, Boolean, string, double, timestamp, date, time, and
|
824
|
+
# intervals. The supported complex data types are arrays, rows, and
|
825
|
+
# timeseries.
|
826
|
+
# @return [Types::Type]
|
827
|
+
#
|
828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ParameterMapping AWS API Documentation
|
829
|
+
#
|
830
|
+
class ParameterMapping < Struct.new(
|
831
|
+
:name,
|
832
|
+
:type)
|
833
|
+
SENSITIVE = []
|
834
|
+
include Aws::Structure
|
835
|
+
end
|
836
|
+
|
837
|
+
# @note When making an API call, you may pass PrepareQueryRequest
|
838
|
+
# data as a hash:
|
839
|
+
#
|
840
|
+
# {
|
841
|
+
# query_string: "QueryString", # required
|
842
|
+
# validate_only: false,
|
843
|
+
# }
|
844
|
+
#
|
845
|
+
# @!attribute [rw] query_string
|
846
|
+
# The Timestream query string that you want to use as a prepared
|
847
|
+
# statement. Parameter names can be specified in the query string `@`
|
848
|
+
# character followed by an identifier.
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
# @!attribute [rw] validate_only
|
852
|
+
# By setting this value to `true`, Timestream will only validate that
|
853
|
+
# the query string is a valid Timestream query, and not store the
|
854
|
+
# prepared query for later use.
|
855
|
+
# @return [Boolean]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/PrepareQueryRequest AWS API Documentation
|
858
|
+
#
|
859
|
+
class PrepareQueryRequest < Struct.new(
|
860
|
+
:query_string,
|
861
|
+
:validate_only)
|
862
|
+
SENSITIVE = [:query_string]
|
863
|
+
include Aws::Structure
|
864
|
+
end
|
865
|
+
|
866
|
+
# @!attribute [rw] query_string
|
867
|
+
# The query string that you want prepare.
|
868
|
+
# @return [String]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] columns
|
871
|
+
# A list of SELECT clause columns of the submitted query string.
|
872
|
+
# @return [Array<Types::SelectColumn>]
|
873
|
+
#
|
874
|
+
# @!attribute [rw] parameters
|
875
|
+
# A list of parameters used in the submitted query string.
|
876
|
+
# @return [Array<Types::ParameterMapping>]
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/PrepareQueryResponse AWS API Documentation
|
879
|
+
#
|
880
|
+
class PrepareQueryResponse < Struct.new(
|
881
|
+
:query_string,
|
882
|
+
:columns,
|
883
|
+
:parameters)
|
884
|
+
SENSITIVE = [:query_string]
|
885
|
+
include Aws::Structure
|
886
|
+
end
|
887
|
+
|
888
|
+
# Timestream was unable to run the query successfully.
|
889
|
+
#
|
890
|
+
# @!attribute [rw] message
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryExecutionException AWS API Documentation
|
894
|
+
#
|
895
|
+
class QueryExecutionException < Struct.new(
|
896
|
+
:message)
|
897
|
+
SENSITIVE = []
|
898
|
+
include Aws::Structure
|
899
|
+
end
|
900
|
+
|
901
|
+
# @note When making an API call, you may pass QueryRequest
|
902
|
+
# data as a hash:
|
903
|
+
#
|
904
|
+
# {
|
905
|
+
# query_string: "QueryString", # required
|
906
|
+
# client_token: "ClientRequestToken",
|
907
|
+
# next_token: "PaginationToken",
|
908
|
+
# max_rows: 1,
|
909
|
+
# }
|
910
|
+
#
|
911
|
+
# @!attribute [rw] query_string
|
912
|
+
# The query to be run by Timestream.
|
913
|
+
# @return [String]
|
914
|
+
#
|
915
|
+
# @!attribute [rw] client_token
|
916
|
+
# Unique, case-sensitive string of up to 64 ASCII characters specified
|
917
|
+
# when a `Query` request is made. Providing a `ClientToken` makes the
|
918
|
+
# call to `Query` *idempotent*. This means that running the same query
|
919
|
+
# repeatedly will produce the same result. In other words, making
|
920
|
+
# multiple identical `Query` requests has the same effect as making a
|
921
|
+
# single request. When using `ClientToken` in a query, note the
|
922
|
+
# following:
|
923
|
+
#
|
924
|
+
# * If the Query API is instantiated without a `ClientToken`, the
|
925
|
+
# Query SDK generates a `ClientToken` on your behalf.
|
926
|
+
#
|
927
|
+
# * If the `Query` invocation only contains the `ClientToken` but does
|
928
|
+
# not include a `NextToken`, that invocation of `Query` is assumed
|
929
|
+
# to be a new query run.
|
930
|
+
#
|
931
|
+
# * If the invocation contains `NextToken`, that particular invocation
|
932
|
+
# is assumed to be a subsequent invocation of a prior call to the
|
933
|
+
# Query API, and a result set is returned.
|
934
|
+
#
|
935
|
+
# * After 4 hours, any request with the same `ClientToken` is treated
|
936
|
+
# as a new request.
|
937
|
+
#
|
938
|
+
# **A suitable default value is auto-generated.** You should normally
|
939
|
+
# not need to pass this option.
|
940
|
+
# @return [String]
|
941
|
+
#
|
942
|
+
# @!attribute [rw] next_token
|
943
|
+
# A pagination token used to return a set of results. When the `Query`
|
944
|
+
# API is invoked using `NextToken`, that particular invocation is
|
945
|
+
# assumed to be a subsequent invocation of a prior call to `Query`,
|
946
|
+
# and a result set is returned. However, if the `Query` invocation
|
947
|
+
# only contains the `ClientToken`, that invocation of `Query` is
|
948
|
+
# assumed to be a new query run.
|
949
|
+
#
|
950
|
+
# Note the following when using NextToken in a query:
|
951
|
+
#
|
952
|
+
# * A pagination token can be used for up to five `Query` invocations,
|
953
|
+
# OR for a duration of up to 1 hour – whichever comes first.
|
954
|
+
#
|
955
|
+
# * Using the same `NextToken` will return the same set of records. To
|
956
|
+
# keep paginating through the result set, you must to use the most
|
957
|
+
# recent `nextToken`.
|
958
|
+
#
|
959
|
+
# * Suppose a `Query` invocation returns two `NextToken` values,
|
960
|
+
# `TokenA` and `TokenB`. If `TokenB` is used in a subsequent `Query`
|
961
|
+
# invocation, then `TokenA` is invalidated and cannot be reused.
|
962
|
+
#
|
963
|
+
# * To request a previous result set from a query after pagination has
|
964
|
+
# begun, you must re-invoke the Query API.
|
965
|
+
#
|
966
|
+
# * The latest `NextToken` should be used to paginate until `null` is
|
967
|
+
# returned, at which point a new `NextToken` should be used.
|
968
|
+
#
|
969
|
+
# * If the IAM principal of the query initiator and the result reader
|
970
|
+
# are not the same and/or the query initiator and the result reader
|
971
|
+
# do not have the same query string in the query requests, the query
|
972
|
+
# will fail with an `Invalid pagination token` error.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] max_rows
|
976
|
+
# The total number of rows to be returned in the `Query` output. The
|
977
|
+
# initial run of `Query` with a `MaxRows` value specified will return
|
978
|
+
# the result set of the query in two cases:
|
979
|
+
#
|
980
|
+
# * The size of the result is less than `1MB`.
|
981
|
+
#
|
982
|
+
# * The number of rows in the result set is less than the value of
|
983
|
+
# `maxRows`.
|
984
|
+
#
|
985
|
+
# Otherwise, the initial invocation of `Query` only returns a
|
986
|
+
# `NextToken`, which can then be used in subsequent calls to fetch the
|
987
|
+
# result set. To resume pagination, provide the `NextToken` value in
|
988
|
+
# the subsequent command.
|
989
|
+
#
|
990
|
+
# If the row size is large (e.g. a row has many columns), Timestream
|
991
|
+
# may return fewer rows to keep the response size from exceeding the 1
|
992
|
+
# MB limit. If `MaxRows` is not provided, Timestream will send the
|
993
|
+
# necessary number of rows to meet the 1 MB limit.
|
994
|
+
# @return [Integer]
|
995
|
+
#
|
996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryRequest AWS API Documentation
|
997
|
+
#
|
998
|
+
class QueryRequest < Struct.new(
|
999
|
+
:query_string,
|
1000
|
+
:client_token,
|
1001
|
+
:next_token,
|
1002
|
+
:max_rows)
|
1003
|
+
SENSITIVE = [:query_string, :client_token]
|
1004
|
+
include Aws::Structure
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
# @!attribute [rw] query_id
|
1008
|
+
# A unique ID for the given query.
|
1009
|
+
# @return [String]
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] next_token
|
1012
|
+
# A pagination token that can be used again on a `Query` call to get
|
1013
|
+
# the next set of results.
|
1014
|
+
# @return [String]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] rows
|
1017
|
+
# The result set rows returned by the query.
|
1018
|
+
# @return [Array<Types::Row>]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] column_info
|
1021
|
+
# The column data types of the returned result set.
|
1022
|
+
# @return [Array<Types::ColumnInfo>]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] query_status
|
1025
|
+
# Information about the status of the query, including progress and
|
1026
|
+
# bytes scanned.
|
1027
|
+
# @return [Types::QueryStatus]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryResponse AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class QueryResponse < Struct.new(
|
1032
|
+
:query_id,
|
1033
|
+
:next_token,
|
1034
|
+
:rows,
|
1035
|
+
:column_info,
|
1036
|
+
:query_status)
|
1037
|
+
SENSITIVE = []
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# Information about the status of the query, including progress and
|
1042
|
+
# bytes scanned.
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] progress_percentage
|
1045
|
+
# The progress of the query, expressed as a percentage.
|
1046
|
+
# @return [Float]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] cumulative_bytes_scanned
|
1049
|
+
# The amount of data scanned by the query in bytes. This is a
|
1050
|
+
# cumulative sum and represents the total amount of bytes scanned
|
1051
|
+
# since the query was started.
|
1052
|
+
# @return [Integer]
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] cumulative_bytes_metered
|
1055
|
+
# The amount of data scanned by the query in bytes that you will be
|
1056
|
+
# charged for. This is a cumulative sum and represents the total
|
1057
|
+
# amount of data that you will be charged for since the query was
|
1058
|
+
# started. The charge is applied only once and is either applied when
|
1059
|
+
# the query completes running or when the query is cancelled.
|
1060
|
+
# @return [Integer]
|
1061
|
+
#
|
1062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryStatus AWS API Documentation
|
1063
|
+
#
|
1064
|
+
class QueryStatus < Struct.new(
|
1065
|
+
:progress_percentage,
|
1066
|
+
:cumulative_bytes_scanned,
|
1067
|
+
:cumulative_bytes_metered)
|
1068
|
+
SENSITIVE = []
|
1069
|
+
include Aws::Structure
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# The requested resource could not be found.
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] message
|
1075
|
+
# @return [String]
|
1076
|
+
#
|
1077
|
+
# @!attribute [rw] scheduled_query_arn
|
1078
|
+
# The ARN of the scheduled query.
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ResourceNotFoundException AWS API Documentation
|
1082
|
+
#
|
1083
|
+
class ResourceNotFoundException < Struct.new(
|
1084
|
+
:message,
|
1085
|
+
:scheduled_query_arn)
|
1086
|
+
SENSITIVE = []
|
1087
|
+
include Aws::Structure
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# Represents a single row in the query results.
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] data
|
1093
|
+
# List of data points in a single row of the result set.
|
1094
|
+
# @return [Array<Types::Datum>]
|
1095
|
+
#
|
1096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/Row AWS API Documentation
|
1097
|
+
#
|
1098
|
+
class Row < Struct.new(
|
1099
|
+
:data)
|
1100
|
+
SENSITIVE = []
|
1101
|
+
include Aws::Structure
|
1102
|
+
end
|
1103
|
+
|
1104
|
+
# Details on S3 location for error reports that result from running a
|
1105
|
+
# query.
|
1106
|
+
#
|
1107
|
+
# @note When making an API call, you may pass S3Configuration
|
1108
|
+
# data as a hash:
|
1109
|
+
#
|
1110
|
+
# {
|
1111
|
+
# bucket_name: "S3BucketName", # required
|
1112
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
1113
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1114
|
+
# }
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] bucket_name
|
1117
|
+
# Name of the S3 bucket under which error reports will be created.
|
1118
|
+
# @return [String]
|
1119
|
+
#
|
1120
|
+
# @!attribute [rw] object_key_prefix
|
1121
|
+
# Prefix for the error report key. Timestream by default adds the
|
1122
|
+
# following prefix to the error report path.
|
1123
|
+
# @return [String]
|
1124
|
+
#
|
1125
|
+
# @!attribute [rw] encryption_option
|
1126
|
+
# Encryption at rest options for the error reports. If no encryption
|
1127
|
+
# option is specified, Timestream will choose SSE\_S3 as default.
|
1128
|
+
# @return [String]
|
1129
|
+
#
|
1130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/S3Configuration AWS API Documentation
|
1131
|
+
#
|
1132
|
+
class S3Configuration < Struct.new(
|
1133
|
+
:bucket_name,
|
1134
|
+
:object_key_prefix,
|
1135
|
+
:encryption_option)
|
1136
|
+
SENSITIVE = []
|
1137
|
+
include Aws::Structure
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# S3 report location for the scheduled query run.
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] bucket_name
|
1143
|
+
# S3 bucket name.
|
1144
|
+
# @return [String]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] object_key
|
1147
|
+
# S3 key.
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/S3ReportLocation AWS API Documentation
|
1151
|
+
#
|
1152
|
+
class S3ReportLocation < Struct.new(
|
1153
|
+
:bucket_name,
|
1154
|
+
:object_key)
|
1155
|
+
SENSITIVE = []
|
1156
|
+
include Aws::Structure
|
1157
|
+
end
|
1158
|
+
|
1159
|
+
# Configuration of the schedule of the query.
|
1160
|
+
#
|
1161
|
+
# @note When making an API call, you may pass ScheduleConfiguration
|
1162
|
+
# data as a hash:
|
1163
|
+
#
|
1164
|
+
# {
|
1165
|
+
# schedule_expression: "ScheduleExpression", # required
|
1166
|
+
# }
|
114
1167
|
#
|
115
|
-
# @!attribute [rw]
|
116
|
-
#
|
117
|
-
#
|
1168
|
+
# @!attribute [rw] schedule_expression
|
1169
|
+
# An expression that denotes when to trigger the scheduled query run.
|
1170
|
+
# This can be a cron expression or a rate expression.
|
1171
|
+
# @return [String]
|
118
1172
|
#
|
119
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduleConfiguration AWS API Documentation
|
120
1174
|
#
|
121
|
-
class
|
122
|
-
:
|
123
|
-
:time_series_value,
|
124
|
-
:array_value,
|
125
|
-
:row_value,
|
126
|
-
:null_value)
|
1175
|
+
class ScheduleConfiguration < Struct.new(
|
1176
|
+
:schedule_expression)
|
127
1177
|
SENSITIVE = []
|
128
1178
|
include Aws::Structure
|
129
1179
|
end
|
130
1180
|
|
131
|
-
#
|
1181
|
+
# Scheduled Query
|
132
1182
|
#
|
133
|
-
#
|
1183
|
+
# @!attribute [rw] arn
|
1184
|
+
# The Amazon Resource Name.
|
1185
|
+
# @return [String]
|
134
1186
|
#
|
135
|
-
|
136
|
-
|
137
|
-
#
|
138
|
-
# An `Endpoints` object is returned when a `DescribeEndpoints` request
|
139
|
-
# is made.
|
140
|
-
# @return [Array<Types::Endpoint>]
|
1187
|
+
# @!attribute [rw] name
|
1188
|
+
# The name of the scheduled query.
|
1189
|
+
# @return [String]
|
141
1190
|
#
|
142
|
-
#
|
1191
|
+
# @!attribute [rw] creation_time
|
1192
|
+
# The creation time of the scheduled query.
|
1193
|
+
# @return [Time]
|
143
1194
|
#
|
144
|
-
|
145
|
-
|
1195
|
+
# @!attribute [rw] state
|
1196
|
+
# State of scheduled query.
|
1197
|
+
# @return [String]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] previous_invocation_time
|
1200
|
+
# The last time the scheduled query was run.
|
1201
|
+
# @return [Time]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] next_invocation_time
|
1204
|
+
# The next time the scheduled query is to be run.
|
1205
|
+
# @return [Time]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] error_report_configuration
|
1208
|
+
# Configuration for scheduled query error reporting.
|
1209
|
+
# @return [Types::ErrorReportConfiguration]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] target_destination
|
1212
|
+
# Target data source where final scheduled query result will be
|
1213
|
+
# written.
|
1214
|
+
# @return [Types::TargetDestination]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] last_run_status
|
1217
|
+
# Status of the last scheduled query run.
|
1218
|
+
# @return [String]
|
1219
|
+
#
|
1220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQuery AWS API Documentation
|
1221
|
+
#
|
1222
|
+
class ScheduledQuery < Struct.new(
|
1223
|
+
:arn,
|
1224
|
+
:name,
|
1225
|
+
:creation_time,
|
1226
|
+
:state,
|
1227
|
+
:previous_invocation_time,
|
1228
|
+
:next_invocation_time,
|
1229
|
+
:error_report_configuration,
|
1230
|
+
:target_destination,
|
1231
|
+
:last_run_status)
|
146
1232
|
SENSITIVE = []
|
147
1233
|
include Aws::Structure
|
148
1234
|
end
|
149
1235
|
|
150
|
-
#
|
151
|
-
# agaisnt, as well as the TTL for that endpoint.
|
1236
|
+
# Structure that describes scheduled query.
|
152
1237
|
#
|
153
|
-
# @!attribute [rw]
|
154
|
-
#
|
1238
|
+
# @!attribute [rw] arn
|
1239
|
+
# Scheduled query ARN.
|
155
1240
|
# @return [String]
|
156
1241
|
#
|
157
|
-
# @!attribute [rw]
|
158
|
-
#
|
159
|
-
# @return [
|
1242
|
+
# @!attribute [rw] name
|
1243
|
+
# Name of the scheduled query.
|
1244
|
+
# @return [String]
|
160
1245
|
#
|
161
|
-
#
|
1246
|
+
# @!attribute [rw] query_string
|
1247
|
+
# The query to be run.
|
1248
|
+
# @return [String]
|
162
1249
|
#
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
1250
|
+
# @!attribute [rw] creation_time
|
1251
|
+
# Creation time of the scheduled query.
|
1252
|
+
# @return [Time]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] state
|
1255
|
+
# State of the scheduled query.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] previous_invocation_time
|
1259
|
+
# Last time the query was run.
|
1260
|
+
# @return [Time]
|
1261
|
+
#
|
1262
|
+
# @!attribute [rw] next_invocation_time
|
1263
|
+
# The next time the scheduled query is scheduled to run.
|
1264
|
+
# @return [Time]
|
1265
|
+
#
|
1266
|
+
# @!attribute [rw] schedule_configuration
|
1267
|
+
# Schedule configuration.
|
1268
|
+
# @return [Types::ScheduleConfiguration]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] notification_configuration
|
1271
|
+
# Notification configuration.
|
1272
|
+
# @return [Types::NotificationConfiguration]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] target_configuration
|
1275
|
+
# Scheduled query target store configuration.
|
1276
|
+
# @return [Types::TargetConfiguration]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] scheduled_query_execution_role_arn
|
1279
|
+
# IAM role that Timestream uses to run the schedule query.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] kms_key_id
|
1283
|
+
# A customer provided KMS key used to encrypt the scheduled query
|
1284
|
+
# resource.
|
1285
|
+
# @return [String]
|
1286
|
+
#
|
1287
|
+
# @!attribute [rw] error_report_configuration
|
1288
|
+
# Error-reporting configuration for the scheduled query.
|
1289
|
+
# @return [Types::ErrorReportConfiguration]
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] last_run_summary
|
1292
|
+
# Runtime summary for the last scheduled query run.
|
1293
|
+
# @return [Types::ScheduledQueryRunSummary]
|
1294
|
+
#
|
1295
|
+
# @!attribute [rw] recently_failed_runs
|
1296
|
+
# Runtime summary for the last five failed scheduled query runs.
|
1297
|
+
# @return [Array<Types::ScheduledQueryRunSummary>]
|
1298
|
+
#
|
1299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQueryDescription AWS API Documentation
|
1300
|
+
#
|
1301
|
+
class ScheduledQueryDescription < Struct.new(
|
1302
|
+
:arn,
|
1303
|
+
:name,
|
1304
|
+
:query_string,
|
1305
|
+
:creation_time,
|
1306
|
+
:state,
|
1307
|
+
:previous_invocation_time,
|
1308
|
+
:next_invocation_time,
|
1309
|
+
:schedule_configuration,
|
1310
|
+
:notification_configuration,
|
1311
|
+
:target_configuration,
|
1312
|
+
:scheduled_query_execution_role_arn,
|
1313
|
+
:kms_key_id,
|
1314
|
+
:error_report_configuration,
|
1315
|
+
:last_run_summary,
|
1316
|
+
:recently_failed_runs)
|
1317
|
+
SENSITIVE = [:query_string]
|
167
1318
|
include Aws::Structure
|
168
1319
|
end
|
169
1320
|
|
170
|
-
#
|
171
|
-
# internal server error.
|
1321
|
+
# Run summary for the scheduled query
|
172
1322
|
#
|
173
|
-
# @!attribute [rw]
|
1323
|
+
# @!attribute [rw] invocation_time
|
1324
|
+
# InvocationTime for this run. This is the time at which the query is
|
1325
|
+
# scheduled to run. Parameter `@scheduled_runtime` can be used in the
|
1326
|
+
# query to get the value.
|
1327
|
+
# @return [Time]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] trigger_time
|
1330
|
+
# The actual time when the query was run.
|
1331
|
+
# @return [Time]
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] run_status
|
1334
|
+
# The status of a scheduled query run.
|
174
1335
|
# @return [String]
|
175
1336
|
#
|
176
|
-
#
|
1337
|
+
# @!attribute [rw] execution_stats
|
1338
|
+
# Runtime statistics for a scheduled run.
|
1339
|
+
# @return [Types::ExecutionStats]
|
177
1340
|
#
|
178
|
-
|
179
|
-
|
1341
|
+
# @!attribute [rw] error_report_location
|
1342
|
+
# S3 location for error report.
|
1343
|
+
# @return [Types::ErrorReportLocation]
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] failure_reason
|
1346
|
+
# Error message for the scheduled query in case of failure. You might
|
1347
|
+
# have to look at the error report to get more detailed error reasons.
|
1348
|
+
# @return [String]
|
1349
|
+
#
|
1350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ScheduledQueryRunSummary AWS API Documentation
|
1351
|
+
#
|
1352
|
+
class ScheduledQueryRunSummary < Struct.new(
|
1353
|
+
:invocation_time,
|
1354
|
+
:trigger_time,
|
1355
|
+
:run_status,
|
1356
|
+
:execution_stats,
|
1357
|
+
:error_report_location,
|
1358
|
+
:failure_reason)
|
180
1359
|
SENSITIVE = []
|
181
1360
|
include Aws::Structure
|
182
1361
|
end
|
183
1362
|
|
184
|
-
#
|
1363
|
+
# Details of the column that is returned by the query.
|
185
1364
|
#
|
186
|
-
# @!attribute [rw]
|
1365
|
+
# @!attribute [rw] name
|
1366
|
+
# Name of the column.
|
187
1367
|
# @return [String]
|
188
1368
|
#
|
189
|
-
#
|
1369
|
+
# @!attribute [rw] type
|
1370
|
+
# Contains the data type of a column in a query result set. The data
|
1371
|
+
# type can be scalar or complex. The supported scalar data types are
|
1372
|
+
# integers, Boolean, string, double, timestamp, date, time, and
|
1373
|
+
# intervals. The supported complex data types are arrays, rows, and
|
1374
|
+
# timeseries.
|
1375
|
+
# @return [Types::Type]
|
190
1376
|
#
|
191
|
-
|
192
|
-
|
1377
|
+
# @!attribute [rw] database_name
|
1378
|
+
# Database that has this column.
|
1379
|
+
# @return [String]
|
1380
|
+
#
|
1381
|
+
# @!attribute [rw] table_name
|
1382
|
+
# Table within the database that has this column.
|
1383
|
+
# @return [String]
|
1384
|
+
#
|
1385
|
+
# @!attribute [rw] aliased
|
1386
|
+
# True, if the column name was aliased by the query. False otherwise.
|
1387
|
+
# @return [Boolean]
|
1388
|
+
#
|
1389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/SelectColumn AWS API Documentation
|
1390
|
+
#
|
1391
|
+
class SelectColumn < Struct.new(
|
1392
|
+
:name,
|
1393
|
+
:type,
|
1394
|
+
:database_name,
|
1395
|
+
:table_name,
|
1396
|
+
:aliased)
|
193
1397
|
SENSITIVE = []
|
194
1398
|
include Aws::Structure
|
195
1399
|
end
|
196
1400
|
|
197
|
-
#
|
1401
|
+
# You have exceeded the service quota.
|
198
1402
|
#
|
199
1403
|
# @!attribute [rw] message
|
200
1404
|
# @return [String]
|
201
1405
|
#
|
202
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/
|
1406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ServiceQuotaExceededException AWS API Documentation
|
203
1407
|
#
|
204
|
-
class
|
1408
|
+
class ServiceQuotaExceededException < Struct.new(
|
205
1409
|
:message)
|
206
1410
|
SENSITIVE = []
|
207
1411
|
include Aws::Structure
|
208
1412
|
end
|
209
1413
|
|
210
|
-
#
|
1414
|
+
# Details on SNS that are required to send the notification.
|
1415
|
+
#
|
1416
|
+
# @note When making an API call, you may pass SnsConfiguration
|
211
1417
|
# data as a hash:
|
212
1418
|
#
|
213
1419
|
# {
|
214
|
-
#
|
215
|
-
# client_token: "ClientRequestToken",
|
216
|
-
# next_token: "String",
|
217
|
-
# max_rows: 1,
|
1420
|
+
# topic_arn: "AmazonResourceName", # required
|
218
1421
|
# }
|
219
1422
|
#
|
220
|
-
# @!attribute [rw]
|
221
|
-
#
|
1423
|
+
# @!attribute [rw] topic_arn
|
1424
|
+
# SNS topic ARN that the scheduled query status notifications will be
|
1425
|
+
# sent to.
|
222
1426
|
# @return [String]
|
223
1427
|
#
|
224
|
-
#
|
225
|
-
# Unique, case-sensitive string of up to 64 ASCII characters that you
|
226
|
-
# specify when you make a Query request. Providing a `ClientToken`
|
227
|
-
# makes the call to `Query` idempotent, meaning that multiple
|
228
|
-
# identical calls have the same effect as one single call.
|
229
|
-
#
|
230
|
-
# Your query request will fail in the following cases:
|
1428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/SnsConfiguration AWS API Documentation
|
231
1429
|
#
|
232
|
-
|
233
|
-
|
1430
|
+
class SnsConfiguration < Struct.new(
|
1431
|
+
:topic_arn)
|
1432
|
+
SENSITIVE = []
|
1433
|
+
include Aws::Structure
|
1434
|
+
end
|
1435
|
+
|
1436
|
+
# A tag is a label that you assign to a Timestream database and/or
|
1437
|
+
# table. Each tag consists of a key and an optional value, both of which
|
1438
|
+
# you define. Tags enable you to categorize databases and/or tables, for
|
1439
|
+
# example, by purpose, owner, or environment.
|
234
1440
|
#
|
235
|
-
#
|
236
|
-
#
|
1441
|
+
# @note When making an API call, you may pass Tag
|
1442
|
+
# data as a hash:
|
237
1443
|
#
|
238
|
-
#
|
239
|
-
#
|
1444
|
+
# {
|
1445
|
+
# key: "TagKey", # required
|
1446
|
+
# value: "TagValue", # required
|
1447
|
+
# }
|
240
1448
|
#
|
241
|
-
#
|
242
|
-
#
|
1449
|
+
# @!attribute [rw] key
|
1450
|
+
# The key of the tag. Tag keys are case sensitive.
|
243
1451
|
# @return [String]
|
244
1452
|
#
|
245
|
-
# @!attribute [rw]
|
246
|
-
#
|
1453
|
+
# @!attribute [rw] value
|
1454
|
+
# The value of the tag. Tag values are case sensitive and can be null.
|
247
1455
|
# @return [String]
|
248
1456
|
#
|
249
|
-
#
|
250
|
-
# The total number of rows to return in the output. If the total
|
251
|
-
# number of rows available is more than the value specified, a
|
252
|
-
# NextToken is provided in the command's output. To resume
|
253
|
-
# pagination, provide the NextToken value in the starting-token
|
254
|
-
# argument of a subsequent command.
|
255
|
-
# @return [Integer]
|
256
|
-
#
|
257
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/QueryRequest AWS API Documentation
|
1457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/Tag AWS API Documentation
|
258
1458
|
#
|
259
|
-
class
|
260
|
-
:
|
261
|
-
:
|
262
|
-
|
263
|
-
:max_rows)
|
264
|
-
SENSITIVE = [:query_string, :client_token]
|
1459
|
+
class Tag < Struct.new(
|
1460
|
+
:key,
|
1461
|
+
:value)
|
1462
|
+
SENSITIVE = []
|
265
1463
|
include Aws::Structure
|
266
1464
|
end
|
267
1465
|
|
268
|
-
#
|
269
|
-
#
|
270
|
-
# @return [String]
|
271
|
-
#
|
272
|
-
# @!attribute [rw] next_token
|
273
|
-
# A pagination token that can be used again on a `Query` call to get
|
274
|
-
# the next set of results.
|
275
|
-
# @return [String]
|
1466
|
+
# @note When making an API call, you may pass TagResourceRequest
|
1467
|
+
# data as a hash:
|
276
1468
|
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
1469
|
+
# {
|
1470
|
+
# resource_arn: "AmazonResourceName", # required
|
1471
|
+
# tags: [ # required
|
1472
|
+
# {
|
1473
|
+
# key: "TagKey", # required
|
1474
|
+
# value: "TagValue", # required
|
1475
|
+
# },
|
1476
|
+
# ],
|
1477
|
+
# }
|
280
1478
|
#
|
281
|
-
# @!attribute [rw]
|
282
|
-
#
|
283
|
-
#
|
1479
|
+
# @!attribute [rw] resource_arn
|
1480
|
+
# Identifies the Timestream resource to which tags should be added.
|
1481
|
+
# This value is an Amazon Resource Name (ARN).
|
1482
|
+
# @return [String]
|
284
1483
|
#
|
285
|
-
# @!attribute [rw]
|
286
|
-
#
|
287
|
-
#
|
288
|
-
# @return [Types::QueryStatus]
|
1484
|
+
# @!attribute [rw] tags
|
1485
|
+
# The tags to be assigned to the Timestream resource.
|
1486
|
+
# @return [Array<Types::Tag>]
|
289
1487
|
#
|
290
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/TagResourceRequest AWS API Documentation
|
291
1489
|
#
|
292
|
-
class
|
293
|
-
:
|
294
|
-
:
|
295
|
-
:rows,
|
296
|
-
:column_info,
|
297
|
-
:query_status)
|
1490
|
+
class TagResourceRequest < Struct.new(
|
1491
|
+
:resource_arn,
|
1492
|
+
:tags)
|
298
1493
|
SENSITIVE = []
|
299
1494
|
include Aws::Structure
|
300
1495
|
end
|
301
1496
|
|
302
|
-
#
|
303
|
-
# bytes scannned.
|
1497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/TagResourceResponse AWS API Documentation
|
304
1498
|
#
|
305
|
-
|
306
|
-
|
307
|
-
#
|
1499
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1500
|
+
|
1501
|
+
# Configuration used for writing the output of a query.
|
308
1502
|
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
# cumulative sum and represents the total amount of bytes scanned
|
312
|
-
# since the query was started.
|
313
|
-
# @return [Integer]
|
1503
|
+
# @note When making an API call, you may pass TargetConfiguration
|
1504
|
+
# data as a hash:
|
314
1505
|
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
1506
|
+
# {
|
1507
|
+
# timestream_configuration: { # required
|
1508
|
+
# database_name: "ResourceName", # required
|
1509
|
+
# table_name: "ResourceName", # required
|
1510
|
+
# time_column: "SchemaName", # required
|
1511
|
+
# dimension_mappings: [ # required
|
1512
|
+
# {
|
1513
|
+
# name: "SchemaName", # required
|
1514
|
+
# dimension_value_type: "VARCHAR", # required, accepts VARCHAR
|
1515
|
+
# },
|
1516
|
+
# ],
|
1517
|
+
# multi_measure_mappings: {
|
1518
|
+
# target_multi_measure_name: "SchemaName",
|
1519
|
+
# multi_measure_attribute_mappings: [ # required
|
1520
|
+
# {
|
1521
|
+
# source_column: "SchemaName", # required
|
1522
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
1523
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
1524
|
+
# },
|
1525
|
+
# ],
|
1526
|
+
# },
|
1527
|
+
# mixed_measure_mappings: [
|
1528
|
+
# {
|
1529
|
+
# measure_name: "SchemaName",
|
1530
|
+
# source_column: "SchemaName",
|
1531
|
+
# target_measure_name: "SchemaName",
|
1532
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR, MULTI
|
1533
|
+
# multi_measure_attribute_mappings: [
|
1534
|
+
# {
|
1535
|
+
# source_column: "SchemaName", # required
|
1536
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
1537
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
1538
|
+
# },
|
1539
|
+
# ],
|
1540
|
+
# },
|
1541
|
+
# ],
|
1542
|
+
# measure_name_column: "SchemaName",
|
1543
|
+
# },
|
1544
|
+
# }
|
322
1545
|
#
|
323
|
-
#
|
1546
|
+
# @!attribute [rw] timestream_configuration
|
1547
|
+
# Configuration needed to write data into the Timestream database and
|
1548
|
+
# table.
|
1549
|
+
# @return [Types::TimestreamConfiguration]
|
324
1550
|
#
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
:
|
1551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/TargetConfiguration AWS API Documentation
|
1552
|
+
#
|
1553
|
+
class TargetConfiguration < Struct.new(
|
1554
|
+
:timestream_configuration)
|
329
1555
|
SENSITIVE = []
|
330
1556
|
include Aws::Structure
|
331
1557
|
end
|
332
1558
|
|
333
|
-
#
|
1559
|
+
# Destination details to write data for a target data source. Current
|
1560
|
+
# supported data source is Timestream.
|
334
1561
|
#
|
335
|
-
# @!attribute [rw]
|
336
|
-
#
|
337
|
-
# @return [
|
1562
|
+
# @!attribute [rw] timestream_destination
|
1563
|
+
# Query result destination details for Timestream data source.
|
1564
|
+
# @return [Types::TimestreamDestination]
|
338
1565
|
#
|
339
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/
|
1566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/TargetDestination AWS API Documentation
|
340
1567
|
#
|
341
|
-
class
|
342
|
-
:
|
1568
|
+
class TargetDestination < Struct.new(
|
1569
|
+
:timestream_destination)
|
343
1570
|
SENSITIVE = []
|
344
1571
|
include Aws::Structure
|
345
1572
|
end
|
@@ -357,11 +1584,11 @@ module Aws::TimestreamQuery
|
|
357
1584
|
include Aws::Structure
|
358
1585
|
end
|
359
1586
|
|
360
|
-
# The timeseries
|
1587
|
+
# The timeseries data type represents the values of a measure over time.
|
361
1588
|
# A time series is an array of rows of timestamps and measure values,
|
362
1589
|
# with rows sorted in ascending order of time. A TimeSeriesDataPoint is
|
363
|
-
# a single data point in the
|
364
|
-
# measure value) in a
|
1590
|
+
# a single data point in the time series. It represents a tuple of
|
1591
|
+
# (time, measure value) in a time series.
|
365
1592
|
#
|
366
1593
|
# @!attribute [rw] time
|
367
1594
|
# The timestamp when the measure value was collected.
|
@@ -380,14 +1607,125 @@ module Aws::TimestreamQuery
|
|
380
1607
|
include Aws::Structure
|
381
1608
|
end
|
382
1609
|
|
1610
|
+
# Configuration to write data into Timestream database and table. This
|
1611
|
+
# configuration allows the user to map the query result select columns
|
1612
|
+
# into the destination table columns.
|
1613
|
+
#
|
1614
|
+
# @note When making an API call, you may pass TimestreamConfiguration
|
1615
|
+
# data as a hash:
|
1616
|
+
#
|
1617
|
+
# {
|
1618
|
+
# database_name: "ResourceName", # required
|
1619
|
+
# table_name: "ResourceName", # required
|
1620
|
+
# time_column: "SchemaName", # required
|
1621
|
+
# dimension_mappings: [ # required
|
1622
|
+
# {
|
1623
|
+
# name: "SchemaName", # required
|
1624
|
+
# dimension_value_type: "VARCHAR", # required, accepts VARCHAR
|
1625
|
+
# },
|
1626
|
+
# ],
|
1627
|
+
# multi_measure_mappings: {
|
1628
|
+
# target_multi_measure_name: "SchemaName",
|
1629
|
+
# multi_measure_attribute_mappings: [ # required
|
1630
|
+
# {
|
1631
|
+
# source_column: "SchemaName", # required
|
1632
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
1633
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
1634
|
+
# },
|
1635
|
+
# ],
|
1636
|
+
# },
|
1637
|
+
# mixed_measure_mappings: [
|
1638
|
+
# {
|
1639
|
+
# measure_name: "SchemaName",
|
1640
|
+
# source_column: "SchemaName",
|
1641
|
+
# target_measure_name: "SchemaName",
|
1642
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR, MULTI
|
1643
|
+
# multi_measure_attribute_mappings: [
|
1644
|
+
# {
|
1645
|
+
# source_column: "SchemaName", # required
|
1646
|
+
# target_multi_measure_attribute_name: "SchemaName",
|
1647
|
+
# measure_value_type: "BIGINT", # required, accepts BIGINT, BOOLEAN, DOUBLE, VARCHAR
|
1648
|
+
# },
|
1649
|
+
# ],
|
1650
|
+
# },
|
1651
|
+
# ],
|
1652
|
+
# measure_name_column: "SchemaName",
|
1653
|
+
# }
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] database_name
|
1656
|
+
# Name of Timestream database to which the query result will be
|
1657
|
+
# written.
|
1658
|
+
# @return [String]
|
1659
|
+
#
|
1660
|
+
# @!attribute [rw] table_name
|
1661
|
+
# Name of Timestream table that the query result will be written to.
|
1662
|
+
# The table should be within the same database that is provided in
|
1663
|
+
# Timestream configuration.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] time_column
|
1667
|
+
# Column from query result that should be used as the time column in
|
1668
|
+
# destination table. Column type for this should be TIMESTAMP.
|
1669
|
+
# @return [String]
|
1670
|
+
#
|
1671
|
+
# @!attribute [rw] dimension_mappings
|
1672
|
+
# This is to allow mapping column(s) from the query result to the
|
1673
|
+
# dimension in the destination table.
|
1674
|
+
# @return [Array<Types::DimensionMapping>]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] multi_measure_mappings
|
1677
|
+
# Multi-measure mappings.
|
1678
|
+
# @return [Types::MultiMeasureMappings]
|
1679
|
+
#
|
1680
|
+
# @!attribute [rw] mixed_measure_mappings
|
1681
|
+
# Specifies how to map measures to multi-measure records.
|
1682
|
+
# @return [Array<Types::MixedMeasureMapping>]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] measure_name_column
|
1685
|
+
# Name of the measure column.
|
1686
|
+
# @return [String]
|
1687
|
+
#
|
1688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/TimestreamConfiguration AWS API Documentation
|
1689
|
+
#
|
1690
|
+
class TimestreamConfiguration < Struct.new(
|
1691
|
+
:database_name,
|
1692
|
+
:table_name,
|
1693
|
+
:time_column,
|
1694
|
+
:dimension_mappings,
|
1695
|
+
:multi_measure_mappings,
|
1696
|
+
:mixed_measure_mappings,
|
1697
|
+
:measure_name_column)
|
1698
|
+
SENSITIVE = []
|
1699
|
+
include Aws::Structure
|
1700
|
+
end
|
1701
|
+
|
1702
|
+
# Destination for scheduled query.
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] database_name
|
1705
|
+
# Timestream database name.
|
1706
|
+
# @return [String]
|
1707
|
+
#
|
1708
|
+
# @!attribute [rw] table_name
|
1709
|
+
# Timestream table name.
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/TimestreamDestination AWS API Documentation
|
1713
|
+
#
|
1714
|
+
class TimestreamDestination < Struct.new(
|
1715
|
+
:database_name,
|
1716
|
+
:table_name)
|
1717
|
+
SENSITIVE = []
|
1718
|
+
include Aws::Structure
|
1719
|
+
end
|
1720
|
+
|
383
1721
|
# Contains the data type of a column in a query result set. The data
|
384
1722
|
# type can be scalar or complex. The supported scalar data types are
|
385
|
-
# integers,
|
1723
|
+
# integers, Boolean, string, double, timestamp, date, time, and
|
386
1724
|
# intervals. The supported complex data types are arrays, rows, and
|
387
1725
|
# timeseries.
|
388
1726
|
#
|
389
1727
|
# @!attribute [rw] scalar_type
|
390
|
-
# Indicates if the column is of type string, integer,
|
1728
|
+
# Indicates if the column is of type string, integer, Boolean, double,
|
391
1729
|
# timestamp, date, time.
|
392
1730
|
# @return [String]
|
393
1731
|
#
|
@@ -414,6 +1752,62 @@ module Aws::TimestreamQuery
|
|
414
1752
|
include Aws::Structure
|
415
1753
|
end
|
416
1754
|
|
1755
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
1756
|
+
# data as a hash:
|
1757
|
+
#
|
1758
|
+
# {
|
1759
|
+
# resource_arn: "AmazonResourceName", # required
|
1760
|
+
# tag_keys: ["TagKey"], # required
|
1761
|
+
# }
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] resource_arn
|
1764
|
+
# The Timestream resource that the tags will be removed from. This
|
1765
|
+
# value is an Amazon Resource Name (ARN).
|
1766
|
+
# @return [String]
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] tag_keys
|
1769
|
+
# A list of tags keys. Existing tags of the resource whose keys are
|
1770
|
+
# members of this list will be removed from the Timestream resource.
|
1771
|
+
# @return [Array<String>]
|
1772
|
+
#
|
1773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UntagResourceRequest AWS API Documentation
|
1774
|
+
#
|
1775
|
+
class UntagResourceRequest < Struct.new(
|
1776
|
+
:resource_arn,
|
1777
|
+
:tag_keys)
|
1778
|
+
SENSITIVE = []
|
1779
|
+
include Aws::Structure
|
1780
|
+
end
|
1781
|
+
|
1782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UntagResourceResponse AWS API Documentation
|
1783
|
+
#
|
1784
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1785
|
+
|
1786
|
+
# @note When making an API call, you may pass UpdateScheduledQueryRequest
|
1787
|
+
# data as a hash:
|
1788
|
+
#
|
1789
|
+
# {
|
1790
|
+
# scheduled_query_arn: "AmazonResourceName", # required
|
1791
|
+
# state: "ENABLED", # required, accepts ENABLED, DISABLED
|
1792
|
+
# }
|
1793
|
+
#
|
1794
|
+
# @!attribute [rw] scheduled_query_arn
|
1795
|
+
# ARN of the scheuled query.
|
1796
|
+
# @return [String]
|
1797
|
+
#
|
1798
|
+
# @!attribute [rw] state
|
1799
|
+
# State of the scheduled query.
|
1800
|
+
# @return [String]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/UpdateScheduledQueryRequest AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class UpdateScheduledQueryRequest < Struct.new(
|
1805
|
+
:scheduled_query_arn,
|
1806
|
+
:state)
|
1807
|
+
SENSITIVE = []
|
1808
|
+
include Aws::Structure
|
1809
|
+
end
|
1810
|
+
|
417
1811
|
# Invalid or malformed request.
|
418
1812
|
#
|
419
1813
|
# @!attribute [rw] message
|