aws-sdk-redshiftdataapiservice 1.5.0 → 1.9.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 +53 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-redshiftdataapiservice.rb +3 -3
- data/lib/aws-sdk-redshiftdataapiservice/client.rb +166 -52
- data/lib/aws-sdk-redshiftdataapiservice/client_api.rb +95 -11
- data/lib/aws-sdk-redshiftdataapiservice/errors.rb +22 -1
- data/lib/aws-sdk-redshiftdataapiservice/resource.rb +1 -1
- data/lib/aws-sdk-redshiftdataapiservice/types.rb +329 -36
- metadata +11 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 072d8c6f1b5e1957e22d3a95e5343fe5d77604534a20338e014d1b019e767de3
|
|
4
|
+
data.tar.gz: 4941c2dd758c18fd3da2050861997de8c46bedfba9559d8e30b2e19ca72fe96f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 95286b093a3485721df1441c6658ee858f5d687da6a62bedf1849586cefeb49aa31b2431bb442b90e6f690709830b3e15cd1f296ecaa896f1323b028ce927f24
|
|
7
|
+
data.tar.gz: ccba27c1bd68b3a2c66054fbb0421c835ccf71698a4170a79542ad6f783377f962a5f86570354a3b7805141416a17461a3b8c42202cacd9de5adb6d4246398aa
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
Unreleased Changes
|
|
2
|
+
------------------
|
|
3
|
+
|
|
4
|
+
1.9.0 (2021-07-28)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
8
|
+
|
|
9
|
+
1.8.0 (2021-07-27)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Added structures to support new Data API operation BatchExecuteStatement, used to execute multiple SQL statements within a single transaction.
|
|
13
|
+
|
|
14
|
+
1.7.0 (2021-06-15)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Redshift Data API service now supports SQL parameterization.
|
|
18
|
+
|
|
19
|
+
1.6.0 (2021-03-10)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
23
|
+
|
|
24
|
+
1.5.0 (2021-02-23)
|
|
25
|
+
------------------
|
|
26
|
+
|
|
27
|
+
* Feature - This release adds an additional parameter 'ConnectedDatabase' into ListSchemasRequest, ListTablesRequest and DescribeTableRequest to support the metadata sharing across databases.
|
|
28
|
+
|
|
29
|
+
1.4.0 (2021-02-15)
|
|
30
|
+
------------------
|
|
31
|
+
|
|
32
|
+
* Feature - This release enables fine grant access control in ListStatements, GetStatementResult, CancelStatement and DescribeStatement.
|
|
33
|
+
|
|
34
|
+
1.3.0 (2021-02-02)
|
|
35
|
+
------------------
|
|
36
|
+
|
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
38
|
+
|
|
39
|
+
1.2.0 (2020-09-30)
|
|
40
|
+
------------------
|
|
41
|
+
|
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
43
|
+
|
|
44
|
+
1.1.0 (2020-09-15)
|
|
45
|
+
------------------
|
|
46
|
+
|
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
48
|
+
|
|
49
|
+
1.0.0 (2020-09-09)
|
|
50
|
+
------------------
|
|
51
|
+
|
|
52
|
+
* Feature - Initial release of `aws-sdk-redshiftdataapiservice`.
|
|
53
|
+
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
1.9.0
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-redshiftdataapiservice/customizations'
|
|
|
28
28
|
# structure.
|
|
29
29
|
#
|
|
30
30
|
# redshift_data_api_service = Aws::RedshiftDataAPIService::Client.new
|
|
31
|
-
# resp = redshift_data_api_service.
|
|
31
|
+
# resp = redshift_data_api_service.batch_execute_statement(params)
|
|
32
32
|
#
|
|
33
33
|
# See {Client} for more information.
|
|
34
34
|
#
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-redshiftdataapiservice/customizations'
|
|
|
48
48
|
# @!group service
|
|
49
49
|
module Aws::RedshiftDataAPIService
|
|
50
50
|
|
|
51
|
-
GEM_VERSION = '1.
|
|
51
|
+
GEM_VERSION = '1.9.0'
|
|
52
52
|
|
|
53
53
|
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -337,13 +337,93 @@ module Aws::RedshiftDataAPIService
|
|
|
337
337
|
|
|
338
338
|
# @!group API Operations
|
|
339
339
|
|
|
340
|
+
# Runs one or more SQL statements, which can be data manipulation
|
|
341
|
+
# language (DML) or data definition language (DDL). Depending on the
|
|
342
|
+
# authorization method, use one of the following combinations of request
|
|
343
|
+
# parameters:
|
|
344
|
+
#
|
|
345
|
+
# * Secrets Manager - specify the Amazon Resource Name (ARN) of the
|
|
346
|
+
# secret, the database name, and the cluster identifier that matches
|
|
347
|
+
# the cluster in the secret.
|
|
348
|
+
#
|
|
349
|
+
# * Temporary credentials - specify the cluster identifier, the database
|
|
350
|
+
# name, and the database user name. Permission to call the
|
|
351
|
+
# `redshift:GetClusterCredentials` operation is required to use this
|
|
352
|
+
# method.
|
|
353
|
+
#
|
|
354
|
+
# @option params [required, String] :cluster_identifier
|
|
355
|
+
# The cluster identifier. This parameter is required when authenticating
|
|
356
|
+
# using either Secrets Manager or temporary credentials.
|
|
357
|
+
#
|
|
358
|
+
# @option params [required, String] :database
|
|
359
|
+
# The name of the database. This parameter is required when
|
|
360
|
+
# authenticating using either Secrets Manager or temporary credentials.
|
|
361
|
+
#
|
|
362
|
+
# @option params [String] :db_user
|
|
363
|
+
# The database user name. This parameter is required when authenticating
|
|
364
|
+
# using temporary credentials.
|
|
365
|
+
#
|
|
366
|
+
# @option params [String] :secret_arn
|
|
367
|
+
# The name or ARN of the secret that enables access to the database.
|
|
368
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
369
|
+
#
|
|
370
|
+
# @option params [required, Array<String>] :sqls
|
|
371
|
+
# One or more SQL statements to run.
|
|
372
|
+
#
|
|
373
|
+
# @option params [String] :statement_name
|
|
374
|
+
# The name of the SQL statements. You can name the SQL statements when
|
|
375
|
+
# you create them to identify the query.
|
|
376
|
+
#
|
|
377
|
+
# @option params [Boolean] :with_event
|
|
378
|
+
# A value that indicates whether to send an event to the Amazon
|
|
379
|
+
# EventBridge event bus after the SQL statements run.
|
|
380
|
+
#
|
|
381
|
+
# @return [Types::BatchExecuteStatementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
382
|
+
#
|
|
383
|
+
# * {Types::BatchExecuteStatementOutput#cluster_identifier #cluster_identifier} => String
|
|
384
|
+
# * {Types::BatchExecuteStatementOutput#created_at #created_at} => Time
|
|
385
|
+
# * {Types::BatchExecuteStatementOutput#database #database} => String
|
|
386
|
+
# * {Types::BatchExecuteStatementOutput#db_user #db_user} => String
|
|
387
|
+
# * {Types::BatchExecuteStatementOutput#id #id} => String
|
|
388
|
+
# * {Types::BatchExecuteStatementOutput#secret_arn #secret_arn} => String
|
|
389
|
+
#
|
|
390
|
+
# @example Request syntax with placeholder values
|
|
391
|
+
#
|
|
392
|
+
# resp = client.batch_execute_statement({
|
|
393
|
+
# cluster_identifier: "Location", # required
|
|
394
|
+
# database: "String", # required
|
|
395
|
+
# db_user: "String",
|
|
396
|
+
# secret_arn: "SecretArn",
|
|
397
|
+
# sqls: ["StatementString"], # required
|
|
398
|
+
# statement_name: "StatementNameString",
|
|
399
|
+
# with_event: false,
|
|
400
|
+
# })
|
|
401
|
+
#
|
|
402
|
+
# @example Response structure
|
|
403
|
+
#
|
|
404
|
+
# resp.cluster_identifier #=> String
|
|
405
|
+
# resp.created_at #=> Time
|
|
406
|
+
# resp.database #=> String
|
|
407
|
+
# resp.db_user #=> String
|
|
408
|
+
# resp.id #=> String
|
|
409
|
+
# resp.secret_arn #=> String
|
|
410
|
+
#
|
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatement AWS API Documentation
|
|
412
|
+
#
|
|
413
|
+
# @overload batch_execute_statement(params = {})
|
|
414
|
+
# @param [Hash] params ({})
|
|
415
|
+
def batch_execute_statement(params = {}, options = {})
|
|
416
|
+
req = build_request(:batch_execute_statement, params)
|
|
417
|
+
req.send_request(options)
|
|
418
|
+
end
|
|
419
|
+
|
|
340
420
|
# Cancels a running query. To be canceled, a query must be running.
|
|
341
421
|
#
|
|
342
422
|
# @option params [required, String] :id
|
|
343
423
|
# The identifier of the SQL statement to cancel. This value is a
|
|
344
424
|
# universally unique identifier (UUID) generated by Amazon Redshift Data
|
|
345
|
-
# API. This identifier is returned by `
|
|
346
|
-
# `ListStatements`.
|
|
425
|
+
# API. This identifier is returned by `BatchExecuteStatment`,
|
|
426
|
+
# `ExecuteStatment`, and `ListStatements`.
|
|
347
427
|
#
|
|
348
428
|
# @return [Types::CancelStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
349
429
|
#
|
|
@@ -352,7 +432,7 @@ module Aws::RedshiftDataAPIService
|
|
|
352
432
|
# @example Request syntax with placeholder values
|
|
353
433
|
#
|
|
354
434
|
# resp = client.cancel_statement({
|
|
355
|
-
# id: "
|
|
435
|
+
# id: "StatementId", # required
|
|
356
436
|
# })
|
|
357
437
|
#
|
|
358
438
|
# @example Response structure
|
|
@@ -376,7 +456,10 @@ module Aws::RedshiftDataAPIService
|
|
|
376
456
|
# @option params [required, String] :id
|
|
377
457
|
# The identifier of the SQL statement to describe. This value is a
|
|
378
458
|
# universally unique identifier (UUID) generated by Amazon Redshift Data
|
|
379
|
-
# API.
|
|
459
|
+
# API. A suffix indicates the number of the SQL statement. For example,
|
|
460
|
+
# `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that
|
|
461
|
+
# indicates the second SQL statement of a batch query. This identifier
|
|
462
|
+
# is returned by `BatchExecuteStatment`, `ExecuteStatement`, and
|
|
380
463
|
# `ListStatements`.
|
|
381
464
|
#
|
|
382
465
|
# @return [Types::DescribeStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -389,6 +472,7 @@ module Aws::RedshiftDataAPIService
|
|
|
389
472
|
# * {Types::DescribeStatementResponse#error #error} => String
|
|
390
473
|
# * {Types::DescribeStatementResponse#has_result_set #has_result_set} => Boolean
|
|
391
474
|
# * {Types::DescribeStatementResponse#id #id} => String
|
|
475
|
+
# * {Types::DescribeStatementResponse#query_parameters #query_parameters} => Array<Types::SqlParameter>
|
|
392
476
|
# * {Types::DescribeStatementResponse#query_string #query_string} => String
|
|
393
477
|
# * {Types::DescribeStatementResponse#redshift_pid #redshift_pid} => Integer
|
|
394
478
|
# * {Types::DescribeStatementResponse#redshift_query_id #redshift_query_id} => Integer
|
|
@@ -396,12 +480,13 @@ module Aws::RedshiftDataAPIService
|
|
|
396
480
|
# * {Types::DescribeStatementResponse#result_size #result_size} => Integer
|
|
397
481
|
# * {Types::DescribeStatementResponse#secret_arn #secret_arn} => String
|
|
398
482
|
# * {Types::DescribeStatementResponse#status #status} => String
|
|
483
|
+
# * {Types::DescribeStatementResponse#sub_statements #sub_statements} => Array<Types::SubStatementData>
|
|
399
484
|
# * {Types::DescribeStatementResponse#updated_at #updated_at} => Time
|
|
400
485
|
#
|
|
401
486
|
# @example Request syntax with placeholder values
|
|
402
487
|
#
|
|
403
488
|
# resp = client.describe_statement({
|
|
404
|
-
# id: "
|
|
489
|
+
# id: "StatementId", # required
|
|
405
490
|
# })
|
|
406
491
|
#
|
|
407
492
|
# @example Response structure
|
|
@@ -414,6 +499,9 @@ module Aws::RedshiftDataAPIService
|
|
|
414
499
|
# resp.error #=> String
|
|
415
500
|
# resp.has_result_set #=> Boolean
|
|
416
501
|
# resp.id #=> String
|
|
502
|
+
# resp.query_parameters #=> Array
|
|
503
|
+
# resp.query_parameters[0].name #=> String
|
|
504
|
+
# resp.query_parameters[0].value #=> String
|
|
417
505
|
# resp.query_string #=> String
|
|
418
506
|
# resp.redshift_pid #=> Integer
|
|
419
507
|
# resp.redshift_query_id #=> Integer
|
|
@@ -421,6 +509,18 @@ module Aws::RedshiftDataAPIService
|
|
|
421
509
|
# resp.result_size #=> Integer
|
|
422
510
|
# resp.secret_arn #=> String
|
|
423
511
|
# resp.status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
|
|
512
|
+
# resp.sub_statements #=> Array
|
|
513
|
+
# resp.sub_statements[0].created_at #=> Time
|
|
514
|
+
# resp.sub_statements[0].duration #=> Integer
|
|
515
|
+
# resp.sub_statements[0].error #=> String
|
|
516
|
+
# resp.sub_statements[0].has_result_set #=> Boolean
|
|
517
|
+
# resp.sub_statements[0].id #=> String
|
|
518
|
+
# resp.sub_statements[0].query_string #=> String
|
|
519
|
+
# resp.sub_statements[0].redshift_query_id #=> Integer
|
|
520
|
+
# resp.sub_statements[0].result_rows #=> Integer
|
|
521
|
+
# resp.sub_statements[0].result_size #=> Integer
|
|
522
|
+
# resp.sub_statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED"
|
|
523
|
+
# resp.sub_statements[0].updated_at #=> Time
|
|
424
524
|
# resp.updated_at #=> Time
|
|
425
525
|
#
|
|
426
526
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatement AWS API Documentation
|
|
@@ -437,9 +537,9 @@ module Aws::RedshiftDataAPIService
|
|
|
437
537
|
# page through the column list. Depending on the authorization method,
|
|
438
538
|
# use one of the following combinations of request parameters:
|
|
439
539
|
#
|
|
440
|
-
# *
|
|
441
|
-
# secret and the cluster identifier that matches
|
|
442
|
-
# secret.
|
|
540
|
+
# * Secrets Manager - specify the Amazon Resource Name (ARN) of the
|
|
541
|
+
# secret, the database name, and the cluster identifier that matches
|
|
542
|
+
# the cluster in the secret.
|
|
443
543
|
#
|
|
444
544
|
# * Temporary credentials - specify the cluster identifier, the database
|
|
445
545
|
# name, and the database user name. Permission to call the
|
|
@@ -448,7 +548,7 @@ module Aws::RedshiftDataAPIService
|
|
|
448
548
|
#
|
|
449
549
|
# @option params [required, String] :cluster_identifier
|
|
450
550
|
# The cluster identifier. This parameter is required when authenticating
|
|
451
|
-
# using either
|
|
551
|
+
# using either Secrets Manager or temporary credentials.
|
|
452
552
|
#
|
|
453
553
|
# @option params [String] :connected_database
|
|
454
554
|
# A database name. The connected database is specified when you connect
|
|
@@ -482,8 +582,7 @@ module Aws::RedshiftDataAPIService
|
|
|
482
582
|
#
|
|
483
583
|
# @option params [String] :secret_arn
|
|
484
584
|
# The name or ARN of the secret that enables access to the database.
|
|
485
|
-
# This parameter is required when authenticating using
|
|
486
|
-
# Manager.
|
|
585
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
487
586
|
#
|
|
488
587
|
# @option params [String] :table
|
|
489
588
|
# The table name. If no table is specified, then all tables for all
|
|
@@ -545,9 +644,9 @@ module Aws::RedshiftDataAPIService
|
|
|
545
644
|
# statement. Depending on the authorization method, use one of the
|
|
546
645
|
# following combinations of request parameters:
|
|
547
646
|
#
|
|
548
|
-
# *
|
|
549
|
-
# secret and the cluster identifier that matches
|
|
550
|
-
# secret.
|
|
647
|
+
# * Secrets Manager - specify the Amazon Resource Name (ARN) of the
|
|
648
|
+
# secret, the database name, and the cluster identifier that matches
|
|
649
|
+
# the cluster in the secret.
|
|
551
650
|
#
|
|
552
651
|
# * Temporary credentials - specify the cluster identifier, the database
|
|
553
652
|
# name, and the database user name. Permission to call the
|
|
@@ -556,20 +655,22 @@ module Aws::RedshiftDataAPIService
|
|
|
556
655
|
#
|
|
557
656
|
# @option params [required, String] :cluster_identifier
|
|
558
657
|
# The cluster identifier. This parameter is required when authenticating
|
|
559
|
-
# using either
|
|
658
|
+
# using either Secrets Manager or temporary credentials.
|
|
560
659
|
#
|
|
561
|
-
# @option params [String] :database
|
|
660
|
+
# @option params [required, String] :database
|
|
562
661
|
# The name of the database. This parameter is required when
|
|
563
|
-
# authenticating using temporary credentials.
|
|
662
|
+
# authenticating using either Secrets Manager or temporary credentials.
|
|
564
663
|
#
|
|
565
664
|
# @option params [String] :db_user
|
|
566
665
|
# The database user name. This parameter is required when authenticating
|
|
567
666
|
# using temporary credentials.
|
|
568
667
|
#
|
|
668
|
+
# @option params [Array<Types::SqlParameter>] :parameters
|
|
669
|
+
# The parameters for the SQL statement.
|
|
670
|
+
#
|
|
569
671
|
# @option params [String] :secret_arn
|
|
570
672
|
# The name or ARN of the secret that enables access to the database.
|
|
571
|
-
# This parameter is required when authenticating using
|
|
572
|
-
# Manager.
|
|
673
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
573
674
|
#
|
|
574
675
|
# @option params [required, String] :sql
|
|
575
676
|
# The SQL statement text to run.
|
|
@@ -595,8 +696,14 @@ module Aws::RedshiftDataAPIService
|
|
|
595
696
|
#
|
|
596
697
|
# resp = client.execute_statement({
|
|
597
698
|
# cluster_identifier: "Location", # required
|
|
598
|
-
# database: "String",
|
|
699
|
+
# database: "String", # required
|
|
599
700
|
# db_user: "String",
|
|
701
|
+
# parameters: [
|
|
702
|
+
# {
|
|
703
|
+
# name: "ParameterName", # required
|
|
704
|
+
# value: "ParameterValue", # required
|
|
705
|
+
# },
|
|
706
|
+
# ],
|
|
600
707
|
# secret_arn: "SecretArn",
|
|
601
708
|
# sql: "StatementString", # required
|
|
602
709
|
# statement_name: "StatementNameString",
|
|
@@ -627,8 +734,11 @@ module Aws::RedshiftDataAPIService
|
|
|
627
734
|
# @option params [required, String] :id
|
|
628
735
|
# The identifier of the SQL statement whose results are to be fetched.
|
|
629
736
|
# This value is a universally unique identifier (UUID) generated by
|
|
630
|
-
# Amazon Redshift Data API.
|
|
631
|
-
# `
|
|
737
|
+
# Amazon Redshift Data API. A suffix indicates then number of the SQL
|
|
738
|
+
# statement. For example, `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a
|
|
739
|
+
# suffix of `:2` that indicates the second SQL statement of a batch
|
|
740
|
+
# query. This identifier is returned by `BatchExecuteStatment`,
|
|
741
|
+
# `ExecuteStatment`, and `ListStatements`.
|
|
632
742
|
#
|
|
633
743
|
# @option params [String] :next_token
|
|
634
744
|
# A value that indicates the starting point for the next set of response
|
|
@@ -650,7 +760,7 @@ module Aws::RedshiftDataAPIService
|
|
|
650
760
|
# @example Request syntax with placeholder values
|
|
651
761
|
#
|
|
652
762
|
# resp = client.get_statement_result({
|
|
653
|
-
# id: "
|
|
763
|
+
# id: "StatementId", # required
|
|
654
764
|
# next_token: "String",
|
|
655
765
|
# })
|
|
656
766
|
#
|
|
@@ -694,9 +804,9 @@ module Aws::RedshiftDataAPIService
|
|
|
694
804
|
# the database list. Depending on the authorization method, use one of
|
|
695
805
|
# the following combinations of request parameters:
|
|
696
806
|
#
|
|
697
|
-
# *
|
|
698
|
-
# secret and the cluster identifier that matches
|
|
699
|
-
# secret.
|
|
807
|
+
# * Secrets Manager - specify the Amazon Resource Name (ARN) of the
|
|
808
|
+
# secret, the database name, and the cluster identifier that matches
|
|
809
|
+
# the cluster in the secret.
|
|
700
810
|
#
|
|
701
811
|
# * Temporary credentials - specify the cluster identifier, the database
|
|
702
812
|
# name, and the database user name. Permission to call the
|
|
@@ -705,11 +815,11 @@ module Aws::RedshiftDataAPIService
|
|
|
705
815
|
#
|
|
706
816
|
# @option params [required, String] :cluster_identifier
|
|
707
817
|
# The cluster identifier. This parameter is required when authenticating
|
|
708
|
-
# using either
|
|
818
|
+
# using either Secrets Manager or temporary credentials.
|
|
709
819
|
#
|
|
710
|
-
# @option params [String] :database
|
|
820
|
+
# @option params [required, String] :database
|
|
711
821
|
# The name of the database. This parameter is required when
|
|
712
|
-
# authenticating using temporary credentials.
|
|
822
|
+
# authenticating using either Secrets Manager or temporary credentials.
|
|
713
823
|
#
|
|
714
824
|
# @option params [String] :db_user
|
|
715
825
|
# The database user name. This parameter is required when authenticating
|
|
@@ -730,8 +840,7 @@ module Aws::RedshiftDataAPIService
|
|
|
730
840
|
#
|
|
731
841
|
# @option params [String] :secret_arn
|
|
732
842
|
# The name or ARN of the secret that enables access to the database.
|
|
733
|
-
# This parameter is required when authenticating using
|
|
734
|
-
# Manager.
|
|
843
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
735
844
|
#
|
|
736
845
|
# @return [Types::ListDatabasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
737
846
|
#
|
|
@@ -744,7 +853,7 @@ module Aws::RedshiftDataAPIService
|
|
|
744
853
|
#
|
|
745
854
|
# resp = client.list_databases({
|
|
746
855
|
# cluster_identifier: "Location", # required
|
|
747
|
-
# database: "String",
|
|
856
|
+
# database: "String", # required
|
|
748
857
|
# db_user: "String",
|
|
749
858
|
# max_results: 1,
|
|
750
859
|
# next_token: "String",
|
|
@@ -770,9 +879,9 @@ module Aws::RedshiftDataAPIService
|
|
|
770
879
|
# the schema list. Depending on the authorization method, use one of the
|
|
771
880
|
# following combinations of request parameters:
|
|
772
881
|
#
|
|
773
|
-
# *
|
|
774
|
-
# secret and the cluster identifier that matches
|
|
775
|
-
# secret.
|
|
882
|
+
# * Secrets Manager - specify the Amazon Resource Name (ARN) of the
|
|
883
|
+
# secret, the database name, and the cluster identifier that matches
|
|
884
|
+
# the cluster in the secret.
|
|
776
885
|
#
|
|
777
886
|
# * Temporary credentials - specify the cluster identifier, the database
|
|
778
887
|
# name, and the database user name. Permission to call the
|
|
@@ -781,7 +890,7 @@ module Aws::RedshiftDataAPIService
|
|
|
781
890
|
#
|
|
782
891
|
# @option params [required, String] :cluster_identifier
|
|
783
892
|
# The cluster identifier. This parameter is required when authenticating
|
|
784
|
-
# using either
|
|
893
|
+
# using either Secrets Manager or temporary credentials.
|
|
785
894
|
#
|
|
786
895
|
# @option params [String] :connected_database
|
|
787
896
|
# A database name. The connected database is specified when you connect
|
|
@@ -817,8 +926,7 @@ module Aws::RedshiftDataAPIService
|
|
|
817
926
|
#
|
|
818
927
|
# @option params [String] :secret_arn
|
|
819
928
|
# The name or ARN of the secret that enables access to the database.
|
|
820
|
-
# This parameter is required when authenticating using
|
|
821
|
-
# Manager.
|
|
929
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
822
930
|
#
|
|
823
931
|
# @return [Types::ListSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
824
932
|
#
|
|
@@ -878,12 +986,13 @@ module Aws::RedshiftDataAPIService
|
|
|
878
986
|
# IAM session are returned. The default is true.
|
|
879
987
|
#
|
|
880
988
|
# @option params [String] :statement_name
|
|
881
|
-
# The name of the SQL statement specified as input to
|
|
882
|
-
# to identify the query.
|
|
883
|
-
#
|
|
884
|
-
#
|
|
885
|
-
#
|
|
886
|
-
#
|
|
989
|
+
# The name of the SQL statement specified as input to
|
|
990
|
+
# `BatchExecuteStatement` or `ExecuteStatement` to identify the query.
|
|
991
|
+
# You can list multiple statements by providing a prefix that matches
|
|
992
|
+
# the beginning of the statement name. For example, to list
|
|
993
|
+
# myStatement1, myStatement2, myStatement3, and so on, then provide the
|
|
994
|
+
# a value of `myStatement`. Data API does a case-sensitive match of SQL
|
|
995
|
+
# statement names to the prefix value you provide.
|
|
887
996
|
#
|
|
888
997
|
# @option params [String] :status
|
|
889
998
|
# The status of the SQL statement to list. Status values are defined as
|
|
@@ -927,7 +1036,13 @@ module Aws::RedshiftDataAPIService
|
|
|
927
1036
|
# resp.statements #=> Array
|
|
928
1037
|
# resp.statements[0].created_at #=> Time
|
|
929
1038
|
# resp.statements[0].id #=> String
|
|
1039
|
+
# resp.statements[0].is_batch_statement #=> Boolean
|
|
1040
|
+
# resp.statements[0].query_parameters #=> Array
|
|
1041
|
+
# resp.statements[0].query_parameters[0].name #=> String
|
|
1042
|
+
# resp.statements[0].query_parameters[0].value #=> String
|
|
930
1043
|
# resp.statements[0].query_string #=> String
|
|
1044
|
+
# resp.statements[0].query_strings #=> Array
|
|
1045
|
+
# resp.statements[0].query_strings[0] #=> String
|
|
931
1046
|
# resp.statements[0].secret_arn #=> String
|
|
932
1047
|
# resp.statements[0].statement_name #=> String
|
|
933
1048
|
# resp.statements[0].status #=> String, one of "SUBMITTED", "PICKED", "STARTED", "FINISHED", "ABORTED", "FAILED", "ALL"
|
|
@@ -948,9 +1063,9 @@ module Aws::RedshiftDataAPIService
|
|
|
948
1063
|
# Depending on the authorization method, use one of the following
|
|
949
1064
|
# combinations of request parameters:
|
|
950
1065
|
#
|
|
951
|
-
# *
|
|
952
|
-
# secret and the cluster identifier that matches
|
|
953
|
-
# secret.
|
|
1066
|
+
# * Secrets Manager - specify the Amazon Resource Name (ARN) of the
|
|
1067
|
+
# secret, the database name, and the cluster identifier that matches
|
|
1068
|
+
# the cluster in the secret.
|
|
954
1069
|
#
|
|
955
1070
|
# * Temporary credentials - specify the cluster identifier, the database
|
|
956
1071
|
# name, and the database user name. Permission to call the
|
|
@@ -959,7 +1074,7 @@ module Aws::RedshiftDataAPIService
|
|
|
959
1074
|
#
|
|
960
1075
|
# @option params [required, String] :cluster_identifier
|
|
961
1076
|
# The cluster identifier. This parameter is required when authenticating
|
|
962
|
-
# using either
|
|
1077
|
+
# using either Secrets Manager or temporary credentials.
|
|
963
1078
|
#
|
|
964
1079
|
# @option params [String] :connected_database
|
|
965
1080
|
# A database name. The connected database is specified when you connect
|
|
@@ -998,8 +1113,7 @@ module Aws::RedshiftDataAPIService
|
|
|
998
1113
|
#
|
|
999
1114
|
# @option params [String] :secret_arn
|
|
1000
1115
|
# The name or ARN of the secret that enables access to the database.
|
|
1001
|
-
# This parameter is required when authenticating using
|
|
1002
|
-
# Manager.
|
|
1116
|
+
# This parameter is required when authenticating using Secrets Manager.
|
|
1003
1117
|
#
|
|
1004
1118
|
# @option params [String] :table_pattern
|
|
1005
1119
|
# A pattern to filter results by table name. Within a table pattern,
|
|
@@ -1061,7 +1175,7 @@ module Aws::RedshiftDataAPIService
|
|
|
1061
1175
|
params: params,
|
|
1062
1176
|
config: config)
|
|
1063
1177
|
context[:gem_name] = 'aws-sdk-redshiftdataapiservice'
|
|
1064
|
-
context[:gem_version] = '1.
|
|
1178
|
+
context[:gem_version] = '1.9.0'
|
|
1065
1179
|
Seahorse::Client::Request.new(handlers, context)
|
|
1066
1180
|
end
|
|
1067
1181
|
|