aws-sdk-finspacedata 1.5.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-finspacedata/client.rb +697 -54
- data/lib/aws-sdk-finspacedata/client_api.rb +502 -41
- data/lib/aws-sdk-finspacedata/errors.rb +32 -0
- data/lib/aws-sdk-finspacedata/types.rb +1506 -126
- data/lib/aws-sdk-finspacedata.rb +1 -1
- metadata +2 -2
@@ -23,188 +23,509 @@ module Aws::FinSpaceData
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
-
#
|
26
|
+
# The structure with error messages.
|
27
27
|
#
|
28
|
-
# @!attribute [rw]
|
29
|
-
#
|
28
|
+
# @!attribute [rw] error_message
|
29
|
+
# The text of the error message.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @!attribute [rw] error_category
|
33
|
+
# The category of the error.
|
34
|
+
#
|
35
|
+
# * `VALIDATION` -The inputs to this request are invalid.
|
36
|
+
#
|
37
|
+
# * `SERVICE_QUOTA_EXCEEDED` - Service quotas have been exceeded.
|
38
|
+
# Please contact AWS support to increase quotas.
|
39
|
+
#
|
40
|
+
# * `ACCESS_DENIED` - Missing required permission to perform this
|
41
|
+
# request.
|
42
|
+
#
|
43
|
+
# * `RESOURCE_NOT_FOUND` - One or more inputs to this request were not
|
44
|
+
# found.
|
45
|
+
#
|
46
|
+
# * `THROTTLING` - The system temporarily lacks sufficient resources
|
47
|
+
# to process the request.
|
48
|
+
#
|
49
|
+
# * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
|
50
|
+
# occurred.
|
51
|
+
#
|
52
|
+
# * `CANCELLED` - Cancelled.
|
53
|
+
#
|
54
|
+
# * `USER_RECOVERABLE` - A user recoverable error has occurred.
|
55
|
+
# @return [String]
|
56
|
+
#
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ChangesetErrorInfo AWS API Documentation
|
58
|
+
#
|
59
|
+
class ChangesetErrorInfo < Struct.new(
|
60
|
+
:error_message,
|
61
|
+
:error_category)
|
62
|
+
SENSITIVE = []
|
63
|
+
include Aws::Structure
|
64
|
+
end
|
65
|
+
|
66
|
+
# A Changeset is unit of data in a Dataset.
|
67
|
+
#
|
68
|
+
# @!attribute [rw] changeset_id
|
69
|
+
# The unique identifier for a Changeset.
|
30
70
|
# @return [String]
|
31
71
|
#
|
32
72
|
# @!attribute [rw] changeset_arn
|
33
|
-
# The ARN identifier of the
|
73
|
+
# The ARN identifier of the Changeset.
|
34
74
|
# @return [String]
|
35
75
|
#
|
36
76
|
# @!attribute [rw] dataset_id
|
37
|
-
# The unique identifier for the FinSpace
|
38
|
-
#
|
77
|
+
# The unique identifier for the FinSpace Dataset in which the
|
78
|
+
# Changeset is created.
|
39
79
|
# @return [String]
|
40
80
|
#
|
41
81
|
# @!attribute [rw] change_type
|
42
|
-
#
|
82
|
+
# Type that indicates how a Changeset is applied to a Dataset.
|
43
83
|
#
|
44
84
|
# * `REPLACE` - Changeset is considered as a replacement to all prior
|
45
|
-
# loaded
|
85
|
+
# loaded Changesets.
|
46
86
|
#
|
47
87
|
# * `APPEND` - Changeset is considered as an addition to the end of
|
48
|
-
# all prior loaded
|
88
|
+
# all prior loaded Changesets.
|
49
89
|
#
|
50
90
|
# * `MODIFY` - Changeset is considered as a replacement to a specific
|
51
|
-
# prior ingested
|
52
|
-
# @return [String]
|
53
|
-
#
|
54
|
-
# @!attribute [rw] source_type
|
55
|
-
# Type of the data source from which the files to create the changeset
|
56
|
-
# are sourced.
|
57
|
-
#
|
58
|
-
# * `S3` - Amazon S3.
|
59
|
-
#
|
60
|
-
# ^
|
91
|
+
# prior ingested Changeset.
|
61
92
|
# @return [String]
|
62
93
|
#
|
63
94
|
# @!attribute [rw] source_params
|
64
|
-
#
|
65
|
-
# sourced.
|
95
|
+
# Options that define the location of the data being ingested.
|
66
96
|
# @return [Hash<String,String>]
|
67
97
|
#
|
68
|
-
# @!attribute [rw] format_type
|
69
|
-
# Format type of the input files loaded into the changeset.
|
70
|
-
# @return [String]
|
71
|
-
#
|
72
98
|
# @!attribute [rw] format_params
|
73
|
-
#
|
99
|
+
# Options that define the structure of the source file(s).
|
74
100
|
# @return [Hash<String,String>]
|
75
101
|
#
|
76
|
-
# @!attribute [rw]
|
77
|
-
# The timestamp at which the
|
78
|
-
#
|
102
|
+
# @!attribute [rw] create_time
|
103
|
+
# The timestamp at which the Changeset was created in FinSpace. The
|
104
|
+
# value is determined as Epoch time in milliseconds. For example, the
|
105
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
106
|
+
# 1635768000000.
|
107
|
+
# @return [Integer]
|
79
108
|
#
|
80
109
|
# @!attribute [rw] status
|
81
|
-
#
|
110
|
+
# Status of the Changeset ingestion.
|
111
|
+
#
|
112
|
+
# * `PENDING` - Changeset is pending creation.
|
113
|
+
#
|
114
|
+
# * `FAILED` - Changeset creation has failed.
|
115
|
+
#
|
116
|
+
# * `SUCCESS` - Changeset creation has succeeded.
|
117
|
+
#
|
118
|
+
# * `RUNNING` - Changeset creation is running.
|
119
|
+
#
|
120
|
+
# * `STOP_REQUESTED` - User requested Changeset creation to stop.
|
82
121
|
# @return [String]
|
83
122
|
#
|
84
123
|
# @!attribute [rw] error_info
|
85
124
|
# The structure with error messages.
|
86
|
-
# @return [Types::
|
125
|
+
# @return [Types::ChangesetErrorInfo]
|
87
126
|
#
|
88
|
-
# @!attribute [rw]
|
89
|
-
#
|
90
|
-
#
|
127
|
+
# @!attribute [rw] active_until_timestamp
|
128
|
+
# Time until which the Changeset is active. The value is determined as
|
129
|
+
# Epoch time in milliseconds. For example, the value for Monday,
|
130
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
131
|
+
# @return [Integer]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] active_from_timestamp
|
134
|
+
# Milliseconds since UTC epoch
|
135
|
+
# @return [Integer]
|
91
136
|
#
|
92
137
|
# @!attribute [rw] updates_changeset_id
|
93
|
-
#
|
138
|
+
# The unique identifier of the Changeset that is updated.
|
94
139
|
# @return [String]
|
95
140
|
#
|
96
141
|
# @!attribute [rw] updated_by_changeset_id
|
97
|
-
#
|
142
|
+
# The unique identifier of the updated Changeset.
|
98
143
|
# @return [String]
|
99
144
|
#
|
100
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/
|
145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ChangesetSummary AWS API Documentation
|
101
146
|
#
|
102
|
-
class
|
103
|
-
:
|
147
|
+
class ChangesetSummary < Struct.new(
|
148
|
+
:changeset_id,
|
104
149
|
:changeset_arn,
|
105
150
|
:dataset_id,
|
106
151
|
:change_type,
|
107
|
-
:source_type,
|
108
152
|
:source_params,
|
109
|
-
:format_type,
|
110
153
|
:format_params,
|
111
|
-
:
|
154
|
+
:create_time,
|
112
155
|
:status,
|
113
156
|
:error_info,
|
114
|
-
:
|
157
|
+
:active_until_timestamp,
|
158
|
+
:active_from_timestamp,
|
115
159
|
:updates_changeset_id,
|
116
160
|
:updated_by_changeset_id)
|
117
161
|
SENSITIVE = []
|
118
162
|
include Aws::Structure
|
119
163
|
end
|
120
164
|
|
165
|
+
# The definition of a column in a tabular Dataset.
|
166
|
+
#
|
167
|
+
# @note When making an API call, you may pass ColumnDefinition
|
168
|
+
# data as a hash:
|
169
|
+
#
|
170
|
+
# {
|
171
|
+
# data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
|
172
|
+
# column_name: "ColumnName",
|
173
|
+
# column_description: "ColumnDescription",
|
174
|
+
# }
|
175
|
+
#
|
176
|
+
# @!attribute [rw] data_type
|
177
|
+
# Data type of a column.
|
178
|
+
#
|
179
|
+
# * `STRING` - A String data type.
|
180
|
+
#
|
181
|
+
# `CHAR` - A char data type.
|
182
|
+
#
|
183
|
+
# `INTEGER` - An integer data type.
|
184
|
+
#
|
185
|
+
# `TINYINT` - A tinyint data type.
|
186
|
+
#
|
187
|
+
# `SMALLINT` - A smallint data type.
|
188
|
+
#
|
189
|
+
# `BIGINT` - A bigint data type.
|
190
|
+
#
|
191
|
+
# `FLOAT` - A float data type.
|
192
|
+
#
|
193
|
+
# `DOUBLE` - A double data type.
|
194
|
+
#
|
195
|
+
# `DATE` - A date data type.
|
196
|
+
#
|
197
|
+
# `DATETIME` - A datetime data type.
|
198
|
+
#
|
199
|
+
# `BOOLEAN` - A boolean data type.
|
200
|
+
#
|
201
|
+
# `BINARY` - A binary data type.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] column_name
|
205
|
+
# Name for a column.
|
206
|
+
# @return [String]
|
207
|
+
#
|
208
|
+
# @!attribute [rw] column_description
|
209
|
+
# Description for a column.
|
210
|
+
# @return [String]
|
211
|
+
#
|
212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ColumnDefinition AWS API Documentation
|
213
|
+
#
|
214
|
+
class ColumnDefinition < Struct.new(
|
215
|
+
:data_type,
|
216
|
+
:column_name,
|
217
|
+
:column_description)
|
218
|
+
SENSITIVE = []
|
219
|
+
include Aws::Structure
|
220
|
+
end
|
221
|
+
|
222
|
+
# The request conflicts with an existing resource.
|
223
|
+
#
|
224
|
+
# @!attribute [rw] message
|
225
|
+
# @return [String]
|
226
|
+
#
|
227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ConflictException AWS API Documentation
|
228
|
+
#
|
229
|
+
class ConflictException < Struct.new(
|
230
|
+
:message)
|
231
|
+
SENSITIVE = []
|
232
|
+
include Aws::Structure
|
233
|
+
end
|
234
|
+
|
235
|
+
# The request for a CreateChangeset operation.
|
236
|
+
#
|
121
237
|
# @note When making an API call, you may pass CreateChangesetRequest
|
122
238
|
# data as a hash:
|
123
239
|
#
|
124
240
|
# {
|
125
|
-
#
|
241
|
+
# client_token: "ClientToken",
|
242
|
+
# dataset_id: "DatasetId", # required
|
126
243
|
# change_type: "REPLACE", # required, accepts REPLACE, APPEND, MODIFY
|
127
|
-
# source_type: "S3", # required, accepts S3
|
128
244
|
# source_params: { # required
|
129
|
-
# "
|
245
|
+
# "StringMapKey" => "StringMapValue",
|
130
246
|
# },
|
131
|
-
#
|
132
|
-
#
|
133
|
-
# "stringMapKey" => "stringMapValue",
|
134
|
-
# },
|
135
|
-
# tags: {
|
136
|
-
# "stringMapKey" => "stringMapValue",
|
247
|
+
# format_params: { # required
|
248
|
+
# "StringMapKey" => "StringMapValue",
|
137
249
|
# },
|
138
250
|
# }
|
139
251
|
#
|
252
|
+
# @!attribute [rw] client_token
|
253
|
+
# A token used to ensure idempotency.
|
254
|
+
#
|
255
|
+
# **A suitable default value is auto-generated.** You should normally
|
256
|
+
# not need to pass this option.
|
257
|
+
# @return [String]
|
258
|
+
#
|
140
259
|
# @!attribute [rw] dataset_id
|
141
|
-
# The unique identifier for the FinSpace
|
142
|
-
#
|
260
|
+
# The unique identifier for the FinSpace Dataset where the Changeset
|
261
|
+
# will be created.
|
143
262
|
# @return [String]
|
144
263
|
#
|
145
264
|
# @!attribute [rw] change_type
|
146
|
-
# Option to indicate how a
|
265
|
+
# Option to indicate how a Changeset will be applied to a Dataset.
|
147
266
|
#
|
148
267
|
# * `REPLACE` - Changeset will be considered as a replacement to all
|
149
|
-
# prior loaded
|
268
|
+
# prior loaded Changesets.
|
150
269
|
#
|
151
270
|
# * `APPEND` - Changeset will be considered as an addition to the end
|
152
|
-
# of all prior loaded
|
153
|
-
# @return [String]
|
154
|
-
#
|
155
|
-
# @!attribute [rw] source_type
|
156
|
-
# Type of the data source from which the files to create the changeset
|
157
|
-
# will be sourced.
|
271
|
+
# of all prior loaded Changesets.
|
158
272
|
#
|
159
|
-
# * `
|
160
|
-
#
|
161
|
-
# ^
|
273
|
+
# * `MODIFY` - Changeset is considered as a replacement to a specific
|
274
|
+
# prior ingested Changeset.
|
162
275
|
# @return [String]
|
163
276
|
#
|
164
277
|
# @!attribute [rw] source_params
|
165
|
-
#
|
166
|
-
# sourced.
|
278
|
+
# Options that define the location of the data being ingested.
|
167
279
|
# @return [Hash<String,String>]
|
168
280
|
#
|
169
|
-
# @!attribute [rw] format_type
|
170
|
-
# Format type of the input files being loaded into the changeset.
|
171
|
-
# @return [String]
|
172
|
-
#
|
173
281
|
# @!attribute [rw] format_params
|
174
|
-
# Options that define the structure of the source file(s)
|
175
|
-
#
|
282
|
+
# Options that define the structure of the source file(s) including
|
283
|
+
# the format type (`formatType`), header row (`withHeader`), data
|
284
|
+
# separation character (`separator`) and the type of compression
|
285
|
+
# (`compression`).
|
286
|
+
#
|
287
|
+
# `formatType` is a required attribute and can have the following
|
288
|
+
# values:
|
289
|
+
#
|
290
|
+
# * `PARQUET` - Parquet source file format.
|
291
|
+
#
|
292
|
+
# * `CSV` - CSV source file format.
|
293
|
+
#
|
294
|
+
# * `JSON` - JSON source file format.
|
295
|
+
#
|
296
|
+
# * `XML` - XML source file format.
|
176
297
|
#
|
177
|
-
#
|
178
|
-
#
|
298
|
+
# For example, you could specify the following for `formatParams`\: `
|
299
|
+
# "formatParams": \{ "formatType": "CSV", "withHeader": "true",
|
300
|
+
# "separator": ",", "compression":"None" \} `
|
179
301
|
# @return [Hash<String,String>]
|
180
302
|
#
|
181
303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangesetRequest AWS API Documentation
|
182
304
|
#
|
183
305
|
class CreateChangesetRequest < Struct.new(
|
306
|
+
:client_token,
|
184
307
|
:dataset_id,
|
185
308
|
:change_type,
|
186
|
-
:source_type,
|
187
309
|
:source_params,
|
188
|
-
:
|
189
|
-
:format_params,
|
190
|
-
:tags)
|
310
|
+
:format_params)
|
191
311
|
SENSITIVE = []
|
192
312
|
include Aws::Structure
|
193
313
|
end
|
194
314
|
|
195
|
-
#
|
196
|
-
#
|
197
|
-
#
|
315
|
+
# The response from a CreateChangeset operation.
|
316
|
+
#
|
317
|
+
# @!attribute [rw] dataset_id
|
318
|
+
# The unique identifier for the FinSpace Dataset where the Changeset
|
319
|
+
# is created.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] changeset_id
|
323
|
+
# The unique identifier of the Changeset that is created.
|
324
|
+
# @return [String]
|
198
325
|
#
|
199
326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangesetResponse AWS API Documentation
|
200
327
|
#
|
201
328
|
class CreateChangesetResponse < Struct.new(
|
202
|
-
:
|
329
|
+
:dataset_id,
|
330
|
+
:changeset_id)
|
331
|
+
SENSITIVE = []
|
332
|
+
include Aws::Structure
|
333
|
+
end
|
334
|
+
|
335
|
+
# Request for creating a data view.
|
336
|
+
#
|
337
|
+
# @note When making an API call, you may pass CreateDataViewRequest
|
338
|
+
# data as a hash:
|
339
|
+
#
|
340
|
+
# {
|
341
|
+
# client_token: "ClientToken",
|
342
|
+
# dataset_id: "DatasetId", # required
|
343
|
+
# auto_update: false,
|
344
|
+
# sort_columns: ["StringValueLength1to255"],
|
345
|
+
# partition_columns: ["StringValueLength1to255"],
|
346
|
+
# as_of_timestamp: 1,
|
347
|
+
# destination_type_params: { # required
|
348
|
+
# destination_type: "DataViewDestinationType", # required
|
349
|
+
# s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
|
350
|
+
# s3_destination_export_file_format_options: {
|
351
|
+
# "StringMapKey" => "StringMapValue",
|
352
|
+
# },
|
353
|
+
# },
|
354
|
+
# }
|
355
|
+
#
|
356
|
+
# @!attribute [rw] client_token
|
357
|
+
# A token used to ensure idempotency.
|
358
|
+
#
|
359
|
+
# **A suitable default value is auto-generated.** You should normally
|
360
|
+
# not need to pass this option.
|
361
|
+
# @return [String]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] dataset_id
|
364
|
+
# The unique Dataset identifier that is used to create a Dataview.
|
365
|
+
# @return [String]
|
366
|
+
#
|
367
|
+
# @!attribute [rw] auto_update
|
368
|
+
# Flag to indicate Dataview should be updated automatically.
|
369
|
+
# @return [Boolean]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] sort_columns
|
372
|
+
# Columns to be used for sorting the data.
|
373
|
+
# @return [Array<String>]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] partition_columns
|
376
|
+
# Ordered set of column names used to partition data.
|
377
|
+
# @return [Array<String>]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] as_of_timestamp
|
380
|
+
# Beginning time to use for the Dataview. The value is determined as
|
381
|
+
# Epoch time in milliseconds. For example, the value for Monday,
|
382
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
383
|
+
# @return [Integer]
|
384
|
+
#
|
385
|
+
# @!attribute [rw] destination_type_params
|
386
|
+
# Options that define the destination type for the Dataview.
|
387
|
+
# @return [Types::DataViewDestinationTypeParams]
|
388
|
+
#
|
389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataViewRequest AWS API Documentation
|
390
|
+
#
|
391
|
+
class CreateDataViewRequest < Struct.new(
|
392
|
+
:client_token,
|
393
|
+
:dataset_id,
|
394
|
+
:auto_update,
|
395
|
+
:sort_columns,
|
396
|
+
:partition_columns,
|
397
|
+
:as_of_timestamp,
|
398
|
+
:destination_type_params)
|
399
|
+
SENSITIVE = []
|
400
|
+
include Aws::Structure
|
401
|
+
end
|
402
|
+
|
403
|
+
# Response for creating a data view.
|
404
|
+
#
|
405
|
+
# @!attribute [rw] dataset_id
|
406
|
+
# The unique identifier of the Dataset used for the Dataview.
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] data_view_id
|
410
|
+
# The unique identifier for the created Dataview.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataViewResponse AWS API Documentation
|
414
|
+
#
|
415
|
+
class CreateDataViewResponse < Struct.new(
|
416
|
+
:dataset_id,
|
417
|
+
:data_view_id)
|
418
|
+
SENSITIVE = []
|
419
|
+
include Aws::Structure
|
420
|
+
end
|
421
|
+
|
422
|
+
# The request for a CreateDataset operation
|
423
|
+
#
|
424
|
+
# @note When making an API call, you may pass CreateDatasetRequest
|
425
|
+
# data as a hash:
|
426
|
+
#
|
427
|
+
# {
|
428
|
+
# client_token: "ClientToken",
|
429
|
+
# dataset_title: "DatasetTitle", # required
|
430
|
+
# kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
|
431
|
+
# dataset_description: "DatasetDescription",
|
432
|
+
# owner_info: {
|
433
|
+
# name: "OwnerName",
|
434
|
+
# phone_number: "PhoneNumber",
|
435
|
+
# email: "Email",
|
436
|
+
# },
|
437
|
+
# permission_group_params: { # required
|
438
|
+
# permission_group_id: "PermissionGroupId",
|
439
|
+
# dataset_permissions: [
|
440
|
+
# {
|
441
|
+
# permission: "StringValueLength1to250",
|
442
|
+
# },
|
443
|
+
# ],
|
444
|
+
# },
|
445
|
+
# alias: "AliasString",
|
446
|
+
# schema_definition: {
|
447
|
+
# tabular_schema_config: {
|
448
|
+
# columns: [
|
449
|
+
# {
|
450
|
+
# data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
|
451
|
+
# column_name: "ColumnName",
|
452
|
+
# column_description: "ColumnDescription",
|
453
|
+
# },
|
454
|
+
# ],
|
455
|
+
# primary_key_columns: ["ColumnName"],
|
456
|
+
# },
|
457
|
+
# },
|
458
|
+
# }
|
459
|
+
#
|
460
|
+
# @!attribute [rw] client_token
|
461
|
+
# A token used to ensure idempotency.
|
462
|
+
#
|
463
|
+
# **A suitable default value is auto-generated.** You should normally
|
464
|
+
# not need to pass this option.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] dataset_title
|
468
|
+
# Display title for a FinSpace Dataset.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] kind
|
472
|
+
# The format in which Dataset data is structured.
|
473
|
+
#
|
474
|
+
# * `TABULAR` - Data is structured in a tabular format.
|
475
|
+
#
|
476
|
+
# * `NON_TABULAR` - Data is structured in a non-tabular format.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] dataset_description
|
480
|
+
# Description of a Dataset.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] owner_info
|
484
|
+
# Contact information for a Dataset owner.
|
485
|
+
# @return [Types::DatasetOwnerInfo]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] permission_group_params
|
488
|
+
# Permission group parameters for Dataset permissions.
|
489
|
+
# @return [Types::PermissionGroupParams]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] alias
|
492
|
+
# The unique resource identifier for a Dataset.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] schema_definition
|
496
|
+
# Definition for a schema on a tabular Dataset.
|
497
|
+
# @return [Types::SchemaUnion]
|
498
|
+
#
|
499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDatasetRequest AWS API Documentation
|
500
|
+
#
|
501
|
+
class CreateDatasetRequest < Struct.new(
|
502
|
+
:client_token,
|
503
|
+
:dataset_title,
|
504
|
+
:kind,
|
505
|
+
:dataset_description,
|
506
|
+
:owner_info,
|
507
|
+
:permission_group_params,
|
508
|
+
:alias,
|
509
|
+
:schema_definition)
|
510
|
+
SENSITIVE = []
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
514
|
+
# The response from a CreateDataset operation
|
515
|
+
#
|
516
|
+
# @!attribute [rw] dataset_id
|
517
|
+
# The unique identifier for the created Dataset.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDatasetResponse AWS API Documentation
|
521
|
+
#
|
522
|
+
class CreateDatasetResponse < Struct.new(
|
523
|
+
:dataset_id)
|
203
524
|
SENSITIVE = []
|
204
525
|
include Aws::Structure
|
205
526
|
end
|
206
527
|
|
207
|
-
#
|
528
|
+
# Short term API credentials.
|
208
529
|
#
|
209
530
|
# @!attribute [rw] access_key_id
|
210
531
|
# The access key identifier.
|
@@ -228,7 +549,45 @@ module Aws::FinSpaceData
|
|
228
549
|
include Aws::Structure
|
229
550
|
end
|
230
551
|
|
231
|
-
#
|
552
|
+
# Structure for the Dataview destination type parameters.
|
553
|
+
#
|
554
|
+
# @note When making an API call, you may pass DataViewDestinationTypeParams
|
555
|
+
# data as a hash:
|
556
|
+
#
|
557
|
+
# {
|
558
|
+
# destination_type: "DataViewDestinationType", # required
|
559
|
+
# s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
|
560
|
+
# s3_destination_export_file_format_options: {
|
561
|
+
# "StringMapKey" => "StringMapValue",
|
562
|
+
# },
|
563
|
+
# }
|
564
|
+
#
|
565
|
+
# @!attribute [rw] destination_type
|
566
|
+
# Destination type for a Dataview.
|
567
|
+
#
|
568
|
+
# * `GLUE_TABLE` - Glue table destination type.
|
569
|
+
#
|
570
|
+
# ^
|
571
|
+
# @return [String]
|
572
|
+
#
|
573
|
+
# @!attribute [rw] s3_destination_export_file_format
|
574
|
+
# Data View Export File Format
|
575
|
+
# @return [String]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] s3_destination_export_file_format_options
|
578
|
+
# @return [Hash<String,String>]
|
579
|
+
#
|
580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewDestinationTypeParams AWS API Documentation
|
581
|
+
#
|
582
|
+
class DataViewDestinationTypeParams < Struct.new(
|
583
|
+
:destination_type,
|
584
|
+
:s3_destination_export_file_format,
|
585
|
+
:s3_destination_export_file_format_options)
|
586
|
+
SENSITIVE = []
|
587
|
+
include Aws::Structure
|
588
|
+
end
|
589
|
+
|
590
|
+
# The structure with error messages.
|
232
591
|
#
|
233
592
|
# @!attribute [rw] error_message
|
234
593
|
# The text of the error message.
|
@@ -254,65 +613,645 @@ module Aws::FinSpaceData
|
|
254
613
|
# * `INTERNAL_SERVICE_EXCEPTION` - An internal service error has
|
255
614
|
# occurred.
|
256
615
|
#
|
257
|
-
# * `CANCELLED` -
|
616
|
+
# * `CANCELLED` - Cancelled.
|
617
|
+
#
|
618
|
+
# * `USER_RECOVERABLE` - A user recoverable error has occurred.
|
258
619
|
# @return [String]
|
259
620
|
#
|
260
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/
|
621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewErrorInfo AWS API Documentation
|
261
622
|
#
|
262
|
-
class
|
623
|
+
class DataViewErrorInfo < Struct.new(
|
263
624
|
:error_message,
|
264
625
|
:error_category)
|
265
626
|
SENSITIVE = []
|
266
627
|
include Aws::Structure
|
267
628
|
end
|
268
629
|
|
269
|
-
#
|
270
|
-
# data as a hash:
|
630
|
+
# Structure for the summary of a Dataview.
|
271
631
|
#
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
# }
|
632
|
+
# @!attribute [rw] data_view_id
|
633
|
+
# The unique identifier for the Dataview.
|
634
|
+
# @return [String]
|
276
635
|
#
|
277
|
-
# @!attribute [rw]
|
278
|
-
# The
|
279
|
-
# @return [
|
636
|
+
# @!attribute [rw] data_view_arn
|
637
|
+
# The ARN identifier of the Dataview.
|
638
|
+
# @return [String]
|
280
639
|
#
|
281
|
-
# @!attribute [rw]
|
282
|
-
#
|
640
|
+
# @!attribute [rw] dataset_id
|
641
|
+
# Th unique identifier for the Dataview Dataset.
|
283
642
|
# @return [String]
|
284
643
|
#
|
285
|
-
#
|
644
|
+
# @!attribute [rw] as_of_timestamp
|
645
|
+
# Time range to use for the Dataview. The value is determined as Epoch
|
646
|
+
# time in milliseconds. For example, the value for Monday, November 1,
|
647
|
+
# 2021 12:00:00 PM UTC is specified as 1635768000000.
|
648
|
+
# @return [Integer]
|
286
649
|
#
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
SENSITIVE = []
|
291
|
-
include Aws::Structure
|
292
|
-
end
|
293
|
-
|
294
|
-
# @!attribute [rw] credentials
|
295
|
-
# Returns the programmatic credentials.
|
296
|
-
# @return [Types::Credentials]
|
650
|
+
# @!attribute [rw] partition_columns
|
651
|
+
# Ordered set of column names used to partition data.
|
652
|
+
# @return [Array<String>]
|
297
653
|
#
|
298
|
-
# @!attribute [rw]
|
299
|
-
#
|
300
|
-
# @return [
|
654
|
+
# @!attribute [rw] sort_columns
|
655
|
+
# Columns to be used for sorting the data.
|
656
|
+
# @return [Array<String>]
|
301
657
|
#
|
302
|
-
#
|
658
|
+
# @!attribute [rw] status
|
659
|
+
# The status of a Dataview creation.
|
303
660
|
#
|
304
|
-
|
305
|
-
:credentials,
|
306
|
-
:duration_in_minutes)
|
307
|
-
SENSITIVE = []
|
308
|
-
include Aws::Structure
|
309
|
-
end
|
310
|
-
|
311
|
-
# @note When making an API call, you may pass GetWorkingLocationRequest
|
312
|
-
# data as a hash:
|
661
|
+
# * `RUNNING` - Dataview creation is running.
|
313
662
|
#
|
314
|
-
#
|
315
|
-
#
|
663
|
+
# * `STARTING` - Dataview creation is starting.
|
664
|
+
#
|
665
|
+
# * `FAILED` - Dataview creation has failed.
|
666
|
+
#
|
667
|
+
# * `CANCELLED` - Dataview creation has been cancelled.
|
668
|
+
#
|
669
|
+
# * `TIMEOUT` - Dataview creation has timed out.
|
670
|
+
#
|
671
|
+
# * `SUCCESS` - Dataview creation has succeeded.
|
672
|
+
#
|
673
|
+
# * `PENDING` - Dataview creation is pending.
|
674
|
+
#
|
675
|
+
# * `FAILED_CLEANUP_FAILED` - Dataview creation failed and resource
|
676
|
+
# cleanup failed.
|
677
|
+
# @return [String]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] error_info
|
680
|
+
# The structure with error messages.
|
681
|
+
# @return [Types::DataViewErrorInfo]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] destination_type_properties
|
684
|
+
# Information about the Dataview destination.
|
685
|
+
# @return [Types::DataViewDestinationTypeParams]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] auto_update
|
688
|
+
# The flag to indicate Dataview should be updated automatically.
|
689
|
+
# @return [Boolean]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] create_time
|
692
|
+
# The timestamp at which the Dataview was created in FinSpace. The
|
693
|
+
# value is determined as Epoch time in milliseconds. For example, the
|
694
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
695
|
+
# 1635768000000.
|
696
|
+
# @return [Integer]
|
697
|
+
#
|
698
|
+
# @!attribute [rw] last_modified_time
|
699
|
+
# The last time that a Dataview was modified. The value is determined
|
700
|
+
# as Epoch time in milliseconds. For example, the value for Monday,
|
701
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
702
|
+
# @return [Integer]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewSummary AWS API Documentation
|
705
|
+
#
|
706
|
+
class DataViewSummary < Struct.new(
|
707
|
+
:data_view_id,
|
708
|
+
:data_view_arn,
|
709
|
+
:dataset_id,
|
710
|
+
:as_of_timestamp,
|
711
|
+
:partition_columns,
|
712
|
+
:sort_columns,
|
713
|
+
:status,
|
714
|
+
:error_info,
|
715
|
+
:destination_type_properties,
|
716
|
+
:auto_update,
|
717
|
+
:create_time,
|
718
|
+
:last_modified_time)
|
719
|
+
SENSITIVE = []
|
720
|
+
include Aws::Structure
|
721
|
+
end
|
722
|
+
|
723
|
+
# The structure for a Dataset.
|
724
|
+
#
|
725
|
+
# @!attribute [rw] dataset_id
|
726
|
+
# An identifier for a Dataset.
|
727
|
+
# @return [String]
|
728
|
+
#
|
729
|
+
# @!attribute [rw] dataset_arn
|
730
|
+
# The ARN identifier of the Dataset.
|
731
|
+
# @return [String]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] dataset_title
|
734
|
+
# Display title for a Dataset.
|
735
|
+
# @return [String]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] kind
|
738
|
+
# The format in which Dataset data is structured.
|
739
|
+
#
|
740
|
+
# * `TABULAR` - Data is structured in a tabular format.
|
741
|
+
#
|
742
|
+
# * `NON_TABULAR` - Data is structured in a non-tabular format.
|
743
|
+
# @return [String]
|
744
|
+
#
|
745
|
+
# @!attribute [rw] dataset_description
|
746
|
+
# Description for a Dataset.
|
747
|
+
# @return [String]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] owner_info
|
750
|
+
# Contact information for a Dataset owner.
|
751
|
+
# @return [Types::DatasetOwnerInfo]
|
752
|
+
#
|
753
|
+
# @!attribute [rw] create_time
|
754
|
+
# The timestamp at which the Dataset was created in FinSpace. The
|
755
|
+
# value is determined as Epoch time in milliseconds. For example, the
|
756
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
757
|
+
# 1635768000000.
|
758
|
+
# @return [Integer]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] last_modified_time
|
761
|
+
# The last time that the Dataset was modified. The value is determined
|
762
|
+
# as Epoch time in milliseconds. For example, the value for Monday,
|
763
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
764
|
+
# @return [Integer]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] schema_definition
|
767
|
+
# Definition for a schema on a tabular Dataset.
|
768
|
+
# @return [Types::SchemaUnion]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] alias
|
771
|
+
# The unique resource identifier for a Dataset.
|
772
|
+
# @return [String]
|
773
|
+
#
|
774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/Dataset AWS API Documentation
|
775
|
+
#
|
776
|
+
class Dataset < Struct.new(
|
777
|
+
:dataset_id,
|
778
|
+
:dataset_arn,
|
779
|
+
:dataset_title,
|
780
|
+
:kind,
|
781
|
+
:dataset_description,
|
782
|
+
:owner_info,
|
783
|
+
:create_time,
|
784
|
+
:last_modified_time,
|
785
|
+
:schema_definition,
|
786
|
+
:alias)
|
787
|
+
SENSITIVE = []
|
788
|
+
include Aws::Structure
|
789
|
+
end
|
790
|
+
|
791
|
+
# A structure for Dataset owner info.
|
792
|
+
#
|
793
|
+
# @note When making an API call, you may pass DatasetOwnerInfo
|
794
|
+
# data as a hash:
|
795
|
+
#
|
796
|
+
# {
|
797
|
+
# name: "OwnerName",
|
798
|
+
# phone_number: "PhoneNumber",
|
799
|
+
# email: "Email",
|
800
|
+
# }
|
801
|
+
#
|
802
|
+
# @!attribute [rw] name
|
803
|
+
# Name of the Dataset owner.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] phone_number
|
807
|
+
# Phone number for the Dataset owner.
|
808
|
+
# @return [String]
|
809
|
+
#
|
810
|
+
# @!attribute [rw] email
|
811
|
+
# Email address for the Dataset owner.
|
812
|
+
# @return [String]
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DatasetOwnerInfo AWS API Documentation
|
815
|
+
#
|
816
|
+
class DatasetOwnerInfo < Struct.new(
|
817
|
+
:name,
|
818
|
+
:phone_number,
|
819
|
+
:email)
|
820
|
+
SENSITIVE = []
|
821
|
+
include Aws::Structure
|
822
|
+
end
|
823
|
+
|
824
|
+
# The request for a DeleteDataset operation.
|
825
|
+
#
|
826
|
+
# @note When making an API call, you may pass DeleteDatasetRequest
|
827
|
+
# data as a hash:
|
828
|
+
#
|
829
|
+
# {
|
830
|
+
# client_token: "ClientToken",
|
831
|
+
# dataset_id: "DatasetId", # required
|
832
|
+
# }
|
833
|
+
#
|
834
|
+
# @!attribute [rw] client_token
|
835
|
+
# A token used to ensure idempotency.
|
836
|
+
#
|
837
|
+
# **A suitable default value is auto-generated.** You should normally
|
838
|
+
# not need to pass this option.
|
839
|
+
# @return [String]
|
840
|
+
#
|
841
|
+
# @!attribute [rw] dataset_id
|
842
|
+
# The unique identifier of the Dataset to be deleted.
|
843
|
+
# @return [String]
|
844
|
+
#
|
845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDatasetRequest AWS API Documentation
|
846
|
+
#
|
847
|
+
class DeleteDatasetRequest < Struct.new(
|
848
|
+
:client_token,
|
849
|
+
:dataset_id)
|
850
|
+
SENSITIVE = []
|
851
|
+
include Aws::Structure
|
852
|
+
end
|
853
|
+
|
854
|
+
# The response from an DeleteDataset operation
|
855
|
+
#
|
856
|
+
# @!attribute [rw] dataset_id
|
857
|
+
# The unique identifier for the deleted Dataset.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDatasetResponse AWS API Documentation
|
861
|
+
#
|
862
|
+
class DeleteDatasetResponse < Struct.new(
|
863
|
+
:dataset_id)
|
864
|
+
SENSITIVE = []
|
865
|
+
include Aws::Structure
|
866
|
+
end
|
867
|
+
|
868
|
+
# Request to describe a changeset.
|
869
|
+
#
|
870
|
+
# @note When making an API call, you may pass GetChangesetRequest
|
871
|
+
# data as a hash:
|
872
|
+
#
|
873
|
+
# {
|
874
|
+
# dataset_id: "DatasetId", # required
|
875
|
+
# changeset_id: "ChangesetId", # required
|
876
|
+
# }
|
877
|
+
#
|
878
|
+
# @!attribute [rw] dataset_id
|
879
|
+
# The unique identifier for the FinSpace Dataset where the Changeset
|
880
|
+
# is created.
|
881
|
+
# @return [String]
|
882
|
+
#
|
883
|
+
# @!attribute [rw] changeset_id
|
884
|
+
# The unique identifier of the Changeset for which to get data.
|
885
|
+
# @return [String]
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangesetRequest AWS API Documentation
|
888
|
+
#
|
889
|
+
class GetChangesetRequest < Struct.new(
|
890
|
+
:dataset_id,
|
891
|
+
:changeset_id)
|
892
|
+
SENSITIVE = []
|
893
|
+
include Aws::Structure
|
894
|
+
end
|
895
|
+
|
896
|
+
# The response from a describe changeset operation
|
897
|
+
#
|
898
|
+
# @!attribute [rw] changeset_id
|
899
|
+
# The unique identifier for a Changeset.
|
900
|
+
# @return [String]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] changeset_arn
|
903
|
+
# The ARN identifier of the Changeset.
|
904
|
+
# @return [String]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] dataset_id
|
907
|
+
# The unique identifier for the FinSpace Dataset where the Changeset
|
908
|
+
# is created.
|
909
|
+
# @return [String]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] change_type
|
912
|
+
# Type that indicates how a Changeset is applied to a Dataset.
|
913
|
+
#
|
914
|
+
# * `REPLACE` - Changeset is considered as a replacement to all prior
|
915
|
+
# loaded Changesets.
|
916
|
+
#
|
917
|
+
# * `APPEND` - Changeset is considered as an addition to the end of
|
918
|
+
# all prior loaded Changesets.
|
919
|
+
#
|
920
|
+
# * `MODIFY` - Changeset is considered as a replacement to a specific
|
921
|
+
# prior ingested Changeset.
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @!attribute [rw] source_params
|
925
|
+
# Options that define the location of the data being ingested.
|
926
|
+
# @return [Hash<String,String>]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] format_params
|
929
|
+
# Structure of the source file(s).
|
930
|
+
# @return [Hash<String,String>]
|
931
|
+
#
|
932
|
+
# @!attribute [rw] create_time
|
933
|
+
# The timestamp at which the Changeset was created in FinSpace. The
|
934
|
+
# value is determined as Epoch time in milliseconds. For example, the
|
935
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
936
|
+
# 1635768000000.
|
937
|
+
# @return [Integer]
|
938
|
+
#
|
939
|
+
# @!attribute [rw] status
|
940
|
+
# The status of Changeset creation operation.
|
941
|
+
# @return [String]
|
942
|
+
#
|
943
|
+
# @!attribute [rw] error_info
|
944
|
+
# The structure with error messages.
|
945
|
+
# @return [Types::ChangesetErrorInfo]
|
946
|
+
#
|
947
|
+
# @!attribute [rw] active_until_timestamp
|
948
|
+
# Time until which the Changeset is active. The value is determined as
|
949
|
+
# Epoch time in milliseconds. For example, the value for Monday,
|
950
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
951
|
+
# @return [Integer]
|
952
|
+
#
|
953
|
+
# @!attribute [rw] active_from_timestamp
|
954
|
+
# Milliseconds since UTC epoch
|
955
|
+
# @return [Integer]
|
956
|
+
#
|
957
|
+
# @!attribute [rw] updates_changeset_id
|
958
|
+
# The unique identifier of the Changeset that is being updated.
|
959
|
+
# @return [String]
|
960
|
+
#
|
961
|
+
# @!attribute [rw] updated_by_changeset_id
|
962
|
+
# The unique identifier of the updated Changeset.
|
963
|
+
# @return [String]
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangesetResponse AWS API Documentation
|
966
|
+
#
|
967
|
+
class GetChangesetResponse < Struct.new(
|
968
|
+
:changeset_id,
|
969
|
+
:changeset_arn,
|
970
|
+
:dataset_id,
|
971
|
+
:change_type,
|
972
|
+
:source_params,
|
973
|
+
:format_params,
|
974
|
+
:create_time,
|
975
|
+
:status,
|
976
|
+
:error_info,
|
977
|
+
:active_until_timestamp,
|
978
|
+
:active_from_timestamp,
|
979
|
+
:updates_changeset_id,
|
980
|
+
:updated_by_changeset_id)
|
981
|
+
SENSITIVE = []
|
982
|
+
include Aws::Structure
|
983
|
+
end
|
984
|
+
|
985
|
+
# Request for retrieving a data view detail. Grouped / accessible within
|
986
|
+
# a dataset by its dataset id.
|
987
|
+
#
|
988
|
+
# @note When making an API call, you may pass GetDataViewRequest
|
989
|
+
# data as a hash:
|
990
|
+
#
|
991
|
+
# {
|
992
|
+
# data_view_id: "DataViewId", # required
|
993
|
+
# dataset_id: "DatasetId", # required
|
994
|
+
# }
|
995
|
+
#
|
996
|
+
# @!attribute [rw] data_view_id
|
997
|
+
# The unique identifier for the Dataview.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] dataset_id
|
1001
|
+
# The unique identifier for the Dataset used in the Dataview.
|
1002
|
+
# @return [String]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataViewRequest AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class GetDataViewRequest < Struct.new(
|
1007
|
+
:data_view_id,
|
1008
|
+
:dataset_id)
|
1009
|
+
SENSITIVE = []
|
1010
|
+
include Aws::Structure
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
# Response from retrieving a dataview, which includes details on the
|
1014
|
+
# target database and table name
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] auto_update
|
1017
|
+
# Flag to indicate Dataview should be updated automatically.
|
1018
|
+
# @return [Boolean]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] partition_columns
|
1021
|
+
# Ordered set of column names used to partition data.
|
1022
|
+
# @return [Array<String>]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] dataset_id
|
1025
|
+
# The unique identifier for the Dataset used in the Dataview.
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] as_of_timestamp
|
1029
|
+
# Time range to use for the Dataview. The value is determined as Epoch
|
1030
|
+
# time in milliseconds. For example, the value for Monday, November 1,
|
1031
|
+
# 2021 12:00:00 PM UTC is specified as 1635768000000.
|
1032
|
+
# @return [Integer]
|
1033
|
+
#
|
1034
|
+
# @!attribute [rw] error_info
|
1035
|
+
# Information about an error that occurred for the Dataview.
|
1036
|
+
# @return [Types::DataViewErrorInfo]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] last_modified_time
|
1039
|
+
# The last time that a Dataview was modified. The value is determined
|
1040
|
+
# as Epoch time in milliseconds. For example, the value for Monday,
|
1041
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
1042
|
+
# @return [Integer]
|
1043
|
+
#
|
1044
|
+
# @!attribute [rw] create_time
|
1045
|
+
# The timestamp at which the Dataview was created in FinSpace. The
|
1046
|
+
# value is determined as Epoch time in milliseconds. For example, the
|
1047
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1048
|
+
# 1635768000000.
|
1049
|
+
# @return [Integer]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] sort_columns
|
1052
|
+
# Columns to be used for sorting the data.
|
1053
|
+
# @return [Array<String>]
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] data_view_id
|
1056
|
+
# The unique identifier for the Dataview.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] data_view_arn
|
1060
|
+
# The ARN identifier of the Dataview.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] destination_type_params
|
1064
|
+
# Options that define the destination type for the Dataview.
|
1065
|
+
# @return [Types::DataViewDestinationTypeParams]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] status
|
1068
|
+
# The status of a Dataview creation.
|
1069
|
+
#
|
1070
|
+
# * `RUNNING` - Dataview creation is running.
|
1071
|
+
#
|
1072
|
+
# * `STARTING` - Dataview creation is starting.
|
1073
|
+
#
|
1074
|
+
# * `FAILED` - Dataview creation has failed.
|
1075
|
+
#
|
1076
|
+
# * `CANCELLED` - Dataview creation has been cancelled.
|
1077
|
+
#
|
1078
|
+
# * `TIMEOUT` - Dataview creation has timed out.
|
1079
|
+
#
|
1080
|
+
# * `SUCCESS` - Dataview creation has succeeded.
|
1081
|
+
#
|
1082
|
+
# * `PENDING` - Dataview creation is pending.
|
1083
|
+
#
|
1084
|
+
# * `FAILED_CLEANUP_FAILED` - Dataview creation failed and resource
|
1085
|
+
# cleanup failed.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1088
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataViewResponse AWS API Documentation
|
1089
|
+
#
|
1090
|
+
class GetDataViewResponse < Struct.new(
|
1091
|
+
:auto_update,
|
1092
|
+
:partition_columns,
|
1093
|
+
:dataset_id,
|
1094
|
+
:as_of_timestamp,
|
1095
|
+
:error_info,
|
1096
|
+
:last_modified_time,
|
1097
|
+
:create_time,
|
1098
|
+
:sort_columns,
|
1099
|
+
:data_view_id,
|
1100
|
+
:data_view_arn,
|
1101
|
+
:destination_type_params,
|
1102
|
+
:status)
|
1103
|
+
SENSITIVE = []
|
1104
|
+
include Aws::Structure
|
1105
|
+
end
|
1106
|
+
|
1107
|
+
# Request for the GetDataset operation.
|
1108
|
+
#
|
1109
|
+
# @note When making an API call, you may pass GetDatasetRequest
|
1110
|
+
# data as a hash:
|
1111
|
+
#
|
1112
|
+
# {
|
1113
|
+
# dataset_id: "StringValueLength1to255", # required
|
1114
|
+
# }
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] dataset_id
|
1117
|
+
# The unique identifier for a Dataset.
|
1118
|
+
# @return [String]
|
1119
|
+
#
|
1120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDatasetRequest AWS API Documentation
|
1121
|
+
#
|
1122
|
+
class GetDatasetRequest < Struct.new(
|
1123
|
+
:dataset_id)
|
1124
|
+
SENSITIVE = []
|
1125
|
+
include Aws::Structure
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
# Response for the GetDataset operation
|
1129
|
+
#
|
1130
|
+
# @!attribute [rw] dataset_id
|
1131
|
+
# The unique identifier for a Dataset.
|
1132
|
+
# @return [String]
|
1133
|
+
#
|
1134
|
+
# @!attribute [rw] dataset_arn
|
1135
|
+
# The ARN identifier of the Dataset.
|
1136
|
+
# @return [String]
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] dataset_title
|
1139
|
+
# Display title for a Dataset.
|
1140
|
+
# @return [String]
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] kind
|
1143
|
+
# The format in which Dataset data is structured.
|
1144
|
+
#
|
1145
|
+
# * `TABULAR` - Data is structured in a tabular format.
|
1146
|
+
#
|
1147
|
+
# * `NON_TABULAR` - Data is structured in a non-tabular format.
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] dataset_description
|
1151
|
+
# A description of the Dataset.
|
1152
|
+
# @return [String]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] create_time
|
1155
|
+
# The timestamp at which the Dataset was created in FinSpace. The
|
1156
|
+
# value is determined as Epoch time in milliseconds. For example, the
|
1157
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1158
|
+
# 1635768000000.
|
1159
|
+
# @return [Integer]
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] last_modified_time
|
1162
|
+
# The last time that the Dataset was modified. The value is determined
|
1163
|
+
# as Epoch time in milliseconds. For example, the value for Monday,
|
1164
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
1165
|
+
# @return [Integer]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] schema_definition
|
1168
|
+
# Definition for a schema on a tabular Dataset.
|
1169
|
+
# @return [Types::SchemaUnion]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] alias
|
1172
|
+
# The unique resource identifier for a Dataset.
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] status
|
1176
|
+
# Status of the Dataset creation.
|
1177
|
+
#
|
1178
|
+
# * `PENDING` - Dataset is pending creation.
|
1179
|
+
#
|
1180
|
+
# * `FAILED` - Dataset creation has failed.
|
1181
|
+
#
|
1182
|
+
# * `SUCCESS` - Dataset creation has succeeded.
|
1183
|
+
#
|
1184
|
+
# * `RUNNING` - Dataset creation is running.
|
1185
|
+
# @return [String]
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDatasetResponse AWS API Documentation
|
1188
|
+
#
|
1189
|
+
class GetDatasetResponse < Struct.new(
|
1190
|
+
:dataset_id,
|
1191
|
+
:dataset_arn,
|
1192
|
+
:dataset_title,
|
1193
|
+
:kind,
|
1194
|
+
:dataset_description,
|
1195
|
+
:create_time,
|
1196
|
+
:last_modified_time,
|
1197
|
+
:schema_definition,
|
1198
|
+
:alias,
|
1199
|
+
:status)
|
1200
|
+
SENSITIVE = []
|
1201
|
+
include Aws::Structure
|
1202
|
+
end
|
1203
|
+
|
1204
|
+
# Request for GetProgrammaticAccessCredentials operation
|
1205
|
+
#
|
1206
|
+
# @note When making an API call, you may pass GetProgrammaticAccessCredentialsRequest
|
1207
|
+
# data as a hash:
|
1208
|
+
#
|
1209
|
+
# {
|
1210
|
+
# duration_in_minutes: 1,
|
1211
|
+
# environment_id: "IdType", # required
|
1212
|
+
# }
|
1213
|
+
#
|
1214
|
+
# @!attribute [rw] duration_in_minutes
|
1215
|
+
# The time duration in which the credentials remain valid.
|
1216
|
+
# @return [Integer]
|
1217
|
+
#
|
1218
|
+
# @!attribute [rw] environment_id
|
1219
|
+
# The FinSpace environment identifier.
|
1220
|
+
# @return [String]
|
1221
|
+
#
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentialsRequest AWS API Documentation
|
1223
|
+
#
|
1224
|
+
class GetProgrammaticAccessCredentialsRequest < Struct.new(
|
1225
|
+
:duration_in_minutes,
|
1226
|
+
:environment_id)
|
1227
|
+
SENSITIVE = []
|
1228
|
+
include Aws::Structure
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# Response for GetProgrammaticAccessCredentials operation
|
1232
|
+
#
|
1233
|
+
# @!attribute [rw] credentials
|
1234
|
+
# Returns the programmatic credentials.
|
1235
|
+
# @return [Types::Credentials]
|
1236
|
+
#
|
1237
|
+
# @!attribute [rw] duration_in_minutes
|
1238
|
+
# Returns the duration in which the credentials will remain valid.
|
1239
|
+
# @return [Integer]
|
1240
|
+
#
|
1241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentialsResponse AWS API Documentation
|
1242
|
+
#
|
1243
|
+
class GetProgrammaticAccessCredentialsResponse < Struct.new(
|
1244
|
+
:credentials,
|
1245
|
+
:duration_in_minutes)
|
1246
|
+
SENSITIVE = []
|
1247
|
+
include Aws::Structure
|
1248
|
+
end
|
1249
|
+
|
1250
|
+
# @note When making an API call, you may pass GetWorkingLocationRequest
|
1251
|
+
# data as a hash:
|
1252
|
+
#
|
1253
|
+
# {
|
1254
|
+
# location_type: "INGESTION", # accepts INGESTION, SAGEMAKER
|
316
1255
|
# }
|
317
1256
|
#
|
318
1257
|
# @!attribute [rw] location_type
|
@@ -324,7 +1263,7 @@ module Aws::FinSpaceData
|
|
324
1263
|
#
|
325
1264
|
# * `INGESTION` - Use the Amazon S3 location as a staging location to
|
326
1265
|
# copy your data content and then use the location with the
|
327
|
-
#
|
1266
|
+
# Changeset creation operation.
|
328
1267
|
# @return [String]
|
329
1268
|
#
|
330
1269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocationRequest AWS API Documentation
|
@@ -371,6 +1310,201 @@ module Aws::FinSpaceData
|
|
371
1310
|
include Aws::Structure
|
372
1311
|
end
|
373
1312
|
|
1313
|
+
# A limit has exceeded.
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] message
|
1316
|
+
# @return [String]
|
1317
|
+
#
|
1318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/LimitExceededException AWS API Documentation
|
1319
|
+
#
|
1320
|
+
class LimitExceededException < Struct.new(
|
1321
|
+
:message)
|
1322
|
+
SENSITIVE = []
|
1323
|
+
include Aws::Structure
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
# Request to ListChangesetsRequest. It exposes minimal query filters.
|
1327
|
+
#
|
1328
|
+
# @note When making an API call, you may pass ListChangesetsRequest
|
1329
|
+
# data as a hash:
|
1330
|
+
#
|
1331
|
+
# {
|
1332
|
+
# dataset_id: "DatasetId", # required
|
1333
|
+
# max_results: 1,
|
1334
|
+
# next_token: "PaginationToken",
|
1335
|
+
# }
|
1336
|
+
#
|
1337
|
+
# @!attribute [rw] dataset_id
|
1338
|
+
# The unique identifier for the FinSpace Dataset to which the
|
1339
|
+
# Changeset belongs.
|
1340
|
+
# @return [String]
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] max_results
|
1343
|
+
# The maximum number of results per page.
|
1344
|
+
# @return [Integer]
|
1345
|
+
#
|
1346
|
+
# @!attribute [rw] next_token
|
1347
|
+
# A token indicating where a results page should begin.
|
1348
|
+
# @return [String]
|
1349
|
+
#
|
1350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesetsRequest AWS API Documentation
|
1351
|
+
#
|
1352
|
+
class ListChangesetsRequest < Struct.new(
|
1353
|
+
:dataset_id,
|
1354
|
+
:max_results,
|
1355
|
+
:next_token)
|
1356
|
+
SENSITIVE = []
|
1357
|
+
include Aws::Structure
|
1358
|
+
end
|
1359
|
+
|
1360
|
+
# Response to ListChangesetsResponse. This returns a list of dataset
|
1361
|
+
# changesets that match the query criteria.
|
1362
|
+
#
|
1363
|
+
# @!attribute [rw] changesets
|
1364
|
+
# List of Changesets found.
|
1365
|
+
# @return [Array<Types::ChangesetSummary>]
|
1366
|
+
#
|
1367
|
+
# @!attribute [rw] next_token
|
1368
|
+
# A token indicating where a results page should begin.
|
1369
|
+
# @return [String]
|
1370
|
+
#
|
1371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesetsResponse AWS API Documentation
|
1372
|
+
#
|
1373
|
+
class ListChangesetsResponse < Struct.new(
|
1374
|
+
:changesets,
|
1375
|
+
:next_token)
|
1376
|
+
SENSITIVE = []
|
1377
|
+
include Aws::Structure
|
1378
|
+
end
|
1379
|
+
|
1380
|
+
# Request for a list data views.
|
1381
|
+
#
|
1382
|
+
# @note When making an API call, you may pass ListDataViewsRequest
|
1383
|
+
# data as a hash:
|
1384
|
+
#
|
1385
|
+
# {
|
1386
|
+
# dataset_id: "DatasetId", # required
|
1387
|
+
# next_token: "PaginationToken",
|
1388
|
+
# max_results: 1,
|
1389
|
+
# }
|
1390
|
+
#
|
1391
|
+
# @!attribute [rw] dataset_id
|
1392
|
+
# The unique identifier of the Dataset for which to retrieve
|
1393
|
+
# Dataviews.
|
1394
|
+
# @return [String]
|
1395
|
+
#
|
1396
|
+
# @!attribute [rw] next_token
|
1397
|
+
# A token indicating where a results page should begin.
|
1398
|
+
# @return [String]
|
1399
|
+
#
|
1400
|
+
# @!attribute [rw] max_results
|
1401
|
+
# The maximum number of results per page.
|
1402
|
+
# @return [Integer]
|
1403
|
+
#
|
1404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViewsRequest AWS API Documentation
|
1405
|
+
#
|
1406
|
+
class ListDataViewsRequest < Struct.new(
|
1407
|
+
:dataset_id,
|
1408
|
+
:next_token,
|
1409
|
+
:max_results)
|
1410
|
+
SENSITIVE = []
|
1411
|
+
include Aws::Structure
|
1412
|
+
end
|
1413
|
+
|
1414
|
+
# @!attribute [rw] next_token
|
1415
|
+
# A token indicating where a results page should begin.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] data_views
|
1419
|
+
# A list of Dataviews.
|
1420
|
+
# @return [Array<Types::DataViewSummary>]
|
1421
|
+
#
|
1422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViewsResponse AWS API Documentation
|
1423
|
+
#
|
1424
|
+
class ListDataViewsResponse < Struct.new(
|
1425
|
+
:next_token,
|
1426
|
+
:data_views)
|
1427
|
+
SENSITIVE = []
|
1428
|
+
include Aws::Structure
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
# Request for the ListDatasets operation.
|
1432
|
+
#
|
1433
|
+
# @note When making an API call, you may pass ListDatasetsRequest
|
1434
|
+
# data as a hash:
|
1435
|
+
#
|
1436
|
+
# {
|
1437
|
+
# next_token: "PaginationToken",
|
1438
|
+
# max_results: 1,
|
1439
|
+
# }
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] next_token
|
1442
|
+
# A token indicating where a results page should begin.
|
1443
|
+
# @return [String]
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] max_results
|
1446
|
+
# The maximum number of results per page.
|
1447
|
+
# @return [Integer]
|
1448
|
+
#
|
1449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasetsRequest AWS API Documentation
|
1450
|
+
#
|
1451
|
+
class ListDatasetsRequest < Struct.new(
|
1452
|
+
:next_token,
|
1453
|
+
:max_results)
|
1454
|
+
SENSITIVE = []
|
1455
|
+
include Aws::Structure
|
1456
|
+
end
|
1457
|
+
|
1458
|
+
# Response for the ListDatasets operation
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] datasets
|
1461
|
+
# List of Datasets.
|
1462
|
+
# @return [Array<Types::Dataset>]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] next_token
|
1465
|
+
# A token indicating where a results page should begin.
|
1466
|
+
# @return [String]
|
1467
|
+
#
|
1468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasetsResponse AWS API Documentation
|
1469
|
+
#
|
1470
|
+
class ListDatasetsResponse < Struct.new(
|
1471
|
+
:datasets,
|
1472
|
+
:next_token)
|
1473
|
+
SENSITIVE = []
|
1474
|
+
include Aws::Structure
|
1475
|
+
end
|
1476
|
+
|
1477
|
+
# Permission group parameters for Dataset permissions.
|
1478
|
+
#
|
1479
|
+
# @note When making an API call, you may pass PermissionGroupParams
|
1480
|
+
# data as a hash:
|
1481
|
+
#
|
1482
|
+
# {
|
1483
|
+
# permission_group_id: "PermissionGroupId",
|
1484
|
+
# dataset_permissions: [
|
1485
|
+
# {
|
1486
|
+
# permission: "StringValueLength1to250",
|
1487
|
+
# },
|
1488
|
+
# ],
|
1489
|
+
# }
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] permission_group_id
|
1492
|
+
# The unique identifier of the PermissionGroup.
|
1493
|
+
# @return [String]
|
1494
|
+
#
|
1495
|
+
# @!attribute [rw] dataset_permissions
|
1496
|
+
# List of resource permissions.
|
1497
|
+
# @return [Array<Types::ResourcePermission>]
|
1498
|
+
#
|
1499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/PermissionGroupParams AWS API Documentation
|
1500
|
+
#
|
1501
|
+
class PermissionGroupParams < Struct.new(
|
1502
|
+
:permission_group_id,
|
1503
|
+
:dataset_permissions)
|
1504
|
+
SENSITIVE = []
|
1505
|
+
include Aws::Structure
|
1506
|
+
end
|
1507
|
+
|
374
1508
|
# One or more resources can't be found.
|
375
1509
|
#
|
376
1510
|
# @!attribute [rw] message
|
@@ -384,12 +1518,258 @@ module Aws::FinSpaceData
|
|
384
1518
|
include Aws::Structure
|
385
1519
|
end
|
386
1520
|
|
1521
|
+
# Resource permission for a Dataset.
|
1522
|
+
#
|
1523
|
+
# @note When making an API call, you may pass ResourcePermission
|
1524
|
+
# data as a hash:
|
1525
|
+
#
|
1526
|
+
# {
|
1527
|
+
# permission: "StringValueLength1to250",
|
1528
|
+
# }
|
1529
|
+
#
|
1530
|
+
# @!attribute [rw] permission
|
1531
|
+
# Permission for a resource.
|
1532
|
+
# @return [String]
|
1533
|
+
#
|
1534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResourcePermission AWS API Documentation
|
1535
|
+
#
|
1536
|
+
class ResourcePermission < Struct.new(
|
1537
|
+
:permission)
|
1538
|
+
SENSITIVE = []
|
1539
|
+
include Aws::Structure
|
1540
|
+
end
|
1541
|
+
|
1542
|
+
# Definition for a schema on a tabular Dataset.
|
1543
|
+
#
|
1544
|
+
# @note When making an API call, you may pass SchemaDefinition
|
1545
|
+
# data as a hash:
|
1546
|
+
#
|
1547
|
+
# {
|
1548
|
+
# columns: [
|
1549
|
+
# {
|
1550
|
+
# data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
|
1551
|
+
# column_name: "ColumnName",
|
1552
|
+
# column_description: "ColumnDescription",
|
1553
|
+
# },
|
1554
|
+
# ],
|
1555
|
+
# primary_key_columns: ["ColumnName"],
|
1556
|
+
# }
|
1557
|
+
#
|
1558
|
+
# @!attribute [rw] columns
|
1559
|
+
# List of column definitions.
|
1560
|
+
# @return [Array<Types::ColumnDefinition>]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] primary_key_columns
|
1563
|
+
# List of column names used for primary key.
|
1564
|
+
# @return [Array<String>]
|
1565
|
+
#
|
1566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/SchemaDefinition AWS API Documentation
|
1567
|
+
#
|
1568
|
+
class SchemaDefinition < Struct.new(
|
1569
|
+
:columns,
|
1570
|
+
:primary_key_columns)
|
1571
|
+
SENSITIVE = []
|
1572
|
+
include Aws::Structure
|
1573
|
+
end
|
1574
|
+
|
1575
|
+
# A union of schema types.
|
1576
|
+
#
|
1577
|
+
# @note When making an API call, you may pass SchemaUnion
|
1578
|
+
# data as a hash:
|
1579
|
+
#
|
1580
|
+
# {
|
1581
|
+
# tabular_schema_config: {
|
1582
|
+
# columns: [
|
1583
|
+
# {
|
1584
|
+
# data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
|
1585
|
+
# column_name: "ColumnName",
|
1586
|
+
# column_description: "ColumnDescription",
|
1587
|
+
# },
|
1588
|
+
# ],
|
1589
|
+
# primary_key_columns: ["ColumnName"],
|
1590
|
+
# },
|
1591
|
+
# }
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] tabular_schema_config
|
1594
|
+
# The configuration for a schema on a tabular Dataset.
|
1595
|
+
# @return [Types::SchemaDefinition]
|
1596
|
+
#
|
1597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/SchemaUnion AWS API Documentation
|
1598
|
+
#
|
1599
|
+
class SchemaUnion < Struct.new(
|
1600
|
+
:tabular_schema_config)
|
1601
|
+
SENSITIVE = []
|
1602
|
+
include Aws::Structure
|
1603
|
+
end
|
1604
|
+
|
387
1605
|
# The request was denied due to request throttling.
|
388
1606
|
#
|
389
1607
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ThrottlingException AWS API Documentation
|
390
1608
|
#
|
391
1609
|
class ThrottlingException < Aws::EmptyStructure; end
|
392
1610
|
|
1611
|
+
# Request to update an existing changeset.
|
1612
|
+
#
|
1613
|
+
# @note When making an API call, you may pass UpdateChangesetRequest
|
1614
|
+
# data as a hash:
|
1615
|
+
#
|
1616
|
+
# {
|
1617
|
+
# client_token: "ClientToken",
|
1618
|
+
# dataset_id: "DatasetId", # required
|
1619
|
+
# changeset_id: "ChangesetId", # required
|
1620
|
+
# source_params: { # required
|
1621
|
+
# "StringMapKey" => "StringMapValue",
|
1622
|
+
# },
|
1623
|
+
# format_params: { # required
|
1624
|
+
# "StringMapKey" => "StringMapValue",
|
1625
|
+
# },
|
1626
|
+
# }
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] client_token
|
1629
|
+
# A token used to ensure idempotency.
|
1630
|
+
#
|
1631
|
+
# **A suitable default value is auto-generated.** You should normally
|
1632
|
+
# not need to pass this option.
|
1633
|
+
# @return [String]
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] dataset_id
|
1636
|
+
# The unique identifier for the FinSpace Dataset in which the
|
1637
|
+
# Changeset is created.
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] changeset_id
|
1641
|
+
# The unique identifier for the Changeset to update.
|
1642
|
+
# @return [String]
|
1643
|
+
#
|
1644
|
+
# @!attribute [rw] source_params
|
1645
|
+
# Options that define the location of the data being ingested.
|
1646
|
+
# @return [Hash<String,String>]
|
1647
|
+
#
|
1648
|
+
# @!attribute [rw] format_params
|
1649
|
+
# Options that define the structure of the source file(s).
|
1650
|
+
# @return [Hash<String,String>]
|
1651
|
+
#
|
1652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangesetRequest AWS API Documentation
|
1653
|
+
#
|
1654
|
+
class UpdateChangesetRequest < Struct.new(
|
1655
|
+
:client_token,
|
1656
|
+
:dataset_id,
|
1657
|
+
:changeset_id,
|
1658
|
+
:source_params,
|
1659
|
+
:format_params)
|
1660
|
+
SENSITIVE = []
|
1661
|
+
include Aws::Structure
|
1662
|
+
end
|
1663
|
+
|
1664
|
+
# The response from a update changeset operation.
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] changeset_id
|
1667
|
+
# The unique identifier for the Changeset to update.
|
1668
|
+
# @return [String]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] dataset_id
|
1671
|
+
# The unique identifier for the FinSpace Dataset in which the
|
1672
|
+
# Changeset is created.
|
1673
|
+
# @return [String]
|
1674
|
+
#
|
1675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangesetResponse AWS API Documentation
|
1676
|
+
#
|
1677
|
+
class UpdateChangesetResponse < Struct.new(
|
1678
|
+
:changeset_id,
|
1679
|
+
:dataset_id)
|
1680
|
+
SENSITIVE = []
|
1681
|
+
include Aws::Structure
|
1682
|
+
end
|
1683
|
+
|
1684
|
+
# The request for an UpdateDataset operation
|
1685
|
+
#
|
1686
|
+
# @note When making an API call, you may pass UpdateDatasetRequest
|
1687
|
+
# data as a hash:
|
1688
|
+
#
|
1689
|
+
# {
|
1690
|
+
# client_token: "ClientToken",
|
1691
|
+
# dataset_id: "DatasetId", # required
|
1692
|
+
# dataset_title: "DatasetTitle", # required
|
1693
|
+
# kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
|
1694
|
+
# dataset_description: "DatasetDescription",
|
1695
|
+
# alias: "AliasString",
|
1696
|
+
# schema_definition: {
|
1697
|
+
# tabular_schema_config: {
|
1698
|
+
# columns: [
|
1699
|
+
# {
|
1700
|
+
# data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
|
1701
|
+
# column_name: "ColumnName",
|
1702
|
+
# column_description: "ColumnDescription",
|
1703
|
+
# },
|
1704
|
+
# ],
|
1705
|
+
# primary_key_columns: ["ColumnName"],
|
1706
|
+
# },
|
1707
|
+
# },
|
1708
|
+
# }
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] client_token
|
1711
|
+
# A token used to ensure idempotency.
|
1712
|
+
#
|
1713
|
+
# **A suitable default value is auto-generated.** You should normally
|
1714
|
+
# not need to pass this option.
|
1715
|
+
# @return [String]
|
1716
|
+
#
|
1717
|
+
# @!attribute [rw] dataset_id
|
1718
|
+
# The unique identifier for the Dataset to update.
|
1719
|
+
# @return [String]
|
1720
|
+
#
|
1721
|
+
# @!attribute [rw] dataset_title
|
1722
|
+
# A display title for the Dataset.
|
1723
|
+
# @return [String]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] kind
|
1726
|
+
# The format in which the Dataset data is structured.
|
1727
|
+
#
|
1728
|
+
# * `TABULAR` - Data is structured in a tabular format.
|
1729
|
+
#
|
1730
|
+
# * `NON_TABULAR` - Data is structured in a non-tabular format.
|
1731
|
+
# @return [String]
|
1732
|
+
#
|
1733
|
+
# @!attribute [rw] dataset_description
|
1734
|
+
# A description for the Dataset.
|
1735
|
+
# @return [String]
|
1736
|
+
#
|
1737
|
+
# @!attribute [rw] alias
|
1738
|
+
# The unique resource identifier for a Dataset.
|
1739
|
+
# @return [String]
|
1740
|
+
#
|
1741
|
+
# @!attribute [rw] schema_definition
|
1742
|
+
# Definition for a schema on a tabular Dataset.
|
1743
|
+
# @return [Types::SchemaUnion]
|
1744
|
+
#
|
1745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDatasetRequest AWS API Documentation
|
1746
|
+
#
|
1747
|
+
class UpdateDatasetRequest < Struct.new(
|
1748
|
+
:client_token,
|
1749
|
+
:dataset_id,
|
1750
|
+
:dataset_title,
|
1751
|
+
:kind,
|
1752
|
+
:dataset_description,
|
1753
|
+
:alias,
|
1754
|
+
:schema_definition)
|
1755
|
+
SENSITIVE = []
|
1756
|
+
include Aws::Structure
|
1757
|
+
end
|
1758
|
+
|
1759
|
+
# The response from an UpdateDataset operation
|
1760
|
+
#
|
1761
|
+
# @!attribute [rw] dataset_id
|
1762
|
+
# The unique identifier for updated Dataset.
|
1763
|
+
# @return [String]
|
1764
|
+
#
|
1765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDatasetResponse AWS API Documentation
|
1766
|
+
#
|
1767
|
+
class UpdateDatasetResponse < Struct.new(
|
1768
|
+
:dataset_id)
|
1769
|
+
SENSITIVE = []
|
1770
|
+
include Aws::Structure
|
1771
|
+
end
|
1772
|
+
|
393
1773
|
# The input fails to satisfy the constraints specified by an AWS
|
394
1774
|
# service.
|
395
1775
|
#
|