aws-sdk-finspacedata 1.7.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2622a22377e7647878cd211bef3e4c473dd86e81ba44d95d7229803322623e45
-  data.tar.gz: 48d02c2203439edaabebc95378012039d2a1c05ecce1d45dcdcf2f8746cd07db
+  metadata.gz: 92916b39e6ab2ee47c894389969dba1dd6eabfbfbd3a83276ba67d7975f8538e
+  data.tar.gz: db96bf2aa8f5d347af901aed5f9d0c90af2c85ae97c72eb013678105c03b3362
 SHA512:
-  metadata.gz: 66d10a72b91de2e87117695bb8ca31e2c5f83c1e579271def3db762956d5401c9137b4b3e39faef86e67255aeffe03407a7c2f854cbaa548a9fa85fa0d290241
-  data.tar.gz: 5fdf73982cceed48865acefa7dcfc2160ac0a02b0b9bec2b63a1f98a51f4ce8e21b283ac19cdd7d9ccc385e9233d30c2d2543f7f6ba7e40413155cf638ba7e10
+  metadata.gz: 6a57f7e3e021c8cd53498b0714579421b3641bc5af1fc0787c5ddf1124f10cfcbe62b57a1962f92fc0c97d043463a186af089d29735f05a1825a7e06b44fc16c
+  data.tar.gz: 3a2a9c20c150f07f5891d423c74e0bd5b5d09b27d0c086f6d1c37421661f7698e0e344955e70c081483eb31f94df389ccd987da9a3b6638dede215c608690767

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.11.0 (2022-01-11)
+------------------
+
+* Feature - Documentation updates for FinSpace.
+
+1.10.0 (2021-12-21)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.9.0 (2021-12-20)
+------------------
+
+* Feature - Make dataset description optional and allow s3 export for dataviews
+
+1.8.0 (2021-11-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.7.0 (2021-11-23)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.7.0
+1.11.0

data/lib/aws-sdk-finspacedata/client.rb

@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
+require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 require 'aws-sdk-finspacedata/plugins/content_type.rb'
@@ -74,6 +75,7 @@ module Aws::FinSpaceData
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
+    add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
     add_plugin(Aws::FinSpaceData::Plugins::ContentType)
@@ -121,7 +123,9 @@ module Aws::FinSpaceData
     #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
     #       are very aggressive. Construct and pass an instance of
     #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts.
+    #       enable retries and extended timeouts. Instance profile credential
+    #       fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
+    #       to true.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -175,6 +179,10 @@ module Aws::FinSpaceData
     #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
     #     a clock skew correction and retry requests with skewed client clocks.
     #
+    #   @option options [String] :defaults_mode ("legacy")
+    #     See {Aws::DefaultsModeConfiguration} for a list of the
+    #     accepted modes and the configuration defaults that are included.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -297,7 +305,7 @@ module Aws::FinSpaceData
     #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
-    #   @option options [Integer] :http_read_timeout (60) The default
+    #   @option options [Float] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
     #     safely be set per-request on the session.
     #
@@ -313,6 +321,9 @@ module Aws::FinSpaceData
     #     disables this behaviour.  This value can safely be set per
     #     request on the session.
     #
+    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
+    #     in seconds.
+    #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
     #
@@ -341,7 +352,7 @@ module Aws::FinSpaceData
     # Creates a new Changeset in a FinSpace Dataset.
     #
     # @option params [String] :client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -363,7 +374,25 @@ module Aws::FinSpaceData
     #     prior ingested Changeset.
     #
     # @option params [required, Hash<String,String>] :source_params
-    #   Options that define the location of the data being ingested.
+    #   Options that define the location of the data being ingested
+    #   (`s3SourcePath`) and the source of the changeset (`sourceType`).
+    #
+    #   Both `s3SourcePath` and `sourceType` are required attributes.
+    #
+    #   Here is an example of how you could specify the `sourceParams`\:
+    #
+    #   ` "sourceParams": \{ "s3SourcePath":
+    #   "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+    #   "sourceType": "S3" \} `
+    #
+    #   The S3 path that you specify must allow the FinSpace role access. To
+    #   do that, you first need to configure the IAM policy on S3 bucket. For
+    #   more information, see [Loading data from an Amazon S3 Bucket using the
+    #   FinSpace API][1]section.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
     #
     # @option params [required, Hash<String,String>] :format_params
     #   Options that define the structure of the source file(s) including the
@@ -381,10 +410,23 @@ module Aws::FinSpaceData
     #
     #   * `XML` - XML source file format.
     #
-    #   For example, you could specify the following for `formatParams`\: `
-    #   "formatParams": \{ "formatType": "CSV", "withHeader": "true",
+    #   Here is an example of how you could specify the `formatParams`\:
+    #
+    #   ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
     #   "separator": ",", "compression":"None" \} `
     #
+    #   Note that if you only provide `formatType` as `CSV`, the rest of the
+    #   attributes will automatically default to CSV values as following:
+    #
+    #   ` \{ "withHeader": "true", "separator": "," \} `
+    #
+    #   For more information about supported file formats, see [Supported Data
+    #   Types and File Formats][1] in the FinSpace User Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
+    #
     # @return [Types::CreateChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateChangesetResponse#dataset_id #dataset_id} => String
@@ -421,7 +463,7 @@ module Aws::FinSpaceData
     # Creates a Dataview for a Dataset.
     #
     # @option params [String] :client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -462,6 +504,10 @@ module Aws::FinSpaceData
     #     as_of_timestamp: 1,
     #     destination_type_params: { # required
     #       destination_type: "DataViewDestinationType", # required
+    #       s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
+    #       s3_destination_export_file_format_options: {
+    #         "StringMapKey" => "StringMapValue",
+    #       },
     #     },
     #   })
     #
@@ -482,7 +528,7 @@ module Aws::FinSpaceData
     # Creates a new FinSpace Dataset.
     #
     # @option params [String] :client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -497,7 +543,7 @@ module Aws::FinSpaceData
     #
     #   * `NON_TABULAR` - Data is structured in a non-tabular format.
     #
-    # @option params [required, String] :dataset_description
+    # @option params [String] :dataset_description
     #   Description of a Dataset.
     #
     # @option params [Types::DatasetOwnerInfo] :owner_info
@@ -506,7 +552,7 @@ module Aws::FinSpaceData
     # @option params [required, Types::PermissionGroupParams] :permission_group_params
     #   Permission group parameters for Dataset permissions.
     #
-    # @option params [required, String] :alias
+    # @option params [String] :alias
     #   The unique resource identifier for a Dataset.
     #
     # @option params [Types::SchemaUnion] :schema_definition
@@ -522,7 +568,7 @@ module Aws::FinSpaceData
     #     client_token: "ClientToken",
     #     dataset_title: "DatasetTitle", # required
     #     kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
-    #     dataset_description: "DatasetDescription", # required
+    #     dataset_description: "DatasetDescription",
     #     owner_info: {
     #       name: "OwnerName",
     #       phone_number: "PhoneNumber",
@@ -536,7 +582,7 @@ module Aws::FinSpaceData
     #         },
     #       ],
     #     },
-    #     alias: "AliasString", # required
+    #     alias: "AliasString",
     #     schema_definition: {
     #       tabular_schema_config: {
     #         columns: [
@@ -567,7 +613,7 @@ module Aws::FinSpaceData
     # Deletes a FinSpace Dataset.
     #
     # @option params [String] :client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -620,6 +666,7 @@ module Aws::FinSpaceData
     #   * {Types::GetChangesetResponse#status #status} => String
     #   * {Types::GetChangesetResponse#error_info #error_info} => Types::ChangesetErrorInfo
     #   * {Types::GetChangesetResponse#active_until_timestamp #active_until_timestamp} => Integer
+    #   * {Types::GetChangesetResponse#active_from_timestamp #active_from_timestamp} => Integer
     #   * {Types::GetChangesetResponse#updates_changeset_id #updates_changeset_id} => String
     #   * {Types::GetChangesetResponse#updated_by_changeset_id #updated_by_changeset_id} => String
     #
@@ -645,6 +692,7 @@ module Aws::FinSpaceData
     #   resp.error_info.error_message #=> String
     #   resp.error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
     #   resp.active_until_timestamp #=> Integer
+    #   resp.active_from_timestamp #=> Integer
     #   resp.updates_changeset_id #=> String
     #   resp.updated_by_changeset_id #=> String
     #
@@ -703,6 +751,9 @@ module Aws::FinSpaceData
     #   resp.data_view_id #=> String
     #   resp.data_view_arn #=> String
     #   resp.destination_type_params.destination_type #=> String
+    #   resp.destination_type_params.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
+    #   resp.destination_type_params.s3_destination_export_file_format_options #=> Hash
+    #   resp.destination_type_params.s3_destination_export_file_format_options["StringMapKey"] #=> String
     #   resp.status #=> String, one of "RUNNING", "STARTING", "FAILED", "CANCELLED", "TIMEOUT", "SUCCESS", "PENDING", "FAILED_CLEANUP_FAILED"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView AWS API Documentation
@@ -886,6 +937,7 @@ module Aws::FinSpaceData
     #   resp.changesets[0].error_info.error_message #=> String
     #   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"
     #   resp.changesets[0].active_until_timestamp #=> Integer
+    #   resp.changesets[0].active_from_timestamp #=> Integer
     #   resp.changesets[0].updates_changeset_id #=> String
     #   resp.changesets[0].updated_by_changeset_id #=> String
     #   resp.next_token #=> String
@@ -941,6 +993,9 @@ module Aws::FinSpaceData
     #   resp.data_views[0].error_info.error_message #=> String
     #   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"
     #   resp.data_views[0].destination_type_properties.destination_type #=> String
+    #   resp.data_views[0].destination_type_properties.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
+    #   resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options #=> Hash
+    #   resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options["StringMapKey"] #=> String
     #   resp.data_views[0].auto_update #=> Boolean
     #   resp.data_views[0].create_time #=> Integer
     #   resp.data_views[0].last_modified_time #=> Integer
@@ -1010,7 +1065,7 @@ module Aws::FinSpaceData
     # Updates a FinSpace Changeset.
     #
     # @option params [String] :client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -1023,10 +1078,58 @@ module Aws::FinSpaceData
     #   The unique identifier for the Changeset to update.
     #
     # @option params [required, Hash<String,String>] :source_params
-    #   Options that define the location of the data being ingested.
+    #   Options that define the location of the data being ingested
+    #   (`s3SourcePath`) and the source of the changeset (`sourceType`).
+    #
+    #   Both `s3SourcePath` and `sourceType` are required attributes.
+    #
+    #   Here is an example of how you could specify the `sourceParams`\:
+    #
+    #   ` "sourceParams": \{ "s3SourcePath":
+    #   "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+    #   "sourceType": "S3" \} `
+    #
+    #   The S3 path that you specify must allow the FinSpace role access. To
+    #   do that, you first need to configure the IAM policy on S3 bucket. For
+    #   more information, see [Loading data from an Amazon S3 Bucket using the
+    #   FinSpace API][1]section.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
     #
     # @option params [required, Hash<String,String>] :format_params
-    #   Options that define the structure of the source file(s).
+    #   Options that define the structure of the source file(s) including the
+    #   format type (`formatType`), header row (`withHeader`), data separation
+    #   character (`separator`) and the type of compression (`compression`).
+    #
+    #   `formatType` is a required attribute and can have the following
+    #   values:
+    #
+    #   * `PARQUET` - Parquet source file format.
+    #
+    #   * `CSV` - CSV source file format.
+    #
+    #   * `JSON` - JSON source file format.
+    #
+    #   * `XML` - XML source file format.
+    #
+    #   Here is an example of how you could specify the `formatParams`\:
+    #
+    #   ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
+    #   "separator": ",", "compression":"None" \} `
+    #
+    #   Note that if you only provide `formatType` as `CSV`, the rest of the
+    #   attributes will automatically default to CSV values as following:
+    #
+    #   ` \{ "withHeader": "true", "separator": "," \} `
+    #
+    #   For more information about supported file formats, see [Supported Data
+    #   Types and File Formats][1] in the FinSpace User Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
     #
     # @return [Types::UpdateChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1064,7 +1167,7 @@ module Aws::FinSpaceData
     # Updates a FinSpace Dataset.
     #
     # @option params [String] :client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -1085,7 +1188,7 @@ module Aws::FinSpaceData
     # @option params [String] :dataset_description
     #   A description for the Dataset.
     #
-    # @option params [required, String] :alias
+    # @option params [String] :alias
     #   The unique resource identifier for a Dataset.
     #
     # @option params [Types::SchemaUnion] :schema_definition
@@ -1103,7 +1206,7 @@ module Aws::FinSpaceData
     #     dataset_title: "DatasetTitle", # required
     #     kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
     #     dataset_description: "DatasetDescription",
-    #     alias: "AliasString", # required
+    #     alias: "AliasString",
     #     schema_definition: {
     #       tabular_schema_config: {
     #         columns: [
@@ -1144,7 +1247,7 @@ module Aws::FinSpaceData
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-finspacedata'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.11.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-finspacedata/client_api.rb

@@ -59,6 +59,7 @@ module Aws::FinSpaceData
     Email = Shapes::StringShape.new(name: 'Email')
     ErrorCategory = Shapes::StringShape.new(name: 'ErrorCategory')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
+    ExportFileFormat = Shapes::StringShape.new(name: 'ExportFileFormat')
     FormatParams = Shapes::MapShape.new(name: 'FormatParams')
     GetChangesetRequest = Shapes::StructureShape.new(name: 'GetChangesetRequest')
     GetChangesetResponse = Shapes::StructureShape.new(name: 'GetChangesetResponse')
@@ -90,6 +91,7 @@ module Aws::FinSpaceData
     ResourcePermission = Shapes::StructureShape.new(name: 'ResourcePermission')
     ResourcePermissionsList = Shapes::ListShape.new(name: 'ResourcePermissionsList')
     ResultLimit = Shapes::IntegerShape.new(name: 'ResultLimit')
+    S3DestinationFormatOptions = Shapes::MapShape.new(name: 'S3DestinationFormatOptions')
     SchemaDefinition = Shapes::StructureShape.new(name: 'SchemaDefinition')
     SchemaUnion = Shapes::StructureShape.new(name: 'SchemaUnion')
     SessionDuration = Shapes::IntegerShape.new(name: 'SessionDuration')
@@ -132,6 +134,7 @@ module Aws::FinSpaceData
     ChangesetSummary.add_member(:status, Shapes::ShapeRef.new(shape: IngestionStatus, location_name: "status"))
     ChangesetSummary.add_member(:error_info, Shapes::ShapeRef.new(shape: ChangesetErrorInfo, location_name: "errorInfo"))
     ChangesetSummary.add_member(:active_until_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeUntilTimestamp", metadata: {"box"=>true}))
+    ChangesetSummary.add_member(:active_from_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeFromTimestamp", metadata: {"box"=>true}))
     ChangesetSummary.add_member(:updates_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatesChangesetId"))
     ChangesetSummary.add_member(:updated_by_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatedByChangesetId"))
     ChangesetSummary.struct_class = Types::ChangesetSummary
@@ -175,10 +178,10 @@ module Aws::FinSpaceData
     CreateDatasetRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
     CreateDatasetRequest.add_member(:dataset_title, Shapes::ShapeRef.new(shape: DatasetTitle, required: true, location_name: "datasetTitle"))
     CreateDatasetRequest.add_member(:kind, Shapes::ShapeRef.new(shape: DatasetKind, required: true, location_name: "kind"))
-    CreateDatasetRequest.add_member(:dataset_description, Shapes::ShapeRef.new(shape: DatasetDescription, required: true, location_name: "datasetDescription"))
+    CreateDatasetRequest.add_member(:dataset_description, Shapes::ShapeRef.new(shape: DatasetDescription, location_name: "datasetDescription"))
     CreateDatasetRequest.add_member(:owner_info, Shapes::ShapeRef.new(shape: DatasetOwnerInfo, location_name: "ownerInfo"))
     CreateDatasetRequest.add_member(:permission_group_params, Shapes::ShapeRef.new(shape: PermissionGroupParams, required: true, location_name: "permissionGroupParams"))
-    CreateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, required: true, location_name: "alias"))
+    CreateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, location_name: "alias"))
     CreateDatasetRequest.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaUnion, location_name: "schemaDefinition"))
     CreateDatasetRequest.struct_class = Types::CreateDatasetRequest
 
@@ -191,6 +194,8 @@ module Aws::FinSpaceData
     Credentials.struct_class = Types::Credentials
 
     DataViewDestinationTypeParams.add_member(:destination_type, Shapes::ShapeRef.new(shape: DataViewDestinationType, required: true, location_name: "destinationType"))
+    DataViewDestinationTypeParams.add_member(:s3_destination_export_file_format, Shapes::ShapeRef.new(shape: ExportFileFormat, location_name: "s3DestinationExportFileFormat"))
+    DataViewDestinationTypeParams.add_member(:s3_destination_export_file_format_options, Shapes::ShapeRef.new(shape: S3DestinationFormatOptions, location_name: "s3DestinationExportFileFormatOptions"))
     DataViewDestinationTypeParams.struct_class = Types::DataViewDestinationTypeParams
 
     DataViewErrorInfo.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
@@ -256,6 +261,7 @@ module Aws::FinSpaceData
     GetChangesetResponse.add_member(:status, Shapes::ShapeRef.new(shape: IngestionStatus, location_name: "status"))
     GetChangesetResponse.add_member(:error_info, Shapes::ShapeRef.new(shape: ChangesetErrorInfo, location_name: "errorInfo"))
     GetChangesetResponse.add_member(:active_until_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeUntilTimestamp", metadata: {"box"=>true}))
+    GetChangesetResponse.add_member(:active_from_timestamp, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "activeFromTimestamp", metadata: {"box"=>true}))
     GetChangesetResponse.add_member(:updates_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatesChangesetId"))
     GetChangesetResponse.add_member(:updated_by_changeset_id, Shapes::ShapeRef.new(shape: ChangesetId, location_name: "updatedByChangesetId"))
     GetChangesetResponse.struct_class = Types::GetChangesetResponse
@@ -355,6 +361,9 @@ module Aws::FinSpaceData
 
     ResourcePermissionsList.member = Shapes::ShapeRef.new(shape: ResourcePermission)
 
+    S3DestinationFormatOptions.key = Shapes::ShapeRef.new(shape: StringMapKey)
+    S3DestinationFormatOptions.value = Shapes::ShapeRef.new(shape: StringMapValue)
+
     SchemaDefinition.add_member(:columns, Shapes::ShapeRef.new(shape: ColumnList, location_name: "columns"))
     SchemaDefinition.add_member(:primary_key_columns, Shapes::ShapeRef.new(shape: ColumnNameList, location_name: "primaryKeyColumns"))
     SchemaDefinition.struct_class = Types::SchemaDefinition
@@ -385,7 +394,7 @@ module Aws::FinSpaceData
     UpdateDatasetRequest.add_member(:dataset_title, Shapes::ShapeRef.new(shape: DatasetTitle, required: true, location_name: "datasetTitle"))
     UpdateDatasetRequest.add_member(:kind, Shapes::ShapeRef.new(shape: DatasetKind, required: true, location_name: "kind"))
     UpdateDatasetRequest.add_member(:dataset_description, Shapes::ShapeRef.new(shape: DatasetDescription, location_name: "datasetDescription"))
-    UpdateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, required: true, location_name: "alias"))
+    UpdateDatasetRequest.add_member(:alias, Shapes::ShapeRef.new(shape: AliasString, location_name: "alias"))
     UpdateDatasetRequest.add_member(:schema_definition, Shapes::ShapeRef.new(shape: SchemaUnion, location_name: "schemaDefinition"))
     UpdateDatasetRequest.struct_class = Types::UpdateDatasetRequest
 

data/lib/aws-sdk-finspacedata/types.rb

@@ -130,6 +130,13 @@ module Aws::FinSpaceData
     #   November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
     #   @return [Integer]
     #
+    # @!attribute [rw] active_from_timestamp
+    #   Beginning time from which the Changeset is active. The value is
+    #   determined as Epoch time in milliseconds. For example, the value for
+    #   Monday, November 1, 2021 12:00:00 PM UTC is specified as
+    #   1635768000000.
+    #   @return [Integer]
+    #
     # @!attribute [rw] updates_changeset_id
     #   The unique identifier of the Changeset that is updated.
     #   @return [String]
@@ -151,6 +158,7 @@ module Aws::FinSpaceData
       :status,
       :error_info,
       :active_until_timestamp,
+      :active_from_timestamp,
       :updates_changeset_id,
       :updated_by_changeset_id)
       SENSITIVE = []
@@ -245,7 +253,7 @@ module Aws::FinSpaceData
     #       }
     #
     # @!attribute [rw] client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -270,7 +278,25 @@ module Aws::FinSpaceData
     #   @return [String]
     #
     # @!attribute [rw] source_params
-    #   Options that define the location of the data being ingested.
+    #   Options that define the location of the data being ingested
+    #   (`s3SourcePath`) and the source of the changeset (`sourceType`).
+    #
+    #   Both `s3SourcePath` and `sourceType` are required attributes.
+    #
+    #   Here is an example of how you could specify the `sourceParams`\:
+    #
+    #   ` "sourceParams": \{ "s3SourcePath":
+    #   "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+    #   "sourceType": "S3" \} `
+    #
+    #   The S3 path that you specify must allow the FinSpace role access. To
+    #   do that, you first need to configure the IAM policy on S3 bucket.
+    #   For more information, see [Loading data from an Amazon S3 Bucket
+    #   using the FinSpace API][1]section.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] format_params
@@ -290,9 +316,22 @@ module Aws::FinSpaceData
     #
     #   * `XML` - XML source file format.
     #
-    #   For example, you could specify the following for `formatParams`\: `
-    #   "formatParams": \{ "formatType": "CSV", "withHeader": "true",
+    #   Here is an example of how you could specify the `formatParams`\:
+    #
+    #   ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
     #   "separator": ",", "compression":"None" \} `
+    #
+    #   Note that if you only provide `formatType` as `CSV`, the rest of the
+    #   attributes will automatically default to CSV values as following:
+    #
+    #   ` \{ "withHeader": "true", "separator": "," \} `
+    #
+    #   For more information about supported file formats, see [Supported
+    #   Data Types and File Formats][1] in the FinSpace User Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangesetRequest AWS API Documentation
@@ -341,11 +380,15 @@ module Aws::FinSpaceData
     #         as_of_timestamp: 1,
     #         destination_type_params: { # required
     #           destination_type: "DataViewDestinationType", # required
+    #           s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
+    #           s3_destination_export_file_format_options: {
+    #             "StringMapKey" => "StringMapValue",
+    #           },
     #         },
     #       }
     #
     # @!attribute [rw] client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -419,7 +462,7 @@ module Aws::FinSpaceData
     #         client_token: "ClientToken",
     #         dataset_title: "DatasetTitle", # required
     #         kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
-    #         dataset_description: "DatasetDescription", # required
+    #         dataset_description: "DatasetDescription",
     #         owner_info: {
     #           name: "OwnerName",
     #           phone_number: "PhoneNumber",
@@ -433,7 +476,7 @@ module Aws::FinSpaceData
     #             },
     #           ],
     #         },
-    #         alias: "AliasString", # required
+    #         alias: "AliasString",
     #         schema_definition: {
     #           tabular_schema_config: {
     #             columns: [
@@ -449,7 +492,7 @@ module Aws::FinSpaceData
     #       }
     #
     # @!attribute [rw] client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -547,6 +590,10 @@ module Aws::FinSpaceData
     #
     #       {
     #         destination_type: "DataViewDestinationType", # required
+    #         s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
+    #         s3_destination_export_file_format_options: {
+    #           "StringMapKey" => "StringMapValue",
+    #         },
     #       }
     #
     # @!attribute [rw] destination_type
@@ -554,13 +601,32 @@ module Aws::FinSpaceData
     #
     #   * `GLUE_TABLE` - Glue table destination type.
     #
-    #   ^
+    #   * `S3` - S3 destination type.
+    #   @return [String]
+    #
+    # @!attribute [rw] s3_destination_export_file_format
+    #   Data view export file format.
+    #
+    #   * `PARQUET` - Parquet export file format.
+    #
+    #   * `DELIMITED_TEXT` - Delimited text export file format.
     #   @return [String]
     #
+    # @!attribute [rw] s3_destination_export_file_format_options
+    #   Format Options for S3 Destination type.
+    #
+    #   Here is an example of how you could specify the
+    #   `s3DestinationExportFileFormatOptions`
+    #
+    #   ` \{ "header": "true", "delimiter": ",", "compression": "gzip" \}`
+    #   @return [Hash<String,String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DataViewDestinationTypeParams AWS API Documentation
     #
     class DataViewDestinationTypeParams < Struct.new(
-      :destination_type)
+      :destination_type,
+      :s3_destination_export_file_format,
+      :s3_destination_export_file_format_options)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -810,7 +876,7 @@ module Aws::FinSpaceData
     #       }
     #
     # @!attribute [rw] client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -928,6 +994,13 @@ module Aws::FinSpaceData
     #   November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
     #   @return [Integer]
     #
+    # @!attribute [rw] active_from_timestamp
+    #   Beginning time from which the Changeset is active. The value is
+    #   determined as Epoch time in milliseconds. For example, the value for
+    #   Monday, November 1, 2021 12:00:00 PM UTC is specified as
+    #   1635768000000.
+    #   @return [Integer]
+    #
     # @!attribute [rw] updates_changeset_id
     #   The unique identifier of the Changeset that is being updated.
     #   @return [String]
@@ -949,6 +1022,7 @@ module Aws::FinSpaceData
       :status,
       :error_info,
       :active_until_timestamp,
+      :active_from_timestamp,
       :updates_changeset_id,
       :updated_by_changeset_id)
       SENSITIVE = []
@@ -1449,6 +1523,14 @@ module Aws::FinSpaceData
 
     # Permission group parameters for Dataset permissions.
     #
+    # Here is an example of how you could specify the
+    # `PermissionGroupParams`\:
+    #
+    # ` \{ "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g",
+    # "datasetPermissions": [ \{"permission": "ViewDatasetDetails"\},
+    # \{"permission": "AddDatasetData"\}, \{"permission":
+    # "EditDatasetMetadata"\}, \{"permission": "DeleteDataset"\} ] \} `
+    #
     # @note When making an API call, you may pass PermissionGroupParams
     #   data as a hash:
     #
@@ -1491,7 +1573,32 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
-    # Resource permission for a Dataset.
+    # Resource permission for a dataset. When you create a dataset, all the
+    # other members of the same user group inherit access to the dataset.
+    # You can only create a dataset if your user group has application
+    # permission for Create Datasets.
+    #
+    # The following is a list of valid dataset permissions that you can
+    # apply:
+    #
+    # * `ViewDatasetDetails`
+    #
+    # * `ReadDatasetDetails`
+    #
+    # * `AddDatasetData`
+    #
+    # * `CreateSnapshot`
+    #
+    # * `EditDatasetMetadata`
+    #
+    # * `DeleteDataset`
+    #
+    # For more information on the ataset permissions, see [Supported Dataset
+    # Permissions][1] in the FinSpace User Guide.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions
     #
     # @note When making an API call, you may pass ResourcePermission
     #   data as a hash:
@@ -1599,7 +1706,7 @@ module Aws::FinSpaceData
     #       }
     #
     # @!attribute [rw] client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -1615,11 +1722,60 @@ module Aws::FinSpaceData
     #   @return [String]
     #
     # @!attribute [rw] source_params
-    #   Options that define the location of the data being ingested.
+    #   Options that define the location of the data being ingested
+    #   (`s3SourcePath`) and the source of the changeset (`sourceType`).
+    #
+    #   Both `s3SourcePath` and `sourceType` are required attributes.
+    #
+    #   Here is an example of how you could specify the `sourceParams`\:
+    #
+    #   ` "sourceParams": \{ "s3SourcePath":
+    #   "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+    #   "sourceType": "S3" \} `
+    #
+    #   The S3 path that you specify must allow the FinSpace role access. To
+    #   do that, you first need to configure the IAM policy on S3 bucket.
+    #   For more information, see [Loading data from an Amazon S3 Bucket
+    #   using the FinSpace API][1]section.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] format_params
-    #   Options that define the structure of the source file(s).
+    #   Options that define the structure of the source file(s) including
+    #   the format type (`formatType`), header row (`withHeader`), data
+    #   separation character (`separator`) and the type of compression
+    #   (`compression`).
+    #
+    #   `formatType` is a required attribute and can have the following
+    #   values:
+    #
+    #   * `PARQUET` - Parquet source file format.
+    #
+    #   * `CSV` - CSV source file format.
+    #
+    #   * `JSON` - JSON source file format.
+    #
+    #   * `XML` - XML source file format.
+    #
+    #   Here is an example of how you could specify the `formatParams`\:
+    #
+    #   ` "formatParams": \{ "formatType": "CSV", "withHeader": "true",
+    #   "separator": ",", "compression":"None" \} `
+    #
+    #   Note that if you only provide `formatType` as `CSV`, the rest of the
+    #   attributes will automatically default to CSV values as following:
+    #
+    #   ` \{ "withHeader": "true", "separator": "," \} `
+    #
+    #   For more information about supported file formats, see [Supported
+    #   Data Types and File Formats][1] in the FinSpace User Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangesetRequest AWS API Documentation
@@ -1665,7 +1821,7 @@ module Aws::FinSpaceData
     #         dataset_title: "DatasetTitle", # required
     #         kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
     #         dataset_description: "DatasetDescription",
-    #         alias: "AliasString", # required
+    #         alias: "AliasString",
     #         schema_definition: {
     #           tabular_schema_config: {
     #             columns: [
@@ -1681,7 +1837,7 @@ module Aws::FinSpaceData
     #       }
     #
     # @!attribute [rw] client_token
-    #   A token used to ensure idempotency.
+    #   A token that ensures idempotency. This token expires in 10 minutes.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.

data/lib/aws-sdk-finspacedata.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-finspacedata/customizations'
 # @!group service
 module Aws::FinSpaceData
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.11.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-finspacedata
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.125.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.125.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement