/
docs-2.json
1259 lines (1259 loc) · 85.3 KB
/
docs-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",
"service": "<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your 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 only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more 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 Guide</i>.</p> <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not 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 Amazon Athena with JDBC</a>.</p> <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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"operations": {
"BatchGetNamedQuery": "<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries differ from executed queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of query execution IDs.</p>",
"BatchGetPreparedStatement": "<p>Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in <code>UnprocessedPreparedStatementNames</code>.</p>",
"BatchGetQueryExecution": "<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details about named queries.</p>",
"CreateDataCatalog": "<p>Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.</p>",
"CreateNamedQuery": "<p>Creates a named query in the specified workgroup. Requires that you have access to the workgroup.</p> <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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"CreatePreparedStatement": "<p>Creates a prepared statement for use with SQL queries in Athena.</p>",
"CreateWorkGroup": "<p>Creates a workgroup with the specified name.</p>",
"DeleteDataCatalog": "<p>Deletes a data catalog.</p>",
"DeleteNamedQuery": "<p>Deletes the named query if you have access to the workgroup in which the query was saved.</p> <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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"DeletePreparedStatement": "<p>Deletes the prepared statement with the specified name from the specified workgroup.</p>",
"DeleteWorkGroup": "<p>Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.</p>",
"GetDataCatalog": "<p>Returns the specified data catalog.</p>",
"GetDatabase": "<p>Returns a database object for the specified database and data catalog.</p>",
"GetNamedQuery": "<p>Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.</p>",
"GetPreparedStatement": "<p>Retrieves the prepared statement with the specified name from the specified workgroup.</p>",
"GetQueryExecution": "<p>Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.</p>",
"GetQueryResults": "<p>Streams the results of a single query execution specified by <code>QueryExecutionId</code> from the Athena query results location in Amazon S3. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p> <p>To stream query results successfully, the IAM principal with permission to call <code>GetQueryResults</code> also must have permissions to the Amazon S3 <code>GetObject</code> action for the Athena query results location.</p> <important> <p>IAM principals with permission to the Amazon S3 <code>GetObject</code> action for the query results location are able to retrieve query results from Amazon S3 even if permission to the <code>GetQueryResults</code> action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.</p> </important>",
"GetTableMetadata": "<p>Returns table metadata for the specified catalog, database, and table.</p>",
"GetWorkGroup": "<p>Returns information about the workgroup with the specified name.</p>",
"ListDataCatalogs": "<p>Lists the data catalogs in the current Amazon Web Services account.</p>",
"ListDatabases": "<p>Lists the databases in the specified data catalog.</p>",
"ListEngineVersions": "<p>Returns a list of engine versions that are available to choose from, including the Auto option.</p>",
"ListNamedQueries": "<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.</p> <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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"ListPreparedStatements": "<p>Lists the prepared statements in the specified workgroup.</p>",
"ListQueryExecutions": "<p>Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.</p> <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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"ListTableMetadata": "<p>Lists the metadata for the tables in the specified data catalog database.</p>",
"ListTagsForResource": "<p>Lists the tags associated with an Athena workgroup or data catalog resource.</p>",
"ListWorkGroups": "<p>Lists available workgroups for the account.</p>",
"StartQueryExecution": "<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires <a>GetDataCatalog</a> permission to the catalog. 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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"StopQueryExecution": "<p>Stops a query execution. Requires you to have access to the workgroup in which the query ran.</p> <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 Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"TagResource": "<p>Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.</p>",
"UntagResource": "<p>Removes one or more tags from a data catalog or workgroup resource.</p>",
"UpdateDataCatalog": "<p>Updates the data catalog that has the specified name.</p>",
"UpdateNamedQuery": "<p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be updated.</p>",
"UpdatePreparedStatement": "<p>Updates a prepared statement.</p>",
"UpdateWorkGroup": "<p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.</p>"
},
"shapes": {
"AclConfiguration": {
"base": "<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. When Athena stores query results in Amazon S3, the canned ACL is set with the <code>x-amz-acl</code> request header. For more 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 Guide</i>.</p>",
"refs": {
"ResultConfiguration$AclConfiguration": "<p>Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is <code>BUCKET_OWNER_FULL_CONTROL</code>. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"ResultConfigurationUpdates$AclConfiguration": "<p>The ACL configuration for the query results.</p>"
}
},
"AmazonResourceName": {
"base": null,
"refs": {
"ListTagsForResourceInput$ResourceARN": "<p>Lists the tags for the resource with the specified ARN.</p>",
"ResourceNotFoundException$ResourceName": "<p>The name of the Amazon resource.</p>",
"TagResourceInput$ResourceARN": "<p>Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.</p>",
"UntagResourceInput$ResourceARN": "<p>Specifies the ARN of the resource from which tags are to be removed.</p>"
}
},
"AthenaError": {
"base": "<p>Provides information about an Athena query error. The <code>AthenaError</code> feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. <code>AthenaError</code> includes an <code>ErrorCategory</code> field that specifies whether the cause of the failed query is due to system error, user error, or other error.</p>",
"refs": {
"QueryExecutionStatus$AthenaError": "<p>Provides information about an Athena query error.</p>"
}
},
"BatchGetNamedQueryInput": {
"base": null,
"refs": {
}
},
"BatchGetNamedQueryOutput": {
"base": null,
"refs": {
}
},
"BatchGetPreparedStatementInput": {
"base": null,
"refs": {
}
},
"BatchGetPreparedStatementOutput": {
"base": null,
"refs": {
}
},
"BatchGetQueryExecutionInput": {
"base": null,
"refs": {
}
},
"BatchGetQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"AthenaError$Retryable": "<p>True if the query might succeed if resubmitted.</p>",
"ColumnInfo$CaseSensitive": "<p>Indicates whether values in the column are case-sensitive.</p>"
}
},
"BoxedBoolean": {
"base": null,
"refs": {
"DeleteWorkGroupInput$RecursiveDeleteOption": "<p>The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.</p>",
"ResultConfigurationUpdates$RemoveOutputLocation": "<p>If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the <code>OutputLocation</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>OutputLocation</code> in the workgroup's <code>ResultConfiguration</code> will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"ResultConfigurationUpdates$RemoveEncryptionConfiguration": "<p>If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the <code>EncryptionConfiguration</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>EncryptionConfiguration</code> in the workgroup's <code>ResultConfiguration</code> will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"ResultConfigurationUpdates$RemoveExpectedBucketOwner": "<p>If set to \"true\", removes the Amazon Web Services account ID previously specified for <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to \"false\" or not set, and a value is present in the <code>ExpectedBucketOwner</code> in <code>ResultConfigurationUpdates</code> (the client-side setting), the <code>ExpectedBucketOwner</code> in the workgroup's <code>ResultConfiguration</code> is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"ResultConfigurationUpdates$RemoveAclConfiguration": "<p>If set to <code>true</code>, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to <code>false</code> or not set, and a value is present in the <code>AclConfiguration</code> of <code>ResultConfigurationUpdates</code>, the <code>AclConfiguration</code> in the workgroup's <code>ResultConfiguration</code> is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"WorkGroupConfiguration$EnforceWorkGroupConfiguration": "<p>If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"WorkGroupConfiguration$PublishCloudWatchMetricsEnabled": "<p>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</p>",
"WorkGroupConfiguration$RequesterPaysEnabled": "<p>If set to <code>true</code>, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"WorkGroupConfigurationUpdates$EnforceWorkGroupConfiguration": "<p>If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\" client-side settings are used. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"WorkGroupConfigurationUpdates$PublishCloudWatchMetricsEnabled": "<p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>",
"WorkGroupConfigurationUpdates$RemoveBytesScannedCutoffPerQuery": "<p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a> </p>",
"WorkGroupConfigurationUpdates$RequesterPaysEnabled": "<p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
}
},
"BytesScannedCutoffValue": {
"base": null,
"refs": {
"WorkGroupConfiguration$BytesScannedCutoffPerQuery": "<p>The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>",
"WorkGroupConfigurationUpdates$BytesScannedCutoffPerQuery": "<p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
}
},
"CatalogNameString": {
"base": null,
"refs": {
"CreateDataCatalogInput$Name": "<p>The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.</p>",
"DataCatalog$Name": "<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, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.</p>",
"DataCatalogSummary$CatalogName": "<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, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.</p>",
"DeleteDataCatalogInput$Name": "<p>The name of the data catalog to delete.</p>",
"GetDataCatalogInput$Name": "<p>The name of the data catalog to return.</p>",
"GetDatabaseInput$CatalogName": "<p>The name of the data catalog that contains the database to return.</p>",
"GetTableMetadataInput$CatalogName": "<p>The name of the data catalog that contains the database and table metadata to return.</p>",
"ListDatabasesInput$CatalogName": "<p>The name of the data catalog that contains the databases to return.</p>",
"ListTableMetadataInput$CatalogName": "<p>The name of the data catalog for which table metadata should be returned.</p>",
"QueryExecutionContext$Catalog": "<p>The name of the data catalog used in the query execution.</p>",
"UpdateDataCatalogInput$Name": "<p>The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.</p>"
}
},
"Column": {
"base": "<p>Contains metadata for a column in a table.</p>",
"refs": {
"ColumnList$member": null
}
},
"ColumnInfo": {
"base": "<p>Information about the columns in a query execution result.</p>",
"refs": {
"ColumnInfoList$member": null
}
},
"ColumnInfoList": {
"base": null,
"refs": {
"ResultSetMetadata$ColumnInfo": "<p>Information about the columns returned in a query result metadata.</p>"
}
},
"ColumnList": {
"base": null,
"refs": {
"TableMetadata$Columns": "<p>A list of the columns in the table.</p>",
"TableMetadata$PartitionKeys": "<p>A list of the partition keys in the table.</p>"
}
},
"ColumnNullable": {
"base": null,
"refs": {
"ColumnInfo$Nullable": "<p>Indicates the column's nullable status.</p>"
}
},
"CommentString": {
"base": null,
"refs": {
"Column$Comment": "<p>Optional information about the column.</p>"
}
},
"CreateDataCatalogInput": {
"base": null,
"refs": {
}
},
"CreateDataCatalogOutput": {
"base": null,
"refs": {
}
},
"CreateNamedQueryInput": {
"base": null,
"refs": {
}
},
"CreateNamedQueryOutput": {
"base": null,
"refs": {
}
},
"CreatePreparedStatementInput": {
"base": null,
"refs": {
}
},
"CreatePreparedStatementOutput": {
"base": null,
"refs": {
}
},
"CreateWorkGroupInput": {
"base": null,
"refs": {
}
},
"CreateWorkGroupOutput": {
"base": null,
"refs": {
}
},
"DataCatalog": {
"base": "<p>Contains information about a data catalog in an Amazon Web Services account.</p>",
"refs": {
"GetDataCatalogOutput$DataCatalog": "<p>The data catalog returned.</p>"
}
},
"DataCatalogSummary": {
"base": "<p>The summary information for the data catalog, which includes its name and type.</p>",
"refs": {
"DataCatalogSummaryList$member": null
}
},
"DataCatalogSummaryList": {
"base": null,
"refs": {
"ListDataCatalogsOutput$DataCatalogsSummary": "<p>A summary list of data catalogs.</p>"
}
},
"DataCatalogType": {
"base": null,
"refs": {
"CreateDataCatalogInput$Type": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an Glue Data Catalog.</p>",
"DataCatalog$Type": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an Glue Data Catalog.</p>",
"DataCatalogSummary$Type": "<p>The data catalog type.</p>",
"UpdateDataCatalogInput$Type": "<p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a federated catalog, <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an Glue Data Catalog.</p>"
}
},
"Database": {
"base": "<p>Contains metadata information for a database in a data catalog.</p>",
"refs": {
"DatabaseList$member": null,
"GetDatabaseOutput$Database": "<p>The database returned.</p>"
}
},
"DatabaseList": {
"base": null,
"refs": {
"ListDatabasesOutput$DatabaseList": "<p>A list of databases from a data catalog.</p>"
}
},
"DatabaseString": {
"base": null,
"refs": {
"CreateNamedQueryInput$Database": "<p>The database to which the query belongs.</p>",
"NamedQuery$Database": "<p>The database to which the query belongs.</p>",
"QueryExecutionContext$Database": "<p>The name of the database used in the query execution. The database must exist in the catalog.</p>"
}
},
"Date": {
"base": null,
"refs": {
"PreparedStatement$LastModifiedTime": "<p>The last modified time of the prepared statement.</p>",
"PreparedStatementSummary$LastModifiedTime": "<p>The last modified time of the prepared statement.</p>",
"QueryExecutionStatus$SubmissionDateTime": "<p>The date and time that the query was submitted.</p>",
"QueryExecutionStatus$CompletionDateTime": "<p>The date and time that the query completed.</p>",
"WorkGroup$CreationTime": "<p>The date and time the workgroup was created.</p>",
"WorkGroupSummary$CreationTime": "<p>The workgroup creation date and time.</p>"
}
},
"Datum": {
"base": "<p>A piece of data (a field in the table).</p>",
"refs": {
"datumList$member": null
}
},
"DeleteDataCatalogInput": {
"base": null,
"refs": {
}
},
"DeleteDataCatalogOutput": {
"base": null,
"refs": {
}
},
"DeleteNamedQueryInput": {
"base": null,
"refs": {
}
},
"DeleteNamedQueryOutput": {
"base": null,
"refs": {
}
},
"DeletePreparedStatementInput": {
"base": null,
"refs": {
}
},
"DeletePreparedStatementOutput": {
"base": null,
"refs": {
}
},
"DeleteWorkGroupInput": {
"base": null,
"refs": {
}
},
"DeleteWorkGroupOutput": {
"base": null,
"refs": {
}
},
"DescriptionString": {
"base": null,
"refs": {
"CreateDataCatalogInput$Description": "<p>A description of the data catalog to be created.</p>",
"CreateNamedQueryInput$Description": "<p>The query description.</p>",
"CreatePreparedStatementInput$Description": "<p>The description of the prepared statement.</p>",
"DataCatalog$Description": "<p>An optional description of the data catalog.</p>",
"Database$Description": "<p>An optional description of the database.</p>",
"NamedQuery$Description": "<p>The query description.</p>",
"PreparedStatement$Description": "<p>The description of the prepared statement.</p>",
"UpdateDataCatalogInput$Description": "<p>New or modified text that describes the data catalog.</p>",
"UpdatePreparedStatementInput$Description": "<p>The description of the prepared statement.</p>"
}
},
"EncryptionConfiguration": {
"base": "<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and key information.</p>",
"refs": {
"ResultConfiguration$EncryptionConfiguration": "<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"ResultConfigurationUpdates$EncryptionConfiguration": "<p>The encryption configuration for the query results.</p>"
}
},
"EncryptionOption": {
"base": null,
"refs": {
"EncryptionConfiguration$EncryptionOption": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE_S3</code>), server-side encryption with KMS-managed keys (<code>SSE_KMS</code>), or client-side encryption with KMS-managed keys (<code>CSE_KMS</code>) is used.</p> <p>If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. </p>"
}
},
"EngineVersion": {
"base": "<p>The Athena engine version for running queries.</p>",
"refs": {
"EngineVersionsList$member": null,
"QueryExecution$EngineVersion": "<p>The engine version that executed the query.</p>",
"WorkGroupConfiguration$EngineVersion": "<p>The engine version that all queries running on the workgroup use. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>",
"WorkGroupConfigurationUpdates$EngineVersion": "<p>The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>",
"WorkGroupSummary$EngineVersion": "<p>The engine version setting for all queries on the workgroup. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
}
},
"EngineVersionsList": {
"base": null,
"refs": {
"ListEngineVersionsOutput$EngineVersions": "<p>A list of engine versions that are available to choose from.</p>"
}
},
"ErrorCategory": {
"base": null,
"refs": {
"AthenaError$ErrorCategory": "<p>An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.</p> <p> <b>1</b> - System</p> <p> <b>2</b> - User</p> <p> <b>3</b> - Other</p>"
}
},
"ErrorCode": {
"base": "<p>The error code returned when the query execution failed to process, or when the processing request for the named query failed.</p>",
"refs": {
"InvalidRequestException$AthenaErrorCode": null,
"UnprocessedNamedQueryId$ErrorCode": "<p>The error code returned when the processing request for the named query failed, if applicable.</p>",
"UnprocessedPreparedStatementName$ErrorCode": "<p>The error code returned when the request for the prepared statement failed.</p>",
"UnprocessedQueryExecutionId$ErrorCode": "<p>The error code returned when the query execution failed to process, if applicable.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"InternalServerException$Message": null,
"InvalidRequestException$Message": null,
"MetadataException$Message": null,
"ResourceNotFoundException$Message": null,
"TooManyRequestsException$Message": null,
"UnprocessedNamedQueryId$ErrorMessage": "<p>The error message returned when the processing request for the named query failed, if applicable.</p>",
"UnprocessedPreparedStatementName$ErrorMessage": "<p>The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:</p> <ul> <li> <p> <code>INVALID_INPUT</code> - The name of the prepared statement that was provided is not valid (for example, the name is too long).</p> </li> <li> <p> <code>STATEMENT_NOT_FOUND</code> - A prepared statement with the name provided could not be found.</p> </li> <li> <p> <code>UNAUTHORIZED</code> - The requester does not have permission to access the workgroup that contains the prepared statement.</p> </li> </ul>",
"UnprocessedQueryExecutionId$ErrorMessage": "<p>The error message returned when the query execution failed to process, if applicable.</p>"
}
},
"ErrorType": {
"base": null,
"refs": {
"AthenaError$ErrorType": "<p>An integer value that provides specific information about an Athena query 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 Guide</i>.</p>"
}
},
"ExecutionParameter": {
"base": null,
"refs": {
"ExecutionParameters$member": null
}
},
"ExecutionParameters": {
"base": null,
"refs": {
"QueryExecution$ExecutionParameters": "<p>A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.</p>",
"StartQueryExecutionInput$ExecutionParameters": "<p>A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.</p>"
}
},
"ExpressionString": {
"base": null,
"refs": {
"ListTableMetadataInput$Expression": "<p>A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.</p>"
}
},
"GetDataCatalogInput": {
"base": null,
"refs": {
}
},
"GetDataCatalogOutput": {
"base": null,
"refs": {
}
},
"GetDatabaseInput": {
"base": null,
"refs": {
}
},
"GetDatabaseOutput": {
"base": null,
"refs": {
}
},
"GetNamedQueryInput": {
"base": null,
"refs": {
}
},
"GetNamedQueryOutput": {
"base": null,
"refs": {
}
},
"GetPreparedStatementInput": {
"base": null,
"refs": {
}
},
"GetPreparedStatementOutput": {
"base": null,
"refs": {
}
},
"GetQueryExecutionInput": {
"base": null,
"refs": {
}
},
"GetQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"GetQueryResultsInput": {
"base": null,
"refs": {
}
},
"GetQueryResultsOutput": {
"base": null,
"refs": {
}
},
"GetTableMetadataInput": {
"base": null,
"refs": {
}
},
"GetTableMetadataOutput": {
"base": null,
"refs": {
}
},
"GetWorkGroupInput": {
"base": null,
"refs": {
}
},
"GetWorkGroupOutput": {
"base": null,
"refs": {
}
},
"IdempotencyToken": {
"base": null,
"refs": {
"CreateNamedQueryInput$ClientRequestToken": "<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>CreateNamedQuery</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p> </important>",
"StartQueryExecutionInput$ClientRequestToken": "<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>StartQueryExecution</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.</p> </important>"
}
},
"Integer": {
"base": null,
"refs": {
"ColumnInfo$Precision": "<p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.</p>",
"ColumnInfo$Scale": "<p>For <code>DECIMAL</code> data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.</p>"
}
},
"InternalServerException": {
"base": "<p>Indicates a platform issue, which may be due to a transient condition or outage.</p>",
"refs": {
}
},
"InvalidRequestException": {
"base": "<p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>",
"refs": {
}
},
"KeyString": {
"base": null,
"refs": {
"ParametersMap$key": null
}
},
"ListDataCatalogsInput": {
"base": null,
"refs": {
}
},
"ListDataCatalogsOutput": {
"base": null,
"refs": {
}
},
"ListDatabasesInput": {
"base": null,
"refs": {
}
},
"ListDatabasesOutput": {
"base": null,
"refs": {
}
},
"ListEngineVersionsInput": {
"base": null,
"refs": {
}
},
"ListEngineVersionsOutput": {
"base": null,
"refs": {
}
},
"ListNamedQueriesInput": {
"base": null,
"refs": {
}
},
"ListNamedQueriesOutput": {
"base": null,
"refs": {
}
},
"ListPreparedStatementsInput": {
"base": null,
"refs": {
}
},
"ListPreparedStatementsOutput": {
"base": null,
"refs": {
}
},
"ListQueryExecutionsInput": {
"base": null,
"refs": {
}
},
"ListQueryExecutionsOutput": {
"base": null,
"refs": {
}
},
"ListTableMetadataInput": {
"base": null,
"refs": {
}
},
"ListTableMetadataOutput": {
"base": null,
"refs": {
}
},
"ListTagsForResourceInput": {
"base": null,
"refs": {
}
},
"ListTagsForResourceOutput": {
"base": null,
"refs": {
}
},
"ListWorkGroupsInput": {
"base": null,
"refs": {
}
},
"ListWorkGroupsOutput": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"GetQueryResultsOutput$UpdateCount": "<p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code> statement. </p>",
"QueryExecutionStatistics$EngineExecutionTimeInMillis": "<p>The number of milliseconds that the query took to execute.</p>",
"QueryExecutionStatistics$DataScannedInBytes": "<p>The number of bytes in the data that was queried.</p>",
"QueryExecutionStatistics$TotalExecutionTimeInMillis": "<p>The number of milliseconds that Athena took to run the query.</p>",
"QueryExecutionStatistics$QueryQueueTimeInMillis": "<p>The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.</p>",
"QueryExecutionStatistics$QueryPlanningTimeInMillis": "<p>The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.</p>",
"QueryExecutionStatistics$ServiceProcessingTimeInMillis": "<p>The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.</p>"
}
},
"MaxDataCatalogsCount": {
"base": null,
"refs": {
"ListDataCatalogsInput$MaxResults": "<p>Specifies the maximum number of data catalogs to return.</p>"
}
},
"MaxDatabasesCount": {
"base": null,
"refs": {
"ListDatabasesInput$MaxResults": "<p>Specifies the maximum number of results to return.</p>"
}
},
"MaxEngineVersionsCount": {
"base": null,
"refs": {
"ListEngineVersionsInput$MaxResults": "<p>The maximum number of engine versions to return in this request.</p>"
}
},
"MaxNamedQueriesCount": {
"base": null,
"refs": {
"ListNamedQueriesInput$MaxResults": "<p>The maximum number of queries to return in this request.</p>"
}
},
"MaxPreparedStatementsCount": {
"base": null,
"refs": {
"ListPreparedStatementsInput$MaxResults": "<p>The maximum number of results to return in this request.</p>"
}
},
"MaxQueryExecutionsCount": {
"base": null,
"refs": {
"ListQueryExecutionsInput$MaxResults": "<p>The maximum number of query executions to return in this request.</p>"
}
},
"MaxQueryResults": {
"base": null,
"refs": {
"GetQueryResultsInput$MaxResults": "<p>The maximum number of results (rows) to return in this request.</p>"
}
},
"MaxTableMetadataCount": {
"base": null,
"refs": {
"ListTableMetadataInput$MaxResults": "<p>Specifies the maximum number of results to return.</p>"
}
},
"MaxTagsCount": {
"base": null,
"refs": {
"ListTagsForResourceInput$MaxResults": "<p>The maximum number of results to be returned per request that lists the tags for the resource.</p>"
}
},
"MaxWorkGroupsCount": {
"base": null,
"refs": {
"ListWorkGroupsInput$MaxResults": "<p>The maximum number of workgroups to return in this request.</p>"
}
},
"MetadataException": {
"base": "<p>An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (<code>InvalidRequestException</code>) or from the Athena platform (<code>InternalServerException</code>). For example, if a user-created Lambda function is missing permissions, the Lambda <code>4XX</code> exception is returned in a <code>MetadataException</code>.</p>",
"refs": {
}
},
"NameString": {
"base": null,
"refs": {
"Column$Name": "<p>The name of the column.</p>",
"CreateNamedQueryInput$Name": "<p>The query name.</p>",
"Database$Name": "<p>The name of the database.</p>",
"EngineVersion$SelectedEngineVersion": "<p>The engine version requested by the user. Possible values are determined by the output of <code>ListEngineVersions</code>, including Auto. The default is Auto.</p>",
"EngineVersion$EffectiveEngineVersion": "<p>Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a <code>CreateWorkGroup</code> or <code>UpdateWorkGroup</code> operation, the <code>EffectiveEngineVersion</code> field is ignored.</p>",
"GetDatabaseInput$DatabaseName": "<p>The name of the database to return.</p>",
"GetTableMetadataInput$DatabaseName": "<p>The name of the database that contains the table metadata to return.</p>",
"GetTableMetadataInput$TableName": "<p>The name of the table for which metadata is returned.</p>",
"ListTableMetadataInput$DatabaseName": "<p>The name of the database for which table metadata should be returned.</p>",
"NamedQuery$Name": "<p>The query name.</p>",
"TableMetadata$Name": "<p>The name of the table.</p>",
"UpdateNamedQueryInput$Name": "<p>The name of the query.</p>"
}
},
"NamedQuery": {
"base": "<p>A query, where <code>QueryString</code> contains the SQL statements that make up the query.</p>",
"refs": {
"GetNamedQueryOutput$NamedQuery": "<p>Information about the query.</p>",
"NamedQueryList$member": null
}
},
"NamedQueryDescriptionString": {
"base": null,
"refs": {
"UpdateNamedQueryInput$Description": "<p>The query description.</p>"
}
},
"NamedQueryId": {
"base": null,
"refs": {
"CreateNamedQueryOutput$NamedQueryId": "<p>The unique ID of the query.</p>",
"DeleteNamedQueryInput$NamedQueryId": "<p>The unique ID of the query to delete.</p>",
"GetNamedQueryInput$NamedQueryId": "<p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query IDs.</p>",
"NamedQuery$NamedQueryId": "<p>The unique identifier of the query.</p>",
"NamedQueryIdList$member": null,
"UnprocessedNamedQueryId$NamedQueryId": "<p>The unique identifier of the named query.</p>",
"UpdateNamedQueryInput$NamedQueryId": "<p>The unique identifier (UUID) of the query.</p>"
}
},
"NamedQueryIdList": {
"base": null,
"refs": {
"BatchGetNamedQueryInput$NamedQueryIds": "<p>An array of query IDs.</p>",
"ListNamedQueriesOutput$NamedQueryIds": "<p>The list of unique query IDs.</p>"
}
},
"NamedQueryList": {
"base": null,
"refs": {
"BatchGetNamedQueryOutput$NamedQueries": "<p>Information about the named query IDs submitted.</p>"
}
},
"ParametersMap": {
"base": null,
"refs": {
"CreateDataCatalogInput$Parameters": "<p>Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The <code> <i>catalog_id</i> </code> is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs.</p> <p> <code>catalog-id=<i>catalog_id</i> </code> </p> <ul> <li> <p>The <code>GLUE</code> data catalog type also applies to the default <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one and cannot modify.</p> </li> <li> <p>Queries that specify a Glue Data Catalog other than the default <code>AwsDataCatalog</code> must be run on Athena engine version 2.</p> </li> <li> <p>In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an <code>INVALID_INPUT</code> error.</p> </li> </ul> </li> </ul>",
"DataCatalog$Parameters": "<p>Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The <code> <i>catalog_id</i> </code> is the account ID of the Amazon Web Services account to which the Glue catalog belongs.</p> <p> <code>catalog-id=<i>catalog_id</i> </code> </p> <ul> <li> <p>The <code>GLUE</code> data catalog type also applies to the default <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one and cannot modify.</p> </li> <li> <p>Queries that specify a Glue Data Catalog other than the default <code>AwsDataCatalog</code> must be run on Athena engine version 2.</p> </li> </ul> </li> </ul>",
"Database$Parameters": "<p>A set of custom key/value pairs.</p>",
"TableMetadata$Parameters": "<p>A set of custom key/value pairs for table properties.</p>",
"UpdateDataCatalogInput$Parameters": "<p>Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> </ul>"
}
},
"ParametersMapValue": {
"base": null,
"refs": {
"ParametersMap$value": null
}
},
"PreparedStatement": {
"base": "<p>A prepared SQL statement for use with Athena.</p>",
"refs": {
"GetPreparedStatementOutput$PreparedStatement": "<p>The name of the prepared statement that was retrieved.</p>",
"PreparedStatementDetailsList$member": null
}
},
"PreparedStatementDetailsList": {
"base": null,
"refs": {
"BatchGetPreparedStatementOutput$PreparedStatements": "<p>The list of prepared statements returned.</p>"
}
},
"PreparedStatementNameList": {
"base": null,
"refs": {
"BatchGetPreparedStatementInput$PreparedStatementNames": "<p>A list of prepared statement names to return.</p>"
}
},
"PreparedStatementSummary": {
"base": "<p>The name and last modified time of the prepared statement.</p>",
"refs": {
"PreparedStatementsList$member": null
}
},
"PreparedStatementsList": {
"base": null,
"refs": {
"ListPreparedStatementsOutput$PreparedStatements": "<p>The list of prepared statements for the workgroup.</p>"
}
},
"QueryExecution": {
"base": "<p>Information about a single instance of a query execution.</p>",
"refs": {
"GetQueryExecutionOutput$QueryExecution": "<p>Information about the query execution.</p>",
"QueryExecutionList$member": null
}
},
"QueryExecutionContext": {
"base": "<p>The database and data catalog context in which the query execution occurs.</p>",
"refs": {
"QueryExecution$QueryExecutionContext": "<p>The database in which the query execution occurred.</p>",
"StartQueryExecutionInput$QueryExecutionContext": "<p>The database within which the query executes.</p>"
}
},
"QueryExecutionId": {
"base": null,
"refs": {
"GetQueryExecutionInput$QueryExecutionId": "<p>The unique ID of the query execution.</p>",
"GetQueryResultsInput$QueryExecutionId": "<p>The unique ID of the query execution.</p>",
"QueryExecution$QueryExecutionId": "<p>The unique identifier for each query execution.</p>",
"QueryExecutionIdList$member": null,
"StartQueryExecutionOutput$QueryExecutionId": "<p>The unique ID of the query that ran as a result of this request.</p>",
"StopQueryExecutionInput$QueryExecutionId": "<p>The unique ID of the query execution to stop.</p>",
"UnprocessedQueryExecutionId$QueryExecutionId": "<p>The unique identifier of the query execution.</p>"
}
},
"QueryExecutionIdList": {
"base": null,
"refs": {
"BatchGetQueryExecutionInput$QueryExecutionIds": "<p>An array of query execution IDs.</p>",
"ListQueryExecutionsOutput$QueryExecutionIds": "<p>The unique IDs of each query execution as an array of strings.</p>"
}
},
"QueryExecutionList": {
"base": null,
"refs": {
"BatchGetQueryExecutionOutput$QueryExecutions": "<p>Information about a query execution.</p>"
}
},
"QueryExecutionState": {
"base": null,
"refs": {
"QueryExecutionStatus$State": "<p>The state of query execution. <code>QUEUED</code> indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. <code>RUNNING</code> indicates that the query is in execution phase. <code>SUCCEEDED</code> indicates that the query completed without errors. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that a user input interrupted query execution.</p> <note> <p>Athena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from <code>RUNNING</code> or <code>FAILED</code> to <code>QUEUED</code>. </p> </note>"
}
},
"QueryExecutionStatistics": {
"base": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.</p>",
"refs": {
"QueryExecution$Statistics": "<p>Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.</p>"
}
},
"QueryExecutionStatus": {
"base": "<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>",
"refs": {
"QueryExecution$Status": "<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"
}
},
"QueryString": {
"base": null,
"refs": {
"CreateNamedQueryInput$QueryString": "<p>The contents of the query with all query statements.</p>",
"CreatePreparedStatementInput$QueryStatement": "<p>The query string for the prepared statement.</p>",
"NamedQuery$QueryString": "<p>The SQL statements that make up the query.</p>",
"PreparedStatement$QueryStatement": "<p>The query string for the prepared statement.</p>",
"QueryExecution$Query": "<p>The SQL query statements which the query execution ran.</p>",
"StartQueryExecutionInput$QueryString": "<p>The SQL query statements to be executed.</p>",
"UpdateNamedQueryInput$QueryString": "<p>The contents of the query with all query statements.</p>",
"UpdatePreparedStatementInput$QueryStatement": "<p>The query string for the prepared statement.</p>"
}
},
"ResourceNotFoundException": {
"base": "<p>A resource, such as a workgroup, was not found.</p>",
"refs": {
}
},
"ResultConfiguration": {
"base": "<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.</p>",
"refs": {
"QueryExecution$ResultConfiguration": "<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>",
"StartQueryExecutionInput$ResultConfiguration": "<p>Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
"WorkGroupConfiguration$ResultConfiguration": "<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using <a>ResultConfiguration$OutputLocation</a>. If none of them is set, Athena issues an error that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>.</p>"
}
},
"ResultConfigurationUpdates": {
"base": "<p>The information about the updates in the query results, such as output location and encryption configuration for the query results.</p>",
"refs": {
"WorkGroupConfigurationUpdates$ResultConfigurationUpdates": "<p>The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.</p>"
}
},
"ResultSet": {
"base": "<p>The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a <code>ResultSet</code> object, use <a>GetQueryResults</a>.</p>",
"refs": {
"GetQueryResultsOutput$ResultSet": "<p>The results of the query execution.</p>"
}
},
"ResultSetMetadata": {
"base": "<p>The metadata that describes the column structure and data types of a table of query results. To return a <code>ResultSetMetadata</code> object, use <a>GetQueryResults</a>.</p>",
"refs": {
"ResultSet$ResultSetMetadata": "<p>The metadata that describes the column structure and data types of a table of query results.</p>"
}
},
"Row": {
"base": "<p>The rows that make up a query result table.</p>",
"refs": {
"RowList$member": null
}
},
"RowList": {
"base": null,
"refs": {
"ResultSet$Rows": "<p>The rows in the table.</p>"
}
},
"S3AclOption": {
"base": null,
"refs": {
"AclConfiguration$S3AclOption": "<p>The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is <code>BUCKET_OWNER_FULL_CONTROL</code>. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. 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 Guide</i>.</p>"
}
},
"StartQueryExecutionInput": {
"base": null,
"refs": {
}
},
"StartQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"StatementName": {
"base": null,
"refs": {
"CreatePreparedStatementInput$StatementName": "<p>The name of the prepared statement.</p>",
"DeletePreparedStatementInput$StatementName": "<p>The name of the prepared statement to delete.</p>",
"GetPreparedStatementInput$StatementName": "<p>The name of the prepared statement to retrieve.</p>",
"PreparedStatement$StatementName": "<p>The name of the prepared statement.</p>",
"PreparedStatementNameList$member": null,
"PreparedStatementSummary$StatementName": "<p>The name of the prepared statement.</p>",
"UnprocessedPreparedStatementName$StatementName": "<p>The name of a prepared statement that could not be returned due to an error.</p>",
"UpdatePreparedStatementInput$StatementName": "<p>The name of the prepared statement.</p>"
}
},
"StatementType": {
"base": null,
"refs": {
"QueryExecution$StatementType": "<p>The type of query statement that was run. <code>DDL</code> indicates DDL query statements. <code>DML</code> indicates DML (Data Manipulation Language) query statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or <code>DESCRIBE TABLE</code>.</p>"
}
},
"StopQueryExecutionInput": {
"base": null,
"refs": {
}
},
"StopQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"AthenaError$ErrorMessage": "<p>Contains a short description of the error that occurred.</p>",
"ColumnInfo$CatalogName": "<p>The catalog to which the query results belong.</p>",
"ColumnInfo$SchemaName": "<p>The schema name (database name) to which the query results belong.</p>",
"ColumnInfo$TableName": "<p>The table name for the query results.</p>",
"ColumnInfo$Name": "<p>The name of the column.</p>",
"ColumnInfo$Label": "<p>A column label.</p>",
"ColumnInfo$Type": "<p>The data type of the column.</p>",
"EncryptionConfiguration$KmsKey": "<p>For <code>SSE_KMS</code> and <code>CSE_KMS</code>, this is the KMS key ARN or ID.</p>",
"QueryExecutionStatistics$DataManifestLocation": "<p>The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Working with Query Results, Output Files, and Query History</a> in the <i>Amazon Athena User Guide</i>.</p>",
"QueryExecutionStatus$StateChangeReason": "<p>Further detail about the status of the query.</p>",
"ResultConfiguration$OutputLocation": "<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using <a>WorkGroupConfiguration</a>. If none of them is set, Athena issues an error that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
"ResultConfiguration$ExpectedBucketOwner": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>. If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it makes Amazon S3 calls to your specified output location. If the <code>ExpectedBucketOwner</code> Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.</p> <p>This is a client-side setting. If workgroup settings override client-side settings, then the query uses the <code>ExpectedBucketOwner</code> setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
"ResultConfigurationUpdates$OutputLocation": "<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in <code>EnforceWorkGroupConfiguration</code> (true/false) in the <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
"ResultConfigurationUpdates$ExpectedBucketOwner": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>. If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it makes Amazon S3 calls to your specified output location. If the <code>ExpectedBucketOwner</code> Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.</p> <p>If workgroup settings override client-side settings, then the query uses the <code>ExpectedBucketOwner</code> setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"TableMetadata": {
"base": "<p>Contains metadata for a table.</p>",
"refs": {
"GetTableMetadataOutput$TableMetadata": "<p>An object that contains table metadata.</p>",
"TableMetadataList$member": null
}
},
"TableMetadataList": {
"base": null,
"refs": {
"ListTableMetadataOutput$TableMetadataList": "<p>A list of table metadata.</p>"
}
},
"TableTypeString": {
"base": null,
"refs": {
"TableMetadata$TableType": "<p>The type of table. In Athena, only <code>EXTERNAL_TABLE</code> is supported.</p>"
}
},
"Tag": {
"base": "<p>A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas. </p>",
"refs": {
"TagList$member": null
}
},