@aws-sdk/client-athena 3.323.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +22 -0
  2. package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +21 -0
  3. package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +73 -0
  4. package/dist-types/commands/CancelCapacityReservationCommand.d.ts +4 -0
  5. package/dist-types/commands/CreateCapacityReservationCommand.d.ts +4 -0
  6. package/dist-types/commands/CreateDataCatalogCommand.d.ts +4 -0
  7. package/dist-types/commands/CreateNamedQueryCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateNotebookCommand.d.ts +6 -0
  9. package/dist-types/commands/CreatePreparedStatementCommand.d.ts +4 -0
  10. package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +8 -0
  11. package/dist-types/commands/CreateWorkGroupCommand.d.ts +4 -0
  12. package/dist-types/commands/DeleteDataCatalogCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteNamedQueryCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteNotebookCommand.d.ts +4 -0
  15. package/dist-types/commands/DeletePreparedStatementCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteWorkGroupCommand.d.ts +4 -0
  17. package/dist-types/commands/ExportNotebookCommand.d.ts +14 -0
  18. package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +6 -0
  19. package/dist-types/commands/GetCalculationExecutionCommand.d.ts +25 -0
  20. package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +15 -0
  21. package/dist-types/commands/GetCapacityAssignmentConfigurationCommand.d.ts +15 -0
  22. package/dist-types/commands/GetCapacityReservationCommand.d.ts +19 -0
  23. package/dist-types/commands/GetDataCatalogCommand.d.ts +13 -0
  24. package/dist-types/commands/GetDatabaseCommand.d.ts +12 -0
  25. package/dist-types/commands/GetNamedQueryCommand.d.ts +13 -0
  26. package/dist-types/commands/GetNotebookMetadataCommand.d.ts +13 -0
  27. package/dist-types/commands/GetPreparedStatementCommand.d.ts +12 -0
  28. package/dist-types/commands/GetQueryExecutionCommand.d.ts +64 -0
  29. package/dist-types/commands/GetQueryResultsCommand.d.ts +34 -0
  30. package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +63 -0
  31. package/dist-types/commands/GetSessionCommand.d.ts +38 -0
  32. package/dist-types/commands/GetSessionStatusCommand.d.ts +14 -0
  33. package/dist-types/commands/GetTableMetadataCommand.d.ts +28 -0
  34. package/dist-types/commands/GetWorkGroupCommand.d.ts +38 -0
  35. package/dist-types/commands/ImportNotebookCommand.d.ts +6 -0
  36. package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +14 -0
  37. package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +18 -0
  38. package/dist-types/commands/ListCapacityReservationsCommand.d.ts +22 -0
  39. package/dist-types/commands/ListDataCatalogsCommand.d.ts +12 -0
  40. package/dist-types/commands/ListDatabasesCommand.d.ts +15 -0
  41. package/dist-types/commands/ListEngineVersionsCommand.d.ts +12 -0
  42. package/dist-types/commands/ListExecutorsCommand.d.ts +17 -0
  43. package/dist-types/commands/ListNamedQueriesCommand.d.ts +9 -0
  44. package/dist-types/commands/ListNotebookMetadataCommand.d.ts +16 -0
  45. package/dist-types/commands/ListNotebookSessionsCommand.d.ts +12 -0
  46. package/dist-types/commands/ListPreparedStatementsCommand.d.ts +12 -0
  47. package/dist-types/commands/ListQueryExecutionsCommand.d.ts +9 -0
  48. package/dist-types/commands/ListSessionsCommand.d.ts +25 -0
  49. package/dist-types/commands/ListTableMetadataCommand.d.ts +31 -0
  50. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
  51. package/dist-types/commands/ListWorkGroupsCommand.d.ts +18 -0
  52. package/dist-types/commands/PutCapacityAssignmentConfigurationCommand.d.ts +4 -0
  53. package/dist-types/commands/StartCalculationExecutionCommand.d.ts +7 -0
  54. package/dist-types/commands/StartQueryExecutionCommand.d.ts +6 -0
  55. package/dist-types/commands/StartSessionCommand.d.ts +7 -0
  56. package/dist-types/commands/StopCalculationExecutionCommand.d.ts +6 -0
  57. package/dist-types/commands/StopQueryExecutionCommand.d.ts +4 -0
  58. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  59. package/dist-types/commands/TerminateSessionCommand.d.ts +6 -0
  60. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  61. package/dist-types/commands/UpdateCapacityReservationCommand.d.ts +4 -0
  62. package/dist-types/commands/UpdateDataCatalogCommand.d.ts +4 -0
  63. package/dist-types/commands/UpdateNamedQueryCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateNotebookCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +4 -0
  66. package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +4 -0
  67. package/dist-types/commands/UpdateWorkGroupCommand.d.ts +4 -0
  68. package/package.json +16 -16
@@ -41,6 +41,26 @@ export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutpu
41
41
  * };
42
42
  * const command = new BatchGetNamedQueryCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // BatchGetNamedQueryOutput
45
+ * // NamedQueries: [ // NamedQueryList
46
+ * // { // NamedQuery
47
+ * // Name: "STRING_VALUE", // required
48
+ * // Description: "STRING_VALUE",
49
+ * // Database: "STRING_VALUE", // required
50
+ * // QueryString: "STRING_VALUE", // required
51
+ * // NamedQueryId: "STRING_VALUE",
52
+ * // WorkGroup: "STRING_VALUE",
53
+ * // },
54
+ * // ],
55
+ * // UnprocessedNamedQueryIds: [ // UnprocessedNamedQueryIdList
56
+ * // { // UnprocessedNamedQueryId
57
+ * // NamedQueryId: "STRING_VALUE",
58
+ * // ErrorCode: "STRING_VALUE",
59
+ * // ErrorMessage: "STRING_VALUE",
60
+ * // },
61
+ * // ],
62
+ * // };
63
+ *
44
64
  * ```
45
65
  *
46
66
  * @param BatchGetNamedQueryCommandInput - {@link BatchGetNamedQueryCommandInput}
@@ -57,6 +77,8 @@ export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutpu
57
77
  * <p>Indicates that something is wrong with the input to the request. For example, a
58
78
  * required parameter may be missing or out of range.</p>
59
79
  *
80
+ * @throws {@link AthenaServiceException}
81
+ * <p>Base exception class for all service exceptions from Athena service.</p>
60
82
  *
61
83
  */
62
84
  export declare class BatchGetNamedQueryCommand extends $Command<BatchGetNamedQueryCommandInput, BatchGetNamedQueryCommandOutput, AthenaClientResolvedConfig> {
@@ -38,6 +38,25 @@ export interface BatchGetPreparedStatementCommandOutput extends BatchGetPrepared
38
38
  * };
39
39
  * const command = new BatchGetPreparedStatementCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // BatchGetPreparedStatementOutput
42
+ * // PreparedStatements: [ // PreparedStatementDetailsList
43
+ * // { // PreparedStatement
44
+ * // StatementName: "STRING_VALUE",
45
+ * // QueryStatement: "STRING_VALUE",
46
+ * // WorkGroupName: "STRING_VALUE",
47
+ * // Description: "STRING_VALUE",
48
+ * // LastModifiedTime: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ],
51
+ * // UnprocessedPreparedStatementNames: [ // UnprocessedPreparedStatementNameList
52
+ * // { // UnprocessedPreparedStatementName
53
+ * // StatementName: "STRING_VALUE",
54
+ * // ErrorCode: "STRING_VALUE",
55
+ * // ErrorMessage: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
41
60
  * ```
42
61
  *
43
62
  * @param BatchGetPreparedStatementCommandInput - {@link BatchGetPreparedStatementCommandInput}
@@ -54,6 +73,8 @@ export interface BatchGetPreparedStatementCommandOutput extends BatchGetPrepared
54
73
  * <p>Indicates that something is wrong with the input to the request. For example, a
55
74
  * required parameter may be missing or out of range.</p>
56
75
  *
76
+ * @throws {@link AthenaServiceException}
77
+ * <p>Base exception class for all service exceptions from Athena service.</p>
57
78
  *
58
79
  */
59
80
  export declare class BatchGetPreparedStatementCommand extends $Command<BatchGetPreparedStatementCommandInput, BatchGetPreparedStatementCommandOutput, AthenaClientResolvedConfig> {
@@ -38,6 +38,77 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
38
38
  * };
39
39
  * const command = new BatchGetQueryExecutionCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // BatchGetQueryExecutionOutput
42
+ * // QueryExecutions: [ // QueryExecutionList
43
+ * // { // QueryExecution
44
+ * // QueryExecutionId: "STRING_VALUE",
45
+ * // Query: "STRING_VALUE",
46
+ * // StatementType: "DDL" || "DML" || "UTILITY",
47
+ * // ResultConfiguration: { // ResultConfiguration
48
+ * // OutputLocation: "STRING_VALUE",
49
+ * // EncryptionConfiguration: { // EncryptionConfiguration
50
+ * // EncryptionOption: "SSE_S3" || "SSE_KMS" || "CSE_KMS", // required
51
+ * // KmsKey: "STRING_VALUE",
52
+ * // },
53
+ * // ExpectedBucketOwner: "STRING_VALUE",
54
+ * // AclConfiguration: { // AclConfiguration
55
+ * // S3AclOption: "BUCKET_OWNER_FULL_CONTROL", // required
56
+ * // },
57
+ * // },
58
+ * // ResultReuseConfiguration: { // ResultReuseConfiguration
59
+ * // ResultReuseByAgeConfiguration: { // ResultReuseByAgeConfiguration
60
+ * // Enabled: true || false, // required
61
+ * // MaxAgeInMinutes: Number("int"),
62
+ * // },
63
+ * // },
64
+ * // QueryExecutionContext: { // QueryExecutionContext
65
+ * // Database: "STRING_VALUE",
66
+ * // Catalog: "STRING_VALUE",
67
+ * // },
68
+ * // Status: { // QueryExecutionStatus
69
+ * // State: "QUEUED" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLED",
70
+ * // StateChangeReason: "STRING_VALUE",
71
+ * // SubmissionDateTime: new Date("TIMESTAMP"),
72
+ * // CompletionDateTime: new Date("TIMESTAMP"),
73
+ * // AthenaError: { // AthenaError
74
+ * // ErrorCategory: Number("int"),
75
+ * // ErrorType: Number("int"),
76
+ * // Retryable: true || false,
77
+ * // ErrorMessage: "STRING_VALUE",
78
+ * // },
79
+ * // },
80
+ * // Statistics: { // QueryExecutionStatistics
81
+ * // EngineExecutionTimeInMillis: Number("long"),
82
+ * // DataScannedInBytes: Number("long"),
83
+ * // DataManifestLocation: "STRING_VALUE",
84
+ * // TotalExecutionTimeInMillis: Number("long"),
85
+ * // QueryQueueTimeInMillis: Number("long"),
86
+ * // QueryPlanningTimeInMillis: Number("long"),
87
+ * // ServiceProcessingTimeInMillis: Number("long"),
88
+ * // ResultReuseInformation: { // ResultReuseInformation
89
+ * // ReusedPreviousResult: true || false, // required
90
+ * // },
91
+ * // },
92
+ * // WorkGroup: "STRING_VALUE",
93
+ * // EngineVersion: { // EngineVersion
94
+ * // SelectedEngineVersion: "STRING_VALUE",
95
+ * // EffectiveEngineVersion: "STRING_VALUE",
96
+ * // },
97
+ * // ExecutionParameters: [ // ExecutionParameters
98
+ * // "STRING_VALUE",
99
+ * // ],
100
+ * // SubstatementType: "STRING_VALUE",
101
+ * // },
102
+ * // ],
103
+ * // UnprocessedQueryExecutionIds: [ // UnprocessedQueryExecutionIdList
104
+ * // { // UnprocessedQueryExecutionId
105
+ * // QueryExecutionId: "STRING_VALUE",
106
+ * // ErrorCode: "STRING_VALUE",
107
+ * // ErrorMessage: "STRING_VALUE",
108
+ * // },
109
+ * // ],
110
+ * // };
111
+ *
41
112
  * ```
42
113
  *
43
114
  * @param BatchGetQueryExecutionCommandInput - {@link BatchGetQueryExecutionCommandInput}
@@ -54,6 +125,8 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
54
125
  * <p>Indicates that something is wrong with the input to the request. For example, a
55
126
  * required parameter may be missing or out of range.</p>
56
127
  *
128
+ * @throws {@link AthenaServiceException}
129
+ * <p>Base exception class for all service exceptions from Athena service.</p>
57
130
  *
58
131
  */
59
132
  export declare class BatchGetQueryExecutionCommand extends $Command<BatchGetQueryExecutionCommandInput, BatchGetQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface CancelCapacityReservationCommandOutput extends CancelCapacityRe
31
31
  * };
32
32
  * const command = new CancelCapacityReservationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param CancelCapacityReservationCommandInput - {@link CancelCapacityReservationCommandInput}
@@ -47,6 +49,8 @@ export interface CancelCapacityReservationCommandOutput extends CancelCapacityRe
47
49
  * <p>Indicates that something is wrong with the input to the request. For example, a
48
50
  * required parameter may be missing or out of range.</p>
49
51
  *
52
+ * @throws {@link AthenaServiceException}
53
+ * <p>Base exception class for all service exceptions from Athena service.</p>
50
54
  *
51
55
  */
52
56
  export declare class CancelCapacityReservationCommand extends $Command<CancelCapacityReservationCommandInput, CancelCapacityReservationCommandOutput, AthenaClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface CreateCapacityReservationCommandOutput extends CreateCapacityRe
38
38
  * };
39
39
  * const command = new CreateCapacityReservationCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param CreateCapacityReservationCommandInput - {@link CreateCapacityReservationCommandInput}
@@ -54,6 +56,8 @@ export interface CreateCapacityReservationCommandOutput extends CreateCapacityRe
54
56
  * <p>Indicates that something is wrong with the input to the request. For example, a
55
57
  * required parameter may be missing or out of range.</p>
56
58
  *
59
+ * @throws {@link AthenaServiceException}
60
+ * <p>Base exception class for all service exceptions from Athena service.</p>
57
61
  *
58
62
  */
59
63
  export declare class CreateCapacityReservationCommand extends $Command<CreateCapacityReservationCommandInput, CreateCapacityReservationCommandOutput, AthenaClientResolvedConfig> {
@@ -43,6 +43,8 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput,
43
43
  * };
44
44
  * const command = new CreateDataCatalogCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // {};
47
+ *
46
48
  * ```
47
49
  *
48
50
  * @param CreateDataCatalogCommandInput - {@link CreateDataCatalogCommandInput}
@@ -59,6 +61,8 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput,
59
61
  * <p>Indicates that something is wrong with the input to the request. For example, a
60
62
  * required parameter may be missing or out of range.</p>
61
63
  *
64
+ * @throws {@link AthenaServiceException}
65
+ * <p>Base exception class for all service exceptions from Athena service.</p>
62
66
  *
63
67
  */
64
68
  export declare class CreateDataCatalogCommand extends $Command<CreateDataCatalogCommandInput, CreateDataCatalogCommandOutput, AthenaClientResolvedConfig> {
@@ -40,6 +40,10 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
40
40
  * };
41
41
  * const command = new CreateNamedQueryCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // CreateNamedQueryOutput
44
+ * // NamedQueryId: "STRING_VALUE",
45
+ * // };
46
+ *
43
47
  * ```
44
48
  *
45
49
  * @param CreateNamedQueryCommandInput - {@link CreateNamedQueryCommandInput}
@@ -56,6 +60,8 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
56
60
  * <p>Indicates that something is wrong with the input to the request. For example, a
57
61
  * required parameter may be missing or out of range.</p>
58
62
  *
63
+ * @throws {@link AthenaServiceException}
64
+ * <p>Base exception class for all service exceptions from Athena service.</p>
59
65
  *
60
66
  */
61
67
  export declare class CreateNamedQueryCommand extends $Command<CreateNamedQueryCommandInput, CreateNamedQueryCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface CreateNotebookCommandOutput extends CreateNotebookOutput, __Met
35
35
  * };
36
36
  * const command = new CreateNotebookCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // CreateNotebookOutput
39
+ * // NotebookId: "STRING_VALUE",
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param CreateNotebookCommandInput - {@link CreateNotebookCommandInput}
@@ -54,6 +58,8 @@ export interface CreateNotebookCommandOutput extends CreateNotebookOutput, __Met
54
58
  * @throws {@link TooManyRequestsException} (client fault)
55
59
  * <p>Indicates that the request was throttled.</p>
56
60
  *
61
+ * @throws {@link AthenaServiceException}
62
+ * <p>Base exception class for all service exceptions from Athena service.</p>
57
63
  *
58
64
  */
59
65
  export declare class CreateNotebookCommand extends $Command<CreateNotebookCommandInput, CreateNotebookCommandOutput, AthenaClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface CreatePreparedStatementCommandOutput extends CreatePreparedStat
34
34
  * };
35
35
  * const command = new CreatePreparedStatementCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param CreatePreparedStatementCommandInput - {@link CreatePreparedStatementCommandInput}
@@ -50,6 +52,8 @@ export interface CreatePreparedStatementCommandOutput extends CreatePreparedStat
50
52
  * <p>Indicates that something is wrong with the input to the request. For example, a
51
53
  * required parameter may be missing or out of range.</p>
52
54
  *
55
+ * @throws {@link AthenaServiceException}
56
+ * <p>Base exception class for all service exceptions from Athena service.</p>
53
57
  *
54
58
  */
55
59
  export declare class CreatePreparedStatementCommand extends $Command<CreatePreparedStatementCommandInput, CreatePreparedStatementCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,12 @@ export interface CreatePresignedNotebookUrlCommandOutput extends CreatePresigned
35
35
  * };
36
36
  * const command = new CreatePresignedNotebookUrlCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // CreatePresignedNotebookUrlResponse
39
+ * // NotebookUrl: "STRING_VALUE", // required
40
+ * // AuthToken: "STRING_VALUE", // required
41
+ * // AuthTokenExpirationTime: Number("long"), // required
42
+ * // };
43
+ *
38
44
  * ```
39
45
  *
40
46
  * @param CreatePresignedNotebookUrlCommandInput - {@link CreatePresignedNotebookUrlCommandInput}
@@ -54,6 +60,8 @@ export interface CreatePresignedNotebookUrlCommandOutput extends CreatePresigned
54
60
  * @throws {@link ResourceNotFoundException} (client fault)
55
61
  * <p>A resource, such as a workgroup, was not found.</p>
56
62
  *
63
+ * @throws {@link AthenaServiceException}
64
+ * <p>Base exception class for all service exceptions from Athena service.</p>
57
65
  *
58
66
  */
59
67
  export declare class CreatePresignedNotebookUrlCommand extends $Command<CreatePresignedNotebookUrlCommandInput, CreatePresignedNotebookUrlCommandOutput, AthenaClientResolvedConfig> {
@@ -66,6 +66,8 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M
66
66
  * };
67
67
  * const command = new CreateWorkGroupCommand(input);
68
68
  * const response = await client.send(command);
69
+ * // {};
70
+ *
69
71
  * ```
70
72
  *
71
73
  * @param CreateWorkGroupCommandInput - {@link CreateWorkGroupCommandInput}
@@ -82,6 +84,8 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M
82
84
  * <p>Indicates that something is wrong with the input to the request. For example, a
83
85
  * required parameter may be missing or out of range.</p>
84
86
  *
87
+ * @throws {@link AthenaServiceException}
88
+ * <p>Base exception class for all service exceptions from Athena service.</p>
85
89
  *
86
90
  */
87
91
  export declare class CreateWorkGroupCommand extends $Command<CreateWorkGroupCommandInput, CreateWorkGroupCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput,
31
31
  * };
32
32
  * const command = new DeleteDataCatalogCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteDataCatalogCommandInput - {@link DeleteDataCatalogCommandInput}
@@ -47,6 +49,8 @@ export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput,
47
49
  * <p>Indicates that something is wrong with the input to the request. For example, a
48
50
  * required parameter may be missing or out of range.</p>
49
51
  *
52
+ * @throws {@link AthenaServiceException}
53
+ * <p>Base exception class for all service exceptions from Athena service.</p>
50
54
  *
51
55
  */
52
56
  export declare class DeleteDataCatalogCommand extends $Command<DeleteDataCatalogCommandInput, DeleteDataCatalogCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
35
35
  * };
36
36
  * const command = new DeleteNamedQueryCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeleteNamedQueryCommandInput - {@link DeleteNamedQueryCommandInput}
@@ -51,6 +53,8 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
51
53
  * <p>Indicates that something is wrong with the input to the request. For example, a
52
54
  * required parameter may be missing or out of range.</p>
53
55
  *
56
+ * @throws {@link AthenaServiceException}
57
+ * <p>Base exception class for all service exceptions from Athena service.</p>
54
58
  *
55
59
  */
56
60
  export declare class DeleteNamedQueryCommand extends $Command<DeleteNamedQueryCommandInput, DeleteNamedQueryCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteNotebookCommandOutput extends DeleteNotebookOutput, __Met
31
31
  * };
32
32
  * const command = new DeleteNotebookCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteNotebookCommandInput - {@link DeleteNotebookCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteNotebookCommandOutput extends DeleteNotebookOutput, __Met
50
52
  * @throws {@link TooManyRequestsException} (client fault)
51
53
  * <p>Indicates that the request was throttled.</p>
52
54
  *
55
+ * @throws {@link AthenaServiceException}
56
+ * <p>Base exception class for all service exceptions from Athena service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteNotebookCommand extends $Command<DeleteNotebookCommandInput, DeleteNotebookCommandOutput, AthenaClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeletePreparedStatementCommandOutput extends DeletePreparedStat
33
33
  * };
34
34
  * const command = new DeletePreparedStatementCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeletePreparedStatementCommandInput - {@link DeletePreparedStatementCommandInput}
@@ -52,6 +54,8 @@ export interface DeletePreparedStatementCommandOutput extends DeletePreparedStat
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>A resource, such as a workgroup, was not found.</p>
54
56
  *
57
+ * @throws {@link AthenaServiceException}
58
+ * <p>Base exception class for all service exceptions from Athena service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeletePreparedStatementCommand extends $Command<DeletePreparedStatementCommandInput, DeletePreparedStatementCommandOutput, AthenaClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __M
33
33
  * };
34
34
  * const command = new DeleteWorkGroupCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteWorkGroupCommandInput - {@link DeleteWorkGroupCommandInput}
@@ -49,6 +51,8 @@ export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __M
49
51
  * <p>Indicates that something is wrong with the input to the request. For example, a
50
52
  * required parameter may be missing or out of range.</p>
51
53
  *
54
+ * @throws {@link AthenaServiceException}
55
+ * <p>Base exception class for all service exceptions from Athena service.</p>
52
56
  *
53
57
  */
54
58
  export declare class DeleteWorkGroupCommand extends $Command<DeleteWorkGroupCommandInput, DeleteWorkGroupCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,18 @@ export interface ExportNotebookCommandOutput extends ExportNotebookOutput, __Met
31
31
  * };
32
32
  * const command = new ExportNotebookCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ExportNotebookOutput
35
+ * // NotebookMetadata: { // NotebookMetadata
36
+ * // NotebookId: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // WorkGroup: "STRING_VALUE",
39
+ * // CreationTime: new Date("TIMESTAMP"),
40
+ * // Type: "IPYNB",
41
+ * // LastModifiedTime: new Date("TIMESTAMP"),
42
+ * // },
43
+ * // Payload: "STRING_VALUE",
44
+ * // };
45
+ *
34
46
  * ```
35
47
  *
36
48
  * @param ExportNotebookCommandInput - {@link ExportNotebookCommandInput}
@@ -50,6 +62,8 @@ export interface ExportNotebookCommandOutput extends ExportNotebookOutput, __Met
50
62
  * @throws {@link TooManyRequestsException} (client fault)
51
63
  * <p>Indicates that the request was throttled.</p>
52
64
  *
65
+ * @throws {@link AthenaServiceException}
66
+ * <p>Base exception class for all service exceptions from Athena service.</p>
53
67
  *
54
68
  */
55
69
  export declare class ExportNotebookCommand extends $Command<ExportNotebookCommandInput, ExportNotebookCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,10 @@ export interface GetCalculationExecutionCodeCommandOutput extends GetCalculation
31
31
  * };
32
32
  * const command = new GetCalculationExecutionCodeCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetCalculationExecutionCodeResponse
35
+ * // CodeBlock: "STRING_VALUE",
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param GetCalculationExecutionCodeCommandInput - {@link GetCalculationExecutionCodeCommandInput}
@@ -50,6 +54,8 @@ export interface GetCalculationExecutionCodeCommandOutput extends GetCalculation
50
54
  * @throws {@link ResourceNotFoundException} (client fault)
51
55
  * <p>A resource, such as a workgroup, was not found.</p>
52
56
  *
57
+ * @throws {@link AthenaServiceException}
58
+ * <p>Base exception class for all service exceptions from Athena service.</p>
53
59
  *
54
60
  */
55
61
  export declare class GetCalculationExecutionCodeCommand extends $Command<GetCalculationExecutionCodeCommandInput, GetCalculationExecutionCodeCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,29 @@ export interface GetCalculationExecutionCommandOutput extends GetCalculationExec
31
31
  * };
32
32
  * const command = new GetCalculationExecutionCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetCalculationExecutionResponse
35
+ * // CalculationExecutionId: "STRING_VALUE",
36
+ * // SessionId: "STRING_VALUE",
37
+ * // Description: "STRING_VALUE",
38
+ * // WorkingDirectory: "STRING_VALUE",
39
+ * // Status: { // CalculationStatus
40
+ * // SubmissionDateTime: new Date("TIMESTAMP"),
41
+ * // CompletionDateTime: new Date("TIMESTAMP"),
42
+ * // State: "CREATING" || "CREATED" || "QUEUED" || "RUNNING" || "CANCELING" || "CANCELED" || "COMPLETED" || "FAILED",
43
+ * // StateChangeReason: "STRING_VALUE",
44
+ * // },
45
+ * // Statistics: { // CalculationStatistics
46
+ * // DpuExecutionInMillis: Number("long"),
47
+ * // Progress: "STRING_VALUE",
48
+ * // },
49
+ * // Result: { // CalculationResult
50
+ * // StdOutS3Uri: "STRING_VALUE",
51
+ * // StdErrorS3Uri: "STRING_VALUE",
52
+ * // ResultS3Uri: "STRING_VALUE",
53
+ * // ResultType: "STRING_VALUE",
54
+ * // },
55
+ * // };
56
+ *
34
57
  * ```
35
58
  *
36
59
  * @param GetCalculationExecutionCommandInput - {@link GetCalculationExecutionCommandInput}
@@ -50,6 +73,8 @@ export interface GetCalculationExecutionCommandOutput extends GetCalculationExec
50
73
  * @throws {@link ResourceNotFoundException} (client fault)
51
74
  * <p>A resource, such as a workgroup, was not found.</p>
52
75
  *
76
+ * @throws {@link AthenaServiceException}
77
+ * <p>Base exception class for all service exceptions from Athena service.</p>
53
78
  *
54
79
  */
55
80
  export declare class GetCalculationExecutionCommand extends $Command<GetCalculationExecutionCommandInput, GetCalculationExecutionCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,19 @@ export interface GetCalculationExecutionStatusCommandOutput extends GetCalculati
31
31
  * };
32
32
  * const command = new GetCalculationExecutionStatusCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetCalculationExecutionStatusResponse
35
+ * // Status: { // CalculationStatus
36
+ * // SubmissionDateTime: new Date("TIMESTAMP"),
37
+ * // CompletionDateTime: new Date("TIMESTAMP"),
38
+ * // State: "CREATING" || "CREATED" || "QUEUED" || "RUNNING" || "CANCELING" || "CANCELED" || "COMPLETED" || "FAILED",
39
+ * // StateChangeReason: "STRING_VALUE",
40
+ * // },
41
+ * // Statistics: { // CalculationStatistics
42
+ * // DpuExecutionInMillis: Number("long"),
43
+ * // Progress: "STRING_VALUE",
44
+ * // },
45
+ * // };
46
+ *
34
47
  * ```
35
48
  *
36
49
  * @param GetCalculationExecutionStatusCommandInput - {@link GetCalculationExecutionStatusCommandInput}
@@ -50,6 +63,8 @@ export interface GetCalculationExecutionStatusCommandOutput extends GetCalculati
50
63
  * @throws {@link ResourceNotFoundException} (client fault)
51
64
  * <p>A resource, such as a workgroup, was not found.</p>
52
65
  *
66
+ * @throws {@link AthenaServiceException}
67
+ * <p>Base exception class for all service exceptions from Athena service.</p>
53
68
  *
54
69
  */
55
70
  export declare class GetCalculationExecutionStatusCommand extends $Command<GetCalculationExecutionStatusCommandInput, GetCalculationExecutionStatusCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,19 @@ export interface GetCapacityAssignmentConfigurationCommandOutput extends GetCapa
31
31
  * };
32
32
  * const command = new GetCapacityAssignmentConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetCapacityAssignmentConfigurationOutput
35
+ * // CapacityAssignmentConfiguration: { // CapacityAssignmentConfiguration
36
+ * // CapacityReservationName: "STRING_VALUE",
37
+ * // CapacityAssignments: [ // CapacityAssignmentsList
38
+ * // { // CapacityAssignment
39
+ * // WorkGroupNames: [ // WorkGroupNamesList
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // },
43
+ * // ],
44
+ * // },
45
+ * // };
46
+ *
34
47
  * ```
35
48
  *
36
49
  * @param GetCapacityAssignmentConfigurationCommandInput - {@link GetCapacityAssignmentConfigurationCommandInput}
@@ -47,6 +60,8 @@ export interface GetCapacityAssignmentConfigurationCommandOutput extends GetCapa
47
60
  * <p>Indicates that something is wrong with the input to the request. For example, a
48
61
  * required parameter may be missing or out of range.</p>
49
62
  *
63
+ * @throws {@link AthenaServiceException}
64
+ * <p>Base exception class for all service exceptions from Athena service.</p>
50
65
  *
51
66
  */
52
67
  export declare class GetCapacityAssignmentConfigurationCommand extends $Command<GetCapacityAssignmentConfigurationCommandInput, GetCapacityAssignmentConfigurationCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,23 @@ export interface GetCapacityReservationCommandOutput extends GetCapacityReservat
31
31
  * };
32
32
  * const command = new GetCapacityReservationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetCapacityReservationOutput
35
+ * // CapacityReservation: { // CapacityReservation
36
+ * // Name: "STRING_VALUE", // required
37
+ * // Status: "PENDING" || "ACTIVE" || "CANCELLING" || "CANCELLED" || "FAILED" || "UPDATE_PENDING", // required
38
+ * // TargetDpus: Number("int"), // required
39
+ * // AllocatedDpus: Number("int"), // required
40
+ * // LastAllocation: { // CapacityAllocation
41
+ * // Status: "PENDING" || "SUCCEEDED" || "FAILED", // required
42
+ * // StatusMessage: "STRING_VALUE",
43
+ * // RequestTime: new Date("TIMESTAMP"), // required
44
+ * // RequestCompletionTime: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // LastSuccessfulAllocationTime: new Date("TIMESTAMP"),
47
+ * // CreationTime: new Date("TIMESTAMP"), // required
48
+ * // },
49
+ * // };
50
+ *
34
51
  * ```
35
52
  *
36
53
  * @param GetCapacityReservationCommandInput - {@link GetCapacityReservationCommandInput}
@@ -47,6 +64,8 @@ export interface GetCapacityReservationCommandOutput extends GetCapacityReservat
47
64
  * <p>Indicates that something is wrong with the input to the request. For example, a
48
65
  * required parameter may be missing or out of range.</p>
49
66
  *
67
+ * @throws {@link AthenaServiceException}
68
+ * <p>Base exception class for all service exceptions from Athena service.</p>
50
69
  *
51
70
  */
52
71
  export declare class GetCapacityReservationCommand extends $Command<GetCapacityReservationCommandInput, GetCapacityReservationCommandOutput, AthenaClientResolvedConfig> {
@@ -31,6 +31,17 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met
31
31
  * };
32
32
  * const command = new GetDataCatalogCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDataCatalogOutput
35
+ * // DataCatalog: { // DataCatalog
36
+ * // Name: "STRING_VALUE", // required
37
+ * // Description: "STRING_VALUE",
38
+ * // Type: "LAMBDA" || "GLUE" || "HIVE", // required
39
+ * // Parameters: { // ParametersMap
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // },
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param GetDataCatalogCommandInput - {@link GetDataCatalogCommandInput}
@@ -47,6 +58,8 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met
47
58
  * <p>Indicates that something is wrong with the input to the request. For example, a
48
59
  * required parameter may be missing or out of range.</p>
49
60
  *
61
+ * @throws {@link AthenaServiceException}
62
+ * <p>Base exception class for all service exceptions from Athena service.</p>
50
63
  *
51
64
  */
52
65
  export declare class GetDataCatalogCommand extends $Command<GetDataCatalogCommandInput, GetDataCatalogCommandOutput, AthenaClientResolvedConfig> {
@@ -32,6 +32,16 @@ export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB
32
32
  * };
33
33
  * const command = new GetDatabaseCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetDatabaseOutput
36
+ * // Database: { // Database
37
+ * // Name: "STRING_VALUE", // required
38
+ * // Description: "STRING_VALUE",
39
+ * // Parameters: { // ParametersMap
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // },
43
+ * // };
44
+ *
35
45
  * ```
36
46
  *
37
47
  * @param GetDatabaseCommandInput - {@link GetDatabaseCommandInput}
@@ -56,6 +66,8 @@ export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB
56
66
  * Lambda
57
67
  * <code>4XX</code> exception is returned in a <code>MetadataException</code>.</p>
58
68
  *
69
+ * @throws {@link AthenaServiceException}
70
+ * <p>Base exception class for all service exceptions from Athena service.</p>
59
71
  *
60
72
  */
61
73
  export declare class GetDatabaseCommand extends $Command<GetDatabaseCommandInput, GetDatabaseCommandOutput, AthenaClientResolvedConfig> {