aws-sdk-finspacedata 1.4.0 → 1.8.0

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