aws-sdk-timestreamwrite 1.8.0 → 1.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamwrite/client.rb +215 -59
- data/lib/aws-sdk-timestreamwrite/client_api.rb +57 -8
- data/lib/aws-sdk-timestreamwrite/types.rb +334 -41
- data/lib/aws-sdk-timestreamwrite.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dd058ce467240da1e4f5cdcb172e7f36265732931e9fd5377f0f56b2a021d8b1
|
4
|
+
data.tar.gz: 619210847bd710628f593a9d4d7976f46a499712590fac4dc01a6ac1bd16720e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b7bd29eda4c39c39dc42555046ab5145ac3657c548e92061493c96cc35bd93894131c348713609555a8c157ff3ebc3f82298a571e57af10a51e1ef6305a753a1
|
7
|
+
data.tar.gz: b6bab0315d750e74a66d122d05206ce0cc35331d4709fb6e88c6ce2caa8749f0b50211114c59386ecd13601084fea90f16f5a458f8301426d5a399ad8443ff06
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.12.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.11.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.10.0 (2021-11-24)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds support for multi-measure records and magnetic store writes. Multi-measure records allow customers to store multiple measures in a single table row. Magnetic store writes enable customers to write late arrival data (data with timestamp in the past) directly into the magnetic store.
|
18
|
+
|
19
|
+
1.9.0 (2021-11-04)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.8.0 (2021-10-18)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.12.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::TimestreamWrite
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::TimestreamWrite
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::TimestreamWrite
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -285,6 +293,15 @@ module Aws::TimestreamWrite
|
|
285
293
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
294
|
# requests are made, and retries are disabled.
|
287
295
|
#
|
296
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
297
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
298
|
+
# will be used if available.
|
299
|
+
#
|
300
|
+
# @option options [Boolean] :use_fips_endpoint
|
301
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
302
|
+
# When a `fips` region is used, the region is normalized and this config
|
303
|
+
# is set to `true`.
|
304
|
+
#
|
288
305
|
# @option options [Boolean] :validate_params (true)
|
289
306
|
# When `true`, request parameters are validated before
|
290
307
|
# sending the request.
|
@@ -296,7 +313,7 @@ module Aws::TimestreamWrite
|
|
296
313
|
# seconds to wait when opening a HTTP session before raising a
|
297
314
|
# `Timeout::Error`.
|
298
315
|
#
|
299
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
300
317
|
# number of seconds to wait for response data. This value can
|
301
318
|
# safely be set per-request on the session.
|
302
319
|
#
|
@@ -312,6 +329,9 @@ module Aws::TimestreamWrite
|
|
312
329
|
# disables this behaviour. This value can safely be set per
|
313
330
|
# request on the session.
|
314
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
315
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
336
|
# HTTP debug output will be sent to the `:logger`.
|
317
337
|
#
|
@@ -339,14 +359,15 @@ module Aws::TimestreamWrite
|
|
339
359
|
|
340
360
|
# Creates a new Timestream database. If the KMS key is not specified,
|
341
361
|
# the database will be encrypted with a Timestream managed KMS key
|
342
|
-
# located in your account. Refer to [
|
343
|
-
# info. Service quotas apply.
|
344
|
-
#
|
362
|
+
# located in your account. Refer to [Amazon Web Services managed KMS
|
363
|
+
# keys][1] for more info. [Service quotas apply][2]. See [code
|
364
|
+
# sample][3] for details.
|
345
365
|
#
|
346
366
|
#
|
347
367
|
#
|
348
368
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
349
369
|
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
370
|
+
# [3]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html
|
350
371
|
#
|
351
372
|
# @option params [required, String] :database_name
|
352
373
|
# The name of the Timestream database.
|
@@ -354,7 +375,8 @@ module Aws::TimestreamWrite
|
|
354
375
|
# @option params [String] :kms_key_id
|
355
376
|
# The KMS key for the database. If the KMS key is not specified, the
|
356
377
|
# database will be encrypted with a Timestream managed KMS key located
|
357
|
-
# in your account. Refer to [
|
378
|
+
# in your account. Refer to [Amazon Web Services managed KMS keys][1]
|
379
|
+
# for more info.
|
358
380
|
#
|
359
381
|
#
|
360
382
|
#
|
@@ -370,7 +392,7 @@ module Aws::TimestreamWrite
|
|
370
392
|
# @example Request syntax with placeholder values
|
371
393
|
#
|
372
394
|
# resp = client.create_database({
|
373
|
-
# database_name: "
|
395
|
+
# database_name: "ResourceCreateAPIName", # required
|
374
396
|
# kms_key_id: "StringValue2048",
|
375
397
|
# tags: [
|
376
398
|
# {
|
@@ -399,17 +421,17 @@ module Aws::TimestreamWrite
|
|
399
421
|
end
|
400
422
|
|
401
423
|
# The CreateTable operation adds a new table to an existing database in
|
402
|
-
# your account. In an
|
403
|
-
# within each Region if they are in the same database.
|
404
|
-
# identical table names in the same Region if the tables
|
405
|
-
# databases. While creating the table, you must specify
|
406
|
-
# database name, and the retention properties. Service
|
407
|
-
#
|
408
|
-
# Developer Guide.
|
424
|
+
# your account. In an Amazon Web Services account, table names must be
|
425
|
+
# at least unique within each Region if they are in the same database.
|
426
|
+
# You may have identical table names in the same Region if the tables
|
427
|
+
# are in separate databases. While creating the table, you must specify
|
428
|
+
# the table name, database name, and the retention properties. [Service
|
429
|
+
# quotas apply][1]. See [code sample][2] for details.
|
409
430
|
#
|
410
431
|
#
|
411
432
|
#
|
412
433
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
434
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html
|
413
435
|
#
|
414
436
|
# @option params [required, String] :database_name
|
415
437
|
# The name of the Timestream database.
|
@@ -424,6 +446,10 @@ module Aws::TimestreamWrite
|
|
424
446
|
# @option params [Array<Types::Tag>] :tags
|
425
447
|
# A list of key-value pairs to label the table.
|
426
448
|
#
|
449
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
450
|
+
# Contains properties to set on the table when enabling magnetic store
|
451
|
+
# writes.
|
452
|
+
#
|
427
453
|
# @return [Types::CreateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
454
|
#
|
429
455
|
# * {Types::CreateTableResponse#table #table} => Types::Table
|
@@ -431,8 +457,8 @@ module Aws::TimestreamWrite
|
|
431
457
|
# @example Request syntax with placeholder values
|
432
458
|
#
|
433
459
|
# resp = client.create_table({
|
434
|
-
# database_name: "
|
435
|
-
# table_name: "
|
460
|
+
# database_name: "ResourceCreateAPIName", # required
|
461
|
+
# table_name: "ResourceCreateAPIName", # required
|
436
462
|
# retention_properties: {
|
437
463
|
# memory_store_retention_period_in_hours: 1, # required
|
438
464
|
# magnetic_store_retention_period_in_days: 1, # required
|
@@ -443,6 +469,17 @@ module Aws::TimestreamWrite
|
|
443
469
|
# value: "TagValue", # required
|
444
470
|
# },
|
445
471
|
# ],
|
472
|
+
# magnetic_store_write_properties: {
|
473
|
+
# enable_magnetic_store_writes: false, # required
|
474
|
+
# magnetic_store_rejected_data_location: {
|
475
|
+
# s3_configuration: {
|
476
|
+
# bucket_name: "S3BucketName",
|
477
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
478
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
479
|
+
# kms_key_id: "StringValue2048",
|
480
|
+
# },
|
481
|
+
# },
|
482
|
+
# },
|
446
483
|
# })
|
447
484
|
#
|
448
485
|
# @example Response structure
|
@@ -455,6 +492,11 @@ module Aws::TimestreamWrite
|
|
455
492
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
456
493
|
# resp.table.creation_time #=> Time
|
457
494
|
# resp.table.last_updated_time #=> Time
|
495
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
496
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
497
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
498
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
499
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
458
500
|
#
|
459
501
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable AWS API Documentation
|
460
502
|
#
|
@@ -469,13 +511,21 @@ module Aws::TimestreamWrite
|
|
469
511
|
# operation. After a database is deleted, the time series data from its
|
470
512
|
# tables cannot be recovered.*
|
471
513
|
#
|
472
|
-
# All tables in the database must be deleted first, or a
|
514
|
+
# <note markdown="1"> All tables in the database must be deleted first, or a
|
473
515
|
# ValidationException error will be thrown.
|
474
516
|
#
|
475
|
-
#
|
517
|
+
# Due to the nature of distributed retries, the operation can return
|
476
518
|
# either success or a ResourceNotFoundException. Clients should consider
|
477
519
|
# them equivalent.
|
478
520
|
#
|
521
|
+
# </note>
|
522
|
+
#
|
523
|
+
# See [code sample][1] for details.
|
524
|
+
#
|
525
|
+
#
|
526
|
+
#
|
527
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html
|
528
|
+
#
|
479
529
|
# @option params [required, String] :database_name
|
480
530
|
# The name of the Timestream database to be deleted.
|
481
531
|
#
|
@@ -500,10 +550,18 @@ module Aws::TimestreamWrite
|
|
500
550
|
# After a Timestream database table is deleted, the time series data
|
501
551
|
# stored in the table cannot be recovered.
|
502
552
|
#
|
503
|
-
# Due to the nature of distributed retries, the operation can return
|
553
|
+
# <note markdown="1"> Due to the nature of distributed retries, the operation can return
|
504
554
|
# either success or a ResourceNotFoundException. Clients should consider
|
505
555
|
# them equivalent.
|
506
556
|
#
|
557
|
+
# </note>
|
558
|
+
#
|
559
|
+
# See [code sample][1] for details.
|
560
|
+
#
|
561
|
+
#
|
562
|
+
#
|
563
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html
|
564
|
+
#
|
507
565
|
# @option params [required, String] :database_name
|
508
566
|
# The name of the database where the Timestream database is to be
|
509
567
|
# deleted.
|
@@ -531,12 +589,13 @@ module Aws::TimestreamWrite
|
|
531
589
|
|
532
590
|
# Returns information about the database, including the database name,
|
533
591
|
# time that the database was created, and the total number of tables
|
534
|
-
# found within the database. Service quotas apply.
|
535
|
-
#
|
592
|
+
# found within the database. [Service quotas apply][1]. See [code
|
593
|
+
# sample][2] for details.
|
536
594
|
#
|
537
595
|
#
|
538
596
|
#
|
539
597
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
598
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html
|
540
599
|
#
|
541
600
|
# @option params [required, String] :database_name
|
542
601
|
# The name of the Timestream database.
|
@@ -573,22 +632,26 @@ module Aws::TimestreamWrite
|
|
573
632
|
# Timestream API calls against. This API is available through both Write
|
574
633
|
# and Query.
|
575
634
|
#
|
576
|
-
# Because Timestream
|
577
|
-
# service’s architecture, including the management and mapping of
|
578
|
-
# service endpoints, *it is not recommended that you use this API
|
635
|
+
# Because the Timestream SDKs are designed to transparently work with
|
636
|
+
# the service’s architecture, including the management and mapping of
|
637
|
+
# the service endpoints, *it is not recommended that you use this API
|
579
638
|
# unless*\:
|
580
639
|
#
|
640
|
+
# * You are using [VPC endpoints (Amazon Web Services PrivateLink) with
|
641
|
+
# Timestream][1]
|
642
|
+
#
|
581
643
|
# * Your application uses a programming language that does not yet have
|
582
644
|
# SDK support
|
583
645
|
#
|
584
646
|
# * You require better control over the client-side implementation
|
585
647
|
#
|
586
|
-
# For detailed information on how to use
|
587
|
-
# Endpoint Discovery Pattern
|
648
|
+
# For detailed information on how and when to use and implement
|
649
|
+
# DescribeEndpoints, see [The Endpoint Discovery Pattern][2].
|
588
650
|
#
|
589
651
|
#
|
590
652
|
#
|
591
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
653
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints
|
654
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery
|
592
655
|
#
|
593
656
|
# @return [Types::DescribeEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
594
657
|
#
|
@@ -611,12 +674,12 @@ module Aws::TimestreamWrite
|
|
611
674
|
|
612
675
|
# Returns information about the table, including the table name,
|
613
676
|
# database name, retention duration of the memory store and the magnetic
|
614
|
-
# store. Service quotas apply.
|
615
|
-
# Management][1] in the Timestream Developer Guide.
|
677
|
+
# store. [Service quotas apply][1]. See [code sample][2] for details.
|
616
678
|
#
|
617
679
|
#
|
618
680
|
#
|
619
681
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
682
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html
|
620
683
|
#
|
621
684
|
# @option params [required, String] :database_name
|
622
685
|
# The name of the Timestream database.
|
@@ -645,6 +708,11 @@ module Aws::TimestreamWrite
|
|
645
708
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
646
709
|
# resp.table.creation_time #=> Time
|
647
710
|
# resp.table.last_updated_time #=> Time
|
711
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
712
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
713
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
714
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
715
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
648
716
|
#
|
649
717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable AWS API Documentation
|
650
718
|
#
|
@@ -655,13 +723,13 @@ module Aws::TimestreamWrite
|
|
655
723
|
req.send_request(options)
|
656
724
|
end
|
657
725
|
|
658
|
-
# Returns a list of your Timestream databases. Service quotas
|
659
|
-
#
|
660
|
-
# Developer Guide.
|
726
|
+
# Returns a list of your Timestream databases. [Service quotas
|
727
|
+
# apply][1]. See [code sample][2] for details.
|
661
728
|
#
|
662
729
|
#
|
663
730
|
#
|
664
731
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
732
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html
|
665
733
|
#
|
666
734
|
# @option params [String] :next_token
|
667
735
|
# The pagination token. To resume pagination, provide the NextToken
|
@@ -708,7 +776,11 @@ module Aws::TimestreamWrite
|
|
708
776
|
end
|
709
777
|
|
710
778
|
# A list of tables, along with the name, status and retention properties
|
711
|
-
# of each table.
|
779
|
+
# of each table. See [code sample][1] for details.
|
780
|
+
#
|
781
|
+
#
|
782
|
+
#
|
783
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html
|
712
784
|
#
|
713
785
|
# @option params [String] :database_name
|
714
786
|
# The name of the Timestream database.
|
@@ -749,6 +821,11 @@ module Aws::TimestreamWrite
|
|
749
821
|
# resp.tables[0].retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
750
822
|
# resp.tables[0].creation_time #=> Time
|
751
823
|
# resp.tables[0].last_updated_time #=> Time
|
824
|
+
# resp.tables[0].magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
825
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
826
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
827
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
828
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
752
829
|
# resp.next_token #=> String
|
753
830
|
#
|
754
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables AWS API Documentation
|
@@ -858,6 +935,12 @@ module Aws::TimestreamWrite
|
|
858
935
|
# new KMS key to be used (`KmsKeyId`). If there are any concurrent
|
859
936
|
# `UpdateDatabase` requests, first writer wins.
|
860
937
|
#
|
938
|
+
# See [code sample][1] for details.
|
939
|
+
#
|
940
|
+
#
|
941
|
+
#
|
942
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html
|
943
|
+
#
|
861
944
|
# @option params [required, String] :database_name
|
862
945
|
# The name of the database.
|
863
946
|
#
|
@@ -916,22 +999,25 @@ module Aws::TimestreamWrite
|
|
916
999
|
# was made. Timestream does not retrieve data from the magnetic store to
|
917
1000
|
# populate the memory store.
|
918
1001
|
#
|
919
|
-
#
|
920
|
-
# in the Timestream Developer Guide.
|
1002
|
+
# See [code sample][1] for details.
|
921
1003
|
#
|
922
1004
|
#
|
923
1005
|
#
|
924
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
1006
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html
|
925
1007
|
#
|
926
1008
|
# @option params [required, String] :database_name
|
927
1009
|
# The name of the Timestream database.
|
928
1010
|
#
|
929
1011
|
# @option params [required, String] :table_name
|
930
|
-
# The name of the
|
1012
|
+
# The name of the Timestream table.
|
931
1013
|
#
|
932
|
-
# @option params [
|
1014
|
+
# @option params [Types::RetentionProperties] :retention_properties
|
933
1015
|
# The retention duration of the memory store and the magnetic store.
|
934
1016
|
#
|
1017
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
1018
|
+
# Contains properties to set on the table when enabling magnetic store
|
1019
|
+
# writes.
|
1020
|
+
#
|
935
1021
|
# @return [Types::UpdateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
1022
|
#
|
937
1023
|
# * {Types::UpdateTableResponse#table #table} => Types::Table
|
@@ -941,10 +1027,21 @@ module Aws::TimestreamWrite
|
|
941
1027
|
# resp = client.update_table({
|
942
1028
|
# database_name: "ResourceName", # required
|
943
1029
|
# table_name: "ResourceName", # required
|
944
|
-
# retention_properties: {
|
1030
|
+
# retention_properties: {
|
945
1031
|
# memory_store_retention_period_in_hours: 1, # required
|
946
1032
|
# magnetic_store_retention_period_in_days: 1, # required
|
947
1033
|
# },
|
1034
|
+
# magnetic_store_write_properties: {
|
1035
|
+
# enable_magnetic_store_writes: false, # required
|
1036
|
+
# magnetic_store_rejected_data_location: {
|
1037
|
+
# s3_configuration: {
|
1038
|
+
# bucket_name: "S3BucketName",
|
1039
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
1040
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1041
|
+
# kms_key_id: "StringValue2048",
|
1042
|
+
# },
|
1043
|
+
# },
|
1044
|
+
# },
|
948
1045
|
# })
|
949
1046
|
#
|
950
1047
|
# @example Response structure
|
@@ -957,6 +1054,11 @@ module Aws::TimestreamWrite
|
|
957
1054
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
958
1055
|
# resp.table.creation_time #=> Time
|
959
1056
|
# resp.table.last_updated_time #=> Time
|
1057
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
1058
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
1059
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
1060
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
1061
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
960
1062
|
#
|
961
1063
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable AWS API Documentation
|
962
1064
|
#
|
@@ -978,32 +1080,66 @@ module Aws::TimestreamWrite
|
|
978
1080
|
# into Timestream, the query results might not reflect the results of a
|
979
1081
|
# recently completed write operation. The results may also include some
|
980
1082
|
# stale data. If you repeat the query request after a short time, the
|
981
|
-
# results should return the latest data. Service quotas apply.
|
982
|
-
#
|
983
|
-
#
|
1083
|
+
# results should return the latest data. [Service quotas apply][1].
|
1084
|
+
#
|
1085
|
+
# See [code sample][2] for details.
|
1086
|
+
#
|
1087
|
+
# **Upserts**
|
1088
|
+
#
|
1089
|
+
# You can use the `Version` parameter in a `WriteRecords` request to
|
1090
|
+
# update data points. Timestream tracks a version number with each
|
1091
|
+
# record. `Version` defaults to `1` when not specified for the record in
|
1092
|
+
# the request. Timestream will update an existing record’s measure value
|
1093
|
+
# along with its `Version` upon receiving a write request with a higher
|
1094
|
+
# `Version` number for that record. Upon receiving an update request
|
1095
|
+
# where the measure value is the same as that of the existing record,
|
1096
|
+
# Timestream still updates `Version`, if it is greater than the existing
|
1097
|
+
# value of `Version`. You can update a data point as many times as
|
1098
|
+
# desired, as long as the value of `Version` continuously increases.
|
1099
|
+
#
|
1100
|
+
# For example, suppose you write a new record without indicating
|
1101
|
+
# `Version` in the request. Timestream will store this record, and set
|
1102
|
+
# `Version` to `1`. Now, suppose you try to update this record with a
|
1103
|
+
# `WriteRecords` request of the same record with a different measure
|
1104
|
+
# value but, like before, do not provide `Version`. In this case,
|
1105
|
+
# Timestream will reject this update with a `RejectedRecordsException`
|
1106
|
+
# since the updated record’s version is not greater than the existing
|
1107
|
+
# value of Version. However, if you were to resend the update request
|
1108
|
+
# with `Version` set to `2`, Timestream would then succeed in updating
|
1109
|
+
# the record’s value, and the `Version` would be set to `2`. Next,
|
1110
|
+
# suppose you sent a `WriteRecords` request with this same record and an
|
1111
|
+
# identical measure value, but with `Version` set to `3`. In this case,
|
1112
|
+
# Timestream would only update `Version` to `3`. Any further updates
|
1113
|
+
# would need to send a version number greater than `3`, or the update
|
1114
|
+
# requests would receive a `RejectedRecordsException`.
|
984
1115
|
#
|
985
1116
|
#
|
986
1117
|
#
|
987
1118
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
1119
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html
|
988
1120
|
#
|
989
1121
|
# @option params [required, String] :database_name
|
990
1122
|
# The name of the Timestream database.
|
991
1123
|
#
|
992
1124
|
# @option params [required, String] :table_name
|
993
|
-
# The name of the
|
1125
|
+
# The name of the Timestream table.
|
994
1126
|
#
|
995
1127
|
# @option params [Types::Record] :common_attributes
|
996
|
-
# A record containing the common measure
|
997
|
-
# across all the records in the request. The measure
|
998
|
-
# attributes specified
|
1128
|
+
# A record containing the common measure, dimension, time, and version
|
1129
|
+
# attributes shared across all the records in the request. The measure
|
1130
|
+
# and dimension attributes specified will be merged with the measure and
|
999
1131
|
# dimension attributes in the records object when the data is written
|
1000
|
-
# into Timestream.
|
1132
|
+
# into Timestream. Dimensions may not overlap, or a
|
1133
|
+
# `ValidationException` will be thrown. In other words, a record must
|
1134
|
+
# contain dimensions with unique names.
|
1001
1135
|
#
|
1002
1136
|
# @option params [required, Array<Types::Record>] :records
|
1003
|
-
# An array of records containing the unique dimension
|
1004
|
-
# attributes for each time series data point.
|
1137
|
+
# An array of records containing the unique measure, dimension, time,
|
1138
|
+
# and version attributes for each time series data point.
|
1005
1139
|
#
|
1006
|
-
# @return [
|
1140
|
+
# @return [Types::WriteRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1141
|
+
#
|
1142
|
+
# * {Types::WriteRecordsResponse#records_ingested #records_ingested} => Types::RecordsIngested
|
1007
1143
|
#
|
1008
1144
|
# @example Request syntax with placeholder values
|
1009
1145
|
#
|
@@ -1013,37 +1149,57 @@ module Aws::TimestreamWrite
|
|
1013
1149
|
# common_attributes: {
|
1014
1150
|
# dimensions: [
|
1015
1151
|
# {
|
1016
|
-
# name: "
|
1017
|
-
# value: "
|
1152
|
+
# name: "SchemaName", # required
|
1153
|
+
# value: "SchemaValue", # required
|
1018
1154
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1019
1155
|
# },
|
1020
1156
|
# ],
|
1021
|
-
# measure_name: "
|
1157
|
+
# measure_name: "SchemaName",
|
1022
1158
|
# measure_value: "StringValue2048",
|
1023
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1159
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1024
1160
|
# time: "StringValue256",
|
1025
1161
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1026
1162
|
# version: 1,
|
1163
|
+
# measure_values: [
|
1164
|
+
# {
|
1165
|
+
# name: "SchemaName", # required
|
1166
|
+
# value: "StringValue2048", # required
|
1167
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1168
|
+
# },
|
1169
|
+
# ],
|
1027
1170
|
# },
|
1028
1171
|
# records: [ # required
|
1029
1172
|
# {
|
1030
1173
|
# dimensions: [
|
1031
1174
|
# {
|
1032
|
-
# name: "
|
1033
|
-
# value: "
|
1175
|
+
# name: "SchemaName", # required
|
1176
|
+
# value: "SchemaValue", # required
|
1034
1177
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1035
1178
|
# },
|
1036
1179
|
# ],
|
1037
|
-
# measure_name: "
|
1180
|
+
# measure_name: "SchemaName",
|
1038
1181
|
# measure_value: "StringValue2048",
|
1039
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1182
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1040
1183
|
# time: "StringValue256",
|
1041
1184
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1042
1185
|
# version: 1,
|
1186
|
+
# measure_values: [
|
1187
|
+
# {
|
1188
|
+
# name: "SchemaName", # required
|
1189
|
+
# value: "StringValue2048", # required
|
1190
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1191
|
+
# },
|
1192
|
+
# ],
|
1043
1193
|
# },
|
1044
1194
|
# ],
|
1045
1195
|
# })
|
1046
1196
|
#
|
1197
|
+
# @example Response structure
|
1198
|
+
#
|
1199
|
+
# resp.records_ingested.total #=> Integer
|
1200
|
+
# resp.records_ingested.memory_store #=> Integer
|
1201
|
+
# resp.records_ingested.magnetic_store #=> Integer
|
1202
|
+
#
|
1047
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords AWS API Documentation
|
1048
1204
|
#
|
1049
1205
|
# @overload write_records(params = {})
|
@@ -1066,7 +1222,7 @@ module Aws::TimestreamWrite
|
|
1066
1222
|
params: params,
|
1067
1223
|
config: config)
|
1068
1224
|
context[:gem_name] = 'aws-sdk-timestreamwrite'
|
1069
|
-
context[:gem_version] = '1.
|
1225
|
+
context[:gem_version] = '1.12.0'
|
1070
1226
|
Seahorse::Client::Request.new(handlers, context)
|
1071
1227
|
end
|
1072
1228
|
|