@aws-sdk/client-finspace-data 3.47.2 → 3.48.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.48.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.47.2...v3.48.0) (2022-01-22)
+
+
+### Features
+
+* **clients:** update clients as of 2022/01/21 ([#3228](https://github.com/aws/aws-sdk-js-v3/issues/3228)) ([fa713ef](https://github.com/aws/aws-sdk-js-v3/commit/fa713efca6b2f424c27535d000359f08830960b1))
+
+
+
+
+
 ## [3.47.2](https://github.com/aws/aws-sdk-js-v3/compare/v3.47.1...v3.47.2) (2022-01-21)
 
 **Note:** Version bump only for package @aws-sdk/client-finspace-data

package/dist-types/models/models_0.d.ts

@@ -25,7 +25,7 @@ export declare enum ChangeType {
  */
 export interface CreateChangesetRequest {
     /**
-     * <p>A token used to ensure idempotency.</p>
+     * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
      */
     clientToken?: string;
     /**
@@ -54,7 +54,19 @@ export interface CreateChangesetRequest {
      */
     changeType: ChangeType | string | undefined;
     /**
-     * <p>Options that define the location of the data being ingested.</p>
+     * <p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p>
+     *          <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p>
+     *          <p>Here is an example of how you could specify the <code>sourceParams</code>:</p>
+     *          <p>
+     *             <code>
+     *         "sourceParams":
+     *         {
+     *         "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+     *         "sourceType": "S3"
+     *         }
+     *       </code>
+     *          </p>
+     *          <p>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 <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>
      */
     sourceParams: {
         [key: string]: string;
@@ -84,11 +96,9 @@ export interface CreateChangesetRequest {
      *             </li>
      *          </ul>
      *
+     *          <p>Here is an example of how you could specify the <code>formatParams</code>:</p>
      *          <p>
-     *
-     *       For example, you could specify the following for <code>formatParams</code>:
-     *
-     *     <code>
+     *             <code>
      *           "formatParams":
      *         {
      *          "formatType": "CSV",
@@ -96,8 +106,18 @@ export interface CreateChangesetRequest {
      *          "separator": ",",
      *          "compression":"None"
      *          }
-     *     </code>
+     *       </code>
+     *          </p>
+     *          <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p>
+     *          <p>
+     *             <code>
+     *           {
+     *           "withHeader": "true",
+     *           "separator": ","
+     *            }
+     *         </code>
      *          </p>
+     *          <p> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>
      */
     formatParams: {
         [key: string]: string;
@@ -196,7 +216,43 @@ export declare namespace DatasetOwnerInfo {
     const filterSensitiveLog: (obj: DatasetOwnerInfo) => any;
 }
 /**
- * <p>Resource permission for a Dataset.</p>
+ * <p>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.</p>
+ *          <p>The following is a list of valid dataset permissions that you can apply:
+ *
+ *   </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>ViewDatasetDetails</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>ReadDatasetDetails</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>AddDatasetData</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>CreateSnapshot</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>EditDatasetMetadata</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>DeleteDataset</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>For more information on the ataset permissions, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>
  */
 export interface ResourcePermission {
     /**
@@ -212,6 +268,20 @@ export declare namespace ResourcePermission {
 }
 /**
  * <p>Permission group parameters for Dataset permissions.</p>
+ *          <p>Here is an example of how you could specify the <code>PermissionGroupParams</code>:</p>
+ *          <p>
+ *             <code>
+ *         {
+ *         "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g",
+ *         "datasetPermissions": [
+ *         {"permission": "ViewDatasetDetails"},
+ *         {"permission": "AddDatasetData"},
+ *         {"permission": "EditDatasetMetadata"},
+ *         {"permission": "DeleteDataset"}
+ *         ]
+ *         }
+ *       </code>
+ *          </p>
  */
 export interface PermissionGroupParams {
     /**
@@ -333,7 +403,7 @@ export declare namespace SchemaUnion {
  */
 export interface CreateDatasetRequest {
     /**
-     * <p>A token used to ensure idempotency.</p>
+     * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
      */
     clientToken?: string;
     /**
@@ -411,13 +481,40 @@ export interface DataViewDestinationTypeParams {
      *                <p>
      *                   <code>GLUE_TABLE</code> - Glue table destination type.</p>
      *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>S3</code> - S3 destination type.</p>
+     *             </li>
      *          </ul>
      */
     destinationType: string | undefined;
     /**
-     * Data View Export File Format
+     * <p>Data view export file format.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>PARQUET</code> - Parquet export file format.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DELIMITED_TEXT</code> - Delimited text export file format.</p>
+     *             </li>
+     *          </ul>
      */
     s3DestinationExportFileFormat?: ExportFileFormat | string;
+    /**
+     * <p>Format Options for S3 Destination type.</p>
+     *          <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code>
+     *          </p>
+     *          <p>
+     *             <code>
+     *         {
+     *         "header": "true",
+     *         "delimiter": ",",
+     *         "compression": "gzip"
+     *         }</code>
+     *          </p>
+     */
     s3DestinationExportFileFormatOptions?: {
         [key: string]: string;
     };
@@ -433,7 +530,7 @@ export declare namespace DataViewDestinationTypeParams {
  */
 export interface CreateDataViewRequest {
     /**
-     * <p>A token used to ensure idempotency.</p>
+     * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
      */
     clientToken?: string;
     /**
@@ -491,7 +588,7 @@ export declare namespace CreateDataViewResponse {
  */
 export interface DeleteDatasetRequest {
     /**
-     * <p>A token used to ensure idempotency.</p>
+     * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
      */
     clientToken?: string;
     /**
@@ -677,7 +774,7 @@ export interface GetChangesetResponse {
      */
     activeUntilTimestamp?: number;
     /**
-     * Milliseconds since UTC epoch
+     * <p>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.</p>
      */
     activeFromTimestamp?: number;
     /**
@@ -1195,7 +1292,7 @@ export interface ChangesetSummary {
      */
     activeUntilTimestamp?: number;
     /**
-     * Milliseconds since UTC epoch
+     * <p>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.</p>
      */
     activeFromTimestamp?: number;
     /**
@@ -1468,7 +1565,7 @@ export declare namespace ListDataViewsResponse {
  */
 export interface UpdateChangesetRequest {
     /**
-     * <p>A token used to ensure idempotency.</p>
+     * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
      */
     clientToken?: string;
     /**
@@ -1480,13 +1577,70 @@ export interface UpdateChangesetRequest {
      */
     changesetId: string | undefined;
     /**
-     * <p>Options that define the location of the data being ingested.</p>
+     * <p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p>
+     *          <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p>
+     *          <p>Here is an example of how you could specify the <code>sourceParams</code>:</p>
+     *          <p>
+     *             <code>
+     *         "sourceParams":
+     *         {
+     *         "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+     *         "sourceType": "S3"
+     *         }
+     *       </code>
+     *          </p>
+     *          <p>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 <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>
      */
     sourceParams: {
         [key: string]: string;
     } | undefined;
     /**
-     * <p>Options that define the structure of the source file(s).</p>
+     * <p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>).
+     *     </p>
+     *          <p>
+     *             <code>formatType</code> is a required attribute and can have the following values:
+     *     </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>PARQUET</code> - Parquet source file format.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>CSV</code> - CSV source file format.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>JSON</code> - JSON source file format.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>XML</code> - XML source file format.</p>
+     *             </li>
+     *          </ul>
+     *
+     *          <p>Here is an example of how you could specify the <code>formatParams</code>:</p>
+     *          <p>
+     *             <code>
+     *         "formatParams":
+     *         {
+     *         "formatType": "CSV",
+     *         "withHeader": "true",
+     *         "separator": ",",
+     *         "compression":"None"
+     *         }
+     *       </code>
+     *          </p>
+     *          <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p>
+     *          <p>
+     *             <code>
+     *         {
+     *         "withHeader": "true",
+     *         "separator": ","
+     *         }
+     *         </code>
+     *          </p>
+     *          <p> For more information about supported file formats, see <a href="https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>
      */
     formatParams: {
         [key: string]: string;
@@ -1522,7 +1676,7 @@ export declare namespace UpdateChangesetResponse {
  */
 export interface UpdateDatasetRequest {
     /**
-     * <p>A token used to ensure idempotency.</p>
+     * <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
      */
     clientToken?: string;
     /**

package/dist-types/ts3.4/models/models_0.d.ts

@@ -203,6 +203,7 @@ export interface DataViewDestinationTypeParams {
     destinationType: string | undefined;
     
     s3DestinationExportFileFormat?: ExportFileFormat | string;
+    
     s3DestinationExportFileFormatOptions?: {
         [key: string]: string;
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-finspace-data",
   "description": "AWS SDK for JavaScript Finspace Data Client for Node.js, Browser and React Native",
-  "version": "3.47.2",
+  "version": "3.48.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.47.2",
+    "@aws-sdk/client-sts": "3.48.0",
     "@aws-sdk/config-resolver": "3.47.2",
-    "@aws-sdk/credential-provider-node": "3.47.2",
+    "@aws-sdk/credential-provider-node": "3.48.0",
     "@aws-sdk/fetch-http-handler": "3.47.2",
     "@aws-sdk/hash-node": "3.47.2",
     "@aws-sdk/invalid-dependency": "3.47.2",