Skip to content

Commit d29cb21

Browse files
author
awstools
committed
feat(client-finspace-data): This release adds a new set of APIs, GetPermissionGroup, DisassociateUserFromPermissionGroup, AssociateUserToPermissionGroup, ListPermissionGroupsByUser, ListUsersByPermissionGroup.
1 parent 03773d1 commit d29cb21

12 files changed

+2347
-173
lines changed

‎clients/client-finspace-data/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ using your favorite package manager:
2626

2727
The AWS SDK is modulized by clients and commands.
2828
To send a request, you only need to import the `FinspaceDataClient` and
29-
the commands you need, for example `CreateChangesetCommand`:
29+
the commands you need, for example `AssociateUserToPermissionGroupCommand`:
3030

3131
```js
3232
// ES5 example
33-
const { FinspaceDataClient, CreateChangesetCommand } = require("@aws-sdk/client-finspace-data");
33+
const { FinspaceDataClient, AssociateUserToPermissionGroupCommand } = require("@aws-sdk/client-finspace-data");
3434
```
3535

3636
```ts
3737
// ES6+ example
38-
import { FinspaceDataClient, CreateChangesetCommand } from "@aws-sdk/client-finspace-data";
38+
import { FinspaceDataClient, AssociateUserToPermissionGroupCommand } from "@aws-sdk/client-finspace-data";
3939
```
4040

4141
### Usage
@@ -54,7 +54,7 @@ const client = new FinspaceDataClient({ region: "REGION" });
5454
const params = {
5555
/** input parameters */
5656
};
57-
const command = new CreateChangesetCommand(params);
57+
const command = new AssociateUserToPermissionGroupCommand(params);
5858
```
5959

6060
#### Async/await
@@ -133,15 +133,15 @@ const client = new AWS.FinspaceData({ region: "REGION" });
133133

134134
// async/await.
135135
try {
136-
const data = await client.createChangeset(params);
136+
const data = await client.associateUserToPermissionGroup(params);
137137
// process data.
138138
} catch (error) {
139139
// error handling.
140140
}
141141

142142
// Promises.
143143
client
144-
.createChangeset(params)
144+
.associateUserToPermissionGroup(params)
145145
.then((data) => {
146146
// process data.
147147
})
@@ -150,7 +150,7 @@ client
150150
});
151151

152152
// callbacks.
153-
client.createChangeset(params, (err, data) => {
153+
client.associateUserToPermissionGroup(params, (err, data) => {
154154
// process err and data.
155155
});
156156
```

‎clients/client-finspace-data/src/FinspaceData.ts

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
// smithy-typescript generated code
22
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
33

4+
import {
5+
AssociateUserToPermissionGroupCommand,
6+
AssociateUserToPermissionGroupCommandInput,
7+
AssociateUserToPermissionGroupCommandOutput,
8+
} from "./commands/AssociateUserToPermissionGroupCommand";
49
import {
510
CreateChangesetCommand,
611
CreateChangesetCommandInput,
@@ -33,6 +38,11 @@ import {
3338
DeletePermissionGroupCommandOutput,
3439
} from "./commands/DeletePermissionGroupCommand";
3540
import { DisableUserCommand, DisableUserCommandInput, DisableUserCommandOutput } from "./commands/DisableUserCommand";
41+
import {
42+
DisassociateUserFromPermissionGroupCommand,
43+
DisassociateUserFromPermissionGroupCommandInput,
44+
DisassociateUserFromPermissionGroupCommandOutput,
45+
} from "./commands/DisassociateUserFromPermissionGroupCommand";
3646
import { EnableUserCommand, EnableUserCommandInput, EnableUserCommandOutput } from "./commands/EnableUserCommand";
3747
import {
3848
GetChangesetCommand,
@@ -41,6 +51,11 @@ import {
4151
} from "./commands/GetChangesetCommand";
4252
import { GetDatasetCommand, GetDatasetCommandInput, GetDatasetCommandOutput } from "./commands/GetDatasetCommand";
4353
import { GetDataViewCommand, GetDataViewCommandInput, GetDataViewCommandOutput } from "./commands/GetDataViewCommand";
54+
import {
55+
GetPermissionGroupCommand,
56+
GetPermissionGroupCommandInput,
57+
GetPermissionGroupCommandOutput,
58+
} from "./commands/GetPermissionGroupCommand";
4459
import {
4560
GetProgrammaticAccessCredentialsCommand,
4661
GetProgrammaticAccessCredentialsCommandInput,
@@ -67,11 +82,21 @@ import {
6782
ListDataViewsCommandInput,
6883
ListDataViewsCommandOutput,
6984
} from "./commands/ListDataViewsCommand";
85+
import {
86+
ListPermissionGroupsByUserCommand,
87+
ListPermissionGroupsByUserCommandInput,
88+
ListPermissionGroupsByUserCommandOutput,
89+
} from "./commands/ListPermissionGroupsByUserCommand";
7090
import {
7191
ListPermissionGroupsCommand,
7292
ListPermissionGroupsCommandInput,
7393
ListPermissionGroupsCommandOutput,
7494
} from "./commands/ListPermissionGroupsCommand";
95+
import {
96+
ListUsersByPermissionGroupCommand,
97+
ListUsersByPermissionGroupCommandInput,
98+
ListUsersByPermissionGroupCommandOutput,
99+
} from "./commands/ListUsersByPermissionGroupCommand";
75100
import { ListUsersCommand, ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand";
76101
import {
77102
ResetUserPasswordCommand,
@@ -100,6 +125,38 @@ import { FinspaceDataClient } from "./FinspaceDataClient";
100125
* <p> The FinSpace APIs let you take actions inside the FinSpace.</p>
101126
*/
102127
export class FinspaceData extends FinspaceDataClient {
128+
/**
129+
* <p>Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.</p>
130+
*/
131+
public associateUserToPermissionGroup(
132+
args: AssociateUserToPermissionGroupCommandInput,
133+
options?: __HttpHandlerOptions
134+
): Promise<AssociateUserToPermissionGroupCommandOutput>;
135+
public associateUserToPermissionGroup(
136+
args: AssociateUserToPermissionGroupCommandInput,
137+
cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void
138+
): void;
139+
public associateUserToPermissionGroup(
140+
args: AssociateUserToPermissionGroupCommandInput,
141+
options: __HttpHandlerOptions,
142+
cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void
143+
): void;
144+
public associateUserToPermissionGroup(
145+
args: AssociateUserToPermissionGroupCommandInput,
146+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void),
147+
cb?: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void
148+
): Promise<AssociateUserToPermissionGroupCommandOutput> | void {
149+
const command = new AssociateUserToPermissionGroupCommand(args);
150+
if (typeof optionsOrCb === "function") {
151+
this.send(command, optionsOrCb);
152+
} else if (typeof cb === "function") {
153+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
154+
this.send(command, optionsOrCb || {}, cb);
155+
} else {
156+
return this.send(command, optionsOrCb);
157+
}
158+
}
159+
103160
/**
104161
* <p>Creates a new Changeset in a FinSpace Dataset.</p>
105162
*/
@@ -344,6 +401,38 @@ export class FinspaceData extends FinspaceDataClient {
344401
}
345402
}
346403

404+
/**
405+
* <p>Removes a user account from a permission group.</p>
406+
*/
407+
public disassociateUserFromPermissionGroup(
408+
args: DisassociateUserFromPermissionGroupCommandInput,
409+
options?: __HttpHandlerOptions
410+
): Promise<DisassociateUserFromPermissionGroupCommandOutput>;
411+
public disassociateUserFromPermissionGroup(
412+
args: DisassociateUserFromPermissionGroupCommandInput,
413+
cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void
414+
): void;
415+
public disassociateUserFromPermissionGroup(
416+
args: DisassociateUserFromPermissionGroupCommandInput,
417+
options: __HttpHandlerOptions,
418+
cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void
419+
): void;
420+
public disassociateUserFromPermissionGroup(
421+
args: DisassociateUserFromPermissionGroupCommandInput,
422+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void),
423+
cb?: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void
424+
): Promise<DisassociateUserFromPermissionGroupCommandOutput> | void {
425+
const command = new DisassociateUserFromPermissionGroupCommand(args);
426+
if (typeof optionsOrCb === "function") {
427+
this.send(command, optionsOrCb);
428+
} else if (typeof cb === "function") {
429+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
430+
this.send(command, optionsOrCb || {}, cb);
431+
} else {
432+
return this.send(command, optionsOrCb);
433+
}
434+
}
435+
347436
/**
348437
* <p> Allows the specified user to access the FinSpace web application and API.</p>
349438
*/
@@ -451,6 +540,38 @@ export class FinspaceData extends FinspaceDataClient {
451540
}
452541
}
453542

543+
/**
544+
* <p>Retrieves the details of a specific permission group.</p>
545+
*/
546+
public getPermissionGroup(
547+
args: GetPermissionGroupCommandInput,
548+
options?: __HttpHandlerOptions
549+
): Promise<GetPermissionGroupCommandOutput>;
550+
public getPermissionGroup(
551+
args: GetPermissionGroupCommandInput,
552+
cb: (err: any, data?: GetPermissionGroupCommandOutput) => void
553+
): void;
554+
public getPermissionGroup(
555+
args: GetPermissionGroupCommandInput,
556+
options: __HttpHandlerOptions,
557+
cb: (err: any, data?: GetPermissionGroupCommandOutput) => void
558+
): void;
559+
public getPermissionGroup(
560+
args: GetPermissionGroupCommandInput,
561+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetPermissionGroupCommandOutput) => void),
562+
cb?: (err: any, data?: GetPermissionGroupCommandOutput) => void
563+
): Promise<GetPermissionGroupCommandOutput> | void {
564+
const command = new GetPermissionGroupCommand(args);
565+
if (typeof optionsOrCb === "function") {
566+
this.send(command, optionsOrCb);
567+
} else if (typeof cb === "function") {
568+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
569+
this.send(command, optionsOrCb || {}, cb);
570+
} else {
571+
return this.send(command, optionsOrCb);
572+
}
573+
}
574+
454575
/**
455576
* <p>Request programmatic credentials to use with FinSpace SDK.</p>
456577
*/
@@ -667,6 +788,38 @@ export class FinspaceData extends FinspaceDataClient {
667788
}
668789
}
669790

791+
/**
792+
* <p>Lists all the permission groups that are associated with a specific user account.</p>
793+
*/
794+
public listPermissionGroupsByUser(
795+
args: ListPermissionGroupsByUserCommandInput,
796+
options?: __HttpHandlerOptions
797+
): Promise<ListPermissionGroupsByUserCommandOutput>;
798+
public listPermissionGroupsByUser(
799+
args: ListPermissionGroupsByUserCommandInput,
800+
cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void
801+
): void;
802+
public listPermissionGroupsByUser(
803+
args: ListPermissionGroupsByUserCommandInput,
804+
options: __HttpHandlerOptions,
805+
cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void
806+
): void;
807+
public listPermissionGroupsByUser(
808+
args: ListPermissionGroupsByUserCommandInput,
809+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListPermissionGroupsByUserCommandOutput) => void),
810+
cb?: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void
811+
): Promise<ListPermissionGroupsByUserCommandOutput> | void {
812+
const command = new ListPermissionGroupsByUserCommand(args);
813+
if (typeof optionsOrCb === "function") {
814+
this.send(command, optionsOrCb);
815+
} else if (typeof cb === "function") {
816+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
817+
this.send(command, optionsOrCb || {}, cb);
818+
} else {
819+
return this.send(command, optionsOrCb);
820+
}
821+
}
822+
670823
/**
671824
* <p>Lists all available user accounts in FinSpace.</p>
672825
*/
@@ -693,6 +846,38 @@ export class FinspaceData extends FinspaceDataClient {
693846
}
694847
}
695848

849+
/**
850+
* <p>Lists details of all the users in a specific permission group.</p>
851+
*/
852+
public listUsersByPermissionGroup(
853+
args: ListUsersByPermissionGroupCommandInput,
854+
options?: __HttpHandlerOptions
855+
): Promise<ListUsersByPermissionGroupCommandOutput>;
856+
public listUsersByPermissionGroup(
857+
args: ListUsersByPermissionGroupCommandInput,
858+
cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void
859+
): void;
860+
public listUsersByPermissionGroup(
861+
args: ListUsersByPermissionGroupCommandInput,
862+
options: __HttpHandlerOptions,
863+
cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void
864+
): void;
865+
public listUsersByPermissionGroup(
866+
args: ListUsersByPermissionGroupCommandInput,
867+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListUsersByPermissionGroupCommandOutput) => void),
868+
cb?: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void
869+
): Promise<ListUsersByPermissionGroupCommandOutput> | void {
870+
const command = new ListUsersByPermissionGroupCommand(args);
871+
if (typeof optionsOrCb === "function") {
872+
this.send(command, optionsOrCb);
873+
} else if (typeof cb === "function") {
874+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
875+
this.send(command, optionsOrCb || {}, cb);
876+
} else {
877+
return this.send(command, optionsOrCb);
878+
}
879+
}
880+
696881
/**
697882
* <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>
698883
*/

0 commit comments

Comments
 (0)