@aws-sdk/client-rds-data 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,7 @@ import { ExecuteStatementCommandInput, ExecuteStatementCommandOutput } from "./c
7
7
  import { RollbackTransactionCommandInput, RollbackTransactionCommandOutput } from "./commands/RollbackTransactionCommand";
8
8
  import { RDSDataClient } from "./RDSDataClient";
9
9
  /**
10
+ * @public
10
11
  * <fullname>Amazon RDS Data Service</fullname>
11
12
  * <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these
12
13
  * statements, you work with the Data Service API.</p>
@@ -19,6 +20,7 @@ import { RDSDataClient } from "./RDSDataClient";
19
20
  */
20
21
  export declare class RDSData extends RDSDataClient {
21
22
  /**
23
+ * @public
22
24
  * <p>Runs a batch SQL statement over an array of data.</p>
23
25
  * <p>You can run bulk update and insert operations for multiple records using a DML
24
26
  * statement with different parameter sets. Bulk operations can provide a significant
@@ -38,6 +40,7 @@ export declare class RDSData extends RDSDataClient {
38
40
  batchExecuteStatement(args: BatchExecuteStatementCommandInput, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
39
41
  batchExecuteStatement(args: BatchExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchExecuteStatementCommandOutput) => void): void;
40
42
  /**
43
+ * @public
41
44
  * <p>Starts a SQL transaction.</p>
42
45
  * <note>
43
46
  * <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24
@@ -52,6 +55,7 @@ export declare class RDSData extends RDSDataClient {
52
55
  beginTransaction(args: BeginTransactionCommandInput, cb: (err: any, data?: BeginTransactionCommandOutput) => void): void;
53
56
  beginTransaction(args: BeginTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BeginTransactionCommandOutput) => void): void;
54
57
  /**
58
+ * @public
55
59
  * <p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and
56
60
  * commits the changes.</p>
57
61
  */
@@ -59,6 +63,7 @@ export declare class RDSData extends RDSDataClient {
59
63
  commitTransaction(args: CommitTransactionCommandInput, cb: (err: any, data?: CommitTransactionCommandOutput) => void): void;
60
64
  commitTransaction(args: CommitTransactionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CommitTransactionCommandOutput) => void): void;
61
65
  /**
66
+ * @public
62
67
  * @deprecated
63
68
  *
64
69
  * <p>Runs one or more SQL statements.</p>
@@ -71,6 +76,7 @@ export declare class RDSData extends RDSDataClient {
71
76
  executeSql(args: ExecuteSqlCommandInput, cb: (err: any, data?: ExecuteSqlCommandOutput) => void): void;
72
77
  executeSql(args: ExecuteSqlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteSqlCommandOutput) => void): void;
73
78
  /**
79
+ * @public
74
80
  * <p>Runs a SQL statement against a database.</p>
75
81
  * <note>
76
82
  * <p>If a call isn't part of a transaction because it doesn't include the
@@ -83,6 +89,7 @@ export declare class RDSData extends RDSDataClient {
83
89
  executeStatement(args: ExecuteStatementCommandInput, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
84
90
  executeStatement(args: ExecuteStatementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteStatementCommandOutput) => void): void;
85
91
  /**
92
+ * @public
86
93
  * <p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>
87
94
  */
88
95
  rollbackTransaction(args: RollbackTransactionCommandInput, options?: __HttpHandlerOptions): Promise<RollbackTransactionCommandOutput>;
@@ -14,15 +14,24 @@ import { ExecuteSqlCommandInput, ExecuteSqlCommandOutput } from "./commands/Exec
14
14
  import { ExecuteStatementCommandInput, ExecuteStatementCommandOutput } from "./commands/ExecuteStatementCommand";
15
15
  import { RollbackTransactionCommandInput, RollbackTransactionCommandOutput } from "./commands/RollbackTransactionCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = BatchExecuteStatementCommandInput | BeginTransactionCommandInput | CommitTransactionCommandInput | ExecuteSqlCommandInput | ExecuteStatementCommandInput | RollbackTransactionCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = BatchExecuteStatementCommandOutput | BeginTransactionCommandOutput | CommitTransactionCommandOutput | ExecuteSqlCommandOutput | ExecuteStatementCommandOutput | RollbackTransactionCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -112,23 +121,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
112
121
  */
113
122
  logger?: __Logger;
114
123
  /**
115
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
124
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
116
125
  */
117
126
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
118
127
  }
128
+ /**
129
+ * @public
130
+ */
119
131
  type RDSDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
120
132
  /**
121
- * The configuration interface of RDSDataClient class constructor that set the region, credentials and other options.
133
+ * @public
134
+ *
135
+ * The configuration interface of RDSDataClient class constructor that set the region, credentials and other options.
122
136
  */
123
137
  export interface RDSDataClientConfig extends RDSDataClientConfigType {
124
138
  }
139
+ /**
140
+ * @public
141
+ */
125
142
  type RDSDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
126
143
  /**
127
- * The resolved configuration interface of RDSDataClient class. This is resolved and normalized from the {@link RDSDataClientConfig | constructor configuration interface}.
144
+ * @public
145
+ *
146
+ * The resolved configuration interface of RDSDataClient class. This is resolved and normalized from the {@link RDSDataClientConfig | constructor configuration interface}.
128
147
  */
129
148
  export interface RDSDataClientResolvedConfig extends RDSDataClientResolvedConfigType {
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <fullname>Amazon RDS Data Service</fullname>
133
153
  * <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these
134
154
  * statements, you work with the Data Service API.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchExecuteStatementRequest, BatchExecuteStatementResponse } from "../models/models_0";
5
5
  import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchExecuteStatementCommand}.
8
10
  */
9
11
  export interface BatchExecuteStatementCommandInput extends BatchExecuteStatementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchExecuteStatementCommand}.
13
17
  */
14
18
  export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatementResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Runs a batch SQL statement over an array of data.</p>
18
23
  * <p>You can run bulk update and insert operations for multiple records using a DML
19
24
  * statement with different parameter sets. Bulk operations can provide a significant
@@ -38,6 +43,8 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param BatchExecuteStatementCommandInput - {@link BatchExecuteStatementCommandInput}
47
+ * @returns {@link BatchExecuteStatementCommandOutput}
41
48
  * @see {@link BatchExecuteStatementCommandInput} for command's `input` shape.
42
49
  * @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape.
43
50
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -66,11 +73,20 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen
66
73
  export declare class BatchExecuteStatementCommand extends $Command<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput, RDSDataClientResolvedConfig> {
67
74
  readonly input: BatchExecuteStatementCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: BatchExecuteStatementCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchExecuteStatementCommandInput, BatchExecuteStatementCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BeginTransactionRequest, BeginTransactionResponse } from "../models/models_0";
5
5
  import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BeginTransactionCommand}.
8
10
  */
9
11
  export interface BeginTransactionCommandInput extends BeginTransactionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BeginTransactionCommand}.
13
17
  */
14
18
  export interface BeginTransactionCommandOutput extends BeginTransactionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a SQL transaction.</p>
18
23
  * <note>
19
24
  * <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24
@@ -33,6 +38,8 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param BeginTransactionCommandInput - {@link BeginTransactionCommandInput}
42
+ * @returns {@link BeginTransactionCommandOutput}
36
43
  * @see {@link BeginTransactionCommandInput} for command's `input` shape.
37
44
  * @see {@link BeginTransactionCommandOutput} for command's `response` shape.
38
45
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -61,11 +68,20 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse,
61
68
  export declare class BeginTransactionCommand extends $Command<BeginTransactionCommandInput, BeginTransactionCommandOutput, RDSDataClientResolvedConfig> {
62
69
  readonly input: BeginTransactionCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: BeginTransactionCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BeginTransactionCommandInput, BeginTransactionCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CommitTransactionRequest, CommitTransactionResponse } from "../models/models_0";
5
5
  import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CommitTransactionCommand}.
8
10
  */
9
11
  export interface CommitTransactionCommandInput extends CommitTransactionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CommitTransactionCommand}.
13
17
  */
14
18
  export interface CommitTransactionCommandOutput extends CommitTransactionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and
18
23
  * commits the changes.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CommitTransactionCommandOutput extends CommitTransactionRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CommitTransactionCommandInput - {@link CommitTransactionCommandInput}
35
+ * @returns {@link CommitTransactionCommandOutput}
29
36
  * @see {@link CommitTransactionCommandInput} for command's `input` shape.
30
37
  * @see {@link CommitTransactionCommandOutput} for command's `response` shape.
31
38
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CommitTransactionCommandOutput extends CommitTransactionRespons
57
64
  export declare class CommitTransactionCommand extends $Command<CommitTransactionCommandInput, CommitTransactionCommandOutput, RDSDataClientResolvedConfig> {
58
65
  readonly input: CommitTransactionCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CommitTransactionCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CommitTransactionCommandInput, CommitTransactionCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ExecuteSqlRequest, ExecuteSqlResponse } from "../models/models_0";
5
5
  import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ExecuteSqlCommand}.
8
10
  */
9
11
  export interface ExecuteSqlCommandInput extends ExecuteSqlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ExecuteSqlCommand}.
13
17
  */
14
18
  export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * @deprecated
18
23
  *
19
24
  * <p>Runs one or more SQL statements.</p>
@@ -31,6 +36,8 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ExecuteSqlCommandInput - {@link ExecuteSqlCommandInput}
40
+ * @returns {@link ExecuteSqlCommandOutput}
34
41
  * @see {@link ExecuteSqlCommandInput} for command's `input` shape.
35
42
  * @see {@link ExecuteSqlCommandOutput} for command's `response` shape.
36
43
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB
56
63
  export declare class ExecuteSqlCommand extends $Command<ExecuteSqlCommandInput, ExecuteSqlCommandOutput, RDSDataClientResolvedConfig> {
57
64
  readonly input: ExecuteSqlCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: ExecuteSqlCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteSqlCommandInput, ExecuteSqlCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ExecuteStatementRequest, ExecuteStatementResponse } from "../models/models_0";
5
5
  import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ExecuteStatementCommand}.
8
10
  */
9
11
  export interface ExecuteStatementCommandInput extends ExecuteStatementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ExecuteStatementCommand}.
13
17
  */
14
18
  export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Runs a SQL statement against a database.</p>
18
23
  * <note>
19
24
  * <p>If a call isn't part of a transaction because it doesn't include the
@@ -31,6 +36,8 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ExecuteStatementCommandInput - {@link ExecuteStatementCommandInput}
40
+ * @returns {@link ExecuteStatementCommandOutput}
34
41
  * @see {@link ExecuteStatementCommandInput} for command's `input` shape.
35
42
  * @see {@link ExecuteStatementCommandOutput} for command's `response` shape.
36
43
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse,
59
66
  export declare class ExecuteStatementCommand extends $Command<ExecuteStatementCommandInput, ExecuteStatementCommandOutput, RDSDataClientResolvedConfig> {
60
67
  readonly input: ExecuteStatementCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: ExecuteStatementCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteStatementCommandInput, ExecuteStatementCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RollbackTransactionRequest, RollbackTransactionResponse } from "../models/models_0";
5
5
  import { RDSDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSDataClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RollbackTransactionCommand}.
8
10
  */
9
11
  export interface RollbackTransactionCommandInput extends RollbackTransactionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RollbackTransactionCommand}.
13
17
  */
14
18
  export interface RollbackTransactionCommandOutput extends RollbackTransactionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RollbackTransactionCommandOutput extends RollbackTransactionRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RollbackTransactionCommandInput - {@link RollbackTransactionCommandInput}
34
+ * @returns {@link RollbackTransactionCommandOutput}
28
35
  * @see {@link RollbackTransactionCommandInput} for command's `input` shape.
29
36
  * @see {@link RollbackTransactionCommandOutput} for command's `response` shape.
30
37
  * @see {@link RDSDataClientResolvedConfig | config} for RDSDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface RollbackTransactionCommandOutput extends RollbackTransactionRes
56
63
  export declare class RollbackTransactionCommand extends $Command<RollbackTransactionCommandInput, RollbackTransactionCommandOutput, RDSDataClientResolvedConfig> {
57
64
  readonly input: RollbackTransactionCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: RollbackTransactionCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RollbackTransactionCommandInput, RollbackTransactionCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from RDSData service.
4
6
  */
5
7
  export declare class RDSDataServiceException extends __ServiceException {
@@ -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
  */
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.297.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",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",