aws-sdk-rdsdataservice 1.36.0 → 1.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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,31 @@ 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
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] parameter_sets
160
+ # The parameter set for the batch operation.
161
+ #
162
+ # The SQL statement is executed as many times as the number of
163
+ # parameter sets provided. To execute a SQL statement with no
164
+ # parameters, use one of the following options:
165
+ #
166
+ # * Specify one or more empty parameter sets.
167
+ #
168
+ # * Use the `ExecuteStatement` operation instead of the
169
+ # `BatchExecuteStatement` operation.
170
+ #
171
+ # <note markdown="1"> Array parameters are not supported.
172
+ #
173
+ # </note>
174
+ # @return [Array<Array<Types::SqlParameter>>]
175
+ #
176
176
  # @!attribute [rw] transaction_id
177
177
  # The identifier of a transaction that was started by using the
178
178
  # `BeginTransaction` operation. Specify the transaction ID of the
@@ -185,12 +185,12 @@ module Aws::RDSDataService
185
185
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatementRequest AWS API Documentation
186
186
  #
187
187
  class BatchExecuteStatementRequest < Struct.new(
188
- :database,
189
- :parameter_sets,
190
188
  :resource_arn,
191
- :schema,
192
189
  :secret_arn,
193
190
  :sql,
191
+ :database,
192
+ :schema,
193
+ :parameter_sets,
194
194
  :transaction_id)
195
195
  SENSITIVE = []
196
196
  include Aws::Structure
@@ -218,35 +218,35 @@ module Aws::RDSDataService
218
218
  # data as a hash:
219
219
  #
220
220
  # {
221
- # database: "DbName",
222
221
  # resource_arn: "Arn", # required
223
- # schema: "DbName",
224
222
  # secret_arn: "Arn", # required
223
+ # database: "DbName",
224
+ # schema: "DbName",
225
225
  # }
226
226
  #
227
- # @!attribute [rw] database
228
- # The name of the database.
229
- # @return [String]
230
- #
231
227
  # @!attribute [rw] resource_arn
232
228
  # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
233
229
  # @return [String]
234
230
  #
235
- # @!attribute [rw] schema
236
- # The name of the database schema.
237
- # @return [String]
238
- #
239
231
  # @!attribute [rw] secret_arn
240
232
  # The name or ARN of the secret that enables access to the DB cluster.
241
233
  # @return [String]
242
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
+ #
243
243
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BeginTransactionRequest AWS API Documentation
244
244
  #
245
245
  class BeginTransactionRequest < Struct.new(
246
- :database,
247
246
  :resource_arn,
248
- :schema,
249
- :secret_arn)
247
+ :secret_arn,
248
+ :database,
249
+ :schema)
250
250
  SENSITIVE = []
251
251
  include Aws::Structure
252
252
  end
@@ -268,34 +268,46 @@ module Aws::RDSDataService
268
268
 
269
269
  # Contains the metadata for a column.
270
270
  #
271
- # @!attribute [rw] array_base_column_type
271
+ # @!attribute [rw] name
272
+ # The name of the column.
273
+ # @return [String]
274
+ #
275
+ # @!attribute [rw] type
272
276
  # The type of the column.
273
277
  # @return [Integer]
274
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
+ #
275
295
  # @!attribute [rw] is_auto_increment
276
296
  # A value that indicates whether the column increments automatically.
277
297
  # @return [Boolean]
278
298
  #
279
- # @!attribute [rw] is_case_sensitive
280
- # 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.
281
301
  # @return [Boolean]
282
302
  #
283
303
  # @!attribute [rw] is_currency
284
304
  # A value that indicates whether the column contains currency values.
285
305
  # @return [Boolean]
286
306
  #
287
- # @!attribute [rw] is_signed
288
- # 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.
289
309
  # @return [Boolean]
290
310
  #
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
311
  # @!attribute [rw] nullable
300
312
  # A value that indicates whether the column is nullable.
301
313
  # @return [Integer]
@@ -308,39 +320,27 @@ module Aws::RDSDataService
308
320
  # The scale value of a decimal number column.
309
321
  # @return [Integer]
310
322
  #
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
323
+ # @!attribute [rw] array_base_column_type
320
324
  # The type of the column.
321
325
  # @return [Integer]
322
326
  #
323
- # @!attribute [rw] type_name
324
- # The database-specific data type of the column.
325
- # @return [String]
326
- #
327
327
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ColumnMetadata AWS API Documentation
328
328
  #
329
329
  class ColumnMetadata < Struct.new(
330
- :array_base_column_type,
330
+ :name,
331
+ :type,
332
+ :type_name,
333
+ :label,
334
+ :schema_name,
335
+ :table_name,
331
336
  :is_auto_increment,
332
- :is_case_sensitive,
333
- :is_currency,
334
337
  :is_signed,
335
- :label,
336
- :name,
338
+ :is_currency,
339
+ :is_case_sensitive,
337
340
  :nullable,
338
341
  :precision,
339
342
  :scale,
340
- :schema_name,
341
- :table_name,
342
- :type,
343
- :type_name)
343
+ :array_base_column_type)
344
344
  SENSITIVE = []
345
345
  include Aws::Structure
346
346
  end
@@ -401,13 +401,17 @@ module Aws::RDSDataService
401
401
  # data as a hash:
402
402
  #
403
403
  # {
404
+ # db_cluster_or_instance_arn: "Arn", # required
404
405
  # aws_secret_store_arn: "Arn", # required
406
+ # sql_statements: "SqlStatement", # required
405
407
  # database: "DbName",
406
- # db_cluster_or_instance_arn: "Arn", # required
407
408
  # schema: "DbName",
408
- # sql_statements: "SqlStatement", # required
409
409
  # }
410
410
  #
411
+ # @!attribute [rw] db_cluster_or_instance_arn
412
+ # The ARN of the Aurora Serverless DB cluster.
413
+ # @return [String]
414
+ #
411
415
  # @!attribute [rw] aws_secret_store_arn
412
416
  # The Amazon Resource Name (ARN) of the secret that enables access to
413
417
  # the DB cluster. Enter the database user name and password for the
@@ -421,18 +425,6 @@ module Aws::RDSDataService
421
425
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
422
426
  # @return [String]
423
427
  #
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
428
  # @!attribute [rw] sql_statements
437
429
  # One or more SQL statements to run on the DB cluster.
438
430
  #
@@ -441,14 +433,22 @@ module Aws::RDSDataService
441
433
  # definition, data manipulation, and commit statements.
442
434
  # @return [String]
443
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
+ #
444
444
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSqlRequest AWS API Documentation
445
445
  #
446
446
  class ExecuteSqlRequest < Struct.new(
447
+ :db_cluster_or_instance_arn,
447
448
  :aws_secret_store_arn,
449
+ :sql_statements,
448
450
  :database,
449
- :db_cluster_or_instance_arn,
450
- :schema,
451
- :sql_statements)
451
+ :schema)
452
452
  SENSITIVE = []
453
453
  include Aws::Structure
454
454
  end
@@ -475,120 +475,86 @@ module Aws::RDSDataService
475
475
  # data as a hash:
476
476
  #
477
477
  # {
478
- # continue_after_timeout: false,
478
+ # resource_arn: "Arn", # required
479
+ # secret_arn: "Arn", # required
480
+ # sql: "SqlStatement", # required
479
481
  # database: "DbName",
480
- # format_records_as: "NONE", # accepts NONE, JSON
481
- # include_result_metadata: false,
482
+ # schema: "DbName",
482
483
  # parameters: [
483
484
  # {
484
485
  # name: "ParameterName",
485
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
486
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",
487
493
  # array_value: {
494
+ # boolean_values: [false],
495
+ # long_values: [1],
496
+ # double_values: [1.0],
497
+ # string_values: ["String"],
488
498
  # array_values: [
489
499
  # {
490
500
  # # recursive ArrayValue
491
501
  # },
492
502
  # ],
493
- # boolean_values: [false],
494
- # double_values: [1.0],
495
- # long_values: [1],
496
- # string_values: ["String"],
497
503
  # },
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
504
  # },
505
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
505
506
  # },
506
507
  # ],
507
- # resource_arn: "Arn", # required
508
+ # transaction_id: "Id",
509
+ # include_result_metadata: false,
510
+ # continue_after_timeout: false,
508
511
  # result_set_options: {
509
512
  # decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
510
513
  # long_return_type: "STRING", # accepts STRING, LONG
511
514
  # },
512
- # schema: "DbName",
513
- # secret_arn: "Arn", # required
514
- # sql: "SqlStatement", # required
515
- # transaction_id: "Id",
515
+ # format_records_as: "NONE", # accepts NONE, JSON
516
516
  # }
517
517
  #
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.
518
+ # @!attribute [rw] resource_arn
519
+ # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
531
520
  # @return [String]
532
521
  #
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.
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.
539
526
  #
540
- # For usage information about the JSON format for result sets, see
541
- # [Using the Data API][1] in the *Amazon Aurora User Guide*.
527
+ # For information about creating the secret, see [Create a database
528
+ # secret][1].
542
529
  #
543
530
  #
544
531
  #
545
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
532
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
546
533
  # @return [String]
547
534
  #
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.
535
+ # @!attribute [rw] sql
536
+ # The SQL statement to run.
562
537
  # @return [String]
563
538
  #
564
- # @!attribute [rw] result_set_options
565
- # Options that control how the result set is returned.
566
- # @return [Types::ResultSetOptions]
539
+ # @!attribute [rw] database
540
+ # The name of the database.
541
+ # @return [String]
567
542
  #
568
543
  # @!attribute [rw] schema
569
544
  # The name of the database schema.
570
545
  #
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
- #
546
+ # <note markdown="1"> Currently, the `schema` parameter isn't supported.
585
547
  #
586
- # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
548
+ # </note>
587
549
  # @return [String]
588
550
  #
589
- # @!attribute [rw] sql
590
- # The SQL statement to run.
591
- # @return [String]
551
+ # @!attribute [rw] parameters
552
+ # The parameters for the SQL statement.
553
+ #
554
+ # <note markdown="1"> Array parameters are not supported.
555
+ #
556
+ # </note>
557
+ # @return [Array<Types::SqlParameter>]
592
558
  #
593
559
  # @!attribute [rw] transaction_id
594
560
  # The identifier of a transaction that was started by using the
@@ -599,20 +565,56 @@ module Aws::RDSDataService
599
565
  # parameter.
600
566
  # @return [String]
601
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
+ #
602
604
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementRequest AWS API Documentation
603
605
  #
604
606
  class ExecuteStatementRequest < Struct.new(
605
- :continue_after_timeout,
606
- :database,
607
- :format_records_as,
608
- :include_result_metadata,
609
- :parameters,
610
607
  :resource_arn,
611
- :result_set_options,
612
- :schema,
613
608
  :secret_arn,
614
609
  :sql,
615
- :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)
616
618
  SENSITIVE = []
617
619
  include Aws::Structure
618
620
  end
@@ -620,11 +622,26 @@ module Aws::RDSDataService
620
622
  # The response elements represent the output of a request to run a SQL
621
623
  # statement against a database.
622
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
+ #
623
630
  # @!attribute [rw] column_metadata
624
631
  # Metadata for the columns included in the results. This field is
625
632
  # blank if the `formatRecordsAs` parameter is set to `JSON`.
626
633
  # @return [Array<Types::ColumnMetadata>]
627
634
  #
635
+ # @!attribute [rw] number_of_records_updated
636
+ # The number of records updated by the request.
637
+ # @return [Integer]
638
+ #
639
+ # @!attribute [rw] generated_fields
640
+ # Values for fields generated during a DML request.
641
+ #
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>
643
+ # @return [Array<Types::Field>]
644
+ #
628
645
  # @!attribute [rw] formatted_records
629
646
  # A string value that represents the result set of a `SELECT`
630
647
  # statement in JSON format. This value is only present when the
@@ -635,29 +652,14 @@ module Aws::RDSDataService
635
652
  # 10 MB, the call returns an error.
636
653
  # @return [String]
637
654
  #
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
655
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementResponse AWS API Documentation
654
656
  #
655
657
  class ExecuteStatementResponse < Struct.new(
658
+ :records,
656
659
  :column_metadata,
657
- :formatted_records,
658
- :generated_fields,
659
660
  :number_of_records_updated,
660
- :records)
661
+ :generated_fields,
662
+ :formatted_records)
661
663
  SENSITIVE = []
662
664
  include Aws::Structure
663
665
  end
@@ -668,56 +670,56 @@ module Aws::RDSDataService
668
670
  #
669
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.
670
672
  #
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]
673
+ # @!attribute [rw] is_null
674
+ # A NULL value.
675
+ # @return [Boolean]
678
676
  #
679
677
  # @!attribute [rw] boolean_value
680
678
  # A value of Boolean data type.
681
679
  # @return [Boolean]
682
680
  #
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
681
  # @!attribute [rw] long_value
692
682
  # A value of long data type.
693
683
  # @return [Integer]
694
684
  #
685
+ # @!attribute [rw] double_value
686
+ # A value of double data type.
687
+ # @return [Float]
688
+ #
695
689
  # @!attribute [rw] string_value
696
690
  # A value of string data type.
697
691
  # @return [String]
698
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
+ #
699
701
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Field AWS API Documentation
700
702
  #
701
703
  class Field < Struct.new(
702
- :array_value,
703
- :blob_value,
704
- :boolean_value,
705
- :double_value,
706
704
  :is_null,
705
+ :boolean_value,
707
706
  :long_value,
707
+ :double_value,
708
708
  :string_value,
709
+ :blob_value,
710
+ :array_value,
709
711
  :unknown)
710
712
  SENSITIVE = []
711
713
  include Aws::Structure
712
714
  include Aws::Structure::Union
713
715
 
714
- class ArrayValue < Field; end
715
- class BlobValue < Field; end
716
- class BooleanValue < Field; end
717
- class DoubleValue < Field; end
718
716
  class IsNull < Field; end
717
+ class BooleanValue < Field; end
719
718
  class LongValue < Field; end
719
+ class DoubleValue < Field; end
720
720
  class StringValue < Field; end
721
+ class BlobValue < Field; end
722
+ class ArrayValue < Field; end
721
723
  class Unknown < Field; end
722
724
  end
723
725
 
@@ -758,10 +760,12 @@ module Aws::RDSDataService
758
760
 
759
761
  # A record returned by a call.
760
762
  #
761
- # This data structure is only used with the deprecated `ExecuteSql`
763
+ # <note markdown="1"> This data structure is only used with the deprecated `ExecuteSql`
762
764
  # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
763
765
  # operation instead.
764
766
  #
767
+ # </note>
768
+ #
765
769
  # @!attribute [rw] values
766
770
  # The values returned in the record.
767
771
  # @return [Array<Types::Value>]
@@ -776,23 +780,25 @@ module Aws::RDSDataService
776
780
 
777
781
  # The result set returned by a SQL statement.
778
782
  #
779
- # This data structure is only used with the deprecated `ExecuteSql`
783
+ # <note markdown="1"> This data structure is only used with the deprecated `ExecuteSql`
780
784
  # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
781
785
  # operation instead.
782
786
  #
783
- # @!attribute [rw] records
784
- # The records in the result set.
785
- # @return [Array<Types::Record>]
787
+ # </note>
786
788
  #
787
789
  # @!attribute [rw] result_set_metadata
788
790
  # The result-set metadata in the result set.
789
791
  # @return [Types::ResultSetMetadata]
790
792
  #
793
+ # @!attribute [rw] records
794
+ # The records in the result set.
795
+ # @return [Array<Types::Record>]
796
+ #
791
797
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultFrame AWS API Documentation
792
798
  #
793
799
  class ResultFrame < Struct.new(
794
- :records,
795
- :result_set_metadata)
800
+ :result_set_metadata,
801
+ :records)
796
802
  SENSITIVE = []
797
803
  include Aws::Structure
798
804
  end
@@ -833,9 +839,11 @@ module Aws::RDSDataService
833
839
  # specifies that it is converted to a Long value if its scale is 0, or
834
840
  # to a Double value otherwise.
835
841
  #
836
- # 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
837
843
  # precision loss. We recommend converting to String, especially when
838
844
  # working with currency values.
845
+ #
846
+ # </note>
839
847
  # @return [String]
840
848
  #
841
849
  # @!attribute [rw] long_return_type
@@ -916,32 +924,36 @@ module Aws::RDSDataService
916
924
  #
917
925
  # {
918
926
  # name: "ParameterName",
919
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
920
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",
921
934
  # array_value: {
935
+ # boolean_values: [false],
936
+ # long_values: [1],
937
+ # double_values: [1.0],
938
+ # string_values: ["String"],
922
939
  # array_values: [
923
940
  # {
924
941
  # # recursive ArrayValue
925
942
  # },
926
943
  # ],
927
- # boolean_values: [false],
928
- # double_values: [1.0],
929
- # long_values: [1],
930
- # string_values: ["String"],
931
944
  # },
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
945
  # },
946
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
939
947
  # }
940
948
  #
941
949
  # @!attribute [rw] name
942
950
  # The name of the parameter.
943
951
  # @return [String]
944
952
  #
953
+ # @!attribute [rw] value
954
+ # The value of the parameter.
955
+ # @return [Types::Field]
956
+ #
945
957
  # @!attribute [rw] type_hint
946
958
  # A hint that specifies the correct object type for data type mapping.
947
959
  # Possible values are as follows:
@@ -968,67 +980,65 @@ module Aws::RDSDataService
968
980
  # object of `UUID` type to the database.
969
981
  # @return [String]
970
982
  #
971
- # @!attribute [rw] value
972
- # The value of the parameter.
973
- # @return [Types::Field]
974
- #
975
983
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlParameter AWS API Documentation
976
984
  #
977
985
  class SqlParameter < Struct.new(
978
986
  :name,
979
- :type_hint,
980
- :value)
987
+ :value,
988
+ :type_hint)
981
989
  SENSITIVE = []
982
990
  include Aws::Structure
983
991
  end
984
992
 
985
993
  # The result of a SQL statement.
986
994
  #
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]
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>
992
996
  #
993
997
  # @!attribute [rw] result_frame
994
998
  # The result set of the SQL statement.
995
999
  # @return [Types::ResultFrame]
996
1000
  #
1001
+ # @!attribute [rw] number_of_records_updated
1002
+ # The number of records updated by a SQL statement.
1003
+ # @return [Integer]
1004
+ #
997
1005
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlStatementResult AWS API Documentation
998
1006
  #
999
1007
  class SqlStatementResult < Struct.new(
1000
- :number_of_records_updated,
1001
- :result_frame)
1008
+ :result_frame,
1009
+ :number_of_records_updated)
1002
1010
  SENSITIVE = []
1003
1011
  include Aws::Structure
1004
1012
  end
1005
1013
 
1006
1014
  # The execution of the SQL statement timed out.
1007
1015
  #
1008
- # @!attribute [rw] db_connection_id
1009
- # The database connection ID that executed the SQL statement.
1010
- # @return [Integer]
1011
- #
1012
1016
  # @!attribute [rw] message
1013
1017
  # The error message returned by this `StatementTimeoutException`
1014
1018
  # error.
1015
1019
  # @return [String]
1016
1020
  #
1021
+ # @!attribute [rw] db_connection_id
1022
+ # The database connection ID that executed the SQL statement.
1023
+ # @return [Integer]
1024
+ #
1017
1025
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/StatementTimeoutException AWS API Documentation
1018
1026
  #
1019
1027
  class StatementTimeoutException < Struct.new(
1020
- :db_connection_id,
1021
- :message)
1028
+ :message,
1029
+ :db_connection_id)
1022
1030
  SENSITIVE = []
1023
1031
  include Aws::Structure
1024
1032
  end
1025
1033
 
1026
1034
  # A structure value returned by a call.
1027
1035
  #
1028
- # This data structure is only used with the deprecated `ExecuteSql`
1036
+ # <note markdown="1"> This data structure is only used with the deprecated `ExecuteSql`
1029
1037
  # operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
1030
1038
  # operation instead.
1031
1039
  #
1040
+ # </note>
1041
+ #
1032
1042
  # @!attribute [rw] attributes
1033
1043
  # The attributes returned in the record.
1034
1044
  # @return [Array<Types::Value>]
@@ -1057,37 +1067,29 @@ module Aws::RDSDataService
1057
1067
 
1058
1068
  # Contains the value of a column.
1059
1069
  #
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>
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>
1061
1071
  #
1062
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.
1063
1073
  #
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]
1074
+ # @!attribute [rw] is_null
1075
+ # A NULL value.
1076
+ # @return [Boolean]
1071
1077
  #
1072
1078
  # @!attribute [rw] bit_value
1073
1079
  # A value for a column of BIT data type.
1074
1080
  # @return [Boolean]
1075
1081
  #
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]
1082
+ # @!attribute [rw] big_int_value
1083
+ # A value for a column of big integer data type.
1084
+ # @return [Integer]
1083
1085
  #
1084
1086
  # @!attribute [rw] int_value
1085
1087
  # A value for a column of integer data type.
1086
1088
  # @return [Integer]
1087
1089
  #
1088
- # @!attribute [rw] is_null
1089
- # A NULL value.
1090
- # @return [Boolean]
1090
+ # @!attribute [rw] double_value
1091
+ # A value for a column of double data type.
1092
+ # @return [Float]
1091
1093
  #
1092
1094
  # @!attribute [rw] real_value
1093
1095
  # A value for a column of real data type.
@@ -1097,6 +1099,14 @@ module Aws::RDSDataService
1097
1099
  # A value for a column of string data type.
1098
1100
  # @return [String]
1099
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
+ #
1100
1110
  # @!attribute [rw] struct_value
1101
1111
  # A value for a column of STRUCT data type.
1102
1112
  # @return [Types::StructValue]
@@ -1104,30 +1114,30 @@ module Aws::RDSDataService
1104
1114
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Value AWS API Documentation
1105
1115
  #
1106
1116
  class Value < Struct.new(
1107
- :array_values,
1108
- :big_int_value,
1117
+ :is_null,
1109
1118
  :bit_value,
1110
- :blob_value,
1111
- :double_value,
1119
+ :big_int_value,
1112
1120
  :int_value,
1113
- :is_null,
1121
+ :double_value,
1114
1122
  :real_value,
1115
1123
  :string_value,
1124
+ :blob_value,
1125
+ :array_values,
1116
1126
  :struct_value,
1117
1127
  :unknown)
1118
1128
  SENSITIVE = []
1119
1129
  include Aws::Structure
1120
1130
  include Aws::Structure::Union
1121
1131
 
1122
- class ArrayValues < Value; end
1123
- class BigIntValue < Value; end
1132
+ class IsNull < Value; end
1124
1133
  class BitValue < Value; end
1125
- class BlobValue < Value; end
1126
- class DoubleValue < Value; end
1134
+ class BigIntValue < Value; end
1127
1135
  class IntValue < Value; end
1128
- class IsNull < Value; end
1136
+ class DoubleValue < Value; end
1129
1137
  class RealValue < Value; end
1130
1138
  class StringValue < Value; end
1139
+ class BlobValue < Value; end
1140
+ class ArrayValues < Value; end
1131
1141
  class StructValue < Value; end
1132
1142
  class Unknown < Value; end
1133
1143
  end