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