aws-sdk-timestreamwrite 1.9.0 → 1.13.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 +208 -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: cd1dfcd55fca223d659b7b6a47c5b4cc6c0cf5bd7b80ed072540ad6ff06e33e2
|
4
|
+
data.tar.gz: 7bd6d5f1cc71d94ff258d2326aa3426634698fa1a362b3a39c851443e1c3785d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 578f50a82ee3d00074aaad33949e398b9a07e0448fdd0cf3405de448b024071ee695fc59715fc4099874e5eff4ba095a532867c672c3a9ed2241d2f7a837875c
|
7
|
+
data.tar.gz: 2074f40ed4493c21463e4f68b9740fe958eedf63b82279eed99632506469a128d3d8bf36d33049cb4f3700e0b07ecf439125a4a7600a005aa5bd20f4d9cbdf0e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.13.0 (2022-02-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.12.0 (2021-12-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.11.0 (2021-11-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.10.0 (2021-11-24)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* 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.
|
23
|
+
|
4
24
|
1.9.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.13.0
|
@@ -27,6 +27,8 @@ 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'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::TimestreamWrite
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::TimestreamWrite
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::TimestreamWrite
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -305,7 +315,7 @@ module Aws::TimestreamWrite
|
|
305
315
|
# seconds to wait when opening a HTTP session before raising a
|
306
316
|
# `Timeout::Error`.
|
307
317
|
#
|
308
|
-
# @option options [
|
318
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
319
|
# number of seconds to wait for response data. This value can
|
310
320
|
# safely be set per-request on the session.
|
311
321
|
#
|
@@ -321,6 +331,9 @@ module Aws::TimestreamWrite
|
|
321
331
|
# disables this behaviour. This value can safely be set per
|
322
332
|
# request on the session.
|
323
333
|
#
|
334
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
335
|
+
# in seconds.
|
336
|
+
#
|
324
337
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
338
|
# HTTP debug output will be sent to the `:logger`.
|
326
339
|
#
|
@@ -348,14 +361,15 @@ module Aws::TimestreamWrite
|
|
348
361
|
|
349
362
|
# Creates a new Timestream database. If the KMS key is not specified,
|
350
363
|
# the database will be encrypted with a Timestream managed KMS key
|
351
|
-
# located in your account. Refer to [
|
352
|
-
# info. Service quotas apply.
|
353
|
-
#
|
364
|
+
# located in your account. Refer to [Amazon Web Services managed KMS
|
365
|
+
# keys][1] for more info. [Service quotas apply][2]. See [code
|
366
|
+
# sample][3] for details.
|
354
367
|
#
|
355
368
|
#
|
356
369
|
#
|
357
370
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
358
371
|
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
372
|
+
# [3]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html
|
359
373
|
#
|
360
374
|
# @option params [required, String] :database_name
|
361
375
|
# The name of the Timestream database.
|
@@ -363,7 +377,8 @@ module Aws::TimestreamWrite
|
|
363
377
|
# @option params [String] :kms_key_id
|
364
378
|
# The KMS key for the database. If the KMS key is not specified, the
|
365
379
|
# database will be encrypted with a Timestream managed KMS key located
|
366
|
-
# in your account. Refer to [
|
380
|
+
# in your account. Refer to [Amazon Web Services managed KMS keys][1]
|
381
|
+
# for more info.
|
367
382
|
#
|
368
383
|
#
|
369
384
|
#
|
@@ -379,7 +394,7 @@ module Aws::TimestreamWrite
|
|
379
394
|
# @example Request syntax with placeholder values
|
380
395
|
#
|
381
396
|
# resp = client.create_database({
|
382
|
-
# database_name: "
|
397
|
+
# database_name: "ResourceCreateAPIName", # required
|
383
398
|
# kms_key_id: "StringValue2048",
|
384
399
|
# tags: [
|
385
400
|
# {
|
@@ -408,17 +423,17 @@ module Aws::TimestreamWrite
|
|
408
423
|
end
|
409
424
|
|
410
425
|
# The CreateTable operation adds a new table to an existing database in
|
411
|
-
# your account. In an
|
412
|
-
# within each Region if they are in the same database.
|
413
|
-
# identical table names in the same Region if the tables
|
414
|
-
# databases. While creating the table, you must specify
|
415
|
-
# database name, and the retention properties. Service
|
416
|
-
#
|
417
|
-
# Developer Guide.
|
426
|
+
# your account. In an Amazon Web Services account, table names must be
|
427
|
+
# at least unique within each Region if they are in the same database.
|
428
|
+
# You may have identical table names in the same Region if the tables
|
429
|
+
# are in separate databases. While creating the table, you must specify
|
430
|
+
# the table name, database name, and the retention properties. [Service
|
431
|
+
# quotas apply][1]. See [code sample][2] for details.
|
418
432
|
#
|
419
433
|
#
|
420
434
|
#
|
421
435
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
436
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html
|
422
437
|
#
|
423
438
|
# @option params [required, String] :database_name
|
424
439
|
# The name of the Timestream database.
|
@@ -433,6 +448,10 @@ module Aws::TimestreamWrite
|
|
433
448
|
# @option params [Array<Types::Tag>] :tags
|
434
449
|
# A list of key-value pairs to label the table.
|
435
450
|
#
|
451
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
452
|
+
# Contains properties to set on the table when enabling magnetic store
|
453
|
+
# writes.
|
454
|
+
#
|
436
455
|
# @return [Types::CreateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
437
456
|
#
|
438
457
|
# * {Types::CreateTableResponse#table #table} => Types::Table
|
@@ -440,8 +459,8 @@ module Aws::TimestreamWrite
|
|
440
459
|
# @example Request syntax with placeholder values
|
441
460
|
#
|
442
461
|
# resp = client.create_table({
|
443
|
-
# database_name: "
|
444
|
-
# table_name: "
|
462
|
+
# database_name: "ResourceCreateAPIName", # required
|
463
|
+
# table_name: "ResourceCreateAPIName", # required
|
445
464
|
# retention_properties: {
|
446
465
|
# memory_store_retention_period_in_hours: 1, # required
|
447
466
|
# magnetic_store_retention_period_in_days: 1, # required
|
@@ -452,6 +471,17 @@ module Aws::TimestreamWrite
|
|
452
471
|
# value: "TagValue", # required
|
453
472
|
# },
|
454
473
|
# ],
|
474
|
+
# magnetic_store_write_properties: {
|
475
|
+
# enable_magnetic_store_writes: false, # required
|
476
|
+
# magnetic_store_rejected_data_location: {
|
477
|
+
# s3_configuration: {
|
478
|
+
# bucket_name: "S3BucketName",
|
479
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
480
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
481
|
+
# kms_key_id: "StringValue2048",
|
482
|
+
# },
|
483
|
+
# },
|
484
|
+
# },
|
455
485
|
# })
|
456
486
|
#
|
457
487
|
# @example Response structure
|
@@ -464,6 +494,11 @@ module Aws::TimestreamWrite
|
|
464
494
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
465
495
|
# resp.table.creation_time #=> Time
|
466
496
|
# resp.table.last_updated_time #=> Time
|
497
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
498
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
499
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
500
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
501
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
467
502
|
#
|
468
503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable AWS API Documentation
|
469
504
|
#
|
@@ -478,13 +513,21 @@ module Aws::TimestreamWrite
|
|
478
513
|
# operation. After a database is deleted, the time series data from its
|
479
514
|
# tables cannot be recovered.*
|
480
515
|
#
|
481
|
-
# All tables in the database must be deleted first, or a
|
516
|
+
# <note markdown="1"> All tables in the database must be deleted first, or a
|
482
517
|
# ValidationException error will be thrown.
|
483
518
|
#
|
484
|
-
#
|
519
|
+
# Due to the nature of distributed retries, the operation can return
|
485
520
|
# either success or a ResourceNotFoundException. Clients should consider
|
486
521
|
# them equivalent.
|
487
522
|
#
|
523
|
+
# </note>
|
524
|
+
#
|
525
|
+
# See [code sample][1] for details.
|
526
|
+
#
|
527
|
+
#
|
528
|
+
#
|
529
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html
|
530
|
+
#
|
488
531
|
# @option params [required, String] :database_name
|
489
532
|
# The name of the Timestream database to be deleted.
|
490
533
|
#
|
@@ -509,10 +552,18 @@ module Aws::TimestreamWrite
|
|
509
552
|
# After a Timestream database table is deleted, the time series data
|
510
553
|
# stored in the table cannot be recovered.
|
511
554
|
#
|
512
|
-
# Due to the nature of distributed retries, the operation can return
|
555
|
+
# <note markdown="1"> Due to the nature of distributed retries, the operation can return
|
513
556
|
# either success or a ResourceNotFoundException. Clients should consider
|
514
557
|
# them equivalent.
|
515
558
|
#
|
559
|
+
# </note>
|
560
|
+
#
|
561
|
+
# See [code sample][1] for details.
|
562
|
+
#
|
563
|
+
#
|
564
|
+
#
|
565
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html
|
566
|
+
#
|
516
567
|
# @option params [required, String] :database_name
|
517
568
|
# The name of the database where the Timestream database is to be
|
518
569
|
# deleted.
|
@@ -540,12 +591,13 @@ module Aws::TimestreamWrite
|
|
540
591
|
|
541
592
|
# Returns information about the database, including the database name,
|
542
593
|
# time that the database was created, and the total number of tables
|
543
|
-
# found within the database. Service quotas apply.
|
544
|
-
#
|
594
|
+
# found within the database. [Service quotas apply][1]. See [code
|
595
|
+
# sample][2] for details.
|
545
596
|
#
|
546
597
|
#
|
547
598
|
#
|
548
599
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
600
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html
|
549
601
|
#
|
550
602
|
# @option params [required, String] :database_name
|
551
603
|
# The name of the Timestream database.
|
@@ -582,22 +634,26 @@ module Aws::TimestreamWrite
|
|
582
634
|
# Timestream API calls against. This API is available through both Write
|
583
635
|
# and Query.
|
584
636
|
#
|
585
|
-
# Because Timestream
|
586
|
-
# service’s architecture, including the management and mapping of
|
587
|
-
# service endpoints, *it is not recommended that you use this API
|
637
|
+
# Because the Timestream SDKs are designed to transparently work with
|
638
|
+
# the service’s architecture, including the management and mapping of
|
639
|
+
# the service endpoints, *it is not recommended that you use this API
|
588
640
|
# unless*\:
|
589
641
|
#
|
642
|
+
# * You are using [VPC endpoints (Amazon Web Services PrivateLink) with
|
643
|
+
# Timestream][1]
|
644
|
+
#
|
590
645
|
# * Your application uses a programming language that does not yet have
|
591
646
|
# SDK support
|
592
647
|
#
|
593
648
|
# * You require better control over the client-side implementation
|
594
649
|
#
|
595
|
-
# For detailed information on how to use
|
596
|
-
# Endpoint Discovery Pattern
|
650
|
+
# For detailed information on how and when to use and implement
|
651
|
+
# DescribeEndpoints, see [The Endpoint Discovery Pattern][2].
|
597
652
|
#
|
598
653
|
#
|
599
654
|
#
|
600
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
655
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints
|
656
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery
|
601
657
|
#
|
602
658
|
# @return [Types::DescribeEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
603
659
|
#
|
@@ -620,12 +676,12 @@ module Aws::TimestreamWrite
|
|
620
676
|
|
621
677
|
# Returns information about the table, including the table name,
|
622
678
|
# database name, retention duration of the memory store and the magnetic
|
623
|
-
# store. Service quotas apply.
|
624
|
-
# Management][1] in the Timestream Developer Guide.
|
679
|
+
# store. [Service quotas apply][1]. See [code sample][2] for details.
|
625
680
|
#
|
626
681
|
#
|
627
682
|
#
|
628
683
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
684
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html
|
629
685
|
#
|
630
686
|
# @option params [required, String] :database_name
|
631
687
|
# The name of the Timestream database.
|
@@ -654,6 +710,11 @@ module Aws::TimestreamWrite
|
|
654
710
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
655
711
|
# resp.table.creation_time #=> Time
|
656
712
|
# resp.table.last_updated_time #=> Time
|
713
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
714
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
715
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
716
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
717
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
657
718
|
#
|
658
719
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable AWS API Documentation
|
659
720
|
#
|
@@ -664,13 +725,13 @@ module Aws::TimestreamWrite
|
|
664
725
|
req.send_request(options)
|
665
726
|
end
|
666
727
|
|
667
|
-
# Returns a list of your Timestream databases. Service quotas
|
668
|
-
#
|
669
|
-
# Developer Guide.
|
728
|
+
# Returns a list of your Timestream databases. [Service quotas
|
729
|
+
# apply][1]. See [code sample][2] for details.
|
670
730
|
#
|
671
731
|
#
|
672
732
|
#
|
673
733
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
734
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html
|
674
735
|
#
|
675
736
|
# @option params [String] :next_token
|
676
737
|
# The pagination token. To resume pagination, provide the NextToken
|
@@ -717,7 +778,11 @@ module Aws::TimestreamWrite
|
|
717
778
|
end
|
718
779
|
|
719
780
|
# A list of tables, along with the name, status and retention properties
|
720
|
-
# of each table.
|
781
|
+
# of each table. See [code sample][1] for details.
|
782
|
+
#
|
783
|
+
#
|
784
|
+
#
|
785
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html
|
721
786
|
#
|
722
787
|
# @option params [String] :database_name
|
723
788
|
# The name of the Timestream database.
|
@@ -758,6 +823,11 @@ module Aws::TimestreamWrite
|
|
758
823
|
# resp.tables[0].retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
759
824
|
# resp.tables[0].creation_time #=> Time
|
760
825
|
# resp.tables[0].last_updated_time #=> Time
|
826
|
+
# resp.tables[0].magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
827
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
828
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
829
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
830
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
761
831
|
# resp.next_token #=> String
|
762
832
|
#
|
763
833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables AWS API Documentation
|
@@ -867,6 +937,12 @@ module Aws::TimestreamWrite
|
|
867
937
|
# new KMS key to be used (`KmsKeyId`). If there are any concurrent
|
868
938
|
# `UpdateDatabase` requests, first writer wins.
|
869
939
|
#
|
940
|
+
# See [code sample][1] for details.
|
941
|
+
#
|
942
|
+
#
|
943
|
+
#
|
944
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html
|
945
|
+
#
|
870
946
|
# @option params [required, String] :database_name
|
871
947
|
# The name of the database.
|
872
948
|
#
|
@@ -925,22 +1001,25 @@ module Aws::TimestreamWrite
|
|
925
1001
|
# was made. Timestream does not retrieve data from the magnetic store to
|
926
1002
|
# populate the memory store.
|
927
1003
|
#
|
928
|
-
#
|
929
|
-
# in the Timestream Developer Guide.
|
1004
|
+
# See [code sample][1] for details.
|
930
1005
|
#
|
931
1006
|
#
|
932
1007
|
#
|
933
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
1008
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html
|
934
1009
|
#
|
935
1010
|
# @option params [required, String] :database_name
|
936
1011
|
# The name of the Timestream database.
|
937
1012
|
#
|
938
1013
|
# @option params [required, String] :table_name
|
939
|
-
# The name of the
|
1014
|
+
# The name of the Timestream table.
|
940
1015
|
#
|
941
|
-
# @option params [
|
1016
|
+
# @option params [Types::RetentionProperties] :retention_properties
|
942
1017
|
# The retention duration of the memory store and the magnetic store.
|
943
1018
|
#
|
1019
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
1020
|
+
# Contains properties to set on the table when enabling magnetic store
|
1021
|
+
# writes.
|
1022
|
+
#
|
944
1023
|
# @return [Types::UpdateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
945
1024
|
#
|
946
1025
|
# * {Types::UpdateTableResponse#table #table} => Types::Table
|
@@ -950,10 +1029,21 @@ module Aws::TimestreamWrite
|
|
950
1029
|
# resp = client.update_table({
|
951
1030
|
# database_name: "ResourceName", # required
|
952
1031
|
# table_name: "ResourceName", # required
|
953
|
-
# retention_properties: {
|
1032
|
+
# retention_properties: {
|
954
1033
|
# memory_store_retention_period_in_hours: 1, # required
|
955
1034
|
# magnetic_store_retention_period_in_days: 1, # required
|
956
1035
|
# },
|
1036
|
+
# magnetic_store_write_properties: {
|
1037
|
+
# enable_magnetic_store_writes: false, # required
|
1038
|
+
# magnetic_store_rejected_data_location: {
|
1039
|
+
# s3_configuration: {
|
1040
|
+
# bucket_name: "S3BucketName",
|
1041
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
1042
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1043
|
+
# kms_key_id: "StringValue2048",
|
1044
|
+
# },
|
1045
|
+
# },
|
1046
|
+
# },
|
957
1047
|
# })
|
958
1048
|
#
|
959
1049
|
# @example Response structure
|
@@ -966,6 +1056,11 @@ module Aws::TimestreamWrite
|
|
966
1056
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
967
1057
|
# resp.table.creation_time #=> Time
|
968
1058
|
# resp.table.last_updated_time #=> Time
|
1059
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
1060
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
1061
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
1062
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
1063
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
969
1064
|
#
|
970
1065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable AWS API Documentation
|
971
1066
|
#
|
@@ -987,32 +1082,66 @@ module Aws::TimestreamWrite
|
|
987
1082
|
# into Timestream, the query results might not reflect the results of a
|
988
1083
|
# recently completed write operation. The results may also include some
|
989
1084
|
# stale data. If you repeat the query request after a short time, the
|
990
|
-
# results should return the latest data. Service quotas apply.
|
991
|
-
#
|
992
|
-
#
|
1085
|
+
# results should return the latest data. [Service quotas apply][1].
|
1086
|
+
#
|
1087
|
+
# See [code sample][2] for details.
|
1088
|
+
#
|
1089
|
+
# **Upserts**
|
1090
|
+
#
|
1091
|
+
# You can use the `Version` parameter in a `WriteRecords` request to
|
1092
|
+
# update data points. Timestream tracks a version number with each
|
1093
|
+
# record. `Version` defaults to `1` when not specified for the record in
|
1094
|
+
# the request. Timestream will update an existing record’s measure value
|
1095
|
+
# along with its `Version` upon receiving a write request with a higher
|
1096
|
+
# `Version` number for that record. Upon receiving an update request
|
1097
|
+
# where the measure value is the same as that of the existing record,
|
1098
|
+
# Timestream still updates `Version`, if it is greater than the existing
|
1099
|
+
# value of `Version`. You can update a data point as many times as
|
1100
|
+
# desired, as long as the value of `Version` continuously increases.
|
1101
|
+
#
|
1102
|
+
# For example, suppose you write a new record without indicating
|
1103
|
+
# `Version` in the request. Timestream will store this record, and set
|
1104
|
+
# `Version` to `1`. Now, suppose you try to update this record with a
|
1105
|
+
# `WriteRecords` request of the same record with a different measure
|
1106
|
+
# value but, like before, do not provide `Version`. In this case,
|
1107
|
+
# Timestream will reject this update with a `RejectedRecordsException`
|
1108
|
+
# since the updated record’s version is not greater than the existing
|
1109
|
+
# value of Version. However, if you were to resend the update request
|
1110
|
+
# with `Version` set to `2`, Timestream would then succeed in updating
|
1111
|
+
# the record’s value, and the `Version` would be set to `2`. Next,
|
1112
|
+
# suppose you sent a `WriteRecords` request with this same record and an
|
1113
|
+
# identical measure value, but with `Version` set to `3`. In this case,
|
1114
|
+
# Timestream would only update `Version` to `3`. Any further updates
|
1115
|
+
# would need to send a version number greater than `3`, or the update
|
1116
|
+
# requests would receive a `RejectedRecordsException`.
|
993
1117
|
#
|
994
1118
|
#
|
995
1119
|
#
|
996
1120
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
1121
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html
|
997
1122
|
#
|
998
1123
|
# @option params [required, String] :database_name
|
999
1124
|
# The name of the Timestream database.
|
1000
1125
|
#
|
1001
1126
|
# @option params [required, String] :table_name
|
1002
|
-
# The name of the
|
1127
|
+
# The name of the Timestream table.
|
1003
1128
|
#
|
1004
1129
|
# @option params [Types::Record] :common_attributes
|
1005
|
-
# A record containing the common measure
|
1006
|
-
# across all the records in the request. The measure
|
1007
|
-
# attributes specified
|
1130
|
+
# A record containing the common measure, dimension, time, and version
|
1131
|
+
# attributes shared across all the records in the request. The measure
|
1132
|
+
# and dimension attributes specified will be merged with the measure and
|
1008
1133
|
# dimension attributes in the records object when the data is written
|
1009
|
-
# into Timestream.
|
1134
|
+
# into Timestream. Dimensions may not overlap, or a
|
1135
|
+
# `ValidationException` will be thrown. In other words, a record must
|
1136
|
+
# contain dimensions with unique names.
|
1010
1137
|
#
|
1011
1138
|
# @option params [required, Array<Types::Record>] :records
|
1012
|
-
# An array of records containing the unique dimension
|
1013
|
-
# attributes for each time series data point.
|
1139
|
+
# An array of records containing the unique measure, dimension, time,
|
1140
|
+
# and version attributes for each time series data point.
|
1014
1141
|
#
|
1015
|
-
# @return [
|
1142
|
+
# @return [Types::WriteRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1143
|
+
#
|
1144
|
+
# * {Types::WriteRecordsResponse#records_ingested #records_ingested} => Types::RecordsIngested
|
1016
1145
|
#
|
1017
1146
|
# @example Request syntax with placeholder values
|
1018
1147
|
#
|
@@ -1022,37 +1151,57 @@ module Aws::TimestreamWrite
|
|
1022
1151
|
# common_attributes: {
|
1023
1152
|
# dimensions: [
|
1024
1153
|
# {
|
1025
|
-
# name: "
|
1026
|
-
# value: "
|
1154
|
+
# name: "SchemaName", # required
|
1155
|
+
# value: "SchemaValue", # required
|
1027
1156
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1028
1157
|
# },
|
1029
1158
|
# ],
|
1030
|
-
# measure_name: "
|
1159
|
+
# measure_name: "SchemaName",
|
1031
1160
|
# measure_value: "StringValue2048",
|
1032
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1161
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1033
1162
|
# time: "StringValue256",
|
1034
1163
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1035
1164
|
# version: 1,
|
1165
|
+
# measure_values: [
|
1166
|
+
# {
|
1167
|
+
# name: "SchemaName", # required
|
1168
|
+
# value: "StringValue2048", # required
|
1169
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1170
|
+
# },
|
1171
|
+
# ],
|
1036
1172
|
# },
|
1037
1173
|
# records: [ # required
|
1038
1174
|
# {
|
1039
1175
|
# dimensions: [
|
1040
1176
|
# {
|
1041
|
-
# name: "
|
1042
|
-
# value: "
|
1177
|
+
# name: "SchemaName", # required
|
1178
|
+
# value: "SchemaValue", # required
|
1043
1179
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1044
1180
|
# },
|
1045
1181
|
# ],
|
1046
|
-
# measure_name: "
|
1182
|
+
# measure_name: "SchemaName",
|
1047
1183
|
# measure_value: "StringValue2048",
|
1048
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1184
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1049
1185
|
# time: "StringValue256",
|
1050
1186
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1051
1187
|
# version: 1,
|
1188
|
+
# measure_values: [
|
1189
|
+
# {
|
1190
|
+
# name: "SchemaName", # required
|
1191
|
+
# value: "StringValue2048", # required
|
1192
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1193
|
+
# },
|
1194
|
+
# ],
|
1052
1195
|
# },
|
1053
1196
|
# ],
|
1054
1197
|
# })
|
1055
1198
|
#
|
1199
|
+
# @example Response structure
|
1200
|
+
#
|
1201
|
+
# resp.records_ingested.total #=> Integer
|
1202
|
+
# resp.records_ingested.memory_store #=> Integer
|
1203
|
+
# resp.records_ingested.magnetic_store #=> Integer
|
1204
|
+
#
|
1056
1205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords AWS API Documentation
|
1057
1206
|
#
|
1058
1207
|
# @overload write_records(params = {})
|
@@ -1075,7 +1224,7 @@ module Aws::TimestreamWrite
|
|
1075
1224
|
params: params,
|
1076
1225
|
config: config)
|
1077
1226
|
context[:gem_name] = 'aws-sdk-timestreamwrite'
|
1078
|
-
context[:gem_version] = '1.
|
1227
|
+
context[:gem_version] = '1.13.0'
|
1079
1228
|
Seahorse::Client::Request.new(handlers, context)
|
1080
1229
|
end
|
1081
1230
|
|