@aws-sdk/client-finspace-data 3.418.0 → 3.419.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/commands/GetProgrammaticAccessCredentialsCommand.js +2 -1
- package/dist-cjs/models/models_0.js +11 -2
- package/dist-cjs/protocols/Aws_restJson1.js +1 -1
- package/dist-es/commands/GetProgrammaticAccessCredentialsCommand.js +2 -1
- package/dist-es/models/models_0.js +8 -1
- package/dist-es/protocols/Aws_restJson1.js +1 -1
- package/dist-types/commands/AssociateUserToPermissionGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateUserFromPermissionGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetProgrammaticAccessCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ListPermissionGroupsByUserCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +50 -42
- package/dist-types/ts3.4/models/models_0.d.ts +5 -1
- package/package.json +1 -1
|
@@ -6,6 +6,7 @@ const middleware_serde_1 = require("@smithy/middleware-serde");
|
|
|
6
6
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
7
7
|
Object.defineProperty(exports, "$Command", { enumerable: true, get: function () { return smithy_client_1.Command; } });
|
|
8
8
|
const types_1 = require("@smithy/types");
|
|
9
|
+
const models_0_1 = require("../models/models_0");
|
|
9
10
|
const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
|
|
10
11
|
class GetProgrammaticAccessCredentialsCommand extends smithy_client_1.Command {
|
|
11
12
|
static getEndpointParameterInstructions() {
|
|
@@ -32,7 +33,7 @@ class GetProgrammaticAccessCredentialsCommand extends smithy_client_1.Command {
|
|
|
32
33
|
clientName,
|
|
33
34
|
commandName,
|
|
34
35
|
inputFilterSensitiveLog: (_) => _,
|
|
35
|
-
outputFilterSensitiveLog:
|
|
36
|
+
outputFilterSensitiveLog: models_0_1.GetProgrammaticAccessCredentialsResponseFilterSensitiveLog,
|
|
36
37
|
[types_1.SMITHY_CONTEXT_KEY]: {
|
|
37
38
|
service: "AWSHabaneroPublicAPI",
|
|
38
39
|
operation: "GetProgrammaticAccessCredentials",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.UpdateUserRequestFilterSensitiveLog = exports.UpdatePermissionGroupRequestFilterSensitiveLog = exports.ResetUserPasswordResponseFilterSensitiveLog = exports.ListUsersByPermissionGroupResponseFilterSensitiveLog = exports.UserByPermissionGroupFilterSensitiveLog = exports.ListUsersResponseFilterSensitiveLog = exports.UserFilterSensitiveLog = exports.ListPermissionGroupsByUserResponseFilterSensitiveLog = exports.PermissionGroupByUserFilterSensitiveLog = exports.ListPermissionGroupsResponseFilterSensitiveLog = exports.ListDatasetsResponseFilterSensitiveLog = exports.DatasetFilterSensitiveLog = exports.GetUserResponseFilterSensitiveLog = exports.GetPermissionGroupResponseFilterSensitiveLog = exports.PermissionGroupFilterSensitiveLog = exports.GetExternalDataViewAccessDetailsResponseFilterSensitiveLog = exports.CreateUserRequestFilterSensitiveLog = exports.CreatePermissionGroupRequestFilterSensitiveLog = exports.CreateDatasetRequestFilterSensitiveLog = exports.DatasetOwnerInfoFilterSensitiveLog = exports.AwsCredentialsFilterSensitiveLog = exports.LocationType = exports.UserStatus = exports.PermissionGroupMembershipStatus = exports.DataViewStatus = exports.DatasetStatus = exports.IngestionStatus = exports.ErrorCategory = exports.UserType = exports.ExportFileFormat = exports.ColumnDataType = exports.DatasetKind = exports.LimitExceededException = exports.ChangeType = exports.ValidationException = exports.ThrottlingException = exports.ResourceNotFoundException = exports.InternalServerException = exports.ConflictException = exports.ApplicationPermission = exports.ApiAccess = exports.AccessDeniedException = void 0;
|
|
3
|
+
exports.UpdateUserRequestFilterSensitiveLog = exports.UpdatePermissionGroupRequestFilterSensitiveLog = exports.ResetUserPasswordResponseFilterSensitiveLog = exports.ListUsersByPermissionGroupResponseFilterSensitiveLog = exports.UserByPermissionGroupFilterSensitiveLog = exports.ListUsersResponseFilterSensitiveLog = exports.UserFilterSensitiveLog = exports.ListPermissionGroupsByUserResponseFilterSensitiveLog = exports.PermissionGroupByUserFilterSensitiveLog = exports.ListPermissionGroupsResponseFilterSensitiveLog = exports.ListDatasetsResponseFilterSensitiveLog = exports.DatasetFilterSensitiveLog = exports.GetUserResponseFilterSensitiveLog = exports.GetProgrammaticAccessCredentialsResponseFilterSensitiveLog = exports.CredentialsFilterSensitiveLog = exports.GetPermissionGroupResponseFilterSensitiveLog = exports.PermissionGroupFilterSensitiveLog = exports.GetExternalDataViewAccessDetailsResponseFilterSensitiveLog = exports.CreateUserRequestFilterSensitiveLog = exports.CreatePermissionGroupRequestFilterSensitiveLog = exports.CreateDatasetRequestFilterSensitiveLog = exports.DatasetOwnerInfoFilterSensitiveLog = exports.AwsCredentialsFilterSensitiveLog = exports.LocationType = exports.UserStatus = exports.PermissionGroupMembershipStatus = exports.DataViewStatus = exports.DatasetStatus = exports.IngestionStatus = exports.ErrorCategory = exports.UserType = exports.ExportFileFormat = exports.ColumnDataType = exports.DatasetKind = exports.LimitExceededException = exports.ChangeType = exports.ValidationException = exports.ThrottlingException = exports.ResourceNotFoundException = exports.InternalServerException = exports.ConflictException = exports.ApplicationPermission = exports.ApiAccess = exports.AccessDeniedException = void 0;
|
|
4
4
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
5
5
|
const FinspaceDataServiceException_1 = require("./FinspaceDataServiceException");
|
|
6
6
|
class AccessDeniedException extends FinspaceDataServiceException_1.FinspaceDataServiceException {
|
|
@@ -219,7 +219,7 @@ const CreateUserRequestFilterSensitiveLog = (obj) => ({
|
|
|
219
219
|
exports.CreateUserRequestFilterSensitiveLog = CreateUserRequestFilterSensitiveLog;
|
|
220
220
|
const GetExternalDataViewAccessDetailsResponseFilterSensitiveLog = (obj) => ({
|
|
221
221
|
...obj,
|
|
222
|
-
...(obj.credentials && { credentials:
|
|
222
|
+
...(obj.credentials && { credentials: smithy_client_1.SENSITIVE_STRING }),
|
|
223
223
|
});
|
|
224
224
|
exports.GetExternalDataViewAccessDetailsResponseFilterSensitiveLog = GetExternalDataViewAccessDetailsResponseFilterSensitiveLog;
|
|
225
225
|
const PermissionGroupFilterSensitiveLog = (obj) => ({
|
|
@@ -233,6 +233,15 @@ const GetPermissionGroupResponseFilterSensitiveLog = (obj) => ({
|
|
|
233
233
|
...(obj.permissionGroup && { permissionGroup: (0, exports.PermissionGroupFilterSensitiveLog)(obj.permissionGroup) }),
|
|
234
234
|
});
|
|
235
235
|
exports.GetPermissionGroupResponseFilterSensitiveLog = GetPermissionGroupResponseFilterSensitiveLog;
|
|
236
|
+
const CredentialsFilterSensitiveLog = (obj) => ({
|
|
237
|
+
...obj,
|
|
238
|
+
});
|
|
239
|
+
exports.CredentialsFilterSensitiveLog = CredentialsFilterSensitiveLog;
|
|
240
|
+
const GetProgrammaticAccessCredentialsResponseFilterSensitiveLog = (obj) => ({
|
|
241
|
+
...obj,
|
|
242
|
+
...(obj.credentials && { credentials: smithy_client_1.SENSITIVE_STRING }),
|
|
243
|
+
});
|
|
244
|
+
exports.GetProgrammaticAccessCredentialsResponseFilterSensitiveLog = GetProgrammaticAccessCredentialsResponseFilterSensitiveLog;
|
|
236
245
|
const GetUserResponseFilterSensitiveLog = (obj) => ({
|
|
237
246
|
...obj,
|
|
238
247
|
...(obj.firstName && { firstName: smithy_client_1.SENSITIVE_STRING }),
|
|
@@ -143,7 +143,7 @@ const se_CreateUserCommand = async (input, context) => {
|
|
|
143
143
|
const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/user";
|
|
144
144
|
let body;
|
|
145
145
|
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
146
|
-
|
|
146
|
+
apiAccess: [],
|
|
147
147
|
apiAccessPrincipalArn: [],
|
|
148
148
|
clientToken: [true, (_) => _ ?? (0, uuid_1.v4)()],
|
|
149
149
|
emailAddress: [],
|
|
@@ -2,6 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
|
2
2
|
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
3
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
4
|
import { SMITHY_CONTEXT_KEY, } from "@smithy/types";
|
|
5
|
+
import { GetProgrammaticAccessCredentialsResponseFilterSensitiveLog, } from "../models/models_0";
|
|
5
6
|
import { de_GetProgrammaticAccessCredentialsCommand, se_GetProgrammaticAccessCredentialsCommand, } from "../protocols/Aws_restJson1";
|
|
6
7
|
export { $Command };
|
|
7
8
|
export class GetProgrammaticAccessCredentialsCommand extends $Command {
|
|
@@ -29,7 +30,7 @@ export class GetProgrammaticAccessCredentialsCommand extends $Command {
|
|
|
29
30
|
clientName,
|
|
30
31
|
commandName,
|
|
31
32
|
inputFilterSensitiveLog: (_) => _,
|
|
32
|
-
outputFilterSensitiveLog:
|
|
33
|
+
outputFilterSensitiveLog: GetProgrammaticAccessCredentialsResponseFilterSensitiveLog,
|
|
33
34
|
[SMITHY_CONTEXT_KEY]: {
|
|
34
35
|
service: "AWSHabaneroPublicAPI",
|
|
35
36
|
operation: "GetProgrammaticAccessCredentials",
|
|
@@ -204,7 +204,7 @@ export const CreateUserRequestFilterSensitiveLog = (obj) => ({
|
|
|
204
204
|
});
|
|
205
205
|
export const GetExternalDataViewAccessDetailsResponseFilterSensitiveLog = (obj) => ({
|
|
206
206
|
...obj,
|
|
207
|
-
...(obj.credentials && { credentials:
|
|
207
|
+
...(obj.credentials && { credentials: SENSITIVE_STRING }),
|
|
208
208
|
});
|
|
209
209
|
export const PermissionGroupFilterSensitiveLog = (obj) => ({
|
|
210
210
|
...obj,
|
|
@@ -215,6 +215,13 @@ export const GetPermissionGroupResponseFilterSensitiveLog = (obj) => ({
|
|
|
215
215
|
...obj,
|
|
216
216
|
...(obj.permissionGroup && { permissionGroup: PermissionGroupFilterSensitiveLog(obj.permissionGroup) }),
|
|
217
217
|
});
|
|
218
|
+
export const CredentialsFilterSensitiveLog = (obj) => ({
|
|
219
|
+
...obj,
|
|
220
|
+
});
|
|
221
|
+
export const GetProgrammaticAccessCredentialsResponseFilterSensitiveLog = (obj) => ({
|
|
222
|
+
...obj,
|
|
223
|
+
...(obj.credentials && { credentials: SENSITIVE_STRING }),
|
|
224
|
+
});
|
|
218
225
|
export const GetUserResponseFilterSensitiveLog = (obj) => ({
|
|
219
226
|
...obj,
|
|
220
227
|
...(obj.firstName && { firstName: SENSITIVE_STRING }),
|
|
@@ -134,7 +134,7 @@ export const se_CreateUserCommand = async (input, context) => {
|
|
|
134
134
|
const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/user";
|
|
135
135
|
let body;
|
|
136
136
|
body = JSON.stringify(take(input, {
|
|
137
|
-
|
|
137
|
+
apiAccess: [],
|
|
138
138
|
apiAccessPrincipalArn: [],
|
|
139
139
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
140
140
|
emailAddress: [],
|
|
@@ -23,7 +23,7 @@ export interface AssociateUserToPermissionGroupCommandOutput extends AssociateUs
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Adds a user
|
|
26
|
+
* <p>Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -35,7 +35,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
35
35
|
* type: "SUPER_USER" || "APP_USER", // required
|
|
36
36
|
* firstName: "STRING_VALUE",
|
|
37
37
|
* lastName: "STRING_VALUE",
|
|
38
|
-
*
|
|
38
|
+
* apiAccess: "ENABLED" || "DISABLED",
|
|
39
39
|
* apiAccessPrincipalArn: "STRING_VALUE",
|
|
40
40
|
* clientToken: "STRING_VALUE",
|
|
41
41
|
* };
|
|
@@ -23,7 +23,7 @@ export interface DisassociateUserFromPermissionGroupCommandOutput extends Disass
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Removes a user
|
|
26
|
+
* <p>Removes a user from a permission group.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface GetProgrammaticAccessCredentialsCommandOutput extends GetProgra
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Request programmatic credentials to use with FinSpace SDK
|
|
26
|
+
* <p>Request programmatic credentials to use with FinSpace SDK. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials">Step 2. Access credentials programmatically using IAM access key id and secret access key</a>.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface ListPermissionGroupsByUserCommandOutput extends ListPermissionG
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists all the permission groups that are associated with a specific user
|
|
26
|
+
* <p>Lists all the permission groups that are associated with a specific user.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists all available
|
|
26
|
+
* <p>Lists all available users in FinSpace.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Modifies the details of the specified user
|
|
26
|
+
* <p>Modifies the details of the specified user. You cannot update the <code>userId</code> for a user.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -829,7 +829,7 @@ export interface CreateUserRequest {
|
|
|
829
829
|
* </li>
|
|
830
830
|
* </ul>
|
|
831
831
|
*/
|
|
832
|
-
|
|
832
|
+
apiAccess?: ApiAccess | string;
|
|
833
833
|
/**
|
|
834
834
|
* @public
|
|
835
835
|
* <p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>
|
|
@@ -909,7 +909,7 @@ export interface DeletePermissionGroupResponse {
|
|
|
909
909
|
export interface DisableUserRequest {
|
|
910
910
|
/**
|
|
911
911
|
* @public
|
|
912
|
-
* <p>The unique identifier for the user
|
|
912
|
+
* <p>The unique identifier for the user that you want to deactivate.</p>
|
|
913
913
|
*/
|
|
914
914
|
userId: string | undefined;
|
|
915
915
|
/**
|
|
@@ -924,7 +924,7 @@ export interface DisableUserRequest {
|
|
|
924
924
|
export interface DisableUserResponse {
|
|
925
925
|
/**
|
|
926
926
|
* @public
|
|
927
|
-
* <p>The unique identifier for the
|
|
927
|
+
* <p>The unique identifier for the deactivated user.</p>
|
|
928
928
|
*/
|
|
929
929
|
userId?: string;
|
|
930
930
|
}
|
|
@@ -964,7 +964,7 @@ export interface DisassociateUserFromPermissionGroupResponse {
|
|
|
964
964
|
export interface EnableUserRequest {
|
|
965
965
|
/**
|
|
966
966
|
* @public
|
|
967
|
-
* <p>The unique identifier for the user
|
|
967
|
+
* <p>The unique identifier for the user that you want to activate.</p>
|
|
968
968
|
*/
|
|
969
969
|
userId: string | undefined;
|
|
970
970
|
/**
|
|
@@ -979,7 +979,7 @@ export interface EnableUserRequest {
|
|
|
979
979
|
export interface EnableUserResponse {
|
|
980
980
|
/**
|
|
981
981
|
* @public
|
|
982
|
-
* <p>The unique identifier for the
|
|
982
|
+
* <p>The unique identifier for the active user.</p>
|
|
983
983
|
*/
|
|
984
984
|
userId?: string;
|
|
985
985
|
}
|
|
@@ -1611,15 +1611,15 @@ export interface PermissionGroup {
|
|
|
1611
1611
|
lastModifiedTime?: number;
|
|
1612
1612
|
/**
|
|
1613
1613
|
* @public
|
|
1614
|
-
* <p>Indicates the status of the user
|
|
1614
|
+
* <p>Indicates the status of the user within a permission group.</p>
|
|
1615
1615
|
* <ul>
|
|
1616
1616
|
* <li>
|
|
1617
1617
|
* <p>
|
|
1618
|
-
* <code>ADDITION_IN_PROGRESS</code> – The user
|
|
1618
|
+
* <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p>
|
|
1619
1619
|
* </li>
|
|
1620
1620
|
* <li>
|
|
1621
1621
|
* <p>
|
|
1622
|
-
* <code>ADDITION_SUCCESS</code> – The user
|
|
1622
|
+
* <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p>
|
|
1623
1623
|
* </li>
|
|
1624
1624
|
* <li>
|
|
1625
1625
|
* <p>
|
|
@@ -1721,24 +1721,24 @@ export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
|
|
|
1721
1721
|
export interface GetUserResponse {
|
|
1722
1722
|
/**
|
|
1723
1723
|
* @public
|
|
1724
|
-
* <p>The unique identifier for the user
|
|
1724
|
+
* <p>The unique identifier for the user that is retrieved.</p>
|
|
1725
1725
|
*/
|
|
1726
1726
|
userId?: string;
|
|
1727
1727
|
/**
|
|
1728
1728
|
* @public
|
|
1729
|
-
* <p>The current status of the user
|
|
1729
|
+
* <p>The current status of the user. </p>
|
|
1730
1730
|
* <ul>
|
|
1731
1731
|
* <li>
|
|
1732
1732
|
* <p>
|
|
1733
|
-
* <code>CREATING</code> – The
|
|
1733
|
+
* <code>CREATING</code> – The creation is in progress.</p>
|
|
1734
1734
|
* </li>
|
|
1735
1735
|
* <li>
|
|
1736
1736
|
* <p>
|
|
1737
|
-
* <code>ENABLED</code> – The user
|
|
1737
|
+
* <code>ENABLED</code> – The user is created and is currently active.</p>
|
|
1738
1738
|
* </li>
|
|
1739
1739
|
* <li>
|
|
1740
1740
|
* <p>
|
|
1741
|
-
* <code>DISABLED</code> – The user
|
|
1741
|
+
* <code>DISABLED</code> – The user is currently inactive.</p>
|
|
1742
1742
|
* </li>
|
|
1743
1743
|
* </ul>
|
|
1744
1744
|
*/
|
|
@@ -1797,22 +1797,22 @@ export interface GetUserResponse {
|
|
|
1797
1797
|
apiAccessPrincipalArn?: string;
|
|
1798
1798
|
/**
|
|
1799
1799
|
* @public
|
|
1800
|
-
* <p>The timestamp at which the user
|
|
1800
|
+
* <p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
1801
1801
|
*/
|
|
1802
1802
|
createTime?: number;
|
|
1803
1803
|
/**
|
|
1804
1804
|
* @public
|
|
1805
|
-
* <p>Describes the last time the user
|
|
1805
|
+
* <p>Describes the last time the user was activated. The value is determined as epoch time in milliseconds.</p>
|
|
1806
1806
|
*/
|
|
1807
1807
|
lastEnabledTime?: number;
|
|
1808
1808
|
/**
|
|
1809
1809
|
* @public
|
|
1810
|
-
* <p>Describes the last time the user
|
|
1810
|
+
* <p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>
|
|
1811
1811
|
*/
|
|
1812
1812
|
lastDisabledTime?: number;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* @public
|
|
1815
|
-
* <p>Describes the last time the user
|
|
1815
|
+
* <p>Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.</p>
|
|
1816
1816
|
*/
|
|
1817
1817
|
lastModifiedTime?: number;
|
|
1818
1818
|
/**
|
|
@@ -2308,7 +2308,7 @@ export interface ListPermissionGroupsByUserRequest {
|
|
|
2308
2308
|
}
|
|
2309
2309
|
/**
|
|
2310
2310
|
* @public
|
|
2311
|
-
* <p>The structure of a permission group associated with a user
|
|
2311
|
+
* <p>The structure of a permission group associated with a user.</p>
|
|
2312
2312
|
*/
|
|
2313
2313
|
export interface PermissionGroupByUser {
|
|
2314
2314
|
/**
|
|
@@ -2323,15 +2323,15 @@ export interface PermissionGroupByUser {
|
|
|
2323
2323
|
name?: string;
|
|
2324
2324
|
/**
|
|
2325
2325
|
* @public
|
|
2326
|
-
* <p>Indicates the status of the user
|
|
2326
|
+
* <p>Indicates the status of the user within a permission group.</p>
|
|
2327
2327
|
* <ul>
|
|
2328
2328
|
* <li>
|
|
2329
2329
|
* <p>
|
|
2330
|
-
* <code>ADDITION_IN_PROGRESS</code> – The user
|
|
2330
|
+
* <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p>
|
|
2331
2331
|
* </li>
|
|
2332
2332
|
* <li>
|
|
2333
2333
|
* <p>
|
|
2334
|
-
* <code>ADDITION_SUCCESS</code> – The user
|
|
2334
|
+
* <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p>
|
|
2335
2335
|
* </li>
|
|
2336
2336
|
* <li>
|
|
2337
2337
|
* <p>
|
|
@@ -2373,7 +2373,7 @@ export interface ListUsersRequest {
|
|
|
2373
2373
|
}
|
|
2374
2374
|
/**
|
|
2375
2375
|
* @public
|
|
2376
|
-
* <p>The details of the user
|
|
2376
|
+
* <p>The details of the user.</p>
|
|
2377
2377
|
*/
|
|
2378
2378
|
export interface User {
|
|
2379
2379
|
/**
|
|
@@ -2383,19 +2383,19 @@ export interface User {
|
|
|
2383
2383
|
userId?: string;
|
|
2384
2384
|
/**
|
|
2385
2385
|
* @public
|
|
2386
|
-
* <p>The current status of the user
|
|
2386
|
+
* <p>The current status of the user. </p>
|
|
2387
2387
|
* <ul>
|
|
2388
2388
|
* <li>
|
|
2389
2389
|
* <p>
|
|
2390
|
-
* <code>CREATING</code> – The user
|
|
2390
|
+
* <code>CREATING</code> – The user creation is in progress.</p>
|
|
2391
2391
|
* </li>
|
|
2392
2392
|
* <li>
|
|
2393
2393
|
* <p>
|
|
2394
|
-
* <code>ENABLED</code> – The user
|
|
2394
|
+
* <code>ENABLED</code> – The user is created and is currently active.</p>
|
|
2395
2395
|
* </li>
|
|
2396
2396
|
* <li>
|
|
2397
2397
|
* <p>
|
|
2398
|
-
* <code>DISABLED</code> – The user
|
|
2398
|
+
* <code>DISABLED</code> – The user is currently inactive.</p>
|
|
2399
2399
|
* </li>
|
|
2400
2400
|
* </ul>
|
|
2401
2401
|
*/
|
|
@@ -2452,23 +2452,23 @@ export interface User {
|
|
|
2452
2452
|
apiAccessPrincipalArn?: string;
|
|
2453
2453
|
/**
|
|
2454
2454
|
* @public
|
|
2455
|
-
* <p>The timestamp at which the user
|
|
2455
|
+
* <p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>
|
|
2456
2456
|
*/
|
|
2457
2457
|
createTime?: number;
|
|
2458
2458
|
/**
|
|
2459
2459
|
* @public
|
|
2460
|
-
* <p> Describes the last time the user
|
|
2460
|
+
* <p> Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
|
|
2461
2461
|
* </p>
|
|
2462
2462
|
*/
|
|
2463
2463
|
lastEnabledTime?: number;
|
|
2464
2464
|
/**
|
|
2465
2465
|
* @public
|
|
2466
|
-
* <p>Describes the last time the user
|
|
2466
|
+
* <p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>
|
|
2467
2467
|
*/
|
|
2468
2468
|
lastDisabledTime?: number;
|
|
2469
2469
|
/**
|
|
2470
2470
|
* @public
|
|
2471
|
-
* <p>Describes the last time the user
|
|
2471
|
+
* <p>Describes the last time the user was updated. The value is determined as epoch time in milliseconds.
|
|
2472
2472
|
* </p>
|
|
2473
2473
|
*/
|
|
2474
2474
|
lastModifiedTime?: number;
|
|
@@ -2485,7 +2485,7 @@ export interface User {
|
|
|
2485
2485
|
export interface ListUsersResponse {
|
|
2486
2486
|
/**
|
|
2487
2487
|
* @public
|
|
2488
|
-
* <p>A list of all the
|
|
2488
|
+
* <p>A list of all the users.</p>
|
|
2489
2489
|
*/
|
|
2490
2490
|
users?: User[];
|
|
2491
2491
|
/**
|
|
@@ -2516,7 +2516,7 @@ export interface ListUsersByPermissionGroupRequest {
|
|
|
2516
2516
|
}
|
|
2517
2517
|
/**
|
|
2518
2518
|
* @public
|
|
2519
|
-
* <p>The structure of a user
|
|
2519
|
+
* <p>The structure of a user associated with a permission group.</p>
|
|
2520
2520
|
*/
|
|
2521
2521
|
export interface UserByPermissionGroup {
|
|
2522
2522
|
/**
|
|
@@ -2526,19 +2526,19 @@ export interface UserByPermissionGroup {
|
|
|
2526
2526
|
userId?: string;
|
|
2527
2527
|
/**
|
|
2528
2528
|
* @public
|
|
2529
|
-
* <p>The current status of the user
|
|
2529
|
+
* <p>The current status of the user. </p>
|
|
2530
2530
|
* <ul>
|
|
2531
2531
|
* <li>
|
|
2532
2532
|
* <p>
|
|
2533
|
-
* <code>CREATING</code> – The user
|
|
2533
|
+
* <code>CREATING</code> – The user creation is in progress.</p>
|
|
2534
2534
|
* </li>
|
|
2535
2535
|
* <li>
|
|
2536
2536
|
* <p>
|
|
2537
|
-
* <code>ENABLED</code> – The user
|
|
2537
|
+
* <code>ENABLED</code> – The user is created and is currently active.</p>
|
|
2538
2538
|
* </li>
|
|
2539
2539
|
* <li>
|
|
2540
2540
|
* <p>
|
|
2541
|
-
* <code>DISABLED</code> – The user
|
|
2541
|
+
* <code>DISABLED</code> – The user is currently inactive.</p>
|
|
2542
2542
|
* </li>
|
|
2543
2543
|
* </ul>
|
|
2544
2544
|
*/
|
|
@@ -2595,15 +2595,15 @@ export interface UserByPermissionGroup {
|
|
|
2595
2595
|
apiAccessPrincipalArn?: string;
|
|
2596
2596
|
/**
|
|
2597
2597
|
* @public
|
|
2598
|
-
* <p>Indicates the status of the user
|
|
2598
|
+
* <p>Indicates the status of the user within a permission group.</p>
|
|
2599
2599
|
* <ul>
|
|
2600
2600
|
* <li>
|
|
2601
2601
|
* <p>
|
|
2602
|
-
* <code>ADDITION_IN_PROGRESS</code> – The user
|
|
2602
|
+
* <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p>
|
|
2603
2603
|
* </li>
|
|
2604
2604
|
* <li>
|
|
2605
2605
|
* <p>
|
|
2606
|
-
* <code>ADDITION_SUCCESS</code> – The user
|
|
2606
|
+
* <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p>
|
|
2607
2607
|
* </li>
|
|
2608
2608
|
* <li>
|
|
2609
2609
|
* <p>
|
|
@@ -2654,7 +2654,7 @@ export interface ResetUserPasswordResponse {
|
|
|
2654
2654
|
userId?: string;
|
|
2655
2655
|
/**
|
|
2656
2656
|
* @public
|
|
2657
|
-
* <p>A randomly generated temporary password for the requested user
|
|
2657
|
+
* <p>A randomly generated temporary password for the requested user. This password expires in 7 days.</p>
|
|
2658
2658
|
*/
|
|
2659
2659
|
temporaryPassword?: string;
|
|
2660
2660
|
}
|
|
@@ -2902,7 +2902,7 @@ export interface UpdatePermissionGroupResponse {
|
|
|
2902
2902
|
export interface UpdateUserRequest {
|
|
2903
2903
|
/**
|
|
2904
2904
|
* @public
|
|
2905
|
-
* <p>The unique identifier for the user
|
|
2905
|
+
* <p>The unique identifier for the user that you want to update.</p>
|
|
2906
2906
|
*/
|
|
2907
2907
|
userId: string | undefined;
|
|
2908
2908
|
/**
|
|
@@ -2962,7 +2962,7 @@ export interface UpdateUserRequest {
|
|
|
2962
2962
|
export interface UpdateUserResponse {
|
|
2963
2963
|
/**
|
|
2964
2964
|
* @public
|
|
2965
|
-
* <p>The unique identifier of the updated user
|
|
2965
|
+
* <p>The unique identifier of the updated user.</p>
|
|
2966
2966
|
*/
|
|
2967
2967
|
userId?: string;
|
|
2968
2968
|
}
|
|
@@ -2998,6 +2998,14 @@ export declare const PermissionGroupFilterSensitiveLog: (obj: PermissionGroup) =
|
|
|
2998
2998
|
* @internal
|
|
2999
2999
|
*/
|
|
3000
3000
|
export declare const GetPermissionGroupResponseFilterSensitiveLog: (obj: GetPermissionGroupResponse) => any;
|
|
3001
|
+
/**
|
|
3002
|
+
* @internal
|
|
3003
|
+
*/
|
|
3004
|
+
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
3005
|
+
/**
|
|
3006
|
+
* @internal
|
|
3007
|
+
*/
|
|
3008
|
+
export declare const GetProgrammaticAccessCredentialsResponseFilterSensitiveLog: (obj: GetProgrammaticAccessCredentialsResponse) => any;
|
|
3001
3009
|
/**
|
|
3002
3010
|
* @internal
|
|
3003
3011
|
*/
|
|
@@ -198,7 +198,7 @@ export interface CreateUserRequest {
|
|
|
198
198
|
type: UserType | string | undefined;
|
|
199
199
|
firstName?: string;
|
|
200
200
|
lastName?: string;
|
|
201
|
-
|
|
201
|
+
apiAccess?: ApiAccess | string;
|
|
202
202
|
apiAccessPrincipalArn?: string;
|
|
203
203
|
clientToken?: string;
|
|
204
204
|
}
|
|
@@ -633,6 +633,10 @@ export declare const PermissionGroupFilterSensitiveLog: (
|
|
|
633
633
|
export declare const GetPermissionGroupResponseFilterSensitiveLog: (
|
|
634
634
|
obj: GetPermissionGroupResponse
|
|
635
635
|
) => any;
|
|
636
|
+
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
637
|
+
export declare const GetProgrammaticAccessCredentialsResponseFilterSensitiveLog: (
|
|
638
|
+
obj: GetProgrammaticAccessCredentialsResponse
|
|
639
|
+
) => any;
|
|
636
640
|
export declare const GetUserResponseFilterSensitiveLog: (
|
|
637
641
|
obj: GetUserResponse
|
|
638
642
|
) => any;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-finspace-data",
|
|
3
3
|
"description": "AWS SDK for JavaScript Finspace Data Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.419.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|