aws-sdk-redshiftdataapiservice 1.4.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -14,6 +14,9 @@ module Aws::RedshiftDataAPIService
14
14
  include Seahorse::Model
15
15
 
16
16
  ActiveStatementsExceededException = Shapes::StructureShape.new(name: 'ActiveStatementsExceededException')
17
+ BatchExecuteStatementException = Shapes::StructureShape.new(name: 'BatchExecuteStatementException')
18
+ BatchExecuteStatementInput = Shapes::StructureShape.new(name: 'BatchExecuteStatementInput')
19
+ BatchExecuteStatementOutput = Shapes::StructureShape.new(name: 'BatchExecuteStatementOutput')
17
20
  Blob = Shapes::BlobShape.new(name: 'Blob')
18
21
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
19
22
  BoxedBoolean = Shapes::BooleanShape.new(name: 'BoxedBoolean')
@@ -50,27 +53,57 @@ module Aws::RedshiftDataAPIService
50
53
  Location = Shapes::StringShape.new(name: 'Location')
51
54
  Long = Shapes::IntegerShape.new(name: 'Long')
52
55
  PageSize = Shapes::IntegerShape.new(name: 'PageSize')
56
+ ParameterName = Shapes::StringShape.new(name: 'ParameterName')
57
+ ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
53
58
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
54
59
  SchemaList = Shapes::ListShape.new(name: 'SchemaList')
55
60
  SecretArn = Shapes::StringShape.new(name: 'SecretArn')
61
+ SqlList = Shapes::ListShape.new(name: 'SqlList')
62
+ SqlParameter = Shapes::StructureShape.new(name: 'SqlParameter')
63
+ SqlParametersList = Shapes::ListShape.new(name: 'SqlParametersList')
56
64
  SqlRecords = Shapes::ListShape.new(name: 'SqlRecords')
57
65
  StatementData = Shapes::StructureShape.new(name: 'StatementData')
66
+ StatementId = Shapes::StringShape.new(name: 'StatementId')
58
67
  StatementList = Shapes::ListShape.new(name: 'StatementList')
59
68
  StatementNameString = Shapes::StringShape.new(name: 'StatementNameString')
69
+ StatementStatusString = Shapes::StringShape.new(name: 'StatementStatusString')
60
70
  StatementString = Shapes::StringShape.new(name: 'StatementString')
71
+ StatementStringList = Shapes::ListShape.new(name: 'StatementStringList')
61
72
  StatusString = Shapes::StringShape.new(name: 'StatusString')
62
73
  String = Shapes::StringShape.new(name: 'String')
74
+ SubStatementData = Shapes::StructureShape.new(name: 'SubStatementData')
75
+ SubStatementList = Shapes::ListShape.new(name: 'SubStatementList')
63
76
  TableList = Shapes::ListShape.new(name: 'TableList')
64
77
  TableMember = Shapes::StructureShape.new(name: 'TableMember')
65
78
  Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
66
- UUID = Shapes::StringShape.new(name: 'UUID')
67
79
  ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
68
80
  bool = Shapes::BooleanShape.new(name: 'bool')
69
81
 
70
82
  ActiveStatementsExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
71
83
  ActiveStatementsExceededException.struct_class = Types::ActiveStatementsExceededException
72
84
 
73
- CancelStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
85
+ BatchExecuteStatementException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Message"))
86
+ BatchExecuteStatementException.add_member(:statement_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "StatementId"))
87
+ BatchExecuteStatementException.struct_class = Types::BatchExecuteStatementException
88
+
89
+ BatchExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, required: true, location_name: "ClusterIdentifier"))
90
+ BatchExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
91
+ BatchExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
92
+ BatchExecuteStatementInput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
93
+ BatchExecuteStatementInput.add_member(:sqls, Shapes::ShapeRef.new(shape: SqlList, required: true, location_name: "Sqls"))
94
+ BatchExecuteStatementInput.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName"))
95
+ BatchExecuteStatementInput.add_member(:with_event, Shapes::ShapeRef.new(shape: Boolean, location_name: "WithEvent"))
96
+ BatchExecuteStatementInput.struct_class = Types::BatchExecuteStatementInput
97
+
98
+ BatchExecuteStatementOutput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, location_name: "ClusterIdentifier"))
99
+ BatchExecuteStatementOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
100
+ BatchExecuteStatementOutput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
101
+ BatchExecuteStatementOutput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
102
+ BatchExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, location_name: "Id"))
103
+ BatchExecuteStatementOutput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
104
+ BatchExecuteStatementOutput.struct_class = Types::BatchExecuteStatementOutput
105
+
106
+ CancelStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id"))
74
107
  CancelStatementRequest.struct_class = Types::CancelStatementRequest
75
108
 
76
109
  CancelStatementResponse.add_member(:status, Shapes::ShapeRef.new(shape: Boolean, location_name: "Status"))
@@ -97,7 +130,7 @@ module Aws::RedshiftDataAPIService
97
130
 
98
131
  DatabaseList.member = Shapes::ShapeRef.new(shape: String)
99
132
 
100
- DescribeStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
133
+ DescribeStatementRequest.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id"))
101
134
  DescribeStatementRequest.struct_class = Types::DescribeStatementRequest
102
135
 
103
136
  DescribeStatementResponse.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ClusterIdentifier"))
@@ -107,7 +140,8 @@ module Aws::RedshiftDataAPIService
107
140
  DescribeStatementResponse.add_member(:duration, Shapes::ShapeRef.new(shape: Long, location_name: "Duration"))
108
141
  DescribeStatementResponse.add_member(:error, Shapes::ShapeRef.new(shape: String, location_name: "Error"))
109
142
  DescribeStatementResponse.add_member(:has_result_set, Shapes::ShapeRef.new(shape: Boolean, location_name: "HasResultSet"))
110
- DescribeStatementResponse.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
143
+ DescribeStatementResponse.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id"))
144
+ DescribeStatementResponse.add_member(:query_parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "QueryParameters"))
111
145
  DescribeStatementResponse.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString"))
112
146
  DescribeStatementResponse.add_member(:redshift_pid, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftPid"))
113
147
  DescribeStatementResponse.add_member(:redshift_query_id, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftQueryId"))
@@ -115,11 +149,13 @@ module Aws::RedshiftDataAPIService
115
149
  DescribeStatementResponse.add_member(:result_size, Shapes::ShapeRef.new(shape: Long, location_name: "ResultSize"))
116
150
  DescribeStatementResponse.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
117
151
  DescribeStatementResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusString, location_name: "Status"))
152
+ DescribeStatementResponse.add_member(:sub_statements, Shapes::ShapeRef.new(shape: SubStatementList, location_name: "SubStatements"))
118
153
  DescribeStatementResponse.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
119
154
  DescribeStatementResponse.struct_class = Types::DescribeStatementResponse
120
155
 
121
156
  DescribeTableRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, required: true, location_name: "ClusterIdentifier"))
122
- DescribeTableRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
157
+ DescribeTableRequest.add_member(:connected_database, Shapes::ShapeRef.new(shape: String, location_name: "ConnectedDatabase"))
158
+ DescribeTableRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
123
159
  DescribeTableRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
124
160
  DescribeTableRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PageSize, location_name: "MaxResults"))
125
161
  DescribeTableRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
@@ -138,8 +174,9 @@ module Aws::RedshiftDataAPIService
138
174
  ExecuteStatementException.struct_class = Types::ExecuteStatementException
139
175
 
140
176
  ExecuteStatementInput.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, required: true, location_name: "ClusterIdentifier"))
141
- ExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
177
+ ExecuteStatementInput.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
142
178
  ExecuteStatementInput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
179
+ ExecuteStatementInput.add_member(:parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "Parameters"))
143
180
  ExecuteStatementInput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
144
181
  ExecuteStatementInput.add_member(:sql, Shapes::ShapeRef.new(shape: StatementString, required: true, location_name: "Sql"))
145
182
  ExecuteStatementInput.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName"))
@@ -150,7 +187,7 @@ module Aws::RedshiftDataAPIService
150
187
  ExecuteStatementOutput.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
151
188
  ExecuteStatementOutput.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
152
189
  ExecuteStatementOutput.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
153
- ExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "Id"))
190
+ ExecuteStatementOutput.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, location_name: "Id"))
154
191
  ExecuteStatementOutput.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
155
192
  ExecuteStatementOutput.struct_class = Types::ExecuteStatementOutput
156
193
 
@@ -164,7 +201,7 @@ module Aws::RedshiftDataAPIService
164
201
 
165
202
  FieldList.member = Shapes::ShapeRef.new(shape: Field)
166
203
 
167
- GetStatementResultRequest.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
204
+ GetStatementResultRequest.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id"))
168
205
  GetStatementResultRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
169
206
  GetStatementResultRequest.struct_class = Types::GetStatementResultRequest
170
207
 
@@ -178,7 +215,7 @@ module Aws::RedshiftDataAPIService
178
215
  InternalServerException.struct_class = Types::InternalServerException
179
216
 
180
217
  ListDatabasesRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, required: true, location_name: "ClusterIdentifier"))
181
- ListDatabasesRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, location_name: "Database"))
218
+ ListDatabasesRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
182
219
  ListDatabasesRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
183
220
  ListDatabasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PageSize, location_name: "MaxResults"))
184
221
  ListDatabasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
@@ -190,6 +227,7 @@ module Aws::RedshiftDataAPIService
190
227
  ListDatabasesResponse.struct_class = Types::ListDatabasesResponse
191
228
 
192
229
  ListSchemasRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, required: true, location_name: "ClusterIdentifier"))
230
+ ListSchemasRequest.add_member(:connected_database, Shapes::ShapeRef.new(shape: String, location_name: "ConnectedDatabase"))
193
231
  ListSchemasRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
194
232
  ListSchemasRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
195
233
  ListSchemasRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PageSize, location_name: "MaxResults"))
@@ -214,6 +252,7 @@ module Aws::RedshiftDataAPIService
214
252
  ListStatementsResponse.struct_class = Types::ListStatementsResponse
215
253
 
216
254
  ListTablesRequest.add_member(:cluster_identifier, Shapes::ShapeRef.new(shape: Location, required: true, location_name: "ClusterIdentifier"))
255
+ ListTablesRequest.add_member(:connected_database, Shapes::ShapeRef.new(shape: String, location_name: "ConnectedDatabase"))
217
256
  ListTablesRequest.add_member(:database, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Database"))
218
257
  ListTablesRequest.add_member(:db_user, Shapes::ShapeRef.new(shape: String, location_name: "DbUser"))
219
258
  ListTablesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PageSize, location_name: "MaxResults"))
@@ -233,11 +272,22 @@ module Aws::RedshiftDataAPIService
233
272
 
234
273
  SchemaList.member = Shapes::ShapeRef.new(shape: String)
235
274
 
275
+ SqlList.member = Shapes::ShapeRef.new(shape: StatementString)
276
+
277
+ SqlParameter.add_member(:name, Shapes::ShapeRef.new(shape: ParameterName, required: true, location_name: "name"))
278
+ SqlParameter.add_member(:value, Shapes::ShapeRef.new(shape: ParameterValue, required: true, location_name: "value"))
279
+ SqlParameter.struct_class = Types::SqlParameter
280
+
281
+ SqlParametersList.member = Shapes::ShapeRef.new(shape: SqlParameter)
282
+
236
283
  SqlRecords.member = Shapes::ShapeRef.new(shape: FieldList)
237
284
 
238
285
  StatementData.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
239
- StatementData.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "Id"))
286
+ StatementData.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id"))
287
+ StatementData.add_member(:is_batch_statement, Shapes::ShapeRef.new(shape: Boolean, location_name: "IsBatchStatement"))
288
+ StatementData.add_member(:query_parameters, Shapes::ShapeRef.new(shape: SqlParametersList, location_name: "QueryParameters"))
240
289
  StatementData.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString"))
290
+ StatementData.add_member(:query_strings, Shapes::ShapeRef.new(shape: StatementStringList, location_name: "QueryStrings"))
241
291
  StatementData.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
242
292
  StatementData.add_member(:statement_name, Shapes::ShapeRef.new(shape: StatementNameString, location_name: "StatementName"))
243
293
  StatementData.add_member(:status, Shapes::ShapeRef.new(shape: StatusString, location_name: "Status"))
@@ -246,6 +296,23 @@ module Aws::RedshiftDataAPIService
246
296
 
247
297
  StatementList.member = Shapes::ShapeRef.new(shape: StatementData)
248
298
 
299
+ StatementStringList.member = Shapes::ShapeRef.new(shape: StatementString)
300
+
301
+ SubStatementData.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
302
+ SubStatementData.add_member(:duration, Shapes::ShapeRef.new(shape: Long, location_name: "Duration"))
303
+ SubStatementData.add_member(:error, Shapes::ShapeRef.new(shape: String, location_name: "Error"))
304
+ SubStatementData.add_member(:has_result_set, Shapes::ShapeRef.new(shape: Boolean, location_name: "HasResultSet"))
305
+ SubStatementData.add_member(:id, Shapes::ShapeRef.new(shape: StatementId, required: true, location_name: "Id"))
306
+ SubStatementData.add_member(:query_string, Shapes::ShapeRef.new(shape: StatementString, location_name: "QueryString"))
307
+ SubStatementData.add_member(:redshift_query_id, Shapes::ShapeRef.new(shape: Long, location_name: "RedshiftQueryId"))
308
+ SubStatementData.add_member(:result_rows, Shapes::ShapeRef.new(shape: Long, location_name: "ResultRows"))
309
+ SubStatementData.add_member(:result_size, Shapes::ShapeRef.new(shape: Long, location_name: "ResultSize"))
310
+ SubStatementData.add_member(:status, Shapes::ShapeRef.new(shape: StatementStatusString, location_name: "Status"))
311
+ SubStatementData.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
312
+ SubStatementData.struct_class = Types::SubStatementData
313
+
314
+ SubStatementList.member = Shapes::ShapeRef.new(shape: SubStatementData)
315
+
249
316
  TableList.member = Shapes::ShapeRef.new(shape: TableMember)
250
317
 
251
318
  TableMember.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
@@ -275,12 +342,24 @@ module Aws::RedshiftDataAPIService
275
342
  "uid" => "redshift-data-2019-12-20",
276
343
  }
277
344
 
345
+ api.add_operation(:batch_execute_statement, Seahorse::Model::Operation.new.tap do |o|
346
+ o.name = "BatchExecuteStatement"
347
+ o.http_method = "POST"
348
+ o.http_request_uri = "/"
349
+ o.input = Shapes::ShapeRef.new(shape: BatchExecuteStatementInput)
350
+ o.output = Shapes::ShapeRef.new(shape: BatchExecuteStatementOutput)
351
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
352
+ o.errors << Shapes::ShapeRef.new(shape: ActiveStatementsExceededException)
353
+ o.errors << Shapes::ShapeRef.new(shape: BatchExecuteStatementException)
354
+ end)
355
+
278
356
  api.add_operation(:cancel_statement, Seahorse::Model::Operation.new.tap do |o|
279
357
  o.name = "CancelStatement"
280
358
  o.http_method = "POST"
281
359
  o.http_request_uri = "/"
282
360
  o.input = Shapes::ShapeRef.new(shape: CancelStatementRequest)
283
361
  o.output = Shapes::ShapeRef.new(shape: CancelStatementResponse)
362
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
284
363
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
285
364
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
286
365
  end)
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -28,6 +28,7 @@ module Aws::RedshiftDataAPIService
28
28
  #
29
29
  # ## Error Classes
30
30
  # * {ActiveStatementsExceededException}
31
+ # * {BatchExecuteStatementException}
31
32
  # * {ExecuteStatementException}
32
33
  # * {InternalServerException}
33
34
  # * {ResourceNotFoundException}
@@ -54,6 +55,26 @@ module Aws::RedshiftDataAPIService
54
55
  end
55
56
  end
56
57
 
58
+ class BatchExecuteStatementException < ServiceError
59
+
60
+ # @param [Seahorse::Client::RequestContext] context
61
+ # @param [String] message
62
+ # @param [Aws::RedshiftDataAPIService::Types::BatchExecuteStatementException] data
63
+ def initialize(context, message, data = Aws::EmptyStructure.new)
64
+ super(context, message, data)
65
+ end
66
+
67
+ # @return [String]
68
+ def message
69
+ @message || @data[:message]
70
+ end
71
+
72
+ # @return [String]
73
+ def statement_id
74
+ @data[:statement_id]
75
+ end
76
+ end
77
+
57
78
  class ExecuteStatementException < ServiceError
58
79
 
59
80
  # @param [Seahorse::Client::RequestContext] context
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -23,18 +23,140 @@ module Aws::RedshiftDataAPIService
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # An SQL statement encountered an environmental error while running.
27
+ #
28
+ # @!attribute [rw] message
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] statement_id
32
+ # Statement identifier of the exception.
33
+ # @return [String]
34
+ #
35
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementException AWS API Documentation
36
+ #
37
+ class BatchExecuteStatementException < Struct.new(
38
+ :message,
39
+ :statement_id)
40
+ SENSITIVE = []
41
+ include Aws::Structure
42
+ end
43
+
44
+ # @note When making an API call, you may pass BatchExecuteStatementInput
45
+ # data as a hash:
46
+ #
47
+ # {
48
+ # cluster_identifier: "Location", # required
49
+ # database: "String", # required
50
+ # db_user: "String",
51
+ # secret_arn: "SecretArn",
52
+ # sqls: ["StatementString"], # required
53
+ # statement_name: "StatementNameString",
54
+ # with_event: false,
55
+ # }
56
+ #
57
+ # @!attribute [rw] cluster_identifier
58
+ # The cluster identifier. This parameter is required when
59
+ # authenticating using either Secrets Manager or temporary
60
+ # credentials.
61
+ # @return [String]
62
+ #
63
+ # @!attribute [rw] database
64
+ # The name of the database. This parameter is required when
65
+ # authenticating using either Secrets Manager or temporary
66
+ # credentials.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] db_user
70
+ # The database user name. This parameter is required when
71
+ # authenticating using temporary credentials.
72
+ # @return [String]
73
+ #
74
+ # @!attribute [rw] secret_arn
75
+ # The name or ARN of the secret that enables access to the database.
76
+ # This parameter is required when authenticating using Secrets
77
+ # Manager.
78
+ # @return [String]
79
+ #
80
+ # @!attribute [rw] sqls
81
+ # One or more SQL statements to run.
82
+ # @return [Array<String>]
83
+ #
84
+ # @!attribute [rw] statement_name
85
+ # The name of the SQL statements. You can name the SQL statements when
86
+ # you create them to identify the query.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] with_event
90
+ # A value that indicates whether to send an event to the Amazon
91
+ # EventBridge event bus after the SQL statements run.
92
+ # @return [Boolean]
93
+ #
94
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementInput AWS API Documentation
95
+ #
96
+ class BatchExecuteStatementInput < Struct.new(
97
+ :cluster_identifier,
98
+ :database,
99
+ :db_user,
100
+ :secret_arn,
101
+ :sqls,
102
+ :statement_name,
103
+ :with_event)
104
+ SENSITIVE = []
105
+ include Aws::Structure
106
+ end
107
+
108
+ # @!attribute [rw] cluster_identifier
109
+ # The cluster identifier.
110
+ # @return [String]
111
+ #
112
+ # @!attribute [rw] created_at
113
+ # The date and time (UTC) the statement was created.
114
+ # @return [Time]
115
+ #
116
+ # @!attribute [rw] database
117
+ # The name of the database.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] db_user
121
+ # The database user name.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] id
125
+ # The identifier of the SQL statement whose results are to be fetched.
126
+ # This value is a universally unique identifier (UUID) generated by
127
+ # Amazon Redshift Data API. This identifier is returned by
128
+ # `BatchExecuteStatment`.
129
+ # @return [String]
130
+ #
131
+ # @!attribute [rw] secret_arn
132
+ # The name or ARN of the secret that enables access to the database.
133
+ # @return [String]
134
+ #
135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/BatchExecuteStatementOutput AWS API Documentation
136
+ #
137
+ class BatchExecuteStatementOutput < Struct.new(
138
+ :cluster_identifier,
139
+ :created_at,
140
+ :database,
141
+ :db_user,
142
+ :id,
143
+ :secret_arn)
144
+ SENSITIVE = []
145
+ include Aws::Structure
146
+ end
147
+
26
148
  # @note When making an API call, you may pass CancelStatementRequest
27
149
  # data as a hash:
28
150
  #
29
151
  # {
30
- # id: "UUID", # required
152
+ # id: "StatementId", # required
31
153
  # }
32
154
  #
33
155
  # @!attribute [rw] id
34
156
  # The identifier of the SQL statement to cancel. This value is a
35
157
  # universally unique identifier (UUID) generated by Amazon Redshift
36
- # Data API. This identifier is returned by `ExecuteStatment` and
37
- # `ListStatements`.
158
+ # Data API. This identifier is returned by `BatchExecuteStatment`,
159
+ # `ExecuteStatment`, and `ListStatements`.
38
160
  # @return [String]
39
161
  #
40
162
  # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/CancelStatementRequest AWS API Documentation
@@ -137,14 +259,17 @@ module Aws::RedshiftDataAPIService
137
259
  # data as a hash:
138
260
  #
139
261
  # {
140
- # id: "UUID", # required
262
+ # id: "StatementId", # required
141
263
  # }
142
264
  #
143
265
  # @!attribute [rw] id
144
266
  # The identifier of the SQL statement to describe. This value is a
145
267
  # universally unique identifier (UUID) generated by Amazon Redshift
146
- # Data API. This identifier is returned by `ExecuteStatment` and
147
- # `ListStatements`.
268
+ # Data API. A suffix indicates the number of the SQL statement. For
269
+ # example, `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of
270
+ # `:2` that indicates the second SQL statement of a batch query. This
271
+ # identifier is returned by `BatchExecuteStatment`,
272
+ # `ExecuteStatement`, and `ListStatements`.
148
273
  # @return [String]
149
274
  #
150
275
  # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeStatementRequest AWS API Documentation
@@ -191,6 +316,10 @@ module Aws::RedshiftDataAPIService
191
316
  # Data API.
192
317
  # @return [String]
193
318
  #
319
+ # @!attribute [rw] query_parameters
320
+ # The parameters for the SQL statement.
321
+ # @return [Array<Types::SqlParameter>]
322
+ #
194
323
  # @!attribute [rw] query_string
195
324
  # The SQL statement text.
196
325
  # @return [String]
@@ -209,11 +338,13 @@ module Aws::RedshiftDataAPIService
209
338
  # Either the number of rows returned from the SQL statement or the
210
339
  # number of rows affected. If result size is greater than zero, the
211
340
  # result rows can be the number of rows affected by SQL statements
212
- # such as INSERT, UPDATE, DELETE, COPY, and others.
341
+ # such as INSERT, UPDATE, DELETE, COPY, and others. A `-1` indicates
342
+ # the value is null.
213
343
  # @return [Integer]
214
344
  #
215
345
  # @!attribute [rw] result_size
216
- # The size in bytes of the returned results.
346
+ # The size in bytes of the returned results. A `-1` indicates the
347
+ # value is null.
217
348
  # @return [Integer]
218
349
  #
219
350
  # @!attribute [rw] secret_arn
@@ -241,6 +372,10 @@ module Aws::RedshiftDataAPIService
241
372
  # * SUBMITTED - The query was submitted, but not yet processed.
242
373
  # @return [String]
243
374
  #
375
+ # @!attribute [rw] sub_statements
376
+ # The SQL statements from a multiple statement run.
377
+ # @return [Array<Types::SubStatementData>]
378
+ #
244
379
  # @!attribute [rw] updated_at
245
380
  # The date and time (UTC) that the metadata for the SQL statement was
246
381
  # last updated. An example is the time the status last changed.
@@ -257,6 +392,7 @@ module Aws::RedshiftDataAPIService
257
392
  :error,
258
393
  :has_result_set,
259
394
  :id,
395
+ :query_parameters,
260
396
  :query_string,
261
397
  :redshift_pid,
262
398
  :redshift_query_id,
@@ -264,6 +400,7 @@ module Aws::RedshiftDataAPIService
264
400
  :result_size,
265
401
  :secret_arn,
266
402
  :status,
403
+ :sub_statements,
267
404
  :updated_at)
268
405
  SENSITIVE = []
269
406
  include Aws::Structure
@@ -274,7 +411,8 @@ module Aws::RedshiftDataAPIService
274
411
  #
275
412
  # {
276
413
  # cluster_identifier: "Location", # required
277
- # database: "String",
414
+ # connected_database: "String",
415
+ # database: "String", # required
278
416
  # db_user: "String",
279
417
  # max_results: 1,
280
418
  # next_token: "String",
@@ -285,13 +423,19 @@ module Aws::RedshiftDataAPIService
285
423
  #
286
424
  # @!attribute [rw] cluster_identifier
287
425
  # The cluster identifier. This parameter is required when
288
- # authenticating using either AWS Secrets Manager or temporary
426
+ # authenticating using either Secrets Manager or temporary
289
427
  # credentials.
290
428
  # @return [String]
291
429
  #
430
+ # @!attribute [rw] connected_database
431
+ # A database name. The connected database is specified when you
432
+ # connect with your authentication credentials.
433
+ # @return [String]
434
+ #
292
435
  # @!attribute [rw] database
293
- # The name of the database. This parameter is required when
294
- # authenticating using temporary credentials.
436
+ # The name of the database that contains the tables to be described.
437
+ # If `ConnectedDatabase` is not specified, this is also the database
438
+ # to connect to with your authentication credentials.
295
439
  # @return [String]
296
440
  #
297
441
  # @!attribute [rw] db_user
@@ -321,7 +465,7 @@ module Aws::RedshiftDataAPIService
321
465
  #
322
466
  # @!attribute [rw] secret_arn
323
467
  # The name or ARN of the secret that enables access to the database.
324
- # This parameter is required when authenticating using AWS Secrets
468
+ # This parameter is required when authenticating using Secrets
325
469
  # Manager.
326
470
  # @return [String]
327
471
  #
@@ -336,6 +480,7 @@ module Aws::RedshiftDataAPIService
336
480
  #
337
481
  class DescribeTableRequest < Struct.new(
338
482
  :cluster_identifier,
483
+ :connected_database,
339
484
  :database,
340
485
  :db_user,
341
486
  :max_results,
@@ -398,8 +543,14 @@ module Aws::RedshiftDataAPIService
398
543
  #
399
544
  # {
400
545
  # cluster_identifier: "Location", # required
401
- # database: "String",
546
+ # database: "String", # required
402
547
  # db_user: "String",
548
+ # parameters: [
549
+ # {
550
+ # name: "ParameterName", # required
551
+ # value: "ParameterValue", # required
552
+ # },
553
+ # ],
403
554
  # secret_arn: "SecretArn",
404
555
  # sql: "StatementString", # required
405
556
  # statement_name: "StatementNameString",
@@ -408,13 +559,14 @@ module Aws::RedshiftDataAPIService
408
559
  #
409
560
  # @!attribute [rw] cluster_identifier
410
561
  # The cluster identifier. This parameter is required when
411
- # authenticating using either AWS Secrets Manager or temporary
562
+ # authenticating using either Secrets Manager or temporary
412
563
  # credentials.
413
564
  # @return [String]
414
565
  #
415
566
  # @!attribute [rw] database
416
567
  # The name of the database. This parameter is required when
417
- # authenticating using temporary credentials.
568
+ # authenticating using either Secrets Manager or temporary
569
+ # credentials.
418
570
  # @return [String]
419
571
  #
420
572
  # @!attribute [rw] db_user
@@ -422,9 +574,13 @@ module Aws::RedshiftDataAPIService
422
574
  # authenticating using temporary credentials.
423
575
  # @return [String]
424
576
  #
577
+ # @!attribute [rw] parameters
578
+ # The parameters for the SQL statement.
579
+ # @return [Array<Types::SqlParameter>]
580
+ #
425
581
  # @!attribute [rw] secret_arn
426
582
  # The name or ARN of the secret that enables access to the database.
427
- # This parameter is required when authenticating using AWS Secrets
583
+ # This parameter is required when authenticating using Secrets
428
584
  # Manager.
429
585
  # @return [String]
430
586
  #
@@ -448,6 +604,7 @@ module Aws::RedshiftDataAPIService
448
604
  :cluster_identifier,
449
605
  :database,
450
606
  :db_user,
607
+ :parameters,
451
608
  :secret_arn,
452
609
  :sql,
453
610
  :statement_name,
@@ -473,9 +630,9 @@ module Aws::RedshiftDataAPIService
473
630
  # @return [String]
474
631
  #
475
632
  # @!attribute [rw] id
476
- # The identifier of the statement to be run. This value is a
477
- # universally unique identifier (UUID) generated by Amazon Redshift
478
- # Data API.
633
+ # The identifier of the SQL statement whose results are to be fetched.
634
+ # This value is a universally unique identifier (UUID) generated by
635
+ # Amazon Redshift Data API.
479
636
  # @return [String]
480
637
  #
481
638
  # @!attribute [rw] secret_arn
@@ -538,15 +695,18 @@ module Aws::RedshiftDataAPIService
538
695
  # data as a hash:
539
696
  #
540
697
  # {
541
- # id: "UUID", # required
698
+ # id: "StatementId", # required
542
699
  # next_token: "String",
543
700
  # }
544
701
  #
545
702
  # @!attribute [rw] id
546
703
  # The identifier of the SQL statement whose results are to be fetched.
547
704
  # This value is a universally unique identifier (UUID) generated by
548
- # Amazon Redshift Data API. This identifier is returned by
549
- # `ExecuteStatment` and `ListStatements`.
705
+ # Amazon Redshift Data API. A suffix indicates then number of the SQL
706
+ # statement. For example, `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has
707
+ # a suffix of `:2` that indicates the second SQL statement of a batch
708
+ # query. This identifier is returned by `BatchExecuteStatment`,
709
+ # `ExecuteStatment`, and `ListStatements`.
550
710
  # @return [String]
551
711
  #
552
712
  # @!attribute [rw] next_token
@@ -620,7 +780,7 @@ module Aws::RedshiftDataAPIService
620
780
  #
621
781
  # {
622
782
  # cluster_identifier: "Location", # required
623
- # database: "String",
783
+ # database: "String", # required
624
784
  # db_user: "String",
625
785
  # max_results: 1,
626
786
  # next_token: "String",
@@ -629,13 +789,14 @@ module Aws::RedshiftDataAPIService
629
789
  #
630
790
  # @!attribute [rw] cluster_identifier
631
791
  # The cluster identifier. This parameter is required when
632
- # authenticating using either AWS Secrets Manager or temporary
792
+ # authenticating using either Secrets Manager or temporary
633
793
  # credentials.
634
794
  # @return [String]
635
795
  #
636
796
  # @!attribute [rw] database
637
797
  # The name of the database. This parameter is required when
638
- # authenticating using temporary credentials.
798
+ # authenticating using either Secrets Manager or temporary
799
+ # credentials.
639
800
  # @return [String]
640
801
  #
641
802
  # @!attribute [rw] db_user
@@ -660,7 +821,7 @@ module Aws::RedshiftDataAPIService
660
821
  #
661
822
  # @!attribute [rw] secret_arn
662
823
  # The name or ARN of the secret that enables access to the database.
663
- # This parameter is required when authenticating using AWS Secrets
824
+ # This parameter is required when authenticating using Secrets
664
825
  # Manager.
665
826
  # @return [String]
666
827
  #
@@ -704,6 +865,7 @@ module Aws::RedshiftDataAPIService
704
865
  #
705
866
  # {
706
867
  # cluster_identifier: "Location", # required
868
+ # connected_database: "String",
707
869
  # database: "String", # required
708
870
  # db_user: "String",
709
871
  # max_results: 1,
@@ -714,13 +876,19 @@ module Aws::RedshiftDataAPIService
714
876
  #
715
877
  # @!attribute [rw] cluster_identifier
716
878
  # The cluster identifier. This parameter is required when
717
- # authenticating using either AWS Secrets Manager or temporary
879
+ # authenticating using either Secrets Manager or temporary
718
880
  # credentials.
719
881
  # @return [String]
720
882
  #
883
+ # @!attribute [rw] connected_database
884
+ # A database name. The connected database is specified when you
885
+ # connect with your authentication credentials.
886
+ # @return [String]
887
+ #
721
888
  # @!attribute [rw] database
722
- # The name of the database. This parameter is required when
723
- # authenticating using temporary credentials.
889
+ # The name of the database that contains the schemas to list. If
890
+ # `ConnectedDatabase` is not specified, this is also the database to
891
+ # connect to with your authentication credentials.
724
892
  # @return [String]
725
893
  #
726
894
  # @!attribute [rw] db_user
@@ -752,7 +920,7 @@ module Aws::RedshiftDataAPIService
752
920
  #
753
921
  # @!attribute [rw] secret_arn
754
922
  # The name or ARN of the secret that enables access to the database.
755
- # This parameter is required when authenticating using AWS Secrets
923
+ # This parameter is required when authenticating using Secrets
756
924
  # Manager.
757
925
  # @return [String]
758
926
  #
@@ -760,6 +928,7 @@ module Aws::RedshiftDataAPIService
760
928
  #
761
929
  class ListSchemasRequest < Struct.new(
762
930
  :cluster_identifier,
931
+ :connected_database,
763
932
  :database,
764
933
  :db_user,
765
934
  :max_results,
@@ -827,12 +996,12 @@ module Aws::RedshiftDataAPIService
827
996
  #
828
997
  # @!attribute [rw] statement_name
829
998
  # The name of the SQL statement specified as input to
830
- # `ExecuteStatement` to identify the query. You can list multiple
831
- # statements by providing a prefix that matches the beginning of the
832
- # statement name. For example, to list myStatement1, myStatement2,
833
- # myStatement3, and so on, then provide the a value of `myStatement`.
834
- # Data API does a case-sensitive match of SQL statement names to the
835
- # prefix value you provide.
999
+ # `BatchExecuteStatement` or `ExecuteStatement` to identify the query.
1000
+ # You can list multiple statements by providing a prefix that matches
1001
+ # the beginning of the statement name. For example, to list
1002
+ # myStatement1, myStatement2, myStatement3, and so on, then provide
1003
+ # the a value of `myStatement`. Data API does a case-sensitive match
1004
+ # of SQL statement names to the prefix value you provide.
836
1005
  # @return [String]
837
1006
  #
838
1007
  # @!attribute [rw] status
@@ -894,6 +1063,7 @@ module Aws::RedshiftDataAPIService
894
1063
  #
895
1064
  # {
896
1065
  # cluster_identifier: "Location", # required
1066
+ # connected_database: "String",
897
1067
  # database: "String", # required
898
1068
  # db_user: "String",
899
1069
  # max_results: 1,
@@ -905,13 +1075,19 @@ module Aws::RedshiftDataAPIService
905
1075
  #
906
1076
  # @!attribute [rw] cluster_identifier
907
1077
  # The cluster identifier. This parameter is required when
908
- # authenticating using either AWS Secrets Manager or temporary
1078
+ # authenticating using either Secrets Manager or temporary
909
1079
  # credentials.
910
1080
  # @return [String]
911
1081
  #
1082
+ # @!attribute [rw] connected_database
1083
+ # A database name. The connected database is specified when you
1084
+ # connect with your authentication credentials.
1085
+ # @return [String]
1086
+ #
912
1087
  # @!attribute [rw] database
913
- # The name of the database. This parameter is required when
914
- # authenticating using temporary credentials.
1088
+ # The name of the database that contains the tables to list. If
1089
+ # `ConnectedDatabase` is not specified, this is also the database to
1090
+ # connect to with your authentication credentials.
915
1091
  # @return [String]
916
1092
  #
917
1093
  # @!attribute [rw] db_user
@@ -946,7 +1122,7 @@ module Aws::RedshiftDataAPIService
946
1122
  #
947
1123
  # @!attribute [rw] secret_arn
948
1124
  # The name or ARN of the secret that enables access to the database.
949
- # This parameter is required when authenticating using AWS Secrets
1125
+ # This parameter is required when authenticating using Secrets
950
1126
  # Manager.
951
1127
  # @return [String]
952
1128
  #
@@ -964,6 +1140,7 @@ module Aws::RedshiftDataAPIService
964
1140
  #
965
1141
  class ListTablesRequest < Struct.new(
966
1142
  :cluster_identifier,
1143
+ :connected_database,
967
1144
  :database,
968
1145
  :db_user,
969
1146
  :max_results,
@@ -1017,6 +1194,39 @@ module Aws::RedshiftDataAPIService
1017
1194
  include Aws::Structure
1018
1195
  end
1019
1196
 
1197
+ # A parameter used in a SQL statement.
1198
+ #
1199
+ # @note When making an API call, you may pass SqlParameter
1200
+ # data as a hash:
1201
+ #
1202
+ # {
1203
+ # name: "ParameterName", # required
1204
+ # value: "ParameterValue", # required
1205
+ # }
1206
+ #
1207
+ # @!attribute [rw] name
1208
+ # The name of the parameter.
1209
+ # @return [String]
1210
+ #
1211
+ # @!attribute [rw] value
1212
+ # The value of the parameter. Amazon Redshift implicitly converts to
1213
+ # the proper data type. For more inforation, see [Data types][1] in
1214
+ # the *Amazon Redshift Database Developer Guide*.
1215
+ #
1216
+ #
1217
+ #
1218
+ # [1]: https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html
1219
+ # @return [String]
1220
+ #
1221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/SqlParameter AWS API Documentation
1222
+ #
1223
+ class SqlParameter < Struct.new(
1224
+ :name,
1225
+ :value)
1226
+ SENSITIVE = []
1227
+ include Aws::Structure
1228
+ end
1229
+
1020
1230
  # The SQL statement to run.
1021
1231
  #
1022
1232
  # @!attribute [rw] created_at
@@ -1028,10 +1238,24 @@ module Aws::RedshiftDataAPIService
1028
1238
  # identifier (UUID) generated by Amazon Redshift Data API.
1029
1239
  # @return [String]
1030
1240
  #
1241
+ # @!attribute [rw] is_batch_statement
1242
+ # A value that indicates whether the statement is a batch query
1243
+ # request.
1244
+ # @return [Boolean]
1245
+ #
1246
+ # @!attribute [rw] query_parameters
1247
+ # The parameters used in a SQL statement.
1248
+ # @return [Array<Types::SqlParameter>]
1249
+ #
1031
1250
  # @!attribute [rw] query_string
1032
1251
  # The SQL statement.
1033
1252
  # @return [String]
1034
1253
  #
1254
+ # @!attribute [rw] query_strings
1255
+ # One or more SQL statements. Each query string in the array
1256
+ # corresponds to one of the queries in a batch query request.
1257
+ # @return [Array<String>]
1258
+ #
1035
1259
  # @!attribute [rw] secret_arn
1036
1260
  # The name or Amazon Resource Name (ARN) of the secret that enables
1037
1261
  # access to the database.
@@ -1056,7 +1280,10 @@ module Aws::RedshiftDataAPIService
1056
1280
  class StatementData < Struct.new(
1057
1281
  :created_at,
1058
1282
  :id,
1283
+ :is_batch_statement,
1284
+ :query_parameters,
1059
1285
  :query_string,
1286
+ :query_strings,
1060
1287
  :secret_arn,
1061
1288
  :statement_name,
1062
1289
  :status,
@@ -1065,6 +1292,84 @@ module Aws::RedshiftDataAPIService
1065
1292
  include Aws::Structure
1066
1293
  end
1067
1294
 
1295
+ # Information about an SQL statement.
1296
+ #
1297
+ # @!attribute [rw] created_at
1298
+ # The date and time (UTC) the statement was created.
1299
+ # @return [Time]
1300
+ #
1301
+ # @!attribute [rw] duration
1302
+ # The amount of time in nanoseconds that the statement ran.
1303
+ # @return [Integer]
1304
+ #
1305
+ # @!attribute [rw] error
1306
+ # The error message from the cluster if the SQL statement encountered
1307
+ # an error while running.
1308
+ # @return [String]
1309
+ #
1310
+ # @!attribute [rw] has_result_set
1311
+ # A value that indicates whether the statement has a result set. The
1312
+ # result set can be empty.
1313
+ # @return [Boolean]
1314
+ #
1315
+ # @!attribute [rw] id
1316
+ # The identifier of the SQL statement. This value is a universally
1317
+ # unique identifier (UUID) generated by Amazon Redshift Data API. A
1318
+ # suffix indicates the number of the SQL statement. For example,
1319
+ # `d9b6c0c9-0747-4bf4-b142-e8883122f766:2` has a suffix of `:2` that
1320
+ # indicates the second SQL statement of a batch query.
1321
+ # @return [String]
1322
+ #
1323
+ # @!attribute [rw] query_string
1324
+ # The SQL statement text.
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] redshift_query_id
1328
+ # The SQL statement identifier. This value is a universally unique
1329
+ # identifier (UUID) generated by Amazon Redshift Data API.
1330
+ # @return [Integer]
1331
+ #
1332
+ # @!attribute [rw] result_rows
1333
+ # Either the number of rows returned from the SQL statement or the
1334
+ # number of rows affected. If result size is greater than zero, the
1335
+ # result rows can be the number of rows affected by SQL statements
1336
+ # such as INSERT, UPDATE, DELETE, COPY, and others. A `-1` indicates
1337
+ # the value is null.
1338
+ # @return [Integer]
1339
+ #
1340
+ # @!attribute [rw] result_size
1341
+ # The size in bytes of the returned results. A `-1` indicates the
1342
+ # value is null.
1343
+ # @return [Integer]
1344
+ #
1345
+ # @!attribute [rw] status
1346
+ # The status of the SQL statement. An example is the that the SQL
1347
+ # statement finished.
1348
+ # @return [String]
1349
+ #
1350
+ # @!attribute [rw] updated_at
1351
+ # The date and time (UTC) that the statement metadata was last
1352
+ # updated.
1353
+ # @return [Time]
1354
+ #
1355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/SubStatementData AWS API Documentation
1356
+ #
1357
+ class SubStatementData < Struct.new(
1358
+ :created_at,
1359
+ :duration,
1360
+ :error,
1361
+ :has_result_set,
1362
+ :id,
1363
+ :query_string,
1364
+ :redshift_query_id,
1365
+ :result_rows,
1366
+ :result_size,
1367
+ :status,
1368
+ :updated_at)
1369
+ SENSITIVE = []
1370
+ include Aws::Structure
1371
+ end
1372
+
1068
1373
  # The properties of a table.
1069
1374
  #
1070
1375
  # @!attribute [rw] name