aws-sdk-timestreamwrite 1.15.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 +12 -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 +38 -95
- 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 +613 -363
- 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,20 +184,61 @@ module Aws::TimestreamWrite
|
|
37
184
|
include Aws::Structure
|
38
185
|
end
|
39
186
|
|
40
|
-
#
|
41
|
-
#
|
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]
|
42
199
|
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
# ],
|
52
|
-
# }
|
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]
|
53
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
|
+
|
54
242
|
# @!attribute [rw] database_name
|
55
243
|
# The name of the Timestream database.
|
56
244
|
# @return [String]
|
@@ -58,8 +246,8 @@ module Aws::TimestreamWrite
|
|
58
246
|
# @!attribute [rw] kms_key_id
|
59
247
|
# The KMS key for the database. If the KMS key is not specified, the
|
60
248
|
# database will be encrypted with a Timestream managed KMS key located
|
61
|
-
# in your account.
|
62
|
-
#
|
249
|
+
# in your account. For more information, see [Amazon Web Services
|
250
|
+
# managed keys][1].
|
63
251
|
#
|
64
252
|
#
|
65
253
|
#
|
@@ -92,35 +280,6 @@ module Aws::TimestreamWrite
|
|
92
280
|
include Aws::Structure
|
93
281
|
end
|
94
282
|
|
95
|
-
# @note When making an API call, you may pass CreateTableRequest
|
96
|
-
# data as a hash:
|
97
|
-
#
|
98
|
-
# {
|
99
|
-
# database_name: "ResourceCreateAPIName", # required
|
100
|
-
# table_name: "ResourceCreateAPIName", # required
|
101
|
-
# retention_properties: {
|
102
|
-
# memory_store_retention_period_in_hours: 1, # required
|
103
|
-
# magnetic_store_retention_period_in_days: 1, # required
|
104
|
-
# },
|
105
|
-
# tags: [
|
106
|
-
# {
|
107
|
-
# key: "TagKey", # required
|
108
|
-
# value: "TagValue", # required
|
109
|
-
# },
|
110
|
-
# ],
|
111
|
-
# magnetic_store_write_properties: {
|
112
|
-
# enable_magnetic_store_writes: false, # required
|
113
|
-
# magnetic_store_rejected_data_location: {
|
114
|
-
# s3_configuration: {
|
115
|
-
# bucket_name: "S3BucketName",
|
116
|
-
# object_key_prefix: "S3ObjectKeyPrefix",
|
117
|
-
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
118
|
-
# kms_key_id: "StringValue2048",
|
119
|
-
# },
|
120
|
-
# },
|
121
|
-
# },
|
122
|
-
# }
|
123
|
-
#
|
124
283
|
# @!attribute [rw] database_name
|
125
284
|
# The name of the Timestream database.
|
126
285
|
# @return [String]
|
@@ -130,7 +289,7 @@ module Aws::TimestreamWrite
|
|
130
289
|
# @return [String]
|
131
290
|
#
|
132
291
|
# @!attribute [rw] retention_properties
|
133
|
-
# The duration for which your time
|
292
|
+
# The duration for which your time-series data must be stored in the
|
134
293
|
# memory store and the magnetic store.
|
135
294
|
# @return [Types::RetentionProperties]
|
136
295
|
#
|
@@ -167,7 +326,155 @@ module Aws::TimestreamWrite
|
|
167
326
|
include Aws::Structure
|
168
327
|
end
|
169
328
|
|
170
|
-
# 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
|
171
478
|
# fundamental management concepts in Amazon Timestream. All tables in a
|
172
479
|
# database are encrypted with the same KMS key.
|
173
480
|
#
|
@@ -210,13 +517,6 @@ module Aws::TimestreamWrite
|
|
210
517
|
include Aws::Structure
|
211
518
|
end
|
212
519
|
|
213
|
-
# @note When making an API call, you may pass DeleteDatabaseRequest
|
214
|
-
# data as a hash:
|
215
|
-
#
|
216
|
-
# {
|
217
|
-
# database_name: "ResourceName", # required
|
218
|
-
# }
|
219
|
-
#
|
220
520
|
# @!attribute [rw] database_name
|
221
521
|
# The name of the Timestream database to be deleted.
|
222
522
|
# @return [String]
|
@@ -229,14 +529,6 @@ module Aws::TimestreamWrite
|
|
229
529
|
include Aws::Structure
|
230
530
|
end
|
231
531
|
|
232
|
-
# @note When making an API call, you may pass DeleteTableRequest
|
233
|
-
# data as a hash:
|
234
|
-
#
|
235
|
-
# {
|
236
|
-
# database_name: "ResourceName", # required
|
237
|
-
# table_name: "ResourceName", # required
|
238
|
-
# }
|
239
|
-
#
|
240
532
|
# @!attribute [rw] database_name
|
241
533
|
# The name of the database where the Timestream database is to be
|
242
534
|
# deleted.
|
@@ -255,13 +547,30 @@ module Aws::TimestreamWrite
|
|
255
547
|
include Aws::Structure
|
256
548
|
end
|
257
549
|
|
258
|
-
#
|
259
|
-
#
|
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]
|
260
565
|
#
|
261
|
-
#
|
262
|
-
# database_name: "ResourceName", # required
|
263
|
-
# }
|
566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeBatchLoadTaskResponse AWS API Documentation
|
264
567
|
#
|
568
|
+
class DescribeBatchLoadTaskResponse < Struct.new(
|
569
|
+
:batch_load_task_description)
|
570
|
+
SENSITIVE = []
|
571
|
+
include Aws::Structure
|
572
|
+
end
|
573
|
+
|
265
574
|
# @!attribute [rw] database_name
|
266
575
|
# The name of the Timestream database.
|
267
576
|
# @return [String]
|
@@ -305,14 +614,6 @@ module Aws::TimestreamWrite
|
|
305
614
|
include Aws::Structure
|
306
615
|
end
|
307
616
|
|
308
|
-
# @note When making an API call, you may pass DescribeTableRequest
|
309
|
-
# data as a hash:
|
310
|
-
#
|
311
|
-
# {
|
312
|
-
# database_name: "ResourceName", # required
|
313
|
-
# table_name: "ResourceName", # required
|
314
|
-
# }
|
315
|
-
#
|
316
617
|
# @!attribute [rw] database_name
|
317
618
|
# The name of the Timestream database.
|
318
619
|
# @return [String]
|
@@ -342,25 +643,16 @@ module Aws::TimestreamWrite
|
|
342
643
|
include Aws::Structure
|
343
644
|
end
|
344
645
|
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
# @note When making an API call, you may pass Dimension
|
350
|
-
# data as a hash:
|
351
|
-
#
|
352
|
-
# {
|
353
|
-
# name: "SchemaName", # required
|
354
|
-
# value: "SchemaValue", # required
|
355
|
-
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
356
|
-
# }
|
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.
|
357
649
|
#
|
358
650
|
# @!attribute [rw] name
|
359
|
-
# Dimension represents the
|
360
|
-
#
|
361
|
-
#
|
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.
|
362
654
|
#
|
363
|
-
# For constraints on
|
655
|
+
# For constraints on dimension names, see [Naming Constraints][1].
|
364
656
|
#
|
365
657
|
#
|
366
658
|
#
|
@@ -372,7 +664,7 @@ module Aws::TimestreamWrite
|
|
372
664
|
# @return [String]
|
373
665
|
#
|
374
666
|
# @!attribute [rw] dimension_value_type
|
375
|
-
# The data type of the dimension for the time
|
667
|
+
# The data type of the dimension for the time-series data point.
|
376
668
|
# @return [String]
|
377
669
|
#
|
378
670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/Dimension AWS API Documentation
|
@@ -385,8 +677,23 @@ module Aws::TimestreamWrite
|
|
385
677
|
include Aws::Structure
|
386
678
|
end
|
387
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
|
+
|
388
695
|
# Represents an available endpoint against which to make API calls
|
389
|
-
#
|
696
|
+
# against, as well as the TTL for that endpoint.
|
390
697
|
#
|
391
698
|
# @!attribute [rw] address
|
392
699
|
# An endpoint address.
|
@@ -419,7 +726,7 @@ module Aws::TimestreamWrite
|
|
419
726
|
include Aws::Structure
|
420
727
|
end
|
421
728
|
|
422
|
-
# The requested endpoint was
|
729
|
+
# The requested endpoint was not valid.
|
423
730
|
#
|
424
731
|
# @!attribute [rw] message
|
425
732
|
# @return [String]
|
@@ -432,14 +739,50 @@ module Aws::TimestreamWrite
|
|
432
739
|
include Aws::Structure
|
433
740
|
end
|
434
741
|
|
435
|
-
#
|
436
|
-
#
|
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>]
|
437
776
|
#
|
438
|
-
#
|
439
|
-
# next_token: "String",
|
440
|
-
# max_results: 1,
|
441
|
-
# }
|
777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListBatchLoadTasksResponse AWS API Documentation
|
442
778
|
#
|
779
|
+
class ListBatchLoadTasksResponse < Struct.new(
|
780
|
+
:next_token,
|
781
|
+
:batch_load_tasks)
|
782
|
+
SENSITIVE = []
|
783
|
+
include Aws::Structure
|
784
|
+
end
|
785
|
+
|
443
786
|
# @!attribute [rw] next_token
|
444
787
|
# The pagination token. To resume pagination, provide the NextToken
|
445
788
|
# value as argument of a subsequent API invocation.
|
@@ -479,15 +822,6 @@ module Aws::TimestreamWrite
|
|
479
822
|
include Aws::Structure
|
480
823
|
end
|
481
824
|
|
482
|
-
# @note When making an API call, you may pass ListTablesRequest
|
483
|
-
# data as a hash:
|
484
|
-
#
|
485
|
-
# {
|
486
|
-
# database_name: "ResourceName",
|
487
|
-
# next_token: "String",
|
488
|
-
# max_results: 1,
|
489
|
-
# }
|
490
|
-
#
|
491
825
|
# @!attribute [rw] database_name
|
492
826
|
# The name of the Timestream database.
|
493
827
|
# @return [String]
|
@@ -532,13 +866,6 @@ module Aws::TimestreamWrite
|
|
532
866
|
include Aws::Structure
|
533
867
|
end
|
534
868
|
|
535
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
536
|
-
# data as a hash:
|
537
|
-
#
|
538
|
-
# {
|
539
|
-
# resource_arn: "AmazonResourceName", # required
|
540
|
-
# }
|
541
|
-
#
|
542
869
|
# @!attribute [rw] resource_arn
|
543
870
|
# The Timestream resource with tags to be listed. This value is an
|
544
871
|
# Amazon Resource Name (ARN).
|
@@ -567,18 +894,6 @@ module Aws::TimestreamWrite
|
|
567
894
|
# The location to write error reports for records rejected,
|
568
895
|
# asynchronously, during magnetic store writes.
|
569
896
|
#
|
570
|
-
# @note When making an API call, you may pass MagneticStoreRejectedDataLocation
|
571
|
-
# data as a hash:
|
572
|
-
#
|
573
|
-
# {
|
574
|
-
# s3_configuration: {
|
575
|
-
# bucket_name: "S3BucketName",
|
576
|
-
# object_key_prefix: "S3ObjectKeyPrefix",
|
577
|
-
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
578
|
-
# kms_key_id: "StringValue2048",
|
579
|
-
# },
|
580
|
-
# }
|
581
|
-
#
|
582
897
|
# @!attribute [rw] s3_configuration
|
583
898
|
# Configuration of an S3 location to write error reports for records
|
584
899
|
# rejected, asynchronously, during magnetic store writes.
|
@@ -595,21 +910,6 @@ module Aws::TimestreamWrite
|
|
595
910
|
# The set of properties on a table for configuring magnetic store
|
596
911
|
# writes.
|
597
912
|
#
|
598
|
-
# @note When making an API call, you may pass MagneticStoreWriteProperties
|
599
|
-
# data as a hash:
|
600
|
-
#
|
601
|
-
# {
|
602
|
-
# enable_magnetic_store_writes: false, # required
|
603
|
-
# magnetic_store_rejected_data_location: {
|
604
|
-
# s3_configuration: {
|
605
|
-
# bucket_name: "S3BucketName",
|
606
|
-
# object_key_prefix: "S3ObjectKeyPrefix",
|
607
|
-
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
608
|
-
# kms_key_id: "StringValue2048",
|
609
|
-
# },
|
610
|
-
# },
|
611
|
-
# }
|
612
|
-
#
|
613
913
|
# @!attribute [rw] enable_magnetic_store_writes
|
614
914
|
# A flag to enable magnetic store writes.
|
615
915
|
# @return [Boolean]
|
@@ -628,28 +928,19 @@ module Aws::TimestreamWrite
|
|
628
928
|
include Aws::Structure
|
629
929
|
end
|
630
930
|
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
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.
|
634
934
|
#
|
635
935
|
# MeasureValue is only allowed for type `MULTI`. Using `MULTI` type, you
|
636
936
|
# can pass multiple data attributes associated with the same time series
|
637
937
|
# in a single record
|
638
938
|
#
|
639
|
-
# @note When making an API call, you may pass MeasureValue
|
640
|
-
# data as a hash:
|
641
|
-
#
|
642
|
-
# {
|
643
|
-
# name: "SchemaName", # required
|
644
|
-
# value: "StringValue2048", # required
|
645
|
-
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
646
|
-
# }
|
647
|
-
#
|
648
939
|
# @!attribute [rw] name
|
649
|
-
#
|
940
|
+
# The name of the MeasureValue.
|
650
941
|
#
|
651
|
-
# For constraints on MeasureValue names,
|
652
|
-
#
|
942
|
+
# For constraints on MeasureValue names, see [ Naming Constraints][1]
|
943
|
+
# in the Amazon Timestream Developer Guide.
|
653
944
|
#
|
654
945
|
#
|
655
946
|
#
|
@@ -657,11 +948,11 @@ module Aws::TimestreamWrite
|
|
657
948
|
# @return [String]
|
658
949
|
#
|
659
950
|
# @!attribute [rw] value
|
660
|
-
#
|
951
|
+
# The value for the MeasureValue.
|
661
952
|
# @return [String]
|
662
953
|
#
|
663
954
|
# @!attribute [rw] type
|
664
|
-
# Contains the data type of the MeasureValue for the time
|
955
|
+
# Contains the data type of the MeasureValue for the time-series data
|
665
956
|
# point.
|
666
957
|
# @return [String]
|
667
958
|
#
|
@@ -675,16 +966,77 @@ module Aws::TimestreamWrite
|
|
675
966
|
include Aws::Structure
|
676
967
|
end
|
677
968
|
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
#
|
685
|
-
#
|
686
|
-
#
|
687
|
-
#
|
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.
|
688
1040
|
#
|
689
1041
|
# Records have a `Version` field, which is a 64-bit `long` that you can
|
690
1042
|
# use for updating data points. Writes of a duplicate record with the
|
@@ -694,34 +1046,8 @@ module Aws::TimestreamWrite
|
|
694
1046
|
# Timestream defaults to a `Version` of `1` for records without the
|
695
1047
|
# `Version` field.
|
696
1048
|
#
|
697
|
-
# @note When making an API call, you may pass Record
|
698
|
-
# data as a hash:
|
699
|
-
#
|
700
|
-
# {
|
701
|
-
# dimensions: [
|
702
|
-
# {
|
703
|
-
# name: "SchemaName", # required
|
704
|
-
# value: "SchemaValue", # required
|
705
|
-
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
706
|
-
# },
|
707
|
-
# ],
|
708
|
-
# measure_name: "SchemaName",
|
709
|
-
# measure_value: "StringValue2048",
|
710
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
711
|
-
# time: "StringValue256",
|
712
|
-
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
713
|
-
# version: 1,
|
714
|
-
# measure_values: [
|
715
|
-
# {
|
716
|
-
# name: "SchemaName", # required
|
717
|
-
# value: "StringValue2048", # required
|
718
|
-
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
719
|
-
# },
|
720
|
-
# ],
|
721
|
-
# }
|
722
|
-
#
|
723
1049
|
# @!attribute [rw] dimensions
|
724
|
-
# Contains the list of dimensions for time
|
1050
|
+
# Contains the list of dimensions for time-series data points.
|
725
1051
|
# @return [Array<Types::Dimension>]
|
726
1052
|
#
|
727
1053
|
# @!attribute [rw] measure_name
|
@@ -731,11 +1057,11 @@ module Aws::TimestreamWrite
|
|
731
1057
|
# @return [String]
|
732
1058
|
#
|
733
1059
|
# @!attribute [rw] measure_value
|
734
|
-
# Contains the measure value for the time
|
1060
|
+
# Contains the measure value for the time-series data point.
|
735
1061
|
# @return [String]
|
736
1062
|
#
|
737
1063
|
# @!attribute [rw] measure_value_type
|
738
|
-
# 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
|
739
1065
|
# point. Default type is `DOUBLE`.
|
740
1066
|
# @return [String]
|
741
1067
|
#
|
@@ -748,7 +1074,7 @@ module Aws::TimestreamWrite
|
|
748
1074
|
#
|
749
1075
|
# @!attribute [rw] time_unit
|
750
1076
|
# The granularity of the timestamp unit. It indicates if the time
|
751
|
-
# value is in seconds, milliseconds, nanoseconds or other supported
|
1077
|
+
# value is in seconds, milliseconds, nanoseconds, or other supported
|
752
1078
|
# values. Default is `MILLISECONDS`.
|
753
1079
|
# @return [String]
|
754
1080
|
#
|
@@ -756,7 +1082,7 @@ module Aws::TimestreamWrite
|
|
756
1082
|
# 64-bit attribute used for record updates. Write requests for
|
757
1083
|
# duplicate data with a higher version number will update the existing
|
758
1084
|
# measure value and version. In cases where the measure value is the
|
759
|
-
# same, `Version` will still be updated
|
1085
|
+
# same, `Version` will still be updated. Default value is `1`.
|
760
1086
|
#
|
761
1087
|
# <note markdown="1"> `Version` must be `1` or greater, or you will receive a
|
762
1088
|
# `ValidationException` error.
|
@@ -765,10 +1091,10 @@ module Aws::TimestreamWrite
|
|
765
1091
|
# @return [Integer]
|
766
1092
|
#
|
767
1093
|
# @!attribute [rw] measure_values
|
768
|
-
# Contains the list of MeasureValue for time
|
1094
|
+
# Contains the list of MeasureValue for time-series data points.
|
769
1095
|
#
|
770
1096
|
# This is only allowed for type `MULTI`. For scalar values, use
|
771
|
-
# `MeasureValue` attribute of the
|
1097
|
+
# `MeasureValue` attribute of the record directly.
|
772
1098
|
# @return [Array<Types::MeasureValue>]
|
773
1099
|
#
|
774
1100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/Record AWS API Documentation
|
@@ -810,9 +1136,9 @@ module Aws::TimestreamWrite
|
|
810
1136
|
include Aws::Structure
|
811
1137
|
end
|
812
1138
|
|
813
|
-
#
|
814
|
-
# data validation issues that must be resolved
|
815
|
-
# 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.
|
816
1142
|
#
|
817
1143
|
# @!attribute [rw] record_index
|
818
1144
|
# The index of the record in the input request for WriteRecords.
|
@@ -828,7 +1154,7 @@ module Aws::TimestreamWrite
|
|
828
1154
|
#
|
829
1155
|
# * Measure values are different
|
830
1156
|
#
|
831
|
-
# * 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
|
832
1158
|
# in the new record is equal to or lower than the existing value
|
833
1159
|
#
|
834
1160
|
# If Timestream rejects data for this case, the `ExistingVersion`
|
@@ -838,7 +1164,7 @@ module Aws::TimestreamWrite
|
|
838
1164
|
# `ExistingVersion`.
|
839
1165
|
#
|
840
1166
|
# * Records with timestamps that lie outside the retention duration of
|
841
|
-
# the memory store
|
1167
|
+
# the memory store.
|
842
1168
|
#
|
843
1169
|
# <note markdown="1"> When the retention window is updated, you will receive a
|
844
1170
|
# `RejectedRecords` exception if you immediately try to ingest data
|
@@ -896,13 +1222,13 @@ module Aws::TimestreamWrite
|
|
896
1222
|
# `ExistingVersion`.
|
897
1223
|
#
|
898
1224
|
# * Records with timestamps that lie outside the retention duration of
|
899
|
-
# the memory store
|
1225
|
+
# the memory store.
|
900
1226
|
#
|
901
1227
|
# * Records with dimensions or measures that exceed the Timestream
|
902
1228
|
# defined limits.
|
903
1229
|
#
|
904
|
-
# For more information, see [Quotas][1] in the Timestream
|
905
|
-
# Guide.
|
1230
|
+
# For more information, see [Quotas][1] in the Amazon Timestream
|
1231
|
+
# Developer Guide.
|
906
1232
|
#
|
907
1233
|
#
|
908
1234
|
#
|
@@ -923,6 +1249,45 @@ module Aws::TimestreamWrite
|
|
923
1249
|
include Aws::Structure
|
924
1250
|
end
|
925
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
|
+
|
926
1291
|
# The operation tried to access a nonexistent resource. The resource
|
927
1292
|
# might not be specified correctly, or its status might not be ACTIVE.
|
928
1293
|
#
|
@@ -937,16 +1302,24 @@ module Aws::TimestreamWrite
|
|
937
1302
|
include Aws::Structure
|
938
1303
|
end
|
939
1304
|
|
940
|
-
#
|
941
|
-
#
|
1305
|
+
# @!attribute [rw] task_id
|
1306
|
+
# The ID of the batch load task to resume.
|
1307
|
+
# @return [String]
|
942
1308
|
#
|
943
|
-
# @
|
944
|
-
# data as a hash:
|
1309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ResumeBatchLoadTaskRequest AWS API Documentation
|
945
1310
|
#
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
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
|
1322
|
+
# data must be stored in the magnetic store and the memory store.
|
950
1323
|
#
|
951
1324
|
# @!attribute [rw] memory_store_retention_period_in_hours
|
952
1325
|
# The duration for which data must be stored in the memory store.
|
@@ -965,34 +1338,25 @@ module Aws::TimestreamWrite
|
|
965
1338
|
include Aws::Structure
|
966
1339
|
end
|
967
1340
|
|
968
|
-
#
|
969
|
-
#
|
970
|
-
# @note When making an API call, you may pass S3Configuration
|
971
|
-
# data as a hash:
|
972
|
-
#
|
973
|
-
# {
|
974
|
-
# bucket_name: "S3BucketName",
|
975
|
-
# object_key_prefix: "S3ObjectKeyPrefix",
|
976
|
-
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
977
|
-
# kms_key_id: "StringValue2048",
|
978
|
-
# }
|
1341
|
+
# The configuration that specifies an S3 location.
|
979
1342
|
#
|
980
1343
|
# @!attribute [rw] bucket_name
|
981
|
-
#
|
1344
|
+
# The bucket name of the customer S3 bucket.
|
982
1345
|
# @return [String]
|
983
1346
|
#
|
984
1347
|
# @!attribute [rw] object_key_prefix
|
985
|
-
#
|
1348
|
+
# The object key preview for the customer S3 location.
|
986
1349
|
# @return [String]
|
987
1350
|
#
|
988
1351
|
# @!attribute [rw] encryption_option
|
989
|
-
#
|
990
|
-
# 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.
|
991
1355
|
# @return [String]
|
992
1356
|
#
|
993
1357
|
# @!attribute [rw] kms_key_id
|
994
|
-
# KMS key
|
995
|
-
# managed key.
|
1358
|
+
# The KMS key ID for the customer S3 location when encrypting with an
|
1359
|
+
# Amazon Web Services managed key.
|
996
1360
|
# @return [String]
|
997
1361
|
#
|
998
1362
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/S3Configuration AWS API Documentation
|
@@ -1006,7 +1370,7 @@ module Aws::TimestreamWrite
|
|
1006
1370
|
include Aws::Structure
|
1007
1371
|
end
|
1008
1372
|
|
1009
|
-
#
|
1373
|
+
# The instance quota of resource exceeded for this account.
|
1010
1374
|
#
|
1011
1375
|
# @!attribute [rw] message
|
1012
1376
|
# @return [String]
|
@@ -1019,8 +1383,8 @@ module Aws::TimestreamWrite
|
|
1019
1383
|
include Aws::Structure
|
1020
1384
|
end
|
1021
1385
|
|
1022
|
-
#
|
1023
|
-
#
|
1386
|
+
# Represents a database table in Timestream. Tables contain one or more
|
1387
|
+
# related time series. You can modify the retention duration of the
|
1024
1388
|
# memory store and the magnetic store for a table.
|
1025
1389
|
#
|
1026
1390
|
# @!attribute [rw] arn
|
@@ -1077,17 +1441,9 @@ module Aws::TimestreamWrite
|
|
1077
1441
|
|
1078
1442
|
# A tag is a label that you assign to a Timestream database and/or
|
1079
1443
|
# table. Each tag consists of a key and an optional value, both of which
|
1080
|
-
# you define.
|
1444
|
+
# you define. With tags, you can categorize databases and/or tables, for
|
1081
1445
|
# example, by purpose, owner, or environment.
|
1082
1446
|
#
|
1083
|
-
# @note When making an API call, you may pass Tag
|
1084
|
-
# data as a hash:
|
1085
|
-
#
|
1086
|
-
# {
|
1087
|
-
# key: "TagKey", # required
|
1088
|
-
# value: "TagValue", # required
|
1089
|
-
# }
|
1090
|
-
#
|
1091
1447
|
# @!attribute [rw] key
|
1092
1448
|
# The key of the tag. Tag keys are case sensitive.
|
1093
1449
|
# @return [String]
|
@@ -1105,19 +1461,6 @@ module Aws::TimestreamWrite
|
|
1105
1461
|
include Aws::Structure
|
1106
1462
|
end
|
1107
1463
|
|
1108
|
-
# @note When making an API call, you may pass TagResourceRequest
|
1109
|
-
# data as a hash:
|
1110
|
-
#
|
1111
|
-
# {
|
1112
|
-
# resource_arn: "AmazonResourceName", # required
|
1113
|
-
# tags: [ # required
|
1114
|
-
# {
|
1115
|
-
# key: "TagKey", # required
|
1116
|
-
# value: "TagValue", # required
|
1117
|
-
# },
|
1118
|
-
# ],
|
1119
|
-
# }
|
1120
|
-
#
|
1121
1464
|
# @!attribute [rw] resource_arn
|
1122
1465
|
# Identifies the Timestream resource to which tags should be added.
|
1123
1466
|
# This value is an Amazon Resource Name (ARN).
|
@@ -1140,8 +1483,8 @@ module Aws::TimestreamWrite
|
|
1140
1483
|
#
|
1141
1484
|
class TagResourceResponse < Aws::EmptyStructure; end
|
1142
1485
|
|
1143
|
-
# Too many requests were made by a user
|
1144
|
-
# request was throttled.
|
1486
|
+
# Too many requests were made by a user and they exceeded the service
|
1487
|
+
# quotas. The request was throttled.
|
1145
1488
|
#
|
1146
1489
|
# @!attribute [rw] message
|
1147
1490
|
# @return [String]
|
@@ -1154,14 +1497,6 @@ module Aws::TimestreamWrite
|
|
1154
1497
|
include Aws::Structure
|
1155
1498
|
end
|
1156
1499
|
|
1157
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
1158
|
-
# data as a hash:
|
1159
|
-
#
|
1160
|
-
# {
|
1161
|
-
# resource_arn: "AmazonResourceName", # required
|
1162
|
-
# tag_keys: ["TagKey"], # required
|
1163
|
-
# }
|
1164
|
-
#
|
1165
1500
|
# @!attribute [rw] resource_arn
|
1166
1501
|
# The Timestream resource that the tags will be removed from. This
|
1167
1502
|
# value is an Amazon Resource Name (ARN).
|
@@ -1185,14 +1520,6 @@ module Aws::TimestreamWrite
|
|
1185
1520
|
#
|
1186
1521
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1187
1522
|
|
1188
|
-
# @note When making an API call, you may pass UpdateDatabaseRequest
|
1189
|
-
# data as a hash:
|
1190
|
-
#
|
1191
|
-
# {
|
1192
|
-
# database_name: "ResourceName", # required
|
1193
|
-
# kms_key_id: "StringValue2048", # required
|
1194
|
-
# }
|
1195
|
-
#
|
1196
1523
|
# @!attribute [rw] database_name
|
1197
1524
|
# The name of the database.
|
1198
1525
|
# @return [String]
|
@@ -1225,7 +1552,7 @@ module Aws::TimestreamWrite
|
|
1225
1552
|
end
|
1226
1553
|
|
1227
1554
|
# @!attribute [rw] database
|
1228
|
-
# A top
|
1555
|
+
# A top-level container for a table. Databases and tables are the
|
1229
1556
|
# fundamental management concepts in Amazon Timestream. All tables in
|
1230
1557
|
# a database are encrypted with the same KMS key.
|
1231
1558
|
# @return [Types::Database]
|
@@ -1238,29 +1565,6 @@ module Aws::TimestreamWrite
|
|
1238
1565
|
include Aws::Structure
|
1239
1566
|
end
|
1240
1567
|
|
1241
|
-
# @note When making an API call, you may pass UpdateTableRequest
|
1242
|
-
# data as a hash:
|
1243
|
-
#
|
1244
|
-
# {
|
1245
|
-
# database_name: "ResourceName", # required
|
1246
|
-
# table_name: "ResourceName", # required
|
1247
|
-
# retention_properties: {
|
1248
|
-
# memory_store_retention_period_in_hours: 1, # required
|
1249
|
-
# magnetic_store_retention_period_in_days: 1, # required
|
1250
|
-
# },
|
1251
|
-
# magnetic_store_write_properties: {
|
1252
|
-
# enable_magnetic_store_writes: false, # required
|
1253
|
-
# magnetic_store_rejected_data_location: {
|
1254
|
-
# s3_configuration: {
|
1255
|
-
# bucket_name: "S3BucketName",
|
1256
|
-
# object_key_prefix: "S3ObjectKeyPrefix",
|
1257
|
-
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1258
|
-
# kms_key_id: "StringValue2048",
|
1259
|
-
# },
|
1260
|
-
# },
|
1261
|
-
# },
|
1262
|
-
# }
|
1263
|
-
#
|
1264
1568
|
# @!attribute [rw] database_name
|
1265
1569
|
# The name of the Timestream database.
|
1266
1570
|
# @return [String]
|
@@ -1301,7 +1605,7 @@ module Aws::TimestreamWrite
|
|
1301
1605
|
include Aws::Structure
|
1302
1606
|
end
|
1303
1607
|
|
1304
|
-
#
|
1608
|
+
# An invalid or malformed request.
|
1305
1609
|
#
|
1306
1610
|
# @!attribute [rw] message
|
1307
1611
|
# @return [String]
|
@@ -1314,60 +1618,6 @@ module Aws::TimestreamWrite
|
|
1314
1618
|
include Aws::Structure
|
1315
1619
|
end
|
1316
1620
|
|
1317
|
-
# @note When making an API call, you may pass WriteRecordsRequest
|
1318
|
-
# data as a hash:
|
1319
|
-
#
|
1320
|
-
# {
|
1321
|
-
# database_name: "ResourceName", # required
|
1322
|
-
# table_name: "ResourceName", # required
|
1323
|
-
# common_attributes: {
|
1324
|
-
# dimensions: [
|
1325
|
-
# {
|
1326
|
-
# name: "SchemaName", # required
|
1327
|
-
# value: "SchemaValue", # required
|
1328
|
-
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1329
|
-
# },
|
1330
|
-
# ],
|
1331
|
-
# measure_name: "SchemaName",
|
1332
|
-
# measure_value: "StringValue2048",
|
1333
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1334
|
-
# time: "StringValue256",
|
1335
|
-
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1336
|
-
# version: 1,
|
1337
|
-
# measure_values: [
|
1338
|
-
# {
|
1339
|
-
# name: "SchemaName", # required
|
1340
|
-
# value: "StringValue2048", # required
|
1341
|
-
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1342
|
-
# },
|
1343
|
-
# ],
|
1344
|
-
# },
|
1345
|
-
# records: [ # required
|
1346
|
-
# {
|
1347
|
-
# dimensions: [
|
1348
|
-
# {
|
1349
|
-
# name: "SchemaName", # required
|
1350
|
-
# value: "SchemaValue", # required
|
1351
|
-
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1352
|
-
# },
|
1353
|
-
# ],
|
1354
|
-
# measure_name: "SchemaName",
|
1355
|
-
# measure_value: "StringValue2048",
|
1356
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1357
|
-
# time: "StringValue256",
|
1358
|
-
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1359
|
-
# version: 1,
|
1360
|
-
# measure_values: [
|
1361
|
-
# {
|
1362
|
-
# name: "SchemaName", # required
|
1363
|
-
# value: "StringValue2048", # required
|
1364
|
-
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1365
|
-
# },
|
1366
|
-
# ],
|
1367
|
-
# },
|
1368
|
-
# ],
|
1369
|
-
# }
|
1370
|
-
#
|
1371
1621
|
# @!attribute [rw] database_name
|
1372
1622
|
# The name of the Timestream database.
|
1373
1623
|
# @return [String]
|
@@ -1377,18 +1627,18 @@ module Aws::TimestreamWrite
|
|
1377
1627
|
# @return [String]
|
1378
1628
|
#
|
1379
1629
|
# @!attribute [rw] common_attributes
|
1380
|
-
# A record
|
1381
|
-
# attributes shared across all the records in the request. The
|
1382
|
-
# and dimension attributes specified will be merged with the
|
1383
|
-
# and dimension attributes in the records object when the data
|
1384
|
-
# 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
|
1385
1635
|
# `ValidationException` will be thrown. In other words, a record must
|
1386
1636
|
# contain dimensions with unique names.
|
1387
1637
|
# @return [Types::Record]
|
1388
1638
|
#
|
1389
1639
|
# @!attribute [rw] records
|
1390
|
-
# An array of records
|
1391
|
-
# 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.
|
1392
1642
|
# @return [Array<Types::Record>]
|
1393
1643
|
#
|
1394
1644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecordsRequest AWS API Documentation
|