/
service-2.json
1041 lines (1041 loc) · 42.8 KB
/
service-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-11-01",
"endpointPrefix":"ingest.timestream",
"jsonVersion":"1.0",
"protocol":"json",
"serviceAbbreviation":"Timestream Write",
"serviceFullName":"Amazon Timestream Write",
"serviceId":"Timestream Write",
"signatureVersion":"v4",
"signingName":"timestream",
"targetPrefix":"Timestream_20181101",
"uid":"timestream-write-2018-11-01"
},
"operations":{
"CreateDatabase":{
"name":"CreateDatabase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDatabaseRequest"},
"output":{"shape":"CreateDatabaseResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidEndpointException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">AWS managed KMS keys</a> for more info. Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>",
"endpointdiscovery":{"required":true}
},
"CreateTable":{
"name":"CreateTable",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTableRequest"},
"output":{"shape":"CreateTableResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>The CreateTable operation adds a new table to an existing database in your account. In an AWS account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in seperate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>",
"endpointdiscovery":{"required":true}
},
"DeleteDatabase":{
"name":"DeleteDatabase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDatabaseRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>Deletes a given Timestream database. <i>This is an irreversible operation. After a database is deleted, the time series data from its tables cannot be recovered.</i> </p> <p>All tables in the database must be deleted first, or a ValidationException error will be thrown. </p> <p>Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>",
"endpointdiscovery":{"required":true}
},
"DeleteTable":{
"name":"DeleteTable",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTableRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time series data stored in the table cannot be recovered. </p> <p>Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>",
"endpointdiscovery":{"required":true}
},
"DescribeDatabase":{
"name":"DescribeDatabase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDatabaseRequest"},
"output":{"shape":"DescribeDatabaseResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide.</p>",
"endpointdiscovery":{"required":true}
},
"DescribeEndpoints":{
"name":"DescribeEndpoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEndpointsRequest"},
"output":{"shape":"DescribeEndpointsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.</p> <p>Because Timestream’s SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, <i>it is not recommended that you use this API unless</i>:</p> <ul> <li> <p>Your application uses a programming language that does not yet have SDK support</p> </li> <li> <p>You require better control over the client-side implementation</p> </li> </ul> <p>For detailed information on how to use DescribeEndpoints, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/Using-API.endpoint-discovery.html\">The Endpoint Discovery Pattern and REST APIs</a>.</p>",
"endpointoperation":true
},
"DescribeTable":{
"name":"DescribeTable",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTableRequest"},
"output":{"shape":"DescribeTableResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>",
"endpointdiscovery":{"required":true}
},
"ListDatabases":{
"name":"ListDatabases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDatabasesRequest"},
"output":{"shape":"ListDatabasesResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>Returns a list of your Timestream databases. Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>",
"endpointdiscovery":{"required":true}
},
"ListTables":{
"name":"ListTables",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTablesRequest"},
"output":{"shape":"ListTablesResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>A list of tables, along with the name, status and retention properties of each table. </p>",
"endpointdiscovery":{"required":true}
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p> List all tags on a Timestream resource. </p>",
"endpointdiscovery":{"required":true}
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p> Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. </p>",
"endpointdiscovery":{"required":true}
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p> Removes the association of tags from a Timestream resource. </p>",
"endpointdiscovery":{"required":true}
},
"UpdateDatabase":{
"name":"UpdateDatabase",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDatabaseRequest"},
"output":{"shape":"UpdateDatabaseResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p> Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (<code>KmsKeyId</code>). If there are any concurrent <code>UpdateDatabase</code> requests, first writer wins. </p>",
"endpointdiscovery":{"required":true}
},
"UpdateTable":{
"name":"UpdateTable",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateTableRequest"},
"output":{"shape":"UpdateTableResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store. </p> <p>Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide.</p>",
"endpointdiscovery":{"required":true}
},
"WriteRecords":{
"name":"WriteRecords",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"WriteRecordsRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"RejectedRecordsException"},
{"shape":"InvalidEndpointException"}
],
"documentation":"<p>The WriteRecords operation enables you to write your time series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you with a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. Timestream support eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply. For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>",
"endpointdiscovery":{"required":true}
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>You are not authorized to perform this action.</p>",
"exception":true
},
"AmazonResourceName":{
"type":"string",
"max":1011,
"min":1
},
"ConflictException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Timestream was unable to process this request because it contains resource that already exists.</p>",
"exception":true
},
"CreateDatabaseRequest":{
"type":"structure",
"required":["DatabaseName"],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
},
"KmsKeyId":{
"shape":"StringValue2048",
"documentation":"<p>The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">AWS managed KMS keys</a> for more info.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p> A list of key-value pairs to label the table. </p>"
}
}
},
"CreateDatabaseResponse":{
"type":"structure",
"members":{
"Database":{
"shape":"Database",
"documentation":"<p>The newly created Timestream database.</p>"
}
}
},
"CreateTableRequest":{
"type":"structure",
"required":[
"DatabaseName",
"TableName"
],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
},
"TableName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream table.</p>"
},
"RetentionProperties":{
"shape":"RetentionProperties",
"documentation":"<p>The duration for which your time series data must be stored in the memory store and the magnetic store.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p> A list of key-value pairs to label the table. </p>"
}
}
},
"CreateTableResponse":{
"type":"structure",
"members":{
"Table":{
"shape":"Table",
"documentation":"<p>The newly created Timestream table.</p>"
}
}
},
"Database":{
"type":"structure",
"members":{
"Arn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name that uniquely identifies this database.</p>"
},
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
},
"TableCount":{
"shape":"Long",
"documentation":"<p>The total number of tables found within a Timestream database. </p>"
},
"KmsKeyId":{
"shape":"StringValue2048",
"documentation":"<p>The identifier of the KMS key used to encrypt the data stored in the database.</p>"
},
"CreationTime":{
"shape":"Date",
"documentation":"<p>The time when the database was created, calculated from the Unix epoch time.</p>"
},
"LastUpdatedTime":{
"shape":"Date",
"documentation":"<p> The last time that this database was updated. </p>"
}
},
"documentation":"<p>A top level container for a table. Databases and tables are the fundamental management concepts in Amazon Timestream. All tables in a database are encrypted with the same KMS key.</p>"
},
"DatabaseList":{
"type":"list",
"member":{"shape":"Database"}
},
"Date":{"type":"timestamp"},
"DeleteDatabaseRequest":{
"type":"structure",
"required":["DatabaseName"],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database to be deleted.</p>"
}
}
},
"DeleteTableRequest":{
"type":"structure",
"required":[
"DatabaseName",
"TableName"
],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the database where the Timestream database is to be deleted.</p>"
},
"TableName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream table to be deleted.</p>"
}
}
},
"DescribeDatabaseRequest":{
"type":"structure",
"required":["DatabaseName"],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
}
}
},
"DescribeDatabaseResponse":{
"type":"structure",
"members":{
"Database":{
"shape":"Database",
"documentation":"<p>The name of the Timestream table.</p>"
}
}
},
"DescribeEndpointsRequest":{
"type":"structure",
"members":{
}
},
"DescribeEndpointsResponse":{
"type":"structure",
"required":["Endpoints"],
"members":{
"Endpoints":{
"shape":"Endpoints",
"documentation":"<p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code> request is made.</p>"
}
}
},
"DescribeTableRequest":{
"type":"structure",
"required":[
"DatabaseName",
"TableName"
],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
},
"TableName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream table.</p>"
}
}
},
"DescribeTableResponse":{
"type":"structure",
"members":{
"Table":{
"shape":"Table",
"documentation":"<p>The Timestream table.</p>"
}
}
},
"Dimension":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{
"shape":"StringValue256",
"documentation":"<p> Dimension represents the meta data attributes of the time series. For example, the name and availability zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions. </p> <p>For constraints on Dimension names, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming\">Naming Constraints</a>.</p>"
},
"Value":{
"shape":"StringValue2048",
"documentation":"<p>The value of the dimension.</p>"
},
"DimensionValueType":{
"shape":"DimensionValueType",
"documentation":"<p>The data type of the dimension for the time series data point.</p>"
}
},
"documentation":"<p>Dimension represents the meta data attributes of the time series. For example, the name and availability zone of an EC2 instance or the name of the manufacturer of a wind turbine are dimensions. </p>"
},
"DimensionValueType":{
"type":"string",
"enum":["VARCHAR"]
},
"Dimensions":{
"type":"list",
"member":{"shape":"Dimension"},
"max":128
},
"Endpoint":{
"type":"structure",
"required":[
"Address",
"CachePeriodInMinutes"
],
"members":{
"Address":{
"shape":"String",
"documentation":"<p>An endpoint address.</p>"
},
"CachePeriodInMinutes":{
"shape":"Long",
"documentation":"<p>The TTL for the endpoint, in minutes.</p>"
}
},
"documentation":"<p>Represents an available endpoint against which to make API calls agaisnt, as well as the TTL for that endpoint.</p>"
},
"Endpoints":{
"type":"list",
"member":{"shape":"Endpoint"}
},
"ErrorMessage":{"type":"string"},
"InternalServerException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p> Timestream was unable to fully process this request because of an internal server error.</p>",
"exception":true,
"fault":true
},
"InvalidEndpointException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The requested endpoint was invalid.</p>",
"exception":true
},
"ListDatabasesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p>"
},
"MaxResults":{
"shape":"PaginationLimit",
"documentation":"<p>The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p>"
}
}
},
"ListDatabasesResponse":{
"type":"structure",
"members":{
"Databases":{
"shape":"DatabaseList",
"documentation":"<p>A list of database names.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token. This parameter is returned when the response is truncated.</p>"
}
}
},
"ListTablesRequest":{
"type":"structure",
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p>"
},
"MaxResults":{
"shape":"PaginationLimit",
"documentation":"<p>The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p>"
}
}
},
"ListTablesResponse":{
"type":"structure",
"members":{
"Tables":{
"shape":"TableList",
"documentation":"<p>A list of tables.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p> The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN). </p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p> The tags currently associated with the Timestream resource. </p>"
}
}
},
"Long":{"type":"long"},
"MagneticStoreRetentionPeriodInDays":{
"type":"long",
"max":73000,
"min":1
},
"MeasureValueType":{
"type":"string",
"enum":[
"DOUBLE",
"BIGINT",
"VARCHAR",
"BOOLEAN"
]
},
"MemoryStoreRetentionPeriodInHours":{
"type":"long",
"max":8766,
"min":1
},
"PaginationLimit":{
"type":"integer",
"box":true,
"max":20,
"min":1
},
"Record":{
"type":"structure",
"members":{
"Dimensions":{
"shape":"Dimensions",
"documentation":"<p>Contains the list of dimensions for time series data points.</p>"
},
"MeasureName":{
"shape":"StringValue256",
"documentation":"<p>Measure represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. </p>"
},
"MeasureValue":{
"shape":"StringValue2048",
"documentation":"<p> Contains the measure value for the time series data point. </p>"
},
"MeasureValueType":{
"shape":"MeasureValueType",
"documentation":"<p> Contains the data type of the measure value for the time series data point. </p>"
},
"Time":{
"shape":"StringValue256",
"documentation":"<p> Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is <code>12345</code> and the unit is <code>ms</code>, then <code>12345 ms</code> have elapsed since the epoch. </p>"
},
"TimeUnit":{
"shape":"TimeUnit",
"documentation":"<p> The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values. </p>"
},
"Version":{
"shape":"RecordVersion",
"documentation":"<p>64-bit attribute used for record updates. Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, <code>Version</code> will still be updated . Default value is to 1.</p>",
"box":true
}
},
"documentation":"<p>Record represents a time series data point being written into Timestream. Each record contains an array of dimensions. Dimensions represent the meta data attributes of a time series data point such as the instance name or availability zone of an EC2 instance. A record also contains the measure name which is the name of the measure being collected for example the CPU utilization of an EC2 instance. A record also contains the measure value and the value type which is the data type of the measure value. In addition, the record contains the timestamp when the measure was collected that the timestamp unit which represents the granularity of the timestamp. </p>"
},
"RecordIndex":{"type":"integer"},
"RecordVersion":{"type":"long"},
"Records":{
"type":"list",
"member":{"shape":"Record"},
"max":100,
"min":1
},
"RejectedRecord":{
"type":"structure",
"members":{
"RecordIndex":{
"shape":"RecordIndex",
"documentation":"<p> The index of the record in the input request for WriteRecords. Indexes begin with 0. </p>"
},
"Reason":{
"shape":"ErrorMessage",
"documentation":"<p> The reason why a record was not successfully inserted into Timestream. Possible causes of failure include: </p> <ul> <li> <p> Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but different measure values. </p> </li> <li> <p> Records with timestamps that lie outside the retention duration of the memory store </p> <note> <p>When the retention window is updated, you will receive a <code>RejectedRecords</code> exception if you immediately try to ingest data within the new window. To avoid a <code>RejectedRecords</code> exception, wait until the duration of the new window to ingest new data. For further information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration\"> Best Practices for Configuring Timestream</a> and <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html\">the explanation of how storage works in Timestream</a>.</p> </note> </li> <li> <p> Records with dimensions or measures that exceed the Timestream defined limits. </p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>"
},
"ExistingVersion":{
"shape":"RecordVersion",
"documentation":"<p>The existing version of the record. This value is populated in scenarios where an identical record exists with a higher version than the version in the write request.</p>",
"box":true
}
},
"documentation":"<p> Records that were not successfully inserted into Timestream due to data validation issues that must be resolved prior to reinserting time series data into the system. </p>"
},
"RejectedRecords":{
"type":"list",
"member":{"shape":"RejectedRecord"}
},
"RejectedRecordsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"RejectedRecords":{"shape":"RejectedRecords"}
},
"documentation":"<p> WriteRecords would throw this exception in the following cases: </p> <ul> <li> <p> Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but different measure values. </p> </li> <li> <p> Records with timestamps that lie outside the retention duration of the memory store </p> </li> <li> <p> Records with dimensions or measures that exceed the Timestream defined limits. </p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html\">Access Management</a> in the Timestream Developer Guide. </p>",
"exception":true
},
"ResourceName":{
"type":"string",
"max":64,
"min":3,
"pattern":"[a-zA-Z0-9_.-]+"
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</p>",
"exception":true
},
"RetentionProperties":{
"type":"structure",
"required":[
"MemoryStoreRetentionPeriodInHours",
"MagneticStoreRetentionPeriodInDays"
],
"members":{
"MemoryStoreRetentionPeriodInHours":{
"shape":"MemoryStoreRetentionPeriodInHours",
"documentation":"<p>The duration for which data must be stored in the memory store. </p>"
},
"MagneticStoreRetentionPeriodInDays":{
"shape":"MagneticStoreRetentionPeriodInDays",
"documentation":"<p>The duration for which data must be stored in the magnetic store. </p>"
}
},
"documentation":"<p>Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store. </p>"
},
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p> Instance quota of resource exceeded for this account.</p>",
"exception":true
},
"String":{"type":"string"},
"StringValue2048":{
"type":"string",
"max":2048,
"min":1
},
"StringValue256":{
"type":"string",
"max":256,
"min":1
},
"Table":{
"type":"structure",
"members":{
"Arn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name that uniquely identifies this table.</p>"
},
"TableName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream table.</p>"
},
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database that contains this table.</p>"
},
"TableStatus":{
"shape":"TableStatus",
"documentation":"<p>The current state of the table:</p> <ul> <li> <p> <code>DELETING</code> - The table is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The table is ready for use.</p> </li> </ul>"
},
"RetentionProperties":{
"shape":"RetentionProperties",
"documentation":"<p>The retention duration for the memory store and magnetic store.</p>"
},
"CreationTime":{
"shape":"Date",
"documentation":"<p>The time when the Timestream table was created. </p>"
},
"LastUpdatedTime":{
"shape":"Date",
"documentation":"<p>The time when the Timestream table was last updated.</p>"
}
},
"documentation":"<p>Table represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a table. </p>"
},
"TableList":{
"type":"list",
"member":{"shape":"Table"}
},
"TableStatus":{
"type":"string",
"enum":[
"ACTIVE",
"DELETING"
]
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p> The key of the tag. Tag keys are case sensitive. </p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p> The value of the tag. Tag values are case-sensitive and can be null. </p>"
}
},
"documentation":"<p> A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment. </p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":0
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p> Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN). </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p> The tags to be assigned to the Timestream resource. </p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"ThrottlingException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p> Too many requests were made by a user exceeding service quotas. The request was throttled.</p>",
"exception":true
},
"TimeUnit":{
"type":"string",
"enum":[
"MILLISECONDS",
"SECONDS",
"MICROSECONDS",
"NANOSECONDS"
]
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"TagKeys"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p> The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN). </p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p> A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource. </p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateDatabaseRequest":{
"type":"structure",
"required":[
"DatabaseName",
"KmsKeyId"
],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p> The name of the database. </p>"
},
"KmsKeyId":{
"shape":"StringValue2048",
"documentation":"<p> The identifier of the new KMS key (<code>KmsKeyId</code>) to be used to encrypt the data stored in the database. If the <code>KmsKeyId</code> currently registered with the database is the same as the <code>KmsKeyId</code> in the request, there will not be any update. </p> <p>You can specify the <code>KmsKeyId</code> using any of the following:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias</code> </p> </li> </ul>"
}
}
},
"UpdateDatabaseResponse":{
"type":"structure",
"members":{
"Database":{"shape":"Database"}
}
},
"UpdateTableRequest":{
"type":"structure",
"required":[
"DatabaseName",
"TableName",
"RetentionProperties"
],
"members":{
"DatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timestream database.</p>"
},
"TableName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Timesream table.</p>"
},
"RetentionProperties":{
"shape":"RetentionProperties",
"documentation":"<p>The retention duration of the memory store and the magnetic store.</p>"
}
}
},
"UpdateTableResponse":{
"type":"structure",
"members":{
"Table":{
"shape":"Table",
"documentation":"<p>The updated Timestream table.</p>"