@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 { GetCalculationExecutionCodeRequest, GetCalculationExecutionCodeResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCalculationExecutionCodeCommand}.
8
10
  */
9
11
  export interface GetCalculationExecutionCodeCommandInput extends GetCalculationExecutionCodeRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCalculationExecutionCodeCommand}.
13
17
  */
14
18
  export interface GetCalculationExecutionCodeCommandOutput extends GetCalculationExecutionCodeResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a pre-signed URL to a copy of the code that was executed for the
18
23
  * calculation.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetCalculationExecutionCodeCommandOutput extends GetCalculation
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetCalculationExecutionCodeCommandInput - {@link GetCalculationExecutionCodeCommandInput}
35
+ * @returns {@link GetCalculationExecutionCodeCommandOutput}
29
36
  * @see {@link GetCalculationExecutionCodeCommandInput} for command's `input` shape.
30
37
  * @see {@link GetCalculationExecutionCodeCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetCalculationExecutionCodeCommandOutput extends GetCalculation
46
53
  export declare class GetCalculationExecutionCodeCommand extends $Command<GetCalculationExecutionCodeCommandInput, GetCalculationExecutionCodeCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: GetCalculationExecutionCodeCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetCalculationExecutionCodeCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCalculationExecutionCodeCommandInput, GetCalculationExecutionCodeCommandOutput>;
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 { GetCalculationExecutionRequest, GetCalculationExecutionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCalculationExecutionCommand}.
8
10
  */
9
11
  export interface GetCalculationExecutionCommandInput extends GetCalculationExecutionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCalculationExecutionCommand}.
13
17
  */
14
18
  export interface GetCalculationExecutionCommandOutput extends GetCalculationExecutionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a previously submitted calculation execution.</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 GetCalculationExecutionCommandOutput extends GetCalculationExec
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCalculationExecutionCommandInput - {@link GetCalculationExecutionCommandInput}
34
+ * @returns {@link GetCalculationExecutionCommandOutput}
28
35
  * @see {@link GetCalculationExecutionCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCalculationExecutionCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetCalculationExecutionCommandOutput extends GetCalculationExec
45
52
  export declare class GetCalculationExecutionCommand extends $Command<GetCalculationExecutionCommandInput, GetCalculationExecutionCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: GetCalculationExecutionCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetCalculationExecutionCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCalculationExecutionCommandInput, GetCalculationExecutionCommandOutput>;
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 { GetCalculationExecutionStatusRequest, GetCalculationExecutionStatusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCalculationExecutionStatusCommand}.
8
10
  */
9
11
  export interface GetCalculationExecutionStatusCommandInput extends GetCalculationExecutionStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCalculationExecutionStatusCommand}.
13
17
  */
14
18
  export interface GetCalculationExecutionStatusCommandOutput extends GetCalculationExecutionStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the status of a current calculation.</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 GetCalculationExecutionStatusCommandOutput extends GetCalculati
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCalculationExecutionStatusCommandInput - {@link GetCalculationExecutionStatusCommandInput}
34
+ * @returns {@link GetCalculationExecutionStatusCommandOutput}
28
35
  * @see {@link GetCalculationExecutionStatusCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCalculationExecutionStatusCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetCalculationExecutionStatusCommandOutput extends GetCalculati
45
52
  export declare class GetCalculationExecutionStatusCommand extends $Command<GetCalculationExecutionStatusCommandInput, GetCalculationExecutionStatusCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: GetCalculationExecutionStatusCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetCalculationExecutionStatusCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCalculationExecutionStatusCommandInput, GetCalculationExecutionStatusCommandOutput>;
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 { GetDataCatalogInput, GetDataCatalogOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDataCatalogCommand}.
8
10
  */
9
11
  export interface GetDataCatalogCommandInput extends GetDataCatalogInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDataCatalogCommand}.
13
17
  */
14
18
  export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the specified 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 GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDataCatalogCommandInput - {@link GetDataCatalogCommandInput}
34
+ * @returns {@link GetDataCatalogCommandOutput}
28
35
  * @see {@link GetDataCatalogCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDataCatalogCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -42,11 +49,20 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met
42
49
  export declare class GetDataCatalogCommand extends $Command<GetDataCatalogCommandInput, GetDataCatalogCommandOutput, AthenaClientResolvedConfig> {
43
50
  readonly input: GetDataCatalogCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: GetDataCatalogCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDataCatalogCommandInput, GetDataCatalogCommandOutput>;
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 { GetDatabaseInput, GetDatabaseOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDatabaseCommand}.
8
10
  */
9
11
  export interface GetDatabaseCommandInput extends GetDatabaseInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDatabaseCommand}.
13
17
  */
14
18
  export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a database object for the specified database and 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 GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDatabaseCommandInput - {@link GetDatabaseCommandInput}
34
+ * @returns {@link GetDatabaseCommandOutput}
28
35
  * @see {@link GetDatabaseCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDatabaseCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB
50
57
  export declare class GetDatabaseCommand extends $Command<GetDatabaseCommandInput, GetDatabaseCommandOutput, AthenaClientResolvedConfig> {
51
58
  readonly input: GetDatabaseCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetDatabaseCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDatabaseCommandInput, GetDatabaseCommandOutput>;
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 { GetNamedQueryInput, GetNamedQueryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetNamedQueryCommand}.
8
10
  */
9
11
  export interface GetNamedQueryCommandInput extends GetNamedQueryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetNamedQueryCommand}.
13
17
  */
14
18
  export interface GetNamedQueryCommandOutput extends GetNamedQueryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a single query. Requires that you have access to the
18
23
  * workgroup in which the query was saved.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetNamedQueryCommandOutput extends GetNamedQueryOutput, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetNamedQueryCommandInput - {@link GetNamedQueryCommandInput}
35
+ * @returns {@link GetNamedQueryCommandOutput}
29
36
  * @see {@link GetNamedQueryCommandInput} for command's `input` shape.
30
37
  * @see {@link GetNamedQueryCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetNamedQueryCommandOutput extends GetNamedQueryOutput, __Metad
43
50
  export declare class GetNamedQueryCommand extends $Command<GetNamedQueryCommandInput, GetNamedQueryCommandOutput, AthenaClientResolvedConfig> {
44
51
  readonly input: GetNamedQueryCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetNamedQueryCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetNamedQueryCommandInput, GetNamedQueryCommandOutput>;
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 { GetNotebookMetadataInput, GetNotebookMetadataOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetNotebookMetadataCommand}.
8
10
  */
9
11
  export interface GetNotebookMetadataCommandInput extends GetNotebookMetadataInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetNotebookMetadataCommand}.
13
17
  */
14
18
  export interface GetNotebookMetadataCommandOutput extends GetNotebookMetadataOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves notebook metadata for the specified notebook ID.</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 GetNotebookMetadataCommandOutput extends GetNotebookMetadataOut
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetNotebookMetadataCommandInput - {@link GetNotebookMetadataCommandInput}
34
+ * @returns {@link GetNotebookMetadataCommandOutput}
28
35
  * @see {@link GetNotebookMetadataCommandInput} for command's `input` shape.
29
36
  * @see {@link GetNotebookMetadataCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetNotebookMetadataCommandOutput extends GetNotebookMetadataOut
45
52
  export declare class GetNotebookMetadataCommand extends $Command<GetNotebookMetadataCommandInput, GetNotebookMetadataCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: GetNotebookMetadataCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetNotebookMetadataCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetNotebookMetadataCommandInput, GetNotebookMetadataCommandOutput>;
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 { GetPreparedStatementInput, GetPreparedStatementOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPreparedStatementCommand}.
8
10
  */
9
11
  export interface GetPreparedStatementCommandInput extends GetPreparedStatementInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPreparedStatementCommand}.
13
17
  */
14
18
  export interface GetPreparedStatementCommandOutput extends GetPreparedStatementOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the prepared statement with the specified name from the specified
18
23
  * workgroup.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetPreparedStatementCommandOutput extends GetPreparedStatementO
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetPreparedStatementCommandInput - {@link GetPreparedStatementCommandInput}
35
+ * @returns {@link GetPreparedStatementCommandOutput}
29
36
  * @see {@link GetPreparedStatementCommandInput} for command's `input` shape.
30
37
  * @see {@link GetPreparedStatementCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetPreparedStatementCommandOutput extends GetPreparedStatementO
46
53
  export declare class GetPreparedStatementCommand extends $Command<GetPreparedStatementCommandInput, GetPreparedStatementCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: GetPreparedStatementCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetPreparedStatementCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPreparedStatementCommandInput, GetPreparedStatementCommandOutput>;
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 { GetQueryExecutionInput, GetQueryExecutionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetQueryExecutionCommand}.
8
10
  */
9
11
  export interface GetQueryExecutionCommandInput extends GetQueryExecutionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetQueryExecutionCommand}.
13
17
  */
14
18
  export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a single execution of a query if you have access to the
18
23
  * workgroup in which the query ran. Each time a query executes, information about the
19
24
  * query execution is saved with a unique ID.</p>
@@ -27,6 +32,8 @@ export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetQueryExecutionCommandInput - {@link GetQueryExecutionCommandInput}
36
+ * @returns {@link GetQueryExecutionCommandOutput}
30
37
  * @see {@link GetQueryExecutionCommandInput} for command's `input` shape.
31
38
  * @see {@link GetQueryExecutionCommandOutput} for command's `response` shape.
32
39
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -44,11 +51,20 @@ export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput,
44
51
  export declare class GetQueryExecutionCommand extends $Command<GetQueryExecutionCommandInput, GetQueryExecutionCommandOutput, AthenaClientResolvedConfig> {
45
52
  readonly input: GetQueryExecutionCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: GetQueryExecutionCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQueryExecutionCommandInput, GetQueryExecutionCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { GetQueryResultsInput, GetQueryResultsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetQueryResultsCommand}.
8
10
  */
9
11
  export interface GetQueryResultsCommandInput extends GetQueryResultsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetQueryResultsCommand}.
13
17
  */
14
18
  export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Streams the results of a single query execution specified by
18
23
  * <code>QueryExecutionId</code> from the Athena query results location in
19
24
  * Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/athena/latest/ug/querying.html">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query
@@ -39,6 +44,8 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param GetQueryResultsCommandInput - {@link GetQueryResultsCommandInput}
48
+ * @returns {@link GetQueryResultsCommandOutput}
42
49
  * @see {@link GetQueryResultsCommandInput} for command's `input` shape.
43
50
  * @see {@link GetQueryResultsCommandOutput} for command's `response` shape.
44
51
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -59,11 +66,20 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M
59
66
  export declare class GetQueryResultsCommand extends $Command<GetQueryResultsCommandInput, GetQueryResultsCommandOutput, AthenaClientResolvedConfig> {
60
67
  readonly input: GetQueryResultsCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: GetQueryResultsCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQueryResultsCommandInput, GetQueryResultsCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AthenaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AthenaClient";
5
5
  import { GetQueryRuntimeStatisticsInput, GetQueryRuntimeStatisticsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetQueryRuntimeStatisticsCommand}.
8
10
  */
9
11
  export interface GetQueryRuntimeStatisticsCommandInput extends GetQueryRuntimeStatisticsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetQueryRuntimeStatisticsCommand}.
13
17
  */
14
18
  export interface GetQueryRuntimeStatisticsCommandOutput extends GetQueryRuntimeStatisticsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns query execution runtime statistics related to a single execution of a query if
18
23
  * you have access to the workgroup in which the query ran. Query execution runtime
19
24
  * statistics are returned only when <a>QueryExecutionStatus$State</a> is in a
@@ -30,6 +35,8 @@ export interface GetQueryRuntimeStatisticsCommandOutput extends GetQueryRuntimeS
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param GetQueryRuntimeStatisticsCommandInput - {@link GetQueryRuntimeStatisticsCommandInput}
39
+ * @returns {@link GetQueryRuntimeStatisticsCommandOutput}
33
40
  * @see {@link GetQueryRuntimeStatisticsCommandInput} for command's `input` shape.
34
41
  * @see {@link GetQueryRuntimeStatisticsCommandOutput} for command's `response` shape.
35
42
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetQueryRuntimeStatisticsCommandOutput extends GetQueryRuntimeS
47
54
  export declare class GetQueryRuntimeStatisticsCommand extends $Command<GetQueryRuntimeStatisticsCommandInput, GetQueryRuntimeStatisticsCommandOutput, AthenaClientResolvedConfig> {
48
55
  readonly input: GetQueryRuntimeStatisticsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetQueryRuntimeStatisticsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQueryRuntimeStatisticsCommandInput, GetQueryRuntimeStatisticsCommandOutput>;
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 { GetSessionRequest, GetSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSessionCommand}.
8
10
  */
9
11
  export interface GetSessionCommandInput extends GetSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSessionCommand}.
13
17
  */
14
18
  export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the full details of a previously created session, including the session status
18
23
  * and configuration.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetSessionCommandInput - {@link GetSessionCommandInput}
35
+ * @returns {@link GetSessionCommandOutput}
29
36
  * @see {@link GetSessionCommandInput} for command's `input` shape.
30
37
  * @see {@link GetSessionCommandOutput} for command's `response` shape.
31
38
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
46
53
  export declare class GetSessionCommand extends $Command<GetSessionCommandInput, GetSessionCommandOutput, AthenaClientResolvedConfig> {
47
54
  readonly input: GetSessionCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetSessionCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionCommandInput, GetSessionCommandOutput>;
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 { GetSessionStatusRequest, GetSessionStatusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSessionStatusCommand}.
8
10
  */
9
11
  export interface GetSessionStatusCommandInput extends GetSessionStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSessionStatusCommand}.
13
17
  */
14
18
  export interface GetSessionStatusCommandOutput extends GetSessionStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the current status of a session.</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 GetSessionStatusCommandOutput extends GetSessionStatusResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetSessionStatusCommandInput - {@link GetSessionStatusCommandInput}
34
+ * @returns {@link GetSessionStatusCommandOutput}
28
35
  * @see {@link GetSessionStatusCommandInput} for command's `input` shape.
29
36
  * @see {@link GetSessionStatusCommandOutput} for command's `response` shape.
30
37
  * @see {@link AthenaClientResolvedConfig | config} for AthenaClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetSessionStatusCommandOutput extends GetSessionStatusResponse,
45
52
  export declare class GetSessionStatusCommand extends $Command<GetSessionStatusCommandInput, GetSessionStatusCommandOutput, AthenaClientResolvedConfig> {
46
53
  readonly input: GetSessionStatusCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetSessionStatusCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AthenaClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionStatusCommandInput, GetSessionStatusCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }