aws-sdk-finspacedata 1.8.0 → 1.12.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ea0b0ac4c3e38e5e75092e67bc40467874ba7fabbbf2ed7b4019fc7bcd6c2434
4
- data.tar.gz: 535e3af4d120d45be80a1afbec9ca349a5e0591fe32c583acebba5e5df029636
3
+ metadata.gz: b22345c48083db19ba7bd619eacaed6f3b14b47f021fe54dd7405979b4222a5f
4
+ data.tar.gz: cafc91eefcf46a5f3b1ff0703dd2689b021f4f8e79e40e19cb10f2858321fc53
5
5
  SHA512:
6
- metadata.gz: e67e11e174d6e641b8c3857067fc743352185a3580232c34768d4a6d6f3d92b78abf21dd867e71bf5614f7d9b0465e5ee6b48624ba459faf42d54e83fc68ff25
7
- data.tar.gz: d0c354aeb330d0fed073ec9a6cc31574b5b0d38ffa3a54099df52199d81f148ef94751551a68115199c9176a247bfbdd4ad44c6806947a4b0302b9fdfe073952
6
+ metadata.gz: a5065b97b662a433d005426ea8bc03f31336db28afd696b8c6c24a8dece4cd5d102e370751f5c820b87e55fbdacbd17a3f63cbe5b7285596fca2b9c9800bf060
7
+ data.tar.gz: bc30e49633c4e3576bdcd129a02d61fbe004570bcd2ba332b998b3920c44d4d592392e8b873c138a28c1a80c6044e9b20e0a27da0324f3eb21e407df181f06fe
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.12.0 (2022-02-03)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.11.0 (2022-01-11)
10
+ ------------------
11
+
12
+ * Feature - Documentation updates for FinSpace.
13
+
14
+ 1.10.0 (2021-12-21)
15
+ ------------------
16
+
17
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
18
+
19
+ 1.9.0 (2021-12-20)
20
+ ------------------
21
+
22
+ * Feature - Make dataset description optional and allow s3 export for dataviews
23
+
4
24
  1.8.0 (2021-11-30)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.8.0
1
+ 1.12.0
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
31
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
30
32
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
33
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
34
  require 'aws-sdk-finspacedata/plugins/content_type.rb'
@@ -74,6 +76,8 @@ module Aws::FinSpaceData
74
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
75
77
  add_plugin(Aws::Plugins::TransferEncoding)
76
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::DefaultsMode)
80
+ add_plugin(Aws::Plugins::RecursionDetection)
77
81
  add_plugin(Aws::Plugins::SignatureV4)
78
82
  add_plugin(Aws::Plugins::Protocols::RestJson)
79
83
  add_plugin(Aws::FinSpaceData::Plugins::ContentType)
@@ -177,6 +181,10 @@ module Aws::FinSpaceData
177
181
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
178
182
  # a clock skew correction and retry requests with skewed client clocks.
179
183
  #
184
+ # @option options [String] :defaults_mode ("legacy")
185
+ # See {Aws::DefaultsModeConfiguration} for a list of the
186
+ # accepted modes and the configuration defaults that are included.
187
+ #
180
188
  # @option options [Boolean] :disable_host_prefix_injection (false)
181
189
  # Set to true to disable SDK automatically adding host prefix
182
190
  # to default service endpoint when available.
@@ -299,7 +307,7 @@ module Aws::FinSpaceData
299
307
  # seconds to wait when opening a HTTP session before raising a
300
308
  # `Timeout::Error`.
301
309
  #
302
- # @option options [Integer] :http_read_timeout (60) The default
310
+ # @option options [Float] :http_read_timeout (60) The default
303
311
  # number of seconds to wait for response data. This value can
304
312
  # safely be set per-request on the session.
305
313
  #
@@ -315,6 +323,9 @@ module Aws::FinSpaceData
315
323
  # disables this behaviour. This value can safely be set per
316
324
  # request on the session.
317
325
  #
326
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
327
+ # in seconds.
328
+ #
318
329
  # @option options [Boolean] :http_wire_trace (false) When `true`,
319
330
  # HTTP debug output will be sent to the `:logger`.
320
331
  #
@@ -343,7 +354,7 @@ module Aws::FinSpaceData
343
354
  # Creates a new Changeset in a FinSpace Dataset.
344
355
  #
345
356
  # @option params [String] :client_token
346
- # A token used to ensure idempotency.
357
+ # A token that ensures idempotency. This token expires in 10 minutes.
347
358
  #
348
359
  # **A suitable default value is auto-generated.** You should normally
349
360
  # not need to pass this option.**
@@ -365,7 +376,25 @@ module Aws::FinSpaceData
365
376
  # prior ingested Changeset.
366
377
  #
367
378
  # @option params [required, Hash<String,String>] :source_params
368
- # Options that define the location of the data being ingested.
379
+ # Options that define the location of the data being ingested
380
+ # (`s3SourcePath`) and the source of the changeset (`sourceType`).
381
+ #
382
+ # Both `s3SourcePath` and `sourceType` are required attributes.
383
+ #
384
+ # Here is an example of how you could specify the `sourceParams`\:
385
+ #
386
+ # ` "sourceParams": \{ "s3SourcePath":
387
+ # "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
388
+ # "sourceType": "S3" \} `
389
+ #
390
+ # The S3 path that you specify must allow the FinSpace role access. To
391
+ # do that, you first need to configure the IAM policy on S3 bucket. For
392
+ # more information, see [Loading data from an Amazon S3 Bucket using the
393
+ # FinSpace API][1]section.
394
+ #
395
+ #
396
+ #
397
+ # [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
369
398
  #
370
399
  # @option params [required, Hash<String,String>] :format_params
371
400
  # Options that define the structure of the source file(s) including the
@@ -383,10 +412,23 @@ module Aws::FinSpaceData
383
412
  #
384
413
  # * `XML` - XML source file format.
385
414
  #
386
- # For example, you could specify the following for `formatParams`\: `
387
- # "formatParams": \{ "formatType": "CSV", "withHeader": "true",
415
+ # Here is an example of how you could specify the `formatParams`\:
416
+ #
417
+ # ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
388
418
  # "separator": ",", "compression":"None" \} `
389
419
  #
420
+ # Note that if you only provide `formatType` as `CSV`, the rest of the
421
+ # attributes will automatically default to CSV values as following:
422
+ #
423
+ # ` \{ "withHeader": "true", "separator": "," \} `
424
+ #
425
+ # For more information about supported file formats, see [Supported Data
426
+ # Types and File Formats][1] in the FinSpace User Guide.
427
+ #
428
+ #
429
+ #
430
+ # [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
431
+ #
390
432
  # @return [Types::CreateChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
391
433
  #
392
434
  # * {Types::CreateChangesetResponse#dataset_id #dataset_id} => String
@@ -423,7 +465,7 @@ module Aws::FinSpaceData
423
465
  # Creates a Dataview for a Dataset.
424
466
  #
425
467
  # @option params [String] :client_token
426
- # A token used to ensure idempotency.
468
+ # A token that ensures idempotency. This token expires in 10 minutes.
427
469
  #
428
470
  # **A suitable default value is auto-generated.** You should normally
429
471
  # not need to pass this option.**
@@ -464,6 +506,10 @@ module Aws::FinSpaceData
464
506
  # as_of_timestamp: 1,
465
507
  # destination_type_params: { # required
466
508
  # destination_type: "DataViewDestinationType", # required
509
+ # s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
510
+ # s3_destination_export_file_format_options: {
511
+ # "StringMapKey" => "StringMapValue",
512
+ # },
467
513
  # },
468
514
  # })
469
515
  #
@@ -484,7 +530,7 @@ module Aws::FinSpaceData
484
530
  # Creates a new FinSpace Dataset.
485
531
  #
486
532
  # @option params [String] :client_token
487
- # A token used to ensure idempotency.
533
+ # A token that ensures idempotency. This token expires in 10 minutes.
488
534
  #
489
535
  # **A suitable default value is auto-generated.** You should normally
490
536
  # not need to pass this option.**
@@ -499,7 +545,7 @@ module Aws::FinSpaceData
499
545
  #
500
546
  # * `NON_TABULAR` - Data is structured in a non-tabular format.
501
547
  #
502
- # @option params [required, String] :dataset_description
548
+ # @option params [String] :dataset_description
503
549
  # Description of a Dataset.
504
550
  #
505
551
  # @option params [Types::DatasetOwnerInfo] :owner_info
@@ -508,7 +554,7 @@ module Aws::FinSpaceData
508
554
  # @option params [required, Types::PermissionGroupParams] :permission_group_params
509
555
  # Permission group parameters for Dataset permissions.
510
556
  #
511
- # @option params [required, String] :alias
557
+ # @option params [String] :alias
512
558
  # The unique resource identifier for a Dataset.
513
559
  #
514
560
  # @option params [Types::SchemaUnion] :schema_definition
@@ -524,7 +570,7 @@ module Aws::FinSpaceData
524
570
  # client_token: "ClientToken",
525
571
  # dataset_title: "DatasetTitle", # required
526
572
  # kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
527
- # dataset_description: "DatasetDescription", # required
573
+ # dataset_description: "DatasetDescription",
528
574
  # owner_info: {
529
575
  # name: "OwnerName",
530
576
  # phone_number: "PhoneNumber",
@@ -538,7 +584,7 @@ module Aws::FinSpaceData
538
584
  # },
539
585
  # ],
540
586
  # },
541
- # alias: "AliasString", # required
587
+ # alias: "AliasString",
542
588
  # schema_definition: {
543
589
  # tabular_schema_config: {
544
590
  # columns: [
@@ -569,7 +615,7 @@ module Aws::FinSpaceData
569
615
  # Deletes a FinSpace Dataset.
570
616
  #
571
617
  # @option params [String] :client_token
572
- # A token used to ensure idempotency.
618
+ # A token that ensures idempotency. This token expires in 10 minutes.
573
619
  #
574
620
  # **A suitable default value is auto-generated.** You should normally
575
621
  # not need to pass this option.**
@@ -622,6 +668,7 @@ module Aws::FinSpaceData
622
668
  # * {Types::GetChangesetResponse#status #status} => String
623
669
  # * {Types::GetChangesetResponse#error_info #error_info} => Types::ChangesetErrorInfo
624
670
  # * {Types::GetChangesetResponse#active_until_timestamp #active_until_timestamp} => Integer
671
+ # * {Types::GetChangesetResponse#active_from_timestamp #active_from_timestamp} => Integer
625
672
  # * {Types::GetChangesetResponse#updates_changeset_id #updates_changeset_id} => String
626
673
  # * {Types::GetChangesetResponse#updated_by_changeset_id #updated_by_changeset_id} => String
627
674
  #
@@ -647,6 +694,7 @@ module Aws::FinSpaceData
647
694
  # resp.error_info.error_message #=> String
648
695
  # resp.error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
649
696
  # resp.active_until_timestamp #=> Integer
697
+ # resp.active_from_timestamp #=> Integer
650
698
  # resp.updates_changeset_id #=> String
651
699
  # resp.updated_by_changeset_id #=> String
652
700
  #
@@ -705,6 +753,9 @@ module Aws::FinSpaceData
705
753
  # resp.data_view_id #=> String
706
754
  # resp.data_view_arn #=> String
707
755
  # resp.destination_type_params.destination_type #=> String
756
+ # resp.destination_type_params.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
757
+ # resp.destination_type_params.s3_destination_export_file_format_options #=> Hash
758
+ # resp.destination_type_params.s3_destination_export_file_format_options["StringMapKey"] #=> String
708
759
  # resp.status #=> String, one of "RUNNING", "STARTING", "FAILED", "CANCELLED", "TIMEOUT", "SUCCESS", "PENDING", "FAILED_CLEANUP_FAILED"
709
760
  #
710
761
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView AWS API Documentation
@@ -888,6 +939,7 @@ module Aws::FinSpaceData
888
939
  # resp.changesets[0].error_info.error_message #=> String
889
940
  # resp.changesets[0].error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
890
941
  # resp.changesets[0].active_until_timestamp #=> Integer
942
+ # resp.changesets[0].active_from_timestamp #=> Integer
891
943
  # resp.changesets[0].updates_changeset_id #=> String
892
944
  # resp.changesets[0].updated_by_changeset_id #=> String
893
945
  # resp.next_token #=> String
@@ -943,6 +995,9 @@ module Aws::FinSpaceData
943
995
  # resp.data_views[0].error_info.error_message #=> String
944
996
  # resp.data_views[0].error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
945
997
  # resp.data_views[0].destination_type_properties.destination_type #=> String
998
+ # resp.data_views[0].destination_type_properties.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
999
+ # resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options #=> Hash
1000
+ # resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options["StringMapKey"] #=> String
946
1001
  # resp.data_views[0].auto_update #=> Boolean
947
1002
  # resp.data_views[0].create_time #=> Integer
948
1003
  # resp.data_views[0].last_modified_time #=> Integer
@@ -1012,7 +1067,7 @@ module Aws::FinSpaceData
1012
1067
  # Updates a FinSpace Changeset.
1013
1068
  #
1014
1069
  # @option params [String] :client_token
1015
- # A token used to ensure idempotency.
1070
+ # A token that ensures idempotency. This token expires in 10 minutes.
1016
1071
  #
1017
1072
  # **A suitable default value is auto-generated.** You should normally
1018
1073
  # not need to pass this option.**
@@ -1025,10 +1080,58 @@ module Aws::FinSpaceData
1025
1080
  # The unique identifier for the Changeset to update.
1026
1081
  #
1027
1082
  # @option params [required, Hash<String,String>] :source_params
1028
- # Options that define the location of the data being ingested.
1083
+ # Options that define the location of the data being ingested
1084
+ # (`s3SourcePath`) and the source of the changeset (`sourceType`).
1085
+ #
1086
+ # Both `s3SourcePath` and `sourceType` are required attributes.
1087
+ #
1088
+ # Here is an example of how you could specify the `sourceParams`\:
1089
+ #
1090
+ # ` "sourceParams": \{ "s3SourcePath":
1091
+ # "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
1092
+ # "sourceType": "S3" \} `
1093
+ #
1094
+ # The S3 path that you specify must allow the FinSpace role access. To
1095
+ # do that, you first need to configure the IAM policy on S3 bucket. For
1096
+ # more information, see [Loading data from an Amazon S3 Bucket using the
1097
+ # FinSpace API][1]section.
1098
+ #
1099
+ #
1100
+ #
1101
+ # [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
1029
1102
  #
1030
1103
  # @option params [required, Hash<String,String>] :format_params
1031
- # Options that define the structure of the source file(s).
1104
+ # Options that define the structure of the source file(s) including the
1105
+ # format type (`formatType`), header row (`withHeader`), data separation
1106
+ # character (`separator`) and the type of compression (`compression`).
1107
+ #
1108
+ # `formatType` is a required attribute and can have the following
1109
+ # values:
1110
+ #
1111
+ # * `PARQUET` - Parquet source file format.
1112
+ #
1113
+ # * `CSV` - CSV source file format.
1114
+ #
1115
+ # * `JSON` - JSON source file format.
1116
+ #
1117
+ # * `XML` - XML source file format.
1118
+ #
1119
+ # Here is an example of how you could specify the `formatParams`\:
1120
+ #
1121
+ # ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
1122
+ # "separator": ",", "compression":"None" \} `
1123
+ #
1124
+ # Note that if you only provide `formatType` as `CSV`, the rest of the
1125
+ # attributes will automatically default to CSV values as following:
1126
+ #
1127
+ # ` \{ "withHeader": "true", "separator": "," \} `
1128
+ #
1129
+ # For more information about supported file formats, see [Supported Data
1130
+ # Types and File Formats][1] in the FinSpace User Guide.
1131
+ #
1132
+ #
1133
+ #
1134
+ # [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
1032
1135
  #
1033
1136
  # @return [Types::UpdateChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1034
1137
  #
@@ -1066,7 +1169,7 @@ module Aws::FinSpaceData
1066
1169
  # Updates a FinSpace Dataset.
1067
1170
  #
1068
1171
  # @option params [String] :client_token
1069
- # A token used to ensure idempotency.
1172
+ # A token that ensures idempotency. This token expires in 10 minutes.
1070
1173
  #
1071
1174
  # **A suitable default value is auto-generated.** You should normally
1072
1175
  # not need to pass this option.**
@@ -1087,7 +1190,7 @@ module Aws::FinSpaceData
1087
1190
  # @option params [String] :dataset_description
1088
1191
  # A description for the Dataset.
1089
1192
  #
1090
- # @option params [required, String] :alias
1193
+ # @option params [String] :alias
1091
1194
  # The unique resource identifier for a Dataset.
1092
1195
  #
1093
1196
  # @option params [Types::SchemaUnion] :schema_definition
@@ -1105,7 +1208,7 @@ module Aws::FinSpaceData
1105
1208
  # dataset_title: "DatasetTitle", # required
1106
1209
  # kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
1107
1210
  # dataset_description: "DatasetDescription",
1108
- # alias: "AliasString", # required
1211
+ # alias: "AliasString",
1109
1212
  # schema_definition: {
1110
1213
  # tabular_schema_config: {
1111
1214
  # columns: [
@@ -1146,7 +1249,7 @@ module Aws::FinSpaceData
1146
1249
  params: params,
1147
1250
  config: config)
1148
1251
  context[:gem_name] = 'aws-sdk-finspacedata'
1149
- context[:gem_version] = '1.8.0'
1252
+ context[:gem_version] = '1.12.0'
1150
1253
  Seahorse::Client::Request.new(handlers, context)
1151
1254
  end
1152
1255
 
@@ -59,6 +59,7 @@ module Aws::FinSpaceData
59
59
  Email = Shapes::StringShape.new(name: 'Email')
60
60
  ErrorCategory = Shapes::StringShape.new(name: 'ErrorCategory')
61
61
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
62
+ ExportFileFormat = Shapes::StringShape.new(name: 'ExportFileFormat')
62
63
  FormatParams = Shapes::MapShape.new(name: 'FormatParams')
63
64
  GetChangesetRequest = Shapes::StructureShape.new(name: 'GetChangesetRequest')
64
65
  GetChangesetResponse = Shapes::StructureShape.new(name: 'GetChangesetResponse')
@@ -90,6 +91,7 @@ module Aws::FinSpaceData
90
91
  ResourcePermission = Shapes::StructureShape.new(name: 'ResourcePermission')
91
92
  ResourcePermissionsList = Shapes::ListShape.new(name: 'ResourcePermissionsList')
92
93
  ResultLimit = Shapes::IntegerShape.new(name: 'ResultLimit')
94
+ S3DestinationFormatOptions = Shapes::MapShape.new(name: 'S3DestinationFormatOptions')
93
95
  SchemaDefinition = Shapes::StructureShape.new(name: 'SchemaDefinition')
94
96
  SchemaUnion = Shapes::StructureShape.new(name: 'SchemaUnion')
95
97
  SessionDuration = Shapes::IntegerShape.new(name: 'SessionDuration')
@@ -132,6 +134,7 @@ module Aws::FinSpaceData
132
134
  ChangesetSummary.add_member(:status, Shapes::ShapeRef.new(shape: IngestionStatus, location_name: "status"))
133
135
  ChangesetSummary.add_member(:error_info, Shapes::ShapeRef.new(shape: ChangesetErrorInfo, location_name: "errorInfo"))
134
136
  ChangesetSummary.add_member(:active_until_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeUntilTimestamp", metadata: {"box"=>true}))
137
+ ChangesetSummary.add_member(:active_from_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeFromTimestamp", metadata: {"box"=>true}))
135
138
  ChangesetSummary.add_member(:updates_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatesChangesetId"))
136
139
  ChangesetSummary.add_member(:updated_by_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatedByChangesetId"))
137
140
  ChangesetSummary.struct_class = Types::ChangesetSummary
@@ -175,10 +178,10 @@ module Aws::FinSpaceData
175
178
  CreateDatasetRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
176
179
  CreateDatasetRequest.add_member(:dataset_title, Shapes::ShapeRef.new(shape: DatasetTitle, required: true, location_name: "datasetTitle"))
177
180
  CreateDatasetRequest.add_member(:kind, Shapes::ShapeRef.new(shape: DatasetKind, required: true, location_name: "kind"))
178
- CreateDatasetRequest.add_member(:dataset_description, Shapes::ShapeRef.new(shape: DatasetDescription, required: true, location_name: "datasetDescription"))
181
+ CreateDatasetRequest.add_member(:dataset_description, Shapes::ShapeRef.new(shape: DatasetDescription, location_name: "datasetDescription"))
179
182
  CreateDatasetRequest.add_member(:owner_info, Shapes::ShapeRef.new(shape: DatasetOwnerInfo, location_name: "ownerInfo"))
180
183
  CreateDatasetRequest.add_member(:permission_group_params, Shapes::ShapeRef.new(shape: PermissionGroupParams, required: true, location_name: "permissionGroupParams"))
181
- CreateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, required: true, location_name: "alias"))
184
+ CreateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, location_name: "alias"))
182
185
  CreateDatasetRequest.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaUnion, location_name: "schemaDefinition"))
183
186
  CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
184
187
 
@@ -191,6 +194,8 @@ module Aws::FinSpaceData
191
194
  Credentials.struct_class = Types::Credentials
192
195
 
193
196
  DataViewDestinationTypeParams.add_member(:destination_type, Shapes::ShapeRef.new(shape: DataViewDestinationType, required: true, location_name: "destinationType"))
197
+ DataViewDestinationTypeParams.add_member(:s3_destination_export_file_format, Shapes::ShapeRef.new(shape: ExportFileFormat, location_name: "s3DestinationExportFileFormat"))
198
+ DataViewDestinationTypeParams.add_member(:s3_destination_export_file_format_options, Shapes::ShapeRef.new(shape: S3DestinationFormatOptions, location_name: "s3DestinationExportFileFormatOptions"))
194
199
  DataViewDestinationTypeParams.struct_class = Types::DataViewDestinationTypeParams
195
200
 
196
201
  DataViewErrorInfo.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
@@ -256,6 +261,7 @@ module Aws::FinSpaceData
256
261
  GetChangesetResponse.add_member(:status, Shapes::ShapeRef.new(shape: IngestionStatus, location_name: "status"))
257
262
  GetChangesetResponse.add_member(:error_info, Shapes::ShapeRef.new(shape: ChangesetErrorInfo, location_name: "errorInfo"))
258
263
  GetChangesetResponse.add_member(:active_until_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeUntilTimestamp", metadata: {"box"=>true}))
264
+ GetChangesetResponse.add_member(:active_from_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeFromTimestamp", metadata: {"box"=>true}))
259
265
  GetChangesetResponse.add_member(:updates_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatesChangesetId"))
260
266
  GetChangesetResponse.add_member(:updated_by_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatedByChangesetId"))
261
267
  GetChangesetResponse.struct_class = Types::GetChangesetResponse
@@ -355,6 +361,9 @@ module Aws::FinSpaceData
355
361
 
356
362
  ResourcePermissionsList.member = Shapes::ShapeRef.new(shape: ResourcePermission)
357
363
 
364
+ S3DestinationFormatOptions.key = Shapes::ShapeRef.new(shape: StringMapKey)
365
+ S3DestinationFormatOptions.value = Shapes::ShapeRef.new(shape: StringMapValue)
366
+
358
367
  SchemaDefinition.add_member(:columns, Shapes::ShapeRef.new(shape: ColumnList, location_name: "columns"))
359
368
  SchemaDefinition.add_member(:primary_key_columns, Shapes::ShapeRef.new(shape: ColumnNameList, location_name: "primaryKeyColumns"))
360
369
  SchemaDefinition.struct_class = Types::SchemaDefinition
@@ -385,7 +394,7 @@ module Aws::FinSpaceData
385
394
  UpdateDatasetRequest.add_member(:dataset_title, Shapes::ShapeRef.new(shape: DatasetTitle, required: true, location_name: "datasetTitle"))
386
395
  UpdateDatasetRequest.add_member(:kind, Shapes::ShapeRef.new(shape: DatasetKind, required: true, location_name: "kind"))
387
396
  UpdateDatasetRequest.add_member(:dataset_description, Shapes::ShapeRef.new(shape: DatasetDescription, location_name: "datasetDescription"))
388
- UpdateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, required: true, location_name: "alias"))
397
+ UpdateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, location_name: "alias"))
389
398
  UpdateDatasetRequest.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaUnion, location_name: "schemaDefinition"))
390
399
  UpdateDatasetRequest.struct_class = Types::UpdateDatasetRequest
391
400
 
@@ -130,6 +130,13 @@ module Aws::FinSpaceData
130
130
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
131
131
  # @return [Integer]
132
132
  #
133
+ # @!attribute [rw] active_from_timestamp
134
+ # Beginning time from which the Changeset is active. The value is
135
+ # determined as Epoch time in milliseconds. For example, the value for
136
+ # Monday, November 1, 2021 12:00:00 PM UTC is specified as
137
+ # 1635768000000.
138
+ # @return [Integer]
139
+ #
133
140
  # @!attribute [rw] updates_changeset_id
134
141
  # The unique identifier of the Changeset that is updated.
135
142
  # @return [String]
@@ -151,6 +158,7 @@ module Aws::FinSpaceData
151
158
  :status,
152
159
  :error_info,
153
160
  :active_until_timestamp,
161
+ :active_from_timestamp,
154
162
  :updates_changeset_id,
155
163
  :updated_by_changeset_id)
156
164
  SENSITIVE = []
@@ -245,7 +253,7 @@ module Aws::FinSpaceData
245
253
  # }
246
254
  #
247
255
  # @!attribute [rw] client_token
248
- # A token used to ensure idempotency.
256
+ # A token that ensures idempotency. This token expires in 10 minutes.
249
257
  #
250
258
  # **A suitable default value is auto-generated.** You should normally
251
259
  # not need to pass this option.
@@ -270,7 +278,25 @@ module Aws::FinSpaceData
270
278
  # @return [String]
271
279
  #
272
280
  # @!attribute [rw] source_params
273
- # Options that define the location of the data being ingested.
281
+ # Options that define the location of the data being ingested
282
+ # (`s3SourcePath`) and the source of the changeset (`sourceType`).
283
+ #
284
+ # Both `s3SourcePath` and `sourceType` are required attributes.
285
+ #
286
+ # Here is an example of how you could specify the `sourceParams`\:
287
+ #
288
+ # ` "sourceParams": \{ "s3SourcePath":
289
+ # "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
290
+ # "sourceType": "S3" \} `
291
+ #
292
+ # The S3 path that you specify must allow the FinSpace role access. To
293
+ # do that, you first need to configure the IAM policy on S3 bucket.
294
+ # For more information, see [Loading data from an Amazon S3 Bucket
295
+ # using the FinSpace API][1]section.
296
+ #
297
+ #
298
+ #
299
+ # [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
274
300
  # @return [Hash<String,String>]
275
301
  #
276
302
  # @!attribute [rw] format_params
@@ -290,9 +316,22 @@ module Aws::FinSpaceData
290
316
  #
291
317
  # * `XML` - XML source file format.
292
318
  #
293
- # For example, you could specify the following for `formatParams`\: `
294
- # "formatParams": \{ "formatType": "CSV", "withHeader": "true",
319
+ # Here is an example of how you could specify the `formatParams`\:
320
+ #
321
+ # ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
295
322
  # "separator": ",", "compression":"None" \} `
323
+ #
324
+ # Note that if you only provide `formatType` as `CSV`, the rest of the
325
+ # attributes will automatically default to CSV values as following:
326
+ #
327
+ # ` \{ "withHeader": "true", "separator": "," \} `
328
+ #
329
+ # For more information about supported file formats, see [Supported
330
+ # Data Types and File Formats][1] in the FinSpace User Guide.
331
+ #
332
+ #
333
+ #
334
+ # [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
296
335
  # @return [Hash<String,String>]
297
336
  #
298
337
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangesetRequest AWS API Documentation
@@ -341,11 +380,15 @@ module Aws::FinSpaceData
341
380
  # as_of_timestamp: 1,
342
381
  # destination_type_params: { # required
343
382
  # destination_type: "DataViewDestinationType", # required
383
+ # s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
384
+ # s3_destination_export_file_format_options: {
385
+ # "StringMapKey" => "StringMapValue",
386
+ # },
344
387
  # },
345
388
  # }
346
389
  #
347
390
  # @!attribute [rw] client_token
348
- # A token used to ensure idempotency.
391
+ # A token that ensures idempotency. This token expires in 10 minutes.
349
392
  #
350
393
  # **A suitable default value is auto-generated.** You should normally
351
394
  # not need to pass this option.
@@ -419,7 +462,7 @@ module Aws::FinSpaceData
419
462
  # client_token: "ClientToken",
420
463
  # dataset_title: "DatasetTitle", # required
421
464
  # kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
422
- # dataset_description: "DatasetDescription", # required
465
+ # dataset_description: "DatasetDescription",
423
466
  # owner_info: {
424
467
  # name: "OwnerName",
425
468
  # phone_number: "PhoneNumber",
@@ -433,7 +476,7 @@ module Aws::FinSpaceData
433
476
  # },
434
477
  # ],
435
478
  # },
436
- # alias: "AliasString", # required
479
+ # alias: "AliasString",
437
480
  # schema_definition: {
438
481
  # tabular_schema_config: {
439
482
  # columns: [
@@ -449,7 +492,7 @@ module Aws::FinSpaceData
449
492
  # }
450
493
  #
451
494
  # @!attribute [rw] client_token
452
- # A token used to ensure idempotency.
495
+ # A token that ensures idempotency. This token expires in 10 minutes.
453
496
  #
454
497
  # **A suitable default value is auto-generated.** You should normally
455
498
  # not need to pass this option.
@@ -547,6 +590,10 @@ module Aws::FinSpaceData
547
590
  #
548
591
  # {
549
592
  # destination_type: "DataViewDestinationType", # required
593
+ # s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
594
+ # s3_destination_export_file_format_options: {
595
+ # "StringMapKey" => "StringMapValue",
596
+ # },
550
597
  # }
551
598
  #
552
599
  # @!attribute [rw] destination_type
@@ -554,13 +601,32 @@ module Aws::FinSpaceData
554
601
  #
555
602
  # * `GLUE_TABLE` - Glue table destination type.
556
603
  #
557
- # ^
604
+ # * `S3` - S3 destination type.
605
+ # @return [String]
606
+ #
607
+ # @!attribute [rw] s3_destination_export_file_format
608
+ # Data view export file format.
609
+ #
610
+ # * `PARQUET` - Parquet export file format.
611
+ #
612
+ # * `DELIMITED_TEXT` - Delimited text export file format.
558
613
  # @return [String]
559
614
  #
615
+ # @!attribute [rw] s3_destination_export_file_format_options
616
+ # Format Options for S3 Destination type.
617
+ #
618
+ # Here is an example of how you could specify the
619
+ # `s3DestinationExportFileFormatOptions`
620
+ #
621
+ # ` \{ "header": "true", "delimiter": ",", "compression": "gzip" \}`
622
+ # @return [Hash<String,String>]
623
+ #
560
624
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewDestinationTypeParams AWS API Documentation
561
625
  #
562
626
  class DataViewDestinationTypeParams < Struct.new(
563
- :destination_type)
627
+ :destination_type,
628
+ :s3_destination_export_file_format,
629
+ :s3_destination_export_file_format_options)
564
630
  SENSITIVE = []
565
631
  include Aws::Structure
566
632
  end
@@ -810,7 +876,7 @@ module Aws::FinSpaceData
810
876
  # }
811
877
  #
812
878
  # @!attribute [rw] client_token
813
- # A token used to ensure idempotency.
879
+ # A token that ensures idempotency. This token expires in 10 minutes.
814
880
  #
815
881
  # **A suitable default value is auto-generated.** You should normally
816
882
  # not need to pass this option.
@@ -928,6 +994,13 @@ module Aws::FinSpaceData
928
994
  # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
929
995
  # @return [Integer]
930
996
  #
997
+ # @!attribute [rw] active_from_timestamp
998
+ # Beginning time from which the Changeset is active. The value is
999
+ # determined as Epoch time in milliseconds. For example, the value for
1000
+ # Monday, November 1, 2021 12:00:00 PM UTC is specified as
1001
+ # 1635768000000.
1002
+ # @return [Integer]
1003
+ #
931
1004
  # @!attribute [rw] updates_changeset_id
932
1005
  # The unique identifier of the Changeset that is being updated.
933
1006
  # @return [String]
@@ -949,6 +1022,7 @@ module Aws::FinSpaceData
949
1022
  :status,
950
1023
  :error_info,
951
1024
  :active_until_timestamp,
1025
+ :active_from_timestamp,
952
1026
  :updates_changeset_id,
953
1027
  :updated_by_changeset_id)
954
1028
  SENSITIVE = []
@@ -1449,6 +1523,14 @@ module Aws::FinSpaceData
1449
1523
 
1450
1524
  # Permission group parameters for Dataset permissions.
1451
1525
  #
1526
+ # Here is an example of how you could specify the
1527
+ # `PermissionGroupParams`\:
1528
+ #
1529
+ # ` \{ "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g",
1530
+ # "datasetPermissions": [ \{"permission": "ViewDatasetDetails"\},
1531
+ # \{"permission": "AddDatasetData"\}, \{"permission":
1532
+ # "EditDatasetMetadata"\}, \{"permission": "DeleteDataset"\} ] \} `
1533
+ #
1452
1534
  # @note When making an API call, you may pass PermissionGroupParams
1453
1535
  # data as a hash:
1454
1536
  #
@@ -1491,7 +1573,32 @@ module Aws::FinSpaceData
1491
1573
  include Aws::Structure
1492
1574
  end
1493
1575
 
1494
- # Resource permission for a Dataset.
1576
+ # Resource permission for a dataset. When you create a dataset, all the
1577
+ # other members of the same user group inherit access to the dataset.
1578
+ # You can only create a dataset if your user group has application
1579
+ # permission for Create Datasets.
1580
+ #
1581
+ # The following is a list of valid dataset permissions that you can
1582
+ # apply:
1583
+ #
1584
+ # * `ViewDatasetDetails`
1585
+ #
1586
+ # * `ReadDatasetDetails`
1587
+ #
1588
+ # * `AddDatasetData`
1589
+ #
1590
+ # * `CreateSnapshot`
1591
+ #
1592
+ # * `EditDatasetMetadata`
1593
+ #
1594
+ # * `DeleteDataset`
1595
+ #
1596
+ # For more information on the ataset permissions, see [Supported Dataset
1597
+ # Permissions][1] in the FinSpace User Guide.
1598
+ #
1599
+ #
1600
+ #
1601
+ # [1]: https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions
1495
1602
  #
1496
1603
  # @note When making an API call, you may pass ResourcePermission
1497
1604
  # data as a hash:
@@ -1599,7 +1706,7 @@ module Aws::FinSpaceData
1599
1706
  # }
1600
1707
  #
1601
1708
  # @!attribute [rw] client_token
1602
- # A token used to ensure idempotency.
1709
+ # A token that ensures idempotency. This token expires in 10 minutes.
1603
1710
  #
1604
1711
  # **A suitable default value is auto-generated.** You should normally
1605
1712
  # not need to pass this option.
@@ -1615,11 +1722,60 @@ module Aws::FinSpaceData
1615
1722
  # @return [String]
1616
1723
  #
1617
1724
  # @!attribute [rw] source_params
1618
- # Options that define the location of the data being ingested.
1725
+ # Options that define the location of the data being ingested
1726
+ # (`s3SourcePath`) and the source of the changeset (`sourceType`).
1727
+ #
1728
+ # Both `s3SourcePath` and `sourceType` are required attributes.
1729
+ #
1730
+ # Here is an example of how you could specify the `sourceParams`\:
1731
+ #
1732
+ # ` "sourceParams": \{ "s3SourcePath":
1733
+ # "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
1734
+ # "sourceType": "S3" \} `
1735
+ #
1736
+ # The S3 path that you specify must allow the FinSpace role access. To
1737
+ # do that, you first need to configure the IAM policy on S3 bucket.
1738
+ # For more information, see [Loading data from an Amazon S3 Bucket
1739
+ # using the FinSpace API][1]section.
1740
+ #
1741
+ #
1742
+ #
1743
+ # [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
1619
1744
  # @return [Hash<String,String>]
1620
1745
  #
1621
1746
  # @!attribute [rw] format_params
1622
- # Options that define the structure of the source file(s).
1747
+ # Options that define the structure of the source file(s) including
1748
+ # the format type (`formatType`), header row (`withHeader`), data
1749
+ # separation character (`separator`) and the type of compression
1750
+ # (`compression`).
1751
+ #
1752
+ # `formatType` is a required attribute and can have the following
1753
+ # values:
1754
+ #
1755
+ # * `PARQUET` - Parquet source file format.
1756
+ #
1757
+ # * `CSV` - CSV source file format.
1758
+ #
1759
+ # * `JSON` - JSON source file format.
1760
+ #
1761
+ # * `XML` - XML source file format.
1762
+ #
1763
+ # Here is an example of how you could specify the `formatParams`\:
1764
+ #
1765
+ # ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
1766
+ # "separator": ",", "compression":"None" \} `
1767
+ #
1768
+ # Note that if you only provide `formatType` as `CSV`, the rest of the
1769
+ # attributes will automatically default to CSV values as following:
1770
+ #
1771
+ # ` \{ "withHeader": "true", "separator": "," \} `
1772
+ #
1773
+ # For more information about supported file formats, see [Supported
1774
+ # Data Types and File Formats][1] in the FinSpace User Guide.
1775
+ #
1776
+ #
1777
+ #
1778
+ # [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
1623
1779
  # @return [Hash<String,String>]
1624
1780
  #
1625
1781
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangesetRequest AWS API Documentation
@@ -1665,7 +1821,7 @@ module Aws::FinSpaceData
1665
1821
  # dataset_title: "DatasetTitle", # required
1666
1822
  # kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
1667
1823
  # dataset_description: "DatasetDescription",
1668
- # alias: "AliasString", # required
1824
+ # alias: "AliasString",
1669
1825
  # schema_definition: {
1670
1826
  # tabular_schema_config: {
1671
1827
  # columns: [
@@ -1681,7 +1837,7 @@ module Aws::FinSpaceData
1681
1837
  # }
1682
1838
  #
1683
1839
  # @!attribute [rw] client_token
1684
- # A token used to ensure idempotency.
1840
+ # A token that ensures idempotency. This token expires in 10 minutes.
1685
1841
  #
1686
1842
  # **A suitable default value is auto-generated.** You should normally
1687
1843
  # not need to pass this option.
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-finspacedata/customizations'
48
48
  # @!group service
49
49
  module Aws::FinSpaceData
50
50
 
51
- GEM_VERSION = '1.8.0'
51
+ GEM_VERSION = '1.12.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-finspacedata
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.0
4
+ version: 1.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-30 00:00:00.000000000 Z
11
+ date: 2022-02-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.122.0
22
+ version: 3.126.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.122.0
32
+ version: 3.126.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement