@aws-sdk/client-athena 3.325.0 → 3.327.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 +7 -7
@@ -36,6 +36,21 @@ export interface ListExecutorsCommandOutput extends ListExecutorsResponse, __Met
36
36
  * };
37
37
  * const command = new ListExecutorsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListExecutorsResponse
40
+ * // SessionId: "STRING_VALUE", // required
41
+ * // NextToken: "STRING_VALUE",
42
+ * // ExecutorsSummary: [ // ExecutorsSummaryList
43
+ * // { // ExecutorsSummary
44
+ * // ExecutorId: "STRING_VALUE", // required
45
+ * // ExecutorType: "COORDINATOR" || "GATEWAY" || "WORKER",
46
+ * // StartDateTime: Number("long"),
47
+ * // TerminationDateTime: Number("long"),
48
+ * // ExecutorState: "CREATING" || "CREATED" || "REGISTERED" || "TERMINATING" || "TERMINATED" || "FAILED",
49
+ * // ExecutorSize: Number("long"),
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
39
54
  * ```
40
55
  *
41
56
  * @param ListExecutorsCommandInput - {@link ListExecutorsCommandInput}
@@ -55,6 +70,8 @@ export interface ListExecutorsCommandOutput extends ListExecutorsResponse, __Met
55
70
  * @throws {@link ResourceNotFoundException} (client fault)
56
71
  * <p>A resource, such as a workgroup, was not found.</p>
57
72
  *
73
+ * @throws {@link AthenaServiceException}
74
+ * <p>Base exception class for all service exceptions from Athena service.</p>
58
75
  *
59
76
  */
60
77
  export declare class ListExecutorsCommand extends $Command<ListExecutorsCommandInput, ListExecutorsCommandOutput, AthenaClientResolvedConfig> {
@@ -38,6 +38,13 @@ export interface ListNamedQueriesCommandOutput extends ListNamedQueriesOutput, _
38
38
  * };
39
39
  * const command = new ListNamedQueriesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListNamedQueriesOutput
42
+ * // NamedQueryIds: [ // NamedQueryIdList
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
41
48
  * ```
42
49
  *
43
50
  * @param ListNamedQueriesCommandInput - {@link ListNamedQueriesCommandInput}
@@ -54,6 +61,8 @@ export interface ListNamedQueriesCommandOutput extends ListNamedQueriesOutput, _
54
61
  * <p>Indicates that something is wrong with the input to the request. For example, a
55
62
  * required parameter may be missing or out of range.</p>
56
63
  *
64
+ * @throws {@link AthenaServiceException}
65
+ * <p>Base exception class for all service exceptions from Athena service.</p>
57
66
  *
58
67
  */
59
68
  export declare class ListNamedQueriesCommand extends $Command<ListNamedQueriesCommandInput, ListNamedQueriesCommandOutput, AthenaClientResolvedConfig> {
@@ -36,6 +36,20 @@ export interface ListNotebookMetadataCommandOutput extends ListNotebookMetadataO
36
36
  * };
37
37
  * const command = new ListNotebookMetadataCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListNotebookMetadataOutput
40
+ * // NextToken: "STRING_VALUE",
41
+ * // NotebookMetadataList: [ // NotebookMetadataArray
42
+ * // { // NotebookMetadata
43
+ * // NotebookId: "STRING_VALUE",
44
+ * // Name: "STRING_VALUE",
45
+ * // WorkGroup: "STRING_VALUE",
46
+ * // CreationTime: new Date("TIMESTAMP"),
47
+ * // Type: "IPYNB",
48
+ * // LastModifiedTime: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
39
53
  * ```
40
54
  *
41
55
  * @param ListNotebookMetadataCommandInput - {@link ListNotebookMetadataCommandInput}
@@ -55,6 +69,8 @@ export interface ListNotebookMetadataCommandOutput extends ListNotebookMetadataO
55
69
  * @throws {@link TooManyRequestsException} (client fault)
56
70
  * <p>Indicates that the request was throttled.</p>
57
71
  *
72
+ * @throws {@link AthenaServiceException}
73
+ * <p>Base exception class for all service exceptions from Athena service.</p>
58
74
  *
59
75
  */
60
76
  export declare class ListNotebookMetadataCommand extends $Command<ListNotebookMetadataCommandInput, ListNotebookMetadataCommandOutput, AthenaClientResolvedConfig> {
@@ -36,6 +36,16 @@ export interface ListNotebookSessionsCommandOutput extends ListNotebookSessionsR
36
36
  * };
37
37
  * const command = new ListNotebookSessionsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListNotebookSessionsResponse
40
+ * // NotebookSessionsList: [ // NotebookSessionsList // required
41
+ * // { // NotebookSessionSummary
42
+ * // SessionId: "STRING_VALUE",
43
+ * // CreationTime: new Date("TIMESTAMP"),
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
39
49
  * ```
40
50
  *
41
51
  * @param ListNotebookSessionsCommandInput - {@link ListNotebookSessionsCommandInput}
@@ -55,6 +65,8 @@ export interface ListNotebookSessionsCommandOutput extends ListNotebookSessionsR
55
65
  * @throws {@link ResourceNotFoundException} (client fault)
56
66
  * <p>A resource, such as a workgroup, was not found.</p>
57
67
  *
68
+ * @throws {@link AthenaServiceException}
69
+ * <p>Base exception class for all service exceptions from Athena service.</p>
58
70
  *
59
71
  */
60
72
  export declare class ListNotebookSessionsCommand extends $Command<ListNotebookSessionsCommandInput, ListNotebookSessionsCommandOutput, AthenaClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface ListPreparedStatementsCommandOutput extends ListPreparedStateme
33
33
  * };
34
34
  * const command = new ListPreparedStatementsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListPreparedStatementsOutput
37
+ * // PreparedStatements: [ // PreparedStatementsList
38
+ * // { // PreparedStatementSummary
39
+ * // StatementName: "STRING_VALUE",
40
+ * // LastModifiedTime: new Date("TIMESTAMP"),
41
+ * // },
42
+ * // ],
43
+ * // NextToken: "STRING_VALUE",
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param ListPreparedStatementsCommandInput - {@link ListPreparedStatementsCommandInput}
@@ -49,6 +59,8 @@ export interface ListPreparedStatementsCommandOutput extends ListPreparedStateme
49
59
  * <p>Indicates that something is wrong with the input to the request. For example, a
50
60
  * required parameter may be missing or out of range.</p>
51
61
  *
62
+ * @throws {@link AthenaServiceException}
63
+ * <p>Base exception class for all service exceptions from Athena service.</p>
52
64
  *
53
65
  */
54
66
  export declare class ListPreparedStatementsCommand extends $Command<ListPreparedStatementsCommandInput, ListPreparedStatementsCommandOutput, AthenaClientResolvedConfig> {
@@ -39,6 +39,13 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
39
39
  * };
40
40
  * const command = new ListQueryExecutionsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListQueryExecutionsOutput
43
+ * // QueryExecutionIds: [ // QueryExecutionIdList
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
42
49
  * ```
43
50
  *
44
51
  * @param ListQueryExecutionsCommandInput - {@link ListQueryExecutionsCommandInput}
@@ -55,6 +62,8 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
55
62
  * <p>Indicates that something is wrong with the input to the request. For example, a
56
63
  * required parameter may be missing or out of range.</p>
57
64
  *
65
+ * @throws {@link AthenaServiceException}
66
+ * <p>Base exception class for all service exceptions from Athena service.</p>
58
67
  *
59
68
  */
60
69
  export declare class ListQueryExecutionsCommand extends $Command<ListQueryExecutionsCommandInput, ListQueryExecutionsCommandOutput, AthenaClientResolvedConfig> {
@@ -37,6 +37,29 @@ export interface ListSessionsCommandOutput extends ListSessionsResponse, __Metad
37
37
  * };
38
38
  * const command = new ListSessionsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListSessionsResponse
41
+ * // NextToken: "STRING_VALUE",
42
+ * // Sessions: [ // SessionsList
43
+ * // { // SessionSummary
44
+ * // SessionId: "STRING_VALUE",
45
+ * // Description: "STRING_VALUE",
46
+ * // EngineVersion: { // EngineVersion
47
+ * // SelectedEngineVersion: "STRING_VALUE",
48
+ * // EffectiveEngineVersion: "STRING_VALUE",
49
+ * // },
50
+ * // NotebookVersion: "STRING_VALUE",
51
+ * // Status: { // SessionStatus
52
+ * // StartDateTime: new Date("TIMESTAMP"),
53
+ * // LastModifiedDateTime: new Date("TIMESTAMP"),
54
+ * // EndDateTime: new Date("TIMESTAMP"),
55
+ * // IdleSinceDateTime: new Date("TIMESTAMP"),
56
+ * // State: "CREATING" || "CREATED" || "IDLE" || "BUSY" || "TERMINATING" || "TERMINATED" || "DEGRADED" || "FAILED",
57
+ * // StateChangeReason: "STRING_VALUE",
58
+ * // },
59
+ * // },
60
+ * // ],
61
+ * // };
62
+ *
40
63
  * ```
41
64
  *
42
65
  * @param ListSessionsCommandInput - {@link ListSessionsCommandInput}
@@ -56,6 +79,8 @@ export interface ListSessionsCommandOutput extends ListSessionsResponse, __Metad
56
79
  * @throws {@link ResourceNotFoundException} (client fault)
57
80
  * <p>A resource, such as a workgroup, was not found.</p>
58
81
  *
82
+ * @throws {@link AthenaServiceException}
83
+ * <p>Base exception class for all service exceptions from Athena service.</p>
59
84
  *
60
85
  */
61
86
  export declare class ListSessionsCommand extends $Command<ListSessionsCommandInput, ListSessionsCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,35 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput,
35
35
  * };
36
36
  * const command = new ListTableMetadataCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListTableMetadataOutput
39
+ * // TableMetadataList: [ // TableMetadataList
40
+ * // { // TableMetadata
41
+ * // Name: "STRING_VALUE", // required
42
+ * // CreateTime: new Date("TIMESTAMP"),
43
+ * // LastAccessTime: new Date("TIMESTAMP"),
44
+ * // TableType: "STRING_VALUE",
45
+ * // Columns: [ // ColumnList
46
+ * // { // Column
47
+ * // Name: "STRING_VALUE", // required
48
+ * // Type: "STRING_VALUE",
49
+ * // Comment: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // PartitionKeys: [
53
+ * // {
54
+ * // Name: "STRING_VALUE", // required
55
+ * // Type: "STRING_VALUE",
56
+ * // Comment: "STRING_VALUE",
57
+ * // },
58
+ * // ],
59
+ * // Parameters: { // ParametersMap
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // },
63
+ * // ],
64
+ * // NextToken: "STRING_VALUE",
65
+ * // };
66
+ *
38
67
  * ```
39
68
  *
40
69
  * @param ListTableMetadataCommandInput - {@link ListTableMetadataCommandInput}
@@ -59,6 +88,8 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput,
59
88
  * Lambda
60
89
  * <code>4XX</code> exception is returned in a <code>MetadataException</code>.</p>
61
90
  *
91
+ * @throws {@link AthenaServiceException}
92
+ * <p>Base exception class for all service exceptions from Athena service.</p>
62
93
  *
63
94
  */
64
95
  export declare class ListTableMetadataCommand extends $Command<ListTableMetadataCommandInput, ListTableMetadataCommandOutput, AthenaClientResolvedConfig> {
@@ -33,6 +33,16 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
33
33
  * };
34
34
  * const command = new ListTagsForResourceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListTagsForResourceOutput
37
+ * // Tags: [ // TagList
38
+ * // { // Tag
39
+ * // Key: "STRING_VALUE",
40
+ * // Value: "STRING_VALUE",
41
+ * // },
42
+ * // ],
43
+ * // NextToken: "STRING_VALUE",
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -52,6 +62,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
52
62
  * @throws {@link ResourceNotFoundException} (client fault)
53
63
  * <p>A resource, such as a workgroup, was not found.</p>
54
64
  *
65
+ * @throws {@link AthenaServiceException}
66
+ * <p>Base exception class for all service exceptions from Athena service.</p>
55
67
  *
56
68
  */
57
69
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, AthenaClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met
32
32
  * };
33
33
  * const command = new ListWorkGroupsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListWorkGroupsOutput
36
+ * // WorkGroups: [ // WorkGroupsList
37
+ * // { // WorkGroupSummary
38
+ * // Name: "STRING_VALUE",
39
+ * // State: "ENABLED" || "DISABLED",
40
+ * // Description: "STRING_VALUE",
41
+ * // CreationTime: new Date("TIMESTAMP"),
42
+ * // EngineVersion: { // EngineVersion
43
+ * // SelectedEngineVersion: "STRING_VALUE",
44
+ * // EffectiveEngineVersion: "STRING_VALUE",
45
+ * // },
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param ListWorkGroupsCommandInput - {@link ListWorkGroupsCommandInput}
@@ -48,6 +64,8 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met
48
64
  * <p>Indicates that something is wrong with the input to the request. For example, a
49
65
  * required parameter may be missing or out of range.</p>
50
66
  *
67
+ * @throws {@link AthenaServiceException}
68
+ * <p>Base exception class for all service exceptions from Athena service.</p>
51
69
  *
52
70
  */
53
71
  export declare class ListWorkGroupsCommand extends $Command<ListWorkGroupsCommandInput, ListWorkGroupsCommandOutput, AthenaClientResolvedConfig> {
@@ -38,6 +38,8 @@ export interface PutCapacityAssignmentConfigurationCommandOutput extends PutCapa
38
38
  * };
39
39
  * const command = new PutCapacityAssignmentConfigurationCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // {};
42
+ *
41
43
  * ```
42
44
  *
43
45
  * @param PutCapacityAssignmentConfigurationCommandInput - {@link PutCapacityAssignmentConfigurationCommandInput}
@@ -54,6 +56,8 @@ export interface PutCapacityAssignmentConfigurationCommandOutput extends PutCapa
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 PutCapacityAssignmentConfigurationCommand extends $Command<PutCapacityAssignmentConfigurationCommandInput, PutCapacityAssignmentConfigurationCommandOutput, AthenaClientResolvedConfig> {
@@ -38,6 +38,11 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
38
38
  * };
39
39
  * const command = new StartCalculationExecutionCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // StartCalculationExecutionResponse
42
+ * // CalculationExecutionId: "STRING_VALUE",
43
+ * // State: "CREATING" || "CREATED" || "QUEUED" || "RUNNING" || "CANCELING" || "CANCELED" || "COMPLETED" || "FAILED",
44
+ * // };
45
+ *
41
46
  * ```
42
47
  *
43
48
  * @param StartCalculationExecutionCommandInput - {@link StartCalculationExecutionCommandInput}
@@ -57,6 +62,8 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
57
62
  * @throws {@link ResourceNotFoundException} (client fault)
58
63
  * <p>A resource, such as a workgroup, was not found.</p>
59
64
  *
65
+ * @throws {@link AthenaServiceException}
66
+ * <p>Base exception class for all service exceptions from Athena service.</p>
60
67
  *
61
68
  */
62
69
  export declare class StartCalculationExecutionCommand extends $Command<StartCalculationExecutionCommandInput, StartCalculationExecutionCommandOutput, AthenaClientResolvedConfig> {
@@ -62,6 +62,10 @@ export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOut
62
62
  * };
63
63
  * const command = new StartQueryExecutionCommand(input);
64
64
  * const response = await client.send(command);
65
+ * // { // StartQueryExecutionOutput
66
+ * // QueryExecutionId: "STRING_VALUE",
67
+ * // };
68
+ *
65
69
  * ```
66
70
  *
67
71
  * @param StartQueryExecutionCommandInput - {@link StartQueryExecutionCommandInput}
@@ -81,6 +85,8 @@ export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOut
81
85
  * @throws {@link TooManyRequestsException} (client fault)
82
86
  * <p>Indicates that the request was throttled.</p>
83
87
  *
88
+ * @throws {@link AthenaServiceException}
89
+ * <p>Base exception class for all service exceptions from Athena service.</p>
84
90
  *
85
91
  */
86
92
  export declare class StartQueryExecutionCommand extends $Command<StartQueryExecutionCommandInput, StartQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
@@ -44,6 +44,11 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad
44
44
  * };
45
45
  * const command = new StartSessionCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // StartSessionResponse
48
+ * // SessionId: "STRING_VALUE",
49
+ * // State: "CREATING" || "CREATED" || "IDLE" || "BUSY" || "TERMINATING" || "TERMINATED" || "DEGRADED" || "FAILED",
50
+ * // };
51
+ *
47
52
  * ```
48
53
  *
49
54
  * @param StartSessionCommandInput - {@link StartSessionCommandInput}
@@ -69,6 +74,8 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad
69
74
  * @throws {@link TooManyRequestsException} (client fault)
70
75
  * <p>Indicates that the request was throttled.</p>
71
76
  *
77
+ * @throws {@link AthenaServiceException}
78
+ * <p>Base exception class for all service exceptions from Athena service.</p>
72
79
  *
73
80
  */
74
81
  export declare class StartSessionCommand extends $Command<StartSessionCommandInput, StartSessionCommandOutput, AthenaClientResolvedConfig> {
@@ -40,6 +40,10 @@ export interface StopCalculationExecutionCommandOutput extends StopCalculationEx
40
40
  * };
41
41
  * const command = new StopCalculationExecutionCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // StopCalculationExecutionResponse
44
+ * // State: "CREATING" || "CREATED" || "QUEUED" || "RUNNING" || "CANCELING" || "CANCELED" || "COMPLETED" || "FAILED",
45
+ * // };
46
+ *
43
47
  * ```
44
48
  *
45
49
  * @param StopCalculationExecutionCommandInput - {@link StopCalculationExecutionCommandInput}
@@ -59,6 +63,8 @@ export interface StopCalculationExecutionCommandOutput extends StopCalculationEx
59
63
  * @throws {@link ResourceNotFoundException} (client fault)
60
64
  * <p>A resource, such as a workgroup, was not found.</p>
61
65
  *
66
+ * @throws {@link AthenaServiceException}
67
+ * <p>Base exception class for all service exceptions from Athena service.</p>
62
68
  *
63
69
  */
64
70
  export declare class StopCalculationExecutionCommand extends $Command<StopCalculationExecutionCommandInput, StopCalculationExecutionCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
35
35
  * };
36
36
  * const command = new StopQueryExecutionCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param StopQueryExecutionCommandInput - {@link StopQueryExecutionCommandInput}
@@ -51,6 +53,8 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
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 StopQueryExecutionCommand extends $Command<StopQueryExecutionCommandInput, StopQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
45
45
  * };
46
46
  * const command = new TagResourceCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -64,6 +66,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
64
66
  * @throws {@link ResourceNotFoundException} (client fault)
65
67
  * <p>A resource, such as a workgroup, was not found.</p>
66
68
  *
69
+ * @throws {@link AthenaServiceException}
70
+ * <p>Base exception class for all service exceptions from Athena service.</p>
67
71
  *
68
72
  */
69
73
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse,
35
35
  * };
36
36
  * const command = new TerminateSessionCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // TerminateSessionResponse
39
+ * // State: "CREATING" || "CREATED" || "IDLE" || "BUSY" || "TERMINATING" || "TERMINATED" || "DEGRADED" || "FAILED",
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param TerminateSessionCommandInput - {@link TerminateSessionCommandInput}
@@ -54,6 +58,8 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse,
54
58
  * @throws {@link ResourceNotFoundException} (client fault)
55
59
  * <p>A resource, such as a workgroup, was not found.</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 TerminateSessionCommand extends $Command<TerminateSessionCommandInput, TerminateSessionCommandOutput, AthenaClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -53,6 +55,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
53
55
  * @throws {@link ResourceNotFoundException} (client fault)
54
56
  * <p>A resource, such as a workgroup, was not found.</p>
55
57
  *
58
+ * @throws {@link AthenaServiceException}
59
+ * <p>Base exception class for all service exceptions from Athena service.</p>
56
60
  *
57
61
  */
58
62
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, AthenaClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface UpdateCapacityReservationCommandOutput extends UpdateCapacityRe
32
32
  * };
33
33
  * const command = new UpdateCapacityReservationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param UpdateCapacityReservationCommandInput - {@link UpdateCapacityReservationCommandInput}
@@ -48,6 +50,8 @@ export interface UpdateCapacityReservationCommandOutput extends UpdateCapacityRe
48
50
  * <p>Indicates that something is wrong with the input to the request. For example, a
49
51
  * required parameter may be missing or out of range.</p>
50
52
  *
53
+ * @throws {@link AthenaServiceException}
54
+ * <p>Base exception class for all service exceptions from Athena service.</p>
51
55
  *
52
56
  */
53
57
  export declare class UpdateCapacityReservationCommand extends $Command<UpdateCapacityReservationCommandInput, UpdateCapacityReservationCommandOutput, AthenaClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface UpdateDataCatalogCommandOutput extends UpdateDataCatalogOutput,
36
36
  * };
37
37
  * const command = new UpdateDataCatalogCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param UpdateDataCatalogCommandInput - {@link UpdateDataCatalogCommandInput}
@@ -52,6 +54,8 @@ export interface UpdateDataCatalogCommandOutput extends UpdateDataCatalogOutput,
52
54
  * <p>Indicates that something is wrong with the input to the request. For example, a
53
55
  * required parameter may be missing or out of range.</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 UpdateDataCatalogCommand extends $Command<UpdateDataCatalogCommandInput, UpdateDataCatalogCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UpdateNamedQueryCommandOutput extends UpdateNamedQueryOutput, _
35
35
  * };
36
36
  * const command = new UpdateNamedQueryCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UpdateNamedQueryCommandInput - {@link UpdateNamedQueryCommandInput}
@@ -51,6 +53,8 @@ export interface UpdateNamedQueryCommandOutput extends UpdateNamedQueryOutput, _
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 UpdateNamedQueryCommand extends $Command<UpdateNamedQueryCommandInput, UpdateNamedQueryCommandOutput, AthenaClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface UpdateNotebookCommandOutput extends UpdateNotebookOutput, __Met
35
35
  * };
36
36
  * const command = new UpdateNotebookCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param UpdateNotebookCommandInput - {@link UpdateNotebookCommandInput}
@@ -54,6 +56,8 @@ export interface UpdateNotebookCommandOutput extends UpdateNotebookOutput, __Met
54
56
  * @throws {@link TooManyRequestsException} (client fault)
55
57
  * <p>Indicates that the request was throttled.</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 UpdateNotebookCommand extends $Command<UpdateNotebookCommandInput, UpdateNotebookCommandOutput, AthenaClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface UpdateNotebookMetadataCommandOutput extends UpdateNotebookMetad
33
33
  * };
34
34
  * const command = new UpdateNotebookMetadataCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param UpdateNotebookMetadataCommandInput - {@link UpdateNotebookMetadataCommandInput}
@@ -52,6 +54,8 @@ export interface UpdateNotebookMetadataCommandOutput extends UpdateNotebookMetad
52
54
  * @throws {@link TooManyRequestsException} (client fault)
53
55
  * <p>Indicates that the request was throttled.</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 UpdateNotebookMetadataCommand extends $Command<UpdateNotebookMetadataCommandInput, UpdateNotebookMetadataCommandOutput, AthenaClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UpdatePreparedStatementCommandOutput extends UpdatePreparedStat
34
34
  * };
35
35
  * const command = new UpdatePreparedStatementCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UpdatePreparedStatementCommandInput - {@link UpdatePreparedStatementCommandInput}
@@ -53,6 +55,8 @@ export interface UpdatePreparedStatementCommandOutput extends UpdatePreparedStat
53
55
  * @throws {@link ResourceNotFoundException} (client fault)
54
56
  * <p>A resource, such as a workgroup, was not found.</p>
55
57
  *
58
+ * @throws {@link AthenaServiceException}
59
+ * <p>Base exception class for all service exceptions from Athena service.</p>
56
60
  *
57
61
  */
58
62
  export declare class UpdatePreparedStatementCommand extends $Command<UpdatePreparedStatementCommandInput, UpdatePreparedStatementCommandOutput, AthenaClientResolvedConfig> {
@@ -67,6 +67,8 @@ export interface UpdateWorkGroupCommandOutput extends UpdateWorkGroupOutput, __M
67
67
  * };
68
68
  * const command = new UpdateWorkGroupCommand(input);
69
69
  * const response = await client.send(command);
70
+ * // {};
71
+ *
70
72
  * ```
71
73
  *
72
74
  * @param UpdateWorkGroupCommandInput - {@link UpdateWorkGroupCommandInput}
@@ -83,6 +85,8 @@ export interface UpdateWorkGroupCommandOutput extends UpdateWorkGroupOutput, __M
83
85
  * <p>Indicates that something is wrong with the input to the request. For example, a
84
86
  * required parameter may be missing or out of range.</p>
85
87
  *
88
+ * @throws {@link AthenaServiceException}
89
+ * <p>Base exception class for all service exceptions from Athena service.</p>
86
90
  *
87
91
  */
88
92
  export declare class UpdateWorkGroupCommand extends $Command<UpdateWorkGroupCommandInput, UpdateWorkGroupCommandOutput, AthenaClientResolvedConfig> {