@aws-sdk/client-athena 3.295.0 → 3.297.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 (80) hide show
  1. package/dist-types/Athena.d.ts +61 -0
  2. package/dist-types/AthenaClient.d.ts +24 -4
  3. package/dist-types/commands/BatchGetNamedQueryCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchGetPreparedStatementCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchGetQueryExecutionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDataCatalogCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateNamedQueryCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateNotebookCommand.d.ts +16 -0
  9. package/dist-types/commands/CreatePreparedStatementCommand.d.ts +16 -0
  10. package/dist-types/commands/CreatePresignedNotebookUrlCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateWorkGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteDataCatalogCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteNamedQueryCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteNotebookCommand.d.ts +16 -0
  15. package/dist-types/commands/DeletePreparedStatementCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteWorkGroupCommand.d.ts +16 -0
  17. package/dist-types/commands/ExportNotebookCommand.d.ts +16 -0
  18. package/dist-types/commands/GetCalculationExecutionCodeCommand.d.ts +16 -0
  19. package/dist-types/commands/GetCalculationExecutionCommand.d.ts +16 -0
  20. package/dist-types/commands/GetCalculationExecutionStatusCommand.d.ts +16 -0
  21. package/dist-types/commands/GetDataCatalogCommand.d.ts +16 -0
  22. package/dist-types/commands/GetDatabaseCommand.d.ts +16 -0
  23. package/dist-types/commands/GetNamedQueryCommand.d.ts +16 -0
  24. package/dist-types/commands/GetNotebookMetadataCommand.d.ts +16 -0
  25. package/dist-types/commands/GetPreparedStatementCommand.d.ts +16 -0
  26. package/dist-types/commands/GetQueryExecutionCommand.d.ts +16 -0
  27. package/dist-types/commands/GetQueryResultsCommand.d.ts +16 -0
  28. package/dist-types/commands/GetQueryRuntimeStatisticsCommand.d.ts +16 -0
  29. package/dist-types/commands/GetSessionCommand.d.ts +16 -0
  30. package/dist-types/commands/GetSessionStatusCommand.d.ts +16 -0
  31. package/dist-types/commands/GetTableMetadataCommand.d.ts +16 -0
  32. package/dist-types/commands/GetWorkGroupCommand.d.ts +16 -0
  33. package/dist-types/commands/ImportNotebookCommand.d.ts +16 -0
  34. package/dist-types/commands/ListApplicationDPUSizesCommand.d.ts +16 -0
  35. package/dist-types/commands/ListCalculationExecutionsCommand.d.ts +16 -0
  36. package/dist-types/commands/ListDataCatalogsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListDatabasesCommand.d.ts +16 -0
  38. package/dist-types/commands/ListEngineVersionsCommand.d.ts +16 -0
  39. package/dist-types/commands/ListExecutorsCommand.d.ts +16 -0
  40. package/dist-types/commands/ListNamedQueriesCommand.d.ts +16 -0
  41. package/dist-types/commands/ListNotebookMetadataCommand.d.ts +16 -0
  42. package/dist-types/commands/ListNotebookSessionsCommand.d.ts +16 -0
  43. package/dist-types/commands/ListPreparedStatementsCommand.d.ts +16 -0
  44. package/dist-types/commands/ListQueryExecutionsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListSessionsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListTableMetadataCommand.d.ts +16 -0
  47. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/ListWorkGroupsCommand.d.ts +16 -0
  49. package/dist-types/commands/StartCalculationExecutionCommand.d.ts +16 -0
  50. package/dist-types/commands/StartQueryExecutionCommand.d.ts +16 -0
  51. package/dist-types/commands/StartSessionCommand.d.ts +16 -0
  52. package/dist-types/commands/StopCalculationExecutionCommand.d.ts +16 -0
  53. package/dist-types/commands/StopQueryExecutionCommand.d.ts +16 -0
  54. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  55. package/dist-types/commands/TerminateSessionCommand.d.ts +16 -0
  56. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  57. package/dist-types/commands/UpdateDataCatalogCommand.d.ts +16 -0
  58. package/dist-types/commands/UpdateNamedQueryCommand.d.ts +16 -0
  59. package/dist-types/commands/UpdateNotebookCommand.d.ts +16 -0
  60. package/dist-types/commands/UpdateNotebookMetadataCommand.d.ts +16 -0
  61. package/dist-types/commands/UpdatePreparedStatementCommand.d.ts +16 -0
  62. package/dist-types/commands/UpdateWorkGroupCommand.d.ts +16 -0
  63. package/dist-types/models/AthenaServiceException.d.ts +2 -0
  64. package/dist-types/models/models_0.d.ts +456 -0
  65. package/dist-types/pagination/GetQueryResultsPaginator.d.ts +3 -0
  66. package/dist-types/pagination/Interfaces.d.ts +3 -0
  67. package/dist-types/pagination/ListApplicationDPUSizesPaginator.d.ts +3 -0
  68. package/dist-types/pagination/ListCalculationExecutionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/ListDataCatalogsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListDatabasesPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListEngineVersionsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListExecutorsPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListNamedQueriesPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListPreparedStatementsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListQueryExecutionsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListSessionsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListTableMetadataPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListWorkGroupsPaginator.d.ts +3 -0
  80. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { ListQueryExecutionsInput, ListQueryExecutionsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListQueryExecutionsCommand}.
8
10
  */
9
11
  export interface ListQueryExecutionsCommandInput extends ListQueryExecutionsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListQueryExecutionsCommand}.
13
17
  */
14
18
  export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a list of available query execution IDs for the queries in the specified
18
23
  * workgroup. If a workgroup is not specified, returns a list of query execution IDs for
19
24
  * the primary workgroup. Requires you to have access to the workgroup in which the queries
@@ -31,6 +36,8 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ListQueryExecutionsCommandInput - {@link ListQueryExecutionsCommandInput}
40
+ * @returns {@link ListQueryExecutionsCommandOutput}
34
41
  * @see {@link ListQueryExecutionsCommandInput} for command's `input` shape.
35
42
  * @see {@link ListQueryExecutionsCommandOutput} for command's `response` shape.
36
43
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut
48
55
  export declare class ListQueryExecutionsCommand extends $Command<ListQueryExecutionsCommandInput, ListQueryExecutionsCommandOutput, AthenaClientResolvedConfig> {
49
56
  readonly input: ListQueryExecutionsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListQueryExecutionsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListQueryExecutionsCommandInput, ListQueryExecutionsCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { ListSessionsRequest, ListSessionsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSessionsCommand}.
8
10
  */
9
11
  export interface ListSessionsCommandInput extends ListSessionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSessionsCommand}.
13
17
  */
14
18
  export interface ListSessionsCommandOutput extends ListSessionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the sessions in a workgroup that are in an active state like
18
23
  * <code>CREATING</code>, <code>CREATED</code>, <code>IDLE</code>, or
19
24
  * <code>BUSY</code>. Newer sessions are listed first; older sessions are listed
@@ -28,6 +33,8 @@ export interface ListSessionsCommandOutput extends ListSessionsResponse, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListSessionsCommandInput - {@link ListSessionsCommandInput}
37
+ * @returns {@link ListSessionsCommandOutput}
31
38
  * @see {@link ListSessionsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListSessionsCommandOutput} for command's `response` shape.
33
40
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ListSessionsCommandOutput extends ListSessionsResponse, __Metad
48
55
  export declare class ListSessionsCommand extends $Command<ListSessionsCommandInput, ListSessionsCommandOutput, AthenaClientResolvedConfig> {
49
56
  readonly input: ListSessionsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: ListSessionsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSessionsCommandInput, ListSessionsCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { ListTableMetadataInput, ListTableMetadataOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTableMetadataCommand}.
8
10
  */
9
11
  export interface ListTableMetadataCommandInput extends ListTableMetadataInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTableMetadataCommand}.
13
17
  */
14
18
  export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the metadata for the tables in the specified data catalog database.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTableMetadataCommandInput - {@link ListTableMetadataCommandInput}
34
+ * @returns {@link ListTableMetadataCommandOutput}
28
35
  * @see {@link ListTableMetadataCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTableMetadataCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput,
50
57
  export declare class ListTableMetadataCommand extends $Command<ListTableMetadataCommandInput, ListTableMetadataCommandOutput, AthenaClientResolvedConfig> {
51
58
  readonly input: ListTableMetadataCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListTableMetadataCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTableMetadataCommandInput, ListTableMetadataCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags associated with an Athena workgroup or data catalog
18
23
  * resource.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
35
+ * @returns {@link ListTagsForResourceCommandOutput}
29
36
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
46
53
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: ListTagsForResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListTagsForResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { ListWorkGroupsInput, ListWorkGroupsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListWorkGroupsCommand}.
8
10
  */
9
11
  export interface ListWorkGroupsCommandInput extends ListWorkGroupsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListWorkGroupsCommand}.
13
17
  */
14
18
  export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists available workgroups for the account.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListWorkGroupsCommandInput - {@link ListWorkGroupsCommandInput}
34
+ * @returns {@link ListWorkGroupsCommandOutput}
28
35
  * @see {@link ListWorkGroupsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListWorkGroupsCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met
42
49
  export declare class ListWorkGroupsCommand extends $Command<ListWorkGroupsCommandInput, ListWorkGroupsCommandOutput, AthenaClientResolvedConfig> {
43
50
  readonly input: ListWorkGroupsCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListWorkGroupsCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkGroupsCommandInput, ListWorkGroupsCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { StartCalculationExecutionRequest, StartCalculationExecutionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartCalculationExecutionCommand}.
8
10
  */
9
11
  export interface StartCalculationExecutionCommandInput extends StartCalculationExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartCalculationExecutionCommand}.
13
17
  */
14
18
  export interface StartCalculationExecutionCommandOutput extends StartCalculationExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Submits calculations for execution within a session. You can supply the code to run as
18
23
  * an inline code block within the request or as an Amazon S3 URL.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartCalculationExecutionCommandInput - {@link StartCalculationExecutionCommandInput}
35
+ * @returns {@link StartCalculationExecutionCommandOutput}
29
36
  * @see {@link StartCalculationExecutionCommandInput} for command's `input` shape.
30
37
  * @see {@link StartCalculationExecutionCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface StartCalculationExecutionCommandOutput extends StartCalculation
46
53
  export declare class StartCalculationExecutionCommand extends $Command<StartCalculationExecutionCommandInput, StartCalculationExecutionCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: StartCalculationExecutionCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: StartCalculationExecutionCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCalculationExecutionCommandInput, StartCalculationExecutionCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { StartQueryExecutionInput, StartQueryExecutionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartQueryExecutionCommand}.
8
10
  */
9
11
  export interface StartQueryExecutionCommandInput extends StartQueryExecutionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartQueryExecutionCommand}.
13
17
  */
14
18
  export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to
18
23
  * have access to the workgroup in which the query ran. Running queries against an external
19
24
  * catalog requires <a>GetDataCatalog</a> permission to the catalog. For code
@@ -30,6 +35,8 @@ export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOut
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param StartQueryExecutionCommandInput - {@link StartQueryExecutionCommandInput}
39
+ * @returns {@link StartQueryExecutionCommandOutput}
33
40
  * @see {@link StartQueryExecutionCommandInput} for command's `input` shape.
34
41
  * @see {@link StartQueryExecutionCommandOutput} for command's `response` shape.
35
42
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOut
50
57
  export declare class StartQueryExecutionCommand extends $Command<StartQueryExecutionCommandInput, StartQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
51
58
  readonly input: StartQueryExecutionCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: StartQueryExecutionCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartQueryExecutionCommandInput, StartQueryExecutionCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { StartSessionRequest, StartSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartSessionCommand}.
8
10
  */
9
11
  export interface StartSessionCommandInput extends StartSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartSessionCommand}.
13
17
  */
14
18
  export interface StartSessionCommandOutput extends StartSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a session for running calculations within a workgroup. The session is ready
18
23
  * when it reaches an <code>IDLE</code> state.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartSessionCommandInput - {@link StartSessionCommandInput}
35
+ * @returns {@link StartSessionCommandOutput}
29
36
  * @see {@link StartSessionCommandInput} for command's `input` shape.
30
37
  * @see {@link StartSessionCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad
52
59
  export declare class StartSessionCommand extends $Command<StartSessionCommandInput, StartSessionCommandOutput, AthenaClientResolvedConfig> {
53
60
  readonly input: StartSessionCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: StartSessionCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSessionCommandInput, StartSessionCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { StopCalculationExecutionRequest, StopCalculationExecutionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopCalculationExecutionCommand}.
8
10
  */
9
11
  export interface StopCalculationExecutionCommandInput extends StopCalculationExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopCalculationExecutionCommand}.
13
17
  */
14
18
  export interface StopCalculationExecutionCommandOutput extends StopCalculationExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Requests the cancellation of a calculation. A <code>StopCalculationExecution</code>
18
23
  * call on a calculation that is already in a terminal state (for example,
19
24
  * <code>STOPPED</code>, <code>FAILED</code>, or <code>COMPLETED</code>) succeeds but
@@ -34,6 +39,8 @@ export interface StopCalculationExecutionCommandOutput extends StopCalculationEx
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param StopCalculationExecutionCommandInput - {@link StopCalculationExecutionCommandInput}
43
+ * @returns {@link StopCalculationExecutionCommandOutput}
37
44
  * @see {@link StopCalculationExecutionCommandInput} for command's `input` shape.
38
45
  * @see {@link StopCalculationExecutionCommandOutput} for command's `response` shape.
39
46
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -54,11 +61,20 @@ export interface StopCalculationExecutionCommandOutput extends StopCalculationEx
54
61
  export declare class StopCalculationExecutionCommand extends $Command<StopCalculationExecutionCommandInput, StopCalculationExecutionCommandOutput, AthenaClientResolvedConfig> {
55
62
  readonly input: StopCalculationExecutionCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: StopCalculationExecutionCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopCalculationExecutionCommandInput, StopCalculationExecutionCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { StopQueryExecutionInput, StopQueryExecutionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopQueryExecutionCommand}.
8
10
  */
9
11
  export interface StopQueryExecutionCommandInput extends StopQueryExecutionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopQueryExecutionCommand}.
13
17
  */
14
18
  export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stops a query execution. Requires you to have access to the workgroup in which the
18
23
  * query ran.</p>
19
24
  * <p>For code samples using the Amazon Web Services SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and
@@ -29,6 +34,8 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param StopQueryExecutionCommandInput - {@link StopQueryExecutionCommandInput}
38
+ * @returns {@link StopQueryExecutionCommandOutput}
32
39
  * @see {@link StopQueryExecutionCommandInput} for command's `input` shape.
33
40
  * @see {@link StopQueryExecutionCommandOutput} for command's `response` shape.
34
41
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu
46
53
  export declare class StopQueryExecutionCommand extends $Command<StopQueryExecutionCommandInput, StopQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: StopQueryExecutionCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: StopQueryExecutionCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopQueryExecutionCommandInput, StopQueryExecutionCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { TagResourceInput, TagResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds one or more tags to an Athena resource. A tag is a label that you
18
23
  * assign to a resource. In Athena, a resource can be a workgroup or data
19
24
  * catalog. Each tag consists of a key and an optional value, both of which you define. For
@@ -35,6 +40,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
44
+ * @returns {@link TagResourceCommandOutput}
38
45
  * @see {@link TagResourceCommandInput} for command's `input` shape.
39
46
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
40
47
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -55,11 +62,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
55
62
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AthenaClientResolvedConfig> {
56
63
  readonly input: TagResourceCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: TagResourceCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { TerminateSessionRequest, TerminateSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TerminateSessionCommand}.
8
10
  */
9
11
  export interface TerminateSessionCommandInput extends TerminateSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TerminateSessionCommand}.
13
17
  */
14
18
  export interface TerminateSessionCommandOutput extends TerminateSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Terminates an active session. A <code>TerminateSession</code> call on a session that
18
23
  * is already inactive (for example, in a <code>FAILED</code>, <code>TERMINATED</code> or
19
24
  * <code>TERMINATING</code> state) succeeds but has no effect. Calculations running in
@@ -29,6 +34,8 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse,
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param TerminateSessionCommandInput - {@link TerminateSessionCommandInput}
38
+ * @returns {@link TerminateSessionCommandOutput}
32
39
  * @see {@link TerminateSessionCommandInput} for command's `input` shape.
33
40
  * @see {@link TerminateSessionCommandOutput} for command's `response` shape.
34
41
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse,
49
56
  export declare class TerminateSessionCommand extends $Command<TerminateSessionCommandInput, TerminateSessionCommandOutput, AthenaClientResolvedConfig> {
50
57
  readonly input: TerminateSessionCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: TerminateSessionCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TerminateSessionCommandInput, TerminateSessionCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more tags from a data catalog or workgroup resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
45
52
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: UntagResourceCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: UntagResourceCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }