-
Notifications
You must be signed in to change notification settings - Fork 598
/
types.go
1606 lines (1234 loc) · 57.4 KB
/
types.go
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
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// 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 x-amz-acl request header. For more information about S3
// Object Ownership, see [Object Ownership settings]in the Amazon S3 User Guide.
//
// [Object Ownership settings]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview
type AclConfiguration struct {
// The Amazon S3 canned ACL that Athena should specify when storing query results.
// Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . 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 [Canned ACL]in the Amazon S3 User Guide.
//
// [Canned ACL]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl
//
// This member is required.
S3AclOption S3AclOption
noSmithyDocumentSerde
}
// Contains the application runtime IDs and their supported DPU sizes.
type ApplicationDPUSizes struct {
// The name of the supported application runtime (for example, Athena notebook
// version 1 ).
ApplicationRuntimeId *string
// A list of the supported DPU sizes that the application runtime supports.
SupportedDPUSizes []int32
noSmithyDocumentSerde
}
// Provides information about an Athena query error. The AthenaError feature
// provides standardized error information to help you understand failed queries
// and take steps after a query failure occurs. AthenaError includes an
// ErrorCategory field that specifies whether the cause of the failed query is due
// to system error, user error, or other error.
type AthenaError struct {
// An integer value that specifies the category of a query failure error. The
// following list shows the category for each integer value.
//
// 1 - System
//
// 2 - User
//
// 3 - Other
ErrorCategory *int32
// Contains a short description of the error that occurred.
ErrorMessage *string
// An integer value that provides specific information about an Athena query
// error. For the meaning of specific values, see the [Error Type Reference]in the Amazon Athena User
// Guide.
//
// [Error Type Reference]: https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference
ErrorType *int32
// True if the query might succeed if resubmitted.
Retryable bool
noSmithyDocumentSerde
}
// Contains configuration information for the calculation.
type CalculationConfiguration struct {
// A string that contains the code for the calculation.
CodeBlock *string
noSmithyDocumentSerde
}
// Contains information about an application-specific calculation result.
type CalculationResult struct {
// The Amazon S3 location of the folder for the calculation results.
ResultS3Uri *string
// The data format of the calculation result.
ResultType *string
// The Amazon S3 location of the stderr error messages file for the calculation.
StdErrorS3Uri *string
// The Amazon S3 location of the stdout file for the calculation.
StdOutS3Uri *string
noSmithyDocumentSerde
}
// Contains statistics for a notebook calculation.
type CalculationStatistics struct {
// The data processing unit execution time in milliseconds for the calculation.
DpuExecutionInMillis *int64
// The progress of the calculation.
Progress *string
noSmithyDocumentSerde
}
// Contains information about the status of a notebook calculation.
type CalculationStatus struct {
// The date and time the calculation completed processing.
CompletionDateTime *time.Time
// The state of the calculation execution. A description of each state follows.
//
// CREATING - The calculation is in the process of being created.
//
// CREATED - The calculation has been created and is ready to run.
//
// QUEUED - The calculation has been queued for processing.
//
// RUNNING - The calculation is running.
//
// CANCELING - A request to cancel the calculation has been received and the
// system is working to stop it.
//
// CANCELED - The calculation is no longer running as the result of a cancel
// request.
//
// COMPLETED - The calculation has completed without error.
//
// FAILED - The calculation failed and is no longer running.
State CalculationExecutionState
// The reason for the calculation state change (for example, the calculation was
// canceled because the session was terminated).
StateChangeReason *string
// The date and time the calculation was submitted for processing.
SubmissionDateTime *time.Time
noSmithyDocumentSerde
}
// Summary information for a notebook calculation.
type CalculationSummary struct {
// The calculation execution UUID.
CalculationExecutionId *string
// A description of the calculation.
Description *string
// Contains information about the status of the calculation.
Status *CalculationStatus
noSmithyDocumentSerde
}
// Contains the submission time of a single allocation request for a capacity
// reservation and the most recent status of the attempted allocation.
type CapacityAllocation struct {
// The time when the capacity allocation was requested.
//
// This member is required.
RequestTime *time.Time
// The status of the capacity allocation.
//
// This member is required.
Status CapacityAllocationStatus
// The time when the capacity allocation request was completed.
RequestCompletionTime *time.Time
// The status message of the capacity allocation.
StatusMessage *string
noSmithyDocumentSerde
}
// A mapping between one or more workgroups and a capacity reservation.
type CapacityAssignment struct {
// The list of workgroup names for the capacity assignment.
WorkGroupNames []string
noSmithyDocumentSerde
}
// Assigns Athena workgroups (and hence their queries) to capacity reservations. A
// capacity reservation can have only one capacity assignment configuration, but
// the capacity assignment configuration can be made up of multiple individual
// assignments. Each assignment specifies how Athena queries can consume capacity
// from the capacity reservation that their workgroup is mapped to.
type CapacityAssignmentConfiguration struct {
// The list of assignments that make up the capacity assignment configuration.
CapacityAssignments []CapacityAssignment
// The name of the reservation that the capacity assignment configuration is for.
CapacityReservationName *string
noSmithyDocumentSerde
}
// A reservation for a specified number of data processing units (DPUs). When a
// reservation is initially created, it has no DPUs. Athena allocates DPUs until
// the allocated amount equals the requested amount.
type CapacityReservation struct {
// The number of data processing units currently allocated.
//
// This member is required.
AllocatedDpus *int32
// The time in UTC epoch millis when the capacity reservation was created.
//
// This member is required.
CreationTime *time.Time
// The name of the capacity reservation.
//
// This member is required.
Name *string
// The status of the capacity reservation.
//
// This member is required.
Status CapacityReservationStatus
// The number of data processing units requested.
//
// This member is required.
TargetDpus *int32
// Contains the submission time of a single allocation request for a capacity
// reservation and the most recent status of the attempted allocation.
LastAllocation *CapacityAllocation
// The time of the most recent capacity allocation that succeeded.
LastSuccessfulAllocationTime *time.Time
noSmithyDocumentSerde
}
// Contains metadata for a column in a table.
type Column struct {
// The name of the column.
//
// This member is required.
Name *string
// Optional information about the column.
Comment *string
// The data type of the column.
Type *string
noSmithyDocumentSerde
}
// Information about the columns in a query execution result.
type ColumnInfo struct {
// The name of the column.
//
// This member is required.
Name *string
// The data type of the column.
//
// This member is required.
Type *string
// Indicates whether values in the column are case-sensitive.
CaseSensitive bool
// The catalog to which the query results belong.
CatalogName *string
// A column label.
Label *string
// Unsupported constraint. This value always shows as UNKNOWN .
Nullable ColumnNullable
// For DECIMAL data types, specifies the total number of digits, up to 38. For
// performance reasons, we recommend up to 18 digits.
Precision int32
// For DECIMAL data types, specifies the total number of digits in the fractional
// part of the value. Defaults to 0.
Scale int32
// The schema name (database name) to which the query results belong.
SchemaName *string
// The table name for the query results.
TableName *string
noSmithyDocumentSerde
}
// Specifies the customer managed KMS key that is used to encrypt the user's data
// stores in Athena. When an Amazon Web Services managed key is used, this value is
// null. This setting does not apply to Athena SQL workgroups.
type CustomerContentEncryptionConfiguration struct {
// The customer managed KMS key that is used to encrypt the user's data stores in
// Athena.
//
// This member is required.
KmsKey *string
noSmithyDocumentSerde
}
// Contains metadata information for a database in a data catalog.
type Database struct {
// The name of the database.
//
// This member is required.
Name *string
// An optional description of the database.
Description *string
// A set of custom key/value pairs.
Parameters map[string]string
noSmithyDocumentSerde
}
// Contains information about a data catalog in an Amazon Web Services account.
//
// In the Athena console, data catalogs are listed as "data sources" on the Data
// sources page under the Data source name column.
type DataCatalog struct {
// 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.
//
// This member is required.
Name *string
// The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
// external hive metastore, or GLUE for an Glue Data Catalog.
//
// This member is required.
Type DataCatalogType
// An optional description of the data catalog.
Description *string
// Specifies the Lambda function or functions to use for the data catalog. This is
// a mapping whose values depend on the catalog type.
//
// - For the HIVE data catalog type, use the following syntax. The
// metadata-function parameter is required. The sdk-version parameter is optional
// and defaults to the currently supported version.
//
// metadata-function=lambda_arn, sdk-version=version_number
//
// - For the LAMBDA data catalog type, use one of the following sets of required
// parameters, but not both.
//
// - If you have one Lambda function that processes metadata and another for
// reading the actual data, use the following syntax. Both parameters are required.
//
// metadata-function=lambda_arn, record-function=lambda_arn
//
// - If you have a composite Lambda function that processes both metadata and
// data, use the following syntax to specify your Lambda function.
//
// function=lambda_arn
//
// - The GLUE type takes a catalog ID parameter and is required. The catalog_id
// is the account ID of the Amazon Web Services account to which the Glue catalog
// belongs.
//
// catalog-id=catalog_id
//
// - The GLUE data catalog type also applies to the default AwsDataCatalog that
// already exists in your account, of which you can have only one and cannot
// modify.
Parameters map[string]string
noSmithyDocumentSerde
}
// The summary information for the data catalog, which includes its name and type.
type DataCatalogSummary struct {
// 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.
CatalogName *string
// The data catalog type.
Type DataCatalogType
noSmithyDocumentSerde
}
// A piece of data (a field in the table).
type Datum struct {
// The value of the datum.
VarCharValue *string
noSmithyDocumentSerde
}
// If query and calculation results are encrypted in Amazon S3, indicates the
// encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.
type EncryptionConfiguration struct {
// Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (
// SSE_S3 ), server-side encryption with KMS-managed keys ( SSE_KMS ), or
// client-side encryption with KMS-managed keys ( CSE_KMS ) is used.
//
// 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.
//
// This member is required.
EncryptionOption EncryptionOption
// For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.
KmsKey *string
noSmithyDocumentSerde
}
// Contains data processing unit (DPU) configuration settings and parameter
// mappings for a notebook engine.
type EngineConfiguration struct {
// The maximum number of DPUs that can run concurrently.
//
// This member is required.
MaxConcurrentDpus *int32
// Contains additional notebook engine MAP parameter mappings in the form of
// key-value pairs. To specify an Athena notebook that the Jupyter server will
// download and serve, specify a value for the StartSessionRequest$NotebookVersionfield, and then add a key named
// NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.
AdditionalConfigs map[string]string
// The number of DPUs to use for the coordinator. A coordinator is a special
// executor that orchestrates processing work and manages other executors in a
// notebook session. The default is 1.
CoordinatorDpuSize *int32
// The default number of DPUs to use for executors. An executor is the smallest
// unit of compute that a notebook session can request from Athena. The default is
// 1.
DefaultExecutorDpuSize *int32
// Specifies custom jar files and Spark properties for use cases like cluster
// encryption, table formats, and general Spark tuning.
SparkProperties map[string]string
noSmithyDocumentSerde
}
// The Athena engine version for running queries, or the PySpark engine version
// for running sessions.
type EngineVersion struct {
// 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 CreateWorkGroup or UpdateWorkGroup operation, the
// EffectiveEngineVersion field is ignored.
EffectiveEngineVersion *string
// The engine version requested by the user. Possible values are determined by the
// output of ListEngineVersions , including AUTO. The default is AUTO.
SelectedEngineVersion *string
noSmithyDocumentSerde
}
// Contains summary information about an executor.
type ExecutorsSummary struct {
// The UUID of the executor.
//
// This member is required.
ExecutorId *string
// The smallest unit of compute that a session can request from Athena. Size is
// measured in data processing unit (DPU) values, a relative measure of processing
// power.
ExecutorSize *int64
// The processing state of the executor. A description of each state follows.
//
// CREATING - The executor is being started, including acquiring resources.
//
// CREATED - The executor has been started.
//
// REGISTERED - The executor has been registered.
//
// TERMINATING - The executor is in the process of shutting down.
//
// TERMINATED - The executor is no longer running.
//
// FAILED - Due to a failure, the executor is no longer running.
ExecutorState ExecutorState
// The type of executor used for the application ( COORDINATOR , GATEWAY , or
// WORKER ).
ExecutorType ExecutorType
// The date and time that the executor started.
StartDateTime *int64
// The date and time that the executor was terminated.
TerminationDateTime *int64
noSmithyDocumentSerde
}
// A string for searching notebook names.
type FilterDefinition struct {
// The name of the notebook to search for.
Name *string
noSmithyDocumentSerde
}
// Specifies whether the workgroup is IAM Identity Center supported.
type IdentityCenterConfiguration struct {
// Specifies whether the workgroup is IAM Identity Center supported.
EnableIdentityCenter *bool
// The IAM Identity Center instance ARN that the workgroup associates to.
IdentityCenterInstanceArn *string
noSmithyDocumentSerde
}
// A query, where QueryString contains the SQL statements that make up the query.
type NamedQuery struct {
// The database to which the query belongs.
//
// This member is required.
Database *string
// The query name.
//
// This member is required.
Name *string
// The SQL statements that make up the query.
//
// This member is required.
QueryString *string
// The query description.
Description *string
// The unique identifier of the query.
NamedQueryId *string
// The name of the workgroup that contains the named query.
WorkGroup *string
noSmithyDocumentSerde
}
// Contains metadata for notebook, including the notebook name, ID, workgroup, and
// time created.
type NotebookMetadata struct {
// The time when the notebook was created.
CreationTime *time.Time
// The time when the notebook was last modified.
LastModifiedTime *time.Time
// The name of the notebook.
Name *string
// The notebook ID.
NotebookId *string
// The type of notebook. Currently, the only valid type is IPYNB .
Type NotebookType
// The name of the Spark enabled workgroup to which the notebook belongs.
WorkGroup *string
noSmithyDocumentSerde
}
// Contains the notebook session ID and notebook session creation time.
type NotebookSessionSummary struct {
// The time when the notebook session was created.
CreationTime *time.Time
// The notebook session ID.
SessionId *string
noSmithyDocumentSerde
}
// A prepared SQL statement for use with Athena.
type PreparedStatement struct {
// The description of the prepared statement.
Description *string
// The last modified time of the prepared statement.
LastModifiedTime *time.Time
// The query string for the prepared statement.
QueryStatement *string
// The name of the prepared statement.
StatementName *string
// The name of the workgroup to which the prepared statement belongs.
WorkGroupName *string
noSmithyDocumentSerde
}
// The name and last modified time of the prepared statement.
type PreparedStatementSummary struct {
// The last modified time of the prepared statement.
LastModifiedTime *time.Time
// The name of the prepared statement.
StatementName *string
noSmithyDocumentSerde
}
// Information about a single instance of a query execution.
type QueryExecution struct {
// The engine version that executed the query.
EngineVersion *EngineVersion
// 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. The list of parameters is not returned in the response.
ExecutionParameters []string
// The SQL query statements which the query execution ran.
Query *string
// The database in which the query execution occurred.
QueryExecutionContext *QueryExecutionContext
// The unique identifier for each query execution.
QueryExecutionId *string
// Specifies whether Amazon S3 access grants are enabled for query results.
QueryResultsS3AccessGrantsConfiguration *QueryResultsS3AccessGrantsConfiguration
// The location in Amazon S3 where query and calculation 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 location for the query results and the encryption
// configuration that are specified for the workgroup.
ResultConfiguration *ResultConfiguration
// Specifies the query result reuse behavior that was used for the query.
ResultReuseConfiguration *ResultReuseConfiguration
// The type of query statement that was run. DDL indicates DDL query statements.
// DML indicates DML (Data Manipulation Language) query statements, such as CREATE
// TABLE AS SELECT . UTILITY indicates query statements other than DDL and DML,
// such as SHOW CREATE TABLE , or DESCRIBE TABLE .
StatementType StatementType
// 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.
Statistics *QueryExecutionStatistics
// The completion date, current state, submission time, and state change reason
// (if applicable) for the query execution.
Status *QueryExecutionStatus
// The kind of query statement that was run.
SubstatementType *string
// The name of the workgroup in which the query ran.
WorkGroup *string
noSmithyDocumentSerde
}
// The database and data catalog context in which the query execution occurs.
type QueryExecutionContext struct {
// The name of the data catalog used in the query execution.
Catalog *string
// The name of the database used in the query execution. The database must exist
// in the catalog.
Database *string
noSmithyDocumentSerde
}
// 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.
type QueryExecutionStatistics struct {
// 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 [Working with Query Results, Output Files, and Query History]in the Amazon Athena User Guide.
//
// [Working with Query Results, Output Files, and Query History]: https://docs.aws.amazon.com/athena/latest/ug/querying.html
DataManifestLocation *string
// The number of bytes in the data that was queried.
DataScannedInBytes *int64
// The number of milliseconds that the query took to execute.
EngineExecutionTimeInMillis *int64
// 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.
QueryPlanningTimeInMillis *int64
// 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.
QueryQueueTimeInMillis *int64
// Contains information about whether previous query results were reused for the
// query.
ResultReuseInformation *ResultReuseInformation
// The number of milliseconds that Athena took to preprocess the query before
// submitting the query to the query engine.
ServicePreProcessingTimeInMillis *int64
// The number of milliseconds that Athena took to finalize and publish the query
// results after the query engine finished running the query.
ServiceProcessingTimeInMillis *int64
// The number of milliseconds that Athena took to run the query.
TotalExecutionTimeInMillis *int64
noSmithyDocumentSerde
}
// The completion date, current state, submission time, and state change reason
// (if applicable) for the query execution.
type QueryExecutionStatus struct {
// Provides information about an Athena query error.
AthenaError *AthenaError
// The date and time that the query completed.
CompletionDateTime *time.Time
// The state of query execution. QUEUED indicates that the query has been
// submitted to the service, and Athena will execute the query as soon as resources
// are available. RUNNING indicates that the query is in execution phase. SUCCEEDED
// indicates that the query completed without errors. FAILED indicates that the
// query experienced an error and did not complete processing. CANCELLED indicates
// that a user input interrupted query execution.
//
// Athena automatically retries your queries in cases of certain transient errors.
// As a result, you may see the query state transition from RUNNING or FAILED to
// QUEUED .
State QueryExecutionState
// Further detail about the status of the query.
StateChangeReason *string
// The date and time that the query was submitted.
SubmissionDateTime *time.Time
noSmithyDocumentSerde
}
// Specifies whether Amazon S3 access grants are enabled for query results.
type QueryResultsS3AccessGrantsConfiguration struct {
// The authentication type used for Amazon S3 access grants. Currently, only
// DIRECTORY_IDENTITY is supported.
//
// This member is required.
AuthenticationType AuthenticationType
// Specifies whether Amazon S3 access grants are enabled for query results.
//
// This member is required.
EnableS3AccessGrants *bool
// When enabled, appends the user ID as an Amazon S3 path prefix to the query
// result output location.
CreateUserLevelPrefix *bool
noSmithyDocumentSerde
}
// The query execution timeline, statistics on input and output rows and bytes,
// and the different query stages that form the query execution plan.
type QueryRuntimeStatistics struct {
// Stage statistics such as input and output rows and bytes, execution time, and
// stage state. This information also includes substages and the query stage plan.
OutputStage *QueryStage
// Statistics such as input rows and bytes read by the query, rows and bytes
// output by the query, and the number of rows written by the query.
Rows *QueryRuntimeStatisticsRows
// Timeline statistics such as query queue time, planning time, execution time,
// service processing time, and total execution time.
Timeline *QueryRuntimeStatisticsTimeline
noSmithyDocumentSerde
}
// Statistics such as input rows and bytes read by the query, rows and bytes
// output by the query, and the number of rows written by the query.
type QueryRuntimeStatisticsRows struct {
// The number of bytes read to execute the query.
InputBytes *int64
// The number of rows read to execute the query.
InputRows *int64
// The number of bytes returned by the query.
OutputBytes *int64
// The number of rows returned by the query.
OutputRows *int64
noSmithyDocumentSerde
}
// Timeline statistics such as query queue time, planning time, execution time,
// service processing time, and total execution time.
type QueryRuntimeStatisticsTimeline struct {
// The number of milliseconds that the query took to execute.
EngineExecutionTimeInMillis *int64
// 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.
QueryPlanningTimeInMillis *int64
// 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.
QueryQueueTimeInMillis *int64
// The number of milliseconds that Athena spends on preprocessing before it
// submits the query to the engine.
ServicePreProcessingTimeInMillis *int64
// The number of milliseconds that Athena took to finalize and publish the query
// results after the query engine finished running the query.
ServiceProcessingTimeInMillis *int64
// The number of milliseconds that Athena took to run the query.
TotalExecutionTimeInMillis *int64
noSmithyDocumentSerde
}
// Stage statistics such as input and output rows and bytes, execution time and
// stage state. This information also includes substages and the query stage plan.
type QueryStage struct {
// Time taken to execute this stage.
ExecutionTime *int64
// The number of bytes input into the stage for execution.
InputBytes *int64
// The number of rows input into the stage for execution.
InputRows *int64
// The number of bytes output from the stage after execution.
OutputBytes *int64
// The number of rows output from the stage after execution.
OutputRows *int64
// Stage plan information such as name, identifier, sub plans, and source stages.
QueryStagePlan *QueryStagePlanNode
// The identifier for a stage.
StageId *int64
// State of the stage after query execution.
State *string
// List of sub query stages that form this stage execution plan.
SubStages []QueryStage
noSmithyDocumentSerde
}
// Stage plan information such as name, identifier, sub plans, and remote sources.
type QueryStagePlanNode struct {
// Stage plan information such as name, identifier, sub plans, and remote sources
// of child plan nodes/
Children []QueryStagePlanNode
// Information about the operation this query stage plan node is performing.
Identifier *string
// Name of the query stage plan that describes the operation this stage is
// performing as part of query execution.
Name *string
// Source plan node IDs.
RemoteSources []string
noSmithyDocumentSerde
}
// The location in Amazon S3 where query and calculation results are stored and
// the encryption option, if any, used for query and calculation results. These are
// known as "client-side settings". If workgroup settings override client-side
// settings, then the query uses the workgroup settings.
type ResultConfiguration struct {
// Indicates that an Amazon S3 canned ACL should be set to control ownership of
// stored query results. Currently the only supported canned ACL is
// BUCKET_OWNER_FULL_CONTROL . 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 WorkGroupConfiguration$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings].
//
// [Workgroup Settings Override Client-Side Settings]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html
AclConfiguration *AclConfiguration
// If query and calculation results are encrypted in Amazon S3, indicates the
// encryption option used (for example, SSE_KMS or CSE_KMS ) 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 WorkGroupConfiguration$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings].
//
// [Workgroup Settings Override Client-Side Settings]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html
EncryptionConfiguration *EncryptionConfiguration
// The Amazon Web Services account ID that you expect to be the owner of the
// Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for
// ExpectedBucketOwner when it makes Amazon S3 calls to your specified output
// location. If the ExpectedBucketOwner Amazon Web Services account ID does not
// match the actual owner of the Amazon S3 bucket, the call fails with a
// permissions error.
//
// This is a client-side setting. If workgroup settings override client-side
// settings, then the query uses the ExpectedBucketOwner setting that is specified
// for the workgroup, and also uses the location for storing query results
// specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings].
//
// [Workgroup Settings Override Client-Side Settings]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html
ExpectedBucketOwner *string