aws-sdk-rdsdataservice 1.36.0 → 1.38.0

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