aws-sdk-timestreamwrite 1.7.0 → 1.11.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 +205 -58
- 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: 2a5892f550a65ce5e7d2bd4db7c03ae5c36a73aaa6144252f62ad8d502215715
|
4
|
+
data.tar.gz: 94a47bce477a59063f3350f38e2da5ccbb428fedc610516ef6ee9774e754664d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1ee840a993609eb649b4f17f5faef1c5ec1dcda5bd0c22c05d5d90f911d92c4bb15be2a750629022d5f3545675d1d99e2e79cc27d94f8405f5e8ad6bb26ccdb3
|
7
|
+
data.tar.gz: 1b272558c373f4e0ecb6fe766e7df5b07e1d6d0360dab7c5af01d71b05b52c4f2cc35617ef4d907120415f6576e74d9178ae4a2ee061938dce535e562f0ef65c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.11.0 (2021-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.10.0 (2021-11-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
14
|
+
1.9.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.8.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.7.0 (2021-09-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.11.0
|
@@ -119,7 +119,9 @@ module Aws::TimestreamWrite
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -285,6 +287,15 @@ module Aws::TimestreamWrite
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
288
|
# requests are made, and retries are disabled.
|
287
289
|
#
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
|
+
# will be used if available.
|
293
|
+
#
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
297
|
+
# is set to `true`.
|
298
|
+
#
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
289
300
|
# When `true`, request parameters are validated before
|
290
301
|
# sending the request.
|
@@ -339,14 +350,15 @@ module Aws::TimestreamWrite
|
|
339
350
|
|
340
351
|
# Creates a new Timestream database. If the KMS key is not specified,
|
341
352
|
# the database will be encrypted with a Timestream managed KMS key
|
342
|
-
# located in your account. Refer to [
|
343
|
-
# info. Service quotas apply.
|
344
|
-
#
|
353
|
+
# located in your account. Refer to [Amazon Web Services managed KMS
|
354
|
+
# keys][1] for more info. [Service quotas apply][2]. See [code
|
355
|
+
# sample][3] for details.
|
345
356
|
#
|
346
357
|
#
|
347
358
|
#
|
348
359
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
349
360
|
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
361
|
+
# [3]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html
|
350
362
|
#
|
351
363
|
# @option params [required, String] :database_name
|
352
364
|
# The name of the Timestream database.
|
@@ -354,7 +366,8 @@ module Aws::TimestreamWrite
|
|
354
366
|
# @option params [String] :kms_key_id
|
355
367
|
# The KMS key for the database. If the KMS key is not specified, the
|
356
368
|
# database will be encrypted with a Timestream managed KMS key located
|
357
|
-
# in your account. Refer to [
|
369
|
+
# in your account. Refer to [Amazon Web Services managed KMS keys][1]
|
370
|
+
# for more info.
|
358
371
|
#
|
359
372
|
#
|
360
373
|
#
|
@@ -370,7 +383,7 @@ module Aws::TimestreamWrite
|
|
370
383
|
# @example Request syntax with placeholder values
|
371
384
|
#
|
372
385
|
# resp = client.create_database({
|
373
|
-
# database_name: "
|
386
|
+
# database_name: "ResourceCreateAPIName", # required
|
374
387
|
# kms_key_id: "StringValue2048",
|
375
388
|
# tags: [
|
376
389
|
# {
|
@@ -399,17 +412,17 @@ module Aws::TimestreamWrite
|
|
399
412
|
end
|
400
413
|
|
401
414
|
# 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.
|
415
|
+
# your account. In an Amazon Web Services account, table names must be
|
416
|
+
# at least unique within each Region if they are in the same database.
|
417
|
+
# You may have identical table names in the same Region if the tables
|
418
|
+
# are in separate databases. While creating the table, you must specify
|
419
|
+
# the table name, database name, and the retention properties. [Service
|
420
|
+
# quotas apply][1]. See [code sample][2] for details.
|
409
421
|
#
|
410
422
|
#
|
411
423
|
#
|
412
424
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
425
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html
|
413
426
|
#
|
414
427
|
# @option params [required, String] :database_name
|
415
428
|
# The name of the Timestream database.
|
@@ -424,6 +437,10 @@ module Aws::TimestreamWrite
|
|
424
437
|
# @option params [Array<Types::Tag>] :tags
|
425
438
|
# A list of key-value pairs to label the table.
|
426
439
|
#
|
440
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
441
|
+
# Contains properties to set on the table when enabling magnetic store
|
442
|
+
# writes.
|
443
|
+
#
|
427
444
|
# @return [Types::CreateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
445
|
#
|
429
446
|
# * {Types::CreateTableResponse#table #table} => Types::Table
|
@@ -431,8 +448,8 @@ module Aws::TimestreamWrite
|
|
431
448
|
# @example Request syntax with placeholder values
|
432
449
|
#
|
433
450
|
# resp = client.create_table({
|
434
|
-
# database_name: "
|
435
|
-
# table_name: "
|
451
|
+
# database_name: "ResourceCreateAPIName", # required
|
452
|
+
# table_name: "ResourceCreateAPIName", # required
|
436
453
|
# retention_properties: {
|
437
454
|
# memory_store_retention_period_in_hours: 1, # required
|
438
455
|
# magnetic_store_retention_period_in_days: 1, # required
|
@@ -443,6 +460,17 @@ module Aws::TimestreamWrite
|
|
443
460
|
# value: "TagValue", # required
|
444
461
|
# },
|
445
462
|
# ],
|
463
|
+
# magnetic_store_write_properties: {
|
464
|
+
# enable_magnetic_store_writes: false, # required
|
465
|
+
# magnetic_store_rejected_data_location: {
|
466
|
+
# s3_configuration: {
|
467
|
+
# bucket_name: "S3BucketName",
|
468
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
469
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
470
|
+
# kms_key_id: "StringValue2048",
|
471
|
+
# },
|
472
|
+
# },
|
473
|
+
# },
|
446
474
|
# })
|
447
475
|
#
|
448
476
|
# @example Response structure
|
@@ -455,6 +483,11 @@ module Aws::TimestreamWrite
|
|
455
483
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
456
484
|
# resp.table.creation_time #=> Time
|
457
485
|
# resp.table.last_updated_time #=> Time
|
486
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
487
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
488
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
489
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
490
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
458
491
|
#
|
459
492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/CreateTable AWS API Documentation
|
460
493
|
#
|
@@ -469,13 +502,21 @@ module Aws::TimestreamWrite
|
|
469
502
|
# operation. After a database is deleted, the time series data from its
|
470
503
|
# tables cannot be recovered.*
|
471
504
|
#
|
472
|
-
# All tables in the database must be deleted first, or a
|
505
|
+
# <note markdown="1"> All tables in the database must be deleted first, or a
|
473
506
|
# ValidationException error will be thrown.
|
474
507
|
#
|
475
|
-
#
|
508
|
+
# Due to the nature of distributed retries, the operation can return
|
476
509
|
# either success or a ResourceNotFoundException. Clients should consider
|
477
510
|
# them equivalent.
|
478
511
|
#
|
512
|
+
# </note>
|
513
|
+
#
|
514
|
+
# See [code sample][1] for details.
|
515
|
+
#
|
516
|
+
#
|
517
|
+
#
|
518
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html
|
519
|
+
#
|
479
520
|
# @option params [required, String] :database_name
|
480
521
|
# The name of the Timestream database to be deleted.
|
481
522
|
#
|
@@ -500,10 +541,18 @@ module Aws::TimestreamWrite
|
|
500
541
|
# After a Timestream database table is deleted, the time series data
|
501
542
|
# stored in the table cannot be recovered.
|
502
543
|
#
|
503
|
-
# Due to the nature of distributed retries, the operation can return
|
544
|
+
# <note markdown="1"> Due to the nature of distributed retries, the operation can return
|
504
545
|
# either success or a ResourceNotFoundException. Clients should consider
|
505
546
|
# them equivalent.
|
506
547
|
#
|
548
|
+
# </note>
|
549
|
+
#
|
550
|
+
# See [code sample][1] for details.
|
551
|
+
#
|
552
|
+
#
|
553
|
+
#
|
554
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html
|
555
|
+
#
|
507
556
|
# @option params [required, String] :database_name
|
508
557
|
# The name of the database where the Timestream database is to be
|
509
558
|
# deleted.
|
@@ -531,12 +580,13 @@ module Aws::TimestreamWrite
|
|
531
580
|
|
532
581
|
# Returns information about the database, including the database name,
|
533
582
|
# time that the database was created, and the total number of tables
|
534
|
-
# found within the database. Service quotas apply.
|
535
|
-
#
|
583
|
+
# found within the database. [Service quotas apply][1]. See [code
|
584
|
+
# sample][2] for details.
|
536
585
|
#
|
537
586
|
#
|
538
587
|
#
|
539
588
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
589
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html
|
540
590
|
#
|
541
591
|
# @option params [required, String] :database_name
|
542
592
|
# The name of the Timestream database.
|
@@ -573,22 +623,26 @@ module Aws::TimestreamWrite
|
|
573
623
|
# Timestream API calls against. This API is available through both Write
|
574
624
|
# and Query.
|
575
625
|
#
|
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
|
626
|
+
# Because the Timestream SDKs are designed to transparently work with
|
627
|
+
# the service’s architecture, including the management and mapping of
|
628
|
+
# the service endpoints, *it is not recommended that you use this API
|
579
629
|
# unless*\:
|
580
630
|
#
|
631
|
+
# * You are using [VPC endpoints (Amazon Web Services PrivateLink) with
|
632
|
+
# Timestream][1]
|
633
|
+
#
|
581
634
|
# * Your application uses a programming language that does not yet have
|
582
635
|
# SDK support
|
583
636
|
#
|
584
637
|
# * You require better control over the client-side implementation
|
585
638
|
#
|
586
|
-
# For detailed information on how to use
|
587
|
-
# Endpoint Discovery Pattern
|
639
|
+
# For detailed information on how and when to use and implement
|
640
|
+
# DescribeEndpoints, see [The Endpoint Discovery Pattern][2].
|
588
641
|
#
|
589
642
|
#
|
590
643
|
#
|
591
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
644
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints
|
645
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery
|
592
646
|
#
|
593
647
|
# @return [Types::DescribeEndpointsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
594
648
|
#
|
@@ -611,12 +665,12 @@ module Aws::TimestreamWrite
|
|
611
665
|
|
612
666
|
# Returns information about the table, including the table name,
|
613
667
|
# database name, retention duration of the memory store and the magnetic
|
614
|
-
# store. Service quotas apply.
|
615
|
-
# Management][1] in the Timestream Developer Guide.
|
668
|
+
# store. [Service quotas apply][1]. See [code sample][2] for details.
|
616
669
|
#
|
617
670
|
#
|
618
671
|
#
|
619
672
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
673
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html
|
620
674
|
#
|
621
675
|
# @option params [required, String] :database_name
|
622
676
|
# The name of the Timestream database.
|
@@ -645,6 +699,11 @@ module Aws::TimestreamWrite
|
|
645
699
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
646
700
|
# resp.table.creation_time #=> Time
|
647
701
|
# resp.table.last_updated_time #=> Time
|
702
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
703
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
704
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
705
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
706
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
648
707
|
#
|
649
708
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/DescribeTable AWS API Documentation
|
650
709
|
#
|
@@ -655,13 +714,13 @@ module Aws::TimestreamWrite
|
|
655
714
|
req.send_request(options)
|
656
715
|
end
|
657
716
|
|
658
|
-
# Returns a list of your Timestream databases. Service quotas
|
659
|
-
#
|
660
|
-
# Developer Guide.
|
717
|
+
# Returns a list of your Timestream databases. [Service quotas
|
718
|
+
# apply][1]. See [code sample][2] for details.
|
661
719
|
#
|
662
720
|
#
|
663
721
|
#
|
664
722
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
723
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html
|
665
724
|
#
|
666
725
|
# @option params [String] :next_token
|
667
726
|
# The pagination token. To resume pagination, provide the NextToken
|
@@ -708,7 +767,11 @@ module Aws::TimestreamWrite
|
|
708
767
|
end
|
709
768
|
|
710
769
|
# A list of tables, along with the name, status and retention properties
|
711
|
-
# of each table.
|
770
|
+
# of each table. See [code sample][1] for details.
|
771
|
+
#
|
772
|
+
#
|
773
|
+
#
|
774
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html
|
712
775
|
#
|
713
776
|
# @option params [String] :database_name
|
714
777
|
# The name of the Timestream database.
|
@@ -749,6 +812,11 @@ module Aws::TimestreamWrite
|
|
749
812
|
# resp.tables[0].retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
750
813
|
# resp.tables[0].creation_time #=> Time
|
751
814
|
# resp.tables[0].last_updated_time #=> Time
|
815
|
+
# resp.tables[0].magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
816
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
817
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
818
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
819
|
+
# resp.tables[0].magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
752
820
|
# resp.next_token #=> String
|
753
821
|
#
|
754
822
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/ListTables AWS API Documentation
|
@@ -858,6 +926,12 @@ module Aws::TimestreamWrite
|
|
858
926
|
# new KMS key to be used (`KmsKeyId`). If there are any concurrent
|
859
927
|
# `UpdateDatabase` requests, first writer wins.
|
860
928
|
#
|
929
|
+
# See [code sample][1] for details.
|
930
|
+
#
|
931
|
+
#
|
932
|
+
#
|
933
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html
|
934
|
+
#
|
861
935
|
# @option params [required, String] :database_name
|
862
936
|
# The name of the database.
|
863
937
|
#
|
@@ -916,22 +990,25 @@ module Aws::TimestreamWrite
|
|
916
990
|
# was made. Timestream does not retrieve data from the magnetic store to
|
917
991
|
# populate the memory store.
|
918
992
|
#
|
919
|
-
#
|
920
|
-
# in the Timestream Developer Guide.
|
993
|
+
# See [code sample][1] for details.
|
921
994
|
#
|
922
995
|
#
|
923
996
|
#
|
924
|
-
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/
|
997
|
+
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html
|
925
998
|
#
|
926
999
|
# @option params [required, String] :database_name
|
927
1000
|
# The name of the Timestream database.
|
928
1001
|
#
|
929
1002
|
# @option params [required, String] :table_name
|
930
|
-
# The name of the
|
1003
|
+
# The name of the Timestream table.
|
931
1004
|
#
|
932
|
-
# @option params [
|
1005
|
+
# @option params [Types::RetentionProperties] :retention_properties
|
933
1006
|
# The retention duration of the memory store and the magnetic store.
|
934
1007
|
#
|
1008
|
+
# @option params [Types::MagneticStoreWriteProperties] :magnetic_store_write_properties
|
1009
|
+
# Contains properties to set on the table when enabling magnetic store
|
1010
|
+
# writes.
|
1011
|
+
#
|
935
1012
|
# @return [Types::UpdateTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
1013
|
#
|
937
1014
|
# * {Types::UpdateTableResponse#table #table} => Types::Table
|
@@ -941,10 +1018,21 @@ module Aws::TimestreamWrite
|
|
941
1018
|
# resp = client.update_table({
|
942
1019
|
# database_name: "ResourceName", # required
|
943
1020
|
# table_name: "ResourceName", # required
|
944
|
-
# retention_properties: {
|
1021
|
+
# retention_properties: {
|
945
1022
|
# memory_store_retention_period_in_hours: 1, # required
|
946
1023
|
# magnetic_store_retention_period_in_days: 1, # required
|
947
1024
|
# },
|
1025
|
+
# magnetic_store_write_properties: {
|
1026
|
+
# enable_magnetic_store_writes: false, # required
|
1027
|
+
# magnetic_store_rejected_data_location: {
|
1028
|
+
# s3_configuration: {
|
1029
|
+
# bucket_name: "S3BucketName",
|
1030
|
+
# object_key_prefix: "S3ObjectKeyPrefix",
|
1031
|
+
# encryption_option: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1032
|
+
# kms_key_id: "StringValue2048",
|
1033
|
+
# },
|
1034
|
+
# },
|
1035
|
+
# },
|
948
1036
|
# })
|
949
1037
|
#
|
950
1038
|
# @example Response structure
|
@@ -957,6 +1045,11 @@ module Aws::TimestreamWrite
|
|
957
1045
|
# resp.table.retention_properties.magnetic_store_retention_period_in_days #=> Integer
|
958
1046
|
# resp.table.creation_time #=> Time
|
959
1047
|
# resp.table.last_updated_time #=> Time
|
1048
|
+
# resp.table.magnetic_store_write_properties.enable_magnetic_store_writes #=> Boolean
|
1049
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name #=> String
|
1050
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix #=> String
|
1051
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option #=> String, one of "SSE_S3", "SSE_KMS"
|
1052
|
+
# resp.table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id #=> String
|
960
1053
|
#
|
961
1054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/UpdateTable AWS API Documentation
|
962
1055
|
#
|
@@ -978,32 +1071,66 @@ module Aws::TimestreamWrite
|
|
978
1071
|
# into Timestream, the query results might not reflect the results of a
|
979
1072
|
# recently completed write operation. The results may also include some
|
980
1073
|
# 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
|
-
#
|
1074
|
+
# results should return the latest data. [Service quotas apply][1].
|
1075
|
+
#
|
1076
|
+
# See [code sample][2] for details.
|
1077
|
+
#
|
1078
|
+
# **Upserts**
|
1079
|
+
#
|
1080
|
+
# You can use the `Version` parameter in a `WriteRecords` request to
|
1081
|
+
# update data points. Timestream tracks a version number with each
|
1082
|
+
# record. `Version` defaults to `1` when not specified for the record in
|
1083
|
+
# the request. Timestream will update an existing record’s measure value
|
1084
|
+
# along with its `Version` upon receiving a write request with a higher
|
1085
|
+
# `Version` number for that record. Upon receiving an update request
|
1086
|
+
# where the measure value is the same as that of the existing record,
|
1087
|
+
# Timestream still updates `Version`, if it is greater than the existing
|
1088
|
+
# value of `Version`. You can update a data point as many times as
|
1089
|
+
# desired, as long as the value of `Version` continuously increases.
|
1090
|
+
#
|
1091
|
+
# For example, suppose you write a new record without indicating
|
1092
|
+
# `Version` in the request. Timestream will store this record, and set
|
1093
|
+
# `Version` to `1`. Now, suppose you try to update this record with a
|
1094
|
+
# `WriteRecords` request of the same record with a different measure
|
1095
|
+
# value but, like before, do not provide `Version`. In this case,
|
1096
|
+
# Timestream will reject this update with a `RejectedRecordsException`
|
1097
|
+
# since the updated record’s version is not greater than the existing
|
1098
|
+
# value of Version. However, if you were to resend the update request
|
1099
|
+
# with `Version` set to `2`, Timestream would then succeed in updating
|
1100
|
+
# the record’s value, and the `Version` would be set to `2`. Next,
|
1101
|
+
# suppose you sent a `WriteRecords` request with this same record and an
|
1102
|
+
# identical measure value, but with `Version` set to `3`. In this case,
|
1103
|
+
# Timestream would only update `Version` to `3`. Any further updates
|
1104
|
+
# would need to send a version number greater than `3`, or the update
|
1105
|
+
# requests would receive a `RejectedRecordsException`.
|
984
1106
|
#
|
985
1107
|
#
|
986
1108
|
#
|
987
1109
|
# [1]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html
|
1110
|
+
# [2]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html
|
988
1111
|
#
|
989
1112
|
# @option params [required, String] :database_name
|
990
1113
|
# The name of the Timestream database.
|
991
1114
|
#
|
992
1115
|
# @option params [required, String] :table_name
|
993
|
-
# The name of the
|
1116
|
+
# The name of the Timestream table.
|
994
1117
|
#
|
995
1118
|
# @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
|
1119
|
+
# A record containing the common measure, dimension, time, and version
|
1120
|
+
# attributes shared across all the records in the request. The measure
|
1121
|
+
# and dimension attributes specified will be merged with the measure and
|
999
1122
|
# dimension attributes in the records object when the data is written
|
1000
|
-
# into Timestream.
|
1123
|
+
# into Timestream. Dimensions may not overlap, or a
|
1124
|
+
# `ValidationException` will be thrown. In other words, a record must
|
1125
|
+
# contain dimensions with unique names.
|
1001
1126
|
#
|
1002
1127
|
# @option params [required, Array<Types::Record>] :records
|
1003
|
-
# An array of records containing the unique dimension
|
1004
|
-
# attributes for each time series data point.
|
1128
|
+
# An array of records containing the unique measure, dimension, time,
|
1129
|
+
# and version attributes for each time series data point.
|
1005
1130
|
#
|
1006
|
-
# @return [
|
1131
|
+
# @return [Types::WriteRecordsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1132
|
+
#
|
1133
|
+
# * {Types::WriteRecordsResponse#records_ingested #records_ingested} => Types::RecordsIngested
|
1007
1134
|
#
|
1008
1135
|
# @example Request syntax with placeholder values
|
1009
1136
|
#
|
@@ -1013,37 +1140,57 @@ module Aws::TimestreamWrite
|
|
1013
1140
|
# common_attributes: {
|
1014
1141
|
# dimensions: [
|
1015
1142
|
# {
|
1016
|
-
# name: "
|
1017
|
-
# value: "
|
1143
|
+
# name: "SchemaName", # required
|
1144
|
+
# value: "SchemaValue", # required
|
1018
1145
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1019
1146
|
# },
|
1020
1147
|
# ],
|
1021
|
-
# measure_name: "
|
1148
|
+
# measure_name: "SchemaName",
|
1022
1149
|
# measure_value: "StringValue2048",
|
1023
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1150
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1024
1151
|
# time: "StringValue256",
|
1025
1152
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1026
1153
|
# version: 1,
|
1154
|
+
# measure_values: [
|
1155
|
+
# {
|
1156
|
+
# name: "SchemaName", # required
|
1157
|
+
# value: "StringValue2048", # required
|
1158
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1159
|
+
# },
|
1160
|
+
# ],
|
1027
1161
|
# },
|
1028
1162
|
# records: [ # required
|
1029
1163
|
# {
|
1030
1164
|
# dimensions: [
|
1031
1165
|
# {
|
1032
|
-
# name: "
|
1033
|
-
# value: "
|
1166
|
+
# name: "SchemaName", # required
|
1167
|
+
# value: "SchemaValue", # required
|
1034
1168
|
# dimension_value_type: "VARCHAR", # accepts VARCHAR
|
1035
1169
|
# },
|
1036
1170
|
# ],
|
1037
|
-
# measure_name: "
|
1171
|
+
# measure_name: "SchemaName",
|
1038
1172
|
# measure_value: "StringValue2048",
|
1039
|
-
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN
|
1173
|
+
# measure_value_type: "DOUBLE", # accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1040
1174
|
# time: "StringValue256",
|
1041
1175
|
# time_unit: "MILLISECONDS", # accepts MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS
|
1042
1176
|
# version: 1,
|
1177
|
+
# measure_values: [
|
1178
|
+
# {
|
1179
|
+
# name: "SchemaName", # required
|
1180
|
+
# value: "StringValue2048", # required
|
1181
|
+
# type: "DOUBLE", # required, accepts DOUBLE, BIGINT, VARCHAR, BOOLEAN, TIMESTAMP, MULTI
|
1182
|
+
# },
|
1183
|
+
# ],
|
1043
1184
|
# },
|
1044
1185
|
# ],
|
1045
1186
|
# })
|
1046
1187
|
#
|
1188
|
+
# @example Response structure
|
1189
|
+
#
|
1190
|
+
# resp.records_ingested.total #=> Integer
|
1191
|
+
# resp.records_ingested.memory_store #=> Integer
|
1192
|
+
# resp.records_ingested.magnetic_store #=> Integer
|
1193
|
+
#
|
1047
1194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-write-2018-11-01/WriteRecords AWS API Documentation
|
1048
1195
|
#
|
1049
1196
|
# @overload write_records(params = {})
|
@@ -1066,7 +1213,7 @@ module Aws::TimestreamWrite
|
|
1066
1213
|
params: params,
|
1067
1214
|
config: config)
|
1068
1215
|
context[:gem_name] = 'aws-sdk-timestreamwrite'
|
1069
|
-
context[:gem_version] = '1.
|
1216
|
+
context[:gem_version] = '1.11.0'
|
1070
1217
|
Seahorse::Client::Request.new(handlers, context)
|
1071
1218
|
end
|
1072
1219
|
|