aws-sdk-rdsdataservice 1.7.0 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rdsdataservice.rb +1 -1
- data/lib/aws-sdk-rdsdataservice/client.rb +362 -9
- data/lib/aws-sdk-rdsdataservice/client_api.rb +199 -19
- data/lib/aws-sdk-rdsdataservice/errors.rb +39 -2
- data/lib/aws-sdk-rdsdataservice/types.rb +588 -103
- metadata +2 -2
@@ -10,11 +10,11 @@ module Aws::RDSDataService
|
|
10
10
|
|
11
11
|
extend Aws::Errors::DynamicErrors
|
12
12
|
|
13
|
-
class
|
13
|
+
class NotFoundException < ServiceError
|
14
14
|
|
15
15
|
# @param [Seahorse::Client::RequestContext] context
|
16
16
|
# @param [String] message
|
17
|
-
# @param [Aws::RDSDataService::Types::
|
17
|
+
# @param [Aws::RDSDataService::Types::NotFoundException] data
|
18
18
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
19
|
super(context, message, data)
|
20
20
|
end
|
@@ -42,5 +42,42 @@ module Aws::RDSDataService
|
|
42
42
|
|
43
43
|
end
|
44
44
|
|
45
|
+
class ForbiddenException < ServiceError
|
46
|
+
|
47
|
+
# @param [Seahorse::Client::RequestContext] context
|
48
|
+
# @param [String] message
|
49
|
+
# @param [Aws::RDSDataService::Types::ForbiddenException] data
|
50
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
51
|
+
super(context, message, data)
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [String]
|
55
|
+
def message
|
56
|
+
@message || @data[:message]
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
|
61
|
+
class StatementTimeoutException < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::RDSDataService::Types::StatementTimeoutException] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def db_connection_id
|
72
|
+
@data[:db_connection_id]
|
73
|
+
end
|
74
|
+
|
75
|
+
# @return [String]
|
76
|
+
def message
|
77
|
+
@message || @data[:message]
|
78
|
+
end
|
79
|
+
|
80
|
+
end
|
81
|
+
|
45
82
|
end
|
46
83
|
end
|
@@ -8,10 +8,337 @@
|
|
8
8
|
module Aws::RDSDataService
|
9
9
|
module Types
|
10
10
|
|
11
|
-
#
|
11
|
+
# The result set returned by a SQL statement.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] records
|
14
|
+
# The records in the result set.
|
15
|
+
# @return [Array<Types::Record>]
|
16
|
+
#
|
17
|
+
# @!attribute [rw] result_set_metadata
|
18
|
+
# The result-set metadata in the result set.
|
19
|
+
# @return [Types::ResultSetMetadata]
|
20
|
+
#
|
21
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultFrame AWS API Documentation
|
22
|
+
#
|
23
|
+
class ResultFrame < Struct.new(
|
24
|
+
:records,
|
25
|
+
:result_set_metadata)
|
26
|
+
include Aws::Structure
|
27
|
+
end
|
28
|
+
|
29
|
+
# The `resourceArn`, `secretArn`, or `transactionId` value can't be
|
30
|
+
# found.
|
31
|
+
#
|
32
|
+
# @!attribute [rw] message
|
33
|
+
# The error message returned by this `NotFoundException` error.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/NotFoundException AWS API Documentation
|
37
|
+
#
|
38
|
+
class NotFoundException < Struct.new(
|
39
|
+
:message)
|
40
|
+
include Aws::Structure
|
41
|
+
end
|
42
|
+
|
43
|
+
# The request parameters represent the input of a SQL statement over an
|
44
|
+
# array of data.
|
45
|
+
#
|
46
|
+
# @note When making an API call, you may pass BatchExecuteStatementRequest
|
47
|
+
# data as a hash:
|
48
|
+
#
|
49
|
+
# {
|
50
|
+
# database: "DbName",
|
51
|
+
# parameter_sets: [
|
52
|
+
# [
|
53
|
+
# {
|
54
|
+
# name: "ParameterName",
|
55
|
+
# value: {
|
56
|
+
# blob_value: "data",
|
57
|
+
# boolean_value: false,
|
58
|
+
# double_value: 1.0,
|
59
|
+
# is_null: false,
|
60
|
+
# long_value: 1,
|
61
|
+
# string_value: "String",
|
62
|
+
# },
|
63
|
+
# },
|
64
|
+
# ],
|
65
|
+
# ],
|
66
|
+
# resource_arn: "Arn", # required
|
67
|
+
# schema: "DbName",
|
68
|
+
# secret_arn: "Arn", # required
|
69
|
+
# sql: "SqlStatement", # required
|
70
|
+
# transaction_id: "Id",
|
71
|
+
# }
|
72
|
+
#
|
73
|
+
# @!attribute [rw] database
|
74
|
+
# The name of the database.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] parameter_sets
|
78
|
+
# The parameter set for the batch operation.
|
79
|
+
# @return [Array<Array<Types::SqlParameter>>]
|
80
|
+
#
|
81
|
+
# @!attribute [rw] resource_arn
|
82
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] schema
|
86
|
+
# The name of the database schema.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] secret_arn
|
90
|
+
# The name or ARN of the secret that enables access to the DB cluster.
|
91
|
+
# @return [String]
|
92
|
+
#
|
93
|
+
# @!attribute [rw] sql
|
94
|
+
# The SQL statement to run.
|
95
|
+
# @return [String]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] transaction_id
|
98
|
+
# The identifier of a transaction that was started by using the
|
99
|
+
# `BeginTransaction` operation. Specify the transaction ID of the
|
100
|
+
# transaction that you want to include the SQL statement in.
|
101
|
+
#
|
102
|
+
# If the SQL statement is not part of a transaction, don't set this
|
103
|
+
# parameter.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatementRequest AWS API Documentation
|
107
|
+
#
|
108
|
+
class BatchExecuteStatementRequest < Struct.new(
|
109
|
+
:database,
|
110
|
+
:parameter_sets,
|
111
|
+
:resource_arn,
|
112
|
+
:schema,
|
113
|
+
:secret_arn,
|
114
|
+
:sql,
|
115
|
+
:transaction_id)
|
116
|
+
include Aws::Structure
|
117
|
+
end
|
118
|
+
|
119
|
+
# The response elements represent the output of a commit transaction
|
120
|
+
# request.
|
121
|
+
#
|
122
|
+
# @!attribute [rw] transaction_status
|
123
|
+
# The status of the commit operation.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/CommitTransactionResponse AWS API Documentation
|
127
|
+
#
|
128
|
+
class CommitTransactionResponse < Struct.new(
|
129
|
+
:transaction_status)
|
130
|
+
include Aws::Structure
|
131
|
+
end
|
132
|
+
|
133
|
+
# A parameter used in a SQL statement.
|
134
|
+
#
|
135
|
+
# @note When making an API call, you may pass SqlParameter
|
136
|
+
# data as a hash:
|
137
|
+
#
|
138
|
+
# {
|
139
|
+
# name: "ParameterName",
|
140
|
+
# value: {
|
141
|
+
# blob_value: "data",
|
142
|
+
# boolean_value: false,
|
143
|
+
# double_value: 1.0,
|
144
|
+
# is_null: false,
|
145
|
+
# long_value: 1,
|
146
|
+
# string_value: "String",
|
147
|
+
# },
|
148
|
+
# }
|
149
|
+
#
|
150
|
+
# @!attribute [rw] name
|
151
|
+
# The name of the parameter.
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] value
|
155
|
+
# The value of the parameter.
|
156
|
+
# @return [Types::Field]
|
157
|
+
#
|
158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlParameter AWS API Documentation
|
159
|
+
#
|
160
|
+
class SqlParameter < Struct.new(
|
161
|
+
:name,
|
162
|
+
:value)
|
163
|
+
include Aws::Structure
|
164
|
+
end
|
165
|
+
|
166
|
+
# Contains a value.
|
167
|
+
#
|
168
|
+
# @note When making an API call, you may pass Field
|
169
|
+
# data as a hash:
|
170
|
+
#
|
171
|
+
# {
|
172
|
+
# blob_value: "data",
|
173
|
+
# boolean_value: false,
|
174
|
+
# double_value: 1.0,
|
175
|
+
# is_null: false,
|
176
|
+
# long_value: 1,
|
177
|
+
# string_value: "String",
|
178
|
+
# }
|
179
|
+
#
|
180
|
+
# @!attribute [rw] blob_value
|
181
|
+
# A value of BLOB data type.
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] boolean_value
|
185
|
+
# A value of Boolean data type.
|
186
|
+
# @return [Boolean]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] double_value
|
189
|
+
# A value of double data type.
|
190
|
+
# @return [Float]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] is_null
|
193
|
+
# A NULL value.
|
194
|
+
# @return [Boolean]
|
195
|
+
#
|
196
|
+
# @!attribute [rw] long_value
|
197
|
+
# A value of long data type.
|
198
|
+
# @return [Integer]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] string_value
|
201
|
+
# A value of string data type.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Field AWS API Documentation
|
205
|
+
#
|
206
|
+
class Field < Struct.new(
|
207
|
+
:blob_value,
|
208
|
+
:boolean_value,
|
209
|
+
:double_value,
|
210
|
+
:is_null,
|
211
|
+
:long_value,
|
212
|
+
:string_value)
|
213
|
+
include Aws::Structure
|
214
|
+
end
|
215
|
+
|
216
|
+
# The request parameters represent the input of a request to run one or
|
217
|
+
# more SQL statements.
|
218
|
+
#
|
219
|
+
# @note When making an API call, you may pass ExecuteSqlRequest
|
220
|
+
# data as a hash:
|
221
|
+
#
|
222
|
+
# {
|
223
|
+
# aws_secret_store_arn: "Arn", # required
|
224
|
+
# database: "DbName",
|
225
|
+
# db_cluster_or_instance_arn: "Arn", # required
|
226
|
+
# schema: "DbName",
|
227
|
+
# sql_statements: "SqlStatement", # required
|
228
|
+
# }
|
229
|
+
#
|
230
|
+
# @!attribute [rw] aws_secret_store_arn
|
231
|
+
# The Amazon Resource Name (ARN) of the secret that enables access to
|
232
|
+
# the DB cluster.
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @!attribute [rw] database
|
236
|
+
# The name of the database.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] db_cluster_or_instance_arn
|
240
|
+
# The ARN of the Aurora Serverless DB cluster.
|
241
|
+
# @return [String]
|
242
|
+
#
|
243
|
+
# @!attribute [rw] schema
|
244
|
+
# The name of the database schema.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @!attribute [rw] sql_statements
|
248
|
+
# One or more SQL statements to run on the DB cluster.
|
249
|
+
#
|
250
|
+
# You can separate SQL statements from each other with a semicolon
|
251
|
+
# (;). Any valid SQL statement is permitted, including data
|
252
|
+
# definition, data manipulation, and commit statements.
|
253
|
+
# @return [String]
|
254
|
+
#
|
255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSqlRequest AWS API Documentation
|
256
|
+
#
|
257
|
+
class ExecuteSqlRequest < Struct.new(
|
258
|
+
:aws_secret_store_arn,
|
259
|
+
:database,
|
260
|
+
:db_cluster_or_instance_arn,
|
261
|
+
:schema,
|
262
|
+
:sql_statements)
|
263
|
+
include Aws::Structure
|
264
|
+
end
|
265
|
+
|
266
|
+
# A structure value returned by a call.
|
267
|
+
#
|
268
|
+
# @!attribute [rw] attributes
|
269
|
+
# The attributes returned in the record.
|
270
|
+
# @return [Array<Types::Value>]
|
271
|
+
#
|
272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/StructValue AWS API Documentation
|
273
|
+
#
|
274
|
+
class StructValue < Struct.new(
|
275
|
+
:attributes)
|
276
|
+
include Aws::Structure
|
277
|
+
end
|
278
|
+
|
279
|
+
# There is an error in the call or in a SQL statement.
|
12
280
|
#
|
13
281
|
# @!attribute [rw] message
|
14
|
-
#
|
282
|
+
# The error message returned by this `BadRequestException` error.
|
283
|
+
# @return [String]
|
284
|
+
#
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BadRequestException AWS API Documentation
|
286
|
+
#
|
287
|
+
class BadRequestException < Struct.new(
|
288
|
+
:message)
|
289
|
+
include Aws::Structure
|
290
|
+
end
|
291
|
+
|
292
|
+
# The request parameters represent the input of a request to perform a
|
293
|
+
# rollback of a transaction.
|
294
|
+
#
|
295
|
+
# @note When making an API call, you may pass RollbackTransactionRequest
|
296
|
+
# data as a hash:
|
297
|
+
#
|
298
|
+
# {
|
299
|
+
# resource_arn: "Arn", # required
|
300
|
+
# secret_arn: "Arn", # required
|
301
|
+
# transaction_id: "Id", # required
|
302
|
+
# }
|
303
|
+
#
|
304
|
+
# @!attribute [rw] resource_arn
|
305
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
306
|
+
# @return [String]
|
307
|
+
#
|
308
|
+
# @!attribute [rw] secret_arn
|
309
|
+
# The name or ARN of the secret that enables access to the DB cluster.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] transaction_id
|
313
|
+
# The identifier of the transaction to roll back.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/RollbackTransactionRequest AWS API Documentation
|
317
|
+
#
|
318
|
+
class RollbackTransactionRequest < Struct.new(
|
319
|
+
:resource_arn,
|
320
|
+
:secret_arn,
|
321
|
+
:transaction_id)
|
322
|
+
include Aws::Structure
|
323
|
+
end
|
324
|
+
|
325
|
+
# A record returned by a call.
|
326
|
+
#
|
327
|
+
# @!attribute [rw] values
|
328
|
+
# The values returned in the record.
|
329
|
+
# @return [Array<Types::Value>]
|
330
|
+
#
|
331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Record AWS API Documentation
|
332
|
+
#
|
333
|
+
class Record < Struct.new(
|
334
|
+
:values)
|
335
|
+
include Aws::Structure
|
336
|
+
end
|
337
|
+
|
338
|
+
# There are insufficient privileges to make the call.
|
339
|
+
#
|
340
|
+
# @!attribute [rw] message
|
341
|
+
# The error message returned by this `ForbiddenException` error.
|
15
342
|
# @return [String]
|
16
343
|
#
|
17
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ForbiddenException AWS API Documentation
|
@@ -21,46 +348,46 @@ module Aws::RDSDataService
|
|
21
348
|
include Aws::Structure
|
22
349
|
end
|
23
350
|
|
24
|
-
#
|
351
|
+
# Contains the value of a column.
|
25
352
|
#
|
26
353
|
# @!attribute [rw] array_values
|
27
|
-
#
|
354
|
+
# An array of column values.
|
28
355
|
# @return [Array<Types::Value>]
|
29
356
|
#
|
30
357
|
# @!attribute [rw] big_int_value
|
31
|
-
#
|
358
|
+
# A value for a column of big integer data type.
|
32
359
|
# @return [Integer]
|
33
360
|
#
|
34
361
|
# @!attribute [rw] bit_value
|
35
|
-
#
|
362
|
+
# A value for a column of BIT data type.
|
36
363
|
# @return [Boolean]
|
37
364
|
#
|
38
365
|
# @!attribute [rw] blob_value
|
39
|
-
#
|
366
|
+
# A value for a column of BLOB data type.
|
40
367
|
# @return [String]
|
41
368
|
#
|
42
369
|
# @!attribute [rw] double_value
|
43
|
-
#
|
370
|
+
# A value for a column of double data type.
|
44
371
|
# @return [Float]
|
45
372
|
#
|
46
373
|
# @!attribute [rw] int_value
|
47
|
-
#
|
374
|
+
# A value for a column of integer data type.
|
48
375
|
# @return [Integer]
|
49
376
|
#
|
50
377
|
# @!attribute [rw] is_null
|
51
|
-
#
|
378
|
+
# A NULL value.
|
52
379
|
# @return [Boolean]
|
53
380
|
#
|
54
381
|
# @!attribute [rw] real_value
|
55
|
-
#
|
382
|
+
# A value for a column of real data type.
|
56
383
|
# @return [Float]
|
57
384
|
#
|
58
385
|
# @!attribute [rw] string_value
|
59
|
-
#
|
386
|
+
# A value for a column of string data type.
|
60
387
|
# @return [String]
|
61
388
|
#
|
62
389
|
# @!attribute [rw] struct_value
|
63
|
-
#
|
390
|
+
# A value for a column of STRUCT data type.
|
64
391
|
# @return [Types::StructValue]
|
65
392
|
#
|
66
393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Value AWS API Documentation
|
@@ -79,28 +406,72 @@ module Aws::RDSDataService
|
|
79
406
|
include Aws::Structure
|
80
407
|
end
|
81
408
|
|
82
|
-
#
|
409
|
+
# The execution of the SQL statement timed out.
|
410
|
+
#
|
411
|
+
# @!attribute [rw] db_connection_id
|
412
|
+
# The database connection ID that executed the SQL statement.
|
413
|
+
# @return [Integer]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] message
|
416
|
+
# The error message returned by this `StatementTimeoutException`
|
417
|
+
# error.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/StatementTimeoutException AWS API Documentation
|
421
|
+
#
|
422
|
+
class StatementTimeoutException < Struct.new(
|
423
|
+
:db_connection_id,
|
424
|
+
:message)
|
425
|
+
include Aws::Structure
|
426
|
+
end
|
427
|
+
|
428
|
+
# The response elements represent the output of a request to run a SQL
|
429
|
+
# statement against a database.
|
430
|
+
#
|
431
|
+
# @!attribute [rw] column_metadata
|
432
|
+
# Metadata for the columns included in the results.
|
433
|
+
# @return [Array<Types::ColumnMetadata>]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] generated_fields
|
436
|
+
# Values for fields generated during the request.
|
437
|
+
# @return [Array<Types::Field>]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] number_of_records_updated
|
440
|
+
# The number of records updated by the request.
|
441
|
+
# @return [Integer]
|
83
442
|
#
|
84
443
|
# @!attribute [rw] records
|
85
|
-
#
|
86
|
-
# @return [Array<Types::
|
444
|
+
# The records returned by the SQL statement.
|
445
|
+
# @return [Array<Array<Types::Field>>]
|
87
446
|
#
|
88
|
-
#
|
89
|
-
# ResultSet Metadata.
|
90
|
-
# @return [Types::ResultSetMetadata]
|
447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementResponse AWS API Documentation
|
91
448
|
#
|
92
|
-
|
449
|
+
class ExecuteStatementResponse < Struct.new(
|
450
|
+
:column_metadata,
|
451
|
+
:generated_fields,
|
452
|
+
:number_of_records_updated,
|
453
|
+
:records)
|
454
|
+
include Aws::Structure
|
455
|
+
end
|
456
|
+
|
457
|
+
# The response elements represent the results of an update.
|
93
458
|
#
|
94
|
-
|
95
|
-
|
96
|
-
|
459
|
+
# @!attribute [rw] generated_fields
|
460
|
+
# Values for fields generated during the request.
|
461
|
+
# @return [Array<Types::Field>]
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/UpdateResult AWS API Documentation
|
464
|
+
#
|
465
|
+
class UpdateResult < Struct.new(
|
466
|
+
:generated_fields)
|
97
467
|
include Aws::Structure
|
98
468
|
end
|
99
469
|
|
100
|
-
#
|
470
|
+
# The response elements represent the output of a request to run one or
|
471
|
+
# more SQL statements.
|
101
472
|
#
|
102
473
|
# @!attribute [rw] sql_statement_results
|
103
|
-
#
|
474
|
+
# The results of the SQL statement or statements.
|
104
475
|
# @return [Array<Types::SqlStatementResult>]
|
105
476
|
#
|
106
477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSqlResponse AWS API Documentation
|
@@ -110,14 +481,14 @@ module Aws::RDSDataService
|
|
110
481
|
include Aws::Structure
|
111
482
|
end
|
112
483
|
|
113
|
-
# SQL statement
|
484
|
+
# The result of a SQL statement.
|
114
485
|
#
|
115
486
|
# @!attribute [rw] number_of_records_updated
|
116
|
-
#
|
487
|
+
# The number of records updated by a SQL statement.
|
117
488
|
# @return [Integer]
|
118
489
|
#
|
119
490
|
# @!attribute [rw] result_frame
|
120
|
-
#
|
491
|
+
# The result set of the SQL statement.
|
121
492
|
# @return [Types::ResultFrame]
|
122
493
|
#
|
123
494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlStatementResult AWS API Documentation
|
@@ -128,14 +499,81 @@ module Aws::RDSDataService
|
|
128
499
|
include Aws::Structure
|
129
500
|
end
|
130
501
|
|
131
|
-
#
|
502
|
+
# The request parameters represent the input of a request to start a SQL
|
503
|
+
# transaction.
|
504
|
+
#
|
505
|
+
# @note When making an API call, you may pass BeginTransactionRequest
|
506
|
+
# data as a hash:
|
507
|
+
#
|
508
|
+
# {
|
509
|
+
# database: "DbName",
|
510
|
+
# resource_arn: "Arn", # required
|
511
|
+
# schema: "DbName",
|
512
|
+
# secret_arn: "Arn", # required
|
513
|
+
# }
|
514
|
+
#
|
515
|
+
# @!attribute [rw] database
|
516
|
+
# The name of the database.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] resource_arn
|
520
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
521
|
+
# @return [String]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] schema
|
524
|
+
# The name of the database schema.
|
525
|
+
# @return [String]
|
526
|
+
#
|
527
|
+
# @!attribute [rw] secret_arn
|
528
|
+
# The name or ARN of the secret that enables access to the DB cluster.
|
529
|
+
# @return [String]
|
530
|
+
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BeginTransactionRequest AWS API Documentation
|
532
|
+
#
|
533
|
+
class BeginTransactionRequest < Struct.new(
|
534
|
+
:database,
|
535
|
+
:resource_arn,
|
536
|
+
:schema,
|
537
|
+
:secret_arn)
|
538
|
+
include Aws::Structure
|
539
|
+
end
|
540
|
+
|
541
|
+
# The response elements represent the output of a request to perform a
|
542
|
+
# rollback of a transaction.
|
543
|
+
#
|
544
|
+
# @!attribute [rw] transaction_status
|
545
|
+
# The status of the rollback operation.
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/RollbackTransactionResponse AWS API Documentation
|
549
|
+
#
|
550
|
+
class RollbackTransactionResponse < Struct.new(
|
551
|
+
:transaction_status)
|
552
|
+
include Aws::Structure
|
553
|
+
end
|
554
|
+
|
555
|
+
# The response elements represent the output of a SQL statement over an
|
556
|
+
# array of data.
|
557
|
+
#
|
558
|
+
# @!attribute [rw] update_results
|
559
|
+
# The execution results of each batch entry.
|
560
|
+
# @return [Array<Types::UpdateResult>]
|
561
|
+
#
|
562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatementResponse AWS API Documentation
|
563
|
+
#
|
564
|
+
class BatchExecuteStatementResponse < Struct.new(
|
565
|
+
:update_results)
|
566
|
+
include Aws::Structure
|
567
|
+
end
|
568
|
+
|
569
|
+
# The metadata of the result set returned by a SQL statement.
|
132
570
|
#
|
133
571
|
# @!attribute [rw] column_count
|
134
|
-
#
|
572
|
+
# The number of columns in the result set.
|
135
573
|
# @return [Integer]
|
136
574
|
#
|
137
575
|
# @!attribute [rw] column_metadata
|
138
|
-
#
|
576
|
+
# The metadata of the columns in the result set.
|
139
577
|
# @return [Array<Types::ColumnMetadata>]
|
140
578
|
#
|
141
579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultSetMetadata AWS API Documentation
|
@@ -146,144 +584,204 @@ module Aws::RDSDataService
|
|
146
584
|
include Aws::Structure
|
147
585
|
end
|
148
586
|
|
149
|
-
#
|
587
|
+
# The request parameters represent the input of a request to run a SQL
|
588
|
+
# statement against a database.
|
150
589
|
#
|
151
|
-
# @note When making an API call, you may pass
|
590
|
+
# @note When making an API call, you may pass ExecuteStatementRequest
|
152
591
|
# data as a hash:
|
153
592
|
#
|
154
593
|
# {
|
155
|
-
#
|
594
|
+
# continue_after_timeout: false,
|
156
595
|
# database: "DbName",
|
157
|
-
#
|
596
|
+
# include_result_metadata: false,
|
597
|
+
# parameters: [
|
598
|
+
# {
|
599
|
+
# name: "ParameterName",
|
600
|
+
# value: {
|
601
|
+
# blob_value: "data",
|
602
|
+
# boolean_value: false,
|
603
|
+
# double_value: 1.0,
|
604
|
+
# is_null: false,
|
605
|
+
# long_value: 1,
|
606
|
+
# string_value: "String",
|
607
|
+
# },
|
608
|
+
# },
|
609
|
+
# ],
|
610
|
+
# resource_arn: "Arn", # required
|
158
611
|
# schema: "DbName",
|
159
|
-
#
|
612
|
+
# secret_arn: "Arn", # required
|
613
|
+
# sql: "SqlStatement", # required
|
614
|
+
# transaction_id: "Id",
|
160
615
|
# }
|
161
616
|
#
|
162
|
-
# @!attribute [rw]
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
617
|
+
# @!attribute [rw] continue_after_timeout
|
618
|
+
# A value that indicates whether to continue running the statement
|
619
|
+
# after the call times out. By default, the statement stops running
|
620
|
+
# when the call times out.
|
621
|
+
#
|
622
|
+
# <important markdown="1"> For DDL statements, we recommend continuing to run the statement
|
623
|
+
# after the call times out. When a DDL statement terminates before it
|
624
|
+
# is finished running, it can result in errors and possibly corrupted
|
625
|
+
# data structures.
|
626
|
+
#
|
627
|
+
# </important>
|
628
|
+
# @return [Boolean]
|
166
629
|
#
|
167
630
|
# @!attribute [rw] database
|
168
|
-
#
|
631
|
+
# The name of the database.
|
169
632
|
# @return [String]
|
170
633
|
#
|
171
|
-
# @!attribute [rw]
|
172
|
-
#
|
634
|
+
# @!attribute [rw] include_result_metadata
|
635
|
+
# A value that indicates whether to include metadata in the results.
|
636
|
+
# @return [Boolean]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] parameters
|
639
|
+
# The parameters for the SQL statement.
|
640
|
+
# @return [Array<Types::SqlParameter>]
|
641
|
+
#
|
642
|
+
# @!attribute [rw] resource_arn
|
643
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
173
644
|
# @return [String]
|
174
645
|
#
|
175
646
|
# @!attribute [rw] schema
|
176
|
-
#
|
647
|
+
# The name of the database schema.
|
177
648
|
# @return [String]
|
178
649
|
#
|
179
|
-
# @!attribute [rw]
|
180
|
-
#
|
181
|
-
# semicolons
|
650
|
+
# @!attribute [rw] secret_arn
|
651
|
+
# The name or ARN of the secret that enables access to the DB cluster.
|
182
652
|
# @return [String]
|
183
653
|
#
|
184
|
-
#
|
654
|
+
# @!attribute [rw] sql
|
655
|
+
# The SQL statement to run.
|
656
|
+
# @return [String]
|
185
657
|
#
|
186
|
-
|
187
|
-
|
658
|
+
# @!attribute [rw] transaction_id
|
659
|
+
# The identifier of a transaction that was started by using the
|
660
|
+
# `BeginTransaction` operation. Specify the transaction ID of the
|
661
|
+
# transaction that you want to include the SQL statement in.
|
662
|
+
#
|
663
|
+
# If the SQL statement is not part of a transaction, don't set this
|
664
|
+
# parameter.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementRequest AWS API Documentation
|
668
|
+
#
|
669
|
+
class ExecuteStatementRequest < Struct.new(
|
670
|
+
:continue_after_timeout,
|
188
671
|
:database,
|
189
|
-
:
|
672
|
+
:include_result_metadata,
|
673
|
+
:parameters,
|
674
|
+
:resource_arn,
|
190
675
|
:schema,
|
191
|
-
:
|
676
|
+
:secret_arn,
|
677
|
+
:sql,
|
678
|
+
:transaction_id)
|
192
679
|
include Aws::Structure
|
193
680
|
end
|
194
681
|
|
195
|
-
#
|
682
|
+
# The response elements represent the output of a request to start a SQL
|
683
|
+
# transaction.
|
196
684
|
#
|
197
|
-
# @!attribute [rw]
|
198
|
-
#
|
199
|
-
# @return [
|
685
|
+
# @!attribute [rw] transaction_id
|
686
|
+
# The transaction ID of the transaction started by the call.
|
687
|
+
# @return [String]
|
200
688
|
#
|
201
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/
|
689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BeginTransactionResponse AWS API Documentation
|
202
690
|
#
|
203
|
-
class
|
204
|
-
:
|
691
|
+
class BeginTransactionResponse < Struct.new(
|
692
|
+
:transaction_id)
|
205
693
|
include Aws::Structure
|
206
694
|
end
|
207
695
|
|
208
|
-
#
|
696
|
+
# The request parameters represent the input of a commit transaction
|
697
|
+
# request.
|
209
698
|
#
|
210
|
-
#
|
211
|
-
#
|
699
|
+
# @note When making an API call, you may pass CommitTransactionRequest
|
700
|
+
# data as a hash:
|
701
|
+
#
|
702
|
+
# {
|
703
|
+
# resource_arn: "Arn", # required
|
704
|
+
# secret_arn: "Arn", # required
|
705
|
+
# transaction_id: "Id", # required
|
706
|
+
# }
|
707
|
+
#
|
708
|
+
# @!attribute [rw] resource_arn
|
709
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
212
710
|
# @return [String]
|
213
711
|
#
|
214
|
-
#
|
712
|
+
# @!attribute [rw] secret_arn
|
713
|
+
# The name or ARN of the secret that enables access to the DB cluster.
|
714
|
+
# @return [String]
|
215
715
|
#
|
216
|
-
|
217
|
-
|
716
|
+
# @!attribute [rw] transaction_id
|
717
|
+
# The identifier of the transaction to end and commit.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/CommitTransactionRequest AWS API Documentation
|
721
|
+
#
|
722
|
+
class CommitTransactionRequest < Struct.new(
|
723
|
+
:resource_arn,
|
724
|
+
:secret_arn,
|
725
|
+
:transaction_id)
|
218
726
|
include Aws::Structure
|
219
727
|
end
|
220
728
|
|
221
|
-
#
|
729
|
+
# Contains the metadata for a column.
|
222
730
|
#
|
223
731
|
# @!attribute [rw] array_base_column_type
|
224
|
-
#
|
732
|
+
# The type of the column.
|
225
733
|
# @return [Integer]
|
226
734
|
#
|
227
735
|
# @!attribute [rw] is_auto_increment
|
228
|
-
#
|
736
|
+
# A value that indicates whether the column increments automatically.
|
229
737
|
# @return [Boolean]
|
230
738
|
#
|
231
739
|
# @!attribute [rw] is_case_sensitive
|
232
|
-
#
|
740
|
+
# A value that indicates whether the column is case-sensitive.
|
233
741
|
# @return [Boolean]
|
234
742
|
#
|
235
743
|
# @!attribute [rw] is_currency
|
236
|
-
#
|
744
|
+
# A value that indicates whether the column contains currency values.
|
237
745
|
# @return [Boolean]
|
238
746
|
#
|
239
747
|
# @!attribute [rw] is_signed
|
240
|
-
#
|
748
|
+
# A value that indicates whether an integer column is signed.
|
241
749
|
# @return [Boolean]
|
242
750
|
#
|
243
751
|
# @!attribute [rw] label
|
244
|
-
#
|
245
|
-
# name.
|
752
|
+
# The label for the column.
|
246
753
|
# @return [String]
|
247
754
|
#
|
248
755
|
# @!attribute [rw] name
|
249
|
-
#
|
756
|
+
# The name of the column.
|
250
757
|
# @return [String]
|
251
758
|
#
|
252
759
|
# @!attribute [rw] nullable
|
253
|
-
#
|
254
|
-
# columnNoNulls (0), columnNullable (1), columnNullableUnknown (2)
|
760
|
+
# A value that indicates whether the column is nullable.
|
255
761
|
# @return [Integer]
|
256
762
|
#
|
257
763
|
# @!attribute [rw] precision
|
258
|
-
#
|
259
|
-
# this is the maximum precision. For character data, this is the
|
260
|
-
# length in characters. For datetime datatypes, this is the length in
|
261
|
-
# characters of the String representation (assuming the maximum
|
262
|
-
# allowed precision of the fractional seconds component). For binary
|
263
|
-
# data, this is the length in bytes. For the ROWID datatype, this is
|
264
|
-
# the length in bytes. 0 is returned for data types where the column
|
265
|
-
# size is not applicable.
|
764
|
+
# The precision value of a decimal number column.
|
266
765
|
# @return [Integer]
|
267
766
|
#
|
268
767
|
# @!attribute [rw] scale
|
269
|
-
#
|
270
|
-
# 0 is returned for data types where the scale is not applicable.
|
768
|
+
# The scale value of a decimal number column.
|
271
769
|
# @return [Integer]
|
272
770
|
#
|
273
771
|
# @!attribute [rw] schema_name
|
274
|
-
#
|
772
|
+
# The name of the schema that owns the table that includes the column.
|
275
773
|
# @return [String]
|
276
774
|
#
|
277
775
|
# @!attribute [rw] table_name
|
278
|
-
#
|
776
|
+
# The name of the table that includes the column.
|
279
777
|
# @return [String]
|
280
778
|
#
|
281
779
|
# @!attribute [rw] type
|
282
|
-
#
|
780
|
+
# The type of the column.
|
283
781
|
# @return [Integer]
|
284
782
|
#
|
285
783
|
# @!attribute [rw] type_name
|
286
|
-
#
|
784
|
+
# The database-specific data type of the column.
|
287
785
|
# @return [String]
|
288
786
|
#
|
289
787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ColumnMetadata AWS API Documentation
|
@@ -306,18 +804,5 @@ module Aws::RDSDataService
|
|
306
804
|
include Aws::Structure
|
307
805
|
end
|
308
806
|
|
309
|
-
# Row or Record
|
310
|
-
#
|
311
|
-
# @!attribute [rw] values
|
312
|
-
# Record
|
313
|
-
# @return [Array<Types::Value>]
|
314
|
-
#
|
315
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Record AWS API Documentation
|
316
|
-
#
|
317
|
-
class Record < Struct.new(
|
318
|
-
:values)
|
319
|
-
include Aws::Structure
|
320
|
-
end
|
321
|
-
|
322
807
|
end
|
323
808
|
end
|