aws-sdk-timestreamwrite 1.6.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreamwrite/client.rb +202 -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 +5 -5
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,26 @@
|
|
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
|
+
|
9
|
+
1.9.0 (2021-11-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.8.0 (2021-10-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.7.0 (2021-09-01)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.6.0 (2021-07-30)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.10.0
|
@@ -285,6 +285,15 @@ module Aws::TimestreamWrite
|
|
285
285
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
286
|
# requests are made, and retries are disabled.
|
287
287
|
#
|
288
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
289
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
290
|
+
# will be used if available.
|
291
|
+
#
|
292
|
+
# @option options [Boolean] :use_fips_endpoint
|
293
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
294
|
+
# When a `fips` region is used, the region is normalized and this config
|
295
|
+
# is set to `true`.
|
296
|
+
#
|
288
297
|
# @option options [Boolean] :validate_params (true)
|
289
298
|
# When `true`, request parameters are validated before
|
290
299
|
# sending the request.
|
@@ -339,14 +348,15 @@ module Aws::TimestreamWrite
|
|
339
348
|
|
340
349
|
# Creates a new Timestream database. If the KMS key is not specified,
|
341
350
|
# the database will be encrypted with a Timestream managed KMS key
|
342
|
-
# located in your account. Refer to [
|
343
|
-
# info. Service quotas apply.
|
344
|
-
#
|
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.
|
345
354
|
#
|
346
355
|
#
|
347
356
|
#
|
348
357
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
349
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
|
350
360
|
#
|
351
361
|
# @option params [required, String] :database_name
|
352
362
|
# The name of the Timestream database.
|
@@ -354,7 +364,8 @@ module Aws::TimestreamWrite
|
|
354
364
|
# @option params [String] :kms_key_id
|
355
365
|
# The KMS key for the database. If the KMS key is not specified, the
|
356
366
|
# database will be encrypted with a Timestream managed KMS key located
|
357
|
-
# in your account. Refer to [
|
367
|
+
# in your account. Refer to [Amazon Web Services managed KMS keys][1]
|
368
|
+
# for more info.
|
358
369
|
#
|
359
370
|
#
|
360
371
|
#
|
@@ -370,7 +381,7 @@ module Aws::TimestreamWrite
|
|
370
381
|
# @example Request syntax with placeholder values
|
371
382
|
#
|
372
383
|
# resp = client.create_database({
|
373
|
-
# database_name: "
|
384
|
+
# database_name: "ResourceCreateAPIName", # required
|
374
385
|
# kms_key_id: "StringValue2048",
|
375
386
|
# tags: [
|
376
387
|
# {
|
@@ -399,17 +410,17 @@ module Aws::TimestreamWrite
|
|
399
410
|
end
|
400
411
|
|
401
412
|
# 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.
|
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.
|
409
419
|
#
|
410
420
|
#
|
411
421
|
#
|
412
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
|
413
424
|
#
|
414
425
|
# @option params [required, String] :database_name
|
415
426
|
# The name of the Timestream database.
|
@@ -424,6 +435,10 @@ module Aws::TimestreamWrite
|
|
424
435
|
# @option params [Array<Types::Tag>] :tags
|
425
436
|
# A list of key-value pairs to label the table.
|
426
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
|
+
#
|
427
442
|
# @return [Types::CreateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
443
|
#
|
429
444
|
# * {Types::CreateTableResponse#table #table} => Types::Table
|
@@ -431,8 +446,8 @@ module Aws::TimestreamWrite
|
|
431
446
|
# @example Request syntax with placeholder values
|
432
447
|
#
|
433
448
|
# resp = client.create_table({
|
434
|
-
# database_name: "
|
435
|
-
# table_name: "
|
449
|
+
# database_name: "ResourceCreateAPIName", # required
|
450
|
+
# table_name: "ResourceCreateAPIName", # required
|
436
451
|
# retention_properties: {
|
437
452
|
# memory_store_retention_period_in_hours: 1, # required
|
438
453
|
# magnetic_store_retention_period_in_days: 1, # required
|
@@ -443,6 +458,17 @@ module Aws::TimestreamWrite
|
|
443
458
|
# value: "TagValue", # required
|
444
459
|
# },
|
445
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
|
+
# },
|
446
472
|
# })
|
447
473
|
#
|
448
474
|
# @example Response structure
|
@@ -455,6 +481,11 @@ module Aws::TimestreamWrite
|
|
455
481
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
456
482
|
# resp.table.creation_time #=> Time
|
457
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
|
458
489
|
#
|
459
490
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable AWS API Documentation
|
460
491
|
#
|
@@ -469,13 +500,21 @@ module Aws::TimestreamWrite
|
|
469
500
|
# operation. After a database is deleted, the time series data from its
|
470
501
|
# tables cannot be recovered.*
|
471
502
|
#
|
472
|
-
# 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
|
473
504
|
# ValidationException error will be thrown.
|
474
505
|
#
|
475
|
-
#
|
506
|
+
# Due to the nature of distributed retries, the operation can return
|
476
507
|
# either success or a ResourceNotFoundException. Clients should consider
|
477
508
|
# them equivalent.
|
478
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
|
+
#
|
479
518
|
# @option params [required, String] :database_name
|
480
519
|
# The name of the Timestream database to be deleted.
|
481
520
|
#
|
@@ -500,10 +539,18 @@ module Aws::TimestreamWrite
|
|
500
539
|
# After a Timestream database table is deleted, the time series data
|
501
540
|
# stored in the table cannot be recovered.
|
502
541
|
#
|
503
|
-
# 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
|
504
543
|
# either success or a ResourceNotFoundException. Clients should consider
|
505
544
|
# them equivalent.
|
506
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
|
+
#
|
507
554
|
# @option params [required, String] :database_name
|
508
555
|
# The name of the database where the Timestream database is to be
|
509
556
|
# deleted.
|
@@ -531,12 +578,13 @@ module Aws::TimestreamWrite
|
|
531
578
|
|
532
579
|
# Returns information about the database, including the database name,
|
533
580
|
# time that the database was created, and the total number of tables
|
534
|
-
# found within the database. Service quotas apply.
|
535
|
-
#
|
581
|
+
# found within the database. [Service quotas apply][1]. See [code
|
582
|
+
# sample][2] for details.
|
536
583
|
#
|
537
584
|
#
|
538
585
|
#
|
539
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
|
540
588
|
#
|
541
589
|
# @option params [required, String] :database_name
|
542
590
|
# The name of the Timestream database.
|
@@ -573,22 +621,26 @@ module Aws::TimestreamWrite
|
|
573
621
|
# Timestream API calls against. This API is available through both Write
|
574
622
|
# and Query.
|
575
623
|
#
|
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
|
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
|
579
627
|
# unless*\:
|
580
628
|
#
|
629
|
+
# * You are using [VPC endpoints (Amazon Web Services PrivateLink) with
|
630
|
+
# Timestream][1]
|
631
|
+
#
|
581
632
|
# * Your application uses a programming language that does not yet have
|
582
633
|
# SDK support
|
583
634
|
#
|
584
635
|
# * You require better control over the client-side implementation
|
585
636
|
#
|
586
|
-
# For detailed information on how to use
|
587
|
-
# Endpoint Discovery Pattern
|
637
|
+
# For detailed information on how and when to use and implement
|
638
|
+
# DescribeEndpoints, see [The Endpoint Discovery Pattern][2].
|
588
639
|
#
|
589
640
|
#
|
590
641
|
#
|
591
|
-
# [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
|
592
644
|
#
|
593
645
|
# @return [Types::DescribeEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
594
646
|
#
|
@@ -611,12 +663,12 @@ module Aws::TimestreamWrite
|
|
611
663
|
|
612
664
|
# Returns information about the table, including the table name,
|
613
665
|
# database name, retention duration of the memory store and the magnetic
|
614
|
-
# store. Service quotas apply.
|
615
|
-
# Management][1] in the Timestream Developer Guide.
|
666
|
+
# store. [Service quotas apply][1]. See [code sample][2] for details.
|
616
667
|
#
|
617
668
|
#
|
618
669
|
#
|
619
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
|
620
672
|
#
|
621
673
|
# @option params [required, String] :database_name
|
622
674
|
# The name of the Timestream database.
|
@@ -645,6 +697,11 @@ module Aws::TimestreamWrite
|
|
645
697
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
646
698
|
# resp.table.creation_time #=> Time
|
647
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
|
648
705
|
#
|
649
706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable AWS API Documentation
|
650
707
|
#
|
@@ -655,13 +712,13 @@ module Aws::TimestreamWrite
|
|
655
712
|
req.send_request(options)
|
656
713
|
end
|
657
714
|
|
658
|
-
# Returns a list of your Timestream databases. Service quotas
|
659
|
-
#
|
660
|
-
# Developer Guide.
|
715
|
+
# Returns a list of your Timestream databases. [Service quotas
|
716
|
+
# apply][1]. See [code sample][2] for details.
|
661
717
|
#
|
662
718
|
#
|
663
719
|
#
|
664
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
|
665
722
|
#
|
666
723
|
# @option params [String] :next_token
|
667
724
|
# The pagination token. To resume pagination, provide the NextToken
|
@@ -708,7 +765,11 @@ module Aws::TimestreamWrite
|
|
708
765
|
end
|
709
766
|
|
710
767
|
# A list of tables, along with the name, status and retention properties
|
711
|
-
# 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
|
712
773
|
#
|
713
774
|
# @option params [String] :database_name
|
714
775
|
# The name of the Timestream database.
|
@@ -749,6 +810,11 @@ module Aws::TimestreamWrite
|
|
749
810
|
# resp.tables[0].retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
750
811
|
# resp.tables[0].creation_time #=> Time
|
751
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
|
752
818
|
# resp.next_token #=> String
|
753
819
|
#
|
754
820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables AWS API Documentation
|
@@ -858,6 +924,12 @@ module Aws::TimestreamWrite
|
|
858
924
|
# new KMS key to be used (`KmsKeyId`). If there are any concurrent
|
859
925
|
# `UpdateDatabase` requests, first writer wins.
|
860
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
|
+
#
|
861
933
|
# @option params [required, String] :database_name
|
862
934
|
# The name of the database.
|
863
935
|
#
|
@@ -916,22 +988,25 @@ module Aws::TimestreamWrite
|
|
916
988
|
# was made. Timestream does not retrieve data from the magnetic store to
|
917
989
|
# populate the memory store.
|
918
990
|
#
|
919
|
-
#
|
920
|
-
# in the Timestream Developer Guide.
|
991
|
+
# See [code sample][1] for details.
|
921
992
|
#
|
922
993
|
#
|
923
994
|
#
|
924
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
995
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html
|
925
996
|
#
|
926
997
|
# @option params [required, String] :database_name
|
927
998
|
# The name of the Timestream database.
|
928
999
|
#
|
929
1000
|
# @option params [required, String] :table_name
|
930
|
-
# The name of the
|
1001
|
+
# The name of the Timestream table.
|
931
1002
|
#
|
932
|
-
# @option params [
|
1003
|
+
# @option params [Types::RetentionProperties] :retention_properties
|
933
1004
|
# The retention duration of the memory store and the magnetic store.
|
934
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
|
+
#
|
935
1010
|
# @return [Types::UpdateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
1011
|
#
|
937
1012
|
# * {Types::UpdateTableResponse#table #table} => Types::Table
|
@@ -941,10 +1016,21 @@ module Aws::TimestreamWrite
|
|
941
1016
|
# resp = client.update_table({
|
942
1017
|
# database_name: "ResourceName", # required
|
943
1018
|
# table_name: "ResourceName", # required
|
944
|
-
# retention_properties: {
|
1019
|
+
# retention_properties: {
|
945
1020
|
# memory_store_retention_period_in_hours: 1, # required
|
946
1021
|
# magnetic_store_retention_period_in_days: 1, # required
|
947
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
|
+
# },
|
948
1034
|
# })
|
949
1035
|
#
|
950
1036
|
# @example Response structure
|
@@ -957,6 +1043,11 @@ module Aws::TimestreamWrite
|
|
957
1043
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
958
1044
|
# resp.table.creation_time #=> Time
|
959
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
|
960
1051
|
#
|
961
1052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable AWS API Documentation
|
962
1053
|
#
|
@@ -978,32 +1069,66 @@ module Aws::TimestreamWrite
|
|
978
1069
|
# into Timestream, the query results might not reflect the results of a
|
979
1070
|
# recently completed write operation. The results may also include some
|
980
1071
|
# 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
|
-
#
|
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`.
|
984
1104
|
#
|
985
1105
|
#
|
986
1106
|
#
|
987
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
|
988
1109
|
#
|
989
1110
|
# @option params [required, String] :database_name
|
990
1111
|
# The name of the Timestream database.
|
991
1112
|
#
|
992
1113
|
# @option params [required, String] :table_name
|
993
|
-
# The name of the
|
1114
|
+
# The name of the Timestream table.
|
994
1115
|
#
|
995
1116
|
# @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
|
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
|
999
1120
|
# dimension attributes in the records object when the data is written
|
1000
|
-
# 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.
|
1001
1124
|
#
|
1002
1125
|
# @option params [required, Array<Types::Record>] :records
|
1003
|
-
# An array of records containing the unique dimension
|
1004
|
-
# 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.
|
1005
1128
|
#
|
1006
|
-
# @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
|
1007
1132
|
#
|
1008
1133
|
# @example Request syntax with placeholder values
|
1009
1134
|
#
|
@@ -1013,37 +1138,57 @@ module Aws::TimestreamWrite
|
|
1013
1138
|
# common_attributes: {
|
1014
1139
|
# dimensions: [
|
1015
1140
|
# {
|
1016
|
-
# name: "
|
1017
|
-
# value: "
|
1141
|
+
# name: "SchemaName", # required
|
1142
|
+
# value: "SchemaValue", # required
|
1018
1143
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1019
1144
|
# },
|
1020
1145
|
# ],
|
1021
|
-
# measure_name: "
|
1146
|
+
# measure_name: "SchemaName",
|
1022
1147
|
# measure_value: "StringValue2048",
|
1023
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1148
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1024
1149
|
# time: "StringValue256",
|
1025
1150
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1026
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
|
+
# ],
|
1027
1159
|
# },
|
1028
1160
|
# records: [ # required
|
1029
1161
|
# {
|
1030
1162
|
# dimensions: [
|
1031
1163
|
# {
|
1032
|
-
# name: "
|
1033
|
-
# value: "
|
1164
|
+
# name: "SchemaName", # required
|
1165
|
+
# value: "SchemaValue", # required
|
1034
1166
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1035
1167
|
# },
|
1036
1168
|
# ],
|
1037
|
-
# measure_name: "
|
1169
|
+
# measure_name: "SchemaName",
|
1038
1170
|
# measure_value: "StringValue2048",
|
1039
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1171
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1040
1172
|
# time: "StringValue256",
|
1041
1173
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1042
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
|
+
# ],
|
1043
1182
|
# },
|
1044
1183
|
# ],
|
1045
1184
|
# })
|
1046
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
|
+
#
|
1047
1192
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords AWS API Documentation
|
1048
1193
|
#
|
1049
1194
|
# @overload write_records(params = {})
|
@@ -1066,7 +1211,7 @@ module Aws::TimestreamWrite
|
|
1066
1211
|
params: params,
|
1067
1212
|
config: config)
|
1068
1213
|
context[:gem_name] = 'aws-sdk-timestreamwrite'
|
1069
|
-
context[:gem_version] = '1.
|
1214
|
+
context[:gem_version] = '1.10.0'
|
1070
1215
|
Seahorse::Client::Request.new(handlers, context)
|
1071
1216
|
end
|
1072
1217
|
|