@aws-sdk/client-finspace-data 3.315.0 → 3.319.0

package/dist-types/FinspaceData.d.ts

@@ -31,235 +31,197 @@ import { UpdateDatasetCommandInput, UpdateDatasetCommandOutput } from "./command
 import { UpdatePermissionGroupCommandInput, UpdatePermissionGroupCommandOutput } from "./commands/UpdatePermissionGroupCommand";
 import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
 import { FinspaceDataClient } from "./FinspaceDataClient";
-/**
- * @public
- * <p> The FinSpace APIs let you take actions inside the FinSpace.</p>
- */
-export declare class FinspaceData extends FinspaceDataClient {
+export interface FinspaceData {
     /**
-     * @public
-     * <p>Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.</p>
+     * @see {@link AssociateUserToPermissionGroupCommand}
      */
     associateUserToPermissionGroup(args: AssociateUserToPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<AssociateUserToPermissionGroupCommandOutput>;
     associateUserToPermissionGroup(args: AssociateUserToPermissionGroupCommandInput, cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void): void;
     associateUserToPermissionGroup(args: AssociateUserToPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a new Changeset in a FinSpace Dataset.</p>
+     * @see {@link CreateChangesetCommand}
      */
     createChangeset(args: CreateChangesetCommandInput, options?: __HttpHandlerOptions): Promise<CreateChangesetCommandOutput>;
     createChangeset(args: CreateChangesetCommandInput, cb: (err: any, data?: CreateChangesetCommandOutput) => void): void;
     createChangeset(args: CreateChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChangesetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a new FinSpace Dataset.</p>
+     * @see {@link CreateDatasetCommand}
      */
     createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
     createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
     createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a Dataview for a Dataset.</p>
+     * @see {@link CreateDataViewCommand}
      */
     createDataView(args: CreateDataViewCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataViewCommandOutput>;
     createDataView(args: CreateDataViewCommandInput, cb: (err: any, data?: CreateDataViewCommandOutput) => void): void;
     createDataView(args: CreateDataViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataViewCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a group of permissions for various actions that a user can perform in FinSpace.</p>
+     * @see {@link CreatePermissionGroupCommand}
      */
     createPermissionGroup(args: CreatePermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreatePermissionGroupCommandOutput>;
     createPermissionGroup(args: CreatePermissionGroupCommandInput, cb: (err: any, data?: CreatePermissionGroupCommandOutput) => void): void;
     createPermissionGroup(args: CreatePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a new user in FinSpace.</p>
+     * @see {@link CreateUserCommand}
      */
     createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
     createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
     createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes a FinSpace Dataset.</p>
+     * @see {@link DeleteDatasetCommand}
      */
     deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
     deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
     deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes a permission group. This action is irreversible.</p>
+     * @see {@link DeletePermissionGroupCommand}
      */
     deletePermissionGroup(args: DeletePermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeletePermissionGroupCommandOutput>;
     deletePermissionGroup(args: DeletePermissionGroupCommandInput, cb: (err: any, data?: DeletePermissionGroupCommandOutput) => void): void;
     deletePermissionGroup(args: DeletePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Denies access to the FinSpace web application and API for the specified user.</p>
+     * @see {@link DisableUserCommand}
      */
     disableUser(args: DisableUserCommandInput, options?: __HttpHandlerOptions): Promise<DisableUserCommandOutput>;
     disableUser(args: DisableUserCommandInput, cb: (err: any, data?: DisableUserCommandOutput) => void): void;
     disableUser(args: DisableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Removes a user account from a permission group.</p>
+     * @see {@link DisassociateUserFromPermissionGroupCommand}
      */
     disassociateUserFromPermissionGroup(args: DisassociateUserFromPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateUserFromPermissionGroupCommandOutput>;
     disassociateUserFromPermissionGroup(args: DisassociateUserFromPermissionGroupCommandInput, cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void): void;
     disassociateUserFromPermissionGroup(args: DisassociateUserFromPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p> Allows the specified user to access the FinSpace web application and API.</p>
+     * @see {@link EnableUserCommand}
      */
     enableUser(args: EnableUserCommandInput, options?: __HttpHandlerOptions): Promise<EnableUserCommandOutput>;
     enableUser(args: EnableUserCommandInput, cb: (err: any, data?: EnableUserCommandOutput) => void): void;
     enableUser(args: EnableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Get information about a Changeset.</p>
+     * @see {@link GetChangesetCommand}
      */
     getChangeset(args: GetChangesetCommandInput, options?: __HttpHandlerOptions): Promise<GetChangesetCommandOutput>;
     getChangeset(args: GetChangesetCommandInput, cb: (err: any, data?: GetChangesetCommandOutput) => void): void;
     getChangeset(args: GetChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangesetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Returns information about a Dataset.</p>
+     * @see {@link GetDatasetCommand}
      */
     getDataset(args: GetDatasetCommandInput, options?: __HttpHandlerOptions): Promise<GetDatasetCommandOutput>;
     getDataset(args: GetDatasetCommandInput, cb: (err: any, data?: GetDatasetCommandOutput) => void): void;
     getDataset(args: GetDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatasetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Gets information about a Dataview.</p>
+     * @see {@link GetDataViewCommand}
      */
     getDataView(args: GetDataViewCommandInput, options?: __HttpHandlerOptions): Promise<GetDataViewCommandOutput>;
     getDataView(args: GetDataViewCommandInput, cb: (err: any, data?: GetDataViewCommandOutput) => void): void;
     getDataView(args: GetDataViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataViewCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p>
-     *          <ul>
-     *             <li>
-     *                <p>You must retrieve the programmatic credentials.</p>
-     *             </li>
-     *             <li>
-     *                <p>You must be a member of a FinSpace user group, where the dataset that you want to access has <code>Read Dataset Data</code> permissions.</p>
-     *             </li>
-     *          </ul>
+     * @see {@link GetExternalDataViewAccessDetailsCommand}
      */
     getExternalDataViewAccessDetails(args: GetExternalDataViewAccessDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetExternalDataViewAccessDetailsCommandOutput>;
     getExternalDataViewAccessDetails(args: GetExternalDataViewAccessDetailsCommandInput, cb: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void): void;
     getExternalDataViewAccessDetails(args: GetExternalDataViewAccessDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves the details of a specific permission group.</p>
+     * @see {@link GetPermissionGroupCommand}
      */
     getPermissionGroup(args: GetPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetPermissionGroupCommandOutput>;
     getPermissionGroup(args: GetPermissionGroupCommandInput, cb: (err: any, data?: GetPermissionGroupCommandOutput) => void): void;
     getPermissionGroup(args: GetPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Request programmatic credentials to use with FinSpace SDK.</p>
+     * @see {@link GetProgrammaticAccessCredentialsCommand}
      */
     getProgrammaticAccessCredentials(args: GetProgrammaticAccessCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<GetProgrammaticAccessCredentialsCommandOutput>;
     getProgrammaticAccessCredentials(args: GetProgrammaticAccessCredentialsCommandInput, cb: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void): void;
     getProgrammaticAccessCredentials(args: GetProgrammaticAccessCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Retrieves details for a specific user.</p>
+     * @see {@link GetUserCommand}
      */
     getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise<GetUserCommandOutput>;
     getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void;
     getUser(args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use
-     *       as a scratch space in FinSpace notebook.</p>
+     * @see {@link GetWorkingLocationCommand}
      */
     getWorkingLocation(args: GetWorkingLocationCommandInput, options?: __HttpHandlerOptions): Promise<GetWorkingLocationCommandOutput>;
     getWorkingLocation(args: GetWorkingLocationCommandInput, cb: (err: any, data?: GetWorkingLocationCommandOutput) => void): void;
     getWorkingLocation(args: GetWorkingLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkingLocationCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists the FinSpace Changesets for a Dataset.</p>
+     * @see {@link ListChangesetsCommand}
      */
     listChangesets(args: ListChangesetsCommandInput, options?: __HttpHandlerOptions): Promise<ListChangesetsCommandOutput>;
     listChangesets(args: ListChangesetsCommandInput, cb: (err: any, data?: ListChangesetsCommandOutput) => void): void;
     listChangesets(args: ListChangesetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangesetsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists all of the active Datasets that a user has access to.</p>
+     * @see {@link ListDatasetsCommand}
      */
     listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
     listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
     listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists all available Dataviews for a Dataset.</p>
+     * @see {@link ListDataViewsCommand}
      */
     listDataViews(args: ListDataViewsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataViewsCommandOutput>;
     listDataViews(args: ListDataViewsCommandInput, cb: (err: any, data?: ListDataViewsCommandOutput) => void): void;
     listDataViews(args: ListDataViewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataViewsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists all available permission groups in FinSpace.</p>
+     * @see {@link ListPermissionGroupsCommand}
      */
     listPermissionGroups(args: ListPermissionGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionGroupsCommandOutput>;
     listPermissionGroups(args: ListPermissionGroupsCommandInput, cb: (err: any, data?: ListPermissionGroupsCommandOutput) => void): void;
     listPermissionGroups(args: ListPermissionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionGroupsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists all the permission groups that are associated with a specific user account.</p>
+     * @see {@link ListPermissionGroupsByUserCommand}
      */
     listPermissionGroupsByUser(args: ListPermissionGroupsByUserCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionGroupsByUserCommandOutput>;
     listPermissionGroupsByUser(args: ListPermissionGroupsByUserCommandInput, cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void): void;
     listPermissionGroupsByUser(args: ListPermissionGroupsByUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists all available user accounts in FinSpace.</p>
+     * @see {@link ListUsersCommand}
      */
     listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
     listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
     listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists details of all the users in a specific permission group.</p>
+     * @see {@link ListUsersByPermissionGroupCommand}
      */
     listUsersByPermissionGroup(args: ListUsersByPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersByPermissionGroupCommandOutput>;
     listUsersByPermissionGroup(args: ListUsersByPermissionGroupCommandInput, cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void): void;
     listUsersByPermissionGroup(args: ListUsersByPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.</p>
+     * @see {@link ResetUserPasswordCommand}
      */
     resetUserPassword(args: ResetUserPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ResetUserPasswordCommandOutput>;
     resetUserPassword(args: ResetUserPasswordCommandInput, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void): void;
     resetUserPassword(args: ResetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates a FinSpace Changeset.</p>
+     * @see {@link UpdateChangesetCommand}
      */
     updateChangeset(args: UpdateChangesetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChangesetCommandOutput>;
     updateChangeset(args: UpdateChangesetCommandInput, cb: (err: any, data?: UpdateChangesetCommandOutput) => void): void;
     updateChangeset(args: UpdateChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChangesetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates a FinSpace Dataset.</p>
+     * @see {@link UpdateDatasetCommand}
      */
     updateDataset(args: UpdateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatasetCommandOutput>;
     updateDataset(args: UpdateDatasetCommandInput, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void;
     updateDataset(args: UpdateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Modifies the details of a permission group. You cannot modify a <code>permissionGroupID</code>.</p>
+     * @see {@link UpdatePermissionGroupCommand}
      */
     updatePermissionGroup(args: UpdatePermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePermissionGroupCommandOutput>;
     updatePermissionGroup(args: UpdatePermissionGroupCommandInput, cb: (err: any, data?: UpdatePermissionGroupCommandOutput) => void): void;
     updatePermissionGroup(args: UpdatePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionGroupCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Modifies the details of the specified user account. You cannot update the <code>userId</code> for a user.</p>
+     * @see {@link UpdateUserCommand}
      */
     updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
     updateUser(args: UpdateUserCommandInput, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
     updateUser(args: UpdateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateUserCommandOutput) => void): void;
 }
+/**
+ * @public
+ * <p> The FinSpace APIs let you take actions inside the FinSpace.</p>
+ */
+export declare class FinspaceData extends FinspaceDataClient implements FinspaceData {
+}

package/dist-types/ts3.4/FinspaceData.d.ts

@@ -124,7 +124,7 @@ import {
   UpdateUserCommandOutput,
 } from "./commands/UpdateUserCommand";
 import { FinspaceDataClient } from "./FinspaceDataClient";
-export declare class FinspaceData extends FinspaceDataClient {
+export interface FinspaceData {
   associateUserToPermissionGroup(
     args: AssociateUserToPermissionGroupCommandInput,
     options?: __HttpHandlerOptions
@@ -535,3 +535,6 @@ export declare class FinspaceData extends FinspaceDataClient {
     cb: (err: any, data?: UpdateUserCommandOutput) => void
   ): void;
 }
+export declare class FinspaceData
+  extends FinspaceDataClient
+  implements FinspaceData {}

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.315.0",
+  "version": "3.319.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.315.0",
+    "@aws-sdk/client-sts": "3.319.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.315.0",
+    "@aws-sdk/credential-provider-node": "3.319.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -36,19 +36,19 @@
     "@aws-sdk/middleware-serde": "3.310.0",
     "@aws-sdk/middleware-signing": "3.310.0",
     "@aws-sdk/middleware-stack": "3.310.0",
-    "@aws-sdk/middleware-user-agent": "3.310.0",
+    "@aws-sdk/middleware-user-agent": "3.319.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.315.0",
+    "@aws-sdk/smithy-client": "3.316.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.315.0",
-    "@aws-sdk/util-defaults-mode-node": "3.315.0",
-    "@aws-sdk/util-endpoints": "3.310.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
+    "@aws-sdk/util-defaults-mode-node": "3.316.0",
+    "@aws-sdk/util-endpoints": "3.319.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",
     "@aws-sdk/util-user-agent-node": "3.310.0",