aws-sdk-redshiftdataapiservice 1.64.0 → 1.65.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-redshiftdataapiservice/client.rb +289 -289
- data/lib/aws-sdk-redshiftdataapiservice/client_api.rb +97 -89
- data/lib/aws-sdk-redshiftdataapiservice/types.rb +506 -507
- data/lib/aws-sdk-redshiftdataapiservice.rb +1 -1
- data/sig/client.rbs +68 -68
- data/sig/types.rbs +91 -91
- metadata +1 -1
|
@@ -55,13 +55,13 @@ module Aws::RedshiftDataAPIService
|
|
|
55
55
|
include Aws::Structure
|
|
56
56
|
end
|
|
57
57
|
|
|
58
|
-
# @!attribute [rw]
|
|
59
|
-
#
|
|
60
|
-
#
|
|
61
|
-
#
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
# @return [String]
|
|
58
|
+
# @!attribute [rw] sqls
|
|
59
|
+
# One or more SQL statements to run. The SQL statements are run as a
|
|
60
|
+
# single transaction. They run serially in the order of the array.
|
|
61
|
+
# Subsequent SQL statements don't start until the previous statement
|
|
62
|
+
# in the array completes. If any SQL statement fails, then because
|
|
63
|
+
# they are run as one transaction, all work is rolled back.
|
|
64
|
+
# @return [Array<String>]
|
|
65
65
|
#
|
|
66
66
|
# @!attribute [rw] cluster_identifier
|
|
67
67
|
# The cluster identifier. This parameter is required when connecting
|
|
@@ -69,10 +69,10 @@ module Aws::RedshiftDataAPIService
|
|
|
69
69
|
# temporary credentials.
|
|
70
70
|
# @return [String]
|
|
71
71
|
#
|
|
72
|
-
# @!attribute [rw]
|
|
73
|
-
# The name of the
|
|
74
|
-
#
|
|
75
|
-
#
|
|
72
|
+
# @!attribute [rw] secret_arn
|
|
73
|
+
# The name or ARN of the secret that enables access to the database.
|
|
74
|
+
# This parameter is required when authenticating using Secrets
|
|
75
|
+
# Manager.
|
|
76
76
|
# @return [String]
|
|
77
77
|
#
|
|
78
78
|
# @!attribute [rw] db_user
|
|
@@ -81,47 +81,22 @@ module Aws::RedshiftDataAPIService
|
|
|
81
81
|
# credentials.
|
|
82
82
|
# @return [String]
|
|
83
83
|
#
|
|
84
|
-
# @!attribute [rw]
|
|
85
|
-
# The
|
|
86
|
-
#
|
|
87
|
-
#
|
|
88
|
-
#
|
|
89
|
-
# @!attribute [rw] secret_arn
|
|
90
|
-
# The name or ARN of the secret that enables access to the database.
|
|
91
|
-
# This parameter is required when authenticating using Secrets
|
|
92
|
-
# Manager.
|
|
93
|
-
# @return [String]
|
|
94
|
-
#
|
|
95
|
-
# @!attribute [rw] session_id
|
|
96
|
-
# The session identifier of the query.
|
|
84
|
+
# @!attribute [rw] database
|
|
85
|
+
# The name of the database. This parameter is required when
|
|
86
|
+
# authenticating using either Secrets Manager or temporary
|
|
87
|
+
# credentials.
|
|
97
88
|
# @return [String]
|
|
98
89
|
#
|
|
99
|
-
# @!attribute [rw]
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
#
|
|
103
|
-
# terminated.
|
|
104
|
-
# @return [Integer]
|
|
105
|
-
#
|
|
106
|
-
# @!attribute [rw] sqls
|
|
107
|
-
# One or more SQL statements to run. The SQL statements are run
|
|
108
|
-
# as a single transaction. They run serially in the order of the
|
|
109
|
-
# array. Subsequent SQL statements don't start until the previous
|
|
110
|
-
# statement in the array completes. If any SQL statement fails, then
|
|
111
|
-
# because they are run as one transaction, all work is rolled
|
|
112
|
-
# back.</p>
|
|
113
|
-
# @return [Array<String>]
|
|
90
|
+
# @!attribute [rw] with_event
|
|
91
|
+
# A value that indicates whether to send an event to the Amazon
|
|
92
|
+
# EventBridge event bus after the SQL statements run.
|
|
93
|
+
# @return [Boolean]
|
|
114
94
|
#
|
|
115
95
|
# @!attribute [rw] statement_name
|
|
116
96
|
# The name of the SQL statements. You can name the SQL statements when
|
|
117
97
|
# you create them to identify the query.
|
|
118
98
|
# @return [String]
|
|
119
99
|
#
|
|
120
|
-
# @!attribute [rw] with_event
|
|
121
|
-
# A value that indicates whether to send an event to the Amazon
|
|
122
|
-
# EventBridge event bus after the SQL statements run.
|
|
123
|
-
# @return [Boolean]
|
|
124
|
-
#
|
|
125
100
|
# @!attribute [rw] workgroup_name
|
|
126
101
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
127
102
|
# parameter is required when connecting to a serverless workgroup and
|
|
@@ -129,78 +104,102 @@ module Aws::RedshiftDataAPIService
|
|
|
129
104
|
# credentials.
|
|
130
105
|
# @return [String]
|
|
131
106
|
#
|
|
107
|
+
# @!attribute [rw] client_token
|
|
108
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
109
|
+
# idempotency of the request.
|
|
110
|
+
#
|
|
111
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
112
|
+
# not need to pass this option.
|
|
113
|
+
# @return [String]
|
|
114
|
+
#
|
|
115
|
+
# @!attribute [rw] result_format
|
|
116
|
+
# The data format of the result of the SQL statement. If no format is
|
|
117
|
+
# specified, the default is JSON.
|
|
118
|
+
# @return [String]
|
|
119
|
+
#
|
|
120
|
+
# @!attribute [rw] session_keep_alive_seconds
|
|
121
|
+
# The number of seconds to keep the session alive after the query
|
|
122
|
+
# finishes. The maximum time a session can keep alive is 24 hours.
|
|
123
|
+
# After 24 hours, the session is forced closed and the query is
|
|
124
|
+
# terminated.
|
|
125
|
+
# @return [Integer]
|
|
126
|
+
#
|
|
127
|
+
# @!attribute [rw] session_id
|
|
128
|
+
# The session identifier of the query.
|
|
129
|
+
# @return [String]
|
|
130
|
+
#
|
|
132
131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementInput AWS API Documentation
|
|
133
132
|
#
|
|
134
133
|
class BatchExecuteStatementInput < Struct.new(
|
|
135
|
-
:
|
|
134
|
+
:sqls,
|
|
136
135
|
:cluster_identifier,
|
|
137
|
-
:
|
|
136
|
+
:secret_arn,
|
|
138
137
|
:db_user,
|
|
138
|
+
:database,
|
|
139
|
+
:with_event,
|
|
140
|
+
:statement_name,
|
|
141
|
+
:workgroup_name,
|
|
142
|
+
:client_token,
|
|
139
143
|
:result_format,
|
|
140
|
-
:secret_arn,
|
|
141
|
-
:session_id,
|
|
142
144
|
:session_keep_alive_seconds,
|
|
143
|
-
:
|
|
144
|
-
:statement_name,
|
|
145
|
-
:with_event,
|
|
146
|
-
:workgroup_name)
|
|
145
|
+
:session_id)
|
|
147
146
|
SENSITIVE = []
|
|
148
147
|
include Aws::Structure
|
|
149
148
|
end
|
|
150
149
|
|
|
151
|
-
# @!attribute [rw]
|
|
152
|
-
# The
|
|
153
|
-
#
|
|
150
|
+
# @!attribute [rw] id
|
|
151
|
+
# The identifier of the SQL statement whose results are to be fetched.
|
|
152
|
+
# This value is a universally unique identifier (UUID) generated by
|
|
153
|
+
# Amazon Redshift Data API. This identifier is returned by
|
|
154
|
+
# `BatchExecuteStatment`.
|
|
154
155
|
# @return [String]
|
|
155
156
|
#
|
|
156
157
|
# @!attribute [rw] created_at
|
|
157
158
|
# The date and time (UTC) the statement was created.
|
|
158
159
|
# @return [Time]
|
|
159
160
|
#
|
|
160
|
-
# @!attribute [rw]
|
|
161
|
-
# The
|
|
161
|
+
# @!attribute [rw] cluster_identifier
|
|
162
|
+
# The cluster identifier. This element is not returned when connecting
|
|
163
|
+
# to a serverless workgroup.
|
|
162
164
|
# @return [String]
|
|
163
165
|
#
|
|
164
|
-
# @!attribute [rw] db_groups
|
|
165
|
-
# A list of colon (:) separated names of database groups.
|
|
166
|
-
# @return [Array<String>]
|
|
167
|
-
#
|
|
168
166
|
# @!attribute [rw] db_user
|
|
169
167
|
# The database user name.
|
|
170
168
|
# @return [String]
|
|
171
169
|
#
|
|
172
|
-
# @!attribute [rw]
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
170
|
+
# @!attribute [rw] db_groups
|
|
171
|
+
# A list of colon (:) separated names of database groups.
|
|
172
|
+
# @return [Array<String>]
|
|
173
|
+
#
|
|
174
|
+
# @!attribute [rw] database
|
|
175
|
+
# The name of the database.
|
|
177
176
|
# @return [String]
|
|
178
177
|
#
|
|
179
178
|
# @!attribute [rw] secret_arn
|
|
180
179
|
# The name or ARN of the secret that enables access to the database.
|
|
181
180
|
# @return [String]
|
|
182
181
|
#
|
|
183
|
-
# @!attribute [rw] session_id
|
|
184
|
-
# The session identifier of the query.
|
|
185
|
-
# @return [String]
|
|
186
|
-
#
|
|
187
182
|
# @!attribute [rw] workgroup_name
|
|
188
183
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
189
184
|
# element is not returned when connecting to a provisioned cluster.
|
|
190
185
|
# @return [String]
|
|
191
186
|
#
|
|
187
|
+
# @!attribute [rw] session_id
|
|
188
|
+
# The session identifier of the query.
|
|
189
|
+
# @return [String]
|
|
190
|
+
#
|
|
192
191
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementOutput AWS API Documentation
|
|
193
192
|
#
|
|
194
193
|
class BatchExecuteStatementOutput < Struct.new(
|
|
195
|
-
:
|
|
194
|
+
:id,
|
|
196
195
|
:created_at,
|
|
197
|
-
:
|
|
198
|
-
:db_groups,
|
|
196
|
+
:cluster_identifier,
|
|
199
197
|
:db_user,
|
|
200
|
-
:
|
|
198
|
+
:db_groups,
|
|
199
|
+
:database,
|
|
201
200
|
:secret_arn,
|
|
202
|
-
:
|
|
203
|
-
:
|
|
201
|
+
:workgroup_name,
|
|
202
|
+
:session_id)
|
|
204
203
|
SENSITIVE = []
|
|
205
204
|
include Aws::Structure
|
|
206
205
|
end
|
|
@@ -235,10 +234,6 @@ module Aws::RedshiftDataAPIService
|
|
|
235
234
|
|
|
236
235
|
# The properties (metadata) of a column.
|
|
237
236
|
#
|
|
238
|
-
# @!attribute [rw] column_default
|
|
239
|
-
# The default value of the column.
|
|
240
|
-
# @return [String]
|
|
241
|
-
#
|
|
242
237
|
# @!attribute [rw] is_case_sensitive
|
|
243
238
|
# A value that indicates whether the column is case-sensitive.
|
|
244
239
|
# @return [Boolean]
|
|
@@ -255,10 +250,6 @@ module Aws::RedshiftDataAPIService
|
|
|
255
250
|
# The label for the column.
|
|
256
251
|
# @return [String]
|
|
257
252
|
#
|
|
258
|
-
# @!attribute [rw] length
|
|
259
|
-
# The length of the column.
|
|
260
|
-
# @return [Integer]
|
|
261
|
-
#
|
|
262
253
|
# @!attribute [rw] name
|
|
263
254
|
# The name of the column.
|
|
264
255
|
# @return [String]
|
|
@@ -288,22 +279,30 @@ module Aws::RedshiftDataAPIService
|
|
|
288
279
|
# The database-specific data type of the column.
|
|
289
280
|
# @return [String]
|
|
290
281
|
#
|
|
282
|
+
# @!attribute [rw] length
|
|
283
|
+
# The length of the column.
|
|
284
|
+
# @return [Integer]
|
|
285
|
+
#
|
|
286
|
+
# @!attribute [rw] column_default
|
|
287
|
+
# The default value of the column.
|
|
288
|
+
# @return [String]
|
|
289
|
+
#
|
|
291
290
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ColumnMetadata AWS API Documentation
|
|
292
291
|
#
|
|
293
292
|
class ColumnMetadata < Struct.new(
|
|
294
|
-
:column_default,
|
|
295
293
|
:is_case_sensitive,
|
|
296
294
|
:is_currency,
|
|
297
295
|
:is_signed,
|
|
298
296
|
:label,
|
|
299
|
-
:length,
|
|
300
297
|
:name,
|
|
301
298
|
:nullable,
|
|
302
299
|
:precision,
|
|
303
300
|
:scale,
|
|
304
301
|
:schema_name,
|
|
305
302
|
:table_name,
|
|
306
|
-
:type_name
|
|
303
|
+
:type_name,
|
|
304
|
+
:length,
|
|
305
|
+
:column_default)
|
|
307
306
|
SENSITIVE = []
|
|
308
307
|
include Aws::Structure
|
|
309
308
|
end
|
|
@@ -339,20 +338,27 @@ module Aws::RedshiftDataAPIService
|
|
|
339
338
|
include Aws::Structure
|
|
340
339
|
end
|
|
341
340
|
|
|
342
|
-
# @!attribute [rw]
|
|
343
|
-
# The
|
|
341
|
+
# @!attribute [rw] id
|
|
342
|
+
# The identifier of the SQL statement described. This value is a
|
|
343
|
+
# universally unique identifier (UUID) generated by Amazon Redshift
|
|
344
|
+
# Data API.
|
|
344
345
|
# @return [String]
|
|
345
346
|
#
|
|
346
|
-
# @!attribute [rw]
|
|
347
|
-
# The
|
|
348
|
-
#
|
|
347
|
+
# @!attribute [rw] secret_arn
|
|
348
|
+
# The name or Amazon Resource Name (ARN) of the secret that enables
|
|
349
|
+
# access to the database.
|
|
350
|
+
# @return [String]
|
|
351
|
+
#
|
|
352
|
+
# @!attribute [rw] db_user
|
|
353
|
+
# The database user name.
|
|
354
|
+
# @return [String]
|
|
349
355
|
#
|
|
350
356
|
# @!attribute [rw] database
|
|
351
357
|
# The name of the database.
|
|
352
358
|
# @return [String]
|
|
353
359
|
#
|
|
354
|
-
# @!attribute [rw]
|
|
355
|
-
# The
|
|
360
|
+
# @!attribute [rw] cluster_identifier
|
|
361
|
+
# The cluster identifier.
|
|
356
362
|
# @return [String]
|
|
357
363
|
#
|
|
358
364
|
# @!attribute [rw] duration
|
|
@@ -364,38 +370,47 @@ module Aws::RedshiftDataAPIService
|
|
|
364
370
|
# an error while running.
|
|
365
371
|
# @return [String]
|
|
366
372
|
#
|
|
367
|
-
# @!attribute [rw]
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
# The value is true if any substatement returns a result set.
|
|
371
|
-
# @return [Boolean]
|
|
373
|
+
# @!attribute [rw] status
|
|
374
|
+
# The status of the SQL statement being described. Status values are
|
|
375
|
+
# defined as follows:
|
|
372
376
|
#
|
|
373
|
-
#
|
|
374
|
-
# The identifier of the SQL statement described. This value is a
|
|
375
|
-
# universally unique identifier (UUID) generated by Amazon Redshift
|
|
376
|
-
# Data API.
|
|
377
|
-
# @return [String]
|
|
377
|
+
# * ABORTED - The query run was stopped by the user.
|
|
378
378
|
#
|
|
379
|
-
#
|
|
380
|
-
#
|
|
381
|
-
# @return [Array<Types::SqlParameter>]
|
|
379
|
+
# * ALL - A status value that includes all query statuses. This value
|
|
380
|
+
# can be used to filter results.
|
|
382
381
|
#
|
|
383
|
-
#
|
|
384
|
-
#
|
|
382
|
+
# * FAILED - The query run failed.
|
|
383
|
+
#
|
|
384
|
+
# * FINISHED - The query has finished running.
|
|
385
|
+
#
|
|
386
|
+
# * PICKED - The query has been chosen to be run.
|
|
387
|
+
#
|
|
388
|
+
# * STARTED - The query run has started.
|
|
389
|
+
#
|
|
390
|
+
# * SUBMITTED - The query was submitted, but not yet processed.
|
|
385
391
|
# @return [String]
|
|
386
392
|
#
|
|
393
|
+
# @!attribute [rw] created_at
|
|
394
|
+
# The date and time (UTC) when the SQL statement was submitted to run.
|
|
395
|
+
# @return [Time]
|
|
396
|
+
#
|
|
397
|
+
# @!attribute [rw] updated_at
|
|
398
|
+
# The date and time (UTC) that the metadata for the SQL statement was
|
|
399
|
+
# last updated. An example is the time the status last changed.
|
|
400
|
+
# @return [Time]
|
|
401
|
+
#
|
|
387
402
|
# @!attribute [rw] redshift_pid
|
|
388
403
|
# The process identifier from Amazon Redshift.
|
|
389
404
|
# @return [Integer]
|
|
390
405
|
#
|
|
391
|
-
# @!attribute [rw]
|
|
392
|
-
#
|
|
393
|
-
#
|
|
394
|
-
#
|
|
395
|
-
# @return [
|
|
406
|
+
# @!attribute [rw] has_result_set
|
|
407
|
+
# A value that indicates whether the statement has a result set. The
|
|
408
|
+
# result set can be empty. The value is true for an empty result set.
|
|
409
|
+
# The value is true if any substatement returns a result set.
|
|
410
|
+
# @return [Boolean]
|
|
396
411
|
#
|
|
397
|
-
# @!attribute [rw]
|
|
398
|
-
# The
|
|
412
|
+
# @!attribute [rw] query_string
|
|
413
|
+
# The SQL statement text.
|
|
399
414
|
# @return [String]
|
|
400
415
|
#
|
|
401
416
|
# @!attribute [rw] result_rows
|
|
@@ -411,72 +426,56 @@ module Aws::RedshiftDataAPIService
|
|
|
411
426
|
# value is null.
|
|
412
427
|
# @return [Integer]
|
|
413
428
|
#
|
|
414
|
-
# @!attribute [rw]
|
|
415
|
-
# The
|
|
416
|
-
#
|
|
417
|
-
#
|
|
418
|
-
#
|
|
419
|
-
# @!attribute [rw] session_id
|
|
420
|
-
# The session identifier of the query.
|
|
421
|
-
# @return [String]
|
|
422
|
-
#
|
|
423
|
-
# @!attribute [rw] status
|
|
424
|
-
# The status of the SQL statement being described. Status values are
|
|
425
|
-
# defined as follows:
|
|
426
|
-
#
|
|
427
|
-
# * ABORTED - The query run was stopped by the user.
|
|
428
|
-
#
|
|
429
|
-
# * ALL - A status value that includes all query statuses. This value
|
|
430
|
-
# can be used to filter results.
|
|
431
|
-
#
|
|
432
|
-
# * FAILED - The query run failed.
|
|
433
|
-
#
|
|
434
|
-
# * FINISHED - The query has finished running.
|
|
435
|
-
#
|
|
436
|
-
# * PICKED - The query has been chosen to be run.
|
|
437
|
-
#
|
|
438
|
-
# * STARTED - The query run has started.
|
|
429
|
+
# @!attribute [rw] redshift_query_id
|
|
430
|
+
# The identifier of the query generated by Amazon Redshift. These
|
|
431
|
+
# identifiers are also available in the `query` column of the
|
|
432
|
+
# `STL_QUERY` system view.
|
|
433
|
+
# @return [Integer]
|
|
439
434
|
#
|
|
440
|
-
#
|
|
441
|
-
#
|
|
435
|
+
# @!attribute [rw] query_parameters
|
|
436
|
+
# The parameters for the SQL statement.
|
|
437
|
+
# @return [Array<Types::SqlParameter>]
|
|
442
438
|
#
|
|
443
439
|
# @!attribute [rw] sub_statements
|
|
444
440
|
# The SQL statements from a multiple statement run.
|
|
445
441
|
# @return [Array<Types::SubStatementData>]
|
|
446
442
|
#
|
|
447
|
-
# @!attribute [rw] updated_at
|
|
448
|
-
# The date and time (UTC) that the metadata for the SQL statement was
|
|
449
|
-
# last updated. An example is the time the status last changed.
|
|
450
|
-
# @return [Time]
|
|
451
|
-
#
|
|
452
443
|
# @!attribute [rw] workgroup_name
|
|
453
444
|
# The serverless workgroup name or Amazon Resource Name (ARN).
|
|
454
445
|
# @return [String]
|
|
455
446
|
#
|
|
447
|
+
# @!attribute [rw] result_format
|
|
448
|
+
# The data format of the result of the SQL statement.
|
|
449
|
+
# @return [String]
|
|
450
|
+
#
|
|
451
|
+
# @!attribute [rw] session_id
|
|
452
|
+
# The session identifier of the query.
|
|
453
|
+
# @return [String]
|
|
454
|
+
#
|
|
456
455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatementResponse AWS API Documentation
|
|
457
456
|
#
|
|
458
457
|
class DescribeStatementResponse < Struct.new(
|
|
459
|
-
:
|
|
460
|
-
:
|
|
461
|
-
:database,
|
|
458
|
+
:id,
|
|
459
|
+
:secret_arn,
|
|
462
460
|
:db_user,
|
|
461
|
+
:database,
|
|
462
|
+
:cluster_identifier,
|
|
463
463
|
:duration,
|
|
464
464
|
:error,
|
|
465
|
+
:status,
|
|
466
|
+
:created_at,
|
|
467
|
+
:updated_at,
|
|
468
|
+
:redshift_pid,
|
|
465
469
|
:has_result_set,
|
|
466
|
-
:id,
|
|
467
|
-
:query_parameters,
|
|
468
470
|
:query_string,
|
|
469
|
-
:redshift_pid,
|
|
470
|
-
:redshift_query_id,
|
|
471
|
-
:result_format,
|
|
472
471
|
:result_rows,
|
|
473
472
|
:result_size,
|
|
474
|
-
:
|
|
475
|
-
:
|
|
476
|
-
:status,
|
|
473
|
+
:redshift_query_id,
|
|
474
|
+
:query_parameters,
|
|
477
475
|
:sub_statements,
|
|
478
|
-
:
|
|
479
|
-
:
|
|
476
|
+
:workgroup_name,
|
|
477
|
+
:result_format,
|
|
478
|
+
:session_id)
|
|
480
479
|
SENSITIVE = []
|
|
481
480
|
include Aws::Structure
|
|
482
481
|
end
|
|
@@ -487,15 +486,10 @@ module Aws::RedshiftDataAPIService
|
|
|
487
486
|
# temporary credentials.
|
|
488
487
|
# @return [String]
|
|
489
488
|
#
|
|
490
|
-
# @!attribute [rw]
|
|
491
|
-
#
|
|
492
|
-
#
|
|
493
|
-
#
|
|
494
|
-
#
|
|
495
|
-
# @!attribute [rw] database
|
|
496
|
-
# The name of the database that contains the tables to be described.
|
|
497
|
-
# If `ConnectedDatabase` is not specified, this is also the database
|
|
498
|
-
# to connect to with your authentication credentials.
|
|
489
|
+
# @!attribute [rw] secret_arn
|
|
490
|
+
# The name or ARN of the secret that enables access to the database.
|
|
491
|
+
# This parameter is required when authenticating using Secrets
|
|
492
|
+
# Manager.
|
|
499
493
|
# @return [String]
|
|
500
494
|
#
|
|
501
495
|
# @!attribute [rw] db_user
|
|
@@ -504,19 +498,15 @@ module Aws::RedshiftDataAPIService
|
|
|
504
498
|
# credentials.
|
|
505
499
|
# @return [String]
|
|
506
500
|
#
|
|
507
|
-
# @!attribute [rw]
|
|
508
|
-
# The
|
|
509
|
-
#
|
|
510
|
-
# to
|
|
511
|
-
# @return [
|
|
501
|
+
# @!attribute [rw] database
|
|
502
|
+
# The name of the database that contains the tables to be described.
|
|
503
|
+
# If `ConnectedDatabase` is not specified, this is also the database
|
|
504
|
+
# to connect to with your authentication credentials.
|
|
505
|
+
# @return [String]
|
|
512
506
|
#
|
|
513
|
-
# @!attribute [rw]
|
|
514
|
-
# A
|
|
515
|
-
#
|
|
516
|
-
# a response, you can retrieve the next set of records by providing
|
|
517
|
-
# this returned NextToken value in the next NextToken parameter and
|
|
518
|
-
# retrying the command. If the NextToken field is empty, all response
|
|
519
|
-
# records have been retrieved for the request.
|
|
507
|
+
# @!attribute [rw] connected_database
|
|
508
|
+
# A database name. The connected database is specified when you
|
|
509
|
+
# connect with your authentication credentials.
|
|
520
510
|
# @return [String]
|
|
521
511
|
#
|
|
522
512
|
# @!attribute [rw] schema
|
|
@@ -524,12 +514,6 @@ module Aws::RedshiftDataAPIService
|
|
|
524
514
|
# matching tables for all schemas are returned.
|
|
525
515
|
# @return [String]
|
|
526
516
|
#
|
|
527
|
-
# @!attribute [rw] secret_arn
|
|
528
|
-
# The name or ARN of the secret that enables access to the database.
|
|
529
|
-
# This parameter is required when authenticating using Secrets
|
|
530
|
-
# Manager.
|
|
531
|
-
# @return [String]
|
|
532
|
-
#
|
|
533
517
|
# @!attribute [rw] table
|
|
534
518
|
# The table name. If no table is specified, then all tables for all
|
|
535
519
|
# matching schemas are returned. If no table and no schema is
|
|
@@ -537,6 +521,21 @@ module Aws::RedshiftDataAPIService
|
|
|
537
521
|
# returned
|
|
538
522
|
# @return [String]
|
|
539
523
|
#
|
|
524
|
+
# @!attribute [rw] next_token
|
|
525
|
+
# A value that indicates the starting point for the next set of
|
|
526
|
+
# response records in a subsequent request. If a value is returned in
|
|
527
|
+
# a response, you can retrieve the next set of records by providing
|
|
528
|
+
# this returned NextToken value in the next NextToken parameter and
|
|
529
|
+
# retrying the command. If the NextToken field is empty, all response
|
|
530
|
+
# records have been retrieved for the request.
|
|
531
|
+
# @return [String]
|
|
532
|
+
#
|
|
533
|
+
# @!attribute [rw] max_results
|
|
534
|
+
# The maximum number of tables to return in the response. If more
|
|
535
|
+
# tables exist than fit in one response, then `NextToken` is returned
|
|
536
|
+
# to page through the results.
|
|
537
|
+
# @return [Integer]
|
|
538
|
+
#
|
|
540
539
|
# @!attribute [rw] workgroup_name
|
|
541
540
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
542
541
|
# parameter is required when connecting to a serverless workgroup and
|
|
@@ -548,19 +547,23 @@ module Aws::RedshiftDataAPIService
|
|
|
548
547
|
#
|
|
549
548
|
class DescribeTableRequest < Struct.new(
|
|
550
549
|
:cluster_identifier,
|
|
551
|
-
:
|
|
552
|
-
:database,
|
|
550
|
+
:secret_arn,
|
|
553
551
|
:db_user,
|
|
554
|
-
:
|
|
555
|
-
:
|
|
552
|
+
:database,
|
|
553
|
+
:connected_database,
|
|
556
554
|
:schema,
|
|
557
|
-
:secret_arn,
|
|
558
555
|
:table,
|
|
556
|
+
:next_token,
|
|
557
|
+
:max_results,
|
|
559
558
|
:workgroup_name)
|
|
560
559
|
SENSITIVE = []
|
|
561
560
|
include Aws::Structure
|
|
562
561
|
end
|
|
563
562
|
|
|
563
|
+
# @!attribute [rw] table_name
|
|
564
|
+
# The table name.
|
|
565
|
+
# @return [String]
|
|
566
|
+
#
|
|
564
567
|
# @!attribute [rw] column_list
|
|
565
568
|
# A list of columns in the table.
|
|
566
569
|
# @return [Array<Types::ColumnMetadata>]
|
|
@@ -574,16 +577,12 @@ module Aws::RedshiftDataAPIService
|
|
|
574
577
|
# records have been retrieved for the request.
|
|
575
578
|
# @return [String]
|
|
576
579
|
#
|
|
577
|
-
# @!attribute [rw] table_name
|
|
578
|
-
# The table name.
|
|
579
|
-
# @return [String]
|
|
580
|
-
#
|
|
581
580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTableResponse AWS API Documentation
|
|
582
581
|
#
|
|
583
582
|
class DescribeTableResponse < Struct.new(
|
|
583
|
+
:table_name,
|
|
584
584
|
:column_list,
|
|
585
|
-
:next_token
|
|
586
|
-
:table_name)
|
|
585
|
+
:next_token)
|
|
587
586
|
SENSITIVE = []
|
|
588
587
|
include Aws::Structure
|
|
589
588
|
end
|
|
@@ -607,12 +606,8 @@ module Aws::RedshiftDataAPIService
|
|
|
607
606
|
include Aws::Structure
|
|
608
607
|
end
|
|
609
608
|
|
|
610
|
-
# @!attribute [rw]
|
|
611
|
-
#
|
|
612
|
-
# idempotency of the request.
|
|
613
|
-
#
|
|
614
|
-
# **A suitable default value is auto-generated.** You should normally
|
|
615
|
-
# not need to pass this option.
|
|
609
|
+
# @!attribute [rw] sql
|
|
610
|
+
# The SQL statement text to run.
|
|
616
611
|
# @return [String]
|
|
617
612
|
#
|
|
618
613
|
# @!attribute [rw] cluster_identifier
|
|
@@ -621,10 +616,10 @@ module Aws::RedshiftDataAPIService
|
|
|
621
616
|
# temporary credentials.
|
|
622
617
|
# @return [String]
|
|
623
618
|
#
|
|
624
|
-
# @!attribute [rw]
|
|
625
|
-
# The name of the
|
|
626
|
-
#
|
|
627
|
-
#
|
|
619
|
+
# @!attribute [rw] secret_arn
|
|
620
|
+
# The name or ARN of the secret that enables access to the database.
|
|
621
|
+
# This parameter is required when authenticating using Secrets
|
|
622
|
+
# Manager.
|
|
628
623
|
# @return [String]
|
|
629
624
|
#
|
|
630
625
|
# @!attribute [rw] db_user
|
|
@@ -633,23 +628,44 @@ module Aws::RedshiftDataAPIService
|
|
|
633
628
|
# credentials.
|
|
634
629
|
# @return [String]
|
|
635
630
|
#
|
|
631
|
+
# @!attribute [rw] database
|
|
632
|
+
# The name of the database. This parameter is required when
|
|
633
|
+
# authenticating using either Secrets Manager or temporary
|
|
634
|
+
# credentials.
|
|
635
|
+
# @return [String]
|
|
636
|
+
#
|
|
637
|
+
# @!attribute [rw] with_event
|
|
638
|
+
# A value that indicates whether to send an event to the Amazon
|
|
639
|
+
# EventBridge event bus after the SQL statement runs.
|
|
640
|
+
# @return [Boolean]
|
|
641
|
+
#
|
|
642
|
+
# @!attribute [rw] statement_name
|
|
643
|
+
# The name of the SQL statement. You can name the SQL statement when
|
|
644
|
+
# you create it to identify the query.
|
|
645
|
+
# @return [String]
|
|
646
|
+
#
|
|
636
647
|
# @!attribute [rw] parameters
|
|
637
648
|
# The parameters for the SQL statement.
|
|
638
649
|
# @return [Array<Types::SqlParameter>]
|
|
639
650
|
#
|
|
640
|
-
# @!attribute [rw]
|
|
641
|
-
# The
|
|
642
|
-
#
|
|
651
|
+
# @!attribute [rw] workgroup_name
|
|
652
|
+
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
653
|
+
# parameter is required when connecting to a serverless workgroup and
|
|
654
|
+
# authenticating using either Secrets Manager or temporary
|
|
655
|
+
# credentials.
|
|
643
656
|
# @return [String]
|
|
644
657
|
#
|
|
645
|
-
# @!attribute [rw]
|
|
646
|
-
#
|
|
647
|
-
#
|
|
648
|
-
#
|
|
658
|
+
# @!attribute [rw] client_token
|
|
659
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
660
|
+
# idempotency of the request.
|
|
661
|
+
#
|
|
662
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
663
|
+
# not need to pass this option.
|
|
649
664
|
# @return [String]
|
|
650
665
|
#
|
|
651
|
-
# @!attribute [rw]
|
|
652
|
-
# The
|
|
666
|
+
# @!attribute [rw] result_format
|
|
667
|
+
# The data format of the result of the SQL statement. If no format is
|
|
668
|
+
# specified, the default is JSON.
|
|
653
669
|
# @return [String]
|
|
654
670
|
#
|
|
655
671
|
# @!attribute [rw] session_keep_alive_seconds
|
|
@@ -659,99 +675,82 @@ module Aws::RedshiftDataAPIService
|
|
|
659
675
|
# terminated.
|
|
660
676
|
# @return [Integer]
|
|
661
677
|
#
|
|
662
|
-
# @!attribute [rw]
|
|
663
|
-
# The
|
|
664
|
-
# @return [String]
|
|
665
|
-
#
|
|
666
|
-
# @!attribute [rw] statement_name
|
|
667
|
-
# The name of the SQL statement. You can name the SQL statement when
|
|
668
|
-
# you create it to identify the query.
|
|
669
|
-
# @return [String]
|
|
670
|
-
#
|
|
671
|
-
# @!attribute [rw] with_event
|
|
672
|
-
# A value that indicates whether to send an event to the Amazon
|
|
673
|
-
# EventBridge event bus after the SQL statement runs.
|
|
674
|
-
# @return [Boolean]
|
|
675
|
-
#
|
|
676
|
-
# @!attribute [rw] workgroup_name
|
|
677
|
-
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
678
|
-
# parameter is required when connecting to a serverless workgroup and
|
|
679
|
-
# authenticating using either Secrets Manager or temporary
|
|
680
|
-
# credentials.
|
|
678
|
+
# @!attribute [rw] session_id
|
|
679
|
+
# The session identifier of the query.
|
|
681
680
|
# @return [String]
|
|
682
681
|
#
|
|
683
682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementInput AWS API Documentation
|
|
684
683
|
#
|
|
685
684
|
class ExecuteStatementInput < Struct.new(
|
|
686
|
-
:
|
|
685
|
+
:sql,
|
|
687
686
|
:cluster_identifier,
|
|
688
|
-
:
|
|
687
|
+
:secret_arn,
|
|
689
688
|
:db_user,
|
|
689
|
+
:database,
|
|
690
|
+
:with_event,
|
|
691
|
+
:statement_name,
|
|
690
692
|
:parameters,
|
|
693
|
+
:workgroup_name,
|
|
694
|
+
:client_token,
|
|
691
695
|
:result_format,
|
|
692
|
-
:secret_arn,
|
|
693
|
-
:session_id,
|
|
694
696
|
:session_keep_alive_seconds,
|
|
695
|
-
:
|
|
696
|
-
:statement_name,
|
|
697
|
-
:with_event,
|
|
698
|
-
:workgroup_name)
|
|
697
|
+
:session_id)
|
|
699
698
|
SENSITIVE = []
|
|
700
699
|
include Aws::Structure
|
|
701
700
|
end
|
|
702
701
|
|
|
703
|
-
# @!attribute [rw]
|
|
704
|
-
# The
|
|
705
|
-
#
|
|
702
|
+
# @!attribute [rw] id
|
|
703
|
+
# The identifier of the SQL statement whose results are to be fetched.
|
|
704
|
+
# This value is a universally unique identifier (UUID) generated by
|
|
705
|
+
# Amazon Redshift Data API.
|
|
706
706
|
# @return [String]
|
|
707
707
|
#
|
|
708
708
|
# @!attribute [rw] created_at
|
|
709
709
|
# The date and time (UTC) the statement was created.
|
|
710
710
|
# @return [Time]
|
|
711
711
|
#
|
|
712
|
-
# @!attribute [rw]
|
|
713
|
-
# The
|
|
712
|
+
# @!attribute [rw] cluster_identifier
|
|
713
|
+
# The cluster identifier. This element is not returned when connecting
|
|
714
|
+
# to a serverless workgroup.
|
|
714
715
|
# @return [String]
|
|
715
716
|
#
|
|
716
|
-
# @!attribute [rw] db_groups
|
|
717
|
-
# A list of colon (:) separated names of database groups.
|
|
718
|
-
# @return [Array<String>]
|
|
719
|
-
#
|
|
720
717
|
# @!attribute [rw] db_user
|
|
721
718
|
# The database user name.
|
|
722
719
|
# @return [String]
|
|
723
720
|
#
|
|
724
|
-
# @!attribute [rw]
|
|
725
|
-
#
|
|
726
|
-
#
|
|
727
|
-
#
|
|
721
|
+
# @!attribute [rw] db_groups
|
|
722
|
+
# A list of colon (:) separated names of database groups.
|
|
723
|
+
# @return [Array<String>]
|
|
724
|
+
#
|
|
725
|
+
# @!attribute [rw] database
|
|
726
|
+
# The name of the database.
|
|
728
727
|
# @return [String]
|
|
729
728
|
#
|
|
730
729
|
# @!attribute [rw] secret_arn
|
|
731
730
|
# The name or ARN of the secret that enables access to the database.
|
|
732
731
|
# @return [String]
|
|
733
732
|
#
|
|
734
|
-
# @!attribute [rw] session_id
|
|
735
|
-
# The session identifier of the query.
|
|
736
|
-
# @return [String]
|
|
737
|
-
#
|
|
738
733
|
# @!attribute [rw] workgroup_name
|
|
739
734
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
740
735
|
# element is not returned when connecting to a provisioned cluster.
|
|
741
736
|
# @return [String]
|
|
742
737
|
#
|
|
738
|
+
# @!attribute [rw] session_id
|
|
739
|
+
# The session identifier of the query.
|
|
740
|
+
# @return [String]
|
|
741
|
+
#
|
|
743
742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementOutput AWS API Documentation
|
|
744
743
|
#
|
|
745
744
|
class ExecuteStatementOutput < Struct.new(
|
|
746
|
-
:
|
|
745
|
+
:id,
|
|
747
746
|
:created_at,
|
|
748
|
-
:
|
|
749
|
-
:db_groups,
|
|
747
|
+
:cluster_identifier,
|
|
750
748
|
:db_user,
|
|
751
|
-
:
|
|
749
|
+
:db_groups,
|
|
750
|
+
:database,
|
|
752
751
|
:secret_arn,
|
|
753
|
-
:
|
|
754
|
-
:
|
|
752
|
+
:workgroup_name,
|
|
753
|
+
:session_id)
|
|
755
754
|
SENSITIVE = []
|
|
756
755
|
include Aws::Structure
|
|
757
756
|
end
|
|
@@ -760,50 +759,50 @@ module Aws::RedshiftDataAPIService
|
|
|
760
759
|
#
|
|
761
760
|
# @note Field is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Field corresponding to the set member.
|
|
762
761
|
#
|
|
763
|
-
# @!attribute [rw]
|
|
764
|
-
# A value
|
|
765
|
-
# @return [
|
|
762
|
+
# @!attribute [rw] is_null
|
|
763
|
+
# A value that indicates whether the data is NULL.
|
|
764
|
+
# @return [Boolean]
|
|
766
765
|
#
|
|
767
766
|
# @!attribute [rw] boolean_value
|
|
768
767
|
# A value of the Boolean data type.
|
|
769
768
|
# @return [Boolean]
|
|
770
769
|
#
|
|
771
|
-
# @!attribute [rw] double_value
|
|
772
|
-
# A value of the double data type.
|
|
773
|
-
# @return [Float]
|
|
774
|
-
#
|
|
775
|
-
# @!attribute [rw] is_null
|
|
776
|
-
# A value that indicates whether the data is NULL.
|
|
777
|
-
# @return [Boolean]
|
|
778
|
-
#
|
|
779
770
|
# @!attribute [rw] long_value
|
|
780
771
|
# A value of the long data type.
|
|
781
772
|
# @return [Integer]
|
|
782
773
|
#
|
|
774
|
+
# @!attribute [rw] double_value
|
|
775
|
+
# A value of the double data type.
|
|
776
|
+
# @return [Float]
|
|
777
|
+
#
|
|
783
778
|
# @!attribute [rw] string_value
|
|
784
779
|
# A value of the string data type.
|
|
785
780
|
# @return [String]
|
|
786
781
|
#
|
|
782
|
+
# @!attribute [rw] blob_value
|
|
783
|
+
# A value of the BLOB data type.
|
|
784
|
+
# @return [String]
|
|
785
|
+
#
|
|
787
786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/Field AWS API Documentation
|
|
788
787
|
#
|
|
789
788
|
class Field < Struct.new(
|
|
790
|
-
:blob_value,
|
|
791
|
-
:boolean_value,
|
|
792
|
-
:double_value,
|
|
793
789
|
:is_null,
|
|
790
|
+
:boolean_value,
|
|
794
791
|
:long_value,
|
|
792
|
+
:double_value,
|
|
795
793
|
:string_value,
|
|
794
|
+
:blob_value,
|
|
796
795
|
:unknown)
|
|
797
796
|
SENSITIVE = []
|
|
798
797
|
include Aws::Structure
|
|
799
798
|
include Aws::Structure::Union
|
|
800
799
|
|
|
801
|
-
class BlobValue < Field; end
|
|
802
|
-
class BooleanValue < Field; end
|
|
803
|
-
class DoubleValue < Field; end
|
|
804
800
|
class IsNull < Field; end
|
|
801
|
+
class BooleanValue < Field; end
|
|
805
802
|
class LongValue < Field; end
|
|
803
|
+
class DoubleValue < Field; end
|
|
806
804
|
class StringValue < Field; end
|
|
805
|
+
class BlobValue < Field; end
|
|
807
806
|
class Unknown < Field; end
|
|
808
807
|
end
|
|
809
808
|
|
|
@@ -835,10 +834,20 @@ module Aws::RedshiftDataAPIService
|
|
|
835
834
|
include Aws::Structure
|
|
836
835
|
end
|
|
837
836
|
|
|
837
|
+
# @!attribute [rw] records
|
|
838
|
+
# The results of the SQL statement in JSON format.
|
|
839
|
+
# @return [Array<Array<Types::Field>>]
|
|
840
|
+
#
|
|
838
841
|
# @!attribute [rw] column_metadata
|
|
839
842
|
# The properties (metadata) of a column.
|
|
840
843
|
# @return [Array<Types::ColumnMetadata>]
|
|
841
844
|
#
|
|
845
|
+
# @!attribute [rw] total_num_rows
|
|
846
|
+
# The total number of rows in the result set returned from a query.
|
|
847
|
+
# You can use this number to estimate the number of calls to the
|
|
848
|
+
# `GetStatementResult` operation needed to page through the results.
|
|
849
|
+
# @return [Integer]
|
|
850
|
+
#
|
|
842
851
|
# @!attribute [rw] next_token
|
|
843
852
|
# A value that indicates the starting point for the next set of
|
|
844
853
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -848,23 +857,13 @@ module Aws::RedshiftDataAPIService
|
|
|
848
857
|
# records have been retrieved for the request.
|
|
849
858
|
# @return [String]
|
|
850
859
|
#
|
|
851
|
-
# @!attribute [rw] records
|
|
852
|
-
# The results of the SQL statement in JSON format.
|
|
853
|
-
# @return [Array<Array<Types::Field>>]
|
|
854
|
-
#
|
|
855
|
-
# @!attribute [rw] total_num_rows
|
|
856
|
-
# The total number of rows in the result set returned from a query.
|
|
857
|
-
# You can use this number to estimate the number of calls to the
|
|
858
|
-
# `GetStatementResult` operation needed to page through the results.
|
|
859
|
-
# @return [Integer]
|
|
860
|
-
#
|
|
861
860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultResponse AWS API Documentation
|
|
862
861
|
#
|
|
863
862
|
class GetStatementResultResponse < Struct.new(
|
|
864
|
-
:column_metadata,
|
|
865
|
-
:next_token,
|
|
866
863
|
:records,
|
|
867
|
-
:
|
|
864
|
+
:column_metadata,
|
|
865
|
+
:total_num_rows,
|
|
866
|
+
:next_token)
|
|
868
867
|
SENSITIVE = []
|
|
869
868
|
include Aws::Structure
|
|
870
869
|
end
|
|
@@ -897,10 +896,24 @@ module Aws::RedshiftDataAPIService
|
|
|
897
896
|
include Aws::Structure
|
|
898
897
|
end
|
|
899
898
|
|
|
899
|
+
# @!attribute [rw] records
|
|
900
|
+
# The results of the SQL statement in CSV format.
|
|
901
|
+
# @return [Array<Types::QueryRecords>]
|
|
902
|
+
#
|
|
900
903
|
# @!attribute [rw] column_metadata
|
|
901
904
|
# The properties (metadata) of a column.
|
|
902
905
|
# @return [Array<Types::ColumnMetadata>]
|
|
903
906
|
#
|
|
907
|
+
# @!attribute [rw] total_num_rows
|
|
908
|
+
# The total number of rows in the result set returned from a query.
|
|
909
|
+
# You can use this number to estimate the number of calls to the
|
|
910
|
+
# `GetStatementResultV2` operation needed to page through the results.
|
|
911
|
+
# @return [Integer]
|
|
912
|
+
#
|
|
913
|
+
# @!attribute [rw] result_format
|
|
914
|
+
# The data format of the result of the SQL statement.
|
|
915
|
+
# @return [String]
|
|
916
|
+
#
|
|
904
917
|
# @!attribute [rw] next_token
|
|
905
918
|
# A value that indicates the starting point for the next set of
|
|
906
919
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -910,28 +923,14 @@ module Aws::RedshiftDataAPIService
|
|
|
910
923
|
# records have been retrieved for the request.
|
|
911
924
|
# @return [String]
|
|
912
925
|
#
|
|
913
|
-
# @!attribute [rw] records
|
|
914
|
-
# The results of the SQL statement in CSV format.
|
|
915
|
-
# @return [Array<Types::QueryRecords>]
|
|
916
|
-
#
|
|
917
|
-
# @!attribute [rw] result_format
|
|
918
|
-
# The data format of the result of the SQL statement.
|
|
919
|
-
# @return [String]
|
|
920
|
-
#
|
|
921
|
-
# @!attribute [rw] total_num_rows
|
|
922
|
-
# The total number of rows in the result set returned from a query.
|
|
923
|
-
# You can use this number to estimate the number of calls to the
|
|
924
|
-
# `GetStatementResultV2` operation needed to page through the results.
|
|
925
|
-
# @return [Integer]
|
|
926
|
-
#
|
|
927
926
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2Response AWS API Documentation
|
|
928
927
|
#
|
|
929
928
|
class GetStatementResultV2Response < Struct.new(
|
|
930
|
-
:column_metadata,
|
|
931
|
-
:next_token,
|
|
932
929
|
:records,
|
|
930
|
+
:column_metadata,
|
|
931
|
+
:total_num_rows,
|
|
933
932
|
:result_format,
|
|
934
|
-
:
|
|
933
|
+
:next_token)
|
|
935
934
|
SENSITIVE = []
|
|
936
935
|
include Aws::Structure
|
|
937
936
|
end
|
|
@@ -962,18 +961,18 @@ module Aws::RedshiftDataAPIService
|
|
|
962
961
|
# credentials.
|
|
963
962
|
# @return [String]
|
|
964
963
|
#
|
|
964
|
+
# @!attribute [rw] secret_arn
|
|
965
|
+
# The name or ARN of the secret that enables access to the database.
|
|
966
|
+
# This parameter is required when authenticating using Secrets
|
|
967
|
+
# Manager.
|
|
968
|
+
# @return [String]
|
|
969
|
+
#
|
|
965
970
|
# @!attribute [rw] db_user
|
|
966
971
|
# The database user name. This parameter is required when connecting
|
|
967
972
|
# to a cluster as a database user and authenticating using temporary
|
|
968
973
|
# credentials.
|
|
969
974
|
# @return [String]
|
|
970
975
|
#
|
|
971
|
-
# @!attribute [rw] max_results
|
|
972
|
-
# The maximum number of databases to return in the response. If more
|
|
973
|
-
# databases exist than fit in one response, then `NextToken` is
|
|
974
|
-
# returned to page through the results.
|
|
975
|
-
# @return [Integer]
|
|
976
|
-
#
|
|
977
976
|
# @!attribute [rw] next_token
|
|
978
977
|
# A value that indicates the starting point for the next set of
|
|
979
978
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -983,11 +982,11 @@ module Aws::RedshiftDataAPIService
|
|
|
983
982
|
# records have been retrieved for the request.
|
|
984
983
|
# @return [String]
|
|
985
984
|
#
|
|
986
|
-
# @!attribute [rw]
|
|
987
|
-
# The
|
|
988
|
-
#
|
|
989
|
-
#
|
|
990
|
-
# @return [
|
|
985
|
+
# @!attribute [rw] max_results
|
|
986
|
+
# The maximum number of databases to return in the response. If more
|
|
987
|
+
# databases exist than fit in one response, then `NextToken` is
|
|
988
|
+
# returned to page through the results.
|
|
989
|
+
# @return [Integer]
|
|
991
990
|
#
|
|
992
991
|
# @!attribute [rw] workgroup_name
|
|
993
992
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
@@ -1001,10 +1000,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1001
1000
|
class ListDatabasesRequest < Struct.new(
|
|
1002
1001
|
:cluster_identifier,
|
|
1003
1002
|
:database,
|
|
1003
|
+
:secret_arn,
|
|
1004
1004
|
:db_user,
|
|
1005
|
-
:max_results,
|
|
1006
1005
|
:next_token,
|
|
1007
|
-
:
|
|
1006
|
+
:max_results,
|
|
1008
1007
|
:workgroup_name)
|
|
1009
1008
|
SENSITIVE = []
|
|
1010
1009
|
include Aws::Structure
|
|
@@ -1038,9 +1037,16 @@ module Aws::RedshiftDataAPIService
|
|
|
1038
1037
|
# temporary credentials.
|
|
1039
1038
|
# @return [String]
|
|
1040
1039
|
#
|
|
1041
|
-
# @!attribute [rw]
|
|
1042
|
-
#
|
|
1043
|
-
#
|
|
1040
|
+
# @!attribute [rw] secret_arn
|
|
1041
|
+
# The name or ARN of the secret that enables access to the database.
|
|
1042
|
+
# This parameter is required when authenticating using Secrets
|
|
1043
|
+
# Manager.
|
|
1044
|
+
# @return [String]
|
|
1045
|
+
#
|
|
1046
|
+
# @!attribute [rw] db_user
|
|
1047
|
+
# The database user name. This parameter is required when connecting
|
|
1048
|
+
# to a cluster as a database user and authenticating using temporary
|
|
1049
|
+
# credentials.
|
|
1044
1050
|
# @return [String]
|
|
1045
1051
|
#
|
|
1046
1052
|
# @!attribute [rw] database
|
|
@@ -1049,17 +1055,17 @@ module Aws::RedshiftDataAPIService
|
|
|
1049
1055
|
# connect to with your authentication credentials.
|
|
1050
1056
|
# @return [String]
|
|
1051
1057
|
#
|
|
1052
|
-
# @!attribute [rw]
|
|
1053
|
-
#
|
|
1054
|
-
#
|
|
1055
|
-
# credentials.
|
|
1058
|
+
# @!attribute [rw] connected_database
|
|
1059
|
+
# A database name. The connected database is specified when you
|
|
1060
|
+
# connect with your authentication credentials.
|
|
1056
1061
|
# @return [String]
|
|
1057
1062
|
#
|
|
1058
|
-
# @!attribute [rw]
|
|
1059
|
-
#
|
|
1060
|
-
#
|
|
1061
|
-
#
|
|
1062
|
-
#
|
|
1063
|
+
# @!attribute [rw] schema_pattern
|
|
1064
|
+
# A pattern to filter results by schema name. Within a schema pattern,
|
|
1065
|
+
# "%" means match any substring of 0 or more characters and "\_"
|
|
1066
|
+
# means match any one character. Only schema name entries matching the
|
|
1067
|
+
# search pattern are returned.
|
|
1068
|
+
# @return [String]
|
|
1063
1069
|
#
|
|
1064
1070
|
# @!attribute [rw] next_token
|
|
1065
1071
|
# A value that indicates the starting point for the next set of
|
|
@@ -1070,18 +1076,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1070
1076
|
# records have been retrieved for the request.
|
|
1071
1077
|
# @return [String]
|
|
1072
1078
|
#
|
|
1073
|
-
# @!attribute [rw]
|
|
1074
|
-
#
|
|
1075
|
-
#
|
|
1076
|
-
#
|
|
1077
|
-
#
|
|
1078
|
-
# @return [String]
|
|
1079
|
-
#
|
|
1080
|
-
# @!attribute [rw] secret_arn
|
|
1081
|
-
# The name or ARN of the secret that enables access to the database.
|
|
1082
|
-
# This parameter is required when authenticating using Secrets
|
|
1083
|
-
# Manager.
|
|
1084
|
-
# @return [String]
|
|
1079
|
+
# @!attribute [rw] max_results
|
|
1080
|
+
# The maximum number of schemas to return in the response. If more
|
|
1081
|
+
# schemas exist than fit in one response, then `NextToken` is returned
|
|
1082
|
+
# to page through the results.
|
|
1083
|
+
# @return [Integer]
|
|
1085
1084
|
#
|
|
1086
1085
|
# @!attribute [rw] workgroup_name
|
|
1087
1086
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
@@ -1094,18 +1093,22 @@ module Aws::RedshiftDataAPIService
|
|
|
1094
1093
|
#
|
|
1095
1094
|
class ListSchemasRequest < Struct.new(
|
|
1096
1095
|
:cluster_identifier,
|
|
1097
|
-
:
|
|
1098
|
-
:database,
|
|
1096
|
+
:secret_arn,
|
|
1099
1097
|
:db_user,
|
|
1100
|
-
:
|
|
1101
|
-
:
|
|
1098
|
+
:database,
|
|
1099
|
+
:connected_database,
|
|
1102
1100
|
:schema_pattern,
|
|
1103
|
-
:
|
|
1101
|
+
:next_token,
|
|
1102
|
+
:max_results,
|
|
1104
1103
|
:workgroup_name)
|
|
1105
1104
|
SENSITIVE = []
|
|
1106
1105
|
include Aws::Structure
|
|
1107
1106
|
end
|
|
1108
1107
|
|
|
1108
|
+
# @!attribute [rw] schemas
|
|
1109
|
+
# The schemas that match the request pattern.
|
|
1110
|
+
# @return [Array<String>]
|
|
1111
|
+
#
|
|
1109
1112
|
# @!attribute [rw] next_token
|
|
1110
1113
|
# A value that indicates the starting point for the next set of
|
|
1111
1114
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -1115,36 +1118,15 @@ module Aws::RedshiftDataAPIService
|
|
|
1115
1118
|
# records have been retrieved for the request.
|
|
1116
1119
|
# @return [String]
|
|
1117
1120
|
#
|
|
1118
|
-
# @!attribute [rw] schemas
|
|
1119
|
-
# The schemas that match the request pattern.
|
|
1120
|
-
# @return [Array<String>]
|
|
1121
|
-
#
|
|
1122
1121
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemasResponse AWS API Documentation
|
|
1123
1122
|
#
|
|
1124
1123
|
class ListSchemasResponse < Struct.new(
|
|
1125
|
-
:
|
|
1126
|
-
:
|
|
1127
|
-
SENSITIVE = []
|
|
1128
|
-
include Aws::Structure
|
|
1129
|
-
end
|
|
1130
|
-
|
|
1131
|
-
# @!attribute [rw] cluster_identifier
|
|
1132
|
-
# The cluster identifier. Only statements that ran on this cluster are
|
|
1133
|
-
# returned. When providing `ClusterIdentifier`, then `WorkgroupName`
|
|
1134
|
-
# can't be specified.
|
|
1135
|
-
# @return [String]
|
|
1136
|
-
#
|
|
1137
|
-
# @!attribute [rw] database
|
|
1138
|
-
# The name of the database when listing statements run against a
|
|
1139
|
-
# `ClusterIdentifier` or `WorkgroupName`.
|
|
1140
|
-
# @return [String]
|
|
1141
|
-
#
|
|
1142
|
-
# @!attribute [rw] max_results
|
|
1143
|
-
# The maximum number of SQL statements to return in the response. If
|
|
1144
|
-
# more SQL statements exist than fit in one response, then `NextToken`
|
|
1145
|
-
# is returned to page through the results.
|
|
1146
|
-
# @return [Integer]
|
|
1147
|
-
#
|
|
1124
|
+
:schemas,
|
|
1125
|
+
:next_token)
|
|
1126
|
+
SENSITIVE = []
|
|
1127
|
+
include Aws::Structure
|
|
1128
|
+
end
|
|
1129
|
+
|
|
1148
1130
|
# @!attribute [rw] next_token
|
|
1149
1131
|
# A value that indicates the starting point for the next set of
|
|
1150
1132
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -1154,12 +1136,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1154
1136
|
# records have been retrieved for the request.
|
|
1155
1137
|
# @return [String]
|
|
1156
1138
|
#
|
|
1157
|
-
# @!attribute [rw]
|
|
1158
|
-
#
|
|
1159
|
-
#
|
|
1160
|
-
#
|
|
1161
|
-
#
|
|
1162
|
-
# @return [Boolean]
|
|
1139
|
+
# @!attribute [rw] max_results
|
|
1140
|
+
# The maximum number of SQL statements to return in the response. If
|
|
1141
|
+
# more SQL statements exist than fit in one response, then `NextToken`
|
|
1142
|
+
# is returned to page through the results.
|
|
1143
|
+
# @return [Integer]
|
|
1163
1144
|
#
|
|
1164
1145
|
# @!attribute [rw] statement_name
|
|
1165
1146
|
# The name of the SQL statement specified as input to
|
|
@@ -1191,6 +1172,24 @@ module Aws::RedshiftDataAPIService
|
|
|
1191
1172
|
# * SUBMITTED - The query was submitted, but not yet processed.
|
|
1192
1173
|
# @return [String]
|
|
1193
1174
|
#
|
|
1175
|
+
# @!attribute [rw] role_level
|
|
1176
|
+
# A value that filters which statements to return in the response. If
|
|
1177
|
+
# true, all statements run by the caller's IAM role are returned. If
|
|
1178
|
+
# false, only statements run by the caller's IAM role in the current
|
|
1179
|
+
# IAM session are returned. The default is true.
|
|
1180
|
+
# @return [Boolean]
|
|
1181
|
+
#
|
|
1182
|
+
# @!attribute [rw] database
|
|
1183
|
+
# The name of the database when listing statements run against a
|
|
1184
|
+
# `ClusterIdentifier` or `WorkgroupName`.
|
|
1185
|
+
# @return [String]
|
|
1186
|
+
#
|
|
1187
|
+
# @!attribute [rw] cluster_identifier
|
|
1188
|
+
# The cluster identifier. Only statements that ran on this cluster are
|
|
1189
|
+
# returned. When providing `ClusterIdentifier`, then `WorkgroupName`
|
|
1190
|
+
# can't be specified.
|
|
1191
|
+
# @return [String]
|
|
1192
|
+
#
|
|
1194
1193
|
# @!attribute [rw] workgroup_name
|
|
1195
1194
|
# The serverless workgroup name or Amazon Resource Name (ARN). Only
|
|
1196
1195
|
# statements that ran on this workgroup are returned. When providing
|
|
@@ -1200,18 +1199,22 @@ module Aws::RedshiftDataAPIService
|
|
|
1200
1199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatementsRequest AWS API Documentation
|
|
1201
1200
|
#
|
|
1202
1201
|
class ListStatementsRequest < Struct.new(
|
|
1203
|
-
:cluster_identifier,
|
|
1204
|
-
:database,
|
|
1205
|
-
:max_results,
|
|
1206
1202
|
:next_token,
|
|
1207
|
-
:
|
|
1203
|
+
:max_results,
|
|
1208
1204
|
:statement_name,
|
|
1209
1205
|
:status,
|
|
1206
|
+
:role_level,
|
|
1207
|
+
:database,
|
|
1208
|
+
:cluster_identifier,
|
|
1210
1209
|
:workgroup_name)
|
|
1211
1210
|
SENSITIVE = []
|
|
1212
1211
|
include Aws::Structure
|
|
1213
1212
|
end
|
|
1214
1213
|
|
|
1214
|
+
# @!attribute [rw] statements
|
|
1215
|
+
# The SQL statements.
|
|
1216
|
+
# @return [Array<Types::StatementData>]
|
|
1217
|
+
#
|
|
1215
1218
|
# @!attribute [rw] next_token
|
|
1216
1219
|
# A value that indicates the starting point for the next set of
|
|
1217
1220
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -1221,15 +1224,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1221
1224
|
# records have been retrieved for the request.
|
|
1222
1225
|
# @return [String]
|
|
1223
1226
|
#
|
|
1224
|
-
# @!attribute [rw] statements
|
|
1225
|
-
# The SQL statements.
|
|
1226
|
-
# @return [Array<Types::StatementData>]
|
|
1227
|
-
#
|
|
1228
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatementsResponse AWS API Documentation
|
|
1229
1228
|
#
|
|
1230
1229
|
class ListStatementsResponse < Struct.new(
|
|
1231
|
-
:
|
|
1232
|
-
:
|
|
1230
|
+
:statements,
|
|
1231
|
+
:next_token)
|
|
1233
1232
|
SENSITIVE = []
|
|
1234
1233
|
include Aws::Structure
|
|
1235
1234
|
end
|
|
@@ -1240,15 +1239,10 @@ module Aws::RedshiftDataAPIService
|
|
|
1240
1239
|
# temporary credentials.
|
|
1241
1240
|
# @return [String]
|
|
1242
1241
|
#
|
|
1243
|
-
# @!attribute [rw]
|
|
1244
|
-
#
|
|
1245
|
-
#
|
|
1246
|
-
#
|
|
1247
|
-
#
|
|
1248
|
-
# @!attribute [rw] database
|
|
1249
|
-
# The name of the database that contains the tables to list. If
|
|
1250
|
-
# `ConnectedDatabase` is not specified, this is also the database to
|
|
1251
|
-
# connect to with your authentication credentials.
|
|
1242
|
+
# @!attribute [rw] secret_arn
|
|
1243
|
+
# The name or ARN of the secret that enables access to the database.
|
|
1244
|
+
# This parameter is required when authenticating using Secrets
|
|
1245
|
+
# Manager.
|
|
1252
1246
|
# @return [String]
|
|
1253
1247
|
#
|
|
1254
1248
|
# @!attribute [rw] db_user
|
|
@@ -1257,19 +1251,15 @@ module Aws::RedshiftDataAPIService
|
|
|
1257
1251
|
# credentials.
|
|
1258
1252
|
# @return [String]
|
|
1259
1253
|
#
|
|
1260
|
-
# @!attribute [rw]
|
|
1261
|
-
# The
|
|
1262
|
-
#
|
|
1263
|
-
# to
|
|
1264
|
-
# @return [
|
|
1254
|
+
# @!attribute [rw] database
|
|
1255
|
+
# The name of the database that contains the tables to list. If
|
|
1256
|
+
# `ConnectedDatabase` is not specified, this is also the database to
|
|
1257
|
+
# connect to with your authentication credentials.
|
|
1258
|
+
# @return [String]
|
|
1265
1259
|
#
|
|
1266
|
-
# @!attribute [rw]
|
|
1267
|
-
# A
|
|
1268
|
-
#
|
|
1269
|
-
# a response, you can retrieve the next set of records by providing
|
|
1270
|
-
# this returned NextToken value in the next NextToken parameter and
|
|
1271
|
-
# retrying the command. If the NextToken field is empty, all response
|
|
1272
|
-
# records have been retrieved for the request.
|
|
1260
|
+
# @!attribute [rw] connected_database
|
|
1261
|
+
# A database name. The connected database is specified when you
|
|
1262
|
+
# connect with your authentication credentials.
|
|
1273
1263
|
# @return [String]
|
|
1274
1264
|
#
|
|
1275
1265
|
# @!attribute [rw] schema_pattern
|
|
@@ -1282,12 +1272,6 @@ module Aws::RedshiftDataAPIService
|
|
|
1282
1272
|
# returned.
|
|
1283
1273
|
# @return [String]
|
|
1284
1274
|
#
|
|
1285
|
-
# @!attribute [rw] secret_arn
|
|
1286
|
-
# The name or ARN of the secret that enables access to the database.
|
|
1287
|
-
# This parameter is required when authenticating using Secrets
|
|
1288
|
-
# Manager.
|
|
1289
|
-
# @return [String]
|
|
1290
|
-
#
|
|
1291
1275
|
# @!attribute [rw] table_pattern
|
|
1292
1276
|
# A pattern to filter results by table name. Within a table pattern,
|
|
1293
1277
|
# "%" means match any substring of 0 or more characters and "\_"
|
|
@@ -1298,6 +1282,21 @@ module Aws::RedshiftDataAPIService
|
|
|
1298
1282
|
# returned.
|
|
1299
1283
|
# @return [String]
|
|
1300
1284
|
#
|
|
1285
|
+
# @!attribute [rw] next_token
|
|
1286
|
+
# A value that indicates the starting point for the next set of
|
|
1287
|
+
# response records in a subsequent request. If a value is returned in
|
|
1288
|
+
# a response, you can retrieve the next set of records by providing
|
|
1289
|
+
# this returned NextToken value in the next NextToken parameter and
|
|
1290
|
+
# retrying the command. If the NextToken field is empty, all response
|
|
1291
|
+
# records have been retrieved for the request.
|
|
1292
|
+
# @return [String]
|
|
1293
|
+
#
|
|
1294
|
+
# @!attribute [rw] max_results
|
|
1295
|
+
# The maximum number of tables to return in the response. If more
|
|
1296
|
+
# tables exist than fit in one response, then `NextToken` is returned
|
|
1297
|
+
# to page through the results.
|
|
1298
|
+
# @return [Integer]
|
|
1299
|
+
#
|
|
1301
1300
|
# @!attribute [rw] workgroup_name
|
|
1302
1301
|
# The serverless workgroup name or Amazon Resource Name (ARN). This
|
|
1303
1302
|
# parameter is required when connecting to a serverless workgroup and
|
|
@@ -1309,19 +1308,23 @@ module Aws::RedshiftDataAPIService
|
|
|
1309
1308
|
#
|
|
1310
1309
|
class ListTablesRequest < Struct.new(
|
|
1311
1310
|
:cluster_identifier,
|
|
1312
|
-
:
|
|
1313
|
-
:database,
|
|
1311
|
+
:secret_arn,
|
|
1314
1312
|
:db_user,
|
|
1315
|
-
:
|
|
1316
|
-
:
|
|
1313
|
+
:database,
|
|
1314
|
+
:connected_database,
|
|
1317
1315
|
:schema_pattern,
|
|
1318
|
-
:secret_arn,
|
|
1319
1316
|
:table_pattern,
|
|
1317
|
+
:next_token,
|
|
1318
|
+
:max_results,
|
|
1320
1319
|
:workgroup_name)
|
|
1321
1320
|
SENSITIVE = []
|
|
1322
1321
|
include Aws::Structure
|
|
1323
1322
|
end
|
|
1324
1323
|
|
|
1324
|
+
# @!attribute [rw] tables
|
|
1325
|
+
# The tables that match the request pattern.
|
|
1326
|
+
# @return [Array<Types::TableMember>]
|
|
1327
|
+
#
|
|
1325
1328
|
# @!attribute [rw] next_token
|
|
1326
1329
|
# A value that indicates the starting point for the next set of
|
|
1327
1330
|
# response records in a subsequent request. If a value is returned in
|
|
@@ -1331,15 +1334,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1331
1334
|
# records have been retrieved for the request.
|
|
1332
1335
|
# @return [String]
|
|
1333
1336
|
#
|
|
1334
|
-
# @!attribute [rw] tables
|
|
1335
|
-
# The tables that match the request pattern.
|
|
1336
|
-
# @return [Array<Types::TableMember>]
|
|
1337
|
-
#
|
|
1338
1337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTablesResponse AWS API Documentation
|
|
1339
1338
|
#
|
|
1340
1339
|
class ListTablesResponse < Struct.new(
|
|
1341
|
-
:
|
|
1342
|
-
:
|
|
1340
|
+
:tables,
|
|
1341
|
+
:next_token)
|
|
1343
1342
|
SENSITIVE = []
|
|
1344
1343
|
include Aws::Structure
|
|
1345
1344
|
end
|
|
@@ -1425,24 +1424,11 @@ module Aws::RedshiftDataAPIService
|
|
|
1425
1424
|
|
|
1426
1425
|
# The SQL statement to run.
|
|
1427
1426
|
#
|
|
1428
|
-
# @!attribute [rw] created_at
|
|
1429
|
-
# The date and time (UTC) the statement was created.
|
|
1430
|
-
# @return [Time]
|
|
1431
|
-
#
|
|
1432
1427
|
# @!attribute [rw] id
|
|
1433
1428
|
# The SQL statement identifier. This value is a universally unique
|
|
1434
1429
|
# identifier (UUID) generated by Amazon Redshift Data API.
|
|
1435
1430
|
# @return [String]
|
|
1436
1431
|
#
|
|
1437
|
-
# @!attribute [rw] is_batch_statement
|
|
1438
|
-
# A value that indicates whether the statement is a batch query
|
|
1439
|
-
# request.
|
|
1440
|
-
# @return [Boolean]
|
|
1441
|
-
#
|
|
1442
|
-
# @!attribute [rw] query_parameters
|
|
1443
|
-
# The parameters used in a SQL statement.
|
|
1444
|
-
# @return [Array<Types::SqlParameter>]
|
|
1445
|
-
#
|
|
1446
1432
|
# @!attribute [rw] query_string
|
|
1447
1433
|
# The SQL statement.
|
|
1448
1434
|
# @return [String]
|
|
@@ -1452,57 +1438,74 @@ module Aws::RedshiftDataAPIService
|
|
|
1452
1438
|
# corresponds to one of the queries in a batch query request.
|
|
1453
1439
|
# @return [Array<String>]
|
|
1454
1440
|
#
|
|
1455
|
-
# @!attribute [rw] result_format
|
|
1456
|
-
# The data format of the result of the SQL statement.
|
|
1457
|
-
# @return [String]
|
|
1458
|
-
#
|
|
1459
1441
|
# @!attribute [rw] secret_arn
|
|
1460
1442
|
# The name or Amazon Resource Name (ARN) of the secret that enables
|
|
1461
1443
|
# access to the database.
|
|
1462
1444
|
# @return [String]
|
|
1463
1445
|
#
|
|
1464
|
-
# @!attribute [rw]
|
|
1465
|
-
# The
|
|
1446
|
+
# @!attribute [rw] status
|
|
1447
|
+
# The status of the SQL statement. An example is the that the SQL
|
|
1448
|
+
# statement finished.
|
|
1466
1449
|
# @return [String]
|
|
1467
1450
|
#
|
|
1468
1451
|
# @!attribute [rw] statement_name
|
|
1469
1452
|
# The name of the SQL statement.
|
|
1470
1453
|
# @return [String]
|
|
1471
1454
|
#
|
|
1472
|
-
# @!attribute [rw]
|
|
1473
|
-
# The
|
|
1474
|
-
#
|
|
1475
|
-
# @return [String]
|
|
1455
|
+
# @!attribute [rw] created_at
|
|
1456
|
+
# The date and time (UTC) the statement was created.
|
|
1457
|
+
# @return [Time]
|
|
1476
1458
|
#
|
|
1477
1459
|
# @!attribute [rw] updated_at
|
|
1478
1460
|
# The date and time (UTC) that the statement metadata was last
|
|
1479
1461
|
# updated.
|
|
1480
1462
|
# @return [Time]
|
|
1481
1463
|
#
|
|
1464
|
+
# @!attribute [rw] query_parameters
|
|
1465
|
+
# The parameters used in a SQL statement.
|
|
1466
|
+
# @return [Array<Types::SqlParameter>]
|
|
1467
|
+
#
|
|
1468
|
+
# @!attribute [rw] is_batch_statement
|
|
1469
|
+
# A value that indicates whether the statement is a batch query
|
|
1470
|
+
# request.
|
|
1471
|
+
# @return [Boolean]
|
|
1472
|
+
#
|
|
1473
|
+
# @!attribute [rw] result_format
|
|
1474
|
+
# The data format of the result of the SQL statement.
|
|
1475
|
+
# @return [String]
|
|
1476
|
+
#
|
|
1477
|
+
# @!attribute [rw] session_id
|
|
1478
|
+
# The session identifier of the query.
|
|
1479
|
+
# @return [String]
|
|
1480
|
+
#
|
|
1482
1481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/StatementData AWS API Documentation
|
|
1483
1482
|
#
|
|
1484
1483
|
class StatementData < Struct.new(
|
|
1485
|
-
:created_at,
|
|
1486
1484
|
:id,
|
|
1487
|
-
:is_batch_statement,
|
|
1488
|
-
:query_parameters,
|
|
1489
1485
|
:query_string,
|
|
1490
1486
|
:query_strings,
|
|
1491
|
-
:result_format,
|
|
1492
1487
|
:secret_arn,
|
|
1493
|
-
:session_id,
|
|
1494
|
-
:statement_name,
|
|
1495
1488
|
:status,
|
|
1496
|
-
:
|
|
1489
|
+
:statement_name,
|
|
1490
|
+
:created_at,
|
|
1491
|
+
:updated_at,
|
|
1492
|
+
:query_parameters,
|
|
1493
|
+
:is_batch_statement,
|
|
1494
|
+
:result_format,
|
|
1495
|
+
:session_id)
|
|
1497
1496
|
SENSITIVE = []
|
|
1498
1497
|
include Aws::Structure
|
|
1499
1498
|
end
|
|
1500
1499
|
|
|
1501
1500
|
# Information about an SQL statement.
|
|
1502
1501
|
#
|
|
1503
|
-
# @!attribute [rw]
|
|
1504
|
-
# The
|
|
1505
|
-
#
|
|
1502
|
+
# @!attribute [rw] id
|
|
1503
|
+
# The identifier of the SQL statement. This value is a universally
|
|
1504
|
+
# unique identifier (UUID) generated by Amazon Redshift Data API. A
|
|
1505
|
+
# suffix indicates the number of the SQL statement. For example,
|
|
1506
|
+
# `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that
|
|
1507
|
+
# indicates the second SQL statement of a batch query.
|
|
1508
|
+
# @return [String]
|
|
1506
1509
|
#
|
|
1507
1510
|
# @!attribute [rw] duration
|
|
1508
1511
|
# The amount of time in nanoseconds that the statement ran.
|
|
@@ -1513,28 +1516,24 @@ module Aws::RedshiftDataAPIService
|
|
|
1513
1516
|
# an error while running.
|
|
1514
1517
|
# @return [String]
|
|
1515
1518
|
#
|
|
1516
|
-
# @!attribute [rw]
|
|
1517
|
-
#
|
|
1518
|
-
#
|
|
1519
|
-
# @return [Boolean]
|
|
1520
|
-
#
|
|
1521
|
-
# @!attribute [rw] id
|
|
1522
|
-
# The identifier of the SQL statement. This value is a universally
|
|
1523
|
-
# unique identifier (UUID) generated by Amazon Redshift Data API. A
|
|
1524
|
-
# suffix indicates the number of the SQL statement. For example,
|
|
1525
|
-
# `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that
|
|
1526
|
-
# indicates the second SQL statement of a batch query.
|
|
1519
|
+
# @!attribute [rw] status
|
|
1520
|
+
# The status of the SQL statement. An example is the that the SQL
|
|
1521
|
+
# statement finished.
|
|
1527
1522
|
# @return [String]
|
|
1528
1523
|
#
|
|
1524
|
+
# @!attribute [rw] created_at
|
|
1525
|
+
# The date and time (UTC) the statement was created.
|
|
1526
|
+
# @return [Time]
|
|
1527
|
+
#
|
|
1528
|
+
# @!attribute [rw] updated_at
|
|
1529
|
+
# The date and time (UTC) that the statement metadata was last
|
|
1530
|
+
# updated.
|
|
1531
|
+
# @return [Time]
|
|
1532
|
+
#
|
|
1529
1533
|
# @!attribute [rw] query_string
|
|
1530
1534
|
# The SQL statement text.
|
|
1531
1535
|
# @return [String]
|
|
1532
1536
|
#
|
|
1533
|
-
# @!attribute [rw] redshift_query_id
|
|
1534
|
-
# The SQL statement identifier. This value is a universally unique
|
|
1535
|
-
# identifier (UUID) generated by Amazon Redshift Data API.
|
|
1536
|
-
# @return [Integer]
|
|
1537
|
-
#
|
|
1538
1537
|
# @!attribute [rw] result_rows
|
|
1539
1538
|
# Either the number of rows returned from the SQL statement or the
|
|
1540
1539
|
# number of rows affected. If result size is greater than zero, the
|
|
@@ -1548,30 +1547,30 @@ module Aws::RedshiftDataAPIService
|
|
|
1548
1547
|
# value is null.
|
|
1549
1548
|
# @return [Integer]
|
|
1550
1549
|
#
|
|
1551
|
-
# @!attribute [rw]
|
|
1552
|
-
# The
|
|
1553
|
-
#
|
|
1554
|
-
# @return [
|
|
1550
|
+
# @!attribute [rw] redshift_query_id
|
|
1551
|
+
# The SQL statement identifier. This value is a universally unique
|
|
1552
|
+
# identifier (UUID) generated by Amazon Redshift Data API.
|
|
1553
|
+
# @return [Integer]
|
|
1555
1554
|
#
|
|
1556
|
-
# @!attribute [rw]
|
|
1557
|
-
#
|
|
1558
|
-
#
|
|
1559
|
-
# @return [
|
|
1555
|
+
# @!attribute [rw] has_result_set
|
|
1556
|
+
# A value that indicates whether the statement has a result set. The
|
|
1557
|
+
# result set can be empty. The value is true for an empty result set.
|
|
1558
|
+
# @return [Boolean]
|
|
1560
1559
|
#
|
|
1561
1560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/SubStatementData AWS API Documentation
|
|
1562
1561
|
#
|
|
1563
1562
|
class SubStatementData < Struct.new(
|
|
1564
|
-
:
|
|
1563
|
+
:id,
|
|
1565
1564
|
:duration,
|
|
1566
1565
|
:error,
|
|
1567
|
-
:
|
|
1568
|
-
:
|
|
1566
|
+
:status,
|
|
1567
|
+
:created_at,
|
|
1568
|
+
:updated_at,
|
|
1569
1569
|
:query_string,
|
|
1570
|
-
:redshift_query_id,
|
|
1571
1570
|
:result_rows,
|
|
1572
1571
|
:result_size,
|
|
1573
|
-
:
|
|
1574
|
-
:
|
|
1572
|
+
:redshift_query_id,
|
|
1573
|
+
:has_result_set)
|
|
1575
1574
|
SENSITIVE = []
|
|
1576
1575
|
include Aws::Structure
|
|
1577
1576
|
end
|
|
@@ -1582,21 +1581,21 @@ module Aws::RedshiftDataAPIService
|
|
|
1582
1581
|
# The name of the table.
|
|
1583
1582
|
# @return [String]
|
|
1584
1583
|
#
|
|
1585
|
-
# @!attribute [rw] schema
|
|
1586
|
-
# The schema containing the table.
|
|
1587
|
-
# @return [String]
|
|
1588
|
-
#
|
|
1589
1584
|
# @!attribute [rw] type
|
|
1590
1585
|
# The type of the table. Possible values include TABLE, VIEW, SYSTEM
|
|
1591
1586
|
# TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
|
|
1592
1587
|
# @return [String]
|
|
1593
1588
|
#
|
|
1589
|
+
# @!attribute [rw] schema
|
|
1590
|
+
# The schema containing the table.
|
|
1591
|
+
# @return [String]
|
|
1592
|
+
#
|
|
1594
1593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/TableMember AWS API Documentation
|
|
1595
1594
|
#
|
|
1596
1595
|
class TableMember < Struct.new(
|
|
1597
1596
|
:name,
|
|
1598
|
-
:
|
|
1599
|
-
:
|
|
1597
|
+
:type,
|
|
1598
|
+
:schema)
|
|
1600
1599
|
SENSITIVE = []
|
|
1601
1600
|
include Aws::Structure
|
|
1602
1601
|
end
|