aws-sdk-finspacedata 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a222ee86b8df08fa26e278c984c55290560d159bada6501467944fb93d52dd1
-  data.tar.gz: bb1b745091dbec04205f3e06549376d175c0e6c3b6b0b66c0e2f8c174dcf2a8f
+  metadata.gz: 92916b39e6ab2ee47c894389969dba1dd6eabfbfbd3a83276ba67d7975f8538e
+  data.tar.gz: db96bf2aa8f5d347af901aed5f9d0c90af2c85ae97c72eb013678105c03b3362
 SHA512:
-  metadata.gz: 9388c0fdfdd9eaee4b3d5b70379d6f7b058b87f12e42f5bc65ca6675596ccb06c403f4f01d94014380f00cc95cdba2e348438c8468b77bc8eb14f566bf730a64
-  data.tar.gz: 0564ff4eb06419d3629332cefa7cbe90aff5782c953fa68a741563c55fac1993fb23b17674b4adf308bca9b38c820685062ccdc6d01d80b392812296718996e0
+  metadata.gz: 6a57f7e3e021c8cd53498b0714579421b3641bc5af1fc0787c5ddf1124f10cfcbe62b57a1962f92fc0c97d043463a186af089d29735f05a1825a7e06b44fc16c
+  data.tar.gz: 3a2a9c20c150f07f5891d423c74e0bd5b5d09b27d0c086f6d1c37421661f7698e0e344955e70c081483eb31f94df389ccd987da9a3b6638dede215c608690767

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.11.0 (2022-01-11)
+------------------
+
+* Feature - Documentation updates for FinSpace.
+
 1.10.0 (2021-12-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.10.0
+1.11.0

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

@@ -352,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.**
@@ -374,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
@@ -392,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
@@ -432,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.**
@@ -497,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.**
@@ -582,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.**
@@ -1034,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.**
@@ -1047,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:
     #
@@ -1088,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.**
@@ -1168,7 +1247,7 @@ module Aws::FinSpaceData
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-finspacedata'
-      context[:gem_version] = '1.10.0'
+      context[:gem_version] = '1.11.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -131,7 +131,10 @@ module Aws::FinSpaceData
     #   @return [Integer]
     #
     # @!attribute [rw] active_from_timestamp
-    #   Milliseconds since UTC epoch
+    #   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
@@ -250,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.
@@ -275,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
@@ -295,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
@@ -354,7 +388,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.
@@ -458,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.
@@ -567,14 +601,24 @@ 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
+    #   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
@@ -832,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.
@@ -951,7 +995,10 @@ module Aws::FinSpaceData
     #   @return [Integer]
     #
     # @!attribute [rw] active_from_timestamp
-    #   Milliseconds since UTC epoch
+    #   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
@@ -1476,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:
     #
@@ -1518,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:
@@ -1626,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.
@@ -1642,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
@@ -1708,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.10.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.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core