@aws-sdk/client-finspace-data 3.296.0 → 3.297.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.
Files changed (42) hide show
  1. package/dist-types/FinspaceData.d.ts +32 -0
  2. package/dist-types/FinspaceDataClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateUserToPermissionGroupCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateChangesetCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDataViewCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  7. package/dist-types/commands/CreatePermissionGroupCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  10. package/dist-types/commands/DeletePermissionGroupCommand.d.ts +16 -0
  11. package/dist-types/commands/DisableUserCommand.d.ts +16 -0
  12. package/dist-types/commands/DisassociateUserFromPermissionGroupCommand.d.ts +16 -0
  13. package/dist-types/commands/EnableUserCommand.d.ts +16 -0
  14. package/dist-types/commands/GetChangesetCommand.d.ts +16 -0
  15. package/dist-types/commands/GetDataViewCommand.d.ts +16 -0
  16. package/dist-types/commands/GetDatasetCommand.d.ts +16 -0
  17. package/dist-types/commands/GetExternalDataViewAccessDetailsCommand.d.ts +16 -0
  18. package/dist-types/commands/GetPermissionGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/GetProgrammaticAccessCredentialsCommand.d.ts +16 -0
  20. package/dist-types/commands/GetUserCommand.d.ts +16 -0
  21. package/dist-types/commands/GetWorkingLocationCommand.d.ts +16 -0
  22. package/dist-types/commands/ListChangesetsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListDataViewsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListPermissionGroupsByUserCommand.d.ts +16 -0
  26. package/dist-types/commands/ListPermissionGroupsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListUsersByPermissionGroupCommand.d.ts +16 -0
  28. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  29. package/dist-types/commands/ResetUserPasswordCommand.d.ts +16 -0
  30. package/dist-types/commands/UpdateChangesetCommand.d.ts +16 -0
  31. package/dist-types/commands/UpdateDatasetCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdatePermissionGroupCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  34. package/dist-types/models/FinspaceDataServiceException.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +224 -20
  36. package/dist-types/pagination/Interfaces.d.ts +3 -0
  37. package/dist-types/pagination/ListChangesetsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListDataViewsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListPermissionGroupsPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListUsersPaginator.d.ts +3 -0
  42. package/package.json +3 -3
@@ -32,94 +32,110 @@ import { UpdatePermissionGroupCommandInput, UpdatePermissionGroupCommandOutput }
32
32
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
33
33
  import { FinspaceDataClient } from "./FinspaceDataClient";
34
34
  /**
35
+ * @public
35
36
  * <p> The FinSpace APIs let you take actions inside the FinSpace.</p>
36
37
  */
37
38
  export declare class FinspaceData extends FinspaceDataClient {
38
39
  /**
40
+ * @public
39
41
  * <p>Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.</p>
40
42
  */
41
43
  associateUserToPermissionGroup(args: AssociateUserToPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<AssociateUserToPermissionGroupCommandOutput>;
42
44
  associateUserToPermissionGroup(args: AssociateUserToPermissionGroupCommandInput, cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void): void;
43
45
  associateUserToPermissionGroup(args: AssociateUserToPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateUserToPermissionGroupCommandOutput) => void): void;
44
46
  /**
47
+ * @public
45
48
  * <p>Creates a new Changeset in a FinSpace Dataset.</p>
46
49
  */
47
50
  createChangeset(args: CreateChangesetCommandInput, options?: __HttpHandlerOptions): Promise<CreateChangesetCommandOutput>;
48
51
  createChangeset(args: CreateChangesetCommandInput, cb: (err: any, data?: CreateChangesetCommandOutput) => void): void;
49
52
  createChangeset(args: CreateChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChangesetCommandOutput) => void): void;
50
53
  /**
54
+ * @public
51
55
  * <p>Creates a new FinSpace Dataset.</p>
52
56
  */
53
57
  createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
54
58
  createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
55
59
  createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
56
60
  /**
61
+ * @public
57
62
  * <p>Creates a Dataview for a Dataset.</p>
58
63
  */
59
64
  createDataView(args: CreateDataViewCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataViewCommandOutput>;
60
65
  createDataView(args: CreateDataViewCommandInput, cb: (err: any, data?: CreateDataViewCommandOutput) => void): void;
61
66
  createDataView(args: CreateDataViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataViewCommandOutput) => void): void;
62
67
  /**
68
+ * @public
63
69
  * <p>Creates a group of permissions for various actions that a user can perform in FinSpace.</p>
64
70
  */
65
71
  createPermissionGroup(args: CreatePermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreatePermissionGroupCommandOutput>;
66
72
  createPermissionGroup(args: CreatePermissionGroupCommandInput, cb: (err: any, data?: CreatePermissionGroupCommandOutput) => void): void;
67
73
  createPermissionGroup(args: CreatePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePermissionGroupCommandOutput) => void): void;
68
74
  /**
75
+ * @public
69
76
  * <p>Creates a new user in FinSpace.</p>
70
77
  */
71
78
  createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): Promise<CreateUserCommandOutput>;
72
79
  createUser(args: CreateUserCommandInput, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
73
80
  createUser(args: CreateUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateUserCommandOutput) => void): void;
74
81
  /**
82
+ * @public
75
83
  * <p>Deletes a FinSpace Dataset.</p>
76
84
  */
77
85
  deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
78
86
  deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
79
87
  deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
80
88
  /**
89
+ * @public
81
90
  * <p>Deletes a permission group. This action is irreversible.</p>
82
91
  */
83
92
  deletePermissionGroup(args: DeletePermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeletePermissionGroupCommandOutput>;
84
93
  deletePermissionGroup(args: DeletePermissionGroupCommandInput, cb: (err: any, data?: DeletePermissionGroupCommandOutput) => void): void;
85
94
  deletePermissionGroup(args: DeletePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionGroupCommandOutput) => void): void;
86
95
  /**
96
+ * @public
87
97
  * <p>Denies access to the FinSpace web application and API for the specified user.</p>
88
98
  */
89
99
  disableUser(args: DisableUserCommandInput, options?: __HttpHandlerOptions): Promise<DisableUserCommandOutput>;
90
100
  disableUser(args: DisableUserCommandInput, cb: (err: any, data?: DisableUserCommandOutput) => void): void;
91
101
  disableUser(args: DisableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableUserCommandOutput) => void): void;
92
102
  /**
103
+ * @public
93
104
  * <p>Removes a user account from a permission group.</p>
94
105
  */
95
106
  disassociateUserFromPermissionGroup(args: DisassociateUserFromPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateUserFromPermissionGroupCommandOutput>;
96
107
  disassociateUserFromPermissionGroup(args: DisassociateUserFromPermissionGroupCommandInput, cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void): void;
97
108
  disassociateUserFromPermissionGroup(args: DisassociateUserFromPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateUserFromPermissionGroupCommandOutput) => void): void;
98
109
  /**
110
+ * @public
99
111
  * <p> Allows the specified user to access the FinSpace web application and API.</p>
100
112
  */
101
113
  enableUser(args: EnableUserCommandInput, options?: __HttpHandlerOptions): Promise<EnableUserCommandOutput>;
102
114
  enableUser(args: EnableUserCommandInput, cb: (err: any, data?: EnableUserCommandOutput) => void): void;
103
115
  enableUser(args: EnableUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableUserCommandOutput) => void): void;
104
116
  /**
117
+ * @public
105
118
  * <p>Get information about a Changeset.</p>
106
119
  */
107
120
  getChangeset(args: GetChangesetCommandInput, options?: __HttpHandlerOptions): Promise<GetChangesetCommandOutput>;
108
121
  getChangeset(args: GetChangesetCommandInput, cb: (err: any, data?: GetChangesetCommandOutput) => void): void;
109
122
  getChangeset(args: GetChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChangesetCommandOutput) => void): void;
110
123
  /**
124
+ * @public
111
125
  * <p>Returns information about a Dataset.</p>
112
126
  */
113
127
  getDataset(args: GetDatasetCommandInput, options?: __HttpHandlerOptions): Promise<GetDatasetCommandOutput>;
114
128
  getDataset(args: GetDatasetCommandInput, cb: (err: any, data?: GetDatasetCommandOutput) => void): void;
115
129
  getDataset(args: GetDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDatasetCommandOutput) => void): void;
116
130
  /**
131
+ * @public
117
132
  * <p>Gets information about a Dataview.</p>
118
133
  */
119
134
  getDataView(args: GetDataViewCommandInput, options?: __HttpHandlerOptions): Promise<GetDataViewCommandOutput>;
120
135
  getDataView(args: GetDataViewCommandInput, cb: (err: any, data?: GetDataViewCommandOutput) => void): void;
121
136
  getDataView(args: GetDataViewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataViewCommandOutput) => void): void;
122
137
  /**
138
+ * @public
123
139
  * <p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p>
124
140
  * <ul>
125
141
  * <li>
@@ -134,24 +150,28 @@ export declare class FinspaceData extends FinspaceDataClient {
134
150
  getExternalDataViewAccessDetails(args: GetExternalDataViewAccessDetailsCommandInput, cb: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void): void;
135
151
  getExternalDataViewAccessDetails(args: GetExternalDataViewAccessDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetExternalDataViewAccessDetailsCommandOutput) => void): void;
136
152
  /**
153
+ * @public
137
154
  * <p>Retrieves the details of a specific permission group.</p>
138
155
  */
139
156
  getPermissionGroup(args: GetPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetPermissionGroupCommandOutput>;
140
157
  getPermissionGroup(args: GetPermissionGroupCommandInput, cb: (err: any, data?: GetPermissionGroupCommandOutput) => void): void;
141
158
  getPermissionGroup(args: GetPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionGroupCommandOutput) => void): void;
142
159
  /**
160
+ * @public
143
161
  * <p>Request programmatic credentials to use with FinSpace SDK.</p>
144
162
  */
145
163
  getProgrammaticAccessCredentials(args: GetProgrammaticAccessCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<GetProgrammaticAccessCredentialsCommandOutput>;
146
164
  getProgrammaticAccessCredentials(args: GetProgrammaticAccessCredentialsCommandInput, cb: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void): void;
147
165
  getProgrammaticAccessCredentials(args: GetProgrammaticAccessCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProgrammaticAccessCredentialsCommandOutput) => void): void;
148
166
  /**
167
+ * @public
149
168
  * <p>Retrieves details for a specific user.</p>
150
169
  */
151
170
  getUser(args: GetUserCommandInput, options?: __HttpHandlerOptions): Promise<GetUserCommandOutput>;
152
171
  getUser(args: GetUserCommandInput, cb: (err: any, data?: GetUserCommandOutput) => void): void;
153
172
  getUser(args: GetUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetUserCommandOutput) => void): void;
154
173
  /**
174
+ * @public
155
175
  * <p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use
156
176
  * as a scratch space in FinSpace notebook.</p>
157
177
  */
@@ -159,72 +179,84 @@ export declare class FinspaceData extends FinspaceDataClient {
159
179
  getWorkingLocation(args: GetWorkingLocationCommandInput, cb: (err: any, data?: GetWorkingLocationCommandOutput) => void): void;
160
180
  getWorkingLocation(args: GetWorkingLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWorkingLocationCommandOutput) => void): void;
161
181
  /**
182
+ * @public
162
183
  * <p>Lists the FinSpace Changesets for a Dataset.</p>
163
184
  */
164
185
  listChangesets(args: ListChangesetsCommandInput, options?: __HttpHandlerOptions): Promise<ListChangesetsCommandOutput>;
165
186
  listChangesets(args: ListChangesetsCommandInput, cb: (err: any, data?: ListChangesetsCommandOutput) => void): void;
166
187
  listChangesets(args: ListChangesetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangesetsCommandOutput) => void): void;
167
188
  /**
189
+ * @public
168
190
  * <p>Lists all of the active Datasets that a user has access to.</p>
169
191
  */
170
192
  listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
171
193
  listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
172
194
  listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
173
195
  /**
196
+ * @public
174
197
  * <p>Lists all available Dataviews for a Dataset.</p>
175
198
  */
176
199
  listDataViews(args: ListDataViewsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataViewsCommandOutput>;
177
200
  listDataViews(args: ListDataViewsCommandInput, cb: (err: any, data?: ListDataViewsCommandOutput) => void): void;
178
201
  listDataViews(args: ListDataViewsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataViewsCommandOutput) => void): void;
179
202
  /**
203
+ * @public
180
204
  * <p>Lists all available permission groups in FinSpace.</p>
181
205
  */
182
206
  listPermissionGroups(args: ListPermissionGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionGroupsCommandOutput>;
183
207
  listPermissionGroups(args: ListPermissionGroupsCommandInput, cb: (err: any, data?: ListPermissionGroupsCommandOutput) => void): void;
184
208
  listPermissionGroups(args: ListPermissionGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionGroupsCommandOutput) => void): void;
185
209
  /**
210
+ * @public
186
211
  * <p>Lists all the permission groups that are associated with a specific user account.</p>
187
212
  */
188
213
  listPermissionGroupsByUser(args: ListPermissionGroupsByUserCommandInput, options?: __HttpHandlerOptions): Promise<ListPermissionGroupsByUserCommandOutput>;
189
214
  listPermissionGroupsByUser(args: ListPermissionGroupsByUserCommandInput, cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void): void;
190
215
  listPermissionGroupsByUser(args: ListPermissionGroupsByUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPermissionGroupsByUserCommandOutput) => void): void;
191
216
  /**
217
+ * @public
192
218
  * <p>Lists all available user accounts in FinSpace.</p>
193
219
  */
194
220
  listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
195
221
  listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
196
222
  listUsers(args: ListUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
197
223
  /**
224
+ * @public
198
225
  * <p>Lists details of all the users in a specific permission group.</p>
199
226
  */
200
227
  listUsersByPermissionGroup(args: ListUsersByPermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersByPermissionGroupCommandOutput>;
201
228
  listUsersByPermissionGroup(args: ListUsersByPermissionGroupCommandInput, cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void): void;
202
229
  listUsersByPermissionGroup(args: ListUsersByPermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListUsersByPermissionGroupCommandOutput) => void): void;
203
230
  /**
231
+ * @public
204
232
  * <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>
205
233
  */
206
234
  resetUserPassword(args: ResetUserPasswordCommandInput, options?: __HttpHandlerOptions): Promise<ResetUserPasswordCommandOutput>;
207
235
  resetUserPassword(args: ResetUserPasswordCommandInput, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void): void;
208
236
  resetUserPassword(args: ResetUserPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetUserPasswordCommandOutput) => void): void;
209
237
  /**
238
+ * @public
210
239
  * <p>Updates a FinSpace Changeset.</p>
211
240
  */
212
241
  updateChangeset(args: UpdateChangesetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChangesetCommandOutput>;
213
242
  updateChangeset(args: UpdateChangesetCommandInput, cb: (err: any, data?: UpdateChangesetCommandOutput) => void): void;
214
243
  updateChangeset(args: UpdateChangesetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChangesetCommandOutput) => void): void;
215
244
  /**
245
+ * @public
216
246
  * <p>Updates a FinSpace Dataset.</p>
217
247
  */
218
248
  updateDataset(args: UpdateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatasetCommandOutput>;
219
249
  updateDataset(args: UpdateDatasetCommandInput, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void;
220
250
  updateDataset(args: UpdateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetCommandOutput) => void): void;
221
251
  /**
252
+ * @public
222
253
  * <p>Modifies the details of a permission group. You cannot modify a <code>permissionGroupID</code>.</p>
223
254
  */
224
255
  updatePermissionGroup(args: UpdatePermissionGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePermissionGroupCommandOutput>;
225
256
  updatePermissionGroup(args: UpdatePermissionGroupCommandInput, cb: (err: any, data?: UpdatePermissionGroupCommandOutput) => void): void;
226
257
  updatePermissionGroup(args: UpdatePermissionGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePermissionGroupCommandOutput) => void): void;
227
258
  /**
259
+ * @public
228
260
  * <p>Modifies the details of the specified user account. You cannot update the <code>userId</code> for a user.</p>
229
261
  */
230
262
  updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): Promise<UpdateUserCommandOutput>;
@@ -39,15 +39,24 @@ import { UpdateDatasetCommandInput, UpdateDatasetCommandOutput } from "./command
39
39
  import { UpdatePermissionGroupCommandInput, UpdatePermissionGroupCommandOutput } from "./commands/UpdatePermissionGroupCommand";
40
40
  import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand";
41
41
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
42
+ /**
43
+ * @public
44
+ */
42
45
  export type ServiceInputTypes = AssociateUserToPermissionGroupCommandInput | CreateChangesetCommandInput | CreateDataViewCommandInput | CreateDatasetCommandInput | CreatePermissionGroupCommandInput | CreateUserCommandInput | DeleteDatasetCommandInput | DeletePermissionGroupCommandInput | DisableUserCommandInput | DisassociateUserFromPermissionGroupCommandInput | EnableUserCommandInput | GetChangesetCommandInput | GetDataViewCommandInput | GetDatasetCommandInput | GetExternalDataViewAccessDetailsCommandInput | GetPermissionGroupCommandInput | GetProgrammaticAccessCredentialsCommandInput | GetUserCommandInput | GetWorkingLocationCommandInput | ListChangesetsCommandInput | ListDataViewsCommandInput | ListDatasetsCommandInput | ListPermissionGroupsByUserCommandInput | ListPermissionGroupsCommandInput | ListUsersByPermissionGroupCommandInput | ListUsersCommandInput | ResetUserPasswordCommandInput | UpdateChangesetCommandInput | UpdateDatasetCommandInput | UpdatePermissionGroupCommandInput | UpdateUserCommandInput;
46
+ /**
47
+ * @public
48
+ */
43
49
  export type ServiceOutputTypes = AssociateUserToPermissionGroupCommandOutput | CreateChangesetCommandOutput | CreateDataViewCommandOutput | CreateDatasetCommandOutput | CreatePermissionGroupCommandOutput | CreateUserCommandOutput | DeleteDatasetCommandOutput | DeletePermissionGroupCommandOutput | DisableUserCommandOutput | DisassociateUserFromPermissionGroupCommandOutput | EnableUserCommandOutput | GetChangesetCommandOutput | GetDataViewCommandOutput | GetDatasetCommandOutput | GetExternalDataViewAccessDetailsCommandOutput | GetPermissionGroupCommandOutput | GetProgrammaticAccessCredentialsCommandOutput | GetUserCommandOutput | GetWorkingLocationCommandOutput | ListChangesetsCommandOutput | ListDataViewsCommandOutput | ListDatasetsCommandOutput | ListPermissionGroupsByUserCommandOutput | ListPermissionGroupsCommandOutput | ListUsersByPermissionGroupCommandOutput | ListUsersCommandOutput | ResetUserPasswordCommandOutput | UpdateChangesetCommandOutput | UpdateDatasetCommandOutput | UpdatePermissionGroupCommandOutput | UpdateUserCommandOutput;
50
+ /**
51
+ * @public
52
+ */
44
53
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
45
54
  /**
46
55
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
47
56
  */
48
57
  requestHandler?: __HttpHandler;
49
58
  /**
50
- * A constructor for a class implementing the {@link __Checksum} interface
59
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
51
60
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
52
61
  * @internal
53
62
  */
@@ -137,23 +146,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
137
146
  */
138
147
  logger?: __Logger;
139
148
  /**
140
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
149
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
150
  */
142
151
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
143
152
  }
153
+ /**
154
+ * @public
155
+ */
144
156
  type FinspaceDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
145
157
  /**
146
- * The configuration interface of FinspaceDataClient class constructor that set the region, credentials and other options.
158
+ * @public
159
+ *
160
+ * The configuration interface of FinspaceDataClient class constructor that set the region, credentials and other options.
147
161
  */
148
162
  export interface FinspaceDataClientConfig extends FinspaceDataClientConfigType {
149
163
  }
164
+ /**
165
+ * @public
166
+ */
150
167
  type FinspaceDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
151
168
  /**
152
- * The resolved configuration interface of FinspaceDataClient class. This is resolved and normalized from the {@link FinspaceDataClientConfig | constructor configuration interface}.
169
+ * @public
170
+ *
171
+ * The resolved configuration interface of FinspaceDataClient class. This is resolved and normalized from the {@link FinspaceDataClientConfig | constructor configuration interface}.
153
172
  */
154
173
  export interface FinspaceDataClientResolvedConfig extends FinspaceDataClientResolvedConfigType {
155
174
  }
156
175
  /**
176
+ * @public
157
177
  * <p> The FinSpace APIs let you take actions inside the FinSpace.</p>
158
178
  */
159
179
  export declare class FinspaceDataClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, FinspaceDataClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { AssociateUserToPermissionGroupRequest, AssociateUserToPermissionGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateUserToPermissionGroupCommand}.
8
10
  */
9
11
  export interface AssociateUserToPermissionGroupCommandInput extends AssociateUserToPermissionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateUserToPermissionGroupCommand}.
13
17
  */
14
18
  export interface AssociateUserToPermissionGroupCommandOutput extends AssociateUserToPermissionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface AssociateUserToPermissionGroupCommandOutput extends AssociateUs
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param AssociateUserToPermissionGroupCommandInput - {@link AssociateUserToPermissionGroupCommandInput}
34
+ * @returns {@link AssociateUserToPermissionGroupCommandOutput}
28
35
  * @see {@link AssociateUserToPermissionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link AssociateUserToPermissionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface AssociateUserToPermissionGroupCommandOutput extends AssociateUs
53
60
  export declare class AssociateUserToPermissionGroupCommand extends $Command<AssociateUserToPermissionGroupCommandInput, AssociateUserToPermissionGroupCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: AssociateUserToPermissionGroupCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: AssociateUserToPermissionGroupCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateUserToPermissionGroupCommandInput, AssociateUserToPermissionGroupCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { CreateChangesetRequest, CreateChangesetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChangesetCommand}.
8
10
  */
9
11
  export interface CreateChangesetCommandInput extends CreateChangesetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChangesetCommand}.
13
17
  */
14
18
  export interface CreateChangesetCommandOutput extends CreateChangesetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Changeset in a FinSpace Dataset.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateChangesetCommandOutput extends CreateChangesetResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateChangesetCommandInput - {@link CreateChangesetCommandInput}
34
+ * @returns {@link CreateChangesetCommandOutput}
28
35
  * @see {@link CreateChangesetCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateChangesetCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateChangesetCommandOutput extends CreateChangesetResponse, _
56
63
  export declare class CreateChangesetCommand extends $Command<CreateChangesetCommandInput, CreateChangesetCommandOutput, FinspaceDataClientResolvedConfig> {
57
64
  readonly input: CreateChangesetCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateChangesetCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChangesetCommandInput, CreateChangesetCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { CreateDataViewRequest, CreateDataViewResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataViewCommand}.
8
10
  */
9
11
  export interface CreateDataViewCommandInput extends CreateDataViewRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataViewCommand}.
13
17
  */
14
18
  export interface CreateDataViewCommandOutput extends CreateDataViewResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a Dataview for a Dataset.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateDataViewCommandOutput extends CreateDataViewResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateDataViewCommandInput - {@link CreateDataViewCommandInput}
34
+ * @returns {@link CreateDataViewCommandOutput}
28
35
  * @see {@link CreateDataViewCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateDataViewCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateDataViewCommandOutput extends CreateDataViewResponse, __M
53
60
  export declare class CreateDataViewCommand extends $Command<CreateDataViewCommandInput, CreateDataViewCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: CreateDataViewCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateDataViewCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataViewCommandInput, CreateDataViewCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { CreateDatasetRequest, CreateDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDatasetCommand}.
8
10
  */
9
11
  export interface CreateDatasetCommandInput extends CreateDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDatasetCommand}.
13
17
  */
14
18
  export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new FinSpace Dataset.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
34
+ * @returns {@link CreateDatasetCommandOutput}
28
35
  * @see {@link CreateDatasetCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
56
63
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, FinspaceDataClientResolvedConfig> {
57
64
  readonly input: CreateDatasetCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateDatasetCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetCommandInput, CreateDatasetCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { CreatePermissionGroupRequest, CreatePermissionGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreatePermissionGroupCommand}.
8
10
  */
9
11
  export interface CreatePermissionGroupCommandInput extends CreatePermissionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreatePermissionGroupCommand}.
13
17
  */
14
18
  export interface CreatePermissionGroupCommandOutput extends CreatePermissionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a group of permissions for various actions that a user can perform in FinSpace.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreatePermissionGroupCommandOutput extends CreatePermissionGrou
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreatePermissionGroupCommandInput - {@link CreatePermissionGroupCommandInput}
34
+ * @returns {@link CreatePermissionGroupCommandOutput}
28
35
  * @see {@link CreatePermissionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link CreatePermissionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreatePermissionGroupCommandOutput extends CreatePermissionGrou
53
60
  export declare class CreatePermissionGroupCommand extends $Command<CreatePermissionGroupCommandInput, CreatePermissionGroupCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: CreatePermissionGroupCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreatePermissionGroupCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePermissionGroupCommandInput, CreatePermissionGroupCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { CreateUserRequest, CreateUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateUserCommand}.
8
10
  */
9
11
  export interface CreateUserCommandInput extends CreateUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateUserCommand}.
13
17
  */
14
18
  export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new user in FinSpace.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateUserCommandInput - {@link CreateUserCommandInput}
34
+ * @returns {@link CreateUserCommandOutput}
28
35
  * @see {@link CreateUserCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
53
60
  export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: CreateUserCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CreateUserCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateUserCommandInput, CreateUserCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { DeleteDatasetRequest, DeleteDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatasetCommand}.
8
10
  */
9
11
  export interface DeleteDatasetCommandInput extends DeleteDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatasetCommand}.
13
17
  */
14
18
  export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a FinSpace Dataset.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
34
+ * @returns {@link DeleteDatasetCommandOutput}
28
35
  * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
56
63
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, FinspaceDataClientResolvedConfig> {
57
64
  readonly input: DeleteDatasetCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DeleteDatasetCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetCommandInput, DeleteDatasetCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }