@aws-sdk/client-rds-data 3.296.0 → 3.298.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.
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { RDSDataServiceException as __BaseException } from "./RDSDataServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have sufficient access to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
14
15
  /**
16
+ * @public
15
17
  * <p>There is an error in the call or in a SQL statement.</p>
16
18
  */
17
19
  export declare class BadRequestException extends __BaseException {
@@ -22,6 +24,9 @@ export declare class BadRequestException extends __BaseException {
22
24
  */
23
25
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
24
26
  }
27
+ /**
28
+ * @public
29
+ */
25
30
  export declare enum TypeHint {
26
31
  DATE = "DATE",
27
32
  DECIMAL = "DECIMAL",
@@ -31,6 +36,7 @@ export declare enum TypeHint {
31
36
  UUID = "UUID"
32
37
  }
33
38
  /**
39
+ * @public
34
40
  * <p>There are insufficient privileges to make the call.</p>
35
41
  */
36
42
  export declare class ForbiddenException extends __BaseException {
@@ -42,6 +48,7 @@ export declare class ForbiddenException extends __BaseException {
42
48
  constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
43
49
  }
44
50
  /**
51
+ * @public
45
52
  * <p>An internal error occurred.</p>
46
53
  */
47
54
  export declare class InternalServerErrorException extends __BaseException {
@@ -53,6 +60,7 @@ export declare class InternalServerErrorException extends __BaseException {
53
60
  constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>);
54
61
  }
55
62
  /**
63
+ * @public
56
64
  * <p>The service specified by the <code>resourceArn</code> parameter is not
57
65
  * available.</p>
58
66
  */
@@ -65,6 +73,7 @@ export declare class ServiceUnavailableError extends __BaseException {
65
73
  constructor(opts: __ExceptionOptionType<ServiceUnavailableError, __BaseException>);
66
74
  }
67
75
  /**
76
+ * @public
68
77
  * <p>The execution of the SQL statement timed out.</p>
69
78
  */
70
79
  export declare class StatementTimeoutException extends __BaseException {
@@ -80,6 +89,7 @@ export declare class StatementTimeoutException extends __BaseException {
80
89
  constructor(opts: __ExceptionOptionType<StatementTimeoutException, __BaseException>);
81
90
  }
82
91
  /**
92
+ * @public
83
93
  * <p>The request parameters represent the input of a request to start a SQL
84
94
  * transaction.</p>
85
95
  */
@@ -102,6 +112,7 @@ export interface BeginTransactionRequest {
102
112
  schema?: string;
103
113
  }
104
114
  /**
115
+ * @public
105
116
  * <p>The response elements represent the output of a request to start a SQL
106
117
  * transaction.</p>
107
118
  */
@@ -112,6 +123,7 @@ export interface BeginTransactionResponse {
112
123
  transactionId?: string;
113
124
  }
114
125
  /**
126
+ * @public
115
127
  * <p>Contains the metadata for a column.</p>
116
128
  */
117
129
  export interface ColumnMetadata {
@@ -173,6 +185,7 @@ export interface ColumnMetadata {
173
185
  arrayBaseColumnType?: number;
174
186
  }
175
187
  /**
188
+ * @public
176
189
  * <p>The request parameters represent the input of a commit transaction request.</p>
177
190
  */
178
191
  export interface CommitTransactionRequest {
@@ -190,6 +203,7 @@ export interface CommitTransactionRequest {
190
203
  transactionId: string | undefined;
191
204
  }
192
205
  /**
206
+ * @public
193
207
  * <p>The response elements represent the output of a commit transaction request.</p>
194
208
  */
195
209
  export interface CommitTransactionResponse {
@@ -199,6 +213,7 @@ export interface CommitTransactionResponse {
199
213
  transactionStatus?: string;
200
214
  }
201
215
  /**
216
+ * @public
202
217
  * <p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>
203
218
  */
204
219
  export declare class NotFoundException extends __BaseException {
@@ -209,11 +224,15 @@ export declare class NotFoundException extends __BaseException {
209
224
  */
210
225
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
211
226
  }
227
+ /**
228
+ * @public
229
+ */
212
230
  export declare enum DecimalReturnType {
213
231
  DOUBLE_OR_LONG = "DOUBLE_OR_LONG",
214
232
  STRING = "STRING"
215
233
  }
216
234
  /**
235
+ * @public
217
236
  * <p>The request parameters represent the input of a request to run one or more SQL
218
237
  * statements.</p>
219
238
  */
@@ -245,6 +264,7 @@ export interface ExecuteSqlRequest {
245
264
  schema?: string;
246
265
  }
247
266
  /**
267
+ * @public
248
268
  * <p>The metadata of the result set returned by a SQL statement.</p>
249
269
  */
250
270
  export interface ResultSetMetadata {
@@ -257,15 +277,22 @@ export interface ResultSetMetadata {
257
277
  */
258
278
  columnMetadata?: ColumnMetadata[];
259
279
  }
280
+ /**
281
+ * @public
282
+ */
260
283
  export declare enum RecordsFormatType {
261
284
  JSON = "JSON",
262
285
  NONE = "NONE"
263
286
  }
287
+ /**
288
+ * @public
289
+ */
264
290
  export declare enum LongReturnType {
265
291
  LONG = "LONG",
266
292
  STRING = "STRING"
267
293
  }
268
294
  /**
295
+ * @public
269
296
  * <p>Options that control how the result set is returned.</p>
270
297
  */
271
298
  export interface ResultSetOptions {
@@ -291,6 +318,7 @@ export interface ResultSetOptions {
291
318
  longReturnType?: LongReturnType | string;
292
319
  }
293
320
  /**
321
+ * @public
294
322
  * <p>The request parameters represent the input of a request to perform a rollback of a
295
323
  * transaction.</p>
296
324
  */
@@ -309,6 +337,7 @@ export interface RollbackTransactionRequest {
309
337
  transactionId: string | undefined;
310
338
  }
311
339
  /**
340
+ * @public
312
341
  * <p>The response elements represent the output of a request to perform a rollback of a
313
342
  * transaction.</p>
314
343
  */
@@ -319,9 +348,13 @@ export interface RollbackTransactionResponse {
319
348
  transactionStatus?: string;
320
349
  }
321
350
  /**
351
+ * @public
322
352
  * <p>Contains an array.</p>
323
353
  */
324
354
  export type ArrayValue = ArrayValue.ArrayValuesMember | ArrayValue.BooleanValuesMember | ArrayValue.DoubleValuesMember | ArrayValue.LongValuesMember | ArrayValue.StringValuesMember | ArrayValue.$UnknownMember;
355
+ /**
356
+ * @public
357
+ */
325
358
  export declare namespace ArrayValue {
326
359
  /**
327
360
  * <p>An array of Boolean values.</p>
@@ -397,9 +430,13 @@ export declare namespace ArrayValue {
397
430
  const visit: <T>(value: ArrayValue, visitor: Visitor<T>) => T;
398
431
  }
399
432
  /**
433
+ * @public
400
434
  * <p>Contains a value.</p>
401
435
  */
402
436
  export type Field = Field.ArrayValueMember | Field.BlobValueMember | Field.BooleanValueMember | Field.DoubleValueMember | Field.IsNullMember | Field.LongValueMember | Field.StringValueMember | Field.$UnknownMember;
437
+ /**
438
+ * @public
439
+ */
403
440
  export declare namespace Field {
404
441
  /**
405
442
  * <p>A NULL value.</p>
@@ -515,6 +552,7 @@ export declare namespace Field {
515
552
  const visit: <T>(value: Field, visitor: Visitor<T>) => T;
516
553
  }
517
554
  /**
555
+ * @public
518
556
  * <p>A parameter used in a SQL statement.</p>
519
557
  */
520
558
  export interface SqlParameter {
@@ -566,6 +604,7 @@ export interface SqlParameter {
566
604
  typeHint?: TypeHint | string;
567
605
  }
568
606
  /**
607
+ * @public
569
608
  * <p>The response elements represent the results of an update.</p>
570
609
  */
571
610
  export interface UpdateResult {
@@ -575,6 +614,7 @@ export interface UpdateResult {
575
614
  generatedFields?: Field[];
576
615
  }
577
616
  /**
617
+ * @public
578
618
  * <p>Contains the value of a column.</p>
579
619
  *
580
620
  * <note>
@@ -583,6 +623,9 @@ export interface UpdateResult {
583
623
  * </note>
584
624
  */
585
625
  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;
626
+ /**
627
+ * @public
628
+ */
586
629
  export declare namespace Value {
587
630
  /**
588
631
  * <p>A NULL value.</p>
@@ -773,6 +816,7 @@ export declare namespace Value {
773
816
  const visit: <T>(value: Value, visitor: Visitor<T>) => T;
774
817
  }
775
818
  /**
819
+ * @public
776
820
  * <p>The request parameters represent the input of a request to run a SQL statement against
777
821
  * a database.</p>
778
822
  */
@@ -847,6 +891,7 @@ export interface ExecuteStatementRequest {
847
891
  formatRecordsAs?: RecordsFormatType | string;
848
892
  }
849
893
  /**
894
+ * @public
850
895
  * <p>A structure value returned by a call.</p>
851
896
  * <note>
852
897
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
@@ -860,6 +905,7 @@ export interface StructValue {
860
905
  attributes?: Value[];
861
906
  }
862
907
  /**
908
+ * @public
863
909
  * <p>The request parameters represent the input of a SQL statement over an array of
864
910
  * data.</p>
865
911
  */
@@ -916,6 +962,7 @@ export interface BatchExecuteStatementRequest {
916
962
  transactionId?: string;
917
963
  }
918
964
  /**
965
+ * @public
919
966
  * <p>The response elements represent the output of a SQL statement over an array of
920
967
  * data.</p>
921
968
  */
@@ -926,6 +973,7 @@ export interface BatchExecuteStatementResponse {
926
973
  updateResults?: UpdateResult[];
927
974
  }
928
975
  /**
976
+ * @public
929
977
  * <p>A record returned by a call.</p>
930
978
  * <note>
931
979
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
@@ -939,6 +987,7 @@ export interface _Record {
939
987
  values?: Value[];
940
988
  }
941
989
  /**
990
+ * @public
942
991
  * <p>The response elements represent the output of a request to run a SQL statement against
943
992
  * a database.</p>
944
993
  */
@@ -978,6 +1027,7 @@ export interface ExecuteStatementResponse {
978
1027
  formattedRecords?: string;
979
1028
  }
980
1029
  /**
1030
+ * @public
981
1031
  * <p>The result set returned by a SQL statement.</p>
982
1032
  * <note>
983
1033
  * <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.
@@ -995,6 +1045,7 @@ export interface ResultFrame {
995
1045
  records?: _Record[];
996
1046
  }
997
1047
  /**
1048
+ * @public
998
1049
  * <p>The result of a SQL statement.</p>
999
1050
  *
1000
1051
  * <note>
@@ -1013,6 +1064,7 @@ export interface SqlStatementResult {
1013
1064
  numberOfRecordsUpdated?: number;
1014
1065
  }
1015
1066
  /**
1067
+ * @public
1016
1068
  * <p>The response elements represent the output of a request to run one or more SQL
1017
1069
  * statements.</p>
1018
1070
  */
@@ -1022,99 +1074,3 @@ export interface ExecuteSqlResponse {
1022
1074
  */
1023
1075
  sqlStatementResults?: SqlStatementResult[];
1024
1076
  }
1025
- /**
1026
- * @internal
1027
- */
1028
- export declare const BeginTransactionRequestFilterSensitiveLog: (obj: BeginTransactionRequest) => any;
1029
- /**
1030
- * @internal
1031
- */
1032
- export declare const BeginTransactionResponseFilterSensitiveLog: (obj: BeginTransactionResponse) => any;
1033
- /**
1034
- * @internal
1035
- */
1036
- export declare const ColumnMetadataFilterSensitiveLog: (obj: ColumnMetadata) => any;
1037
- /**
1038
- * @internal
1039
- */
1040
- export declare const CommitTransactionRequestFilterSensitiveLog: (obj: CommitTransactionRequest) => any;
1041
- /**
1042
- * @internal
1043
- */
1044
- export declare const CommitTransactionResponseFilterSensitiveLog: (obj: CommitTransactionResponse) => any;
1045
- /**
1046
- * @internal
1047
- */
1048
- export declare const ExecuteSqlRequestFilterSensitiveLog: (obj: ExecuteSqlRequest) => any;
1049
- /**
1050
- * @internal
1051
- */
1052
- export declare const ResultSetMetadataFilterSensitiveLog: (obj: ResultSetMetadata) => any;
1053
- /**
1054
- * @internal
1055
- */
1056
- export declare const ResultSetOptionsFilterSensitiveLog: (obj: ResultSetOptions) => any;
1057
- /**
1058
- * @internal
1059
- */
1060
- export declare const RollbackTransactionRequestFilterSensitiveLog: (obj: RollbackTransactionRequest) => any;
1061
- /**
1062
- * @internal
1063
- */
1064
- export declare const RollbackTransactionResponseFilterSensitiveLog: (obj: RollbackTransactionResponse) => any;
1065
- /**
1066
- * @internal
1067
- */
1068
- export declare const ArrayValueFilterSensitiveLog: (obj: ArrayValue) => any;
1069
- /**
1070
- * @internal
1071
- */
1072
- export declare const FieldFilterSensitiveLog: (obj: Field) => any;
1073
- /**
1074
- * @internal
1075
- */
1076
- export declare const SqlParameterFilterSensitiveLog: (obj: SqlParameter) => any;
1077
- /**
1078
- * @internal
1079
- */
1080
- export declare const UpdateResultFilterSensitiveLog: (obj: UpdateResult) => any;
1081
- /**
1082
- * @internal
1083
- */
1084
- export declare const ValueFilterSensitiveLog: (obj: Value) => any;
1085
- /**
1086
- * @internal
1087
- */
1088
- export declare const ExecuteStatementRequestFilterSensitiveLog: (obj: ExecuteStatementRequest) => any;
1089
- /**
1090
- * @internal
1091
- */
1092
- export declare const StructValueFilterSensitiveLog: (obj: StructValue) => any;
1093
- /**
1094
- * @internal
1095
- */
1096
- export declare const BatchExecuteStatementRequestFilterSensitiveLog: (obj: BatchExecuteStatementRequest) => any;
1097
- /**
1098
- * @internal
1099
- */
1100
- export declare const BatchExecuteStatementResponseFilterSensitiveLog: (obj: BatchExecuteStatementResponse) => any;
1101
- /**
1102
- * @internal
1103
- */
1104
- export declare const _RecordFilterSensitiveLog: (obj: _Record) => any;
1105
- /**
1106
- * @internal
1107
- */
1108
- export declare const ExecuteStatementResponseFilterSensitiveLog: (obj: ExecuteStatementResponse) => any;
1109
- /**
1110
- * @internal
1111
- */
1112
- export declare const ResultFrameFilterSensitiveLog: (obj: ResultFrame) => any;
1113
- /**
1114
- * @internal
1115
- */
1116
- export declare const SqlStatementResultFilterSensitiveLog: (obj: SqlStatementResult) => any;
1117
- /**
1118
- * @internal
1119
- */
1120
- export declare const ExecuteSqlResponseFilterSensitiveLog: (obj: ExecuteSqlResponse) => any;
@@ -518,59 +518,3 @@ export interface SqlStatementResult {
518
518
  export interface ExecuteSqlResponse {
519
519
  sqlStatementResults?: SqlStatementResult[];
520
520
  }
521
- export declare const BeginTransactionRequestFilterSensitiveLog: (
522
- obj: BeginTransactionRequest
523
- ) => any;
524
- export declare const BeginTransactionResponseFilterSensitiveLog: (
525
- obj: BeginTransactionResponse
526
- ) => any;
527
- export declare const ColumnMetadataFilterSensitiveLog: (
528
- obj: ColumnMetadata
529
- ) => any;
530
- export declare const CommitTransactionRequestFilterSensitiveLog: (
531
- obj: CommitTransactionRequest
532
- ) => any;
533
- export declare const CommitTransactionResponseFilterSensitiveLog: (
534
- obj: CommitTransactionResponse
535
- ) => any;
536
- export declare const ExecuteSqlRequestFilterSensitiveLog: (
537
- obj: ExecuteSqlRequest
538
- ) => any;
539
- export declare const ResultSetMetadataFilterSensitiveLog: (
540
- obj: ResultSetMetadata
541
- ) => any;
542
- export declare const ResultSetOptionsFilterSensitiveLog: (
543
- obj: ResultSetOptions
544
- ) => any;
545
- export declare const RollbackTransactionRequestFilterSensitiveLog: (
546
- obj: RollbackTransactionRequest
547
- ) => any;
548
- export declare const RollbackTransactionResponseFilterSensitiveLog: (
549
- obj: RollbackTransactionResponse
550
- ) => any;
551
- export declare const ArrayValueFilterSensitiveLog: (obj: ArrayValue) => any;
552
- export declare const FieldFilterSensitiveLog: (obj: Field) => any;
553
- export declare const SqlParameterFilterSensitiveLog: (obj: SqlParameter) => any;
554
- export declare const UpdateResultFilterSensitiveLog: (obj: UpdateResult) => any;
555
- export declare const ValueFilterSensitiveLog: (obj: Value) => any;
556
- export declare const ExecuteStatementRequestFilterSensitiveLog: (
557
- obj: ExecuteStatementRequest
558
- ) => any;
559
- export declare const StructValueFilterSensitiveLog: (obj: StructValue) => any;
560
- export declare const BatchExecuteStatementRequestFilterSensitiveLog: (
561
- obj: BatchExecuteStatementRequest
562
- ) => any;
563
- export declare const BatchExecuteStatementResponseFilterSensitiveLog: (
564
- obj: BatchExecuteStatementResponse
565
- ) => any;
566
- export declare const _RecordFilterSensitiveLog: (obj: _Record) => any;
567
- export declare const ExecuteStatementResponseFilterSensitiveLog: (
568
- obj: ExecuteStatementResponse
569
- ) => any;
570
- export declare const ResultFrameFilterSensitiveLog: (obj: ResultFrame) => any;
571
- export declare const SqlStatementResultFilterSensitiveLog: (
572
- obj: SqlStatementResult
573
- ) => any;
574
- export declare const ExecuteSqlResponseFilterSensitiveLog: (
575
- obj: ExecuteSqlResponse
576
- ) => any;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rds-data",
3
3
  "description": "AWS SDK for JavaScript Rds Data Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.298.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
11
11
  "build:types": "tsc -p tsconfig.types.json",
12
12
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
13
13
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
14
+ "extract:docs": "api-extractor run --local",
14
15
  "generate:client": "node ../../scripts/generate-clients/single-service --solo rds-data"
15
16
  },
16
17
  "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
20
21
  "dependencies": {
21
22
  "@aws-crypto/sha256-browser": "3.0.0",
22
23
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
24
+ "@aws-sdk/client-sts": "3.298.0",
24
25
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/credential-provider-node": "3.298.0",
26
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
28
  "@aws-sdk/hash-node": "3.296.0",
28
29
  "@aws-sdk/invalid-dependency": "3.296.0",