aws-sdk-rdsdataservice 1.34.0 → 1.37.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -10,50 +10,63 @@
10
10
  module Aws::RDSDataService
11
11
  module Types
12
12
 
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
13
26
  # Contains an array.
14
27
  #
15
28
  # @note ArrayValue is a union - when making an API calls you must set exactly one of the members.
16
29
  #
17
30
  # @note ArrayValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ArrayValue corresponding to the set member.
18
31
  #
19
- # @!attribute [rw] array_values
20
- # An array of arrays.
21
- # @return [Array<Types::ArrayValue>]
22
- #
23
32
  # @!attribute [rw] boolean_values
24
33
  # An array of Boolean values.
25
34
  # @return [Array<Boolean>]
26
35
  #
27
- # @!attribute [rw] double_values
28
- # An array of integers.
29
- # @return [Array<Float>]
30
- #
31
36
  # @!attribute [rw] long_values
32
- # An array of floating point numbers.
37
+ # An array of integers.
33
38
  # @return [Array<Integer>]
34
39
  #
40
+ # @!attribute [rw] double_values
41
+ # An array of floating-point numbers.
42
+ # @return [Array<Float>]
43
+ #
35
44
  # @!attribute [rw] string_values
36
45
  # An array of strings.
37
46
  # @return [Array<String>]
38
47
  #
48
+ # @!attribute [rw] array_values
49
+ # An array of arrays.
50
+ # @return [Array<Types::ArrayValue>]
51
+ #
39
52
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ArrayValue AWS API Documentation
40
53
  #
41
54
  class ArrayValue < Struct.new(
42
- :array_values,
43
55
  :boolean_values,
44
- :double_values,
45
56
  :long_values,
57
+ :double_values,
46
58
  :string_values,
59
+ :array_values,
47
60
  :unknown)
48
61
  SENSITIVE = []
49
62
  include Aws::Structure
50
63
  include Aws::Structure::Union
51
64
 
52
- class ArrayValues < ArrayValue; end
53
65
  class BooleanValues < ArrayValue; end
54
- class DoubleValues < ArrayValue; end
55
66
  class LongValues < ArrayValue; end
67
+ class DoubleValues < ArrayValue; end
56
68
  class StringValues < ArrayValue; end
69
+ class ArrayValues < ArrayValue; end
57
70
  class Unknown < ArrayValue; end
58
71
  end
59
72
 
@@ -78,45 +91,71 @@ module Aws::RDSDataService
78
91
  # data as a hash:
79
92
  #
80
93
  # {
94
+ # resource_arn: "Arn", # required
95
+ # secret_arn: "Arn", # required
96
+ # sql: "SqlStatement", # required
81
97
  # database: "DbName",
98
+ # schema: "DbName",
82
99
  # parameter_sets: [
83
100
  # [
84
101
  # {
85
102
  # name: "ParameterName",
86
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
87
103
  # value: {
104
+ # is_null: false,
105
+ # boolean_value: false,
106
+ # long_value: 1,
107
+ # double_value: 1.0,
108
+ # string_value: "String",
109
+ # blob_value: "data",
88
110
  # array_value: {
111
+ # boolean_values: [false],
112
+ # long_values: [1],
113
+ # double_values: [1.0],
114
+ # string_values: ["String"],
89
115
  # array_values: [
90
116
  # {
91
117
  # # recursive ArrayValue
92
118
  # },
93
119
  # ],
94
- # boolean_values: [false],
95
- # double_values: [1.0],
96
- # long_values: [1],
97
- # string_values: ["String"],
98
120
  # },
99
- # blob_value: "data",
100
- # boolean_value: false,
101
- # double_value: 1.0,
102
- # is_null: false,
103
- # long_value: 1,
104
- # string_value: "String",
105
121
  # },
122
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
106
123
  # },
107
124
  # ],
108
125
  # ],
109
- # resource_arn: "Arn", # required
110
- # schema: "DbName",
111
- # secret_arn: "Arn", # required
112
- # sql: "SqlStatement", # required
113
126
  # transaction_id: "Id",
114
127
  # }
115
128
  #
129
+ # @!attribute [rw] resource_arn
130
+ # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] secret_arn
134
+ # The ARN of the secret that enables access to the DB cluster. Enter
135
+ # the database user name and password for the credentials in the
136
+ # secret.
137
+ #
138
+ # For information about creating the secret, see [Create a database
139
+ # secret][1].
140
+ #
141
+ #
142
+ #
143
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] sql
147
+ # The SQL statement to run. Don't include a semicolon (;) at the end
148
+ # of the SQL statement.
149
+ # @return [String]
150
+ #
116
151
  # @!attribute [rw] database
117
152
  # The name of the database.
118
153
  # @return [String]
119
154
  #
155
+ # @!attribute [rw] schema
156
+ # The name of the database schema.
157
+ # @return [String]
158
+ #
120
159
  # @!attribute [rw] parameter_sets
121
160
  # The parameter set for the batch operation.
122
161
  #
@@ -134,22 +173,6 @@ module Aws::RDSDataService
134
173
  # </note>
135
174
  # @return [Array<Array<Types::SqlParameter>>]
136
175
  #
137
- # @!attribute [rw] resource_arn
138
- # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
139
- # @return [String]
140
- #
141
- # @!attribute [rw] schema
142
- # The name of the database schema.
143
- # @return [String]
144
- #
145
- # @!attribute [rw] secret_arn
146
- # The name or ARN of the secret that enables access to the DB cluster.
147
- # @return [String]
148
- #
149
- # @!attribute [rw] sql
150
- # The SQL statement to run.
151
- # @return [String]
152
- #
153
176
  # @!attribute [rw] transaction_id
154
177
  # The identifier of a transaction that was started by using the
155
178
  # `BeginTransaction` operation. Specify the transaction ID of the
@@ -162,12 +185,12 @@ module Aws::RDSDataService
162
185
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatementRequest AWS API Documentation
163
186
  #
164
187
  class BatchExecuteStatementRequest < Struct.new(
165
- :database,
166
- :parameter_sets,
167
188
  :resource_arn,
168
- :schema,
169
189
  :secret_arn,
170
190
  :sql,
191
+ :database,
192
+ :schema,
193
+ :parameter_sets,
171
194
  :transaction_id)
172
195
  SENSITIVE = []
173
196
  include Aws::Structure
@@ -195,35 +218,35 @@ module Aws::RDSDataService
195
218
  # data as a hash:
196
219
  #
197
220
  # {
198
- # database: "DbName",
199
221
  # resource_arn: "Arn", # required
200
- # schema: "DbName",
201
222
  # secret_arn: "Arn", # required
223
+ # database: "DbName",
224
+ # schema: "DbName",
202
225
  # }
203
226
  #
204
- # @!attribute [rw] database
205
- # The name of the database.
206
- # @return [String]
207
- #
208
227
  # @!attribute [rw] resource_arn
209
228
  # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
210
229
  # @return [String]
211
230
  #
212
- # @!attribute [rw] schema
213
- # The name of the database schema.
214
- # @return [String]
215
- #
216
231
  # @!attribute [rw] secret_arn
217
232
  # The name or ARN of the secret that enables access to the DB cluster.
218
233
  # @return [String]
219
234
  #
235
+ # @!attribute [rw] database
236
+ # The name of the database.
237
+ # @return [String]
238
+ #
239
+ # @!attribute [rw] schema
240
+ # The name of the database schema.
241
+ # @return [String]
242
+ #
220
243
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BeginTransactionRequest AWS API Documentation
221
244
  #
222
245
  class BeginTransactionRequest < Struct.new(
223
- :database,
224
246
  :resource_arn,
225
- :schema,
226
- :secret_arn)
247
+ :secret_arn,
248
+ :database,
249
+ :schema)
227
250
  SENSITIVE = []
228
251
  include Aws::Structure
229
252
  end
@@ -245,34 +268,46 @@ module Aws::RDSDataService
245
268
 
246
269
  # Contains the metadata for a column.
247
270
  #
248
- # @!attribute [rw] array_base_column_type
271
+ # @!attribute [rw] name
272
+ # The name of the column.
273
+ # @return [String]
274
+ #
275
+ # @!attribute [rw] type
249
276
  # The type of the column.
250
277
  # @return [Integer]
251
278
  #
279
+ # @!attribute [rw] type_name
280
+ # The database-specific data type of the column.
281
+ # @return [String]
282
+ #
283
+ # @!attribute [rw] label
284
+ # The label for the column.
285
+ # @return [String]
286
+ #
287
+ # @!attribute [rw] schema_name
288
+ # The name of the schema that owns the table that includes the column.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] table_name
292
+ # The name of the table that includes the column.
293
+ # @return [String]
294
+ #
252
295
  # @!attribute [rw] is_auto_increment
253
296
  # A value that indicates whether the column increments automatically.
254
297
  # @return [Boolean]
255
298
  #
256
- # @!attribute [rw] is_case_sensitive
257
- # A value that indicates whether the column is case-sensitive.
299
+ # @!attribute [rw] is_signed
300
+ # A value that indicates whether an integer column is signed.
258
301
  # @return [Boolean]
259
302
  #
260
303
  # @!attribute [rw] is_currency
261
304
  # A value that indicates whether the column contains currency values.
262
305
  # @return [Boolean]
263
306
  #
264
- # @!attribute [rw] is_signed
265
- # A value that indicates whether an integer column is signed.
307
+ # @!attribute [rw] is_case_sensitive
308
+ # A value that indicates whether the column is case-sensitive.
266
309
  # @return [Boolean]
267
310
  #
268
- # @!attribute [rw] label
269
- # The label for the column.
270
- # @return [String]
271
- #
272
- # @!attribute [rw] name
273
- # The name of the column.
274
- # @return [String]
275
- #
276
311
  # @!attribute [rw] nullable
277
312
  # A value that indicates whether the column is nullable.
278
313
  # @return [Integer]
@@ -285,39 +320,27 @@ module Aws::RDSDataService
285
320
  # The scale value of a decimal number column.
286
321
  # @return [Integer]
287
322
  #
288
- # @!attribute [rw] schema_name
289
- # The name of the schema that owns the table that includes the column.
290
- # @return [String]
291
- #
292
- # @!attribute [rw] table_name
293
- # The name of the table that includes the column.
294
- # @return [String]
295
- #
296
- # @!attribute [rw] type
323
+ # @!attribute [rw] array_base_column_type
297
324
  # The type of the column.
298
325
  # @return [Integer]
299
326
  #
300
- # @!attribute [rw] type_name
301
- # The database-specific data type of the column.
302
- # @return [String]
303
- #
304
327
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ColumnMetadata AWS API Documentation
305
328
  #
306
329
  class ColumnMetadata < Struct.new(
307
- :array_base_column_type,
330
+ :name,
331
+ :type,
332
+ :type_name,
333
+ :label,
334
+ :schema_name,
335
+ :table_name,
308
336
  :is_auto_increment,
309
- :is_case_sensitive,
310
- :is_currency,
311
337
  :is_signed,
312
- :label,
313
- :name,
338
+ :is_currency,
339
+ :is_case_sensitive,
314
340
  :nullable,
315
341
  :precision,
316
342
  :scale,
317
- :schema_name,
318
- :table_name,
319
- :type,
320
- :type_name)
343
+ :array_base_column_type)
321
344
  SENSITIVE = []
322
345
  include Aws::Structure
323
346
  end
@@ -378,28 +401,28 @@ module Aws::RDSDataService
378
401
  # data as a hash:
379
402
  #
380
403
  # {
404
+ # db_cluster_or_instance_arn: "Arn", # required
381
405
  # aws_secret_store_arn: "Arn", # required
406
+ # sql_statements: "SqlStatement", # required
382
407
  # database: "DbName",
383
- # db_cluster_or_instance_arn: "Arn", # required
384
408
  # schema: "DbName",
385
- # sql_statements: "SqlStatement", # required
386
409
  # }
387
410
  #
411
+ # @!attribute [rw] db_cluster_or_instance_arn
412
+ # The ARN of the Aurora Serverless DB cluster.
413
+ # @return [String]
414
+ #
388
415
  # @!attribute [rw] aws_secret_store_arn
389
416
  # The Amazon Resource Name (ARN) of the secret that enables access to
390
- # the DB cluster.
391
- # @return [String]
417
+ # the DB cluster. Enter the database user name and password for the
418
+ # credentials in the secret.
392
419
  #
393
- # @!attribute [rw] database
394
- # The name of the database.
395
- # @return [String]
420
+ # For information about creating the secret, see [Create a database
421
+ # secret][1].
396
422
  #
397
- # @!attribute [rw] db_cluster_or_instance_arn
398
- # The ARN of the Aurora Serverless DB cluster.
399
- # @return [String]
400
423
  #
401
- # @!attribute [rw] schema
402
- # The name of the database schema.
424
+ #
425
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
403
426
  # @return [String]
404
427
  #
405
428
  # @!attribute [rw] sql_statements
@@ -410,14 +433,22 @@ module Aws::RDSDataService
410
433
  # definition, data manipulation, and commit statements.
411
434
  # @return [String]
412
435
  #
436
+ # @!attribute [rw] database
437
+ # The name of the database.
438
+ # @return [String]
439
+ #
440
+ # @!attribute [rw] schema
441
+ # The name of the database schema.
442
+ # @return [String]
443
+ #
413
444
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSqlRequest AWS API Documentation
414
445
  #
415
446
  class ExecuteSqlRequest < Struct.new(
447
+ :db_cluster_or_instance_arn,
416
448
  :aws_secret_store_arn,
449
+ :sql_statements,
417
450
  :database,
418
- :db_cluster_or_instance_arn,
419
- :schema,
420
- :sql_statements)
451
+ :schema)
421
452
  SENSITIVE = []
422
453
  include Aws::Structure
423
454
  end
@@ -444,78 +475,70 @@ module Aws::RDSDataService
444
475
  # data as a hash:
445
476
  #
446
477
  # {
447
- # continue_after_timeout: false,
478
+ # resource_arn: "Arn", # required
479
+ # secret_arn: "Arn", # required
480
+ # sql: "SqlStatement", # required
448
481
  # database: "DbName",
449
- # include_result_metadata: false,
482
+ # schema: "DbName",
450
483
  # parameters: [
451
484
  # {
452
485
  # name: "ParameterName",
453
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
454
486
  # value: {
487
+ # is_null: false,
488
+ # boolean_value: false,
489
+ # long_value: 1,
490
+ # double_value: 1.0,
491
+ # string_value: "String",
492
+ # blob_value: "data",
455
493
  # array_value: {
494
+ # boolean_values: [false],
495
+ # long_values: [1],
496
+ # double_values: [1.0],
497
+ # string_values: ["String"],
456
498
  # array_values: [
457
499
  # {
458
500
  # # recursive ArrayValue
459
501
  # },
460
502
  # ],
461
- # boolean_values: [false],
462
- # double_values: [1.0],
463
- # long_values: [1],
464
- # string_values: ["String"],
465
503
  # },
466
- # blob_value: "data",
467
- # boolean_value: false,
468
- # double_value: 1.0,
469
- # is_null: false,
470
- # long_value: 1,
471
- # string_value: "String",
472
504
  # },
505
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
473
506
  # },
474
507
  # ],
475
- # resource_arn: "Arn", # required
508
+ # transaction_id: "Id",
509
+ # include_result_metadata: false,
510
+ # continue_after_timeout: false,
476
511
  # result_set_options: {
477
512
  # decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
513
+ # long_return_type: "STRING", # accepts STRING, LONG
478
514
  # },
479
- # schema: "DbName",
480
- # secret_arn: "Arn", # required
481
- # sql: "SqlStatement", # required
482
- # transaction_id: "Id",
515
+ # format_records_as: "NONE", # accepts NONE, JSON
483
516
  # }
484
517
  #
485
- # @!attribute [rw] continue_after_timeout
486
- # A value that indicates whether to continue running the statement
487
- # after the call times out. By default, the statement stops running
488
- # when the call times out.
489
- #
490
- # For DDL statements, we recommend continuing to run the statement
491
- # after the call times out. When a DDL statement terminates before it
492
- # is finished running, it can result in errors and possibly corrupted
493
- # data structures.
494
- # @return [Boolean]
495
- #
496
- # @!attribute [rw] database
497
- # The name of the database.
518
+ # @!attribute [rw] resource_arn
519
+ # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
498
520
  # @return [String]
499
521
  #
500
- # @!attribute [rw] include_result_metadata
501
- # A value that indicates whether to include metadata in the results.
502
- # @return [Boolean]
522
+ # @!attribute [rw] secret_arn
523
+ # The ARN of the secret that enables access to the DB cluster. Enter
524
+ # the database user name and password for the credentials in the
525
+ # secret.
503
526
  #
504
- # @!attribute [rw] parameters
505
- # The parameters for the SQL statement.
527
+ # For information about creating the secret, see [Create a database
528
+ # secret][1].
506
529
  #
507
- # <note markdown="1"> Array parameters are not supported.
508
530
  #
509
- # </note>
510
- # @return [Array<Types::SqlParameter>]
511
531
  #
512
- # @!attribute [rw] resource_arn
513
- # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
532
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
514
533
  # @return [String]
515
534
  #
516
- # @!attribute [rw] result_set_options
517
- # Options that control how the result set is returned.
518
- # @return [Types::ResultSetOptions]
535
+ # @!attribute [rw] sql
536
+ # The SQL statement to run.
537
+ # @return [String]
538
+ #
539
+ # @!attribute [rw] database
540
+ # The name of the database.
541
+ # @return [String]
519
542
  #
520
543
  # @!attribute [rw] schema
521
544
  # The name of the database schema.
@@ -525,13 +548,13 @@ module Aws::RDSDataService
525
548
  # </note>
526
549
  # @return [String]
527
550
  #
528
- # @!attribute [rw] secret_arn
529
- # The name or ARN of the secret that enables access to the DB cluster.
530
- # @return [String]
551
+ # @!attribute [rw] parameters
552
+ # The parameters for the SQL statement.
531
553
  #
532
- # @!attribute [rw] sql
533
- # The SQL statement to run.
534
- # @return [String]
554
+ # <note markdown="1"> Array parameters are not supported.
555
+ #
556
+ # </note>
557
+ # @return [Array<Types::SqlParameter>]
535
558
  #
536
559
  # @!attribute [rw] transaction_id
537
560
  # The identifier of a transaction that was started by using the
@@ -542,19 +565,56 @@ module Aws::RDSDataService
542
565
  # parameter.
543
566
  # @return [String]
544
567
  #
568
+ # @!attribute [rw] include_result_metadata
569
+ # A value that indicates whether to include metadata in the results.
570
+ # @return [Boolean]
571
+ #
572
+ # @!attribute [rw] continue_after_timeout
573
+ # A value that indicates whether to continue running the statement
574
+ # after the call times out. By default, the statement stops running
575
+ # when the call times out.
576
+ #
577
+ # <note markdown="1"> For DDL statements, we recommend continuing to run the statement
578
+ # after the call times out. When a DDL statement terminates before it
579
+ # is finished running, it can result in errors and possibly corrupted
580
+ # data structures.
581
+ #
582
+ # </note>
583
+ # @return [Boolean]
584
+ #
585
+ # @!attribute [rw] result_set_options
586
+ # Options that control how the result set is returned.
587
+ # @return [Types::ResultSetOptions]
588
+ #
589
+ # @!attribute [rw] format_records_as
590
+ # A value that indicates whether to format the result set as a single
591
+ # JSON string. This parameter only applies to `SELECT` statements and
592
+ # is ignored for other types of statements. Allowed values are `NONE`
593
+ # and `JSON`. The default value is `NONE`. The result is returned in
594
+ # the `formattedRecords` field.
595
+ #
596
+ # For usage information about the JSON format for result sets, see
597
+ # [Using the Data API][1] in the *Amazon Aurora User Guide*.
598
+ #
599
+ #
600
+ #
601
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
602
+ # @return [String]
603
+ #
545
604
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementRequest AWS API Documentation
546
605
  #
547
606
  class ExecuteStatementRequest < Struct.new(
548
- :continue_after_timeout,
549
- :database,
550
- :include_result_metadata,
551
- :parameters,
552
607
  :resource_arn,
553
- :result_set_options,
554
- :schema,
555
608
  :secret_arn,
556
609
  :sql,
557
- :transaction_id)
610
+ :database,
611
+ :schema,
612
+ :parameters,
613
+ :transaction_id,
614
+ :include_result_metadata,
615
+ :continue_after_timeout,
616
+ :result_set_options,
617
+ :format_records_as)
558
618
  SENSITIVE = []
559
619
  include Aws::Structure
560
620
  end
@@ -562,31 +622,44 @@ module Aws::RDSDataService
562
622
  # The response elements represent the output of a request to run a SQL
563
623
  # statement against a database.
564
624
  #
625
+ # @!attribute [rw] records
626
+ # The records returned by the SQL statement. This field is blank if
627
+ # the `formatRecordsAs` parameter is set to `JSON`.
628
+ # @return [Array<Array<Types::Field>>]
629
+ #
565
630
  # @!attribute [rw] column_metadata
566
- # Metadata for the columns included in the results.
631
+ # Metadata for the columns included in the results. This field is
632
+ # blank if the `formatRecordsAs` parameter is set to `JSON`.
567
633
  # @return [Array<Types::ColumnMetadata>]
568
634
  #
635
+ # @!attribute [rw] number_of_records_updated
636
+ # The number of records updated by the request.
637
+ # @return [Integer]
638
+ #
569
639
  # @!attribute [rw] generated_fields
570
- # Values for fields generated during the request.
640
+ # Values for fields generated during a DML request.
571
641
  #
572
642
  # <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>
573
643
  # @return [Array<Types::Field>]
574
644
  #
575
- # @!attribute [rw] number_of_records_updated
576
- # The number of records updated by the request.
577
- # @return [Integer]
645
+ # @!attribute [rw] formatted_records
646
+ # A string value that represents the result set of a `SELECT`
647
+ # statement in JSON format. This value is only present when the
648
+ # `formatRecordsAs` parameter is set to `JSON`.
578
649
  #
579
- # @!attribute [rw] records
580
- # The records returned by the SQL statement.
581
- # @return [Array<Array<Types::Field>>]
650
+ # The size limit for this field is currently 10 MB. If the
651
+ # JSON-formatted string representing the result set requires more than
652
+ # 10 MB, the call returns an error.
653
+ # @return [String]
582
654
  #
583
655
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementResponse AWS API Documentation
584
656
  #
585
657
  class ExecuteStatementResponse < Struct.new(
658
+ :records,
586
659
  :column_metadata,
587
- :generated_fields,
588
660
  :number_of_records_updated,
589
- :records)
661
+ :generated_fields,
662
+ :formatted_records)
590
663
  SENSITIVE = []
591
664
  include Aws::Structure
592
665
  end
@@ -597,56 +670,56 @@ module Aws::RDSDataService
597
670
  #
598
671
  # @note Field is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Field corresponding to the set member.
599
672
  #
600
- # @!attribute [rw] array_value
601
- # An array of values.
602
- # @return [Types::ArrayValue]
603
- #
604
- # @!attribute [rw] blob_value
605
- # A value of BLOB data type.
606
- # @return [String]
673
+ # @!attribute [rw] is_null
674
+ # A NULL value.
675
+ # @return [Boolean]
607
676
  #
608
677
  # @!attribute [rw] boolean_value
609
678
  # A value of Boolean data type.
610
679
  # @return [Boolean]
611
680
  #
612
- # @!attribute [rw] double_value
613
- # A value of double data type.
614
- # @return [Float]
615
- #
616
- # @!attribute [rw] is_null
617
- # A NULL value.
618
- # @return [Boolean]
619
- #
620
681
  # @!attribute [rw] long_value
621
682
  # A value of long data type.
622
683
  # @return [Integer]
623
684
  #
685
+ # @!attribute [rw] double_value
686
+ # A value of double data type.
687
+ # @return [Float]
688
+ #
624
689
  # @!attribute [rw] string_value
625
690
  # A value of string data type.
626
691
  # @return [String]
627
692
  #
693
+ # @!attribute [rw] blob_value
694
+ # A value of BLOB data type.
695
+ # @return [String]
696
+ #
697
+ # @!attribute [rw] array_value
698
+ # An array of values.
699
+ # @return [Types::ArrayValue]
700
+ #
628
701
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Field AWS API Documentation
629
702
  #
630
703
  class Field < Struct.new(
631
- :array_value,
632
- :blob_value,
633
- :boolean_value,
634
- :double_value,
635
704
  :is_null,
705
+ :boolean_value,
636
706
  :long_value,
707
+ :double_value,
637
708
  :string_value,
709
+ :blob_value,
710
+ :array_value,
638
711
  :unknown)
639
712
  SENSITIVE = []
640
713
  include Aws::Structure
641
714
  include Aws::Structure::Union
642
715
 
643
- class ArrayValue < Field; end
644
- class BlobValue < Field; end
645
- class BooleanValue < Field; end
646
- class DoubleValue < Field; end
647
716
  class IsNull < Field; end
717
+ class BooleanValue < Field; end
648
718
  class LongValue < Field; end
719
+ class DoubleValue < Field; end
649
720
  class StringValue < Field; end
721
+ class BlobValue < Field; end
722
+ class ArrayValue < Field; end
650
723
  class Unknown < Field; end
651
724
  end
652
725
 
@@ -687,6 +760,12 @@ module Aws::RDSDataService
687
760
 
688
761
  # A record returned by a call.
689
762
  #
763
+ # <note markdown="1"> This data structure is only used with the deprecated `ExecuteSql`
764
+ # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
765
+ # operation instead.
766
+ #
767
+ # </note>
768
+ #
690
769
  # @!attribute [rw] values
691
770
  # The values returned in the record.
692
771
  # @return [Array<Types::Value>]
@@ -701,19 +780,25 @@ module Aws::RDSDataService
701
780
 
702
781
  # The result set returned by a SQL statement.
703
782
  #
704
- # @!attribute [rw] records
705
- # The records in the result set.
706
- # @return [Array<Types::Record>]
783
+ # <note markdown="1"> This data structure is only used with the deprecated `ExecuteSql`
784
+ # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
785
+ # operation instead.
786
+ #
787
+ # </note>
707
788
  #
708
789
  # @!attribute [rw] result_set_metadata
709
790
  # The result-set metadata in the result set.
710
791
  # @return [Types::ResultSetMetadata]
711
792
  #
793
+ # @!attribute [rw] records
794
+ # The records in the result set.
795
+ # @return [Array<Types::Record>]
796
+ #
712
797
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultFrame AWS API Documentation
713
798
  #
714
799
  class ResultFrame < Struct.new(
715
- :records,
716
- :result_set_metadata)
800
+ :result_set_metadata,
801
+ :records)
717
802
  SENSITIVE = []
718
803
  include Aws::Structure
719
804
  end
@@ -744,6 +829,7 @@ module Aws::RDSDataService
744
829
  #
745
830
  # {
746
831
  # decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
832
+ # long_return_type: "STRING", # accepts STRING, LONG
747
833
  # }
748
834
  #
749
835
  # @!attribute [rw] decimal_return_type
@@ -753,15 +839,25 @@ module Aws::RDSDataService
753
839
  # specifies that it is converted to a Long value if its scale is 0, or
754
840
  # to a Double value otherwise.
755
841
  #
756
- # Conversion to Double or Long can result in roundoff errors due to
842
+ # <note markdown="1"> Conversion to Double or Long can result in roundoff errors due to
757
843
  # precision loss. We recommend converting to String, especially when
758
844
  # working with currency values.
845
+ #
846
+ # </note>
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] long_return_type
850
+ # A value that indicates how a field of `LONG` type is represented.
851
+ # Allowed values are `LONG` and `STRING`. The default is `LONG`.
852
+ # Specify `STRING` if the length or precision of numeric values might
853
+ # cause truncation or rounding errors.
759
854
  # @return [String]
760
855
  #
761
856
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultSetOptions AWS API Documentation
762
857
  #
763
858
  class ResultSetOptions < Struct.new(
764
- :decimal_return_type)
859
+ :decimal_return_type,
860
+ :long_return_type)
765
861
  SENSITIVE = []
766
862
  include Aws::Structure
767
863
  end
@@ -828,32 +924,36 @@ module Aws::RDSDataService
828
924
  #
829
925
  # {
830
926
  # name: "ParameterName",
831
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
832
927
  # value: {
928
+ # is_null: false,
929
+ # boolean_value: false,
930
+ # long_value: 1,
931
+ # double_value: 1.0,
932
+ # string_value: "String",
933
+ # blob_value: "data",
833
934
  # array_value: {
935
+ # boolean_values: [false],
936
+ # long_values: [1],
937
+ # double_values: [1.0],
938
+ # string_values: ["String"],
834
939
  # array_values: [
835
940
  # {
836
941
  # # recursive ArrayValue
837
942
  # },
838
943
  # ],
839
- # boolean_values: [false],
840
- # double_values: [1.0],
841
- # long_values: [1],
842
- # string_values: ["String"],
843
944
  # },
844
- # blob_value: "data",
845
- # boolean_value: false,
846
- # double_value: 1.0,
847
- # is_null: false,
848
- # long_value: 1,
849
- # string_value: "String",
850
945
  # },
946
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
851
947
  # }
852
948
  #
853
949
  # @!attribute [rw] name
854
950
  # The name of the parameter.
855
951
  # @return [String]
856
952
  #
953
+ # @!attribute [rw] value
954
+ # The value of the parameter.
955
+ # @return [Types::Field]
956
+ #
857
957
  # @!attribute [rw] type_hint
858
958
  # A hint that specifies the correct object type for data type mapping.
859
959
  # Possible values are as follows:
@@ -880,63 +980,65 @@ module Aws::RDSDataService
880
980
  # object of `UUID` type to the database.
881
981
  # @return [String]
882
982
  #
883
- # @!attribute [rw] value
884
- # The value of the parameter.
885
- # @return [Types::Field]
886
- #
887
983
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlParameter AWS API Documentation
888
984
  #
889
985
  class SqlParameter < Struct.new(
890
986
  :name,
891
- :type_hint,
892
- :value)
987
+ :value,
988
+ :type_hint)
893
989
  SENSITIVE = []
894
990
  include Aws::Structure
895
991
  end
896
992
 
897
993
  # The result of a SQL statement.
898
994
  #
899
- # <important> <p>This data type is deprecated.</p> </important>
900
- #
901
- # @!attribute [rw] number_of_records_updated
902
- # The number of records updated by a SQL statement.
903
- # @return [Integer]
995
+ # <note> <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p> </note>
904
996
  #
905
997
  # @!attribute [rw] result_frame
906
998
  # The result set of the SQL statement.
907
999
  # @return [Types::ResultFrame]
908
1000
  #
1001
+ # @!attribute [rw] number_of_records_updated
1002
+ # The number of records updated by a SQL statement.
1003
+ # @return [Integer]
1004
+ #
909
1005
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlStatementResult AWS API Documentation
910
1006
  #
911
1007
  class SqlStatementResult < Struct.new(
912
- :number_of_records_updated,
913
- :result_frame)
1008
+ :result_frame,
1009
+ :number_of_records_updated)
914
1010
  SENSITIVE = []
915
1011
  include Aws::Structure
916
1012
  end
917
1013
 
918
1014
  # The execution of the SQL statement timed out.
919
1015
  #
920
- # @!attribute [rw] db_connection_id
921
- # The database connection ID that executed the SQL statement.
922
- # @return [Integer]
923
- #
924
1016
  # @!attribute [rw] message
925
1017
  # The error message returned by this `StatementTimeoutException`
926
1018
  # error.
927
1019
  # @return [String]
928
1020
  #
1021
+ # @!attribute [rw] db_connection_id
1022
+ # The database connection ID that executed the SQL statement.
1023
+ # @return [Integer]
1024
+ #
929
1025
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/StatementTimeoutException AWS API Documentation
930
1026
  #
931
1027
  class StatementTimeoutException < Struct.new(
932
- :db_connection_id,
933
- :message)
1028
+ :message,
1029
+ :db_connection_id)
934
1030
  SENSITIVE = []
935
1031
  include Aws::Structure
936
1032
  end
937
1033
 
938
1034
  # A structure value returned by a call.
939
1035
  #
1036
+ # <note markdown="1"> This data structure is only used with the deprecated `ExecuteSql`
1037
+ # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
1038
+ # operation instead.
1039
+ #
1040
+ # </note>
1041
+ #
940
1042
  # @!attribute [rw] attributes
941
1043
  # The attributes returned in the record.
942
1044
  # @return [Array<Types::Value>]
@@ -965,37 +1067,29 @@ module Aws::RDSDataService
965
1067
 
966
1068
  # Contains the value of a column.
967
1069
  #
968
- # <important> <p>This data type is deprecated.</p> </important>
1070
+ # <note> <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p> </note>
969
1071
  #
970
1072
  # @note Value is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Value corresponding to the set member.
971
1073
  #
972
- # @!attribute [rw] array_values
973
- # An array of column values.
974
- # @return [Array<Types::Value>]
975
- #
976
- # @!attribute [rw] big_int_value
977
- # A value for a column of big integer data type.
978
- # @return [Integer]
1074
+ # @!attribute [rw] is_null
1075
+ # A NULL value.
1076
+ # @return [Boolean]
979
1077
  #
980
1078
  # @!attribute [rw] bit_value
981
1079
  # A value for a column of BIT data type.
982
1080
  # @return [Boolean]
983
1081
  #
984
- # @!attribute [rw] blob_value
985
- # A value for a column of BLOB data type.
986
- # @return [String]
987
- #
988
- # @!attribute [rw] double_value
989
- # A value for a column of double data type.
990
- # @return [Float]
1082
+ # @!attribute [rw] big_int_value
1083
+ # A value for a column of big integer data type.
1084
+ # @return [Integer]
991
1085
  #
992
1086
  # @!attribute [rw] int_value
993
1087
  # A value for a column of integer data type.
994
1088
  # @return [Integer]
995
1089
  #
996
- # @!attribute [rw] is_null
997
- # A NULL value.
998
- # @return [Boolean]
1090
+ # @!attribute [rw] double_value
1091
+ # A value for a column of double data type.
1092
+ # @return [Float]
999
1093
  #
1000
1094
  # @!attribute [rw] real_value
1001
1095
  # A value for a column of real data type.
@@ -1005,6 +1099,14 @@ module Aws::RDSDataService
1005
1099
  # A value for a column of string data type.
1006
1100
  # @return [String]
1007
1101
  #
1102
+ # @!attribute [rw] blob_value
1103
+ # A value for a column of BLOB data type.
1104
+ # @return [String]
1105
+ #
1106
+ # @!attribute [rw] array_values
1107
+ # An array of column values.
1108
+ # @return [Array<Types::Value>]
1109
+ #
1008
1110
  # @!attribute [rw] struct_value
1009
1111
  # A value for a column of STRUCT data type.
1010
1112
  # @return [Types::StructValue]
@@ -1012,30 +1114,30 @@ module Aws::RDSDataService
1012
1114
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Value AWS API Documentation
1013
1115
  #
1014
1116
  class Value < Struct.new(
1015
- :array_values,
1016
- :big_int_value,
1117
+ :is_null,
1017
1118
  :bit_value,
1018
- :blob_value,
1019
- :double_value,
1119
+ :big_int_value,
1020
1120
  :int_value,
1021
- :is_null,
1121
+ :double_value,
1022
1122
  :real_value,
1023
1123
  :string_value,
1124
+ :blob_value,
1125
+ :array_values,
1024
1126
  :struct_value,
1025
1127
  :unknown)
1026
1128
  SENSITIVE = []
1027
1129
  include Aws::Structure
1028
1130
  include Aws::Structure::Union
1029
1131
 
1030
- class ArrayValues < Value; end
1031
- class BigIntValue < Value; end
1132
+ class IsNull < Value; end
1032
1133
  class BitValue < Value; end
1033
- class BlobValue < Value; end
1034
- class DoubleValue < Value; end
1134
+ class BigIntValue < Value; end
1035
1135
  class IntValue < Value; end
1036
- class IsNull < Value; end
1136
+ class DoubleValue < Value; end
1037
1137
  class RealValue < Value; end
1038
1138
  class StringValue < Value; end
1139
+ class BlobValue < Value; end
1140
+ class ArrayValues < Value; end
1039
1141
  class StructValue < Value; end
1040
1142
  class Unknown < Value; end
1041
1143
  end