@aws-sdk/client-finspace-data 3.296.0 → 3.298.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 (107) hide show
  1. package/dist-cjs/commands/AssociateUserToPermissionGroupCommand.js +2 -3
  2. package/dist-cjs/commands/CreateChangesetCommand.js +2 -3
  3. package/dist-cjs/commands/CreateDataViewCommand.js +2 -3
  4. package/dist-cjs/commands/CreateDatasetCommand.js +1 -1
  5. package/dist-cjs/commands/CreatePermissionGroupCommand.js +1 -1
  6. package/dist-cjs/commands/CreateUserCommand.js +1 -1
  7. package/dist-cjs/commands/DeleteDatasetCommand.js +2 -3
  8. package/dist-cjs/commands/DeletePermissionGroupCommand.js +2 -3
  9. package/dist-cjs/commands/DisableUserCommand.js +2 -3
  10. package/dist-cjs/commands/DisassociateUserFromPermissionGroupCommand.js +2 -3
  11. package/dist-cjs/commands/EnableUserCommand.js +2 -3
  12. package/dist-cjs/commands/GetChangesetCommand.js +2 -3
  13. package/dist-cjs/commands/GetDataViewCommand.js +2 -3
  14. package/dist-cjs/commands/GetDatasetCommand.js +2 -3
  15. package/dist-cjs/commands/GetExternalDataViewAccessDetailsCommand.js +1 -1
  16. package/dist-cjs/commands/GetPermissionGroupCommand.js +1 -1
  17. package/dist-cjs/commands/GetProgrammaticAccessCredentialsCommand.js +2 -3
  18. package/dist-cjs/commands/GetUserCommand.js +1 -1
  19. package/dist-cjs/commands/GetWorkingLocationCommand.js +2 -3
  20. package/dist-cjs/commands/ListChangesetsCommand.js +2 -3
  21. package/dist-cjs/commands/ListDataViewsCommand.js +2 -3
  22. package/dist-cjs/commands/ListDatasetsCommand.js +1 -1
  23. package/dist-cjs/commands/ListPermissionGroupsByUserCommand.js +1 -1
  24. package/dist-cjs/commands/ListPermissionGroupsCommand.js +1 -1
  25. package/dist-cjs/commands/ListUsersByPermissionGroupCommand.js +1 -1
  26. package/dist-cjs/commands/ListUsersCommand.js +1 -1
  27. package/dist-cjs/commands/ResetUserPasswordCommand.js +1 -1
  28. package/dist-cjs/commands/UpdateChangesetCommand.js +2 -3
  29. package/dist-cjs/commands/UpdateDatasetCommand.js +2 -3
  30. package/dist-cjs/commands/UpdatePermissionGroupCommand.js +1 -1
  31. package/dist-cjs/commands/UpdateUserCommand.js +1 -1
  32. package/dist-cjs/models/models_0.js +1 -243
  33. package/dist-es/commands/AssociateUserToPermissionGroupCommand.js +2 -3
  34. package/dist-es/commands/CreateChangesetCommand.js +2 -3
  35. package/dist-es/commands/CreateDataViewCommand.js +2 -3
  36. package/dist-es/commands/CreateDatasetCommand.js +2 -2
  37. package/dist-es/commands/CreatePermissionGroupCommand.js +2 -2
  38. package/dist-es/commands/CreateUserCommand.js +2 -2
  39. package/dist-es/commands/DeleteDatasetCommand.js +2 -3
  40. package/dist-es/commands/DeletePermissionGroupCommand.js +2 -3
  41. package/dist-es/commands/DisableUserCommand.js +2 -3
  42. package/dist-es/commands/DisassociateUserFromPermissionGroupCommand.js +2 -3
  43. package/dist-es/commands/EnableUserCommand.js +2 -3
  44. package/dist-es/commands/GetChangesetCommand.js +2 -3
  45. package/dist-es/commands/GetDataViewCommand.js +2 -3
  46. package/dist-es/commands/GetDatasetCommand.js +2 -3
  47. package/dist-es/commands/GetExternalDataViewAccessDetailsCommand.js +2 -2
  48. package/dist-es/commands/GetPermissionGroupCommand.js +2 -2
  49. package/dist-es/commands/GetProgrammaticAccessCredentialsCommand.js +2 -3
  50. package/dist-es/commands/GetUserCommand.js +2 -2
  51. package/dist-es/commands/GetWorkingLocationCommand.js +2 -3
  52. package/dist-es/commands/ListChangesetsCommand.js +2 -3
  53. package/dist-es/commands/ListDataViewsCommand.js +2 -3
  54. package/dist-es/commands/ListDatasetsCommand.js +2 -2
  55. package/dist-es/commands/ListPermissionGroupsByUserCommand.js +2 -2
  56. package/dist-es/commands/ListPermissionGroupsCommand.js +2 -2
  57. package/dist-es/commands/ListUsersByPermissionGroupCommand.js +2 -2
  58. package/dist-es/commands/ListUsersCommand.js +2 -2
  59. package/dist-es/commands/ResetUserPasswordCommand.js +2 -2
  60. package/dist-es/commands/UpdateChangesetCommand.js +2 -3
  61. package/dist-es/commands/UpdateDatasetCommand.js +2 -3
  62. package/dist-es/commands/UpdatePermissionGroupCommand.js +2 -2
  63. package/dist-es/commands/UpdateUserCommand.js +2 -2
  64. package/dist-es/models/models_0.js +0 -180
  65. package/dist-types/FinspaceData.d.ts +32 -0
  66. package/dist-types/FinspaceDataClient.d.ts +24 -4
  67. package/dist-types/commands/AssociateUserToPermissionGroupCommand.d.ts +16 -0
  68. package/dist-types/commands/CreateChangesetCommand.d.ts +16 -0
  69. package/dist-types/commands/CreateDataViewCommand.d.ts +16 -0
  70. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  71. package/dist-types/commands/CreatePermissionGroupCommand.d.ts +16 -0
  72. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  73. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  74. package/dist-types/commands/DeletePermissionGroupCommand.d.ts +16 -0
  75. package/dist-types/commands/DisableUserCommand.d.ts +16 -0
  76. package/dist-types/commands/DisassociateUserFromPermissionGroupCommand.d.ts +16 -0
  77. package/dist-types/commands/EnableUserCommand.d.ts +16 -0
  78. package/dist-types/commands/GetChangesetCommand.d.ts +16 -0
  79. package/dist-types/commands/GetDataViewCommand.d.ts +16 -0
  80. package/dist-types/commands/GetDatasetCommand.d.ts +16 -0
  81. package/dist-types/commands/GetExternalDataViewAccessDetailsCommand.d.ts +16 -0
  82. package/dist-types/commands/GetPermissionGroupCommand.d.ts +16 -0
  83. package/dist-types/commands/GetProgrammaticAccessCredentialsCommand.d.ts +16 -0
  84. package/dist-types/commands/GetUserCommand.d.ts +16 -0
  85. package/dist-types/commands/GetWorkingLocationCommand.d.ts +16 -0
  86. package/dist-types/commands/ListChangesetsCommand.d.ts +16 -0
  87. package/dist-types/commands/ListDataViewsCommand.d.ts +16 -0
  88. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  89. package/dist-types/commands/ListPermissionGroupsByUserCommand.d.ts +16 -0
  90. package/dist-types/commands/ListPermissionGroupsCommand.d.ts +16 -0
  91. package/dist-types/commands/ListUsersByPermissionGroupCommand.d.ts +16 -0
  92. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  93. package/dist-types/commands/ResetUserPasswordCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateChangesetCommand.d.ts +16 -0
  95. package/dist-types/commands/UpdateDatasetCommand.d.ts +16 -0
  96. package/dist-types/commands/UpdatePermissionGroupCommand.d.ts +16 -0
  97. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  98. package/dist-types/models/FinspaceDataServiceException.d.ts +2 -0
  99. package/dist-types/models/models_0.d.ts +224 -260
  100. package/dist-types/pagination/Interfaces.d.ts +3 -0
  101. package/dist-types/pagination/ListChangesetsPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListDataViewsPaginator.d.ts +3 -0
  103. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  104. package/dist-types/pagination/ListPermissionGroupsPaginator.d.ts +3 -0
  105. package/dist-types/pagination/ListUsersPaginator.d.ts +3 -0
  106. package/dist-types/ts3.4/models/models_0.d.ts +0 -174
  107. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { DeletePermissionGroupRequest, DeletePermissionGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeletePermissionGroupCommand}.
8
10
  */
9
11
  export interface DeletePermissionGroupCommandInput extends DeletePermissionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeletePermissionGroupCommand}.
13
17
  */
14
18
  export interface DeletePermissionGroupCommandOutput extends DeletePermissionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a permission group. This action is irreversible.</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 DeletePermissionGroupCommandOutput extends DeletePermissionGrou
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeletePermissionGroupCommandInput - {@link DeletePermissionGroupCommandInput}
34
+ * @returns {@link DeletePermissionGroupCommandOutput}
28
35
  * @see {@link DeletePermissionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DeletePermissionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DeletePermissionGroupCommandOutput extends DeletePermissionGrou
56
63
  export declare class DeletePermissionGroupCommand extends $Command<DeletePermissionGroupCommandInput, DeletePermissionGroupCommandOutput, FinspaceDataClientResolvedConfig> {
57
64
  readonly input: DeletePermissionGroupCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DeletePermissionGroupCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePermissionGroupCommandInput, DeletePermissionGroupCommandOutput>;
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 { DisableUserRequest, DisableUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableUserCommand}.
8
10
  */
9
11
  export interface DisableUserCommandInput extends DisableUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableUserCommand}.
13
17
  */
14
18
  export interface DisableUserCommandOutput extends DisableUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Denies access to the FinSpace web application and API for the specified user.</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 DisableUserCommandOutput extends DisableUserResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisableUserCommandInput - {@link DisableUserCommandInput}
34
+ * @returns {@link DisableUserCommandOutput}
28
35
  * @see {@link DisableUserCommandInput} for command's `input` shape.
29
36
  * @see {@link DisableUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DisableUserCommandOutput extends DisableUserResponse, __Metadat
53
60
  export declare class DisableUserCommand extends $Command<DisableUserCommandInput, DisableUserCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: DisableUserCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DisableUserCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableUserCommandInput, DisableUserCommandOutput>;
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 { DisassociateUserFromPermissionGroupRequest, DisassociateUserFromPermissionGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateUserFromPermissionGroupCommand}.
8
10
  */
9
11
  export interface DisassociateUserFromPermissionGroupCommandInput extends DisassociateUserFromPermissionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateUserFromPermissionGroupCommand}.
13
17
  */
14
18
  export interface DisassociateUserFromPermissionGroupCommandOutput extends DisassociateUserFromPermissionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a user account from a permission group.</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 DisassociateUserFromPermissionGroupCommandOutput extends Disass
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisassociateUserFromPermissionGroupCommandInput - {@link DisassociateUserFromPermissionGroupCommandInput}
34
+ * @returns {@link DisassociateUserFromPermissionGroupCommandOutput}
28
35
  * @see {@link DisassociateUserFromPermissionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DisassociateUserFromPermissionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DisassociateUserFromPermissionGroupCommandOutput extends Disass
53
60
  export declare class DisassociateUserFromPermissionGroupCommand extends $Command<DisassociateUserFromPermissionGroupCommandInput, DisassociateUserFromPermissionGroupCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: DisassociateUserFromPermissionGroupCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DisassociateUserFromPermissionGroupCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateUserFromPermissionGroupCommandInput, DisassociateUserFromPermissionGroupCommandOutput>;
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 { EnableUserRequest, EnableUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableUserCommand}.
8
10
  */
9
11
  export interface EnableUserCommandInput extends EnableUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableUserCommand}.
13
17
  */
14
18
  export interface EnableUserCommandOutput extends EnableUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Allows the specified user to access the FinSpace web application and API.</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 EnableUserCommandOutput extends EnableUserResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param EnableUserCommandInput - {@link EnableUserCommandInput}
34
+ * @returns {@link EnableUserCommandOutput}
28
35
  * @see {@link EnableUserCommandInput} for command's `input` shape.
29
36
  * @see {@link EnableUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -56,11 +63,20 @@ export interface EnableUserCommandOutput extends EnableUserResponse, __MetadataB
56
63
  export declare class EnableUserCommand extends $Command<EnableUserCommandInput, EnableUserCommandOutput, FinspaceDataClientResolvedConfig> {
57
64
  readonly input: EnableUserCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: EnableUserCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableUserCommandInput, EnableUserCommandOutput>;
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 { GetChangesetRequest, GetChangesetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetChangesetCommand}.
8
10
  */
9
11
  export interface GetChangesetCommandInput extends GetChangesetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetChangesetCommand}.
13
17
  */
14
18
  export interface GetChangesetCommandOutput extends GetChangesetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get information about a Changeset.</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 GetChangesetCommandOutput extends GetChangesetResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetChangesetCommandInput - {@link GetChangesetCommandInput}
34
+ * @returns {@link GetChangesetCommandOutput}
28
35
  * @see {@link GetChangesetCommandInput} for command's `input` shape.
29
36
  * @see {@link GetChangesetCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface GetChangesetCommandOutput extends GetChangesetResponse, __Metad
53
60
  export declare class GetChangesetCommand extends $Command<GetChangesetCommandInput, GetChangesetCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: GetChangesetCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: GetChangesetCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChangesetCommandInput, GetChangesetCommandOutput>;
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 { GetDataViewRequest, GetDataViewResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDataViewCommand}.
8
10
  */
9
11
  export interface GetDataViewCommandInput extends GetDataViewRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDataViewCommand}.
13
17
  */
14
18
  export interface GetDataViewCommandOutput extends GetDataViewResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets information about a Dataview.</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 GetDataViewCommandOutput extends GetDataViewResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDataViewCommandInput - {@link GetDataViewCommandInput}
34
+ * @returns {@link GetDataViewCommandOutput}
28
35
  * @see {@link GetDataViewCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDataViewCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetDataViewCommandOutput extends GetDataViewResponse, __Metadat
50
57
  export declare class GetDataViewCommand extends $Command<GetDataViewCommandInput, GetDataViewCommandOutput, FinspaceDataClientResolvedConfig> {
51
58
  readonly input: GetDataViewCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetDataViewCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDataViewCommandInput, GetDataViewCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { GetDatasetRequest, GetDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDatasetCommand}.
8
10
  */
9
11
  export interface GetDatasetCommandInput extends GetDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDatasetCommand}.
13
17
  */
14
18
  export interface GetDatasetCommandOutput extends GetDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about 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 GetDatasetCommandOutput extends GetDatasetResponse, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDatasetCommandInput - {@link GetDatasetCommandInput}
34
+ * @returns {@link GetDatasetCommandOutput}
28
35
  * @see {@link GetDatasetCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDatasetCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface GetDatasetCommandOutput extends GetDatasetResponse, __MetadataB
53
60
  export declare class GetDatasetCommand extends $Command<GetDatasetCommandInput, GetDatasetCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: GetDatasetCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: GetDatasetCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDatasetCommandInput, GetDatasetCommandOutput>;
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 { GetExternalDataViewAccessDetailsRequest, GetExternalDataViewAccessDetailsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetExternalDataViewAccessDetailsCommand}.
8
10
  */
9
11
  export interface GetExternalDataViewAccessDetailsCommandInput extends GetExternalDataViewAccessDetailsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetExternalDataViewAccessDetailsCommand}.
13
17
  */
14
18
  export interface GetExternalDataViewAccessDetailsCommandOutput extends GetExternalDataViewAccessDetailsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p>
18
23
  * <ul>
19
24
  * <li>
@@ -33,6 +38,8 @@ export interface GetExternalDataViewAccessDetailsCommandOutput extends GetExtern
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param GetExternalDataViewAccessDetailsCommandInput - {@link GetExternalDataViewAccessDetailsCommandInput}
42
+ * @returns {@link GetExternalDataViewAccessDetailsCommandOutput}
36
43
  * @see {@link GetExternalDataViewAccessDetailsCommandInput} for command's `input` shape.
37
44
  * @see {@link GetExternalDataViewAccessDetailsCommandOutput} for command's `response` shape.
38
45
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -58,11 +65,20 @@ export interface GetExternalDataViewAccessDetailsCommandOutput extends GetExtern
58
65
  export declare class GetExternalDataViewAccessDetailsCommand extends $Command<GetExternalDataViewAccessDetailsCommandInput, GetExternalDataViewAccessDetailsCommandOutput, FinspaceDataClientResolvedConfig> {
59
66
  readonly input: GetExternalDataViewAccessDetailsCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: GetExternalDataViewAccessDetailsCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExternalDataViewAccessDetailsCommandInput, GetExternalDataViewAccessDetailsCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { GetPermissionGroupRequest, GetPermissionGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPermissionGroupCommand}.
8
10
  */
9
11
  export interface GetPermissionGroupCommandInput extends GetPermissionGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPermissionGroupCommand}.
13
17
  */
14
18
  export interface GetPermissionGroupCommandOutput extends GetPermissionGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the details of a specific permission group.</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 GetPermissionGroupCommandOutput extends GetPermissionGroupRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetPermissionGroupCommandInput - {@link GetPermissionGroupCommandInput}
34
+ * @returns {@link GetPermissionGroupCommandOutput}
28
35
  * @see {@link GetPermissionGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link GetPermissionGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetPermissionGroupCommandOutput extends GetPermissionGroupRespo
50
57
  export declare class GetPermissionGroupCommand extends $Command<GetPermissionGroupCommandInput, GetPermissionGroupCommandOutput, FinspaceDataClientResolvedConfig> {
51
58
  readonly input: GetPermissionGroupCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetPermissionGroupCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPermissionGroupCommandInput, GetPermissionGroupCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { GetProgrammaticAccessCredentialsRequest, GetProgrammaticAccessCredentialsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetProgrammaticAccessCredentialsCommand}.
8
10
  */
9
11
  export interface GetProgrammaticAccessCredentialsCommandInput extends GetProgrammaticAccessCredentialsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetProgrammaticAccessCredentialsCommand}.
13
17
  */
14
18
  export interface GetProgrammaticAccessCredentialsCommandOutput extends GetProgrammaticAccessCredentialsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Request programmatic credentials to use with FinSpace SDK.</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 GetProgrammaticAccessCredentialsCommandOutput extends GetProgra
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetProgrammaticAccessCredentialsCommandInput - {@link GetProgrammaticAccessCredentialsCommandInput}
34
+ * @returns {@link GetProgrammaticAccessCredentialsCommandOutput}
28
35
  * @see {@link GetProgrammaticAccessCredentialsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetProgrammaticAccessCredentialsCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetProgrammaticAccessCredentialsCommandOutput extends GetProgra
47
54
  export declare class GetProgrammaticAccessCredentialsCommand extends $Command<GetProgrammaticAccessCredentialsCommandInput, GetProgrammaticAccessCredentialsCommandOutput, FinspaceDataClientResolvedConfig> {
48
55
  readonly input: GetProgrammaticAccessCredentialsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetProgrammaticAccessCredentialsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetProgrammaticAccessCredentialsCommandInput, GetProgrammaticAccessCredentialsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { GetUserRequest, GetUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetUserCommand}.
8
10
  */
9
11
  export interface GetUserCommandInput extends GetUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetUserCommand}.
13
17
  */
14
18
  export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details for a specific user.</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 GetUserCommandOutput extends GetUserResponse, __MetadataBearer
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetUserCommandInput - {@link GetUserCommandInput}
34
+ * @returns {@link GetUserCommandOutput}
28
35
  * @see {@link GetUserCommandInput} for command's `input` shape.
29
36
  * @see {@link GetUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
50
57
  export declare class GetUserCommand extends $Command<GetUserCommandInput, GetUserCommandOutput, FinspaceDataClientResolvedConfig> {
51
58
  readonly input: GetUserCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetUserCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetUserCommandInput, GetUserCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { GetWorkingLocationRequest, GetWorkingLocationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetWorkingLocationCommand}.
8
10
  */
9
11
  export interface GetWorkingLocationCommandInput extends GetWorkingLocationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetWorkingLocationCommand}.
13
17
  */
14
18
  export interface GetWorkingLocationCommandOutput extends GetWorkingLocationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use
18
23
  * as a scratch space in FinSpace notebook.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetWorkingLocationCommandOutput extends GetWorkingLocationRespo
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetWorkingLocationCommandInput - {@link GetWorkingLocationCommandInput}
35
+ * @returns {@link GetWorkingLocationCommandOutput}
29
36
  * @see {@link GetWorkingLocationCommandInput} for command's `input` shape.
30
37
  * @see {@link GetWorkingLocationCommandOutput} for command's `response` shape.
31
38
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -48,11 +55,20 @@ export interface GetWorkingLocationCommandOutput extends GetWorkingLocationRespo
48
55
  export declare class GetWorkingLocationCommand extends $Command<GetWorkingLocationCommandInput, GetWorkingLocationCommandOutput, FinspaceDataClientResolvedConfig> {
49
56
  readonly input: GetWorkingLocationCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: GetWorkingLocationCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetWorkingLocationCommandInput, GetWorkingLocationCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceDataClient";
5
5
  import { ListChangesetsRequest, ListChangesetsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChangesetsCommand}.
8
10
  */
9
11
  export interface ListChangesetsCommandInput extends ListChangesetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChangesetsCommand}.
13
17
  */
14
18
  export interface ListChangesetsCommandOutput extends ListChangesetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the FinSpace Changesets 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 ListChangesetsCommandOutput extends ListChangesetsResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListChangesetsCommandInput - {@link ListChangesetsCommandInput}
34
+ * @returns {@link ListChangesetsCommandOutput}
28
35
  * @see {@link ListChangesetsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListChangesetsCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceDataClientResolvedConfig | config} for FinspaceDataClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ListChangesetsCommandOutput extends ListChangesetsResponse, __M
53
60
  export declare class ListChangesetsCommand extends $Command<ListChangesetsCommandInput, ListChangesetsCommandOutput, FinspaceDataClientResolvedConfig> {
54
61
  readonly input: ListChangesetsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ListChangesetsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChangesetsCommandInput, ListChangesetsCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }