aws-sdk-rdsdataservice 1.33.0 → 1.36.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 +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rdsdataservice/client.rb +64 -7
- data/lib/aws-sdk-rdsdataservice/client_api.rb +16 -0
- data/lib/aws-sdk-rdsdataservice/errors.rb +16 -0
- data/lib/aws-sdk-rdsdataservice/types.rb +104 -12
- data/lib/aws-sdk-rdsdataservice.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cc45e558fdf476f8475f040029b314ebe35fea74d1cab955424fc8b0825de35f
|
4
|
+
data.tar.gz: 198a0e5a7b03700f6e6062805a38442d783e7ce981f2a989036eb7d2f9780c7b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 614b9163eb9a5eebd4ff81f9dfbb4ad82635613b6858342a145a354ba9377ca0cee4450648b5f68b5e9488a277bf4d0a3ceedcc03dc107d1ba32e053ab471154
|
7
|
+
data.tar.gz: 14f58b20497797c0571c82e17c891610cccac4cd0b644f823adabcab9d789a0c4157ca54f3a843f330336467e41b9d48e9e1fa8c937c098e09b79a3820b047bc
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.36.0 (2022-06-24)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for RDS Data API
|
8
|
+
|
9
|
+
1.35.0 (2022-04-25)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Support to receive SQL query results in the form of a simplified JSON string. This enables developers using the new JSON string format to more easily convert it to an object using popular JSON string parsing libraries.
|
13
|
+
|
14
|
+
1.34.0 (2022-02-24)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
4
19
|
1.33.0 (2022-02-03)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.36.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::RDSDataService
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -360,6 +362,18 @@ module Aws::RDSDataService
|
|
360
362
|
# `transactionID` parameter, changes that result from the call are
|
361
363
|
# committed automatically.
|
362
364
|
#
|
365
|
+
# There isn't a fixed upper limit on the number of parameter sets.
|
366
|
+
# However, the maximum size of the HTTP request submitted through the
|
367
|
+
# Data API is 4 MiB. If the request exceeds this limit, the Data API
|
368
|
+
# returns an error and doesn't process the request. This 4-MiB limit
|
369
|
+
# includes the size of the HTTP headers and the JSON notation in the
|
370
|
+
# request. Thus, the number of parameter sets that you can include
|
371
|
+
# depends on a combination of factors, such as the size of the SQL
|
372
|
+
# statement and the size of each parameter set.
|
373
|
+
#
|
374
|
+
# The response size limit is 1 MiB. If the call returns more than 1 MiB
|
375
|
+
# of response data, the call is terminated.
|
376
|
+
#
|
363
377
|
# @option params [String] :database
|
364
378
|
# The name of the database.
|
365
379
|
#
|
@@ -386,10 +400,19 @@ module Aws::RDSDataService
|
|
386
400
|
# The name of the database schema.
|
387
401
|
#
|
388
402
|
# @option params [required, String] :secret_arn
|
389
|
-
# The
|
403
|
+
# The ARN of the secret that enables access to the DB cluster. Enter the
|
404
|
+
# database user name and password for the credentials in the secret.
|
405
|
+
#
|
406
|
+
# For information about creating the secret, see [Create a database
|
407
|
+
# secret][1].
|
408
|
+
#
|
409
|
+
#
|
410
|
+
#
|
411
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
390
412
|
#
|
391
413
|
# @option params [required, String] :sql
|
392
|
-
# The SQL statement to run.
|
414
|
+
# The SQL statement to run. Don't include a semicolon (;) at the end of
|
415
|
+
# the SQL statement.
|
393
416
|
#
|
394
417
|
# @option params [String] :transaction_id
|
395
418
|
# The identifier of a transaction that was started by using the
|
@@ -557,7 +580,15 @@ module Aws::RDSDataService
|
|
557
580
|
#
|
558
581
|
# @option params [required, String] :aws_secret_store_arn
|
559
582
|
# The Amazon Resource Name (ARN) of the secret that enables access to
|
560
|
-
# the DB cluster.
|
583
|
+
# the DB cluster. Enter the database user name and password for the
|
584
|
+
# credentials in the secret.
|
585
|
+
#
|
586
|
+
# For information about creating the secret, see [Create a database
|
587
|
+
# secret][1].
|
588
|
+
#
|
589
|
+
#
|
590
|
+
#
|
591
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
561
592
|
#
|
562
593
|
# @option params [String] :database
|
563
594
|
# The name of the database.
|
@@ -639,8 +670,8 @@ module Aws::RDSDataService
|
|
639
670
|
# `transactionID` parameter, changes that result from the call are
|
640
671
|
# committed automatically.
|
641
672
|
#
|
642
|
-
#
|
643
|
-
#
|
673
|
+
# If the binary response data from the database is more than 1 MB, the
|
674
|
+
# call is terminated.
|
644
675
|
#
|
645
676
|
# @option params [Boolean] :continue_after_timeout
|
646
677
|
# A value that indicates whether to continue running the statement after
|
@@ -655,6 +686,20 @@ module Aws::RDSDataService
|
|
655
686
|
# @option params [String] :database
|
656
687
|
# The name of the database.
|
657
688
|
#
|
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.
|
695
|
+
#
|
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
|
+
#
|
699
|
+
#
|
700
|
+
#
|
701
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
702
|
+
#
|
658
703
|
# @option params [Boolean] :include_result_metadata
|
659
704
|
# A value that indicates whether to include metadata in the results.
|
660
705
|
#
|
@@ -679,7 +724,15 @@ module Aws::RDSDataService
|
|
679
724
|
# </note>
|
680
725
|
#
|
681
726
|
# @option params [required, String] :secret_arn
|
682
|
-
# The
|
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.
|
729
|
+
#
|
730
|
+
# For information about creating the secret, see [Create a database
|
731
|
+
# secret][1].
|
732
|
+
#
|
733
|
+
#
|
734
|
+
#
|
735
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
683
736
|
#
|
684
737
|
# @option params [required, String] :sql
|
685
738
|
# The SQL statement to run.
|
@@ -695,6 +748,7 @@ module Aws::RDSDataService
|
|
695
748
|
# @return [Types::ExecuteStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
696
749
|
#
|
697
750
|
# * {Types::ExecuteStatementResponse#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
|
751
|
+
# * {Types::ExecuteStatementResponse#formatted_records #formatted_records} => String
|
698
752
|
# * {Types::ExecuteStatementResponse#generated_fields #generated_fields} => Array<Types::Field>
|
699
753
|
# * {Types::ExecuteStatementResponse#number_of_records_updated #number_of_records_updated} => Integer
|
700
754
|
# * {Types::ExecuteStatementResponse#records #records} => Array<Array<Types::Field>>
|
@@ -704,6 +758,7 @@ module Aws::RDSDataService
|
|
704
758
|
# resp = client.execute_statement({
|
705
759
|
# continue_after_timeout: false,
|
706
760
|
# database: "DbName",
|
761
|
+
# format_records_as: "NONE", # accepts NONE, JSON
|
707
762
|
# include_result_metadata: false,
|
708
763
|
# parameters: [
|
709
764
|
# {
|
@@ -733,6 +788,7 @@ module Aws::RDSDataService
|
|
733
788
|
# resource_arn: "Arn", # required
|
734
789
|
# result_set_options: {
|
735
790
|
# decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
|
791
|
+
# long_return_type: "STRING", # accepts STRING, LONG
|
736
792
|
# },
|
737
793
|
# schema: "DbName",
|
738
794
|
# secret_arn: "Arn", # required
|
@@ -757,6 +813,7 @@ module Aws::RDSDataService
|
|
757
813
|
# resp.column_metadata[0].table_name #=> String
|
758
814
|
# resp.column_metadata[0].type #=> Integer
|
759
815
|
# resp.column_metadata[0].type_name #=> String
|
816
|
+
# resp.formatted_records #=> String
|
760
817
|
# resp.generated_fields #=> Array
|
761
818
|
# resp.generated_fields[0].array_value.array_values #=> Array
|
762
819
|
# resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
|
@@ -853,7 +910,7 @@ module Aws::RDSDataService
|
|
853
910
|
params: params,
|
854
911
|
config: config)
|
855
912
|
context[:gem_name] = 'aws-sdk-rdsdataservice'
|
856
|
-
context[:gem_version] = '1.
|
913
|
+
context[:gem_version] = '1.36.0'
|
857
914
|
Seahorse::Client::Request.new(handlers, context)
|
858
915
|
end
|
859
916
|
|
@@ -13,6 +13,7 @@ module Aws::RDSDataService
|
|
13
13
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
|
+
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
16
17
|
Arn = Shapes::StringShape.new(name: 'Arn')
|
17
18
|
ArrayOfArray = Shapes::ListShape.new(name: 'ArrayOfArray')
|
18
19
|
ArrayValue = Shapes::UnionShape.new(name: 'ArrayValue')
|
@@ -44,16 +45,19 @@ module Aws::RDSDataService
|
|
44
45
|
Field = Shapes::UnionShape.new(name: 'Field')
|
45
46
|
FieldList = Shapes::ListShape.new(name: 'FieldList')
|
46
47
|
ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
|
48
|
+
FormattedSqlRecords = Shapes::StringShape.new(name: 'FormattedSqlRecords')
|
47
49
|
Id = Shapes::StringShape.new(name: 'Id')
|
48
50
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
49
51
|
InternalServerErrorException = Shapes::StructureShape.new(name: 'InternalServerErrorException')
|
50
52
|
Long = Shapes::IntegerShape.new(name: 'Long')
|
51
53
|
LongArray = Shapes::ListShape.new(name: 'LongArray')
|
54
|
+
LongReturnType = Shapes::StringShape.new(name: 'LongReturnType')
|
52
55
|
Metadata = Shapes::ListShape.new(name: 'Metadata')
|
53
56
|
NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
|
54
57
|
ParameterName = Shapes::StringShape.new(name: 'ParameterName')
|
55
58
|
Record = Shapes::StructureShape.new(name: 'Record')
|
56
59
|
Records = Shapes::ListShape.new(name: 'Records')
|
60
|
+
RecordsFormatType = Shapes::StringShape.new(name: 'RecordsFormatType')
|
57
61
|
RecordsUpdated = Shapes::IntegerShape.new(name: 'RecordsUpdated')
|
58
62
|
ResultFrame = Shapes::StructureShape.new(name: 'ResultFrame')
|
59
63
|
ResultSetMetadata = Shapes::StructureShape.new(name: 'ResultSetMetadata')
|
@@ -79,6 +83,9 @@ module Aws::RDSDataService
|
|
79
83
|
UpdateResults = Shapes::ListShape.new(name: 'UpdateResults')
|
80
84
|
Value = Shapes::UnionShape.new(name: 'Value')
|
81
85
|
|
86
|
+
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
|
87
|
+
AccessDeniedException.struct_class = Types::AccessDeniedException
|
88
|
+
|
82
89
|
ArrayOfArray.member = Shapes::ShapeRef.new(shape: ArrayValue)
|
83
90
|
|
84
91
|
ArrayValue.add_member(:array_values, Shapes::ShapeRef.new(shape: ArrayOfArray, location_name: "arrayValues"))
|
@@ -161,6 +168,7 @@ module Aws::RDSDataService
|
|
161
168
|
|
162
169
|
ExecuteStatementRequest.add_member(:continue_after_timeout, Shapes::ShapeRef.new(shape: Boolean, location_name: "continueAfterTimeout"))
|
163
170
|
ExecuteStatementRequest.add_member(:database, Shapes::ShapeRef.new(shape: DbName, location_name: "database"))
|
171
|
+
ExecuteStatementRequest.add_member(:format_records_as, Shapes::ShapeRef.new(shape: RecordsFormatType, location_name: "formatRecordsAs"))
|
164
172
|
ExecuteStatementRequest.add_member(:include_result_metadata, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeResultMetadata"))
|
165
173
|
ExecuteStatementRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "parameters"))
|
166
174
|
ExecuteStatementRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "resourceArn"))
|
@@ -172,6 +180,7 @@ module Aws::RDSDataService
|
|
172
180
|
ExecuteStatementRequest.struct_class = Types::ExecuteStatementRequest
|
173
181
|
|
174
182
|
ExecuteStatementResponse.add_member(:column_metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "columnMetadata"))
|
183
|
+
ExecuteStatementResponse.add_member(:formatted_records, Shapes::ShapeRef.new(shape: FormattedSqlRecords, location_name: "formattedRecords"))
|
175
184
|
ExecuteStatementResponse.add_member(:generated_fields, Shapes::ShapeRef.new(shape: FieldList, location_name: "generatedFields"))
|
176
185
|
ExecuteStatementResponse.add_member(:number_of_records_updated, Shapes::ShapeRef.new(shape: RecordsUpdated, location_name: "numberOfRecordsUpdated"))
|
177
186
|
ExecuteStatementResponse.add_member(:records, Shapes::ShapeRef.new(shape: SqlRecords, location_name: "records"))
|
@@ -223,6 +232,7 @@ module Aws::RDSDataService
|
|
223
232
|
ResultSetMetadata.struct_class = Types::ResultSetMetadata
|
224
233
|
|
225
234
|
ResultSetOptions.add_member(:decimal_return_type, Shapes::ShapeRef.new(shape: DecimalReturnType, location_name: "decimalReturnType"))
|
235
|
+
ResultSetOptions.add_member(:long_return_type, Shapes::ShapeRef.new(shape: LongReturnType, location_name: "longReturnType"))
|
226
236
|
ResultSetOptions.struct_class = Types::ResultSetOptions
|
227
237
|
|
228
238
|
RollbackTransactionRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "resourceArn"))
|
@@ -316,6 +326,7 @@ module Aws::RDSDataService
|
|
316
326
|
o.http_request_uri = "/BatchExecute"
|
317
327
|
o.input = Shapes::ShapeRef.new(shape: BatchExecuteStatementRequest)
|
318
328
|
o.output = Shapes::ShapeRef.new(shape: BatchExecuteStatementResponse)
|
329
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
319
330
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
320
331
|
o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
|
321
332
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
@@ -329,6 +340,7 @@ module Aws::RDSDataService
|
|
329
340
|
o.http_request_uri = "/BeginTransaction"
|
330
341
|
o.input = Shapes::ShapeRef.new(shape: BeginTransactionRequest)
|
331
342
|
o.output = Shapes::ShapeRef.new(shape: BeginTransactionResponse)
|
343
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
332
344
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
333
345
|
o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
|
334
346
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
@@ -342,6 +354,7 @@ module Aws::RDSDataService
|
|
342
354
|
o.http_request_uri = "/CommitTransaction"
|
343
355
|
o.input = Shapes::ShapeRef.new(shape: CommitTransactionRequest)
|
344
356
|
o.output = Shapes::ShapeRef.new(shape: CommitTransactionResponse)
|
357
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
345
358
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
346
359
|
o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
|
347
360
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
@@ -357,6 +370,7 @@ module Aws::RDSDataService
|
|
357
370
|
o.deprecated = true
|
358
371
|
o.input = Shapes::ShapeRef.new(shape: ExecuteSqlRequest)
|
359
372
|
o.output = Shapes::ShapeRef.new(shape: ExecuteSqlResponse)
|
373
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
360
374
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
361
375
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
362
376
|
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
@@ -369,6 +383,7 @@ module Aws::RDSDataService
|
|
369
383
|
o.http_request_uri = "/Execute"
|
370
384
|
o.input = Shapes::ShapeRef.new(shape: ExecuteStatementRequest)
|
371
385
|
o.output = Shapes::ShapeRef.new(shape: ExecuteStatementResponse)
|
386
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
372
387
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
373
388
|
o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
|
374
389
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
@@ -382,6 +397,7 @@ module Aws::RDSDataService
|
|
382
397
|
o.http_request_uri = "/RollbackTransaction"
|
383
398
|
o.input = Shapes::ShapeRef.new(shape: RollbackTransactionRequest)
|
384
399
|
o.output = Shapes::ShapeRef.new(shape: RollbackTransactionResponse)
|
400
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
385
401
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
386
402
|
o.errors << Shapes::ShapeRef.new(shape: StatementTimeoutException)
|
387
403
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
@@ -27,6 +27,7 @@ module Aws::RDSDataService
|
|
27
27
|
# See {Seahorse::Client::RequestContext} for more information.
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
30
31
|
# * {BadRequestException}
|
31
32
|
# * {ForbiddenException}
|
32
33
|
# * {InternalServerErrorException}
|
@@ -40,6 +41,21 @@ module Aws::RDSDataService
|
|
40
41
|
|
41
42
|
extend Aws::Errors::DynamicErrors
|
42
43
|
|
44
|
+
class AccessDeniedException < ServiceError
|
45
|
+
|
46
|
+
# @param [Seahorse::Client::RequestContext] context
|
47
|
+
# @param [String] message
|
48
|
+
# @param [Aws::RDSDataService::Types::AccessDeniedException] data
|
49
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
50
|
+
super(context, message, data)
|
51
|
+
end
|
52
|
+
|
53
|
+
# @return [String]
|
54
|
+
def message
|
55
|
+
@message || @data[:message]
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
43
59
|
class BadRequestException < ServiceError
|
44
60
|
|
45
61
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -10,6 +10,19 @@
|
|
10
10
|
module Aws::RDSDataService
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
13
26
|
# Contains an array.
|
14
27
|
#
|
15
28
|
# @note ArrayValue is a union - when making an API calls you must set exactly one of the members.
|
@@ -25,11 +38,11 @@ module Aws::RDSDataService
|
|
25
38
|
# @return [Array<Boolean>]
|
26
39
|
#
|
27
40
|
# @!attribute [rw] double_values
|
28
|
-
# An array of
|
41
|
+
# An array of floating-point numbers.
|
29
42
|
# @return [Array<Float>]
|
30
43
|
#
|
31
44
|
# @!attribute [rw] long_values
|
32
|
-
# An array of
|
45
|
+
# An array of integers.
|
33
46
|
# @return [Array<Integer>]
|
34
47
|
#
|
35
48
|
# @!attribute [rw] string_values
|
@@ -143,11 +156,21 @@ module Aws::RDSDataService
|
|
143
156
|
# @return [String]
|
144
157
|
#
|
145
158
|
# @!attribute [rw] secret_arn
|
146
|
-
# The
|
159
|
+
# The ARN of the secret that enables access to the DB cluster. Enter
|
160
|
+
# the database user name and password for the credentials in the
|
161
|
+
# secret.
|
162
|
+
#
|
163
|
+
# For information about creating the secret, see [Create a database
|
164
|
+
# secret][1].
|
165
|
+
#
|
166
|
+
#
|
167
|
+
#
|
168
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
147
169
|
# @return [String]
|
148
170
|
#
|
149
171
|
# @!attribute [rw] sql
|
150
|
-
# The SQL statement to run.
|
172
|
+
# The SQL statement to run. Don't include a semicolon (;) at the end
|
173
|
+
# of the SQL statement.
|
151
174
|
# @return [String]
|
152
175
|
#
|
153
176
|
# @!attribute [rw] transaction_id
|
@@ -387,7 +410,15 @@ module Aws::RDSDataService
|
|
387
410
|
#
|
388
411
|
# @!attribute [rw] aws_secret_store_arn
|
389
412
|
# The Amazon Resource Name (ARN) of the secret that enables access to
|
390
|
-
# the DB cluster.
|
413
|
+
# the DB cluster. Enter the database user name and password for the
|
414
|
+
# credentials in the secret.
|
415
|
+
#
|
416
|
+
# For information about creating the secret, see [Create a database
|
417
|
+
# secret][1].
|
418
|
+
#
|
419
|
+
#
|
420
|
+
#
|
421
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
391
422
|
# @return [String]
|
392
423
|
#
|
393
424
|
# @!attribute [rw] database
|
@@ -446,6 +477,7 @@ module Aws::RDSDataService
|
|
446
477
|
# {
|
447
478
|
# continue_after_timeout: false,
|
448
479
|
# database: "DbName",
|
480
|
+
# format_records_as: "NONE", # accepts NONE, JSON
|
449
481
|
# include_result_metadata: false,
|
450
482
|
# parameters: [
|
451
483
|
# {
|
@@ -475,6 +507,7 @@ module Aws::RDSDataService
|
|
475
507
|
# resource_arn: "Arn", # required
|
476
508
|
# result_set_options: {
|
477
509
|
# decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
|
510
|
+
# long_return_type: "STRING", # accepts STRING, LONG
|
478
511
|
# },
|
479
512
|
# schema: "DbName",
|
480
513
|
# secret_arn: "Arn", # required
|
@@ -497,6 +530,21 @@ module Aws::RDSDataService
|
|
497
530
|
# The name of the database.
|
498
531
|
# @return [String]
|
499
532
|
#
|
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.
|
539
|
+
#
|
540
|
+
# For usage information about the JSON format for result sets, see
|
541
|
+
# [Using the Data API][1] in the *Amazon Aurora User Guide*.
|
542
|
+
#
|
543
|
+
#
|
544
|
+
#
|
545
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
546
|
+
# @return [String]
|
547
|
+
#
|
500
548
|
# @!attribute [rw] include_result_metadata
|
501
549
|
# A value that indicates whether to include metadata in the results.
|
502
550
|
# @return [Boolean]
|
@@ -526,7 +574,16 @@ module Aws::RDSDataService
|
|
526
574
|
# @return [String]
|
527
575
|
#
|
528
576
|
# @!attribute [rw] secret_arn
|
529
|
-
# The
|
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
|
+
#
|
585
|
+
#
|
586
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
530
587
|
# @return [String]
|
531
588
|
#
|
532
589
|
# @!attribute [rw] sql
|
@@ -547,6 +604,7 @@ module Aws::RDSDataService
|
|
547
604
|
class ExecuteStatementRequest < Struct.new(
|
548
605
|
:continue_after_timeout,
|
549
606
|
:database,
|
607
|
+
:format_records_as,
|
550
608
|
:include_result_metadata,
|
551
609
|
:parameters,
|
552
610
|
:resource_arn,
|
@@ -563,11 +621,22 @@ module Aws::RDSDataService
|
|
563
621
|
# statement against a database.
|
564
622
|
#
|
565
623
|
# @!attribute [rw] column_metadata
|
566
|
-
# Metadata for the columns included in the results.
|
624
|
+
# Metadata for the columns included in the results. This field is
|
625
|
+
# blank if the `formatRecordsAs` parameter is set to `JSON`.
|
567
626
|
# @return [Array<Types::ColumnMetadata>]
|
568
627
|
#
|
628
|
+
# @!attribute [rw] formatted_records
|
629
|
+
# A string value that represents the result set of a `SELECT`
|
630
|
+
# statement in JSON format. This value is only present when the
|
631
|
+
# `formatRecordsAs` parameter is set to `JSON`.
|
632
|
+
#
|
633
|
+
# The size limit for this field is currently 10 MB. If the
|
634
|
+
# JSON-formatted string representing the result set requires more than
|
635
|
+
# 10 MB, the call returns an error.
|
636
|
+
# @return [String]
|
637
|
+
#
|
569
638
|
# @!attribute [rw] generated_fields
|
570
|
-
# Values for fields generated during
|
639
|
+
# Values for fields generated during a DML request.
|
571
640
|
#
|
572
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>
|
573
642
|
# @return [Array<Types::Field>]
|
@@ -577,13 +646,15 @@ module Aws::RDSDataService
|
|
577
646
|
# @return [Integer]
|
578
647
|
#
|
579
648
|
# @!attribute [rw] records
|
580
|
-
# The records returned by the SQL statement.
|
649
|
+
# The records returned by the SQL statement. This field is blank if
|
650
|
+
# the `formatRecordsAs` parameter is set to `JSON`.
|
581
651
|
# @return [Array<Array<Types::Field>>]
|
582
652
|
#
|
583
653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatementResponse AWS API Documentation
|
584
654
|
#
|
585
655
|
class ExecuteStatementResponse < Struct.new(
|
586
656
|
:column_metadata,
|
657
|
+
:formatted_records,
|
587
658
|
:generated_fields,
|
588
659
|
:number_of_records_updated,
|
589
660
|
:records)
|
@@ -687,6 +758,10 @@ module Aws::RDSDataService
|
|
687
758
|
|
688
759
|
# A record returned by a call.
|
689
760
|
#
|
761
|
+
# This data structure is only used with the deprecated `ExecuteSql`
|
762
|
+
# operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
|
763
|
+
# operation instead.
|
764
|
+
#
|
690
765
|
# @!attribute [rw] values
|
691
766
|
# The values returned in the record.
|
692
767
|
# @return [Array<Types::Value>]
|
@@ -701,6 +776,10 @@ module Aws::RDSDataService
|
|
701
776
|
|
702
777
|
# The result set returned by a SQL statement.
|
703
778
|
#
|
779
|
+
# This data structure is only used with the deprecated `ExecuteSql`
|
780
|
+
# operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
|
781
|
+
# operation instead.
|
782
|
+
#
|
704
783
|
# @!attribute [rw] records
|
705
784
|
# The records in the result set.
|
706
785
|
# @return [Array<Types::Record>]
|
@@ -744,6 +823,7 @@ module Aws::RDSDataService
|
|
744
823
|
#
|
745
824
|
# {
|
746
825
|
# decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
|
826
|
+
# long_return_type: "STRING", # accepts STRING, LONG
|
747
827
|
# }
|
748
828
|
#
|
749
829
|
# @!attribute [rw] decimal_return_type
|
@@ -758,10 +838,18 @@ module Aws::RDSDataService
|
|
758
838
|
# working with currency values.
|
759
839
|
# @return [String]
|
760
840
|
#
|
841
|
+
# @!attribute [rw] long_return_type
|
842
|
+
# A value that indicates how a field of `LONG` type is represented.
|
843
|
+
# Allowed values are `LONG` and `STRING`. The default is `LONG`.
|
844
|
+
# Specify `STRING` if the length or precision of numeric values might
|
845
|
+
# cause truncation or rounding errors.
|
846
|
+
# @return [String]
|
847
|
+
#
|
761
848
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultSetOptions AWS API Documentation
|
762
849
|
#
|
763
850
|
class ResultSetOptions < Struct.new(
|
764
|
-
:decimal_return_type
|
851
|
+
:decimal_return_type,
|
852
|
+
:long_return_type)
|
765
853
|
SENSITIVE = []
|
766
854
|
include Aws::Structure
|
767
855
|
end
|
@@ -896,7 +984,7 @@ module Aws::RDSDataService
|
|
896
984
|
|
897
985
|
# The result of a SQL statement.
|
898
986
|
#
|
899
|
-
# <important> <p>This data
|
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>
|
900
988
|
#
|
901
989
|
# @!attribute [rw] number_of_records_updated
|
902
990
|
# The number of records updated by a SQL statement.
|
@@ -937,6 +1025,10 @@ module Aws::RDSDataService
|
|
937
1025
|
|
938
1026
|
# A structure value returned by a call.
|
939
1027
|
#
|
1028
|
+
# This data structure is only used with the deprecated `ExecuteSql`
|
1029
|
+
# operation. Use the `BatchExecuteStatement` or `ExecuteStatement`
|
1030
|
+
# operation instead.
|
1031
|
+
#
|
940
1032
|
# @!attribute [rw] attributes
|
941
1033
|
# The attributes returned in the record.
|
942
1034
|
# @return [Array<Types::Value>]
|
@@ -965,7 +1057,7 @@ module Aws::RDSDataService
|
|
965
1057
|
|
966
1058
|
# Contains the value of a column.
|
967
1059
|
#
|
968
|
-
# <important> <p>This data
|
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>
|
969
1061
|
#
|
970
1062
|
# @note Value is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Value corresponding to the set member.
|
971
1063
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-rdsdataservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.36.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-06-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.127.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.127.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|