aws-sdk-redshiftdataapiservice 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::RedshiftDataAPIService
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,1080 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::RedshiftDataAPIService
11
+ module Types
12
+
13
+ # @note When making an API call, you may pass CancelStatementRequest
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # id: "UUID", # required
18
+ # }
19
+ #
20
+ # @!attribute [rw] id
21
+ # The identifier of the SQL statement to cancel. This value is a
22
+ # universally unique identifier (UUID) generated by Amazon Redshift
23
+ # Data API. This identifier is returned by `ExecuteStatment` and
24
+ # `ListStatements`.
25
+ # @return [String]
26
+ #
27
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/CancelStatementRequest AWS API Documentation
28
+ #
29
+ class CancelStatementRequest < Struct.new(
30
+ :id)
31
+ SENSITIVE = []
32
+ include Aws::Structure
33
+ end
34
+
35
+ # @!attribute [rw] status
36
+ # A value that indicates whether the cancel statement succeeded
37
+ # (true).
38
+ # @return [Boolean]
39
+ #
40
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/CancelStatementResponse AWS API Documentation
41
+ #
42
+ class CancelStatementResponse < Struct.new(
43
+ :status)
44
+ SENSITIVE = []
45
+ include Aws::Structure
46
+ end
47
+
48
+ # The properties (metadata) of a column.
49
+ #
50
+ # @!attribute [rw] column_default
51
+ # The default value of the column.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] is_case_sensitive
55
+ # A value that indicates whether the column is case-sensitive.
56
+ # @return [Boolean]
57
+ #
58
+ # @!attribute [rw] is_currency
59
+ # A value that indicates whether the column contains currency values.
60
+ # @return [Boolean]
61
+ #
62
+ # @!attribute [rw] is_signed
63
+ # A value that indicates whether an integer column is signed.
64
+ # @return [Boolean]
65
+ #
66
+ # @!attribute [rw] label
67
+ # The label for the column.
68
+ # @return [String]
69
+ #
70
+ # @!attribute [rw] length
71
+ # The length of the column.
72
+ # @return [Integer]
73
+ #
74
+ # @!attribute [rw] name
75
+ # The name of the column.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] nullable
79
+ # A value that indicates whether the column is nullable.
80
+ # @return [Integer]
81
+ #
82
+ # @!attribute [rw] precision
83
+ # The precision value of a decimal number column.
84
+ # @return [Integer]
85
+ #
86
+ # @!attribute [rw] scale
87
+ # The scale value of a decimal number column.
88
+ # @return [Integer]
89
+ #
90
+ # @!attribute [rw] schema_name
91
+ # The name of the schema that contains the table that includes the
92
+ # column.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] table_name
96
+ # The name of the table that includes the column.
97
+ # @return [String]
98
+ #
99
+ # @!attribute [rw] type_name
100
+ # The database-specific data type of the column.
101
+ # @return [String]
102
+ #
103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ColumnMetadata AWS API Documentation
104
+ #
105
+ class ColumnMetadata < Struct.new(
106
+ :column_default,
107
+ :is_case_sensitive,
108
+ :is_currency,
109
+ :is_signed,
110
+ :label,
111
+ :length,
112
+ :name,
113
+ :nullable,
114
+ :precision,
115
+ :scale,
116
+ :schema_name,
117
+ :table_name,
118
+ :type_name)
119
+ SENSITIVE = []
120
+ include Aws::Structure
121
+ end
122
+
123
+ # @note When making an API call, you may pass DescribeStatementRequest
124
+ # data as a hash:
125
+ #
126
+ # {
127
+ # id: "UUID", # required
128
+ # }
129
+ #
130
+ # @!attribute [rw] id
131
+ # The identifier of the SQL statement to describe. This value is a
132
+ # universally unique identifier (UUID) generated by Amazon Redshift
133
+ # Data API. This identifier is returned by `ExecuteStatment` and
134
+ # `ListStatements`.
135
+ # @return [String]
136
+ #
137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatementRequest AWS API Documentation
138
+ #
139
+ class DescribeStatementRequest < Struct.new(
140
+ :id)
141
+ SENSITIVE = []
142
+ include Aws::Structure
143
+ end
144
+
145
+ # @!attribute [rw] cluster_identifier
146
+ # The cluster identifier.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] created_at
150
+ # The date and time (UTC) when the SQL statement was submitted to run.
151
+ # @return [Time]
152
+ #
153
+ # @!attribute [rw] database
154
+ # The name of the database.
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] db_user
158
+ # The database user name.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] duration
162
+ # The amount of time in nanoseconds that the statement ran.
163
+ # @return [Integer]
164
+ #
165
+ # @!attribute [rw] error
166
+ # The error message from the cluster if the SQL statement encountered
167
+ # an error while running.
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] id
171
+ # The identifier of the SQL statement described. This value is a
172
+ # universally unique identifier (UUID) generated by Amazon Redshift
173
+ # Data API.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] query_string
177
+ # The SQL statement text.
178
+ # @return [String]
179
+ #
180
+ # @!attribute [rw] redshift_pid
181
+ # The process identifier from Amazon Redshift.
182
+ # @return [Integer]
183
+ #
184
+ # @!attribute [rw] redshift_query_id
185
+ # The identifier of the query generated by Amazon Redshift. These
186
+ # identifiers are also available in the `query` column of the
187
+ # `STL_QUERY` system view.
188
+ # @return [Integer]
189
+ #
190
+ # @!attribute [rw] result_rows
191
+ # Either the number of rows returned from the SQL statement or the
192
+ # number of rows affected. If result size is greater than zero, the
193
+ # result rows can be the number of rows affected by SQL statements
194
+ # such as INSERT, UPDATE, DELETE, COPY, and others.
195
+ # @return [Integer]
196
+ #
197
+ # @!attribute [rw] result_size
198
+ # The size in bytes of the returned results.
199
+ # @return [Integer]
200
+ #
201
+ # @!attribute [rw] secret_arn
202
+ # The name or Amazon Resource Name (ARN) of the secret that enables
203
+ # access to the database.
204
+ # @return [String]
205
+ #
206
+ # @!attribute [rw] status
207
+ # The status of the SQL statement being described. Status values are
208
+ # defined as follows:
209
+ #
210
+ # * ABORTED - The query run was stopped by the user.
211
+ #
212
+ # * ALL - A status value that includes all query statuses. This value
213
+ # can be used to filter results.
214
+ #
215
+ # * FAILED - The query run failed.
216
+ #
217
+ # * FINISHED - The query has finished running.
218
+ #
219
+ # * PICKED - The query has been chosen to be run.
220
+ #
221
+ # * STARTED - The query run has started.
222
+ #
223
+ # * SUBMITTED - The query was submitted, but not yet processed.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] updated_at
227
+ # The date and time (UTC) that the metadata for the SQL statement was
228
+ # last updated. An example is the time the status last changed.
229
+ # @return [Time]
230
+ #
231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatementResponse AWS API Documentation
232
+ #
233
+ class DescribeStatementResponse < Struct.new(
234
+ :cluster_identifier,
235
+ :created_at,
236
+ :database,
237
+ :db_user,
238
+ :duration,
239
+ :error,
240
+ :id,
241
+ :query_string,
242
+ :redshift_pid,
243
+ :redshift_query_id,
244
+ :result_rows,
245
+ :result_size,
246
+ :secret_arn,
247
+ :status,
248
+ :updated_at)
249
+ SENSITIVE = []
250
+ include Aws::Structure
251
+ end
252
+
253
+ # @note When making an API call, you may pass DescribeTableRequest
254
+ # data as a hash:
255
+ #
256
+ # {
257
+ # cluster_identifier: "Location", # required
258
+ # database: "String",
259
+ # db_user: "String",
260
+ # max_results: 1,
261
+ # next_token: "String",
262
+ # schema: "String",
263
+ # secret_arn: "SecretArn",
264
+ # table: "String",
265
+ # }
266
+ #
267
+ # @!attribute [rw] cluster_identifier
268
+ # The cluster identifier. This parameter is required when
269
+ # authenticating using either AWS Secrets Manager or temporary
270
+ # credentials.
271
+ # @return [String]
272
+ #
273
+ # @!attribute [rw] database
274
+ # The name of the database. This parameter is required when
275
+ # authenticating using temporary credentials.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] db_user
279
+ # The database user name. This parameter is required when
280
+ # authenticating using temporary credentials.
281
+ # @return [String]
282
+ #
283
+ # @!attribute [rw] max_results
284
+ # The maximum number of tables to return in the response. If more
285
+ # tables exist than fit in one response, then `NextToken` is returned
286
+ # to page through the results.
287
+ # @return [Integer]
288
+ #
289
+ # @!attribute [rw] next_token
290
+ # A value that indicates the starting point for the next set of
291
+ # response records in a subsequent request. If a value is returned in
292
+ # a response, you can retrieve the next set of records by providing
293
+ # this returned NextToken value in the next NextToken parameter and
294
+ # retrying the command. If the NextToken field is empty, all response
295
+ # records have been retrieved for the request.
296
+ # @return [String]
297
+ #
298
+ # @!attribute [rw] schema
299
+ # The schema that contains the table. If no schema is specified, then
300
+ # matching tables for all schemas are returned.
301
+ # @return [String]
302
+ #
303
+ # @!attribute [rw] secret_arn
304
+ # The name or ARN of the secret that enables access to the database.
305
+ # This parameter is required when authenticating using AWS Secrets
306
+ # Manager.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] table
310
+ # The table name. If no table is specified, then all tables for all
311
+ # matching schemas are returned. If no table and no schema is
312
+ # specified, then all tables for all schemas in the database are
313
+ # returned
314
+ # @return [String]
315
+ #
316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTableRequest AWS API Documentation
317
+ #
318
+ class DescribeTableRequest < Struct.new(
319
+ :cluster_identifier,
320
+ :database,
321
+ :db_user,
322
+ :max_results,
323
+ :next_token,
324
+ :schema,
325
+ :secret_arn,
326
+ :table)
327
+ SENSITIVE = []
328
+ include Aws::Structure
329
+ end
330
+
331
+ # @!attribute [rw] column_list
332
+ # A list of columns in the table.
333
+ # @return [Array<Types::ColumnMetadata>]
334
+ #
335
+ # @!attribute [rw] next_token
336
+ # A value that indicates the starting point for the next set of
337
+ # response records in a subsequent request. If a value is returned in
338
+ # a response, you can retrieve the next set of records by providing
339
+ # this returned NextToken value in the next NextToken parameter and
340
+ # retrying the command. If the NextToken field is empty, all response
341
+ # records have been retrieved for the request.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] table_name
345
+ # The table name.
346
+ # @return [String]
347
+ #
348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTableResponse AWS API Documentation
349
+ #
350
+ class DescribeTableResponse < Struct.new(
351
+ :column_list,
352
+ :next_token,
353
+ :table_name)
354
+ SENSITIVE = []
355
+ include Aws::Structure
356
+ end
357
+
358
+ # The SQL statement encountered an environmental error while running.
359
+ #
360
+ # @!attribute [rw] message
361
+ # The exception message.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] statement_id
365
+ # Statement identifier of the exception.
366
+ # @return [String]
367
+ #
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementException AWS API Documentation
369
+ #
370
+ class ExecuteStatementException < Struct.new(
371
+ :message,
372
+ :statement_id)
373
+ SENSITIVE = []
374
+ include Aws::Structure
375
+ end
376
+
377
+ # @note When making an API call, you may pass ExecuteStatementInput
378
+ # data as a hash:
379
+ #
380
+ # {
381
+ # cluster_identifier: "Location", # required
382
+ # database: "String",
383
+ # db_user: "String",
384
+ # secret_arn: "SecretArn",
385
+ # sql: "StatementString", # required
386
+ # statement_name: "StatementNameString",
387
+ # with_event: false,
388
+ # }
389
+ #
390
+ # @!attribute [rw] cluster_identifier
391
+ # The cluster identifier. This parameter is required when
392
+ # authenticating using either AWS Secrets Manager or temporary
393
+ # credentials.
394
+ # @return [String]
395
+ #
396
+ # @!attribute [rw] database
397
+ # The name of the database. This parameter is required when
398
+ # authenticating using temporary credentials.
399
+ # @return [String]
400
+ #
401
+ # @!attribute [rw] db_user
402
+ # The database user name. This parameter is required when
403
+ # authenticating using temporary credentials.
404
+ # @return [String]
405
+ #
406
+ # @!attribute [rw] secret_arn
407
+ # The name or ARN of the secret that enables access to the database.
408
+ # This parameter is required when authenticating using AWS Secrets
409
+ # Manager.
410
+ # @return [String]
411
+ #
412
+ # @!attribute [rw] sql
413
+ # The SQL statement text to run.
414
+ # @return [String]
415
+ #
416
+ # @!attribute [rw] statement_name
417
+ # The name of the SQL statement. You can name the SQL statement when
418
+ # you create it to identify the query.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] with_event
422
+ # A value that indicates whether to send an event to the Amazon
423
+ # EventBridge event bus after the SQL statement runs.
424
+ # @return [Boolean]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementInput AWS API Documentation
427
+ #
428
+ class ExecuteStatementInput < Struct.new(
429
+ :cluster_identifier,
430
+ :database,
431
+ :db_user,
432
+ :secret_arn,
433
+ :sql,
434
+ :statement_name,
435
+ :with_event)
436
+ SENSITIVE = []
437
+ include Aws::Structure
438
+ end
439
+
440
+ # @!attribute [rw] cluster_identifier
441
+ # The cluster identifier.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] created_at
445
+ # The date and time (UTC) the statement was created.
446
+ # @return [Time]
447
+ #
448
+ # @!attribute [rw] database
449
+ # The name of the database.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] db_user
453
+ # The database user name.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] id
457
+ # The identifier of the statement to be run. This value is a
458
+ # universally unique identifier (UUID) generated by Amazon Redshift
459
+ # Data API.
460
+ # @return [String]
461
+ #
462
+ # @!attribute [rw] secret_arn
463
+ # The name or ARN of the secret that enables access to the database.
464
+ # @return [String]
465
+ #
466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ExecuteStatementOutput AWS API Documentation
467
+ #
468
+ class ExecuteStatementOutput < Struct.new(
469
+ :cluster_identifier,
470
+ :created_at,
471
+ :database,
472
+ :db_user,
473
+ :id,
474
+ :secret_arn)
475
+ SENSITIVE = []
476
+ include Aws::Structure
477
+ end
478
+
479
+ # A data value in a column.
480
+ #
481
+ # @!attribute [rw] blob_value
482
+ # A value of the BLOB data type.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] boolean_value
486
+ # A value of the Boolean data type.
487
+ # @return [Boolean]
488
+ #
489
+ # @!attribute [rw] double_value
490
+ # A value of the double data type.
491
+ # @return [Float]
492
+ #
493
+ # @!attribute [rw] is_null
494
+ # A value that indicates whether the data is NULL.
495
+ # @return [Boolean]
496
+ #
497
+ # @!attribute [rw] long_value
498
+ # A value of the long data type.
499
+ # @return [Integer]
500
+ #
501
+ # @!attribute [rw] string_value
502
+ # A value of the string data type.
503
+ # @return [String]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/Field AWS API Documentation
506
+ #
507
+ class Field < Struct.new(
508
+ :blob_value,
509
+ :boolean_value,
510
+ :double_value,
511
+ :is_null,
512
+ :long_value,
513
+ :string_value)
514
+ SENSITIVE = []
515
+ include Aws::Structure
516
+ end
517
+
518
+ # @note When making an API call, you may pass GetStatementResultRequest
519
+ # data as a hash:
520
+ #
521
+ # {
522
+ # id: "UUID", # required
523
+ # next_token: "String",
524
+ # }
525
+ #
526
+ # @!attribute [rw] id
527
+ # The identifier of the SQL statement whose results are to be fetched.
528
+ # This value is a universally unique identifier (UUID) generated by
529
+ # Amazon Redshift Data API. This identifier is returned by
530
+ # `ExecuteStatment` and `ListStatements`.
531
+ # @return [String]
532
+ #
533
+ # @!attribute [rw] next_token
534
+ # A value that indicates the starting point for the next set of
535
+ # response records in a subsequent request. If a value is returned in
536
+ # a response, you can retrieve the next set of records by providing
537
+ # this returned NextToken value in the next NextToken parameter and
538
+ # retrying the command. If the NextToken field is empty, all response
539
+ # records have been retrieved for the request.
540
+ # @return [String]
541
+ #
542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultRequest AWS API Documentation
543
+ #
544
+ class GetStatementResultRequest < Struct.new(
545
+ :id,
546
+ :next_token)
547
+ SENSITIVE = []
548
+ include Aws::Structure
549
+ end
550
+
551
+ # @!attribute [rw] column_metadata
552
+ # The properties (metadata) of a column.
553
+ # @return [Array<Types::ColumnMetadata>]
554
+ #
555
+ # @!attribute [rw] next_token
556
+ # A value that indicates the starting point for the next set of
557
+ # response records in a subsequent request. If a value is returned in
558
+ # a response, you can retrieve the next set of records by providing
559
+ # this returned NextToken value in the next NextToken parameter and
560
+ # retrying the command. If the NextToken field is empty, all response
561
+ # records have been retrieved for the request.
562
+ # @return [String]
563
+ #
564
+ # @!attribute [rw] records
565
+ # The results of the SQL statement.
566
+ # @return [Array<Array<Types::Field>>]
567
+ #
568
+ # @!attribute [rw] total_num_rows
569
+ # The total number of rows in the result set returned from a query.
570
+ # You can use this number to estimate the number of calls to the
571
+ # `GetStatementResult` operation needed to page through the results.
572
+ # @return [Integer]
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultResponse AWS API Documentation
575
+ #
576
+ class GetStatementResultResponse < Struct.new(
577
+ :column_metadata,
578
+ :next_token,
579
+ :records,
580
+ :total_num_rows)
581
+ SENSITIVE = []
582
+ include Aws::Structure
583
+ end
584
+
585
+ # The Amazon Redshift Data API operation failed due to invalid input.
586
+ #
587
+ # @!attribute [rw] message
588
+ # The exception message.
589
+ # @return [String]
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/InternalServerException AWS API Documentation
592
+ #
593
+ class InternalServerException < Struct.new(
594
+ :message)
595
+ SENSITIVE = []
596
+ include Aws::Structure
597
+ end
598
+
599
+ # @note When making an API call, you may pass ListDatabasesRequest
600
+ # data as a hash:
601
+ #
602
+ # {
603
+ # cluster_identifier: "Location", # required
604
+ # database: "String",
605
+ # db_user: "String",
606
+ # max_results: 1,
607
+ # next_token: "String",
608
+ # secret_arn: "SecretArn",
609
+ # }
610
+ #
611
+ # @!attribute [rw] cluster_identifier
612
+ # The cluster identifier. This parameter is required when
613
+ # authenticating using either AWS Secrets Manager or temporary
614
+ # credentials.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] database
618
+ # The name of the database. This parameter is required when
619
+ # authenticating using temporary credentials.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] db_user
623
+ # The database user name. This parameter is required when
624
+ # authenticating using temporary credentials.
625
+ # @return [String]
626
+ #
627
+ # @!attribute [rw] max_results
628
+ # The maximum number of databases to return in the response. If more
629
+ # databases exist than fit in one response, then `NextToken` is
630
+ # returned to page through the results.
631
+ # @return [Integer]
632
+ #
633
+ # @!attribute [rw] next_token
634
+ # A value that indicates the starting point for the next set of
635
+ # response records in a subsequent request. If a value is returned in
636
+ # a response, you can retrieve the next set of records by providing
637
+ # this returned NextToken value in the next NextToken parameter and
638
+ # retrying the command. If the NextToken field is empty, all response
639
+ # records have been retrieved for the request.
640
+ # @return [String]
641
+ #
642
+ # @!attribute [rw] secret_arn
643
+ # The name or ARN of the secret that enables access to the database.
644
+ # This parameter is required when authenticating using AWS Secrets
645
+ # Manager.
646
+ # @return [String]
647
+ #
648
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListDatabasesRequest AWS API Documentation
649
+ #
650
+ class ListDatabasesRequest < Struct.new(
651
+ :cluster_identifier,
652
+ :database,
653
+ :db_user,
654
+ :max_results,
655
+ :next_token,
656
+ :secret_arn)
657
+ SENSITIVE = []
658
+ include Aws::Structure
659
+ end
660
+
661
+ # @!attribute [rw] databases
662
+ # The names of databases.
663
+ # @return [Array<String>]
664
+ #
665
+ # @!attribute [rw] next_token
666
+ # A value that indicates the starting point for the next set of
667
+ # response records in a subsequent request. If a value is returned in
668
+ # a response, you can retrieve the next set of records by providing
669
+ # this returned NextToken value in the next NextToken parameter and
670
+ # retrying the command. If the NextToken field is empty, all response
671
+ # records have been retrieved for the request.
672
+ # @return [String]
673
+ #
674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListDatabasesResponse AWS API Documentation
675
+ #
676
+ class ListDatabasesResponse < Struct.new(
677
+ :databases,
678
+ :next_token)
679
+ SENSITIVE = []
680
+ include Aws::Structure
681
+ end
682
+
683
+ # @note When making an API call, you may pass ListSchemasRequest
684
+ # data as a hash:
685
+ #
686
+ # {
687
+ # cluster_identifier: "Location", # required
688
+ # database: "String", # required
689
+ # db_user: "String",
690
+ # max_results: 1,
691
+ # next_token: "String",
692
+ # schema_pattern: "String",
693
+ # secret_arn: "SecretArn",
694
+ # }
695
+ #
696
+ # @!attribute [rw] cluster_identifier
697
+ # The cluster identifier. This parameter is required when
698
+ # authenticating using either AWS Secrets Manager or temporary
699
+ # credentials.
700
+ # @return [String]
701
+ #
702
+ # @!attribute [rw] database
703
+ # The name of the database. This parameter is required when
704
+ # authenticating using temporary credentials.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] db_user
708
+ # The database user name. This parameter is required when
709
+ # authenticating using temporary credentials.
710
+ # @return [String]
711
+ #
712
+ # @!attribute [rw] max_results
713
+ # The maximum number of schemas to return in the response. If more
714
+ # schemas exist than fit in one response, then `NextToken` is returned
715
+ # to page through the results.
716
+ # @return [Integer]
717
+ #
718
+ # @!attribute [rw] next_token
719
+ # A value that indicates the starting point for the next set of
720
+ # response records in a subsequent request. If a value is returned in
721
+ # a response, you can retrieve the next set of records by providing
722
+ # this returned NextToken value in the next NextToken parameter and
723
+ # retrying the command. If the NextToken field is empty, all response
724
+ # records have been retrieved for the request.
725
+ # @return [String]
726
+ #
727
+ # @!attribute [rw] schema_pattern
728
+ # A pattern to filter results by schema name. Within a schema pattern,
729
+ # "%" means match any substring of 0 or more characters and "\_"
730
+ # means match any one character. Only schema name entries matching the
731
+ # search pattern are returned.
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] secret_arn
735
+ # The name or ARN of the secret that enables access to the database.
736
+ # This parameter is required when authenticating using AWS Secrets
737
+ # Manager.
738
+ # @return [String]
739
+ #
740
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemasRequest AWS API Documentation
741
+ #
742
+ class ListSchemasRequest < Struct.new(
743
+ :cluster_identifier,
744
+ :database,
745
+ :db_user,
746
+ :max_results,
747
+ :next_token,
748
+ :schema_pattern,
749
+ :secret_arn)
750
+ SENSITIVE = []
751
+ include Aws::Structure
752
+ end
753
+
754
+ # @!attribute [rw] next_token
755
+ # A value that indicates the starting point for the next set of
756
+ # response records in a subsequent request. If a value is returned in
757
+ # a response, you can retrieve the next set of records by providing
758
+ # this returned NextToken value in the next NextToken parameter and
759
+ # retrying the command. If the NextToken field is empty, all response
760
+ # records have been retrieved for the request.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] schemas
764
+ # The schemas that match the request pattern.
765
+ # @return [Array<String>]
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemasResponse AWS API Documentation
768
+ #
769
+ class ListSchemasResponse < Struct.new(
770
+ :next_token,
771
+ :schemas)
772
+ SENSITIVE = []
773
+ include Aws::Structure
774
+ end
775
+
776
+ # @note When making an API call, you may pass ListStatementsRequest
777
+ # data as a hash:
778
+ #
779
+ # {
780
+ # max_results: 1,
781
+ # next_token: "String",
782
+ # statement_name: "StatementNameString",
783
+ # status: "ABORTED", # accepts ABORTED, ALL, FAILED, FINISHED, PICKED, STARTED, SUBMITTED
784
+ # }
785
+ #
786
+ # @!attribute [rw] max_results
787
+ # The maximum number of SQL statements to return in the response. If
788
+ # more SQL statements exist than fit in one response, then `NextToken`
789
+ # is returned to page through the results.
790
+ # @return [Integer]
791
+ #
792
+ # @!attribute [rw] next_token
793
+ # A value that indicates the starting point for the next set of
794
+ # response records in a subsequent request. If a value is returned in
795
+ # a response, you can retrieve the next set of records by providing
796
+ # this returned NextToken value in the next NextToken parameter and
797
+ # retrying the command. If the NextToken field is empty, all response
798
+ # records have been retrieved for the request.
799
+ # @return [String]
800
+ #
801
+ # @!attribute [rw] statement_name
802
+ # The name of the SQL statement specified as input to
803
+ # `ExecuteStatement` to identify the query. You can list multiple
804
+ # statements by providing a prefix that matches the beginning of the
805
+ # statement name. For example, to list myStatement1, myStatement2,
806
+ # myStatement3, and so on, then provide the a value of `myStatement`.
807
+ # Data API does a case-sensitive match of SQL statement names to the
808
+ # prefix value you provide.
809
+ # @return [String]
810
+ #
811
+ # @!attribute [rw] status
812
+ # The status of the SQL statement to list. Status values are defined
813
+ # as follows:
814
+ #
815
+ # * ABORTED - The query run was stopped by the user.
816
+ #
817
+ # * ALL - A status value that includes all query statuses. This value
818
+ # can be used to filter results.
819
+ #
820
+ # * FAILED - The query run failed.
821
+ #
822
+ # * FINISHED - The query has finished running.
823
+ #
824
+ # * PICKED - The query has been chosen to be run.
825
+ #
826
+ # * STARTED - The query run has started.
827
+ #
828
+ # * SUBMITTED - The query was submitted, but not yet processed.
829
+ # @return [String]
830
+ #
831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatementsRequest AWS API Documentation
832
+ #
833
+ class ListStatementsRequest < Struct.new(
834
+ :max_results,
835
+ :next_token,
836
+ :statement_name,
837
+ :status)
838
+ SENSITIVE = []
839
+ include Aws::Structure
840
+ end
841
+
842
+ # @!attribute [rw] next_token
843
+ # A value that indicates the starting point for the next set of
844
+ # response records in a subsequent request. If a value is returned in
845
+ # a response, you can retrieve the next set of records by providing
846
+ # this returned NextToken value in the next NextToken parameter and
847
+ # retrying the command. If the NextToken field is empty, all response
848
+ # records have been retrieved for the request.
849
+ # @return [String]
850
+ #
851
+ # @!attribute [rw] statements
852
+ # The SQL statements.
853
+ # @return [Array<Types::StatementData>]
854
+ #
855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListStatementsResponse AWS API Documentation
856
+ #
857
+ class ListStatementsResponse < Struct.new(
858
+ :next_token,
859
+ :statements)
860
+ SENSITIVE = []
861
+ include Aws::Structure
862
+ end
863
+
864
+ # @note When making an API call, you may pass ListTablesRequest
865
+ # data as a hash:
866
+ #
867
+ # {
868
+ # cluster_identifier: "Location", # required
869
+ # database: "String", # required
870
+ # db_user: "String",
871
+ # max_results: 1,
872
+ # next_token: "String",
873
+ # schema_pattern: "String",
874
+ # secret_arn: "SecretArn",
875
+ # table_pattern: "String",
876
+ # }
877
+ #
878
+ # @!attribute [rw] cluster_identifier
879
+ # The cluster identifier. This parameter is required when
880
+ # authenticating using either AWS Secrets Manager or temporary
881
+ # credentials.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] database
885
+ # The name of the database. This parameter is required when
886
+ # authenticating using temporary credentials.
887
+ # @return [String]
888
+ #
889
+ # @!attribute [rw] db_user
890
+ # The database user name. This parameter is required when
891
+ # authenticating using temporary credentials.
892
+ # @return [String]
893
+ #
894
+ # @!attribute [rw] max_results
895
+ # The maximum number of tables to return in the response. If more
896
+ # tables exist than fit in one response, then `NextToken` is returned
897
+ # to page through the results.
898
+ # @return [Integer]
899
+ #
900
+ # @!attribute [rw] next_token
901
+ # A value that indicates the starting point for the next set of
902
+ # response records in a subsequent request. If a value is returned in
903
+ # a response, you can retrieve the next set of records by providing
904
+ # this returned NextToken value in the next NextToken parameter and
905
+ # retrying the command. If the NextToken field is empty, all response
906
+ # records have been retrieved for the request.
907
+ # @return [String]
908
+ #
909
+ # @!attribute [rw] schema_pattern
910
+ # A pattern to filter results by schema name. Within a schema pattern,
911
+ # "%" means match any substring of 0 or more characters and "\_"
912
+ # means match any one character. Only schema name entries matching the
913
+ # search pattern are returned. If `SchemaPattern` is not specified,
914
+ # then all tables that match `TablePattern` are returned. If neither
915
+ # `SchemaPattern` or `TablePattern` are specified, then all tables are
916
+ # returned.
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] secret_arn
920
+ # The name or ARN of the secret that enables access to the database.
921
+ # This parameter is required when authenticating using AWS Secrets
922
+ # Manager.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] table_pattern
926
+ # A pattern to filter results by table name. Within a table pattern,
927
+ # "%" means match any substring of 0 or more characters and "\_"
928
+ # means match any one character. Only table name entries matching the
929
+ # search pattern are returned. If `TablePattern` is not specified,
930
+ # then all tables that match `SchemaPattern`are returned. If neither
931
+ # `SchemaPattern` or `TablePattern` are specified, then all tables are
932
+ # returned.
933
+ # @return [String]
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTablesRequest AWS API Documentation
936
+ #
937
+ class ListTablesRequest < Struct.new(
938
+ :cluster_identifier,
939
+ :database,
940
+ :db_user,
941
+ :max_results,
942
+ :next_token,
943
+ :schema_pattern,
944
+ :secret_arn,
945
+ :table_pattern)
946
+ SENSITIVE = []
947
+ include Aws::Structure
948
+ end
949
+
950
+ # @!attribute [rw] next_token
951
+ # A value that indicates the starting point for the next set of
952
+ # response records in a subsequent request. If a value is returned in
953
+ # a response, you can retrieve the next set of records by providing
954
+ # this returned NextToken value in the next NextToken parameter and
955
+ # retrying the command. If the NextToken field is empty, all response
956
+ # records have been retrieved for the request.
957
+ # @return [String]
958
+ #
959
+ # @!attribute [rw] tables
960
+ # The tables that match the request pattern.
961
+ # @return [Array<Types::TableMember>]
962
+ #
963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTablesResponse AWS API Documentation
964
+ #
965
+ class ListTablesResponse < Struct.new(
966
+ :next_token,
967
+ :tables)
968
+ SENSITIVE = []
969
+ include Aws::Structure
970
+ end
971
+
972
+ # The Amazon Redshift Data API operation failed due to a missing
973
+ # resource.
974
+ #
975
+ # @!attribute [rw] message
976
+ # The exception message.
977
+ # @return [String]
978
+ #
979
+ # @!attribute [rw] resource_id
980
+ # Resource identifier associated with the exception.
981
+ # @return [String]
982
+ #
983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ResourceNotFoundException AWS API Documentation
984
+ #
985
+ class ResourceNotFoundException < Struct.new(
986
+ :message,
987
+ :resource_id)
988
+ SENSITIVE = []
989
+ include Aws::Structure
990
+ end
991
+
992
+ # The SQL statement to run.
993
+ #
994
+ # @!attribute [rw] created_at
995
+ # The date and time (UTC) the statement was created.
996
+ # @return [Time]
997
+ #
998
+ # @!attribute [rw] id
999
+ # The SQL statement identifier. This value is a universally unique
1000
+ # identifier (UUID) generated by Amazon Redshift Data API.
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] query_string
1004
+ # The SQL statement.
1005
+ # @return [String]
1006
+ #
1007
+ # @!attribute [rw] secret_arn
1008
+ # The name or Amazon Resource Name (ARN) of the secret that enables
1009
+ # access to the database.
1010
+ # @return [String]
1011
+ #
1012
+ # @!attribute [rw] statement_name
1013
+ # The name of the SQL statement.
1014
+ # @return [String]
1015
+ #
1016
+ # @!attribute [rw] status
1017
+ # The status of the SQL statement. An example is the that the SQL
1018
+ # statement finished.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] updated_at
1022
+ # The date and time (UTC) that the statement metadata was last
1023
+ # updated.
1024
+ # @return [Time]
1025
+ #
1026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/StatementData AWS API Documentation
1027
+ #
1028
+ class StatementData < Struct.new(
1029
+ :created_at,
1030
+ :id,
1031
+ :query_string,
1032
+ :secret_arn,
1033
+ :statement_name,
1034
+ :status,
1035
+ :updated_at)
1036
+ SENSITIVE = []
1037
+ include Aws::Structure
1038
+ end
1039
+
1040
+ # The properties of a table.
1041
+ #
1042
+ # @!attribute [rw] name
1043
+ # The name of the table.
1044
+ # @return [String]
1045
+ #
1046
+ # @!attribute [rw] schema
1047
+ # The schema containing the table.
1048
+ # @return [String]
1049
+ #
1050
+ # @!attribute [rw] type
1051
+ # The type of the table. Possible values include TABLE, VIEW, SYSTEM
1052
+ # TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.
1053
+ # @return [String]
1054
+ #
1055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/TableMember AWS API Documentation
1056
+ #
1057
+ class TableMember < Struct.new(
1058
+ :name,
1059
+ :schema,
1060
+ :type)
1061
+ SENSITIVE = []
1062
+ include Aws::Structure
1063
+ end
1064
+
1065
+ # The Amazon Redshift Data API operation failed due to invalid input.
1066
+ #
1067
+ # @!attribute [rw] message
1068
+ # The exception message.
1069
+ # @return [String]
1070
+ #
1071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ValidationException AWS API Documentation
1072
+ #
1073
+ class ValidationException < Struct.new(
1074
+ :message)
1075
+ SENSITIVE = []
1076
+ include Aws::Structure
1077
+ end
1078
+
1079
+ end
1080
+ end