@aws-sdk/client-athena 3.296.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 +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { BatchGetQueryExecutionInput, BatchGetQueryExecutionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchGetQueryExecutionCommand}.
8
10
  */
9
11
  export interface BatchGetQueryExecutionCommandInput extends BatchGetQueryExecutionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchGetQueryExecutionCommand}.
13
17
  */
14
18
  export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecutionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the details of a single query execution or a list of up to 50 query
18
23
  * executions, which you provide as an array of query execution ID strings. Requires you to
19
24
  * have access to the workgroup in which the queries ran. To get a list of query execution
@@ -30,6 +35,8 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param BatchGetQueryExecutionCommandInput - {@link BatchGetQueryExecutionCommandInput}
39
+ * @returns {@link BatchGetQueryExecutionCommandOutput}
33
40
  * @see {@link BatchGetQueryExecutionCommandInput} for command's `input` shape.
34
41
  * @see {@link BatchGetQueryExecutionCommandOutput} for command's `response` shape.
35
42
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -47,11 +54,20 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut
47
54
  export declare class BatchGetQueryExecutionCommand extends $Command<BatchGetQueryExecutionCommandInput, BatchGetQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
48
55
  readonly input: BatchGetQueryExecutionCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: BatchGetQueryExecutionCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetQueryExecutionCommandInput, BatchGetQueryExecutionCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { CreateDataCatalogInput, CreateDataCatalogOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataCatalogCommand}.
8
10
  */
9
11
  export interface CreateDataCatalogCommandInput extends CreateDataCatalogInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataCatalogCommand}.
13
17
  */
14
18
  export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates (registers) a data catalog with the specified name and properties. Catalogs
18
23
  * created are visible to all users of the same Amazon Web Services account.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateDataCatalogCommandInput - {@link CreateDataCatalogCommandInput}
35
+ * @returns {@link CreateDataCatalogCommandOutput}
29
36
  * @see {@link CreateDataCatalogCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateDataCatalogCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -43,11 +50,20 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput,
43
50
  export declare class CreateDataCatalogCommand extends $Command<CreateDataCatalogCommandInput, CreateDataCatalogCommandOutput, AthenaClientResolvedConfig> {
44
51
  readonly input: CreateDataCatalogCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: CreateDataCatalogCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataCatalogCommandInput, CreateDataCatalogCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { CreateNamedQueryInput, CreateNamedQueryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateNamedQueryCommand}.
8
10
  */
9
11
  export interface CreateNamedQueryCommandInput extends CreateNamedQueryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateNamedQueryCommand}.
13
17
  */
14
18
  export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a named query in the specified workgroup. Requires that you have access to the
18
23
  * workgroup.</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 CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateNamedQueryCommandInput - {@link CreateNamedQueryCommandInput}
38
+ * @returns {@link CreateNamedQueryCommandOutput}
32
39
  * @see {@link CreateNamedQueryCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateNamedQueryCommandOutput} for command's `response` shape.
34
41
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _
46
53
  export declare class CreateNamedQueryCommand extends $Command<CreateNamedQueryCommandInput, CreateNamedQueryCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: CreateNamedQueryCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: CreateNamedQueryCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateNamedQueryCommandInput, CreateNamedQueryCommandOutput>;
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 { CreateNotebookInput, CreateNotebookOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateNotebookCommand}.
8
10
  */
9
11
  export interface CreateNotebookCommandInput extends CreateNotebookInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateNotebookCommand}.
13
17
  */
14
18
  export interface CreateNotebookCommandOutput extends CreateNotebookOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an empty <code>ipynb</code> file in the specified Apache Spark enabled
18
23
  * workgroup. Throws an error if a file in the workgroup with the same name already
19
24
  * exists.</p>
@@ -27,6 +32,8 @@ export interface CreateNotebookCommandOutput extends CreateNotebookOutput, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateNotebookCommandInput - {@link CreateNotebookCommandInput}
36
+ * @returns {@link CreateNotebookCommandOutput}
30
37
  * @see {@link CreateNotebookCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateNotebookCommandOutput} for command's `response` shape.
32
39
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreateNotebookCommandOutput extends CreateNotebookOutput, __Met
47
54
  export declare class CreateNotebookCommand extends $Command<CreateNotebookCommandInput, CreateNotebookCommandOutput, AthenaClientResolvedConfig> {
48
55
  readonly input: CreateNotebookCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: CreateNotebookCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateNotebookCommandInput, CreateNotebookCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { CreatePreparedStatementInput, CreatePreparedStatementOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePreparedStatementCommand}.
8
10
  */
9
11
  export interface CreatePreparedStatementCommandInput extends CreatePreparedStatementInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePreparedStatementCommand}.
13
17
  */
14
18
  export interface CreatePreparedStatementCommandOutput extends CreatePreparedStatementOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a prepared statement for use with SQL queries in Athena.</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 CreatePreparedStatementCommandOutput extends CreatePreparedStat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreatePreparedStatementCommandInput - {@link CreatePreparedStatementCommandInput}
34
+ * @returns {@link CreatePreparedStatementCommandOutput}
28
35
  * @see {@link CreatePreparedStatementCommandInput} for command's `input` shape.
29
36
  * @see {@link CreatePreparedStatementCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -42,11 +49,20 @@ export interface CreatePreparedStatementCommandOutput extends CreatePreparedStat
42
49
  export declare class CreatePreparedStatementCommand extends $Command<CreatePreparedStatementCommandInput, CreatePreparedStatementCommandOutput, AthenaClientResolvedConfig> {
43
50
  readonly input: CreatePreparedStatementCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: CreatePreparedStatementCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePreparedStatementCommandInput, CreatePreparedStatementCommandOutput>;
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 { CreatePresignedNotebookUrlRequest, CreatePresignedNotebookUrlResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePresignedNotebookUrlCommand}.
8
10
  */
9
11
  export interface CreatePresignedNotebookUrlCommandInput extends CreatePresignedNotebookUrlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePresignedNotebookUrlCommand}.
13
17
  */
14
18
  export interface CreatePresignedNotebookUrlCommandOutput extends CreatePresignedNotebookUrlResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets an authentication token and the URL at which the notebook can be accessed. During
18
23
  * programmatic access, <code>CreatePresignedNotebookUrl</code> must be called every 10
19
24
  * minutes to refresh the authentication token.</p>
@@ -27,6 +32,8 @@ export interface CreatePresignedNotebookUrlCommandOutput extends CreatePresigned
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreatePresignedNotebookUrlCommandInput - {@link CreatePresignedNotebookUrlCommandInput}
36
+ * @returns {@link CreatePresignedNotebookUrlCommandOutput}
30
37
  * @see {@link CreatePresignedNotebookUrlCommandInput} for command's `input` shape.
31
38
  * @see {@link CreatePresignedNotebookUrlCommandOutput} for command's `response` shape.
32
39
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CreatePresignedNotebookUrlCommandOutput extends CreatePresigned
47
54
  export declare class CreatePresignedNotebookUrlCommand extends $Command<CreatePresignedNotebookUrlCommandInput, CreatePresignedNotebookUrlCommandOutput, AthenaClientResolvedConfig> {
48
55
  readonly input: CreatePresignedNotebookUrlCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: CreatePresignedNotebookUrlCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePresignedNotebookUrlCommandInput, CreatePresignedNotebookUrlCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { CreateWorkGroupInput, CreateWorkGroupOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateWorkGroupCommand}.
8
10
  */
9
11
  export interface CreateWorkGroupCommandInput extends CreateWorkGroupInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateWorkGroupCommand}.
13
17
  */
14
18
  export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a workgroup with the specified name. Only one of <code>Configurations</code>
18
23
  * or <code>Configuration</code> can be specified; <code>Configurations</code> for a
19
24
  * workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or
@@ -28,6 +33,8 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateWorkGroupCommandInput - {@link CreateWorkGroupCommandInput}
37
+ * @returns {@link CreateWorkGroupCommandOutput}
31
38
  * @see {@link CreateWorkGroupCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateWorkGroupCommandOutput} for command's `response` shape.
33
40
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M
45
52
  export declare class CreateWorkGroupCommand extends $Command<CreateWorkGroupCommandInput, CreateWorkGroupCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: CreateWorkGroupCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: CreateWorkGroupCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWorkGroupCommandInput, CreateWorkGroupCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { DeleteDataCatalogInput, DeleteDataCatalogOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDataCatalogCommand}.
8
10
  */
9
11
  export interface DeleteDataCatalogCommandInput extends DeleteDataCatalogInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDataCatalogCommand}.
13
17
  */
14
18
  export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a data catalog.</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 DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteDataCatalogCommandInput - {@link DeleteDataCatalogCommandInput}
34
+ * @returns {@link DeleteDataCatalogCommandOutput}
28
35
  * @see {@link DeleteDataCatalogCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteDataCatalogCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput,
42
49
  export declare class DeleteDataCatalogCommand extends $Command<DeleteDataCatalogCommandInput, DeleteDataCatalogCommandOutput, AthenaClientResolvedConfig> {
43
50
  readonly input: DeleteDataCatalogCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DeleteDataCatalogCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDataCatalogCommandInput, DeleteDataCatalogCommandOutput>;
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 { DeleteNamedQueryInput, DeleteNamedQueryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteNamedQueryCommand}.
8
10
  */
9
11
  export interface DeleteNamedQueryCommandInput extends DeleteNamedQueryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteNamedQueryCommand}.
13
17
  */
14
18
  export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the named query if you have access to the workgroup in which the query was
18
23
  * saved.</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 DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteNamedQueryCommandInput - {@link DeleteNamedQueryCommandInput}
38
+ * @returns {@link DeleteNamedQueryCommandOutput}
32
39
  * @see {@link DeleteNamedQueryCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteNamedQueryCommandOutput} for command's `response` shape.
34
41
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _
46
53
  export declare class DeleteNamedQueryCommand extends $Command<DeleteNamedQueryCommandInput, DeleteNamedQueryCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: DeleteNamedQueryCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteNamedQueryCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteNamedQueryCommandInput, DeleteNamedQueryCommandOutput>;
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 { DeleteNotebookInput, DeleteNotebookOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteNotebookCommand}.
8
10
  */
9
11
  export interface DeleteNotebookCommandInput extends DeleteNotebookInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteNotebookCommand}.
13
17
  */
14
18
  export interface DeleteNotebookCommandOutput extends DeleteNotebookOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified notebook.</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 DeleteNotebookCommandOutput extends DeleteNotebookOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteNotebookCommandInput - {@link DeleteNotebookCommandInput}
34
+ * @returns {@link DeleteNotebookCommandOutput}
28
35
  * @see {@link DeleteNotebookCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteNotebookCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DeleteNotebookCommandOutput extends DeleteNotebookOutput, __Met
45
52
  export declare class DeleteNotebookCommand extends $Command<DeleteNotebookCommandInput, DeleteNotebookCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: DeleteNotebookCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: DeleteNotebookCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteNotebookCommandInput, DeleteNotebookCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { DeletePreparedStatementInput, DeletePreparedStatementOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePreparedStatementCommand}.
8
10
  */
9
11
  export interface DeletePreparedStatementCommandInput extends DeletePreparedStatementInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePreparedStatementCommand}.
13
17
  */
14
18
  export interface DeletePreparedStatementCommandOutput extends DeletePreparedStatementOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the prepared statement with the specified name from the specified
18
23
  * workgroup.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeletePreparedStatementCommandOutput extends DeletePreparedStat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeletePreparedStatementCommandInput - {@link DeletePreparedStatementCommandInput}
35
+ * @returns {@link DeletePreparedStatementCommandOutput}
29
36
  * @see {@link DeletePreparedStatementCommandInput} for command's `input` shape.
30
37
  * @see {@link DeletePreparedStatementCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeletePreparedStatementCommandOutput extends DeletePreparedStat
46
53
  export declare class DeletePreparedStatementCommand extends $Command<DeletePreparedStatementCommandInput, DeletePreparedStatementCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: DeletePreparedStatementCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeletePreparedStatementCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePreparedStatementCommandInput, DeletePreparedStatementCommandOutput>;
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 { DeleteWorkGroupInput, DeleteWorkGroupOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWorkGroupCommand}.
8
10
  */
9
11
  export interface DeleteWorkGroupCommandInput extends DeleteWorkGroupInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWorkGroupCommand}.
13
17
  */
14
18
  export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the workgroup with the specified name. The primary workgroup cannot be
18
23
  * deleted.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteWorkGroupCommandInput - {@link DeleteWorkGroupCommandInput}
35
+ * @returns {@link DeleteWorkGroupCommandOutput}
29
36
  * @see {@link DeleteWorkGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteWorkGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __M
43
50
  export declare class DeleteWorkGroupCommand extends $Command<DeleteWorkGroupCommandInput, DeleteWorkGroupCommandOutput, AthenaClientResolvedConfig> {
44
51
  readonly input: DeleteWorkGroupCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DeleteWorkGroupCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWorkGroupCommandInput, DeleteWorkGroupCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { ExportNotebookInput, ExportNotebookOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ExportNotebookCommand}.
8
10
  */
9
11
  export interface ExportNotebookCommandInput extends ExportNotebookInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ExportNotebookCommand}.
13
17
  */
14
18
  export interface ExportNotebookCommandOutput extends ExportNotebookOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Exports the specified notebook and its metadata.</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 ExportNotebookCommandOutput extends ExportNotebookOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ExportNotebookCommandInput - {@link ExportNotebookCommandInput}
34
+ * @returns {@link ExportNotebookCommandOutput}
28
35
  * @see {@link ExportNotebookCommandInput} for command's `input` shape.
29
36
  * @see {@link ExportNotebookCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface ExportNotebookCommandOutput extends ExportNotebookOutput, __Met
45
52
  export declare class ExportNotebookCommand extends $Command<ExportNotebookCommandInput, ExportNotebookCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: ExportNotebookCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: ExportNotebookCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExportNotebookCommandInput, ExportNotebookCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }