-
Notifications
You must be signed in to change notification settings - Fork 594
/
athena.2017-05-18.json
3786 lines (3786 loc) · 190 KB
/
athena.2017-05-18.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
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.athena#AclConfiguration": {
"type": "structure",
"members": {
"S3AclOption": {
"target": "com.amazonaws.athena#S3AclOption",
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl\">Canned ACL</a> in the <i>Amazon S3 User\n Guide</i>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results. When Athena stores query results in Amazon S3,\n the canned ACL is set with the <code>x-amz-acl</code> request header. For more\n information about S3 Object Ownership, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview\">Object Ownership settings</a> in the <i>Amazon S3 User\n Guide</i>.</p>"
}
},
"com.amazonaws.athena#AmazonAthena": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "Athena",
"arnNamespace": "athena",
"cloudFormationName": "Athena",
"cloudTrailEventSource": "athena.amazonaws.com",
"endpointPrefix": "athena"
},
"aws.auth#sigv4": {
"name": "athena"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<p>Amazon Athena is an interactive query service that lets you use standard SQL\n to analyze data directly in Amazon S3. You can point Athena at your\n data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay\n only for the queries you run. Athena scales automatically—executing queries\n in parallel—so results are fast, even with large datasets and complex queries. For more\n information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User\n Guide</i>.</p>\n <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the\n driver or later with the Amazon Athena API. Earlier version drivers do not\n support the API. For more information and to download the driver, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html\">Accessing\n Amazon Athena with JDBC</a>.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
"smithy.api#title": "Amazon Athena"
},
"version": "2017-05-18",
"operations": [
{
"target": "com.amazonaws.athena#BatchGetNamedQuery"
},
{
"target": "com.amazonaws.athena#BatchGetQueryExecution"
},
{
"target": "com.amazonaws.athena#CreateDataCatalog"
},
{
"target": "com.amazonaws.athena#CreateNamedQuery"
},
{
"target": "com.amazonaws.athena#CreatePreparedStatement"
},
{
"target": "com.amazonaws.athena#CreateWorkGroup"
},
{
"target": "com.amazonaws.athena#DeleteDataCatalog"
},
{
"target": "com.amazonaws.athena#DeleteNamedQuery"
},
{
"target": "com.amazonaws.athena#DeletePreparedStatement"
},
{
"target": "com.amazonaws.athena#DeleteWorkGroup"
},
{
"target": "com.amazonaws.athena#GetDatabase"
},
{
"target": "com.amazonaws.athena#GetDataCatalog"
},
{
"target": "com.amazonaws.athena#GetNamedQuery"
},
{
"target": "com.amazonaws.athena#GetPreparedStatement"
},
{
"target": "com.amazonaws.athena#GetQueryExecution"
},
{
"target": "com.amazonaws.athena#GetQueryResults"
},
{
"target": "com.amazonaws.athena#GetTableMetadata"
},
{
"target": "com.amazonaws.athena#GetWorkGroup"
},
{
"target": "com.amazonaws.athena#ListDatabases"
},
{
"target": "com.amazonaws.athena#ListDataCatalogs"
},
{
"target": "com.amazonaws.athena#ListEngineVersions"
},
{
"target": "com.amazonaws.athena#ListNamedQueries"
},
{
"target": "com.amazonaws.athena#ListPreparedStatements"
},
{
"target": "com.amazonaws.athena#ListQueryExecutions"
},
{
"target": "com.amazonaws.athena#ListTableMetadata"
},
{
"target": "com.amazonaws.athena#ListTagsForResource"
},
{
"target": "com.amazonaws.athena#ListWorkGroups"
},
{
"target": "com.amazonaws.athena#StartQueryExecution"
},
{
"target": "com.amazonaws.athena#StopQueryExecution"
},
{
"target": "com.amazonaws.athena#TagResource"
},
{
"target": "com.amazonaws.athena#UntagResource"
},
{
"target": "com.amazonaws.athena#UpdateDataCatalog"
},
{
"target": "com.amazonaws.athena#UpdateNamedQuery"
},
{
"target": "com.amazonaws.athena#UpdatePreparedStatement"
},
{
"target": "com.amazonaws.athena#UpdateWorkGroup"
}
]
},
"com.amazonaws.athena#AmazonResourceName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1011
}
}
},
"com.amazonaws.athena#AthenaError": {
"type": "structure",
"members": {
"ErrorCategory": {
"target": "com.amazonaws.athena#ErrorCategory",
"traits": {
"smithy.api#documentation": "<p>An integer value that specifies the category of a query failure error. The following\n list shows the category for each integer value.</p>\n <p>\n <b>1</b> - System</p>\n <p>\n <b>2</b> - User</p>\n <p>\n <b>3</b> - Other</p>"
}
},
"ErrorType": {
"target": "com.amazonaws.athena#ErrorType",
"traits": {
"smithy.api#documentation": "<p>An integer value that provides specific information about an Athena query\n error. For the meaning of specific values, see the <a href=\"https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference\">Error Type Reference</a> in the <i>Amazon Athena User\n Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides information about an Athena query error. The\n <code>AthenaError</code> feature provides standardized error information to help you\n understand failed queries and take steps after a query failure occurs.\n <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies\n whether the cause of the failed query is due to system error, user error, or other\n error.</p>"
}
},
"com.amazonaws.athena#BatchGetNamedQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#BatchGetNamedQueryInput"
},
"output": {
"target": "com.amazonaws.athena#BatchGetNamedQueryOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the details of a single named query or a list of up to 50 queries, which you\n provide as an array of query ID strings. Requires you to have access to the workgroup in\n which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the\n list of named query IDs in the specified workgroup. If information could not be\n retrieved for a submitted query ID, information about the query ID submitted is listed\n under <a>UnprocessedNamedQueryId</a>. Named queries differ from executed\n queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each\n unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of\n query execution IDs.</p>"
}
},
"com.amazonaws.athena#BatchGetNamedQueryInput": {
"type": "structure",
"members": {
"NamedQueryIds": {
"target": "com.amazonaws.athena#NamedQueryIdList",
"traits": {
"smithy.api#documentation": "<p>An array of query IDs.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.athena#BatchGetNamedQueryOutput": {
"type": "structure",
"members": {
"NamedQueries": {
"target": "com.amazonaws.athena#NamedQueryList",
"traits": {
"smithy.api#documentation": "<p>Information about the named query IDs submitted.</p>"
}
},
"UnprocessedNamedQueryIds": {
"target": "com.amazonaws.athena#UnprocessedNamedQueryIdList",
"traits": {
"smithy.api#documentation": "<p>Information about provided query IDs.</p>"
}
}
}
},
"com.amazonaws.athena#BatchGetQueryExecution": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#BatchGetQueryExecutionInput"
},
"output": {
"target": "com.amazonaws.athena#BatchGetQueryExecutionOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the details of a single query execution or a list of up to 50 query\n executions, which you provide as an array of query execution ID strings. Requires you to\n have access to the workgroup in which the queries ran. To get a list of query execution\n IDs, use <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ\n from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details\n about named queries.</p>"
}
},
"com.amazonaws.athena#BatchGetQueryExecutionInput": {
"type": "structure",
"members": {
"QueryExecutionIds": {
"target": "com.amazonaws.athena#QueryExecutionIdList",
"traits": {
"smithy.api#documentation": "<p>An array of query execution IDs.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.athena#BatchGetQueryExecutionOutput": {
"type": "structure",
"members": {
"QueryExecutions": {
"target": "com.amazonaws.athena#QueryExecutionList",
"traits": {
"smithy.api#documentation": "<p>Information about a query execution.</p>"
}
},
"UnprocessedQueryExecutionIds": {
"target": "com.amazonaws.athena#UnprocessedQueryExecutionIdList",
"traits": {
"smithy.api#documentation": "<p>Information about the query executions that failed to run.</p>"
}
}
}
},
"com.amazonaws.athena#Boolean": {
"type": "boolean"
},
"com.amazonaws.athena#BoxedBoolean": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.athena#BytesScannedCutoffValue": {
"type": "long",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 10000000
}
}
},
"com.amazonaws.athena#CatalogNameString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 256
},
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
}
},
"com.amazonaws.athena#Column": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the column.</p>",
"smithy.api#required": {}
}
},
"Type": {
"target": "com.amazonaws.athena#TypeString",
"traits": {
"smithy.api#documentation": "<p>The data type of the column.</p>"
}
},
"Comment": {
"target": "com.amazonaws.athena#CommentString",
"traits": {
"smithy.api#documentation": "<p>Optional information about the column.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains metadata for a column in a table.</p>"
}
},
"com.amazonaws.athena#ColumnInfo": {
"type": "structure",
"members": {
"CatalogName": {
"target": "com.amazonaws.athena#String",
"traits": {
"smithy.api#documentation": "<p>The catalog to which the query results belong.</p>"
}
},
"SchemaName": {
"target": "com.amazonaws.athena#String",
"traits": {
"smithy.api#documentation": "<p>The schema name (database name) to which the query results belong.</p>"
}
},
"TableName": {
"target": "com.amazonaws.athena#String",
"traits": {
"smithy.api#documentation": "<p>The table name for the query results.</p>"
}
},
"Name": {
"target": "com.amazonaws.athena#String",
"traits": {
"smithy.api#documentation": "<p>The name of the column.</p>",
"smithy.api#required": {}
}
},
"Label": {
"target": "com.amazonaws.athena#String",
"traits": {
"smithy.api#documentation": "<p>A column label.</p>"
}
},
"Type": {
"target": "com.amazonaws.athena#String",
"traits": {
"smithy.api#documentation": "<p>The data type of the column.</p>",
"smithy.api#required": {}
}
},
"Precision": {
"target": "com.amazonaws.athena#Integer",
"traits": {
"smithy.api#documentation": "<p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38.\n For performance reasons, we recommend up to 18 digits.</p>"
}
},
"Scale": {
"target": "com.amazonaws.athena#Integer",
"traits": {
"smithy.api#documentation": "<p>For <code>DECIMAL</code> data types, specifies the total number of digits in the\n fractional part of the value. Defaults to 0.</p>"
}
},
"Nullable": {
"target": "com.amazonaws.athena#ColumnNullable",
"traits": {
"smithy.api#documentation": "<p>Indicates the column's nullable status.</p>"
}
},
"CaseSensitive": {
"target": "com.amazonaws.athena#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether values in the column are case-sensitive.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the columns in a query execution result.</p>"
}
},
"com.amazonaws.athena#ColumnInfoList": {
"type": "list",
"member": {
"target": "com.amazonaws.athena#ColumnInfo"
}
},
"com.amazonaws.athena#ColumnList": {
"type": "list",
"member": {
"target": "com.amazonaws.athena#Column"
}
},
"com.amazonaws.athena#ColumnNullable": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "NOT_NULL",
"name": "NOT_NULL"
},
{
"value": "NULLABLE",
"name": "NULLABLE"
},
{
"value": "UNKNOWN",
"name": "UNKNOWN"
}
]
}
},
"com.amazonaws.athena#CommentString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 255
},
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
}
},
"com.amazonaws.athena#CreateDataCatalog": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#CreateDataCatalogInput"
},
"output": {
"target": "com.amazonaws.athena#CreateDataCatalogOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.</p>"
}
},
"com.amazonaws.athena#CreateDataCatalogInput": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#CatalogNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the data catalog to create. The catalog name must be unique for the\n Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at\n sign, or hyphen characters. The remainder of the length constraint of 256 is reserved\n for use by Athena.</p>",
"smithy.api#required": {}
}
},
"Type": {
"target": "com.amazonaws.athena#DataCatalogType",
"traits": {
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,\n <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an\n Glue Data Catalog.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.athena#DescriptionString",
"traits": {
"smithy.api#documentation": "<p>A description of the data catalog to be created.</p>"
}
},
"Parameters": {
"target": "com.amazonaws.athena#ParametersMap",
"traits": {
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The\n <code>\n <i>catalog_id</i>\n </code> is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.</p>\n <p>\n <code>catalog-id=<i>catalog_id</i>\n </code>\n </p>\n <ul>\n <li>\n <p>The <code>GLUE</code> data catalog type also applies to the default\n <code>AwsDataCatalog</code> that already exists in your account, of\n which you can have only one and cannot modify.</p>\n </li>\n <li>\n <p>Queries that specify a Glue Data Catalog other than the default\n <code>AwsDataCatalog</code> must be run on Athena engine\n version 2.</p>\n </li>\n <li>\n <p>In Regions where Athena engine version 2 is not available,\n creating new Glue data catalogs results in an\n <code>INVALID_INPUT</code> error.</p>\n </li>\n </ul>\n </li>\n </ul>"
}
},
"Tags": {
"target": "com.amazonaws.athena#TagList",
"traits": {
"smithy.api#documentation": "<p>A list of comma separated tags to add to the data catalog that is created.</p>"
}
}
}
},
"com.amazonaws.athena#CreateDataCatalogOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#CreateNamedQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#CreateNamedQueryInput"
},
"output": {
"target": "com.amazonaws.athena#CreateNamedQueryOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.athena#CreateNamedQueryInput": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#NameString",
"traits": {
"smithy.api#documentation": "<p>The query name.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.athena#DescriptionString",
"traits": {
"smithy.api#documentation": "<p>The query description.</p>"
}
},
"Database": {
"target": "com.amazonaws.athena#DatabaseString",
"traits": {
"smithy.api#documentation": "<p>The database to which the query belongs.</p>",
"smithy.api#required": {}
}
},
"QueryString": {
"target": "com.amazonaws.athena#QueryString",
"traits": {
"smithy.api#documentation": "<p>The contents of the query with all query statements.</p>",
"smithy.api#required": {}
}
},
"ClientRequestToken": {
"target": "com.amazonaws.athena#IdempotencyToken",
"traits": {
"smithy.api#documentation": "<p>A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another <code>CreateNamedQuery</code> request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the <code>QueryString</code>, an error is returned.</p>\n <important>\n <p>This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.</p>\n </important>",
"smithy.api#idempotencyToken": {}
}
},
"WorkGroup": {
"target": "com.amazonaws.athena#WorkGroupName",
"traits": {
"smithy.api#documentation": "<p>The name of the workgroup in which the named query is being created.</p>"
}
}
}
},
"com.amazonaws.athena#CreateNamedQueryOutput": {
"type": "structure",
"members": {
"NamedQueryId": {
"target": "com.amazonaws.athena#NamedQueryId",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the query.</p>"
}
}
}
},
"com.amazonaws.athena#CreatePreparedStatement": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#CreatePreparedStatementInput"
},
"output": {
"target": "com.amazonaws.athena#CreatePreparedStatementOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a prepared statement for use with SQL queries in Athena.</p>"
}
},
"com.amazonaws.athena#CreatePreparedStatementInput": {
"type": "structure",
"members": {
"StatementName": {
"target": "com.amazonaws.athena#StatementName",
"traits": {
"smithy.api#documentation": "<p>The name of the prepared statement.</p>",
"smithy.api#required": {}
}
},
"WorkGroup": {
"target": "com.amazonaws.athena#WorkGroupName",
"traits": {
"smithy.api#documentation": "<p>The name of the workgroup to which the prepared statement belongs.</p>",
"smithy.api#required": {}
}
},
"QueryStatement": {
"target": "com.amazonaws.athena#QueryString",
"traits": {
"smithy.api#documentation": "<p>The query string for the prepared statement.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.athena#DescriptionString",
"traits": {
"smithy.api#documentation": "<p>The description of the prepared statement.</p>"
}
}
}
},
"com.amazonaws.athena#CreatePreparedStatementOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#CreateWorkGroup": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#CreateWorkGroupInput"
},
"output": {
"target": "com.amazonaws.athena#CreateWorkGroupOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a workgroup with the specified name.</p>"
}
},
"com.amazonaws.athena#CreateWorkGroupInput": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#WorkGroupName",
"traits": {
"smithy.api#documentation": "<p>The workgroup name.</p>",
"smithy.api#required": {}
}
},
"Configuration": {
"target": "com.amazonaws.athena#WorkGroupConfiguration",
"traits": {
"smithy.api#documentation": "<p>The configuration for the workgroup, which includes the location in Amazon S3\n where query results are stored, the encryption configuration, if any, used for\n encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the\n workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is\n specified, and whether workgroup's settings (specified with\n <code>EnforceWorkGroupConfiguration</code>) in the\n <code>WorkGroupConfiguration</code> override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
}
},
"Description": {
"target": "com.amazonaws.athena#WorkGroupDescriptionString",
"traits": {
"smithy.api#documentation": "<p>The workgroup description.</p>"
}
},
"Tags": {
"target": "com.amazonaws.athena#TagList",
"traits": {
"smithy.api#documentation": "<p>A list of comma separated tags to add to the workgroup that is created.</p>"
}
}
}
},
"com.amazonaws.athena#CreateWorkGroupOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#DataCatalog": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#CatalogNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign,\n or hyphen characters. The remainder of the length constraint of 256 is reserved for use\n by Athena.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.athena#DescriptionString",
"traits": {
"smithy.api#documentation": "<p>An optional description of the data catalog.</p>"
}
},
"Type": {
"target": "com.amazonaws.athena#DataCatalogType",
"traits": {
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,\n <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an\n Glue Data Catalog.</p>",
"smithy.api#required": {}
}
},
"Parameters": {
"target": "com.amazonaws.athena#ParametersMap",
"traits": {
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The\n <code>\n <i>catalog_id</i>\n </code> is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.</p>\n <p>\n <code>catalog-id=<i>catalog_id</i>\n </code>\n </p>\n <ul>\n <li>\n <p>The <code>GLUE</code> data catalog type also applies to the default\n <code>AwsDataCatalog</code> that already exists in your account, of\n which you can have only one and cannot modify.</p>\n </li>\n <li>\n <p>Queries that specify a Glue Data Catalog other than the default\n <code>AwsDataCatalog</code> must be run on Athena engine\n version 2.</p>\n </li>\n </ul>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about a data catalog in an Amazon Web Services account.</p>"
}
},
"com.amazonaws.athena#DataCatalogSummary": {
"type": "structure",
"members": {
"CatalogName": {
"target": "com.amazonaws.athena#CatalogNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the data catalog. The catalog name is unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign,\n or hyphen characters. The remainder of the length constraint of 256 is reserved for use\n by Athena.</p>"
}
},
"Type": {
"target": "com.amazonaws.athena#DataCatalogType",
"traits": {
"smithy.api#documentation": "<p>The data catalog type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The summary information for the data catalog, which includes its name and type.</p>"
}
},
"com.amazonaws.athena#DataCatalogSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.athena#DataCatalogSummary"
}
},
"com.amazonaws.athena#DataCatalogType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "LAMBDA",
"name": "LAMBDA"
},
{
"value": "GLUE",
"name": "GLUE"
},
{
"value": "HIVE",
"name": "HIVE"
}
]
}
},
"com.amazonaws.athena#Database": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#NameString",
"traits": {
"smithy.api#documentation": "<p>The name of the database.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.athena#DescriptionString",
"traits": {
"smithy.api#documentation": "<p>An optional description of the database.</p>"
}
},
"Parameters": {
"target": "com.amazonaws.athena#ParametersMap",
"traits": {
"smithy.api#documentation": "<p>A set of custom key/value pairs.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains metadata information for a database in a data catalog.</p>"
}
},
"com.amazonaws.athena#DatabaseList": {
"type": "list",
"member": {
"target": "com.amazonaws.athena#Database"
}
},
"com.amazonaws.athena#DatabaseString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 255
}
}
},
"com.amazonaws.athena#Date": {
"type": "timestamp"
},
"com.amazonaws.athena#Datum": {
"type": "structure",
"members": {
"VarCharValue": {
"target": "com.amazonaws.athena#datumString",
"traits": {
"smithy.api#documentation": "<p>The value of the datum.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A piece of data (a field in the table).</p>"
}
},
"com.amazonaws.athena#DeleteDataCatalog": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#DeleteDataCatalogInput"
},
"output": {
"target": "com.amazonaws.athena#DeleteDataCatalogOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a data catalog.</p>"
}
},
"com.amazonaws.athena#DeleteDataCatalogInput": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.athena#CatalogNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the data catalog to delete.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.athena#DeleteDataCatalogOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#DeleteNamedQuery": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#DeleteNamedQueryInput"
},
"output": {
"target": "com.amazonaws.athena#DeleteNamedQueryOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the named query if you have access to the workgroup in which the query was\n saved.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.athena#DeleteNamedQueryInput": {
"type": "structure",
"members": {
"NamedQueryId": {
"target": "com.amazonaws.athena#NamedQueryId",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the query to delete.</p>",
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.athena#DeleteNamedQueryOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#DeletePreparedStatement": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#DeletePreparedStatementInput"
},
"output": {
"target": "com.amazonaws.athena#DeletePreparedStatementOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
},
{
"target": "com.amazonaws.athena#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the prepared statement with the specified name from the specified\n workgroup.</p>"
}
},
"com.amazonaws.athena#DeletePreparedStatementInput": {
"type": "structure",
"members": {
"StatementName": {
"target": "com.amazonaws.athena#StatementName",
"traits": {
"smithy.api#documentation": "<p>The name of the prepared statement to delete.</p>",
"smithy.api#required": {}
}
},
"WorkGroup": {
"target": "com.amazonaws.athena#WorkGroupName",
"traits": {
"smithy.api#documentation": "<p>The workgroup to which the statement to be deleted belongs.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.athena#DeletePreparedStatementOutput": {
"type": "structure",
"members": {}
},
"com.amazonaws.athena#DeleteWorkGroup": {
"type": "operation",
"input": {
"target": "com.amazonaws.athena#DeleteWorkGroupInput"
},
"output": {
"target": "com.amazonaws.athena#DeleteWorkGroupOutput"
},
"errors": [
{
"target": "com.amazonaws.athena#InternalServerException"
},
{
"target": "com.amazonaws.athena#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the workgroup with the specified name. The primary workgroup cannot be\n deleted.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.athena#DeleteWorkGroupInput": {
"type": "structure",
"members": {
"WorkGroup": {
"target": "com.amazonaws.athena#WorkGroupName",
"traits": {
"smithy.api#documentation": "<p>The unique name of the workgroup to delete.</p>",
"smithy.api#required": {}