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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cc45e558fdf476f8475f040029b314ebe35fea74d1cab955424fc8b0825de35f
4
- data.tar.gz: 198a0e5a7b03700f6e6062805a38442d783e7ce981f2a989036eb7d2f9780c7b
3
+ metadata.gz: b30fef0b07054f5ff92d546ebbf9dfef1c85821e9bb1c027729aec874574b81b
4
+ data.tar.gz: 6abb77d02b89a0f280198108f2b12360db19886d3100518373d613ff9bcdb85a
5
5
  SHA512:
6
- metadata.gz: 614b9163eb9a5eebd4ff81f9dfbb4ad82635613b6858342a145a354ba9377ca0cee4450648b5f68b5e9488a277bf4d0a3ceedcc03dc107d1ba32e053ab471154
7
- data.tar.gz: 14f58b20497797c0571c82e17c891610cccac4cd0b644f823adabcab9d789a0c4157ca54f3a843f330336467e41b9d48e9e1fa8c937c098e09b79a3820b047bc
6
+ metadata.gz: e58c9a4a52db9b1c7b0e663e47365561319ebb55e12cf7d4cfed86108bf7c94cf76ebb97aa3490fc8bed180ad7361622596053319be2dddf30dea3ce5d1fed60
7
+ data.tar.gz: 9811aa09a4dfca137fa047c125a640ab69f1be04f15f99071a51eac7de3ea8b341d2651d3f09ebb2c954c4c111fcb3b1b5ea14210f69c65ccfca029e041dcaca
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.37.0 (2022-08-31)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for RDS Data API
8
+
4
9
  1.36.0 (2022-06-24)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.36.0
1
+ 1.37.0
@@ -358,7 +358,7 @@ module Aws::RDSDataService
358
358
  # can provide a significant performance improvement over individual
359
359
  # insert and update operations.
360
360
  #
361
- # If a call isn't part of a transaction because it doesn't include the
361
+ # <note markdown="1"> If a call isn't part of a transaction because it doesn't include the
362
362
  # `transactionID` parameter, changes that result from the call are
363
363
  # committed automatically.
364
364
  #
@@ -374,31 +374,11 @@ module Aws::RDSDataService
374
374
  # The response size limit is 1 MiB. If the call returns more than 1 MiB
375
375
  # of response data, the call is terminated.
376
376
  #
377
- # @option params [String] :database
378
- # The name of the database.
379
- #
380
- # @option params [Array<Array>] :parameter_sets
381
- # The parameter set for the batch operation.
382
- #
383
- # The SQL statement is executed as many times as the number of parameter
384
- # sets provided. To execute a SQL statement with no parameters, use one
385
- # of the following options:
386
- #
387
- # * Specify one or more empty parameter sets.
388
- #
389
- # * Use the `ExecuteStatement` operation instead of the
390
- # `BatchExecuteStatement` operation.
391
- #
392
- # <note markdown="1"> Array parameters are not supported.
393
- #
394
- # </note>
377
+ # </note>
395
378
  #
396
379
  # @option params [required, String] :resource_arn
397
380
  # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
398
381
  #
399
- # @option params [String] :schema
400
- # The name of the database schema.
401
- #
402
382
  # @option params [required, String] :secret_arn
403
383
  # The ARN of the secret that enables access to the DB cluster. Enter the
404
384
  # database user name and password for the credentials in the secret.
@@ -414,6 +394,28 @@ module Aws::RDSDataService
414
394
  # The SQL statement to run. Don't include a semicolon (;) at the end of
415
395
  # the SQL statement.
416
396
  #
397
+ # @option params [String] :database
398
+ # The name of the database.
399
+ #
400
+ # @option params [String] :schema
401
+ # The name of the database schema.
402
+ #
403
+ # @option params [Array<Array>] :parameter_sets
404
+ # The parameter set for the batch operation.
405
+ #
406
+ # The SQL statement is executed as many times as the number of parameter
407
+ # sets provided. To execute a SQL statement with no parameters, use one
408
+ # of the following options:
409
+ #
410
+ # * Specify one or more empty parameter sets.
411
+ #
412
+ # * Use the `ExecuteStatement` operation instead of the
413
+ # `BatchExecuteStatement` operation.
414
+ #
415
+ # <note markdown="1"> Array parameters are not supported.
416
+ #
417
+ # </note>
418
+ #
417
419
  # @option params [String] :transaction_id
418
420
  # The identifier of a transaction that was started by using the
419
421
  # `BeginTransaction` operation. Specify the transaction ID of the
@@ -429,38 +431,38 @@ module Aws::RDSDataService
429
431
  # @example Request syntax with placeholder values
430
432
  #
431
433
  # resp = client.batch_execute_statement({
434
+ # resource_arn: "Arn", # required
435
+ # secret_arn: "Arn", # required
436
+ # sql: "SqlStatement", # required
432
437
  # database: "DbName",
438
+ # schema: "DbName",
433
439
  # parameter_sets: [
434
440
  # [
435
441
  # {
436
442
  # name: "ParameterName",
437
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
438
443
  # value: {
444
+ # is_null: false,
445
+ # boolean_value: false,
446
+ # long_value: 1,
447
+ # double_value: 1.0,
448
+ # string_value: "String",
449
+ # blob_value: "data",
439
450
  # array_value: {
451
+ # boolean_values: [false],
452
+ # long_values: [1],
453
+ # double_values: [1.0],
454
+ # string_values: ["String"],
440
455
  # array_values: [
441
456
  # {
442
457
  # # recursive ArrayValue
443
458
  # },
444
459
  # ],
445
- # boolean_values: [false],
446
- # double_values: [1.0],
447
- # long_values: [1],
448
- # string_values: ["String"],
449
460
  # },
450
- # blob_value: "data",
451
- # boolean_value: false,
452
- # double_value: 1.0,
453
- # is_null: false,
454
- # long_value: 1,
455
- # string_value: "String",
456
461
  # },
462
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
457
463
  # },
458
464
  # ],
459
465
  # ],
460
- # resource_arn: "Arn", # required
461
- # schema: "DbName",
462
- # secret_arn: "Arn", # required
463
- # sql: "SqlStatement", # required
464
466
  # transaction_id: "Id",
465
467
  # })
466
468
  #
@@ -468,22 +470,22 @@ module Aws::RDSDataService
468
470
  #
469
471
  # resp.update_results #=> Array
470
472
  # resp.update_results[0].generated_fields #=> Array
471
- # resp.update_results[0].generated_fields[0].array_value.array_values #=> Array
472
- # resp.update_results[0].generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
473
+ # resp.update_results[0].generated_fields[0].is_null #=> Boolean
474
+ # resp.update_results[0].generated_fields[0].boolean_value #=> Boolean
475
+ # resp.update_results[0].generated_fields[0].long_value #=> Integer
476
+ # resp.update_results[0].generated_fields[0].double_value #=> Float
477
+ # resp.update_results[0].generated_fields[0].string_value #=> String
478
+ # resp.update_results[0].generated_fields[0].blob_value #=> String
473
479
  # resp.update_results[0].generated_fields[0].array_value.boolean_values #=> Array
474
480
  # resp.update_results[0].generated_fields[0].array_value.boolean_values[0] #=> Boolean
475
- # resp.update_results[0].generated_fields[0].array_value.double_values #=> Array
476
- # resp.update_results[0].generated_fields[0].array_value.double_values[0] #=> Float
477
481
  # resp.update_results[0].generated_fields[0].array_value.long_values #=> Array
478
482
  # resp.update_results[0].generated_fields[0].array_value.long_values[0] #=> Integer
483
+ # resp.update_results[0].generated_fields[0].array_value.double_values #=> Array
484
+ # resp.update_results[0].generated_fields[0].array_value.double_values[0] #=> Float
479
485
  # resp.update_results[0].generated_fields[0].array_value.string_values #=> Array
480
486
  # resp.update_results[0].generated_fields[0].array_value.string_values[0] #=> String
481
- # resp.update_results[0].generated_fields[0].blob_value #=> String
482
- # resp.update_results[0].generated_fields[0].boolean_value #=> Boolean
483
- # resp.update_results[0].generated_fields[0].double_value #=> Float
484
- # resp.update_results[0].generated_fields[0].is_null #=> Boolean
485
- # resp.update_results[0].generated_fields[0].long_value #=> Integer
486
- # resp.update_results[0].generated_fields[0].string_value #=> String
487
+ # resp.update_results[0].generated_fields[0].array_value.array_values #=> Array
488
+ # resp.update_results[0].generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
487
489
  #
488
490
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatement AWS API Documentation
489
491
  #
@@ -496,20 +498,31 @@ module Aws::RDSDataService
496
498
 
497
499
  # Starts a SQL transaction.
498
500
  #
499
- # <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>
501
+ # <note markdown="1"> A transaction can run for a maximum of 24 hours. A transaction is
502
+ # terminated and rolled back automatically after 24 hours.
500
503
  #
501
- # @option params [String] :database
502
- # The name of the database.
504
+ # A transaction times out if no calls use its transaction ID in three
505
+ # minutes. If a transaction times out before it's committed, it's
506
+ # rolled back automatically.
507
+ #
508
+ # DDL statements inside a transaction cause an implicit commit. We
509
+ # recommend that you run each DDL statement in a separate
510
+ # `ExecuteStatement` call with `continueAfterTimeout` enabled.
511
+ #
512
+ # </note>
503
513
  #
504
514
  # @option params [required, String] :resource_arn
505
515
  # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
506
516
  #
507
- # @option params [String] :schema
508
- # The name of the database schema.
509
- #
510
517
  # @option params [required, String] :secret_arn
511
518
  # The name or ARN of the secret that enables access to the DB cluster.
512
519
  #
520
+ # @option params [String] :database
521
+ # The name of the database.
522
+ #
523
+ # @option params [String] :schema
524
+ # The name of the database schema.
525
+ #
513
526
  # @return [Types::BeginTransactionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
514
527
  #
515
528
  # * {Types::BeginTransactionResponse#transaction_id #transaction_id} => String
@@ -517,10 +530,10 @@ module Aws::RDSDataService
517
530
  # @example Request syntax with placeholder values
518
531
  #
519
532
  # resp = client.begin_transaction({
520
- # database: "DbName",
521
533
  # resource_arn: "Arn", # required
522
- # schema: "DbName",
523
534
  # secret_arn: "Arn", # required
535
+ # database: "DbName",
536
+ # schema: "DbName",
524
537
  # })
525
538
  #
526
539
  # @example Response structure
@@ -575,9 +588,14 @@ module Aws::RDSDataService
575
588
 
576
589
  # Runs one or more SQL statements.
577
590
  #
578
- # This operation is deprecated. Use the `BatchExecuteStatement` or
591
+ # <note markdown="1"> This operation is deprecated. Use the `BatchExecuteStatement` or
579
592
  # `ExecuteStatement` operation.
580
593
  #
594
+ # </note>
595
+ #
596
+ # @option params [required, String] :db_cluster_or_instance_arn
597
+ # The ARN of the Aurora Serverless DB cluster.
598
+ #
581
599
  # @option params [required, String] :aws_secret_store_arn
582
600
  # The Amazon Resource Name (ARN) of the secret that enables access to
583
601
  # the DB cluster. Enter the database user name and password for the
@@ -590,15 +608,6 @@ module Aws::RDSDataService
590
608
  #
591
609
  # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
592
610
  #
593
- # @option params [String] :database
594
- # The name of the database.
595
- #
596
- # @option params [required, String] :db_cluster_or_instance_arn
597
- # The ARN of the Aurora Serverless DB cluster.
598
- #
599
- # @option params [String] :schema
600
- # The name of the database schema.
601
- #
602
611
  # @option params [required, String] :sql_statements
603
612
  # One or more SQL statements to run on the DB cluster.
604
613
  #
@@ -606,6 +615,12 @@ module Aws::RDSDataService
606
615
  # Any valid SQL statement is permitted, including data definition, data
607
616
  # manipulation, and commit statements.
608
617
  #
618
+ # @option params [String] :database
619
+ # The name of the database.
620
+ #
621
+ # @option params [String] :schema
622
+ # The name of the database schema.
623
+ #
609
624
  # @return [Types::ExecuteSqlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
610
625
  #
611
626
  # * {Types::ExecuteSqlResponse#sql_statement_results #sql_statement_results} => Array&lt;Types::SqlStatementResult&gt;
@@ -613,47 +628,47 @@ module Aws::RDSDataService
613
628
  # @example Request syntax with placeholder values
614
629
  #
615
630
  # resp = client.execute_sql({
631
+ # db_cluster_or_instance_arn: "Arn", # required
616
632
  # aws_secret_store_arn: "Arn", # required
633
+ # sql_statements: "SqlStatement", # required
617
634
  # database: "DbName",
618
- # db_cluster_or_instance_arn: "Arn", # required
619
635
  # schema: "DbName",
620
- # sql_statements: "SqlStatement", # required
621
636
  # })
622
637
  #
623
638
  # @example Response structure
624
639
  #
625
640
  # resp.sql_statement_results #=> Array
626
- # resp.sql_statement_results[0].number_of_records_updated #=> Integer
641
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_count #=> Integer
642
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata #=> Array
643
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].name #=> String
644
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type #=> Integer
645
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type_name #=> String
646
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].label #=> String
647
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].schema_name #=> String
648
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].table_name #=> String
649
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_auto_increment #=> Boolean
650
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_signed #=> Boolean
651
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_currency #=> Boolean
652
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_case_sensitive #=> Boolean
653
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].nullable #=> Integer
654
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].precision #=> Integer
655
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].scale #=> Integer
656
+ # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].array_base_column_type #=> Integer
627
657
  # resp.sql_statement_results[0].result_frame.records #=> Array
628
658
  # resp.sql_statement_results[0].result_frame.records[0].values #=> Array
629
- # resp.sql_statement_results[0].result_frame.records[0].values[0].array_values #=> Array
630
- # resp.sql_statement_results[0].result_frame.records[0].values[0].array_values[0] #=> Types::Value
631
- # resp.sql_statement_results[0].result_frame.records[0].values[0].big_int_value #=> Integer
659
+ # resp.sql_statement_results[0].result_frame.records[0].values[0].is_null #=> Boolean
632
660
  # resp.sql_statement_results[0].result_frame.records[0].values[0].bit_value #=> Boolean
633
- # resp.sql_statement_results[0].result_frame.records[0].values[0].blob_value #=> String
634
- # resp.sql_statement_results[0].result_frame.records[0].values[0].double_value #=> Float
661
+ # resp.sql_statement_results[0].result_frame.records[0].values[0].big_int_value #=> Integer
635
662
  # resp.sql_statement_results[0].result_frame.records[0].values[0].int_value #=> Integer
636
- # resp.sql_statement_results[0].result_frame.records[0].values[0].is_null #=> Boolean
663
+ # resp.sql_statement_results[0].result_frame.records[0].values[0].double_value #=> Float
637
664
  # resp.sql_statement_results[0].result_frame.records[0].values[0].real_value #=> Float
638
665
  # resp.sql_statement_results[0].result_frame.records[0].values[0].string_value #=> String
666
+ # resp.sql_statement_results[0].result_frame.records[0].values[0].blob_value #=> String
667
+ # resp.sql_statement_results[0].result_frame.records[0].values[0].array_values #=> Array
668
+ # resp.sql_statement_results[0].result_frame.records[0].values[0].array_values[0] #=> Types::Value
639
669
  # resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes #=> Array
640
670
  # resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes[0] #=> Types::Value
641
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_count #=> Integer
642
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata #=> Array
643
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].array_base_column_type #=> Integer
644
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_auto_increment #=> Boolean
645
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_case_sensitive #=> Boolean
646
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_currency #=> Boolean
647
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_signed #=> Boolean
648
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].label #=> String
649
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].name #=> String
650
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].nullable #=> Integer
651
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].precision #=> Integer
652
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].scale #=> Integer
653
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].schema_name #=> String
654
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].table_name #=> String
655
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type #=> Integer
656
- # resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type_name #=> String
671
+ # resp.sql_statement_results[0].number_of_records_updated #=> Integer
657
672
  #
658
673
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSql AWS API Documentation
659
674
  #
@@ -666,42 +681,41 @@ module Aws::RDSDataService
666
681
 
667
682
  # Runs a SQL statement against a database.
668
683
  #
669
- # If a call isn't part of a transaction because it doesn't include the
684
+ # <note markdown="1"> If a call isn't part of a transaction because it doesn't include the
670
685
  # `transactionID` parameter, changes that result from the call are
671
686
  # committed automatically.
672
687
  #
673
688
  # If the binary response data from the database is more than 1 MB, the
674
689
  # call is terminated.
675
690
  #
676
- # @option params [Boolean] :continue_after_timeout
677
- # A value that indicates whether to continue running the statement after
678
- # the call times out. By default, the statement stops running when the
679
- # call times out.
691
+ # </note>
680
692
  #
681
- # For DDL statements, we recommend continuing to run the statement after
682
- # the call times out. When a DDL statement terminates before it is
683
- # finished running, it can result in errors and possibly corrupted data
684
- # structures.
693
+ # @option params [required, String] :resource_arn
694
+ # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
685
695
  #
686
- # @option params [String] :database
687
- # The name of the database.
696
+ # @option params [required, String] :secret_arn
697
+ # The ARN of the secret that enables access to the DB cluster. Enter the
698
+ # database user name and password for the credentials in the secret.
688
699
  #
689
- # @option params [String] :format_records_as
690
- # A value that indicates whether to format the result set as a single
691
- # JSON string. This parameter only applies to `SELECT` statements and is
692
- # ignored for other types of statements. Allowed values are `NONE` and
693
- # `JSON`. The default value is `NONE`. The result is returned in the
694
- # `formattedRecords` field.
700
+ # For information about creating the secret, see [Create a database
701
+ # secret][1].
695
702
  #
696
- # For usage information about the JSON format for result sets, see
697
- # [Using the Data API][1] in the *Amazon Aurora User Guide*.
698
703
  #
699
704
  #
705
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
700
706
  #
701
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
707
+ # @option params [required, String] :sql
708
+ # The SQL statement to run.
702
709
  #
703
- # @option params [Boolean] :include_result_metadata
704
- # A value that indicates whether to include metadata in the results.
710
+ # @option params [String] :database
711
+ # The name of the database.
712
+ #
713
+ # @option params [String] :schema
714
+ # The name of the database schema.
715
+ #
716
+ # <note markdown="1"> Currently, the `schema` parameter isn't supported.
717
+ #
718
+ # </note>
705
719
  #
706
720
  # @option params [Array<Types::SqlParameter>] :parameters
707
721
  # The parameters for the SQL statement.
@@ -710,146 +724,151 @@ module Aws::RDSDataService
710
724
  #
711
725
  # </note>
712
726
  #
713
- # @option params [required, String] :resource_arn
714
- # The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
715
- #
716
- # @option params [Types::ResultSetOptions] :result_set_options
717
- # Options that control how the result set is returned.
727
+ # @option params [String] :transaction_id
728
+ # The identifier of a transaction that was started by using the
729
+ # `BeginTransaction` operation. Specify the transaction ID of the
730
+ # transaction that you want to include the SQL statement in.
718
731
  #
719
- # @option params [String] :schema
720
- # The name of the database schema.
732
+ # If the SQL statement is not part of a transaction, don't set this
733
+ # parameter.
721
734
  #
722
- # <note markdown="1"> Currently, the `schema` parameter isn't supported.
735
+ # @option params [Boolean] :include_result_metadata
736
+ # A value that indicates whether to include metadata in the results.
723
737
  #
724
- # </note>
738
+ # @option params [Boolean] :continue_after_timeout
739
+ # A value that indicates whether to continue running the statement after
740
+ # the call times out. By default, the statement stops running when the
741
+ # call times out.
725
742
  #
726
- # @option params [required, String] :secret_arn
727
- # The ARN of the secret that enables access to the DB cluster. Enter the
728
- # database user name and password for the credentials in the secret.
743
+ # <note markdown="1"> For DDL statements, we recommend continuing to run the statement after
744
+ # the call times out. When a DDL statement terminates before it is
745
+ # finished running, it can result in errors and possibly corrupted data
746
+ # structures.
729
747
  #
730
- # For information about creating the secret, see [Create a database
731
- # secret][1].
748
+ # </note>
732
749
  #
750
+ # @option params [Types::ResultSetOptions] :result_set_options
751
+ # Options that control how the result set is returned.
733
752
  #
753
+ # @option params [String] :format_records_as
754
+ # A value that indicates whether to format the result set as a single
755
+ # JSON string. This parameter only applies to `SELECT` statements and is
756
+ # ignored for other types of statements. Allowed values are `NONE` and
757
+ # `JSON`. The default value is `NONE`. The result is returned in the
758
+ # `formattedRecords` field.
734
759
  #
735
- # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
760
+ # For usage information about the JSON format for result sets, see
761
+ # [Using the Data API][1] in the *Amazon Aurora User Guide*.
736
762
  #
737
- # @option params [required, String] :sql
738
- # The SQL statement to run.
739
763
  #
740
- # @option params [String] :transaction_id
741
- # The identifier of a transaction that was started by using the
742
- # `BeginTransaction` operation. Specify the transaction ID of the
743
- # transaction that you want to include the SQL statement in.
744
764
  #
745
- # If the SQL statement is not part of a transaction, don't set this
746
- # parameter.
765
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
747
766
  #
748
767
  # @return [Types::ExecuteStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
749
768
  #
769
+ # * {Types::ExecuteStatementResponse#records #records} => Array&lt;Array&lt;Types::Field&gt;&gt;
750
770
  # * {Types::ExecuteStatementResponse#column_metadata #column_metadata} => Array&lt;Types::ColumnMetadata&gt;
751
- # * {Types::ExecuteStatementResponse#formatted_records #formatted_records} => String
752
- # * {Types::ExecuteStatementResponse#generated_fields #generated_fields} => Array&lt;Types::Field&gt;
753
771
  # * {Types::ExecuteStatementResponse#number_of_records_updated #number_of_records_updated} => Integer
754
- # * {Types::ExecuteStatementResponse#records #records} => Array&lt;Array&lt;Types::Field&gt;&gt;
772
+ # * {Types::ExecuteStatementResponse#generated_fields #generated_fields} => Array&lt;Types::Field&gt;
773
+ # * {Types::ExecuteStatementResponse#formatted_records #formatted_records} => String
755
774
  #
756
775
  # @example Request syntax with placeholder values
757
776
  #
758
777
  # resp = client.execute_statement({
759
- # continue_after_timeout: false,
778
+ # resource_arn: "Arn", # required
779
+ # secret_arn: "Arn", # required
780
+ # sql: "SqlStatement", # required
760
781
  # database: "DbName",
761
- # format_records_as: "NONE", # accepts NONE, JSON
762
- # include_result_metadata: false,
782
+ # schema: "DbName",
763
783
  # parameters: [
764
784
  # {
765
785
  # name: "ParameterName",
766
- # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
767
786
  # value: {
787
+ # is_null: false,
788
+ # boolean_value: false,
789
+ # long_value: 1,
790
+ # double_value: 1.0,
791
+ # string_value: "String",
792
+ # blob_value: "data",
768
793
  # array_value: {
794
+ # boolean_values: [false],
795
+ # long_values: [1],
796
+ # double_values: [1.0],
797
+ # string_values: ["String"],
769
798
  # array_values: [
770
799
  # {
771
800
  # # recursive ArrayValue
772
801
  # },
773
802
  # ],
774
- # boolean_values: [false],
775
- # double_values: [1.0],
776
- # long_values: [1],
777
- # string_values: ["String"],
778
803
  # },
779
- # blob_value: "data",
780
- # boolean_value: false,
781
- # double_value: 1.0,
782
- # is_null: false,
783
- # long_value: 1,
784
- # string_value: "String",
785
804
  # },
805
+ # type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
786
806
  # },
787
807
  # ],
788
- # resource_arn: "Arn", # required
808
+ # transaction_id: "Id",
809
+ # include_result_metadata: false,
810
+ # continue_after_timeout: false,
789
811
  # result_set_options: {
790
812
  # decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
791
813
  # long_return_type: "STRING", # accepts STRING, LONG
792
814
  # },
793
- # schema: "DbName",
794
- # secret_arn: "Arn", # required
795
- # sql: "SqlStatement", # required
796
- # transaction_id: "Id",
815
+ # format_records_as: "NONE", # accepts NONE, JSON
797
816
  # })
798
817
  #
799
818
  # @example Response structure
800
819
  #
820
+ # resp.records #=> Array
821
+ # resp.records[0] #=> Array
822
+ # resp.records[0][0].is_null #=> Boolean
823
+ # resp.records[0][0].boolean_value #=> Boolean
824
+ # resp.records[0][0].long_value #=> Integer
825
+ # resp.records[0][0].double_value #=> Float
826
+ # resp.records[0][0].string_value #=> String
827
+ # resp.records[0][0].blob_value #=> String
828
+ # resp.records[0][0].array_value.boolean_values #=> Array
829
+ # resp.records[0][0].array_value.boolean_values[0] #=> Boolean
830
+ # resp.records[0][0].array_value.long_values #=> Array
831
+ # resp.records[0][0].array_value.long_values[0] #=> Integer
832
+ # resp.records[0][0].array_value.double_values #=> Array
833
+ # resp.records[0][0].array_value.double_values[0] #=> Float
834
+ # resp.records[0][0].array_value.string_values #=> Array
835
+ # resp.records[0][0].array_value.string_values[0] #=> String
836
+ # resp.records[0][0].array_value.array_values #=> Array
837
+ # resp.records[0][0].array_value.array_values[0] #=> Types::ArrayValue
801
838
  # resp.column_metadata #=> Array
802
- # resp.column_metadata[0].array_base_column_type #=> Integer
839
+ # resp.column_metadata[0].name #=> String
840
+ # resp.column_metadata[0].type #=> Integer
841
+ # resp.column_metadata[0].type_name #=> String
842
+ # resp.column_metadata[0].label #=> String
843
+ # resp.column_metadata[0].schema_name #=> String
844
+ # resp.column_metadata[0].table_name #=> String
803
845
  # resp.column_metadata[0].is_auto_increment #=> Boolean
804
- # resp.column_metadata[0].is_case_sensitive #=> Boolean
805
- # resp.column_metadata[0].is_currency #=> Boolean
806
846
  # resp.column_metadata[0].is_signed #=> Boolean
807
- # resp.column_metadata[0].label #=> String
808
- # resp.column_metadata[0].name #=> String
847
+ # resp.column_metadata[0].is_currency #=> Boolean
848
+ # resp.column_metadata[0].is_case_sensitive #=> Boolean
809
849
  # resp.column_metadata[0].nullable #=> Integer
810
850
  # resp.column_metadata[0].precision #=> Integer
811
851
  # resp.column_metadata[0].scale #=> Integer
812
- # resp.column_metadata[0].schema_name #=> String
813
- # resp.column_metadata[0].table_name #=> String
814
- # resp.column_metadata[0].type #=> Integer
815
- # resp.column_metadata[0].type_name #=> String
816
- # resp.formatted_records #=> String
852
+ # resp.column_metadata[0].array_base_column_type #=> Integer
853
+ # resp.number_of_records_updated #=> Integer
817
854
  # resp.generated_fields #=> Array
818
- # resp.generated_fields[0].array_value.array_values #=> Array
819
- # resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
855
+ # resp.generated_fields[0].is_null #=> Boolean
856
+ # resp.generated_fields[0].boolean_value #=> Boolean
857
+ # resp.generated_fields[0].long_value #=> Integer
858
+ # resp.generated_fields[0].double_value #=> Float
859
+ # resp.generated_fields[0].string_value #=> String
860
+ # resp.generated_fields[0].blob_value #=> String
820
861
  # resp.generated_fields[0].array_value.boolean_values #=> Array
821
862
  # resp.generated_fields[0].array_value.boolean_values[0] #=> Boolean
822
- # resp.generated_fields[0].array_value.double_values #=> Array
823
- # resp.generated_fields[0].array_value.double_values[0] #=> Float
824
863
  # resp.generated_fields[0].array_value.long_values #=> Array
825
864
  # resp.generated_fields[0].array_value.long_values[0] #=> Integer
865
+ # resp.generated_fields[0].array_value.double_values #=> Array
866
+ # resp.generated_fields[0].array_value.double_values[0] #=> Float
826
867
  # resp.generated_fields[0].array_value.string_values #=> Array
827
868
  # resp.generated_fields[0].array_value.string_values[0] #=> String
828
- # resp.generated_fields[0].blob_value #=> String
829
- # resp.generated_fields[0].boolean_value #=> Boolean
830
- # resp.generated_fields[0].double_value #=> Float
831
- # resp.generated_fields[0].is_null #=> Boolean
832
- # resp.generated_fields[0].long_value #=> Integer
833
- # resp.generated_fields[0].string_value #=> String
834
- # resp.number_of_records_updated #=> Integer
835
- # resp.records #=> Array
836
- # resp.records[0] #=> Array
837
- # resp.records[0][0].array_value.array_values #=> Array
838
- # resp.records[0][0].array_value.array_values[0] #=> Types::ArrayValue
839
- # resp.records[0][0].array_value.boolean_values #=> Array
840
- # resp.records[0][0].array_value.boolean_values[0] #=> Boolean
841
- # resp.records[0][0].array_value.double_values #=> Array
842
- # resp.records[0][0].array_value.double_values[0] #=> Float
843
- # resp.records[0][0].array_value.long_values #=> Array
844
- # resp.records[0][0].array_value.long_values[0] #=> Integer
845
- # resp.records[0][0].array_value.string_values #=> Array
846
- # resp.records[0][0].array_value.string_values[0] #=> String
847
- # resp.records[0][0].blob_value #=> String
848
- # resp.records[0][0].boolean_value #=> Boolean
849
- # resp.records[0][0].double_value #=> Float
850
- # resp.records[0][0].is_null #=> Boolean
851
- # resp.records[0][0].long_value #=> Integer
852
- # resp.records[0][0].string_value #=> String
869
+ # resp.generated_fields[0].array_value.array_values #=> Array
870
+ # resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
871
+ # resp.formatted_records #=> String
853
872
  #
854
873
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatement AWS API Documentation
855
874
  #
@@ -910,7 +929,7 @@ module Aws::RDSDataService
910
929
  params: params,
911
930
  config: config)
912
931
  context[:gem_name] = 'aws-sdk-rdsdataservice'
913
- context[:gem_version] = '1.36.0'
932
+ context[:gem_version] = '1.37.0'
914
933
  Seahorse::Client::Request.new(handlers, context)
915
934
  end
916
935