aws-sdk-timestreamwrite 1.16.0 → 1.17.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamwrite/client.rb +351 -60
- data/lib/aws-sdk-timestreamwrite/client_api.rb +242 -0
- data/lib/aws-sdk-timestreamwrite/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-timestreamwrite/endpoints.rb +56 -0
- data/lib/aws-sdk-timestreamwrite/plugins/endpoints.rb +8 -0
- data/lib/aws-sdk-timestreamwrite/types.rb +620 -70
- data/lib/aws-sdk-timestreamwrite.rb +2 -2
- metadata +2 -2
@@ -23,6 +23,153 @@ module Aws::TimestreamWrite
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Details about the progress of a batch load task.
|
27
|
+
#
|
28
|
+
# @!attribute [rw] records_processed
|
29
|
+
# @return [Integer]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] records_ingested
|
32
|
+
# @return [Integer]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] parse_failures
|
35
|
+
# @return [Integer]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] record_ingestion_failures
|
38
|
+
# @return [Integer]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] file_failures
|
41
|
+
# @return [Integer]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] bytes_metered
|
44
|
+
# @return [Integer]
|
45
|
+
#
|
46
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/BatchLoadProgressReport AWS API Documentation
|
47
|
+
#
|
48
|
+
class BatchLoadProgressReport < Struct.new(
|
49
|
+
:records_processed,
|
50
|
+
:records_ingested,
|
51
|
+
:parse_failures,
|
52
|
+
:record_ingestion_failures,
|
53
|
+
:file_failures,
|
54
|
+
:bytes_metered)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
59
|
+
# Details about a batch load task.
|
60
|
+
#
|
61
|
+
# @!attribute [rw] task_id
|
62
|
+
# The ID of the batch load task.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] task_status
|
66
|
+
# Status of the batch load task.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] database_name
|
70
|
+
# Database name for the database into which a batch load task loads
|
71
|
+
# data.
|
72
|
+
# @return [String]
|
73
|
+
#
|
74
|
+
# @!attribute [rw] table_name
|
75
|
+
# Table name for the table into which a batch load task loads data.
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] creation_time
|
79
|
+
# The time when the Timestream batch load task was created.
|
80
|
+
# @return [Time]
|
81
|
+
#
|
82
|
+
# @!attribute [rw] last_updated_time
|
83
|
+
# The time when the Timestream batch load task was last updated.
|
84
|
+
# @return [Time]
|
85
|
+
#
|
86
|
+
# @!attribute [rw] resumable_until
|
87
|
+
# @return [Time]
|
88
|
+
#
|
89
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/BatchLoadTask AWS API Documentation
|
90
|
+
#
|
91
|
+
class BatchLoadTask < Struct.new(
|
92
|
+
:task_id,
|
93
|
+
:task_status,
|
94
|
+
:database_name,
|
95
|
+
:table_name,
|
96
|
+
:creation_time,
|
97
|
+
:last_updated_time,
|
98
|
+
:resumable_until)
|
99
|
+
SENSITIVE = []
|
100
|
+
include Aws::Structure
|
101
|
+
end
|
102
|
+
|
103
|
+
# Details about a batch load task.
|
104
|
+
#
|
105
|
+
# @!attribute [rw] task_id
|
106
|
+
# The ID of the batch load task.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] error_message
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] data_source_configuration
|
113
|
+
# Configuration details about the data source for a batch load task.
|
114
|
+
# @return [Types::DataSourceConfiguration]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] progress_report
|
117
|
+
# @return [Types::BatchLoadProgressReport]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] report_configuration
|
120
|
+
# Report configuration for a batch load task. This contains details
|
121
|
+
# about where error reports are stored.
|
122
|
+
# @return [Types::ReportConfiguration]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] data_model_configuration
|
125
|
+
# Data model configuration for a batch load task. This contains
|
126
|
+
# details about where a data model for a batch load task is stored.
|
127
|
+
# @return [Types::DataModelConfiguration]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] target_database_name
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @!attribute [rw] target_table_name
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] task_status
|
136
|
+
# Status of the batch load task.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] record_version
|
140
|
+
# @return [Integer]
|
141
|
+
#
|
142
|
+
# @!attribute [rw] creation_time
|
143
|
+
# The time when the Timestream batch load task was created.
|
144
|
+
# @return [Time]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] last_updated_time
|
147
|
+
# The time when the Timestream batch load task was last updated.
|
148
|
+
# @return [Time]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] resumable_until
|
151
|
+
# @return [Time]
|
152
|
+
#
|
153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/BatchLoadTaskDescription AWS API Documentation
|
154
|
+
#
|
155
|
+
class BatchLoadTaskDescription < Struct.new(
|
156
|
+
:task_id,
|
157
|
+
:error_message,
|
158
|
+
:data_source_configuration,
|
159
|
+
:progress_report,
|
160
|
+
:report_configuration,
|
161
|
+
:data_model_configuration,
|
162
|
+
:target_database_name,
|
163
|
+
:target_table_name,
|
164
|
+
:task_status,
|
165
|
+
:record_version,
|
166
|
+
:creation_time,
|
167
|
+
:last_updated_time,
|
168
|
+
:resumable_until)
|
169
|
+
SENSITIVE = []
|
170
|
+
include Aws::Structure
|
171
|
+
end
|
172
|
+
|
26
173
|
# Timestream was unable to process this request because it contains
|
27
174
|
# resource that already exists.
|
28
175
|
#
|
@@ -37,6 +184,61 @@ module Aws::TimestreamWrite
|
|
37
184
|
include Aws::Structure
|
38
185
|
end
|
39
186
|
|
187
|
+
# @!attribute [rw] client_token
|
188
|
+
# **A suitable default value is auto-generated.** You should normally
|
189
|
+
# not need to pass this option.
|
190
|
+
# @return [String]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] data_model_configuration
|
193
|
+
# @return [Types::DataModelConfiguration]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] data_source_configuration
|
196
|
+
# Defines configuration details about the data source for a batch load
|
197
|
+
# task.
|
198
|
+
# @return [Types::DataSourceConfiguration]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] report_configuration
|
201
|
+
# Report configuration for a batch load task. This contains details
|
202
|
+
# about where error reports are stored.
|
203
|
+
# @return [Types::ReportConfiguration]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] target_database_name
|
206
|
+
# Target Timestream database for a batch load task.
|
207
|
+
# @return [String]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] target_table_name
|
210
|
+
# Target Timestream table for a batch load task.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] record_version
|
214
|
+
# @return [Integer]
|
215
|
+
#
|
216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateBatchLoadTaskRequest AWS API Documentation
|
217
|
+
#
|
218
|
+
class CreateBatchLoadTaskRequest < Struct.new(
|
219
|
+
:client_token,
|
220
|
+
:data_model_configuration,
|
221
|
+
:data_source_configuration,
|
222
|
+
:report_configuration,
|
223
|
+
:target_database_name,
|
224
|
+
:target_table_name,
|
225
|
+
:record_version)
|
226
|
+
SENSITIVE = [:client_token]
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# @!attribute [rw] task_id
|
231
|
+
# The ID of the batch load task.
|
232
|
+
# @return [String]
|
233
|
+
#
|
234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateBatchLoadTaskResponse AWS API Documentation
|
235
|
+
#
|
236
|
+
class CreateBatchLoadTaskResponse < Struct.new(
|
237
|
+
:task_id)
|
238
|
+
SENSITIVE = []
|
239
|
+
include Aws::Structure
|
240
|
+
end
|
241
|
+
|
40
242
|
# @!attribute [rw] database_name
|
41
243
|
# The name of the Timestream database.
|
42
244
|
# @return [String]
|
@@ -44,8 +246,8 @@ module Aws::TimestreamWrite
|
|
44
246
|
# @!attribute [rw] kms_key_id
|
45
247
|
# The KMS key for the database. If the KMS key is not specified, the
|
46
248
|
# database will be encrypted with a Timestream managed KMS key located
|
47
|
-
# in your account.
|
48
|
-
#
|
249
|
+
# in your account. For more information, see [Amazon Web Services
|
250
|
+
# managed keys][1].
|
49
251
|
#
|
50
252
|
#
|
51
253
|
#
|
@@ -87,7 +289,7 @@ module Aws::TimestreamWrite
|
|
87
289
|
# @return [String]
|
88
290
|
#
|
89
291
|
# @!attribute [rw] retention_properties
|
90
|
-
# The duration for which your time
|
292
|
+
# The duration for which your time-series data must be stored in the
|
91
293
|
# memory store and the magnetic store.
|
92
294
|
# @return [Types::RetentionProperties]
|
93
295
|
#
|
@@ -124,7 +326,155 @@ module Aws::TimestreamWrite
|
|
124
326
|
include Aws::Structure
|
125
327
|
end
|
126
328
|
|
127
|
-
# A
|
329
|
+
# A delimited data format where the column separator can be a comma and
|
330
|
+
# the record separator is a newline character.
|
331
|
+
#
|
332
|
+
# @!attribute [rw] column_separator
|
333
|
+
# Column separator can be one of comma (','), pipe ('\|), semicolon
|
334
|
+
# (';'), tab('/t'), or blank space (' ').
|
335
|
+
# @return [String]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] escape_char
|
338
|
+
# Escape character can be one of
|
339
|
+
# @return [String]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] quote_char
|
342
|
+
# Can be single quote (') or double quote (").
|
343
|
+
# @return [String]
|
344
|
+
#
|
345
|
+
# @!attribute [rw] null_value
|
346
|
+
# Can be blank space (' ').
|
347
|
+
# @return [String]
|
348
|
+
#
|
349
|
+
# @!attribute [rw] trim_white_space
|
350
|
+
# Specifies to trim leading and trailing white space.
|
351
|
+
# @return [Boolean]
|
352
|
+
#
|
353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CsvConfiguration AWS API Documentation
|
354
|
+
#
|
355
|
+
class CsvConfiguration < Struct.new(
|
356
|
+
:column_separator,
|
357
|
+
:escape_char,
|
358
|
+
:quote_char,
|
359
|
+
:null_value,
|
360
|
+
:trim_white_space)
|
361
|
+
SENSITIVE = []
|
362
|
+
include Aws::Structure
|
363
|
+
end
|
364
|
+
|
365
|
+
# Data model for a batch load task.
|
366
|
+
#
|
367
|
+
# @!attribute [rw] time_column
|
368
|
+
# Source column to be mapped to time.
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] time_unit
|
372
|
+
# The granularity of the timestamp unit. It indicates if the time
|
373
|
+
# value is in seconds, milliseconds, nanoseconds, or other supported
|
374
|
+
# values. Default is `MILLISECONDS`.
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @!attribute [rw] dimension_mappings
|
378
|
+
# Source to target mappings for dimensions.
|
379
|
+
# @return [Array<Types::DimensionMapping>]
|
380
|
+
#
|
381
|
+
# @!attribute [rw] multi_measure_mappings
|
382
|
+
# Source to target mappings for multi-measure records.
|
383
|
+
# @return [Types::MultiMeasureMappings]
|
384
|
+
#
|
385
|
+
# @!attribute [rw] mixed_measure_mappings
|
386
|
+
# Source to target mappings for measures.
|
387
|
+
# @return [Array<Types::MixedMeasureMapping>]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] measure_name_column
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DataModel AWS API Documentation
|
393
|
+
#
|
394
|
+
class DataModel < Struct.new(
|
395
|
+
:time_column,
|
396
|
+
:time_unit,
|
397
|
+
:dimension_mappings,
|
398
|
+
:multi_measure_mappings,
|
399
|
+
:mixed_measure_mappings,
|
400
|
+
:measure_name_column)
|
401
|
+
SENSITIVE = []
|
402
|
+
include Aws::Structure
|
403
|
+
end
|
404
|
+
|
405
|
+
# @!attribute [rw] data_model
|
406
|
+
# @return [Types::DataModel]
|
407
|
+
#
|
408
|
+
# @!attribute [rw] data_model_s3_configuration
|
409
|
+
# @return [Types::DataModelS3Configuration]
|
410
|
+
#
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DataModelConfiguration AWS API Documentation
|
412
|
+
#
|
413
|
+
class DataModelConfiguration < Struct.new(
|
414
|
+
:data_model,
|
415
|
+
:data_model_s3_configuration)
|
416
|
+
SENSITIVE = []
|
417
|
+
include Aws::Structure
|
418
|
+
end
|
419
|
+
|
420
|
+
# @!attribute [rw] bucket_name
|
421
|
+
# @return [String]
|
422
|
+
#
|
423
|
+
# @!attribute [rw] object_key
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DataModelS3Configuration AWS API Documentation
|
427
|
+
#
|
428
|
+
class DataModelS3Configuration < Struct.new(
|
429
|
+
:bucket_name,
|
430
|
+
:object_key)
|
431
|
+
SENSITIVE = []
|
432
|
+
include Aws::Structure
|
433
|
+
end
|
434
|
+
|
435
|
+
# Defines configuration details about the data source.
|
436
|
+
#
|
437
|
+
# @!attribute [rw] data_source_s3_configuration
|
438
|
+
# Configuration of an S3 location for a file which contains data to
|
439
|
+
# load.
|
440
|
+
# @return [Types::DataSourceS3Configuration]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] csv_configuration
|
443
|
+
# A delimited data format where the column separator can be a comma
|
444
|
+
# and the record separator is a newline character.
|
445
|
+
# @return [Types::CsvConfiguration]
|
446
|
+
#
|
447
|
+
# @!attribute [rw] data_format
|
448
|
+
# This is currently CSV.
|
449
|
+
# @return [String]
|
450
|
+
#
|
451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DataSourceConfiguration AWS API Documentation
|
452
|
+
#
|
453
|
+
class DataSourceConfiguration < Struct.new(
|
454
|
+
:data_source_s3_configuration,
|
455
|
+
:csv_configuration,
|
456
|
+
:data_format)
|
457
|
+
SENSITIVE = []
|
458
|
+
include Aws::Structure
|
459
|
+
end
|
460
|
+
|
461
|
+
# @!attribute [rw] bucket_name
|
462
|
+
# The bucket name of the customer S3 bucket.
|
463
|
+
# @return [String]
|
464
|
+
#
|
465
|
+
# @!attribute [rw] object_key_prefix
|
466
|
+
# @return [String]
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DataSourceS3Configuration AWS API Documentation
|
469
|
+
#
|
470
|
+
class DataSourceS3Configuration < Struct.new(
|
471
|
+
:bucket_name,
|
472
|
+
:object_key_prefix)
|
473
|
+
SENSITIVE = []
|
474
|
+
include Aws::Structure
|
475
|
+
end
|
476
|
+
|
477
|
+
# A top-level container for a table. Databases and tables are the
|
128
478
|
# fundamental management concepts in Amazon Timestream. All tables in a
|
129
479
|
# database are encrypted with the same KMS key.
|
130
480
|
#
|
@@ -197,6 +547,30 @@ module Aws::TimestreamWrite
|
|
197
547
|
include Aws::Structure
|
198
548
|
end
|
199
549
|
|
550
|
+
# @!attribute [rw] task_id
|
551
|
+
# The ID of the batch load task.
|
552
|
+
# @return [String]
|
553
|
+
#
|
554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeBatchLoadTaskRequest AWS API Documentation
|
555
|
+
#
|
556
|
+
class DescribeBatchLoadTaskRequest < Struct.new(
|
557
|
+
:task_id)
|
558
|
+
SENSITIVE = []
|
559
|
+
include Aws::Structure
|
560
|
+
end
|
561
|
+
|
562
|
+
# @!attribute [rw] batch_load_task_description
|
563
|
+
# Description of the batch load task.
|
564
|
+
# @return [Types::BatchLoadTaskDescription]
|
565
|
+
#
|
566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeBatchLoadTaskResponse AWS API Documentation
|
567
|
+
#
|
568
|
+
class DescribeBatchLoadTaskResponse < Struct.new(
|
569
|
+
:batch_load_task_description)
|
570
|
+
SENSITIVE = []
|
571
|
+
include Aws::Structure
|
572
|
+
end
|
573
|
+
|
200
574
|
# @!attribute [rw] database_name
|
201
575
|
# The name of the Timestream database.
|
202
576
|
# @return [String]
|
@@ -269,16 +643,16 @@ module Aws::TimestreamWrite
|
|
269
643
|
include Aws::Structure
|
270
644
|
end
|
271
645
|
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
646
|
+
# Represents the metadata attributes of the time series. For example,
|
647
|
+
# the name and Availability Zone of an EC2 instance or the name of the
|
648
|
+
# manufacturer of a wind turbine are dimensions.
|
275
649
|
#
|
276
650
|
# @!attribute [rw] name
|
277
|
-
# Dimension represents the
|
278
|
-
#
|
279
|
-
#
|
651
|
+
# Dimension represents the metadata attributes of the time series. For
|
652
|
+
# example, the name and Availability Zone of an EC2 instance or the
|
653
|
+
# name of the manufacturer of a wind turbine are dimensions.
|
280
654
|
#
|
281
|
-
# For constraints on
|
655
|
+
# For constraints on dimension names, see [Naming Constraints][1].
|
282
656
|
#
|
283
657
|
#
|
284
658
|
#
|
@@ -290,7 +664,7 @@ module Aws::TimestreamWrite
|
|
290
664
|
# @return [String]
|
291
665
|
#
|
292
666
|
# @!attribute [rw] dimension_value_type
|
293
|
-
# The data type of the dimension for the time
|
667
|
+
# The data type of the dimension for the time-series data point.
|
294
668
|
# @return [String]
|
295
669
|
#
|
296
670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/Dimension AWS API Documentation
|
@@ -303,8 +677,23 @@ module Aws::TimestreamWrite
|
|
303
677
|
include Aws::Structure
|
304
678
|
end
|
305
679
|
|
680
|
+
# @!attribute [rw] source_column
|
681
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] destination_column
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DimensionMapping AWS API Documentation
|
687
|
+
#
|
688
|
+
class DimensionMapping < Struct.new(
|
689
|
+
:source_column,
|
690
|
+
:destination_column)
|
691
|
+
SENSITIVE = []
|
692
|
+
include Aws::Structure
|
693
|
+
end
|
694
|
+
|
306
695
|
# Represents an available endpoint against which to make API calls
|
307
|
-
#
|
696
|
+
# against, as well as the TTL for that endpoint.
|
308
697
|
#
|
309
698
|
# @!attribute [rw] address
|
310
699
|
# An endpoint address.
|
@@ -337,7 +726,7 @@ module Aws::TimestreamWrite
|
|
337
726
|
include Aws::Structure
|
338
727
|
end
|
339
728
|
|
340
|
-
# The requested endpoint was
|
729
|
+
# The requested endpoint was not valid.
|
341
730
|
#
|
342
731
|
# @!attribute [rw] message
|
343
732
|
# @return [String]
|
@@ -350,6 +739,50 @@ module Aws::TimestreamWrite
|
|
350
739
|
include Aws::Structure
|
351
740
|
end
|
352
741
|
|
742
|
+
# @!attribute [rw] next_token
|
743
|
+
# A token to specify where to start paginating. This is the NextToken
|
744
|
+
# from a previously truncated response.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] max_results
|
748
|
+
# The total number of items to return in the output. If the total
|
749
|
+
# number of items available is more than the value specified, a
|
750
|
+
# NextToken is provided in the output. To resume pagination, provide
|
751
|
+
# the NextToken value as argument of a subsequent API invocation.
|
752
|
+
# @return [Integer]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] task_status
|
755
|
+
# Status of the batch load task.
|
756
|
+
# @return [String]
|
757
|
+
#
|
758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListBatchLoadTasksRequest AWS API Documentation
|
759
|
+
#
|
760
|
+
class ListBatchLoadTasksRequest < Struct.new(
|
761
|
+
:next_token,
|
762
|
+
:max_results,
|
763
|
+
:task_status)
|
764
|
+
SENSITIVE = []
|
765
|
+
include Aws::Structure
|
766
|
+
end
|
767
|
+
|
768
|
+
# @!attribute [rw] next_token
|
769
|
+
# A token to specify where to start paginating. Provide the next
|
770
|
+
# ListBatchLoadTasksRequest.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] batch_load_tasks
|
774
|
+
# A list of batch load task details.
|
775
|
+
# @return [Array<Types::BatchLoadTask>]
|
776
|
+
#
|
777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListBatchLoadTasksResponse AWS API Documentation
|
778
|
+
#
|
779
|
+
class ListBatchLoadTasksResponse < Struct.new(
|
780
|
+
:next_token,
|
781
|
+
:batch_load_tasks)
|
782
|
+
SENSITIVE = []
|
783
|
+
include Aws::Structure
|
784
|
+
end
|
785
|
+
|
353
786
|
# @!attribute [rw] next_token
|
354
787
|
# The pagination token. To resume pagination, provide the NextToken
|
355
788
|
# value as argument of a subsequent API invocation.
|
@@ -495,19 +928,19 @@ module Aws::TimestreamWrite
|
|
495
928
|
include Aws::Structure
|
496
929
|
end
|
497
930
|
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
931
|
+
# Represents the data attribute of the time series. For example, the CPU
|
932
|
+
# utilization of an EC2 instance or the RPM of a wind turbine are
|
933
|
+
# measures. MeasureValue has both name and value.
|
501
934
|
#
|
502
935
|
# MeasureValue is only allowed for type `MULTI`. Using `MULTI` type, you
|
503
936
|
# can pass multiple data attributes associated with the same time series
|
504
937
|
# in a single record
|
505
938
|
#
|
506
939
|
# @!attribute [rw] name
|
507
|
-
#
|
940
|
+
# The name of the MeasureValue.
|
508
941
|
#
|
509
|
-
# For constraints on MeasureValue names,
|
510
|
-
#
|
942
|
+
# For constraints on MeasureValue names, see [ Naming Constraints][1]
|
943
|
+
# in the Amazon Timestream Developer Guide.
|
511
944
|
#
|
512
945
|
#
|
513
946
|
#
|
@@ -515,11 +948,11 @@ module Aws::TimestreamWrite
|
|
515
948
|
# @return [String]
|
516
949
|
#
|
517
950
|
# @!attribute [rw] value
|
518
|
-
#
|
951
|
+
# The value for the MeasureValue.
|
519
952
|
# @return [String]
|
520
953
|
#
|
521
954
|
# @!attribute [rw] type
|
522
|
-
# Contains the data type of the MeasureValue for the time
|
955
|
+
# Contains the data type of the MeasureValue for the time-series data
|
523
956
|
# point.
|
524
957
|
# @return [String]
|
525
958
|
#
|
@@ -533,16 +966,77 @@ module Aws::TimestreamWrite
|
|
533
966
|
include Aws::Structure
|
534
967
|
end
|
535
968
|
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
969
|
+
# @!attribute [rw] measure_name
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] source_column
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] target_measure_name
|
976
|
+
# @return [String]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] measure_value_type
|
979
|
+
# @return [String]
|
980
|
+
#
|
981
|
+
# @!attribute [rw] multi_measure_attribute_mappings
|
982
|
+
# @return [Array<Types::MultiMeasureAttributeMapping>]
|
983
|
+
#
|
984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/MixedMeasureMapping AWS API Documentation
|
985
|
+
#
|
986
|
+
class MixedMeasureMapping < Struct.new(
|
987
|
+
:measure_name,
|
988
|
+
:source_column,
|
989
|
+
:target_measure_name,
|
990
|
+
:measure_value_type,
|
991
|
+
:multi_measure_attribute_mappings)
|
992
|
+
SENSITIVE = []
|
993
|
+
include Aws::Structure
|
994
|
+
end
|
995
|
+
|
996
|
+
# @!attribute [rw] source_column
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] target_multi_measure_attribute_name
|
1000
|
+
# @return [String]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] measure_value_type
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/MultiMeasureAttributeMapping AWS API Documentation
|
1006
|
+
#
|
1007
|
+
class MultiMeasureAttributeMapping < Struct.new(
|
1008
|
+
:source_column,
|
1009
|
+
:target_multi_measure_attribute_name,
|
1010
|
+
:measure_value_type)
|
1011
|
+
SENSITIVE = []
|
1012
|
+
include Aws::Structure
|
1013
|
+
end
|
1014
|
+
|
1015
|
+
# @!attribute [rw] target_multi_measure_name
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] multi_measure_attribute_mappings
|
1019
|
+
# @return [Array<Types::MultiMeasureAttributeMapping>]
|
1020
|
+
#
|
1021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/MultiMeasureMappings AWS API Documentation
|
1022
|
+
#
|
1023
|
+
class MultiMeasureMappings < Struct.new(
|
1024
|
+
:target_multi_measure_name,
|
1025
|
+
:multi_measure_attribute_mappings)
|
1026
|
+
SENSITIVE = []
|
1027
|
+
include Aws::Structure
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# Represents a time-series data point being written into Timestream.
|
1031
|
+
# Each record contains an array of dimensions. Dimensions represent the
|
1032
|
+
# metadata attributes of a time-series data point, such as the instance
|
1033
|
+
# name or Availability Zone of an EC2 instance. A record also contains
|
1034
|
+
# the measure name, which is the name of the measure being collected
|
1035
|
+
# (for example, the CPU utilization of an EC2 instance). Additionally, a
|
1036
|
+
# record contains the measure value and the value type, which is the
|
1037
|
+
# data type of the measure value. Also, the record contains the
|
1038
|
+
# timestamp of when the measure was collected and the timestamp unit,
|
1039
|
+
# which represents the granularity of the timestamp.
|
546
1040
|
#
|
547
1041
|
# Records have a `Version` field, which is a 64-bit `long` that you can
|
548
1042
|
# use for updating data points. Writes of a duplicate record with the
|
@@ -553,7 +1047,7 @@ module Aws::TimestreamWrite
|
|
553
1047
|
# `Version` field.
|
554
1048
|
#
|
555
1049
|
# @!attribute [rw] dimensions
|
556
|
-
# Contains the list of dimensions for time
|
1050
|
+
# Contains the list of dimensions for time-series data points.
|
557
1051
|
# @return [Array<Types::Dimension>]
|
558
1052
|
#
|
559
1053
|
# @!attribute [rw] measure_name
|
@@ -563,11 +1057,11 @@ module Aws::TimestreamWrite
|
|
563
1057
|
# @return [String]
|
564
1058
|
#
|
565
1059
|
# @!attribute [rw] measure_value
|
566
|
-
# Contains the measure value for the time
|
1060
|
+
# Contains the measure value for the time-series data point.
|
567
1061
|
# @return [String]
|
568
1062
|
#
|
569
1063
|
# @!attribute [rw] measure_value_type
|
570
|
-
# Contains the data type of the measure value for the time
|
1064
|
+
# Contains the data type of the measure value for the time-series data
|
571
1065
|
# point. Default type is `DOUBLE`.
|
572
1066
|
# @return [String]
|
573
1067
|
#
|
@@ -580,7 +1074,7 @@ module Aws::TimestreamWrite
|
|
580
1074
|
#
|
581
1075
|
# @!attribute [rw] time_unit
|
582
1076
|
# The granularity of the timestamp unit. It indicates if the time
|
583
|
-
# value is in seconds, milliseconds, nanoseconds or other supported
|
1077
|
+
# value is in seconds, milliseconds, nanoseconds, or other supported
|
584
1078
|
# values. Default is `MILLISECONDS`.
|
585
1079
|
# @return [String]
|
586
1080
|
#
|
@@ -588,7 +1082,7 @@ module Aws::TimestreamWrite
|
|
588
1082
|
# 64-bit attribute used for record updates. Write requests for
|
589
1083
|
# duplicate data with a higher version number will update the existing
|
590
1084
|
# measure value and version. In cases where the measure value is the
|
591
|
-
# same, `Version` will still be updated
|
1085
|
+
# same, `Version` will still be updated. Default value is `1`.
|
592
1086
|
#
|
593
1087
|
# <note markdown="1"> `Version` must be `1` or greater, or you will receive a
|
594
1088
|
# `ValidationException` error.
|
@@ -597,10 +1091,10 @@ module Aws::TimestreamWrite
|
|
597
1091
|
# @return [Integer]
|
598
1092
|
#
|
599
1093
|
# @!attribute [rw] measure_values
|
600
|
-
# Contains the list of MeasureValue for time
|
1094
|
+
# Contains the list of MeasureValue for time-series data points.
|
601
1095
|
#
|
602
1096
|
# This is only allowed for type `MULTI`. For scalar values, use
|
603
|
-
# `MeasureValue` attribute of the
|
1097
|
+
# `MeasureValue` attribute of the record directly.
|
604
1098
|
# @return [Array<Types::MeasureValue>]
|
605
1099
|
#
|
606
1100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/Record AWS API Documentation
|
@@ -642,9 +1136,9 @@ module Aws::TimestreamWrite
|
|
642
1136
|
include Aws::Structure
|
643
1137
|
end
|
644
1138
|
|
645
|
-
#
|
646
|
-
# data validation issues that must be resolved
|
647
|
-
# series data into the system.
|
1139
|
+
# Represents records that were not successfully inserted into Timestream
|
1140
|
+
# due to data validation issues that must be resolved before reinserting
|
1141
|
+
# time-series data into the system.
|
648
1142
|
#
|
649
1143
|
# @!attribute [rw] record_index
|
650
1144
|
# The index of the record in the input request for WriteRecords.
|
@@ -660,7 +1154,7 @@ module Aws::TimestreamWrite
|
|
660
1154
|
#
|
661
1155
|
# * Measure values are different
|
662
1156
|
#
|
663
|
-
# * Version is not present in the request *or* the value of version
|
1157
|
+
# * Version is not present in the request, *or* the value of version
|
664
1158
|
# in the new record is equal to or lower than the existing value
|
665
1159
|
#
|
666
1160
|
# If Timestream rejects data for this case, the `ExistingVersion`
|
@@ -670,7 +1164,7 @@ module Aws::TimestreamWrite
|
|
670
1164
|
# `ExistingVersion`.
|
671
1165
|
#
|
672
1166
|
# * Records with timestamps that lie outside the retention duration of
|
673
|
-
# the memory store
|
1167
|
+
# the memory store.
|
674
1168
|
#
|
675
1169
|
# <note markdown="1"> When the retention window is updated, you will receive a
|
676
1170
|
# `RejectedRecords` exception if you immediately try to ingest data
|
@@ -728,13 +1222,13 @@ module Aws::TimestreamWrite
|
|
728
1222
|
# `ExistingVersion`.
|
729
1223
|
#
|
730
1224
|
# * Records with timestamps that lie outside the retention duration of
|
731
|
-
# the memory store
|
1225
|
+
# the memory store.
|
732
1226
|
#
|
733
1227
|
# * Records with dimensions or measures that exceed the Timestream
|
734
1228
|
# defined limits.
|
735
1229
|
#
|
736
|
-
# For more information, see [Quotas][1] in the Timestream
|
737
|
-
# Guide.
|
1230
|
+
# For more information, see [Quotas][1] in the Amazon Timestream
|
1231
|
+
# Developer Guide.
|
738
1232
|
#
|
739
1233
|
#
|
740
1234
|
#
|
@@ -755,6 +1249,45 @@ module Aws::TimestreamWrite
|
|
755
1249
|
include Aws::Structure
|
756
1250
|
end
|
757
1251
|
|
1252
|
+
# Report configuration for a batch load task. This contains details
|
1253
|
+
# about where error reports are stored.
|
1254
|
+
#
|
1255
|
+
# @!attribute [rw] report_s3_configuration
|
1256
|
+
# Configuration of an S3 location to write error reports and events
|
1257
|
+
# for a batch load.
|
1258
|
+
# @return [Types::ReportS3Configuration]
|
1259
|
+
#
|
1260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ReportConfiguration AWS API Documentation
|
1261
|
+
#
|
1262
|
+
class ReportConfiguration < Struct.new(
|
1263
|
+
:report_s3_configuration)
|
1264
|
+
SENSITIVE = []
|
1265
|
+
include Aws::Structure
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# @!attribute [rw] bucket_name
|
1269
|
+
# @return [String]
|
1270
|
+
#
|
1271
|
+
# @!attribute [rw] object_key_prefix
|
1272
|
+
# @return [String]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] encryption_option
|
1275
|
+
# @return [String]
|
1276
|
+
#
|
1277
|
+
# @!attribute [rw] kms_key_id
|
1278
|
+
# @return [String]
|
1279
|
+
#
|
1280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ReportS3Configuration AWS API Documentation
|
1281
|
+
#
|
1282
|
+
class ReportS3Configuration < Struct.new(
|
1283
|
+
:bucket_name,
|
1284
|
+
:object_key_prefix,
|
1285
|
+
:encryption_option,
|
1286
|
+
:kms_key_id)
|
1287
|
+
SENSITIVE = []
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
758
1291
|
# The operation tried to access a nonexistent resource. The resource
|
759
1292
|
# might not be specified correctly, or its status might not be ACTIVE.
|
760
1293
|
#
|
@@ -769,7 +1302,23 @@ module Aws::TimestreamWrite
|
|
769
1302
|
include Aws::Structure
|
770
1303
|
end
|
771
1304
|
|
772
|
-
#
|
1305
|
+
# @!attribute [rw] task_id
|
1306
|
+
# The ID of the batch load task to resume.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ResumeBatchLoadTaskRequest AWS API Documentation
|
1310
|
+
#
|
1311
|
+
class ResumeBatchLoadTaskRequest < Struct.new(
|
1312
|
+
:task_id)
|
1313
|
+
SENSITIVE = []
|
1314
|
+
include Aws::Structure
|
1315
|
+
end
|
1316
|
+
|
1317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ResumeBatchLoadTaskResponse AWS API Documentation
|
1318
|
+
#
|
1319
|
+
class ResumeBatchLoadTaskResponse < Aws::EmptyStructure; end
|
1320
|
+
|
1321
|
+
# Retention properties contain the duration for which your time-series
|
773
1322
|
# data must be stored in the magnetic store and the memory store.
|
774
1323
|
#
|
775
1324
|
# @!attribute [rw] memory_store_retention_period_in_hours
|
@@ -789,24 +1338,25 @@ module Aws::TimestreamWrite
|
|
789
1338
|
include Aws::Structure
|
790
1339
|
end
|
791
1340
|
|
792
|
-
#
|
1341
|
+
# The configuration that specifies an S3 location.
|
793
1342
|
#
|
794
1343
|
# @!attribute [rw] bucket_name
|
795
|
-
#
|
1344
|
+
# The bucket name of the customer S3 bucket.
|
796
1345
|
# @return [String]
|
797
1346
|
#
|
798
1347
|
# @!attribute [rw] object_key_prefix
|
799
|
-
#
|
1348
|
+
# The object key preview for the customer S3 location.
|
800
1349
|
# @return [String]
|
801
1350
|
#
|
802
1351
|
# @!attribute [rw] encryption_option
|
803
|
-
#
|
804
|
-
# server
|
1352
|
+
# The encryption option for the customer S3 location. Options are S3
|
1353
|
+
# server-side encryption with an S3 managed key or Amazon Web Services
|
1354
|
+
# managed key.
|
805
1355
|
# @return [String]
|
806
1356
|
#
|
807
1357
|
# @!attribute [rw] kms_key_id
|
808
|
-
# KMS key
|
809
|
-
# managed key.
|
1358
|
+
# The KMS key ID for the customer S3 location when encrypting with an
|
1359
|
+
# Amazon Web Services managed key.
|
810
1360
|
# @return [String]
|
811
1361
|
#
|
812
1362
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/S3Configuration AWS API Documentation
|
@@ -820,7 +1370,7 @@ module Aws::TimestreamWrite
|
|
820
1370
|
include Aws::Structure
|
821
1371
|
end
|
822
1372
|
|
823
|
-
#
|
1373
|
+
# The instance quota of resource exceeded for this account.
|
824
1374
|
#
|
825
1375
|
# @!attribute [rw] message
|
826
1376
|
# @return [String]
|
@@ -833,8 +1383,8 @@ module Aws::TimestreamWrite
|
|
833
1383
|
include Aws::Structure
|
834
1384
|
end
|
835
1385
|
|
836
|
-
#
|
837
|
-
#
|
1386
|
+
# Represents a database table in Timestream. Tables contain one or more
|
1387
|
+
# related time series. You can modify the retention duration of the
|
838
1388
|
# memory store and the magnetic store for a table.
|
839
1389
|
#
|
840
1390
|
# @!attribute [rw] arn
|
@@ -891,7 +1441,7 @@ module Aws::TimestreamWrite
|
|
891
1441
|
|
892
1442
|
# A tag is a label that you assign to a Timestream database and/or
|
893
1443
|
# table. Each tag consists of a key and an optional value, both of which
|
894
|
-
# you define.
|
1444
|
+
# you define. With tags, you can categorize databases and/or tables, for
|
895
1445
|
# example, by purpose, owner, or environment.
|
896
1446
|
#
|
897
1447
|
# @!attribute [rw] key
|
@@ -933,8 +1483,8 @@ module Aws::TimestreamWrite
|
|
933
1483
|
#
|
934
1484
|
class TagResourceResponse < Aws::EmptyStructure; end
|
935
1485
|
|
936
|
-
# Too many requests were made by a user
|
937
|
-
# request was throttled.
|
1486
|
+
# Too many requests were made by a user and they exceeded the service
|
1487
|
+
# quotas. The request was throttled.
|
938
1488
|
#
|
939
1489
|
# @!attribute [rw] message
|
940
1490
|
# @return [String]
|
@@ -1002,7 +1552,7 @@ module Aws::TimestreamWrite
|
|
1002
1552
|
end
|
1003
1553
|
|
1004
1554
|
# @!attribute [rw] database
|
1005
|
-
# A top
|
1555
|
+
# A top-level container for a table. Databases and tables are the
|
1006
1556
|
# fundamental management concepts in Amazon Timestream. All tables in
|
1007
1557
|
# a database are encrypted with the same KMS key.
|
1008
1558
|
# @return [Types::Database]
|
@@ -1055,7 +1605,7 @@ module Aws::TimestreamWrite
|
|
1055
1605
|
include Aws::Structure
|
1056
1606
|
end
|
1057
1607
|
|
1058
|
-
#
|
1608
|
+
# An invalid or malformed request.
|
1059
1609
|
#
|
1060
1610
|
# @!attribute [rw] message
|
1061
1611
|
# @return [String]
|
@@ -1077,18 +1627,18 @@ module Aws::TimestreamWrite
|
|
1077
1627
|
# @return [String]
|
1078
1628
|
#
|
1079
1629
|
# @!attribute [rw] common_attributes
|
1080
|
-
# A record
|
1081
|
-
# attributes shared across all the records in the request. The
|
1082
|
-
# and dimension attributes specified will be merged with the
|
1083
|
-
# and dimension attributes in the records object when the data
|
1084
|
-
# written into Timestream. Dimensions may not overlap, or a
|
1630
|
+
# A record that contains the common measure, dimension, time, and
|
1631
|
+
# version attributes shared across all the records in the request. The
|
1632
|
+
# measure and dimension attributes specified will be merged with the
|
1633
|
+
# measure and dimension attributes in the records object when the data
|
1634
|
+
# is written into Timestream. Dimensions may not overlap, or a
|
1085
1635
|
# `ValidationException` will be thrown. In other words, a record must
|
1086
1636
|
# contain dimensions with unique names.
|
1087
1637
|
# @return [Types::Record]
|
1088
1638
|
#
|
1089
1639
|
# @!attribute [rw] records
|
1090
|
-
# An array of records
|
1091
|
-
# and version attributes for each time
|
1640
|
+
# An array of records that contain the unique measure, dimension,
|
1641
|
+
# time, and version attributes for each time-series data point.
|
1092
1642
|
# @return [Array<Types::Record>]
|
1093
1643
|
#
|
1094
1644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecordsRequest AWS API Documentation
|