@aws-sdk/client-redshift-data 3.32.0 → 3.36.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 (210) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/{dist/cjs → dist-cjs}/RedshiftData.js +1 -2
  3. package/{dist/cjs → dist-cjs}/RedshiftDataClient.js +8 -9
  4. package/{dist/cjs → dist-cjs}/commands/BatchExecuteStatementCommand.js +2 -3
  5. package/{dist/cjs → dist-cjs}/commands/CancelStatementCommand.js +2 -3
  6. package/{dist/cjs → dist-cjs}/commands/DescribeStatementCommand.js +2 -3
  7. package/{dist/cjs → dist-cjs}/commands/DescribeTableCommand.js +2 -3
  8. package/{dist/cjs → dist-cjs}/commands/ExecuteStatementCommand.js +2 -3
  9. package/{dist/cjs → dist-cjs}/commands/GetStatementResultCommand.js +2 -3
  10. package/{dist/cjs → dist-cjs}/commands/ListDatabasesCommand.js +2 -3
  11. package/{dist/cjs → dist-cjs}/commands/ListSchemasCommand.js +2 -3
  12. package/{dist/cjs → dist-cjs}/commands/ListStatementsCommand.js +2 -3
  13. package/{dist/cjs → dist-cjs}/commands/ListTablesCommand.js +2 -3
  14. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  15. package/{dist/cjs → dist-cjs}/index.js +0 -1
  16. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  17. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -1
  18. package/{dist/cjs → dist-cjs}/pagination/DescribeTablePaginator.js +1 -2
  19. package/{dist/cjs → dist-cjs}/pagination/GetStatementResultPaginator.js +1 -2
  20. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  21. package/{dist/cjs → dist-cjs}/pagination/ListDatabasesPaginator.js +1 -2
  22. package/{dist/cjs → dist-cjs}/pagination/ListSchemasPaginator.js +1 -2
  23. package/{dist/cjs → dist-cjs}/pagination/ListStatementsPaginator.js +1 -2
  24. package/{dist/cjs → dist-cjs}/pagination/ListTablesPaginator.js +1 -2
  25. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -1
  26. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +2 -2
  27. package/{dist/cjs → dist-cjs}/runtimeConfig.js +2 -2
  28. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -1
  29. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -2
  30. package/{dist/es → dist-es}/RedshiftData.js +2 -10
  31. package/{dist/es → dist-es}/RedshiftDataClient.js +2 -15
  32. package/dist-es/commands/BatchExecuteStatementCommand.js +39 -0
  33. package/{dist/es → dist-es}/commands/CancelStatementCommand.js +4 -30
  34. package/{dist/es → dist-es}/commands/DescribeStatementCommand.js +4 -32
  35. package/dist-es/commands/DescribeTableCommand.js +39 -0
  36. package/dist-es/commands/ExecuteStatementCommand.js +39 -0
  37. package/{dist/es → dist-es}/commands/GetStatementResultCommand.js +4 -31
  38. package/dist-es/commands/ListDatabasesCommand.js +39 -0
  39. package/dist-es/commands/ListSchemasCommand.js +39 -0
  40. package/{dist/es → dist-es}/commands/ListStatementsCommand.js +4 -31
  41. package/dist-es/commands/ListTablesCommand.js +39 -0
  42. package/{dist/es → dist-es}/endpoints.js +1 -2
  43. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  44. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  45. package/{dist/es → dist-es}/models/models_0.js +0 -97
  46. package/{dist/es → dist-es}/pagination/DescribeTablePaginator.js +17 -30
  47. package/{dist/es → dist-es}/pagination/GetStatementResultPaginator.js +17 -30
  48. package/dist-es/pagination/Interfaces.js +1 -0
  49. package/{dist/es → dist-es}/pagination/ListDatabasesPaginator.js +17 -30
  50. package/{dist/es → dist-es}/pagination/ListSchemasPaginator.js +17 -30
  51. package/{dist/es → dist-es}/pagination/ListStatementsPaginator.js +17 -30
  52. package/{dist/es → dist-es}/pagination/ListTablesPaginator.js +17 -30
  53. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +178 -184
  54. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  55. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  56. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  57. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  58. package/{dist/types → dist-types}/RedshiftData.d.ts +2 -2
  59. package/{dist/types → dist-types}/RedshiftDataClient.d.ts +8 -8
  60. package/{dist/types → dist-types}/commands/BatchExecuteStatementCommand.d.ts +3 -3
  61. package/{dist/types → dist-types}/commands/CancelStatementCommand.d.ts +3 -3
  62. package/{dist/types → dist-types}/commands/DescribeStatementCommand.d.ts +3 -3
  63. package/{dist/types → dist-types}/commands/DescribeTableCommand.d.ts +3 -3
  64. package/{dist/types → dist-types}/commands/ExecuteStatementCommand.d.ts +3 -3
  65. package/{dist/types → dist-types}/commands/GetStatementResultCommand.d.ts +3 -3
  66. package/{dist/types → dist-types}/commands/ListDatabasesCommand.d.ts +3 -3
  67. package/{dist/types → dist-types}/commands/ListSchemasCommand.d.ts +3 -3
  68. package/{dist/types → dist-types}/commands/ListStatementsCommand.d.ts +3 -3
  69. package/{dist/types → dist-types}/commands/ListTablesCommand.d.ts +3 -3
  70. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  71. package/{index.ts → dist-types/index.d.ts} +0 -0
  72. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  73. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  74. package/{dist/types → dist-types}/pagination/DescribeTablePaginator.d.ts +1 -1
  75. package/{dist/types → dist-types}/pagination/GetStatementResultPaginator.d.ts +1 -1
  76. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  77. package/{dist/types → dist-types}/pagination/ListDatabasesPaginator.d.ts +1 -1
  78. package/{dist/types → dist-types}/pagination/ListSchemasPaginator.d.ts +1 -1
  79. package/{dist/types → dist-types}/pagination/ListStatementsPaginator.d.ts +1 -1
  80. package/{dist/types → dist-types}/pagination/ListTablesPaginator.d.ts +1 -1
  81. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +2 -2
  82. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +1 -0
  83. package/{dist/types/ts3.4 → dist-types}/runtimeConfig.d.ts +37 -36
  84. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +1 -0
  85. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  86. package/{dist/types → dist-types}/ts3.4/RedshiftData.d.ts +2 -2
  87. package/{dist/types → dist-types}/ts3.4/RedshiftDataClient.d.ts +8 -8
  88. package/{dist/types → dist-types}/ts3.4/commands/BatchExecuteStatementCommand.d.ts +3 -3
  89. package/{dist/types → dist-types}/ts3.4/commands/CancelStatementCommand.d.ts +3 -3
  90. package/{dist/types → dist-types}/ts3.4/commands/DescribeStatementCommand.d.ts +3 -3
  91. package/{dist/types → dist-types}/ts3.4/commands/DescribeTableCommand.d.ts +3 -3
  92. package/{dist/types → dist-types}/ts3.4/commands/ExecuteStatementCommand.d.ts +3 -3
  93. package/{dist/types → dist-types}/ts3.4/commands/GetStatementResultCommand.d.ts +3 -3
  94. package/{dist/types → dist-types}/ts3.4/commands/ListDatabasesCommand.d.ts +3 -3
  95. package/{dist/types → dist-types}/ts3.4/commands/ListSchemasCommand.d.ts +3 -3
  96. package/{dist/types → dist-types}/ts3.4/commands/ListStatementsCommand.d.ts +3 -3
  97. package/{dist/types → dist-types}/ts3.4/commands/ListTablesCommand.d.ts +3 -3
  98. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  99. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  100. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  101. package/{dist/types → dist-types}/ts3.4/models/models_0.d.ts +0 -0
  102. package/{dist/types → dist-types}/ts3.4/pagination/DescribeTablePaginator.d.ts +1 -1
  103. package/{dist/types → dist-types}/ts3.4/pagination/GetStatementResultPaginator.d.ts +1 -1
  104. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  105. package/{dist/types → dist-types}/ts3.4/pagination/ListDatabasesPaginator.d.ts +1 -1
  106. package/{dist/types → dist-types}/ts3.4/pagination/ListSchemasPaginator.d.ts +1 -1
  107. package/{dist/types → dist-types}/ts3.4/pagination/ListStatementsPaginator.d.ts +1 -1
  108. package/{dist/types → dist-types}/ts3.4/pagination/ListTablesPaginator.d.ts +1 -1
  109. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +2 -2
  110. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -0
  111. package/{dist/types → dist-types/ts3.4}/runtimeConfig.d.ts +37 -36
  112. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -0
  113. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +0 -0
  114. package/package.json +52 -49
  115. package/RedshiftData.ts +0 -451
  116. package/RedshiftDataClient.ts +0 -272
  117. package/commands/BatchExecuteStatementCommand.ts +0 -108
  118. package/commands/CancelStatementCommand.ts +0 -94
  119. package/commands/DescribeStatementCommand.ts +0 -96
  120. package/commands/DescribeTableCommand.ts +0 -109
  121. package/commands/ExecuteStatementCommand.ts +0 -108
  122. package/commands/GetStatementResultCommand.ts +0 -95
  123. package/commands/ListDatabasesCommand.ts +0 -108
  124. package/commands/ListSchemasCommand.ts +0 -108
  125. package/commands/ListStatementsCommand.ts +0 -95
  126. package/commands/ListTablesCommand.ts +0 -109
  127. package/dist/cjs/RedshiftData.js.map +0 -1
  128. package/dist/cjs/RedshiftDataClient.js.map +0 -1
  129. package/dist/cjs/commands/BatchExecuteStatementCommand.js.map +0 -1
  130. package/dist/cjs/commands/CancelStatementCommand.js.map +0 -1
  131. package/dist/cjs/commands/DescribeStatementCommand.js.map +0 -1
  132. package/dist/cjs/commands/DescribeTableCommand.js.map +0 -1
  133. package/dist/cjs/commands/ExecuteStatementCommand.js.map +0 -1
  134. package/dist/cjs/commands/GetStatementResultCommand.js.map +0 -1
  135. package/dist/cjs/commands/ListDatabasesCommand.js.map +0 -1
  136. package/dist/cjs/commands/ListSchemasCommand.js.map +0 -1
  137. package/dist/cjs/commands/ListStatementsCommand.js.map +0 -1
  138. package/dist/cjs/commands/ListTablesCommand.js.map +0 -1
  139. package/dist/cjs/endpoints.js.map +0 -1
  140. package/dist/cjs/index.js.map +0 -1
  141. package/dist/cjs/models/index.js.map +0 -1
  142. package/dist/cjs/models/models_0.js.map +0 -1
  143. package/dist/cjs/package.json +0 -91
  144. package/dist/cjs/pagination/DescribeTablePaginator.js.map +0 -1
  145. package/dist/cjs/pagination/GetStatementResultPaginator.js.map +0 -1
  146. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  147. package/dist/cjs/pagination/ListDatabasesPaginator.js.map +0 -1
  148. package/dist/cjs/pagination/ListSchemasPaginator.js.map +0 -1
  149. package/dist/cjs/pagination/ListStatementsPaginator.js.map +0 -1
  150. package/dist/cjs/pagination/ListTablesPaginator.js.map +0 -1
  151. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  152. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  153. package/dist/cjs/runtimeConfig.js.map +0 -1
  154. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  155. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  156. package/dist/es/RedshiftData.js.map +0 -1
  157. package/dist/es/RedshiftDataClient.js.map +0 -1
  158. package/dist/es/commands/BatchExecuteStatementCommand.js +0 -79
  159. package/dist/es/commands/BatchExecuteStatementCommand.js.map +0 -1
  160. package/dist/es/commands/CancelStatementCommand.js.map +0 -1
  161. package/dist/es/commands/DescribeStatementCommand.js.map +0 -1
  162. package/dist/es/commands/DescribeTableCommand.js +0 -80
  163. package/dist/es/commands/DescribeTableCommand.js.map +0 -1
  164. package/dist/es/commands/ExecuteStatementCommand.js +0 -79
  165. package/dist/es/commands/ExecuteStatementCommand.js.map +0 -1
  166. package/dist/es/commands/GetStatementResultCommand.js.map +0 -1
  167. package/dist/es/commands/ListDatabasesCommand.js +0 -79
  168. package/dist/es/commands/ListDatabasesCommand.js.map +0 -1
  169. package/dist/es/commands/ListSchemasCommand.js +0 -79
  170. package/dist/es/commands/ListSchemasCommand.js.map +0 -1
  171. package/dist/es/commands/ListStatementsCommand.js.map +0 -1
  172. package/dist/es/commands/ListTablesCommand.js +0 -80
  173. package/dist/es/commands/ListTablesCommand.js.map +0 -1
  174. package/dist/es/endpoints.js.map +0 -1
  175. package/dist/es/index.js +0 -21
  176. package/dist/es/index.js.map +0 -1
  177. package/dist/es/models/index.js +0 -2
  178. package/dist/es/models/index.js.map +0 -1
  179. package/dist/es/models/models_0.js.map +0 -1
  180. package/dist/es/package.json +0 -91
  181. package/dist/es/pagination/DescribeTablePaginator.js.map +0 -1
  182. package/dist/es/pagination/GetStatementResultPaginator.js.map +0 -1
  183. package/dist/es/pagination/Interfaces.js +0 -2
  184. package/dist/es/pagination/Interfaces.js.map +0 -1
  185. package/dist/es/pagination/ListDatabasesPaginator.js.map +0 -1
  186. package/dist/es/pagination/ListSchemasPaginator.js.map +0 -1
  187. package/dist/es/pagination/ListStatementsPaginator.js.map +0 -1
  188. package/dist/es/pagination/ListTablesPaginator.js.map +0 -1
  189. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  190. package/dist/es/runtimeConfig.browser.js.map +0 -1
  191. package/dist/es/runtimeConfig.js.map +0 -1
  192. package/dist/es/runtimeConfig.native.js.map +0 -1
  193. package/dist/es/runtimeConfig.shared.js.map +0 -1
  194. package/endpoints.ts +0 -57
  195. package/jest.config.js +0 -4
  196. package/models/models_0.ts +0 -1379
  197. package/pagination/DescribeTablePaginator.ts +0 -58
  198. package/pagination/GetStatementResultPaginator.ts +0 -57
  199. package/pagination/Interfaces.ts +0 -7
  200. package/pagination/ListDatabasesPaginator.ts +0 -58
  201. package/pagination/ListSchemasPaginator.ts +0 -54
  202. package/pagination/ListStatementsPaginator.ts +0 -58
  203. package/pagination/ListTablesPaginator.ts +0 -54
  204. package/protocols/Aws_json1_1.ts +0 -1614
  205. package/runtimeConfig.browser.ts +0 -40
  206. package/runtimeConfig.native.ts +0 -16
  207. package/runtimeConfig.shared.ts +0 -16
  208. package/runtimeConfig.ts +0 -45
  209. package/tsconfig.es.json +0 -12
  210. package/tsconfig.json +0 -32
@@ -1,1379 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>The number of active statements exceeds the limit.</p>
5
- */
6
- export interface ActiveStatementsExceededException extends __SmithyException, $MetadataBearer {
7
- name: "ActiveStatementsExceededException";
8
- $fault: "client";
9
- Message?: string;
10
- }
11
-
12
- export namespace ActiveStatementsExceededException {
13
- /**
14
- * @internal
15
- */
16
- export const filterSensitiveLog = (obj: ActiveStatementsExceededException): any => ({
17
- ...obj,
18
- });
19
- }
20
-
21
- /**
22
- * <p>An SQL statement encountered an environmental error while running.</p>
23
- */
24
- export interface BatchExecuteStatementException extends __SmithyException, $MetadataBearer {
25
- name: "BatchExecuteStatementException";
26
- $fault: "server";
27
- Message: string | undefined;
28
- /**
29
- * <p>Statement identifier of the exception.</p>
30
- */
31
- StatementId: string | undefined;
32
- }
33
-
34
- export namespace BatchExecuteStatementException {
35
- /**
36
- * @internal
37
- */
38
- export const filterSensitiveLog = (obj: BatchExecuteStatementException): any => ({
39
- ...obj,
40
- });
41
- }
42
-
43
- export interface BatchExecuteStatementInput {
44
- /**
45
- * <p>One or more SQL statements to run. </p>
46
- */
47
- Sqls: string[] | undefined;
48
-
49
- /**
50
- * <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
51
- */
52
- ClusterIdentifier: string | undefined;
53
-
54
- /**
55
- * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
56
- */
57
- SecretArn?: string;
58
-
59
- /**
60
- * <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
61
- */
62
- DbUser?: string;
63
-
64
- /**
65
- * <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
66
- */
67
- Database: string | undefined;
68
-
69
- /**
70
- * <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run. </p>
71
- */
72
- WithEvent?: boolean;
73
-
74
- /**
75
- * <p>The name of the SQL statements. You can name the SQL statements when you create them to identify the query. </p>
76
- */
77
- StatementName?: string;
78
- }
79
-
80
- export namespace BatchExecuteStatementInput {
81
- /**
82
- * @internal
83
- */
84
- export const filterSensitiveLog = (obj: BatchExecuteStatementInput): any => ({
85
- ...obj,
86
- });
87
- }
88
-
89
- export interface BatchExecuteStatementOutput {
90
- /**
91
- * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
92
- * This identifier is returned by <code>BatchExecuteStatment</code>. </p>
93
- */
94
- Id?: string;
95
-
96
- /**
97
- * <p>The date and time (UTC) the statement was created. </p>
98
- */
99
- CreatedAt?: Date;
100
-
101
- /**
102
- * <p>The cluster identifier. </p>
103
- */
104
- ClusterIdentifier?: string;
105
-
106
- /**
107
- * <p>The database user name.</p>
108
- */
109
- DbUser?: string;
110
-
111
- /**
112
- * <p>The name of the database.</p>
113
- */
114
- Database?: string;
115
-
116
- /**
117
- * <p>The name or ARN of the secret that enables access to the database. </p>
118
- */
119
- SecretArn?: string;
120
- }
121
-
122
- export namespace BatchExecuteStatementOutput {
123
- /**
124
- * @internal
125
- */
126
- export const filterSensitiveLog = (obj: BatchExecuteStatementOutput): any => ({
127
- ...obj,
128
- });
129
- }
130
-
131
- /**
132
- * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
133
- */
134
- export interface ValidationException extends __SmithyException, $MetadataBearer {
135
- name: "ValidationException";
136
- $fault: "client";
137
- /**
138
- * <p>The exception message.</p>
139
- */
140
- Message?: string;
141
- }
142
-
143
- export namespace ValidationException {
144
- /**
145
- * @internal
146
- */
147
- export const filterSensitiveLog = (obj: ValidationException): any => ({
148
- ...obj,
149
- });
150
- }
151
-
152
- export interface CancelStatementRequest {
153
- /**
154
- * <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
155
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
156
- */
157
- Id: string | undefined;
158
- }
159
-
160
- export namespace CancelStatementRequest {
161
- /**
162
- * @internal
163
- */
164
- export const filterSensitiveLog = (obj: CancelStatementRequest): any => ({
165
- ...obj,
166
- });
167
- }
168
-
169
- export interface CancelStatementResponse {
170
- /**
171
- * <p>A value that indicates whether the cancel statement succeeded (true). </p>
172
- */
173
- Status?: boolean;
174
- }
175
-
176
- export namespace CancelStatementResponse {
177
- /**
178
- * @internal
179
- */
180
- export const filterSensitiveLog = (obj: CancelStatementResponse): any => ({
181
- ...obj,
182
- });
183
- }
184
-
185
- /**
186
- * <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
187
- */
188
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
189
- name: "InternalServerException";
190
- $fault: "server";
191
- /**
192
- * <p>The exception message.</p>
193
- */
194
- Message: string | undefined;
195
- }
196
-
197
- export namespace InternalServerException {
198
- /**
199
- * @internal
200
- */
201
- export const filterSensitiveLog = (obj: InternalServerException): any => ({
202
- ...obj,
203
- });
204
- }
205
-
206
- /**
207
- * <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
208
- */
209
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
210
- name: "ResourceNotFoundException";
211
- $fault: "client";
212
- /**
213
- * <p>The exception message.</p>
214
- */
215
- Message: string | undefined;
216
-
217
- /**
218
- * <p>Resource identifier associated with the exception.</p>
219
- */
220
- ResourceId: string | undefined;
221
- }
222
-
223
- export namespace ResourceNotFoundException {
224
- /**
225
- * @internal
226
- */
227
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
228
- ...obj,
229
- });
230
- }
231
-
232
- /**
233
- * <p>The properties (metadata) of a column. </p>
234
- */
235
- export interface ColumnMetadata {
236
- /**
237
- * <p>A value that indicates whether the column is case-sensitive. </p>
238
- */
239
- isCaseSensitive?: boolean;
240
-
241
- /**
242
- * <p>A value that indicates whether the column contains currency values.</p>
243
- */
244
- isCurrency?: boolean;
245
-
246
- /**
247
- * <p>A value that indicates whether an integer column is signed.</p>
248
- */
249
- isSigned?: boolean;
250
-
251
- /**
252
- * <p>The label for the column. </p>
253
- */
254
- label?: string;
255
-
256
- /**
257
- * <p>The name of the column. </p>
258
- */
259
- name?: string;
260
-
261
- /**
262
- * <p>A value that indicates whether the column is nullable. </p>
263
- */
264
- nullable?: number;
265
-
266
- /**
267
- * <p>The precision value of a decimal number column. </p>
268
- */
269
- precision?: number;
270
-
271
- /**
272
- * <p>The scale value of a decimal number column. </p>
273
- */
274
- scale?: number;
275
-
276
- /**
277
- * <p>The name of the schema that contains the table that includes the column.</p>
278
- */
279
- schemaName?: string;
280
-
281
- /**
282
- * <p>The name of the table that includes the column. </p>
283
- */
284
- tableName?: string;
285
-
286
- /**
287
- * <p>The database-specific data type of the column. </p>
288
- */
289
- typeName?: string;
290
-
291
- /**
292
- * <p>The length of the column.</p>
293
- */
294
- length?: number;
295
-
296
- /**
297
- * <p>The default value of the column. </p>
298
- */
299
- columnDefault?: string;
300
- }
301
-
302
- export namespace ColumnMetadata {
303
- /**
304
- * @internal
305
- */
306
- export const filterSensitiveLog = (obj: ColumnMetadata): any => ({
307
- ...obj,
308
- });
309
- }
310
-
311
- export interface DescribeStatementRequest {
312
- /**
313
- * <p>The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
314
- * A suffix indicates the number of the SQL statement.
315
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
316
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatement</code>, and <code>ListStatements</code>. </p>
317
- */
318
- Id: string | undefined;
319
- }
320
-
321
- export namespace DescribeStatementRequest {
322
- /**
323
- * @internal
324
- */
325
- export const filterSensitiveLog = (obj: DescribeStatementRequest): any => ({
326
- ...obj,
327
- });
328
- }
329
-
330
- /**
331
- * <p>A parameter used in a SQL statement.</p>
332
- */
333
- export interface SqlParameter {
334
- /**
335
- * <p>The name of the parameter.</p>
336
- */
337
- name: string | undefined;
338
-
339
- /**
340
- * <p>The value of the parameter.
341
- * Amazon Redshift implicitly converts to the proper data type. For more inforation, see
342
- * <a href="https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html">Data types</a> in the
343
- * <i>Amazon Redshift Database Developer Guide</i>. </p>
344
- */
345
- value: string | undefined;
346
- }
347
-
348
- export namespace SqlParameter {
349
- /**
350
- * @internal
351
- */
352
- export const filterSensitiveLog = (obj: SqlParameter): any => ({
353
- ...obj,
354
- });
355
- }
356
-
357
- export enum StatusString {
358
- ABORTED = "ABORTED",
359
- ALL = "ALL",
360
- FAILED = "FAILED",
361
- FINISHED = "FINISHED",
362
- PICKED = "PICKED",
363
- STARTED = "STARTED",
364
- SUBMITTED = "SUBMITTED",
365
- }
366
-
367
- export enum StatementStatusString {
368
- ABORTED = "ABORTED",
369
- FAILED = "FAILED",
370
- FINISHED = "FINISHED",
371
- PICKED = "PICKED",
372
- STARTED = "STARTED",
373
- SUBMITTED = "SUBMITTED",
374
- }
375
-
376
- /**
377
- * <p>Information about an SQL statement.</p>
378
- */
379
- export interface SubStatementData {
380
- /**
381
- * <p>The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
382
- * A suffix indicates the number of the SQL statement.
383
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.</p>
384
- */
385
- Id: string | undefined;
386
-
387
- /**
388
- * <p>The amount of time in nanoseconds that the statement ran.</p>
389
- */
390
- Duration?: number;
391
-
392
- /**
393
- * <p>The error message from the cluster if the SQL statement encountered an error while running.</p>
394
- */
395
- Error?: string;
396
-
397
- /**
398
- * <p>The status of the SQL statement. An
399
- * example is the that the SQL statement finished.
400
- * </p>
401
- */
402
- Status?: StatementStatusString | string;
403
-
404
- /**
405
- * <p>The date and time (UTC) the statement was created. </p>
406
- */
407
- CreatedAt?: Date;
408
-
409
- /**
410
- * <p>The date and time (UTC) that the statement metadata was last updated.</p>
411
- */
412
- UpdatedAt?: Date;
413
-
414
- /**
415
- * <p>The SQL statement text.</p>
416
- */
417
- QueryString?: string;
418
-
419
- /**
420
- * <p>Either the number of rows returned from the SQL statement or the number of rows affected.
421
- * If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
422
- * A <code>-1</code> indicates the value is null.</p>
423
- */
424
- ResultRows?: number;
425
-
426
- /**
427
- * <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
428
- */
429
- ResultSize?: number;
430
-
431
- /**
432
- * <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
433
- */
434
- RedshiftQueryId?: number;
435
-
436
- /**
437
- * <p>A value that indicates whether the statement has a result set. The result set can be empty.</p>
438
- */
439
- HasResultSet?: boolean;
440
- }
441
-
442
- export namespace SubStatementData {
443
- /**
444
- * @internal
445
- */
446
- export const filterSensitiveLog = (obj: SubStatementData): any => ({
447
- ...obj,
448
- });
449
- }
450
-
451
- export interface DescribeStatementResponse {
452
- /**
453
- * <p>The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
454
- */
455
- Id: string | undefined;
456
-
457
- /**
458
- * <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
459
- */
460
- SecretArn?: string;
461
-
462
- /**
463
- * <p>The database user name. </p>
464
- */
465
- DbUser?: string;
466
-
467
- /**
468
- * <p>The name of the database. </p>
469
- */
470
- Database?: string;
471
-
472
- /**
473
- * <p>The cluster identifier. </p>
474
- */
475
- ClusterIdentifier?: string;
476
-
477
- /**
478
- * <p>The amount of time in nanoseconds that the statement ran. </p>
479
- */
480
- Duration?: number;
481
-
482
- /**
483
- * <p>The error message from the cluster if the SQL statement encountered an error while running. </p>
484
- */
485
- Error?: string;
486
-
487
- /**
488
- * <p>The status of the SQL statement being described. Status values are defined as follows: </p>
489
- * <ul>
490
- * <li>
491
- * <p>ABORTED - The query run was stopped by the user. </p>
492
- * </li>
493
- * <li>
494
- * <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
495
- * </li>
496
- * <li>
497
- * <p>FAILED - The query run failed. </p>
498
- * </li>
499
- * <li>
500
- * <p>FINISHED - The query has finished running. </p>
501
- * </li>
502
- * <li>
503
- * <p>PICKED - The query has been chosen to be run. </p>
504
- * </li>
505
- * <li>
506
- * <p>STARTED - The query run has started. </p>
507
- * </li>
508
- * <li>
509
- * <p>SUBMITTED - The query was submitted, but not yet processed. </p>
510
- * </li>
511
- * </ul>
512
- */
513
- Status?: StatusString | string;
514
-
515
- /**
516
- * <p>The date and time (UTC) when the SQL statement was submitted to run. </p>
517
- */
518
- CreatedAt?: Date;
519
-
520
- /**
521
- * <p>The date and time (UTC) that the metadata for the SQL statement was last updated. An
522
- * example is the time the status last changed. </p>
523
- */
524
- UpdatedAt?: Date;
525
-
526
- /**
527
- * <p>The process identifier from Amazon Redshift. </p>
528
- */
529
- RedshiftPid?: number;
530
-
531
- /**
532
- * <p>A value that indicates whether the statement has a result set. The result set can be empty. </p>
533
- */
534
- HasResultSet?: boolean;
535
-
536
- /**
537
- * <p>The SQL statement text. </p>
538
- */
539
- QueryString?: string;
540
-
541
- /**
542
- * <p>Either the number of rows returned from the SQL statement or the number of rows affected.
543
- * If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.
544
- * A <code>-1</code> indicates the value is null.</p>
545
- */
546
- ResultRows?: number;
547
-
548
- /**
549
- * <p>The size in bytes of the returned results. A <code>-1</code> indicates the value is null.</p>
550
- */
551
- ResultSize?: number;
552
-
553
- /**
554
- * <p>The identifier of the query generated by Amazon Redshift.
555
- * These identifiers are also available in the <code>query</code> column of the <code>STL_QUERY</code> system view. </p>
556
- */
557
- RedshiftQueryId?: number;
558
-
559
- /**
560
- * <p>The parameters for the SQL statement.</p>
561
- */
562
- QueryParameters?: SqlParameter[];
563
-
564
- /**
565
- * <p>The SQL statements from a multiple statement run.</p>
566
- */
567
- SubStatements?: SubStatementData[];
568
- }
569
-
570
- export namespace DescribeStatementResponse {
571
- /**
572
- * @internal
573
- */
574
- export const filterSensitiveLog = (obj: DescribeStatementResponse): any => ({
575
- ...obj,
576
- });
577
- }
578
-
579
- export interface DescribeTableRequest {
580
- /**
581
- * <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
582
- */
583
- ClusterIdentifier: string | undefined;
584
-
585
- /**
586
- * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
587
- */
588
- SecretArn?: string;
589
-
590
- /**
591
- * <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
592
- */
593
- DbUser?: string;
594
-
595
- /**
596
- * <p>The name of the database that contains the tables to be described.
597
- * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
598
- */
599
- Database: string | undefined;
600
-
601
- /**
602
- * <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
603
- */
604
- ConnectedDatabase?: string;
605
-
606
- /**
607
- * <p>The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned. </p>
608
- */
609
- Schema?: string;
610
-
611
- /**
612
- * <p>The table name. If no table is specified, then all tables for all matching schemas are returned.
613
- * If no table and no schema is specified, then all tables for all schemas in the database are returned</p>
614
- */
615
- Table?: string;
616
-
617
- /**
618
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
619
- */
620
- NextToken?: string;
621
-
622
- /**
623
- * <p>The maximum number of tables to return in the response.
624
- * If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
625
- */
626
- MaxResults?: number;
627
- }
628
-
629
- export namespace DescribeTableRequest {
630
- /**
631
- * @internal
632
- */
633
- export const filterSensitiveLog = (obj: DescribeTableRequest): any => ({
634
- ...obj,
635
- });
636
- }
637
-
638
- export interface DescribeTableResponse {
639
- /**
640
- * <p>The table name. </p>
641
- */
642
- TableName?: string;
643
-
644
- /**
645
- * <p>A list of columns in the table. </p>
646
- */
647
- ColumnList?: ColumnMetadata[];
648
-
649
- /**
650
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
651
- */
652
- NextToken?: string;
653
- }
654
-
655
- export namespace DescribeTableResponse {
656
- /**
657
- * @internal
658
- */
659
- export const filterSensitiveLog = (obj: DescribeTableResponse): any => ({
660
- ...obj,
661
- });
662
- }
663
-
664
- /**
665
- * <p>The SQL statement encountered an environmental error while running.</p>
666
- */
667
- export interface ExecuteStatementException extends __SmithyException, $MetadataBearer {
668
- name: "ExecuteStatementException";
669
- $fault: "server";
670
- /**
671
- * <p>The exception message.</p>
672
- */
673
- Message: string | undefined;
674
-
675
- /**
676
- * <p>Statement identifier of the exception.</p>
677
- */
678
- StatementId: string | undefined;
679
- }
680
-
681
- export namespace ExecuteStatementException {
682
- /**
683
- * @internal
684
- */
685
- export const filterSensitiveLog = (obj: ExecuteStatementException): any => ({
686
- ...obj,
687
- });
688
- }
689
-
690
- export interface ExecuteStatementInput {
691
- /**
692
- * <p>The SQL statement text to run. </p>
693
- */
694
- Sql: string | undefined;
695
-
696
- /**
697
- * <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
698
- */
699
- ClusterIdentifier: string | undefined;
700
-
701
- /**
702
- * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
703
- */
704
- SecretArn?: string;
705
-
706
- /**
707
- * <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
708
- */
709
- DbUser?: string;
710
-
711
- /**
712
- * <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
713
- */
714
- Database: string | undefined;
715
-
716
- /**
717
- * <p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>
718
- */
719
- WithEvent?: boolean;
720
-
721
- /**
722
- * <p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>
723
- */
724
- StatementName?: string;
725
-
726
- /**
727
- * <p>The parameters for the SQL statement.</p>
728
- */
729
- Parameters?: SqlParameter[];
730
- }
731
-
732
- export namespace ExecuteStatementInput {
733
- /**
734
- * @internal
735
- */
736
- export const filterSensitiveLog = (obj: ExecuteStatementInput): any => ({
737
- ...obj,
738
- });
739
- }
740
-
741
- export interface ExecuteStatementOutput {
742
- /**
743
- * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
744
- */
745
- Id?: string;
746
-
747
- /**
748
- * <p>The date and time (UTC) the statement was created. </p>
749
- */
750
- CreatedAt?: Date;
751
-
752
- /**
753
- * <p>The cluster identifier. </p>
754
- */
755
- ClusterIdentifier?: string;
756
-
757
- /**
758
- * <p>The database user name.</p>
759
- */
760
- DbUser?: string;
761
-
762
- /**
763
- * <p>The name of the database.</p>
764
- */
765
- Database?: string;
766
-
767
- /**
768
- * <p>The name or ARN of the secret that enables access to the database. </p>
769
- */
770
- SecretArn?: string;
771
- }
772
-
773
- export namespace ExecuteStatementOutput {
774
- /**
775
- * @internal
776
- */
777
- export const filterSensitiveLog = (obj: ExecuteStatementOutput): any => ({
778
- ...obj,
779
- });
780
- }
781
-
782
- /**
783
- * <p>A data value in a column. </p>
784
- */
785
- export type Field =
786
- | Field.BlobValueMember
787
- | Field.BooleanValueMember
788
- | Field.DoubleValueMember
789
- | Field.IsNullMember
790
- | Field.LongValueMember
791
- | Field.StringValueMember
792
- | Field.$UnknownMember;
793
-
794
- export namespace Field {
795
- /**
796
- * <p>A value that indicates whether the data is NULL. </p>
797
- */
798
- export interface IsNullMember {
799
- isNull: boolean;
800
- booleanValue?: never;
801
- longValue?: never;
802
- doubleValue?: never;
803
- stringValue?: never;
804
- blobValue?: never;
805
- $unknown?: never;
806
- }
807
-
808
- /**
809
- * <p>A value of the Boolean data type. </p>
810
- */
811
- export interface BooleanValueMember {
812
- isNull?: never;
813
- booleanValue: boolean;
814
- longValue?: never;
815
- doubleValue?: never;
816
- stringValue?: never;
817
- blobValue?: never;
818
- $unknown?: never;
819
- }
820
-
821
- /**
822
- * <p>A value of the long data type. </p>
823
- */
824
- export interface LongValueMember {
825
- isNull?: never;
826
- booleanValue?: never;
827
- longValue: number;
828
- doubleValue?: never;
829
- stringValue?: never;
830
- blobValue?: never;
831
- $unknown?: never;
832
- }
833
-
834
- /**
835
- * <p>A value of the double data type. </p>
836
- */
837
- export interface DoubleValueMember {
838
- isNull?: never;
839
- booleanValue?: never;
840
- longValue?: never;
841
- doubleValue: number;
842
- stringValue?: never;
843
- blobValue?: never;
844
- $unknown?: never;
845
- }
846
-
847
- /**
848
- * <p>A value of the string data type. </p>
849
- */
850
- export interface StringValueMember {
851
- isNull?: never;
852
- booleanValue?: never;
853
- longValue?: never;
854
- doubleValue?: never;
855
- stringValue: string;
856
- blobValue?: never;
857
- $unknown?: never;
858
- }
859
-
860
- /**
861
- * <p>A value of the BLOB data type. </p>
862
- */
863
- export interface BlobValueMember {
864
- isNull?: never;
865
- booleanValue?: never;
866
- longValue?: never;
867
- doubleValue?: never;
868
- stringValue?: never;
869
- blobValue: Uint8Array;
870
- $unknown?: never;
871
- }
872
-
873
- export interface $UnknownMember {
874
- isNull?: never;
875
- booleanValue?: never;
876
- longValue?: never;
877
- doubleValue?: never;
878
- stringValue?: never;
879
- blobValue?: never;
880
- $unknown: [string, any];
881
- }
882
-
883
- export interface Visitor<T> {
884
- isNull: (value: boolean) => T;
885
- booleanValue: (value: boolean) => T;
886
- longValue: (value: number) => T;
887
- doubleValue: (value: number) => T;
888
- stringValue: (value: string) => T;
889
- blobValue: (value: Uint8Array) => T;
890
- _: (name: string, value: any) => T;
891
- }
892
-
893
- export const visit = <T>(value: Field, visitor: Visitor<T>): T => {
894
- if (value.isNull !== undefined) return visitor.isNull(value.isNull);
895
- if (value.booleanValue !== undefined) return visitor.booleanValue(value.booleanValue);
896
- if (value.longValue !== undefined) return visitor.longValue(value.longValue);
897
- if (value.doubleValue !== undefined) return visitor.doubleValue(value.doubleValue);
898
- if (value.stringValue !== undefined) return visitor.stringValue(value.stringValue);
899
- if (value.blobValue !== undefined) return visitor.blobValue(value.blobValue);
900
- return visitor._(value.$unknown[0], value.$unknown[1]);
901
- };
902
-
903
- /**
904
- * @internal
905
- */
906
- export const filterSensitiveLog = (obj: Field): any => {
907
- if (obj.isNull !== undefined) return { isNull: obj.isNull };
908
- if (obj.booleanValue !== undefined) return { booleanValue: obj.booleanValue };
909
- if (obj.longValue !== undefined) return { longValue: obj.longValue };
910
- if (obj.doubleValue !== undefined) return { doubleValue: obj.doubleValue };
911
- if (obj.stringValue !== undefined) return { stringValue: obj.stringValue };
912
- if (obj.blobValue !== undefined) return { blobValue: obj.blobValue };
913
- if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
914
- };
915
- }
916
-
917
- export interface GetStatementResultRequest {
918
- /**
919
- * <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
920
- * A suffix indicates then number of the SQL statement.
921
- * For example, <code>d9b6c0c9-0747-4bf4-b142-e8883122f766:2</code> has a suffix of <code>:2</code> that indicates the second SQL statement of a batch query.
922
- * This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>
923
- */
924
- Id: string | undefined;
925
-
926
- /**
927
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
928
- */
929
- NextToken?: string;
930
- }
931
-
932
- export namespace GetStatementResultRequest {
933
- /**
934
- * @internal
935
- */
936
- export const filterSensitiveLog = (obj: GetStatementResultRequest): any => ({
937
- ...obj,
938
- });
939
- }
940
-
941
- export interface GetStatementResultResponse {
942
- /**
943
- * <p>The results of the SQL statement.</p>
944
- */
945
- Records: Field[][] | undefined;
946
-
947
- /**
948
- * <p>The properties (metadata) of a column. </p>
949
- */
950
- ColumnMetadata?: ColumnMetadata[];
951
-
952
- /**
953
- * <p>The total number of rows in the result set returned from a query.
954
- * You can use this number to estimate the number of calls to the <code>GetStatementResult</code> operation needed to page through the results. </p>
955
- */
956
- TotalNumRows?: number;
957
-
958
- /**
959
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
960
- */
961
- NextToken?: string;
962
- }
963
-
964
- export namespace GetStatementResultResponse {
965
- /**
966
- * @internal
967
- */
968
- export const filterSensitiveLog = (obj: GetStatementResultResponse): any => ({
969
- ...obj,
970
- ...(obj.Records && { Records: obj.Records.map((item) => item.map((item) => Field.filterSensitiveLog(item))) }),
971
- });
972
- }
973
-
974
- export interface ListDatabasesRequest {
975
- /**
976
- * <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
977
- */
978
- ClusterIdentifier: string | undefined;
979
-
980
- /**
981
- * <p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
982
- */
983
- Database: string | undefined;
984
-
985
- /**
986
- * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
987
- */
988
- SecretArn?: string;
989
-
990
- /**
991
- * <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
992
- */
993
- DbUser?: string;
994
-
995
- /**
996
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
997
- */
998
- NextToken?: string;
999
-
1000
- /**
1001
- * <p>The maximum number of databases to return in the response.
1002
- * If more databases exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1003
- */
1004
- MaxResults?: number;
1005
- }
1006
-
1007
- export namespace ListDatabasesRequest {
1008
- /**
1009
- * @internal
1010
- */
1011
- export const filterSensitiveLog = (obj: ListDatabasesRequest): any => ({
1012
- ...obj,
1013
- });
1014
- }
1015
-
1016
- export interface ListDatabasesResponse {
1017
- /**
1018
- * <p>The names of databases. </p>
1019
- */
1020
- Databases?: string[];
1021
-
1022
- /**
1023
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1024
- */
1025
- NextToken?: string;
1026
- }
1027
-
1028
- export namespace ListDatabasesResponse {
1029
- /**
1030
- * @internal
1031
- */
1032
- export const filterSensitiveLog = (obj: ListDatabasesResponse): any => ({
1033
- ...obj,
1034
- });
1035
- }
1036
-
1037
- export interface ListSchemasRequest {
1038
- /**
1039
- * <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
1040
- */
1041
- ClusterIdentifier: string | undefined;
1042
-
1043
- /**
1044
- * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
1045
- */
1046
- SecretArn?: string;
1047
-
1048
- /**
1049
- * <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
1050
- */
1051
- DbUser?: string;
1052
-
1053
- /**
1054
- * <p>The name of the database that contains the schemas to list.
1055
- * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
1056
- */
1057
- Database: string | undefined;
1058
-
1059
- /**
1060
- * <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
1061
- */
1062
- ConnectedDatabase?: string;
1063
-
1064
- /**
1065
- * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
1066
- * substring of 0 or more characters and "_" means match any one character. Only schema name
1067
- * entries matching the search pattern are returned. </p>
1068
- */
1069
- SchemaPattern?: string;
1070
-
1071
- /**
1072
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1073
- */
1074
- NextToken?: string;
1075
-
1076
- /**
1077
- * <p>The maximum number of schemas to return in the response.
1078
- * If more schemas exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1079
- */
1080
- MaxResults?: number;
1081
- }
1082
-
1083
- export namespace ListSchemasRequest {
1084
- /**
1085
- * @internal
1086
- */
1087
- export const filterSensitiveLog = (obj: ListSchemasRequest): any => ({
1088
- ...obj,
1089
- });
1090
- }
1091
-
1092
- export interface ListSchemasResponse {
1093
- /**
1094
- * <p>The schemas that match the request pattern. </p>
1095
- */
1096
- Schemas?: string[];
1097
-
1098
- /**
1099
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1100
- */
1101
- NextToken?: string;
1102
- }
1103
-
1104
- export namespace ListSchemasResponse {
1105
- /**
1106
- * @internal
1107
- */
1108
- export const filterSensitiveLog = (obj: ListSchemasResponse): any => ({
1109
- ...obj,
1110
- });
1111
- }
1112
-
1113
- export interface ListStatementsRequest {
1114
- /**
1115
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1116
- */
1117
- NextToken?: string;
1118
-
1119
- /**
1120
- * <p>The maximum number of SQL statements to return in the response.
1121
- * If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1122
- */
1123
- MaxResults?: number;
1124
-
1125
- /**
1126
- * <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query.
1127
- * You can list multiple statements by providing a prefix that matches the beginning of the statement name.
1128
- * For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>.
1129
- * Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>
1130
- */
1131
- StatementName?: string;
1132
-
1133
- /**
1134
- * <p>The status of the SQL statement to list. Status values are defined as follows: </p>
1135
- * <ul>
1136
- * <li>
1137
- * <p>ABORTED - The query run was stopped by the user. </p>
1138
- * </li>
1139
- * <li>
1140
- * <p>ALL - A status value that includes all query statuses. This value can be used to filter results. </p>
1141
- * </li>
1142
- * <li>
1143
- * <p>FAILED - The query run failed. </p>
1144
- * </li>
1145
- * <li>
1146
- * <p>FINISHED - The query has finished running. </p>
1147
- * </li>
1148
- * <li>
1149
- * <p>PICKED - The query has been chosen to be run. </p>
1150
- * </li>
1151
- * <li>
1152
- * <p>STARTED - The query run has started. </p>
1153
- * </li>
1154
- * <li>
1155
- * <p>SUBMITTED - The query was submitted, but not yet processed. </p>
1156
- * </li>
1157
- * </ul>
1158
- */
1159
- Status?: StatusString | string;
1160
-
1161
- /**
1162
- * <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned.
1163
- * If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>
1164
- */
1165
- RoleLevel?: boolean;
1166
- }
1167
-
1168
- export namespace ListStatementsRequest {
1169
- /**
1170
- * @internal
1171
- */
1172
- export const filterSensitiveLog = (obj: ListStatementsRequest): any => ({
1173
- ...obj,
1174
- });
1175
- }
1176
-
1177
- /**
1178
- * <p>The SQL statement to run.</p>
1179
- */
1180
- export interface StatementData {
1181
- /**
1182
- * <p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>
1183
- */
1184
- Id: string | undefined;
1185
-
1186
- /**
1187
- * <p>The SQL statement.</p>
1188
- */
1189
- QueryString?: string;
1190
-
1191
- /**
1192
- * <p>One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.</p>
1193
- */
1194
- QueryStrings?: string[];
1195
-
1196
- /**
1197
- * <p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>
1198
- */
1199
- SecretArn?: string;
1200
-
1201
- /**
1202
- * <p>The status of the SQL statement. An
1203
- * example is the that the SQL statement finished.
1204
- * </p>
1205
- */
1206
- Status?: StatusString | string;
1207
-
1208
- /**
1209
- * <p>The name of the SQL statement. </p>
1210
- */
1211
- StatementName?: string;
1212
-
1213
- /**
1214
- * <p>The date and time (UTC) the statement was created. </p>
1215
- */
1216
- CreatedAt?: Date;
1217
-
1218
- /**
1219
- * <p>The date and time (UTC) that the statement metadata was last updated.</p>
1220
- */
1221
- UpdatedAt?: Date;
1222
-
1223
- /**
1224
- * <p>The parameters used in a SQL statement.</p>
1225
- */
1226
- QueryParameters?: SqlParameter[];
1227
-
1228
- /**
1229
- * <p>A value that indicates whether the statement is a batch query request.</p>
1230
- */
1231
- IsBatchStatement?: boolean;
1232
- }
1233
-
1234
- export namespace StatementData {
1235
- /**
1236
- * @internal
1237
- */
1238
- export const filterSensitiveLog = (obj: StatementData): any => ({
1239
- ...obj,
1240
- });
1241
- }
1242
-
1243
- export interface ListStatementsResponse {
1244
- /**
1245
- * <p>The SQL statements. </p>
1246
- */
1247
- Statements: StatementData[] | undefined;
1248
-
1249
- /**
1250
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1251
- */
1252
- NextToken?: string;
1253
- }
1254
-
1255
- export namespace ListStatementsResponse {
1256
- /**
1257
- * @internal
1258
- */
1259
- export const filterSensitiveLog = (obj: ListStatementsResponse): any => ({
1260
- ...obj,
1261
- });
1262
- }
1263
-
1264
- export interface ListTablesRequest {
1265
- /**
1266
- * <p>The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>
1267
- */
1268
- ClusterIdentifier: string | undefined;
1269
-
1270
- /**
1271
- * <p>The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager. </p>
1272
- */
1273
- SecretArn?: string;
1274
-
1275
- /**
1276
- * <p>The database user name. This parameter is required when authenticating using temporary credentials. </p>
1277
- */
1278
- DbUser?: string;
1279
-
1280
- /**
1281
- * <p>The name of the database that contains the tables to list.
1282
- * If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>
1283
- */
1284
- Database: string | undefined;
1285
-
1286
- /**
1287
- * <p>A database name. The connected database is specified when you connect with your authentication credentials. </p>
1288
- */
1289
- ConnectedDatabase?: string;
1290
-
1291
- /**
1292
- * <p>A pattern to filter results by schema name. Within a schema pattern, "%" means match any
1293
- * substring of 0 or more characters and "_" means match any one character. Only schema name
1294
- * entries matching the search pattern are returned. If <code>SchemaPattern</code> is not specified, then all tables that match
1295
- * <code>TablePattern</code> are returned.
1296
- * If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1297
- */
1298
- SchemaPattern?: string;
1299
-
1300
- /**
1301
- * <p>A pattern to filter results by table name. Within a table pattern, "%" means match any
1302
- * substring of 0 or more characters and "_" means match any one character. Only table name
1303
- * entries matching the search pattern are returned. If <code>TablePattern</code> is not specified, then all tables that match
1304
- * <code>SchemaPattern</code>are returned.
1305
- * If neither <code>SchemaPattern</code> or <code>TablePattern</code> are specified, then all tables are returned. </p>
1306
- */
1307
- TablePattern?: string;
1308
-
1309
- /**
1310
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1311
- */
1312
- NextToken?: string;
1313
-
1314
- /**
1315
- * <p>The maximum number of tables to return in the response.
1316
- * If more tables exist than fit in one response, then <code>NextToken</code> is returned to page through the results. </p>
1317
- */
1318
- MaxResults?: number;
1319
- }
1320
-
1321
- export namespace ListTablesRequest {
1322
- /**
1323
- * @internal
1324
- */
1325
- export const filterSensitiveLog = (obj: ListTablesRequest): any => ({
1326
- ...obj,
1327
- });
1328
- }
1329
-
1330
- /**
1331
- * <p>The properties of a table. </p>
1332
- */
1333
- export interface TableMember {
1334
- /**
1335
- * <p>The name of the table. </p>
1336
- */
1337
- name?: string;
1338
-
1339
- /**
1340
- * <p>The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL
1341
- * TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. </p>
1342
- */
1343
- type?: string;
1344
-
1345
- /**
1346
- * <p>The schema containing the table. </p>
1347
- */
1348
- schema?: string;
1349
- }
1350
-
1351
- export namespace TableMember {
1352
- /**
1353
- * @internal
1354
- */
1355
- export const filterSensitiveLog = (obj: TableMember): any => ({
1356
- ...obj,
1357
- });
1358
- }
1359
-
1360
- export interface ListTablesResponse {
1361
- /**
1362
- * <p>The tables that match the request pattern. </p>
1363
- */
1364
- Tables?: TableMember[];
1365
-
1366
- /**
1367
- * <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>
1368
- */
1369
- NextToken?: string;
1370
- }
1371
-
1372
- export namespace ListTablesResponse {
1373
- /**
1374
- * @internal
1375
- */
1376
- export const filterSensitiveLog = (obj: ListTablesResponse): any => ({
1377
- ...obj,
1378
- });
1379
- }