@aws-sdk/client-rds-data 3.477.0 → 3.479.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.
- package/README.md +15 -9
- package/dist-cjs/models/models_0.js +105 -1
- package/dist-cjs/protocols/Aws_restJson1.js +210 -0
- package/dist-es/models/models_0.js +96 -0
- package/dist-es/protocols/Aws_restJson1.js +211 -1
- package/dist-types/RDSData.d.ts +14 -8
- package/dist-types/RDSDataClient.d.ts +14 -8
- package/dist-types/commands/BatchExecuteStatementCommand.d.ts +38 -6
- package/dist-types/commands/BeginTransactionCommand.d.ts +37 -5
- package/dist-types/commands/CommitTransactionCommand.d.ts +35 -3
- package/dist-types/commands/ExecuteSqlCommand.d.ts +7 -7
- package/dist-types/commands/ExecuteStatementCommand.d.ts +51 -5
- package/dist-types/commands/RollbackTransactionCommand.d.ts +35 -3
- package/dist-types/index.d.ts +14 -8
- package/dist-types/models/models_0.d.ts +160 -45
- package/dist-types/ts3.4/models/models_0.d.ts +59 -0
- package/package.json +5 -5
|
@@ -26,10 +26,10 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
|
|
|
26
26
|
* @deprecated
|
|
27
27
|
*
|
|
28
28
|
* <p>Runs one or more SQL statements.</p>
|
|
29
|
-
*
|
|
30
|
-
* <p>This operation
|
|
31
|
-
*
|
|
32
|
-
*
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters,
|
|
31
|
+
* the operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p>
|
|
32
|
+
* </note>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -122,10 +122,10 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
|
|
|
122
122
|
* @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
|
|
123
123
|
*
|
|
124
124
|
* @throws {@link AccessDeniedException} (client fault)
|
|
125
|
-
* <p>You
|
|
125
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
126
126
|
*
|
|
127
127
|
* @throws {@link BadRequestException} (client fault)
|
|
128
|
-
* <p>There is an error in the call or in a SQL statement
|
|
128
|
+
* <p>There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)</p>
|
|
129
129
|
*
|
|
130
130
|
* @throws {@link ForbiddenException} (client fault)
|
|
131
131
|
* <p>There are insufficient privileges to make the call.</p>
|
|
@@ -134,7 +134,7 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
|
|
|
134
134
|
* <p>An internal error occurred.</p>
|
|
135
135
|
*
|
|
136
136
|
* @throws {@link ServiceUnavailableError} (server fault)
|
|
137
|
-
* <p>The service specified by the <code>resourceArn</code> parameter
|
|
137
|
+
* <p>The service specified by the <code>resourceArn</code> parameter isn't
|
|
138
138
|
* available.</p>
|
|
139
139
|
*
|
|
140
140
|
* @throws {@link RDSDataServiceException}
|
|
@@ -24,12 +24,12 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Runs a SQL statement against a database.</p>
|
|
27
|
-
*
|
|
27
|
+
* <note>
|
|
28
28
|
* <p>If a call isn't part of a transaction because it doesn't include the
|
|
29
29
|
* <code>transactionID</code> parameter, changes that result from the call are
|
|
30
30
|
* committed automatically.</p>
|
|
31
31
|
* <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>
|
|
32
|
-
*
|
|
32
|
+
* </note>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -188,24 +188,70 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
|
|
|
188
188
|
* @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
|
|
189
189
|
*
|
|
190
190
|
* @throws {@link AccessDeniedException} (client fault)
|
|
191
|
-
* <p>You
|
|
191
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
192
192
|
*
|
|
193
193
|
* @throws {@link BadRequestException} (client fault)
|
|
194
|
-
* <p>There is an error in the call or in a SQL statement
|
|
194
|
+
* <p>There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)</p>
|
|
195
|
+
*
|
|
196
|
+
* @throws {@link DatabaseErrorException} (client fault)
|
|
197
|
+
* <p>There was an error in processing the SQL statement.</p>
|
|
198
|
+
*
|
|
199
|
+
* @throws {@link DatabaseNotFoundException} (client fault)
|
|
200
|
+
* <p>The DB cluster doesn't have a DB instance.</p>
|
|
201
|
+
*
|
|
202
|
+
* @throws {@link DatabaseUnavailableException} (server fault)
|
|
203
|
+
* <p>The writer instance in the DB cluster isn't available.</p>
|
|
195
204
|
*
|
|
196
205
|
* @throws {@link ForbiddenException} (client fault)
|
|
197
206
|
* <p>There are insufficient privileges to make the call.</p>
|
|
198
207
|
*
|
|
208
|
+
* @throws {@link HttpEndpointNotEnabledException} (client fault)
|
|
209
|
+
* <p>The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.</p>
|
|
210
|
+
*
|
|
199
211
|
* @throws {@link InternalServerErrorException} (server fault)
|
|
200
212
|
* <p>An internal error occurred.</p>
|
|
201
213
|
*
|
|
214
|
+
* @throws {@link InvalidSecretException} (client fault)
|
|
215
|
+
* <p>The Secrets Manager secret used with the request isn't valid.</p>
|
|
216
|
+
*
|
|
217
|
+
* @throws {@link SecretsErrorException} (client fault)
|
|
218
|
+
* <p>There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:</p>
|
|
219
|
+
* <ul>
|
|
220
|
+
* <li>
|
|
221
|
+
* <p>RDS Data API timed out retrieving the secret.</p>
|
|
222
|
+
* </li>
|
|
223
|
+
* <li>
|
|
224
|
+
* <p>The secret provided wasn't found.</p>
|
|
225
|
+
* </li>
|
|
226
|
+
* <li>
|
|
227
|
+
* <p>The secret couldn't be decrypted.</p>
|
|
228
|
+
* </li>
|
|
229
|
+
* </ul>
|
|
230
|
+
*
|
|
202
231
|
* @throws {@link ServiceUnavailableError} (server fault)
|
|
203
|
-
* <p>The service specified by the <code>resourceArn</code> parameter
|
|
232
|
+
* <p>The service specified by the <code>resourceArn</code> parameter isn't
|
|
204
233
|
* available.</p>
|
|
205
234
|
*
|
|
206
235
|
* @throws {@link StatementTimeoutException} (client fault)
|
|
207
236
|
* <p>The execution of the SQL statement timed out.</p>
|
|
208
237
|
*
|
|
238
|
+
* @throws {@link TransactionNotFoundException} (client fault)
|
|
239
|
+
* <p>The transaction ID wasn't found.</p>
|
|
240
|
+
*
|
|
241
|
+
* @throws {@link UnsupportedResultException} (client fault)
|
|
242
|
+
* <p>There was a problem with the result because of one of the following conditions:</p>
|
|
243
|
+
* <ul>
|
|
244
|
+
* <li>
|
|
245
|
+
* <p>It contained an unsupported data type.</p>
|
|
246
|
+
* </li>
|
|
247
|
+
* <li>
|
|
248
|
+
* <p>It contained a multidimensional array.</p>
|
|
249
|
+
* </li>
|
|
250
|
+
* <li>
|
|
251
|
+
* <p>The size was too large.</p>
|
|
252
|
+
* </li>
|
|
253
|
+
* </ul>
|
|
254
|
+
*
|
|
209
255
|
* @throws {@link RDSDataServiceException}
|
|
210
256
|
* <p>Base exception class for all service exceptions from RDSData service.</p>
|
|
211
257
|
*
|
|
@@ -50,27 +50,59 @@ export interface RollbackTransactionCommandOutput extends RollbackTransactionRes
|
|
|
50
50
|
* @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
|
|
51
51
|
*
|
|
52
52
|
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
-
* <p>You
|
|
53
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link BadRequestException} (client fault)
|
|
56
|
-
* <p>There is an error in the call or in a SQL statement
|
|
56
|
+
* <p>There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link DatabaseErrorException} (client fault)
|
|
59
|
+
* <p>There was an error in processing the SQL statement.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link DatabaseNotFoundException} (client fault)
|
|
62
|
+
* <p>The DB cluster doesn't have a DB instance.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link DatabaseUnavailableException} (server fault)
|
|
65
|
+
* <p>The writer instance in the DB cluster isn't available.</p>
|
|
57
66
|
*
|
|
58
67
|
* @throws {@link ForbiddenException} (client fault)
|
|
59
68
|
* <p>There are insufficient privileges to make the call.</p>
|
|
60
69
|
*
|
|
70
|
+
* @throws {@link HttpEndpointNotEnabledException} (client fault)
|
|
71
|
+
* <p>The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.</p>
|
|
72
|
+
*
|
|
61
73
|
* @throws {@link InternalServerErrorException} (server fault)
|
|
62
74
|
* <p>An internal error occurred.</p>
|
|
63
75
|
*
|
|
76
|
+
* @throws {@link InvalidSecretException} (client fault)
|
|
77
|
+
* <p>The Secrets Manager secret used with the request isn't valid.</p>
|
|
78
|
+
*
|
|
64
79
|
* @throws {@link NotFoundException} (client fault)
|
|
65
80
|
* <p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>
|
|
66
81
|
*
|
|
82
|
+
* @throws {@link SecretsErrorException} (client fault)
|
|
83
|
+
* <p>There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:</p>
|
|
84
|
+
* <ul>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>RDS Data API timed out retrieving the secret.</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* <li>
|
|
89
|
+
* <p>The secret provided wasn't found.</p>
|
|
90
|
+
* </li>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>The secret couldn't be decrypted.</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* </ul>
|
|
95
|
+
*
|
|
67
96
|
* @throws {@link ServiceUnavailableError} (server fault)
|
|
68
|
-
* <p>The service specified by the <code>resourceArn</code> parameter
|
|
97
|
+
* <p>The service specified by the <code>resourceArn</code> parameter isn't
|
|
69
98
|
* available.</p>
|
|
70
99
|
*
|
|
71
100
|
* @throws {@link StatementTimeoutException} (client fault)
|
|
72
101
|
* <p>The execution of the SQL statement timed out.</p>
|
|
73
102
|
*
|
|
103
|
+
* @throws {@link TransactionNotFoundException} (client fault)
|
|
104
|
+
* <p>The transaction ID wasn't found.</p>
|
|
105
|
+
*
|
|
74
106
|
* @throws {@link RDSDataServiceException}
|
|
75
107
|
* <p>Base exception class for all service exceptions from RDSData service.</p>
|
|
76
108
|
*
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <fullname>
|
|
3
|
-
*
|
|
4
|
-
* statements, you
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
2
|
+
* <fullname>RDS Data API</fullname>
|
|
3
|
+
* <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these
|
|
4
|
+
* statements, you use the RDS Data API (Data API).</p>
|
|
5
|
+
* <p>Data API is available with the following types of Aurora databases:</p>
|
|
6
|
+
* <ul>
|
|
7
|
+
* <li>
|
|
8
|
+
* <p>Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned</p>
|
|
9
|
+
* </li>
|
|
10
|
+
* <li>
|
|
11
|
+
* <p>Aurora MySQL - Serverless v1 only</p>
|
|
12
|
+
* </li>
|
|
13
|
+
* </ul>
|
|
14
|
+
* <p>For more information about the Data API, see
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a>
|
|
10
16
|
* in the <i>Amazon Aurora User Guide</i>.</p>
|
|
11
17
|
*
|
|
12
18
|
* @packageDocumentation
|
|
@@ -2,7 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { RDSDataServiceException as __BaseException } from "./RDSDataServiceException";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
|
-
* <p>You
|
|
5
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -14,7 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* @public
|
|
17
|
-
* <p>There is an error in the call or in a SQL statement
|
|
17
|
+
* <p>There is an error in the call or in a SQL statement. (This error only appears in calls from Aurora Serverless v1 databases.)</p>
|
|
18
18
|
*/
|
|
19
19
|
export declare class BadRequestException extends __BaseException {
|
|
20
20
|
readonly name: "BadRequestException";
|
|
@@ -40,6 +40,42 @@ export declare const TypeHint: {
|
|
|
40
40
|
* @public
|
|
41
41
|
*/
|
|
42
42
|
export type TypeHint = (typeof TypeHint)[keyof typeof TypeHint];
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
* <p>There was an error in processing the SQL statement.</p>
|
|
46
|
+
*/
|
|
47
|
+
export declare class DatabaseErrorException extends __BaseException {
|
|
48
|
+
readonly name: "DatabaseErrorException";
|
|
49
|
+
readonly $fault: "client";
|
|
50
|
+
/**
|
|
51
|
+
* @internal
|
|
52
|
+
*/
|
|
53
|
+
constructor(opts: __ExceptionOptionType<DatabaseErrorException, __BaseException>);
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @public
|
|
57
|
+
* <p>The DB cluster doesn't have a DB instance.</p>
|
|
58
|
+
*/
|
|
59
|
+
export declare class DatabaseNotFoundException extends __BaseException {
|
|
60
|
+
readonly name: "DatabaseNotFoundException";
|
|
61
|
+
readonly $fault: "client";
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
constructor(opts: __ExceptionOptionType<DatabaseNotFoundException, __BaseException>);
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* @public
|
|
69
|
+
* <p>The writer instance in the DB cluster isn't available.</p>
|
|
70
|
+
*/
|
|
71
|
+
export declare class DatabaseUnavailableException extends __BaseException {
|
|
72
|
+
readonly name: "DatabaseUnavailableException";
|
|
73
|
+
readonly $fault: "server";
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
constructor(opts: __ExceptionOptionType<DatabaseUnavailableException, __BaseException>);
|
|
78
|
+
}
|
|
43
79
|
/**
|
|
44
80
|
* @public
|
|
45
81
|
* <p>There are insufficient privileges to make the call.</p>
|
|
@@ -52,6 +88,18 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
52
88
|
*/
|
|
53
89
|
constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
|
|
54
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
* <p>The HTTP endpoint for using RDS Data API isn't enabled for the DB cluster.</p>
|
|
94
|
+
*/
|
|
95
|
+
export declare class HttpEndpointNotEnabledException extends __BaseException {
|
|
96
|
+
readonly name: "HttpEndpointNotEnabledException";
|
|
97
|
+
readonly $fault: "client";
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
constructor(opts: __ExceptionOptionType<HttpEndpointNotEnabledException, __BaseException>);
|
|
102
|
+
}
|
|
55
103
|
/**
|
|
56
104
|
* @public
|
|
57
105
|
* <p>An internal error occurred.</p>
|
|
@@ -66,7 +114,42 @@ export declare class InternalServerErrorException extends __BaseException {
|
|
|
66
114
|
}
|
|
67
115
|
/**
|
|
68
116
|
* @public
|
|
69
|
-
* <p>The
|
|
117
|
+
* <p>The Secrets Manager secret used with the request isn't valid.</p>
|
|
118
|
+
*/
|
|
119
|
+
export declare class InvalidSecretException extends __BaseException {
|
|
120
|
+
readonly name: "InvalidSecretException";
|
|
121
|
+
readonly $fault: "client";
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
125
|
+
constructor(opts: __ExceptionOptionType<InvalidSecretException, __BaseException>);
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
* <p>There was a problem with the Secrets Manager secret used with the request, caused by one of the following conditions:</p>
|
|
130
|
+
* <ul>
|
|
131
|
+
* <li>
|
|
132
|
+
* <p>RDS Data API timed out retrieving the secret.</p>
|
|
133
|
+
* </li>
|
|
134
|
+
* <li>
|
|
135
|
+
* <p>The secret provided wasn't found.</p>
|
|
136
|
+
* </li>
|
|
137
|
+
* <li>
|
|
138
|
+
* <p>The secret couldn't be decrypted.</p>
|
|
139
|
+
* </li>
|
|
140
|
+
* </ul>
|
|
141
|
+
*/
|
|
142
|
+
export declare class SecretsErrorException extends __BaseException {
|
|
143
|
+
readonly name: "SecretsErrorException";
|
|
144
|
+
readonly $fault: "client";
|
|
145
|
+
/**
|
|
146
|
+
* @internal
|
|
147
|
+
*/
|
|
148
|
+
constructor(opts: __ExceptionOptionType<SecretsErrorException, __BaseException>);
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* <p>The service specified by the <code>resourceArn</code> parameter isn't
|
|
70
153
|
* available.</p>
|
|
71
154
|
*/
|
|
72
155
|
export declare class ServiceUnavailableError extends __BaseException {
|
|
@@ -94,6 +177,18 @@ export declare class StatementTimeoutException extends __BaseException {
|
|
|
94
177
|
*/
|
|
95
178
|
constructor(opts: __ExceptionOptionType<StatementTimeoutException, __BaseException>);
|
|
96
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
* <p>The transaction ID wasn't found.</p>
|
|
183
|
+
*/
|
|
184
|
+
export declare class TransactionNotFoundException extends __BaseException {
|
|
185
|
+
readonly name: "TransactionNotFoundException";
|
|
186
|
+
readonly $fault: "client";
|
|
187
|
+
/**
|
|
188
|
+
* @internal
|
|
189
|
+
*/
|
|
190
|
+
constructor(opts: __ExceptionOptionType<TransactionNotFoundException, __BaseException>);
|
|
191
|
+
}
|
|
97
192
|
/**
|
|
98
193
|
* @public
|
|
99
194
|
* <p>The request parameters represent the input of a request to start a SQL
|
|
@@ -280,13 +375,13 @@ export interface ExecuteSqlRequest {
|
|
|
280
375
|
* @public
|
|
281
376
|
* <p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password
|
|
282
377
|
* for the credentials in the secret.</p>
|
|
283
|
-
*
|
|
378
|
+
* <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
|
|
284
379
|
*/
|
|
285
380
|
awsSecretStoreArn: string | undefined;
|
|
286
381
|
/**
|
|
287
382
|
* @public
|
|
288
383
|
* <p>One or more SQL statements to run on the DB cluster.</p>
|
|
289
|
-
*
|
|
384
|
+
* <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL
|
|
290
385
|
* statement is permitted, including data definition, data manipulation, and commit
|
|
291
386
|
* statements. </p>
|
|
292
387
|
*/
|
|
@@ -354,10 +449,10 @@ export interface ResultSetOptions {
|
|
|
354
449
|
* it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code>
|
|
355
450
|
* specifies that it is converted to a Long value if its scale is 0, or to a Double
|
|
356
451
|
* value otherwise.</p>
|
|
357
|
-
*
|
|
452
|
+
* <note>
|
|
358
453
|
* <p>Conversion to Double or Long can result in roundoff errors due to precision loss.
|
|
359
454
|
* We recommend converting to String, especially when working with currency values.</p>
|
|
360
|
-
*
|
|
455
|
+
* </note>
|
|
361
456
|
*/
|
|
362
457
|
decimalReturnType?: DecimalReturnType;
|
|
363
458
|
/**
|
|
@@ -370,6 +465,29 @@ export interface ResultSetOptions {
|
|
|
370
465
|
*/
|
|
371
466
|
longReturnType?: LongReturnType;
|
|
372
467
|
}
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
* <p>There was a problem with the result because of one of the following conditions:</p>
|
|
471
|
+
* <ul>
|
|
472
|
+
* <li>
|
|
473
|
+
* <p>It contained an unsupported data type.</p>
|
|
474
|
+
* </li>
|
|
475
|
+
* <li>
|
|
476
|
+
* <p>It contained a multidimensional array.</p>
|
|
477
|
+
* </li>
|
|
478
|
+
* <li>
|
|
479
|
+
* <p>The size was too large.</p>
|
|
480
|
+
* </li>
|
|
481
|
+
* </ul>
|
|
482
|
+
*/
|
|
483
|
+
export declare class UnsupportedResultException extends __BaseException {
|
|
484
|
+
readonly name: "UnsupportedResultException";
|
|
485
|
+
readonly $fault: "client";
|
|
486
|
+
/**
|
|
487
|
+
* @internal
|
|
488
|
+
*/
|
|
489
|
+
constructor(opts: __ExceptionOptionType<UnsupportedResultException, __BaseException>);
|
|
490
|
+
}
|
|
373
491
|
/**
|
|
374
492
|
* @public
|
|
375
493
|
* <p>The request parameters represent the input of a request to perform a rollback of a
|
|
@@ -645,14 +763,14 @@ export interface SqlParameter {
|
|
|
645
763
|
* @public
|
|
646
764
|
* <p>A hint that specifies the correct object type for data type mapping. Possible values
|
|
647
765
|
* are as follows:</p>
|
|
648
|
-
*
|
|
766
|
+
* <ul>
|
|
649
767
|
* <li>
|
|
650
768
|
* <p>
|
|
651
769
|
* <code>DATE</code> - The corresponding <code>String</code> parameter value is sent as an object
|
|
652
770
|
* of <code>DATE</code> type to the database. The accepted format is <code>YYYY-MM-DD</code>.</p>
|
|
653
771
|
* </li>
|
|
654
772
|
* <li>
|
|
655
|
-
*
|
|
773
|
+
* <p>
|
|
656
774
|
* <code>DECIMAL</code> - The corresponding <code>String</code> parameter value is sent as an object
|
|
657
775
|
* of <code>DECIMAL</code> type to the database.</p>
|
|
658
776
|
* </li>
|
|
@@ -662,7 +780,7 @@ export interface SqlParameter {
|
|
|
662
780
|
* object of <code>JSON</code> type to the database.</p>
|
|
663
781
|
* </li>
|
|
664
782
|
* <li>
|
|
665
|
-
*
|
|
783
|
+
* <p>
|
|
666
784
|
* <code>TIME</code> - The corresponding <code>String</code> parameter value is sent as an object
|
|
667
785
|
* of <code>TIME</code> type to the database. The accepted format is <code>HH:MM:SS[.FFF]</code>.</p>
|
|
668
786
|
* </li>
|
|
@@ -695,11 +813,10 @@ export interface UpdateResult {
|
|
|
695
813
|
/**
|
|
696
814
|
* @public
|
|
697
815
|
* <p>Contains the value of a column.</p>
|
|
698
|
-
*
|
|
699
|
-
* <note>
|
|
816
|
+
* <note>
|
|
700
817
|
* <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
|
|
701
818
|
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
|
|
702
|
-
*
|
|
819
|
+
* </note>
|
|
703
820
|
*/
|
|
704
821
|
export type Value = Value.ArrayValuesMember | Value.BigIntValueMember | Value.BitValueMember | Value.BlobValueMember | Value.DoubleValueMember | Value.IntValueMember | Value.IsNullMember | Value.RealValueMember | Value.StringValueMember | Value.StructValueMember | Value.$UnknownMember;
|
|
705
822
|
/**
|
|
@@ -922,7 +1039,7 @@ export interface ExecuteStatementRequest {
|
|
|
922
1039
|
* @public
|
|
923
1040
|
* <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
|
|
924
1041
|
* the secret.</p>
|
|
925
|
-
*
|
|
1042
|
+
* <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
|
|
926
1043
|
*/
|
|
927
1044
|
secretArn: string | undefined;
|
|
928
1045
|
/**
|
|
@@ -938,17 +1055,17 @@ export interface ExecuteStatementRequest {
|
|
|
938
1055
|
/**
|
|
939
1056
|
* @public
|
|
940
1057
|
* <p>The name of the database schema.</p>
|
|
941
|
-
*
|
|
1058
|
+
* <note>
|
|
942
1059
|
* <p>Currently, the <code>schema</code> parameter isn't supported.</p>
|
|
943
|
-
*
|
|
1060
|
+
* </note>
|
|
944
1061
|
*/
|
|
945
1062
|
schema?: string;
|
|
946
1063
|
/**
|
|
947
1064
|
* @public
|
|
948
1065
|
* <p>The parameters for the SQL statement.</p>
|
|
949
|
-
*
|
|
1066
|
+
* <note>
|
|
950
1067
|
* <p>Array parameters are not supported.</p>
|
|
951
|
-
*
|
|
1068
|
+
* </note>
|
|
952
1069
|
*/
|
|
953
1070
|
parameters?: SqlParameter[];
|
|
954
1071
|
/**
|
|
@@ -956,7 +1073,7 @@ export interface ExecuteStatementRequest {
|
|
|
956
1073
|
* <p>The identifier of a transaction that was started by using the
|
|
957
1074
|
* <code>BeginTransaction</code> operation. Specify the transaction ID of the
|
|
958
1075
|
* transaction that you want to include the SQL statement in.</p>
|
|
959
|
-
*
|
|
1076
|
+
* <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>
|
|
960
1077
|
*/
|
|
961
1078
|
transactionId?: string;
|
|
962
1079
|
/**
|
|
@@ -969,11 +1086,11 @@ export interface ExecuteStatementRequest {
|
|
|
969
1086
|
* <p>A value that indicates whether to continue running the statement after
|
|
970
1087
|
* the call times out. By default, the statement stops running when the call
|
|
971
1088
|
* times out.</p>
|
|
972
|
-
*
|
|
1089
|
+
* <note>
|
|
973
1090
|
* <p>For DDL statements, we recommend continuing to run the statement after
|
|
974
1091
|
* the call times out. When a DDL statement terminates before it is finished
|
|
975
1092
|
* running, it can result in errors and possibly corrupted data structures.</p>
|
|
976
|
-
*
|
|
1093
|
+
* </note>
|
|
977
1094
|
*/
|
|
978
1095
|
continueAfterTimeout?: boolean;
|
|
979
1096
|
/**
|
|
@@ -987,7 +1104,7 @@ export interface ExecuteStatementRequest {
|
|
|
987
1104
|
* This parameter only applies to <code>SELECT</code> statements and is ignored for
|
|
988
1105
|
* other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>.
|
|
989
1106
|
* The default value is <code>NONE</code>. The result is returned in the <code>formattedRecords</code> field.</p>
|
|
990
|
-
*
|
|
1107
|
+
* <p>For usage information about the JSON format for result sets, see
|
|
991
1108
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using the Data API</a>
|
|
992
1109
|
* in the <i>Amazon Aurora User Guide</i>.</p>
|
|
993
1110
|
*/
|
|
@@ -996,10 +1113,10 @@ export interface ExecuteStatementRequest {
|
|
|
996
1113
|
/**
|
|
997
1114
|
* @public
|
|
998
1115
|
* <p>A structure value returned by a call.</p>
|
|
999
|
-
*
|
|
1116
|
+
* <note>
|
|
1000
1117
|
* <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
|
|
1001
1118
|
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
|
|
1002
|
-
*
|
|
1119
|
+
* </note>
|
|
1003
1120
|
*/
|
|
1004
1121
|
export interface StructValue {
|
|
1005
1122
|
/**
|
|
@@ -1023,7 +1140,7 @@ export interface BatchExecuteStatementRequest {
|
|
|
1023
1140
|
* @public
|
|
1024
1141
|
* <p>The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in
|
|
1025
1142
|
* the secret.</p>
|
|
1026
|
-
*
|
|
1143
|
+
* <p>For information about creating the secret, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html">Create a database secret</a>.</p>
|
|
1027
1144
|
*/
|
|
1028
1145
|
secretArn: string | undefined;
|
|
1029
1146
|
/**
|
|
@@ -1039,27 +1156,27 @@ export interface BatchExecuteStatementRequest {
|
|
|
1039
1156
|
/**
|
|
1040
1157
|
* @public
|
|
1041
1158
|
* <p>The name of the database schema.</p>
|
|
1042
|
-
*
|
|
1159
|
+
* <note>
|
|
1043
1160
|
* <p>Currently, the <code>schema</code> parameter isn't supported.</p>
|
|
1044
|
-
*
|
|
1161
|
+
* </note>
|
|
1045
1162
|
*/
|
|
1046
1163
|
schema?: string;
|
|
1047
1164
|
/**
|
|
1048
1165
|
* @public
|
|
1049
1166
|
* <p>The parameter set for the batch operation.</p>
|
|
1050
|
-
*
|
|
1167
|
+
* <p>The SQL statement is executed as many times as the number of parameter sets provided.
|
|
1051
1168
|
* To execute a SQL statement with no parameters, use one of the following options:</p>
|
|
1052
|
-
*
|
|
1169
|
+
* <ul>
|
|
1053
1170
|
* <li>
|
|
1054
|
-
*
|
|
1171
|
+
* <p>Specify one or more empty parameter sets.</p>
|
|
1055
1172
|
* </li>
|
|
1056
1173
|
* <li>
|
|
1057
|
-
*
|
|
1174
|
+
* <p>Use the <code>ExecuteStatement</code> operation instead of the <code>BatchExecuteStatement</code> operation.</p>
|
|
1058
1175
|
* </li>
|
|
1059
1176
|
* </ul>
|
|
1060
|
-
*
|
|
1177
|
+
* <note>
|
|
1061
1178
|
* <p>Array parameters are not supported.</p>
|
|
1062
|
-
*
|
|
1179
|
+
* </note>
|
|
1063
1180
|
*/
|
|
1064
1181
|
parameterSets?: SqlParameter[][];
|
|
1065
1182
|
/**
|
|
@@ -1067,7 +1184,7 @@ export interface BatchExecuteStatementRequest {
|
|
|
1067
1184
|
* <p>The identifier of a transaction that was started by using the
|
|
1068
1185
|
* <code>BeginTransaction</code> operation. Specify the transaction ID of the
|
|
1069
1186
|
* transaction that you want to include the SQL statement in.</p>
|
|
1070
|
-
*
|
|
1187
|
+
* <p>If the SQL statement is not part of a transaction, don't set this
|
|
1071
1188
|
* parameter.</p>
|
|
1072
1189
|
*/
|
|
1073
1190
|
transactionId?: string;
|
|
@@ -1087,10 +1204,10 @@ export interface BatchExecuteStatementResponse {
|
|
|
1087
1204
|
/**
|
|
1088
1205
|
* @public
|
|
1089
1206
|
* <p>A record returned by a call.</p>
|
|
1090
|
-
*
|
|
1207
|
+
* <note>
|
|
1091
1208
|
* <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
|
|
1092
1209
|
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
|
|
1093
|
-
*
|
|
1210
|
+
* </note>
|
|
1094
1211
|
*/
|
|
1095
1212
|
export interface _Record {
|
|
1096
1213
|
/**
|
|
@@ -1125,13 +1242,12 @@ export interface ExecuteStatementResponse {
|
|
|
1125
1242
|
/**
|
|
1126
1243
|
* @public
|
|
1127
1244
|
* <p>Values for fields generated during a DML request.</p>
|
|
1128
|
-
*
|
|
1129
|
-
* <note>
|
|
1245
|
+
* <note>
|
|
1130
1246
|
* <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL.
|
|
1131
1247
|
* To get the values of generated fields, use the <code>RETURNING</code> clause. For
|
|
1132
1248
|
* more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From
|
|
1133
1249
|
* Modified Rows</a> in the PostgreSQL documentation.</p>
|
|
1134
|
-
*
|
|
1250
|
+
* </note>
|
|
1135
1251
|
*/
|
|
1136
1252
|
generatedFields?: Field[];
|
|
1137
1253
|
/**
|
|
@@ -1139,7 +1255,7 @@ export interface ExecuteStatementResponse {
|
|
|
1139
1255
|
* <p>A string value that represents the result set of a <code>SELECT</code> statement
|
|
1140
1256
|
* in JSON format. This value is only present when the <code>formatRecordsAs</code>
|
|
1141
1257
|
* parameter is set to <code>JSON</code>.</p>
|
|
1142
|
-
*
|
|
1258
|
+
* <p>The size limit for this field is currently 10 MB. If the JSON-formatted string representing the
|
|
1143
1259
|
* result set requires more than 10 MB, the call returns an error.</p>
|
|
1144
1260
|
*/
|
|
1145
1261
|
formattedRecords?: string;
|
|
@@ -1147,10 +1263,10 @@ export interface ExecuteStatementResponse {
|
|
|
1147
1263
|
/**
|
|
1148
1264
|
* @public
|
|
1149
1265
|
* <p>The result set returned by a SQL statement.</p>
|
|
1150
|
-
*
|
|
1266
|
+
* <note>
|
|
1151
1267
|
* <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
|
|
1152
1268
|
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
|
|
1153
|
-
*
|
|
1269
|
+
* </note>
|
|
1154
1270
|
*/
|
|
1155
1271
|
export interface ResultFrame {
|
|
1156
1272
|
/**
|
|
@@ -1167,11 +1283,10 @@ export interface ResultFrame {
|
|
|
1167
1283
|
/**
|
|
1168
1284
|
* @public
|
|
1169
1285
|
* <p>The result of a SQL statement.</p>
|
|
1170
|
-
*
|
|
1171
|
-
* <note>
|
|
1286
|
+
* <note>
|
|
1172
1287
|
* <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
|
|
1173
1288
|
* Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>
|
|
1174
|
-
*
|
|
1289
|
+
* </note>
|
|
1175
1290
|
*/
|
|
1176
1291
|
export interface SqlStatementResult {
|
|
1177
1292
|
/**
|