aws-sdk-timestreamwrite 1.9.0 → 1.10.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamwrite/client.rb +193 -57
- 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 +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0ae40fff8c6c44dc2533748a9344dbd474c400e787af3bc12a388e53f2be4d92
|
4
|
+
data.tar.gz: ed15a1ec7c8eb839bb7202e9a104290546e743c1026a3c8f7cac43c692e19d64
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f60e8d37d951397df7eae9aeedba7e3a63b1dd6282b9c9f560636bc30b27a8350f568e970d5265a38d928aeacb9d3b060f89ed03cac602a2bff5bf7ddf50d252
|
7
|
+
data.tar.gz: 0f05c40fb1c3a92bb332c4d888562bf2568aaa93606d182f2de8f5d2ea4739d79756b2d6c223fb43a65aa1aea7bfb9a8e02c57f3109f57f88920cc42ac9cc418
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.10.0 (2021-11-24)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* 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.
|
8
|
+
|
4
9
|
1.9.0 (2021-11-04)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.10.0
|
@@ -348,14 +348,15 @@ module Aws::TimestreamWrite
|
|
348
348
|
|
349
349
|
# Creates a new Timestream database. If the KMS key is not specified,
|
350
350
|
# the database will be encrypted with a Timestream managed KMS key
|
351
|
-
# located in your account. Refer to [
|
352
|
-
# info. Service quotas apply.
|
353
|
-
#
|
351
|
+
# located in your account. Refer to [Amazon Web Services managed KMS
|
352
|
+
# keys][1] for more info. [Service quotas apply][2]. See [code
|
353
|
+
# sample][3] for details.
|
354
354
|
#
|
355
355
|
#
|
356
356
|
#
|
357
357
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
358
358
|
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
359
|
+
# [3]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html
|
359
360
|
#
|
360
361
|
# @option params [required, String] :database_name
|
361
362
|
# The name of the Timestream database.
|
@@ -363,7 +364,8 @@ module Aws::TimestreamWrite
|
|
363
364
|
# @option params [String] :kms_key_id
|
364
365
|
# The KMS key for the database. If the KMS key is not specified, the
|
365
366
|
# database will be encrypted with a Timestream managed KMS key located
|
366
|
-
# in your account. Refer to [
|
367
|
+
# in your account. Refer to [Amazon Web Services managed KMS keys][1]
|
368
|
+
# for more info.
|
367
369
|
#
|
368
370
|
#
|
369
371
|
#
|
@@ -379,7 +381,7 @@ module Aws::TimestreamWrite
|
|
379
381
|
# @example Request syntax with placeholder values
|
380
382
|
#
|
381
383
|
# resp = client.create_database({
|
382
|
-
# database_name: "
|
384
|
+
# database_name: "ResourceCreateAPIName", # required
|
383
385
|
# kms_key_id: "StringValue2048",
|
384
386
|
# tags: [
|
385
387
|
# {
|
@@ -408,17 +410,17 @@ module Aws::TimestreamWrite
|
|
408
410
|
end
|
409
411
|
|
410
412
|
# 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.
|
413
|
+
# your account. In an Amazon Web Services account, table names must be
|
414
|
+
# at least unique within each Region if they are in the same database.
|
415
|
+
# You may have identical table names in the same Region if the tables
|
416
|
+
# are in separate databases. While creating the table, you must specify
|
417
|
+
# the table name, database name, and the retention properties. [Service
|
418
|
+
# quotas apply][1]. See [code sample][2] for details.
|
418
419
|
#
|
419
420
|
#
|
420
421
|
#
|
421
422
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
423
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html
|
422
424
|
#
|
423
425
|
# @option params [required, String] :database_name
|
424
426
|
# The name of the Timestream database.
|
@@ -433,6 +435,10 @@ module Aws::TimestreamWrite
|
|
433
435
|
# @option params [Array<Types::Tag>] :tags
|
434
436
|
# A list of key-value pairs to label the table.
|
435
437
|
#
|
438
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
439
|
+
# Contains properties to set on the table when enabling magnetic store
|
440
|
+
# writes.
|
441
|
+
#
|
436
442
|
# @return [Types::CreateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
437
443
|
#
|
438
444
|
# * {Types::CreateTableResponse#table #table} => Types::Table
|
@@ -440,8 +446,8 @@ module Aws::TimestreamWrite
|
|
440
446
|
# @example Request syntax with placeholder values
|
441
447
|
#
|
442
448
|
# resp = client.create_table({
|
443
|
-
# database_name: "
|
444
|
-
# table_name: "
|
449
|
+
# database_name: "ResourceCreateAPIName", # required
|
450
|
+
# table_name: "ResourceCreateAPIName", # required
|
445
451
|
# retention_properties: {
|
446
452
|
# memory_store_retention_period_in_hours: 1, # required
|
447
453
|
# magnetic_store_retention_period_in_days: 1, # required
|
@@ -452,6 +458,17 @@ module Aws::TimestreamWrite
|
|
452
458
|
# value: "TagValue", # required
|
453
459
|
# },
|
454
460
|
# ],
|
461
|
+
# magnetic_store_write_properties: {
|
462
|
+
# enable_magnetic_store_writes: false, # required
|
463
|
+
# magnetic_store_rejected_data_location: {
|
464
|
+
# s3_configuration: {
|
465
|
+
# bucket_name: "S3BucketName",
|
466
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
467
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
468
|
+
# kms_key_id: "StringValue2048",
|
469
|
+
# },
|
470
|
+
# },
|
471
|
+
# },
|
455
472
|
# })
|
456
473
|
#
|
457
474
|
# @example Response structure
|
@@ -464,6 +481,11 @@ module Aws::TimestreamWrite
|
|
464
481
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
465
482
|
# resp.table.creation_time #=> Time
|
466
483
|
# resp.table.last_updated_time #=> Time
|
484
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
485
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
486
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
487
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
488
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
467
489
|
#
|
468
490
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable AWS API Documentation
|
469
491
|
#
|
@@ -478,13 +500,21 @@ module Aws::TimestreamWrite
|
|
478
500
|
# operation. After a database is deleted, the time series data from its
|
479
501
|
# tables cannot be recovered.*
|
480
502
|
#
|
481
|
-
# All tables in the database must be deleted first, or a
|
503
|
+
# <note markdown="1"> All tables in the database must be deleted first, or a
|
482
504
|
# ValidationException error will be thrown.
|
483
505
|
#
|
484
|
-
#
|
506
|
+
# Due to the nature of distributed retries, the operation can return
|
485
507
|
# either success or a ResourceNotFoundException. Clients should consider
|
486
508
|
# them equivalent.
|
487
509
|
#
|
510
|
+
# </note>
|
511
|
+
#
|
512
|
+
# See [code sample][1] for details.
|
513
|
+
#
|
514
|
+
#
|
515
|
+
#
|
516
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html
|
517
|
+
#
|
488
518
|
# @option params [required, String] :database_name
|
489
519
|
# The name of the Timestream database to be deleted.
|
490
520
|
#
|
@@ -509,10 +539,18 @@ module Aws::TimestreamWrite
|
|
509
539
|
# After a Timestream database table is deleted, the time series data
|
510
540
|
# stored in the table cannot be recovered.
|
511
541
|
#
|
512
|
-
# Due to the nature of distributed retries, the operation can return
|
542
|
+
# <note markdown="1"> Due to the nature of distributed retries, the operation can return
|
513
543
|
# either success or a ResourceNotFoundException. Clients should consider
|
514
544
|
# them equivalent.
|
515
545
|
#
|
546
|
+
# </note>
|
547
|
+
#
|
548
|
+
# See [code sample][1] for details.
|
549
|
+
#
|
550
|
+
#
|
551
|
+
#
|
552
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html
|
553
|
+
#
|
516
554
|
# @option params [required, String] :database_name
|
517
555
|
# The name of the database where the Timestream database is to be
|
518
556
|
# deleted.
|
@@ -540,12 +578,13 @@ module Aws::TimestreamWrite
|
|
540
578
|
|
541
579
|
# Returns information about the database, including the database name,
|
542
580
|
# time that the database was created, and the total number of tables
|
543
|
-
# found within the database. Service quotas apply.
|
544
|
-
#
|
581
|
+
# found within the database. [Service quotas apply][1]. See [code
|
582
|
+
# sample][2] for details.
|
545
583
|
#
|
546
584
|
#
|
547
585
|
#
|
548
586
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
587
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html
|
549
588
|
#
|
550
589
|
# @option params [required, String] :database_name
|
551
590
|
# The name of the Timestream database.
|
@@ -582,22 +621,26 @@ module Aws::TimestreamWrite
|
|
582
621
|
# Timestream API calls against. This API is available through both Write
|
583
622
|
# and Query.
|
584
623
|
#
|
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
|
624
|
+
# Because the Timestream SDKs are designed to transparently work with
|
625
|
+
# the service’s architecture, including the management and mapping of
|
626
|
+
# the service endpoints, *it is not recommended that you use this API
|
588
627
|
# unless*\:
|
589
628
|
#
|
629
|
+
# * You are using [VPC endpoints (Amazon Web Services PrivateLink) with
|
630
|
+
# Timestream][1]
|
631
|
+
#
|
590
632
|
# * Your application uses a programming language that does not yet have
|
591
633
|
# SDK support
|
592
634
|
#
|
593
635
|
# * You require better control over the client-side implementation
|
594
636
|
#
|
595
|
-
# For detailed information on how to use
|
596
|
-
# Endpoint Discovery Pattern
|
637
|
+
# For detailed information on how and when to use and implement
|
638
|
+
# DescribeEndpoints, see [The Endpoint Discovery Pattern][2].
|
597
639
|
#
|
598
640
|
#
|
599
641
|
#
|
600
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
642
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints
|
643
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery
|
601
644
|
#
|
602
645
|
# @return [Types::DescribeEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
603
646
|
#
|
@@ -620,12 +663,12 @@ module Aws::TimestreamWrite
|
|
620
663
|
|
621
664
|
# Returns information about the table, including the table name,
|
622
665
|
# database name, retention duration of the memory store and the magnetic
|
623
|
-
# store. Service quotas apply.
|
624
|
-
# Management][1] in the Timestream Developer Guide.
|
666
|
+
# store. [Service quotas apply][1]. See [code sample][2] for details.
|
625
667
|
#
|
626
668
|
#
|
627
669
|
#
|
628
670
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
671
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html
|
629
672
|
#
|
630
673
|
# @option params [required, String] :database_name
|
631
674
|
# The name of the Timestream database.
|
@@ -654,6 +697,11 @@ module Aws::TimestreamWrite
|
|
654
697
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
655
698
|
# resp.table.creation_time #=> Time
|
656
699
|
# resp.table.last_updated_time #=> Time
|
700
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
701
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
702
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
703
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
704
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
657
705
|
#
|
658
706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable AWS API Documentation
|
659
707
|
#
|
@@ -664,13 +712,13 @@ module Aws::TimestreamWrite
|
|
664
712
|
req.send_request(options)
|
665
713
|
end
|
666
714
|
|
667
|
-
# Returns a list of your Timestream databases. Service quotas
|
668
|
-
#
|
669
|
-
# Developer Guide.
|
715
|
+
# Returns a list of your Timestream databases. [Service quotas
|
716
|
+
# apply][1]. See [code sample][2] for details.
|
670
717
|
#
|
671
718
|
#
|
672
719
|
#
|
673
720
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
721
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html
|
674
722
|
#
|
675
723
|
# @option params [String] :next_token
|
676
724
|
# The pagination token. To resume pagination, provide the NextToken
|
@@ -717,7 +765,11 @@ module Aws::TimestreamWrite
|
|
717
765
|
end
|
718
766
|
|
719
767
|
# A list of tables, along with the name, status and retention properties
|
720
|
-
# of each table.
|
768
|
+
# of each table. See [code sample][1] for details.
|
769
|
+
#
|
770
|
+
#
|
771
|
+
#
|
772
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html
|
721
773
|
#
|
722
774
|
# @option params [String] :database_name
|
723
775
|
# The name of the Timestream database.
|
@@ -758,6 +810,11 @@ module Aws::TimestreamWrite
|
|
758
810
|
# resp.tables[0].retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
759
811
|
# resp.tables[0].creation_time #=> Time
|
760
812
|
# resp.tables[0].last_updated_time #=> Time
|
813
|
+
# resp.tables[0].magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
814
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
815
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
816
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
817
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
761
818
|
# resp.next_token #=> String
|
762
819
|
#
|
763
820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables AWS API Documentation
|
@@ -867,6 +924,12 @@ module Aws::TimestreamWrite
|
|
867
924
|
# new KMS key to be used (`KmsKeyId`). If there are any concurrent
|
868
925
|
# `UpdateDatabase` requests, first writer wins.
|
869
926
|
#
|
927
|
+
# See [code sample][1] for details.
|
928
|
+
#
|
929
|
+
#
|
930
|
+
#
|
931
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html
|
932
|
+
#
|
870
933
|
# @option params [required, String] :database_name
|
871
934
|
# The name of the database.
|
872
935
|
#
|
@@ -925,22 +988,25 @@ module Aws::TimestreamWrite
|
|
925
988
|
# was made. Timestream does not retrieve data from the magnetic store to
|
926
989
|
# populate the memory store.
|
927
990
|
#
|
928
|
-
#
|
929
|
-
# in the Timestream Developer Guide.
|
991
|
+
# See [code sample][1] for details.
|
930
992
|
#
|
931
993
|
#
|
932
994
|
#
|
933
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
995
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html
|
934
996
|
#
|
935
997
|
# @option params [required, String] :database_name
|
936
998
|
# The name of the Timestream database.
|
937
999
|
#
|
938
1000
|
# @option params [required, String] :table_name
|
939
|
-
# The name of the
|
1001
|
+
# The name of the Timestream table.
|
940
1002
|
#
|
941
|
-
# @option params [
|
1003
|
+
# @option params [Types::RetentionProperties] :retention_properties
|
942
1004
|
# The retention duration of the memory store and the magnetic store.
|
943
1005
|
#
|
1006
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
1007
|
+
# Contains properties to set on the table when enabling magnetic store
|
1008
|
+
# writes.
|
1009
|
+
#
|
944
1010
|
# @return [Types::UpdateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
945
1011
|
#
|
946
1012
|
# * {Types::UpdateTableResponse#table #table} => Types::Table
|
@@ -950,10 +1016,21 @@ module Aws::TimestreamWrite
|
|
950
1016
|
# resp = client.update_table({
|
951
1017
|
# database_name: "ResourceName", # required
|
952
1018
|
# table_name: "ResourceName", # required
|
953
|
-
# retention_properties: {
|
1019
|
+
# retention_properties: {
|
954
1020
|
# memory_store_retention_period_in_hours: 1, # required
|
955
1021
|
# magnetic_store_retention_period_in_days: 1, # required
|
956
1022
|
# },
|
1023
|
+
# magnetic_store_write_properties: {
|
1024
|
+
# enable_magnetic_store_writes: false, # required
|
1025
|
+
# magnetic_store_rejected_data_location: {
|
1026
|
+
# s3_configuration: {
|
1027
|
+
# bucket_name: "S3BucketName",
|
1028
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
1029
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1030
|
+
# kms_key_id: "StringValue2048",
|
1031
|
+
# },
|
1032
|
+
# },
|
1033
|
+
# },
|
957
1034
|
# })
|
958
1035
|
#
|
959
1036
|
# @example Response structure
|
@@ -966,6 +1043,11 @@ module Aws::TimestreamWrite
|
|
966
1043
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
967
1044
|
# resp.table.creation_time #=> Time
|
968
1045
|
# resp.table.last_updated_time #=> Time
|
1046
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
1047
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
1048
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
1049
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
1050
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
969
1051
|
#
|
970
1052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable AWS API Documentation
|
971
1053
|
#
|
@@ -987,32 +1069,66 @@ module Aws::TimestreamWrite
|
|
987
1069
|
# into Timestream, the query results might not reflect the results of a
|
988
1070
|
# recently completed write operation. The results may also include some
|
989
1071
|
# 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
|
-
#
|
1072
|
+
# results should return the latest data. [Service quotas apply][1].
|
1073
|
+
#
|
1074
|
+
# See [code sample][2] for details.
|
1075
|
+
#
|
1076
|
+
# **Upserts**
|
1077
|
+
#
|
1078
|
+
# You can use the `Version` parameter in a `WriteRecords` request to
|
1079
|
+
# update data points. Timestream tracks a version number with each
|
1080
|
+
# record. `Version` defaults to `1` when not specified for the record in
|
1081
|
+
# the request. Timestream will update an existing record’s measure value
|
1082
|
+
# along with its `Version` upon receiving a write request with a higher
|
1083
|
+
# `Version` number for that record. Upon receiving an update request
|
1084
|
+
# where the measure value is the same as that of the existing record,
|
1085
|
+
# Timestream still updates `Version`, if it is greater than the existing
|
1086
|
+
# value of `Version`. You can update a data point as many times as
|
1087
|
+
# desired, as long as the value of `Version` continuously increases.
|
1088
|
+
#
|
1089
|
+
# For example, suppose you write a new record without indicating
|
1090
|
+
# `Version` in the request. Timestream will store this record, and set
|
1091
|
+
# `Version` to `1`. Now, suppose you try to update this record with a
|
1092
|
+
# `WriteRecords` request of the same record with a different measure
|
1093
|
+
# value but, like before, do not provide `Version`. In this case,
|
1094
|
+
# Timestream will reject this update with a `RejectedRecordsException`
|
1095
|
+
# since the updated record’s version is not greater than the existing
|
1096
|
+
# value of Version. However, if you were to resend the update request
|
1097
|
+
# with `Version` set to `2`, Timestream would then succeed in updating
|
1098
|
+
# the record’s value, and the `Version` would be set to `2`. Next,
|
1099
|
+
# suppose you sent a `WriteRecords` request with this same record and an
|
1100
|
+
# identical measure value, but with `Version` set to `3`. In this case,
|
1101
|
+
# Timestream would only update `Version` to `3`. Any further updates
|
1102
|
+
# would need to send a version number greater than `3`, or the update
|
1103
|
+
# requests would receive a `RejectedRecordsException`.
|
993
1104
|
#
|
994
1105
|
#
|
995
1106
|
#
|
996
1107
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
1108
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html
|
997
1109
|
#
|
998
1110
|
# @option params [required, String] :database_name
|
999
1111
|
# The name of the Timestream database.
|
1000
1112
|
#
|
1001
1113
|
# @option params [required, String] :table_name
|
1002
|
-
# The name of the
|
1114
|
+
# The name of the Timestream table.
|
1003
1115
|
#
|
1004
1116
|
# @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
|
1117
|
+
# A record containing the common measure, dimension, time, and version
|
1118
|
+
# attributes shared across all the records in the request. The measure
|
1119
|
+
# and dimension attributes specified will be merged with the measure and
|
1008
1120
|
# dimension attributes in the records object when the data is written
|
1009
|
-
# into Timestream.
|
1121
|
+
# into Timestream. Dimensions may not overlap, or a
|
1122
|
+
# `ValidationException` will be thrown. In other words, a record must
|
1123
|
+
# contain dimensions with unique names.
|
1010
1124
|
#
|
1011
1125
|
# @option params [required, Array<Types::Record>] :records
|
1012
|
-
# An array of records containing the unique dimension
|
1013
|
-
# attributes for each time series data point.
|
1126
|
+
# An array of records containing the unique measure, dimension, time,
|
1127
|
+
# and version attributes for each time series data point.
|
1014
1128
|
#
|
1015
|
-
# @return [
|
1129
|
+
# @return [Types::WriteRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1130
|
+
#
|
1131
|
+
# * {Types::WriteRecordsResponse#records_ingested #records_ingested} => Types::RecordsIngested
|
1016
1132
|
#
|
1017
1133
|
# @example Request syntax with placeholder values
|
1018
1134
|
#
|
@@ -1022,37 +1138,57 @@ module Aws::TimestreamWrite
|
|
1022
1138
|
# common_attributes: {
|
1023
1139
|
# dimensions: [
|
1024
1140
|
# {
|
1025
|
-
# name: "
|
1026
|
-
# value: "
|
1141
|
+
# name: "SchemaName", # required
|
1142
|
+
# value: "SchemaValue", # required
|
1027
1143
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1028
1144
|
# },
|
1029
1145
|
# ],
|
1030
|
-
# measure_name: "
|
1146
|
+
# measure_name: "SchemaName",
|
1031
1147
|
# measure_value: "StringValue2048",
|
1032
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1148
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1033
1149
|
# time: "StringValue256",
|
1034
1150
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1035
1151
|
# version: 1,
|
1152
|
+
# measure_values: [
|
1153
|
+
# {
|
1154
|
+
# name: "SchemaName", # required
|
1155
|
+
# value: "StringValue2048", # required
|
1156
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1157
|
+
# },
|
1158
|
+
# ],
|
1036
1159
|
# },
|
1037
1160
|
# records: [ # required
|
1038
1161
|
# {
|
1039
1162
|
# dimensions: [
|
1040
1163
|
# {
|
1041
|
-
# name: "
|
1042
|
-
# value: "
|
1164
|
+
# name: "SchemaName", # required
|
1165
|
+
# value: "SchemaValue", # required
|
1043
1166
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1044
1167
|
# },
|
1045
1168
|
# ],
|
1046
|
-
# measure_name: "
|
1169
|
+
# measure_name: "SchemaName",
|
1047
1170
|
# measure_value: "StringValue2048",
|
1048
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1171
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1049
1172
|
# time: "StringValue256",
|
1050
1173
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1051
1174
|
# version: 1,
|
1175
|
+
# measure_values: [
|
1176
|
+
# {
|
1177
|
+
# name: "SchemaName", # required
|
1178
|
+
# value: "StringValue2048", # required
|
1179
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1180
|
+
# },
|
1181
|
+
# ],
|
1052
1182
|
# },
|
1053
1183
|
# ],
|
1054
1184
|
# })
|
1055
1185
|
#
|
1186
|
+
# @example Response structure
|
1187
|
+
#
|
1188
|
+
# resp.records_ingested.total #=> Integer
|
1189
|
+
# resp.records_ingested.memory_store #=> Integer
|
1190
|
+
# resp.records_ingested.magnetic_store #=> Integer
|
1191
|
+
#
|
1056
1192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords AWS API Documentation
|
1057
1193
|
#
|
1058
1194
|
# @overload write_records(params = {})
|
@@ -1075,7 +1211,7 @@ module Aws::TimestreamWrite
|
|
1075
1211
|
params: params,
|
1076
1212
|
config: config)
|
1077
1213
|
context[:gem_name] = 'aws-sdk-timestreamwrite'
|
1078
|
-
context[:gem_version] = '1.
|
1214
|
+
context[:gem_version] = '1.10.0'
|
1079
1215
|
Seahorse::Client::Request.new(handlers, context)
|
1080
1216
|
end
|
1081
1217
|
|