@aws-sdk/client-finspace 3.345.0 → 3.347.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 (158) hide show
  1. package/README.md +208 -0
  2. package/dist-cjs/Finspace.js +52 -0
  3. package/dist-cjs/commands/CreateKxChangesetCommand.js +46 -0
  4. package/dist-cjs/commands/CreateKxClusterCommand.js +46 -0
  5. package/dist-cjs/commands/CreateKxDatabaseCommand.js +46 -0
  6. package/dist-cjs/commands/CreateKxEnvironmentCommand.js +46 -0
  7. package/dist-cjs/commands/CreateKxUserCommand.js +46 -0
  8. package/dist-cjs/commands/DeleteKxClusterCommand.js +46 -0
  9. package/dist-cjs/commands/DeleteKxDatabaseCommand.js +46 -0
  10. package/dist-cjs/commands/DeleteKxEnvironmentCommand.js +46 -0
  11. package/dist-cjs/commands/DeleteKxUserCommand.js +46 -0
  12. package/dist-cjs/commands/GetKxChangesetCommand.js +46 -0
  13. package/dist-cjs/commands/GetKxClusterCommand.js +46 -0
  14. package/dist-cjs/commands/GetKxConnectionStringCommand.js +47 -0
  15. package/dist-cjs/commands/GetKxDatabaseCommand.js +46 -0
  16. package/dist-cjs/commands/GetKxEnvironmentCommand.js +46 -0
  17. package/dist-cjs/commands/GetKxUserCommand.js +46 -0
  18. package/dist-cjs/commands/ListKxChangesetsCommand.js +46 -0
  19. package/dist-cjs/commands/ListKxClusterNodesCommand.js +46 -0
  20. package/dist-cjs/commands/ListKxClustersCommand.js +46 -0
  21. package/dist-cjs/commands/ListKxDatabasesCommand.js +46 -0
  22. package/dist-cjs/commands/ListKxEnvironmentsCommand.js +46 -0
  23. package/dist-cjs/commands/ListKxUsersCommand.js +46 -0
  24. package/dist-cjs/commands/UpdateKxClusterDatabasesCommand.js +46 -0
  25. package/dist-cjs/commands/UpdateKxDatabaseCommand.js +46 -0
  26. package/dist-cjs/commands/UpdateKxEnvironmentCommand.js +46 -0
  27. package/dist-cjs/commands/UpdateKxEnvironmentNetworkCommand.js +46 -0
  28. package/dist-cjs/commands/UpdateKxUserCommand.js +46 -0
  29. package/dist-cjs/commands/index.js +26 -0
  30. package/dist-cjs/endpoint/ruleset.js +3 -3
  31. package/dist-cjs/index.js +1 -0
  32. package/dist-cjs/models/models_0.js +98 -1
  33. package/dist-cjs/pagination/Interfaces.js +2 -0
  34. package/dist-cjs/pagination/ListKxChangesetsPaginator.js +29 -0
  35. package/dist-cjs/pagination/ListKxClusterNodesPaginator.js +29 -0
  36. package/dist-cjs/pagination/ListKxDatabasesPaginator.js +29 -0
  37. package/dist-cjs/pagination/ListKxEnvironmentsPaginator.js +29 -0
  38. package/dist-cjs/pagination/index.js +8 -0
  39. package/dist-cjs/protocols/Aws_restJson1.js +2270 -125
  40. package/dist-es/Finspace.js +52 -0
  41. package/dist-es/commands/CreateKxChangesetCommand.js +42 -0
  42. package/dist-es/commands/CreateKxClusterCommand.js +42 -0
  43. package/dist-es/commands/CreateKxDatabaseCommand.js +42 -0
  44. package/dist-es/commands/CreateKxEnvironmentCommand.js +42 -0
  45. package/dist-es/commands/CreateKxUserCommand.js +42 -0
  46. package/dist-es/commands/DeleteKxClusterCommand.js +42 -0
  47. package/dist-es/commands/DeleteKxDatabaseCommand.js +42 -0
  48. package/dist-es/commands/DeleteKxEnvironmentCommand.js +42 -0
  49. package/dist-es/commands/DeleteKxUserCommand.js +42 -0
  50. package/dist-es/commands/GetKxChangesetCommand.js +42 -0
  51. package/dist-es/commands/GetKxClusterCommand.js +42 -0
  52. package/dist-es/commands/GetKxConnectionStringCommand.js +43 -0
  53. package/dist-es/commands/GetKxDatabaseCommand.js +42 -0
  54. package/dist-es/commands/GetKxEnvironmentCommand.js +42 -0
  55. package/dist-es/commands/GetKxUserCommand.js +42 -0
  56. package/dist-es/commands/ListKxChangesetsCommand.js +42 -0
  57. package/dist-es/commands/ListKxClusterNodesCommand.js +42 -0
  58. package/dist-es/commands/ListKxClustersCommand.js +42 -0
  59. package/dist-es/commands/ListKxDatabasesCommand.js +42 -0
  60. package/dist-es/commands/ListKxEnvironmentsCommand.js +42 -0
  61. package/dist-es/commands/ListKxUsersCommand.js +42 -0
  62. package/dist-es/commands/UpdateKxClusterDatabasesCommand.js +42 -0
  63. package/dist-es/commands/UpdateKxDatabaseCommand.js +42 -0
  64. package/dist-es/commands/UpdateKxEnvironmentCommand.js +42 -0
  65. package/dist-es/commands/UpdateKxEnvironmentNetworkCommand.js +42 -0
  66. package/dist-es/commands/UpdateKxUserCommand.js +42 -0
  67. package/dist-es/commands/index.js +26 -0
  68. package/dist-es/endpoint/ruleset.js +3 -3
  69. package/dist-es/index.js +1 -0
  70. package/dist-es/models/models_0.js +94 -0
  71. package/dist-es/pagination/Interfaces.js +1 -0
  72. package/dist-es/pagination/ListKxChangesetsPaginator.js +25 -0
  73. package/dist-es/pagination/ListKxClusterNodesPaginator.js +25 -0
  74. package/dist-es/pagination/ListKxDatabasesPaginator.js +25 -0
  75. package/dist-es/pagination/ListKxEnvironmentsPaginator.js +25 -0
  76. package/dist-es/pagination/index.js +5 -0
  77. package/dist-es/protocols/Aws_restJson1.js +2192 -100
  78. package/dist-types/Finspace.d.ts +182 -0
  79. package/dist-types/FinspaceClient.d.ts +28 -2
  80. package/dist-types/commands/CreateEnvironmentCommand.d.ts +1 -1
  81. package/dist-types/commands/CreateKxChangesetCommand.d.ts +122 -0
  82. package/dist-types/commands/CreateKxClusterCommand.d.ts +233 -0
  83. package/dist-types/commands/CreateKxDatabaseCommand.d.ts +109 -0
  84. package/dist-types/commands/CreateKxEnvironmentCommand.d.ts +108 -0
  85. package/dist-types/commands/CreateKxUserCommand.d.ts +107 -0
  86. package/dist-types/commands/DeleteKxClusterCommand.d.ts +95 -0
  87. package/dist-types/commands/DeleteKxDatabaseCommand.d.ts +92 -0
  88. package/dist-types/commands/DeleteKxEnvironmentCommand.d.ts +87 -0
  89. package/dist-types/commands/DeleteKxUserCommand.d.ts +88 -0
  90. package/dist-types/commands/GetEnvironmentCommand.d.ts +2 -2
  91. package/dist-types/commands/GetKxChangesetCommand.d.ts +108 -0
  92. package/dist-types/commands/GetKxClusterCommand.d.ts +164 -0
  93. package/dist-types/commands/GetKxConnectionStringCommand.d.ts +91 -0
  94. package/dist-types/commands/GetKxDatabaseCommand.d.ts +99 -0
  95. package/dist-types/commands/GetKxEnvironmentCommand.d.ts +112 -0
  96. package/dist-types/commands/GetKxUserCommand.d.ts +93 -0
  97. package/dist-types/commands/ListEnvironmentsCommand.d.ts +2 -2
  98. package/dist-types/commands/ListKxChangesetsCommand.d.ts +101 -0
  99. package/dist-types/commands/ListKxClusterNodesCommand.d.ts +102 -0
  100. package/dist-types/commands/ListKxClustersCommand.d.ts +114 -0
  101. package/dist-types/commands/ListKxDatabasesCommand.d.ts +98 -0
  102. package/dist-types/commands/ListKxEnvironmentsCommand.d.ts +112 -0
  103. package/dist-types/commands/ListKxUsersCommand.d.ts +100 -0
  104. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +3 -3
  105. package/dist-types/commands/UpdateKxClusterDatabasesCommand.d.ts +107 -0
  106. package/dist-types/commands/UpdateKxDatabaseCommand.d.ts +98 -0
  107. package/dist-types/commands/UpdateKxEnvironmentCommand.d.ts +120 -0
  108. package/dist-types/commands/UpdateKxEnvironmentNetworkCommand.d.ts +129 -0
  109. package/dist-types/commands/UpdateKxUserCommand.d.ts +101 -0
  110. package/dist-types/commands/index.d.ts +26 -0
  111. package/dist-types/index.d.ts +1 -0
  112. package/dist-types/models/models_0.d.ts +2390 -105
  113. package/dist-types/pagination/Interfaces.d.ts +8 -0
  114. package/dist-types/pagination/ListKxChangesetsPaginator.d.ts +7 -0
  115. package/dist-types/pagination/ListKxClusterNodesPaginator.d.ts +7 -0
  116. package/dist-types/pagination/ListKxDatabasesPaginator.d.ts +7 -0
  117. package/dist-types/pagination/ListKxEnvironmentsPaginator.d.ts +7 -0
  118. package/dist-types/pagination/index.d.ts +5 -0
  119. package/dist-types/protocols/Aws_restJson1.d.ts +234 -0
  120. package/dist-types/ts3.4/Finspace.d.ts +442 -0
  121. package/dist-types/ts3.4/FinspaceClient.d.ts +158 -2
  122. package/dist-types/ts3.4/commands/CreateKxChangesetCommand.d.ts +39 -0
  123. package/dist-types/ts3.4/commands/CreateKxClusterCommand.d.ts +38 -0
  124. package/dist-types/ts3.4/commands/CreateKxDatabaseCommand.d.ts +38 -0
  125. package/dist-types/ts3.4/commands/CreateKxEnvironmentCommand.d.ts +39 -0
  126. package/dist-types/ts3.4/commands/CreateKxUserCommand.d.ts +35 -0
  127. package/dist-types/ts3.4/commands/DeleteKxClusterCommand.d.ts +38 -0
  128. package/dist-types/ts3.4/commands/DeleteKxDatabaseCommand.d.ts +38 -0
  129. package/dist-types/ts3.4/commands/DeleteKxEnvironmentCommand.d.ts +39 -0
  130. package/dist-types/ts3.4/commands/DeleteKxUserCommand.d.ts +35 -0
  131. package/dist-types/ts3.4/commands/GetKxChangesetCommand.d.ts +38 -0
  132. package/dist-types/ts3.4/commands/GetKxClusterCommand.d.ts +35 -0
  133. package/dist-types/ts3.4/commands/GetKxConnectionStringCommand.d.ts +42 -0
  134. package/dist-types/ts3.4/commands/GetKxDatabaseCommand.d.ts +38 -0
  135. package/dist-types/ts3.4/commands/GetKxEnvironmentCommand.d.ts +38 -0
  136. package/dist-types/ts3.4/commands/GetKxUserCommand.d.ts +35 -0
  137. package/dist-types/ts3.4/commands/ListKxChangesetsCommand.d.ts +38 -0
  138. package/dist-types/ts3.4/commands/ListKxClusterNodesCommand.d.ts +39 -0
  139. package/dist-types/ts3.4/commands/ListKxClustersCommand.d.ts +38 -0
  140. package/dist-types/ts3.4/commands/ListKxDatabasesCommand.d.ts +38 -0
  141. package/dist-types/ts3.4/commands/ListKxEnvironmentsCommand.d.ts +39 -0
  142. package/dist-types/ts3.4/commands/ListKxUsersCommand.d.ts +35 -0
  143. package/dist-types/ts3.4/commands/UpdateKxClusterDatabasesCommand.d.ts +42 -0
  144. package/dist-types/ts3.4/commands/UpdateKxDatabaseCommand.d.ts +38 -0
  145. package/dist-types/ts3.4/commands/UpdateKxEnvironmentCommand.d.ts +39 -0
  146. package/dist-types/ts3.4/commands/UpdateKxEnvironmentNetworkCommand.d.ts +42 -0
  147. package/dist-types/ts3.4/commands/UpdateKxUserCommand.d.ts +35 -0
  148. package/dist-types/ts3.4/commands/index.d.ts +26 -0
  149. package/dist-types/ts3.4/index.d.ts +1 -0
  150. package/dist-types/ts3.4/models/models_0.d.ts +575 -3
  151. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  152. package/dist-types/ts3.4/pagination/ListKxChangesetsPaginator.d.ts +11 -0
  153. package/dist-types/ts3.4/pagination/ListKxClusterNodesPaginator.d.ts +11 -0
  154. package/dist-types/ts3.4/pagination/ListKxDatabasesPaginator.d.ts +11 -0
  155. package/dist-types/ts3.4/pagination/ListKxEnvironmentsPaginator.d.ts +11 -0
  156. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  157. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +312 -0
  158. package/package.json +31 -29
@@ -0,0 +1,88 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
+ import { DeleteKxUserRequest, DeleteKxUserResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteKxUserCommand}.
14
+ */
15
+ export interface DeleteKxUserCommandInput extends DeleteKxUserRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteKxUserCommand}.
21
+ */
22
+ export interface DeleteKxUserCommandOutput extends DeleteKxUserResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes a user in the specified kdb environment.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { FinspaceClient, DeleteKxUserCommand } from "@aws-sdk/client-finspace"; // ES Modules import
31
+ * // const { FinspaceClient, DeleteKxUserCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
32
+ * const client = new FinspaceClient(config);
33
+ * const input = { // DeleteKxUserRequest
34
+ * userName: "STRING_VALUE", // required
35
+ * environmentId: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new DeleteKxUserCommand(input);
38
+ * const response = await client.send(command);
39
+ * // {};
40
+ *
41
+ * ```
42
+ *
43
+ * @param DeleteKxUserCommandInput - {@link DeleteKxUserCommandInput}
44
+ * @returns {@link DeleteKxUserCommandOutput}
45
+ * @see {@link DeleteKxUserCommandInput} for command's `input` shape.
46
+ * @see {@link DeleteKxUserCommandOutput} for command's `response` shape.
47
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
48
+ *
49
+ * @throws {@link AccessDeniedException} (client fault)
50
+ * <p>You do not have sufficient access to perform this action.</p>
51
+ *
52
+ * @throws {@link InternalServerException} (server fault)
53
+ * <p>The request processing has failed because of an unknown error, exception or
54
+ * failure.</p>
55
+ *
56
+ * @throws {@link ResourceNotFoundException} (client fault)
57
+ * <p>One or more resources can't be found.</p>
58
+ *
59
+ * @throws {@link ThrottlingException} (client fault)
60
+ * <p>The request was denied due to request throttling.</p>
61
+ *
62
+ * @throws {@link ValidationException} (client fault)
63
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
64
+ *
65
+ * @throws {@link FinspaceServiceException}
66
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
67
+ *
68
+ */
69
+ export declare class DeleteKxUserCommand extends $Command<DeleteKxUserCommandInput, DeleteKxUserCommandOutput, FinspaceClientResolvedConfig> {
70
+ readonly input: DeleteKxUserCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: DeleteKxUserCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteKxUserCommandInput, DeleteKxUserCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -40,14 +40,14 @@ export interface GetEnvironmentCommandOutput extends GetEnvironmentResponse, __M
40
40
  * // name: "STRING_VALUE",
41
41
  * // environmentId: "STRING_VALUE",
42
42
  * // awsAccountId: "STRING_VALUE",
43
- * // status: "STRING_VALUE",
43
+ * // status: "CREATE_REQUESTED" || "CREATING" || "CREATED" || "DELETE_REQUESTED" || "DELETING" || "DELETED" || "FAILED_CREATION" || "RETRY_DELETION" || "FAILED_DELETION" || "UPDATE_NETWORK_REQUESTED" || "UPDATING_NETWORK" || "FAILED_UPDATING_NETWORK" || "SUSPENDED",
44
44
  * // environmentUrl: "STRING_VALUE",
45
45
  * // description: "STRING_VALUE",
46
46
  * // environmentArn: "STRING_VALUE",
47
47
  * // sageMakerStudioDomainUrl: "STRING_VALUE",
48
48
  * // kmsKeyId: "STRING_VALUE",
49
49
  * // dedicatedServiceAccountId: "STRING_VALUE",
50
- * // federationMode: "STRING_VALUE",
50
+ * // federationMode: "FEDERATED" || "LOCAL",
51
51
  * // federationParameters: { // FederationParameters
52
52
  * // samlMetadataDocument: "STRING_VALUE",
53
53
  * // samlMetadataURL: "STRING_VALUE",
@@ -0,0 +1,108 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
+ import { GetKxChangesetRequest, GetKxChangesetResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetKxChangesetCommand}.
14
+ */
15
+ export interface GetKxChangesetCommandInput extends GetKxChangesetRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetKxChangesetCommand}.
21
+ */
22
+ export interface GetKxChangesetCommandOutput extends GetKxChangesetResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns information about a kdb changeset.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { FinspaceClient, GetKxChangesetCommand } from "@aws-sdk/client-finspace"; // ES Modules import
31
+ * // const { FinspaceClient, GetKxChangesetCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
32
+ * const client = new FinspaceClient(config);
33
+ * const input = { // GetKxChangesetRequest
34
+ * environmentId: "STRING_VALUE", // required
35
+ * databaseName: "STRING_VALUE", // required
36
+ * changesetId: "STRING_VALUE", // required
37
+ * };
38
+ * const command = new GetKxChangesetCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // GetKxChangesetResponse
41
+ * // changesetId: "STRING_VALUE",
42
+ * // databaseName: "STRING_VALUE",
43
+ * // environmentId: "STRING_VALUE",
44
+ * // changeRequests: [ // ChangeRequests
45
+ * // { // ChangeRequest
46
+ * // changeType: "PUT" || "DELETE", // required
47
+ * // s3Path: "STRING_VALUE",
48
+ * // dbPath: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // createdTimestamp: new Date("TIMESTAMP"),
52
+ * // activeFromTimestamp: new Date("TIMESTAMP"),
53
+ * // lastModifiedTimestamp: new Date("TIMESTAMP"),
54
+ * // status: "PENDING" || "PROCESSING" || "FAILED" || "COMPLETED",
55
+ * // errorInfo: { // ErrorInfo
56
+ * // errorMessage: "STRING_VALUE",
57
+ * // errorType: "The inputs to this request are invalid." || "Service limits have been exceeded." || "Missing required permission to perform this request." || "One or more inputs to this request were not found." || "The system temporarily lacks sufficient resources to process the request." || "An internal error has occurred." || "Cancelled" || "A user recoverable error has occurred",
58
+ * // },
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param GetKxChangesetCommandInput - {@link GetKxChangesetCommandInput}
64
+ * @returns {@link GetKxChangesetCommandOutput}
65
+ * @see {@link GetKxChangesetCommandInput} for command's `input` shape.
66
+ * @see {@link GetKxChangesetCommandOutput} for command's `response` shape.
67
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
68
+ *
69
+ * @throws {@link AccessDeniedException} (client fault)
70
+ * <p>You do not have sufficient access to perform this action.</p>
71
+ *
72
+ * @throws {@link InternalServerException} (server fault)
73
+ * <p>The request processing has failed because of an unknown error, exception or
74
+ * failure.</p>
75
+ *
76
+ * @throws {@link ResourceNotFoundException} (client fault)
77
+ * <p>One or more resources can't be found.</p>
78
+ *
79
+ * @throws {@link ThrottlingException} (client fault)
80
+ * <p>The request was denied due to request throttling.</p>
81
+ *
82
+ * @throws {@link ValidationException} (client fault)
83
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
84
+ *
85
+ * @throws {@link FinspaceServiceException}
86
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
87
+ *
88
+ */
89
+ export declare class GetKxChangesetCommand extends $Command<GetKxChangesetCommandInput, GetKxChangesetCommandOutput, FinspaceClientResolvedConfig> {
90
+ readonly input: GetKxChangesetCommandInput;
91
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
92
+ /**
93
+ * @public
94
+ */
95
+ constructor(input: GetKxChangesetCommandInput);
96
+ /**
97
+ * @internal
98
+ */
99
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKxChangesetCommandInput, GetKxChangesetCommandOutput>;
100
+ /**
101
+ * @internal
102
+ */
103
+ private serialize;
104
+ /**
105
+ * @internal
106
+ */
107
+ private deserialize;
108
+ }
@@ -0,0 +1,164 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
+ import { GetKxClusterRequest, GetKxClusterResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetKxClusterCommand}.
14
+ */
15
+ export interface GetKxClusterCommandInput extends GetKxClusterRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetKxClusterCommand}.
21
+ */
22
+ export interface GetKxClusterCommandOutput extends GetKxClusterResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Retrieves information about a kdb cluster.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { FinspaceClient, GetKxClusterCommand } from "@aws-sdk/client-finspace"; // ES Modules import
31
+ * // const { FinspaceClient, GetKxClusterCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
32
+ * const client = new FinspaceClient(config);
33
+ * const input = { // GetKxClusterRequest
34
+ * environmentId: "STRING_VALUE", // required
35
+ * clusterName: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new GetKxClusterCommand(input);
38
+ * const response = await client.send(command);
39
+ * // { // GetKxClusterResponse
40
+ * // status: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
41
+ * // statusReason: "STRING_VALUE",
42
+ * // clusterName: "STRING_VALUE",
43
+ * // clusterType: "HDB" || "RDB" || "GATEWAY",
44
+ * // databases: [ // KxDatabaseConfigurations
45
+ * // { // KxDatabaseConfiguration
46
+ * // databaseName: "STRING_VALUE", // required
47
+ * // cacheConfigurations: [ // KxDatabaseCacheConfigurations
48
+ * // { // KxDatabaseCacheConfiguration
49
+ * // cacheType: "STRING_VALUE", // required
50
+ * // dbPaths: [ // DbPaths // required
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // },
54
+ * // ],
55
+ * // changesetId: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // cacheStorageConfigurations: [ // KxCacheStorageConfigurations
59
+ * // { // KxCacheStorageConfiguration
60
+ * // type: "STRING_VALUE", // required
61
+ * // size: Number("int"), // required
62
+ * // },
63
+ * // ],
64
+ * // autoScalingConfiguration: { // AutoScalingConfiguration
65
+ * // minNodeCount: Number("int"),
66
+ * // maxNodeCount: Number("int"),
67
+ * // autoScalingMetric: "CPU_UTILIZATION_PERCENTAGE",
68
+ * // metricTarget: Number("double"),
69
+ * // scaleInCooldownSeconds: Number("double"),
70
+ * // scaleOutCooldownSeconds: Number("double"),
71
+ * // },
72
+ * // clusterDescription: "STRING_VALUE",
73
+ * // capacityConfiguration: { // CapacityConfiguration
74
+ * // nodeType: "STRING_VALUE",
75
+ * // nodeCount: Number("int"),
76
+ * // },
77
+ * // releaseLabel: "STRING_VALUE",
78
+ * // vpcConfiguration: { // VpcConfiguration
79
+ * // vpcId: "STRING_VALUE",
80
+ * // securityGroupIds: [ // SecurityGroupIdList
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // subnetIds: [ // SubnetIdList
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // ipAddressType: "IP_V4",
87
+ * // },
88
+ * // initializationScript: "STRING_VALUE",
89
+ * // commandLineArguments: [ // KxCommandLineArguments
90
+ * // { // KxCommandLineArgument
91
+ * // key: "STRING_VALUE",
92
+ * // value: "STRING_VALUE",
93
+ * // },
94
+ * // ],
95
+ * // code: { // CodeConfiguration
96
+ * // s3Bucket: "STRING_VALUE",
97
+ * // s3Key: "STRING_VALUE",
98
+ * // s3ObjectVersion: "STRING_VALUE",
99
+ * // },
100
+ * // executionRole: "STRING_VALUE",
101
+ * // lastModifiedTimestamp: new Date("TIMESTAMP"),
102
+ * // savedownStorageConfiguration: { // KxSavedownStorageConfiguration
103
+ * // type: "SDS01", // required
104
+ * // size: Number("int"), // required
105
+ * // },
106
+ * // azMode: "SINGLE" || "MULTI",
107
+ * // availabilityZoneId: "STRING_VALUE",
108
+ * // createdTimestamp: new Date("TIMESTAMP"),
109
+ * // };
110
+ *
111
+ * ```
112
+ *
113
+ * @param GetKxClusterCommandInput - {@link GetKxClusterCommandInput}
114
+ * @returns {@link GetKxClusterCommandOutput}
115
+ * @see {@link GetKxClusterCommandInput} for command's `input` shape.
116
+ * @see {@link GetKxClusterCommandOutput} for command's `response` shape.
117
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
118
+ *
119
+ * @throws {@link AccessDeniedException} (client fault)
120
+ * <p>You do not have sufficient access to perform this action.</p>
121
+ *
122
+ * @throws {@link ConflictException} (client fault)
123
+ * <p>There was a conflict with this action, and it could not be completed.</p>
124
+ *
125
+ * @throws {@link InternalServerException} (server fault)
126
+ * <p>The request processing has failed because of an unknown error, exception or
127
+ * failure.</p>
128
+ *
129
+ * @throws {@link LimitExceededException} (client fault)
130
+ * <p>A service limit or quota is exceeded.</p>
131
+ *
132
+ * @throws {@link ResourceNotFoundException} (client fault)
133
+ * <p>One or more resources can't be found.</p>
134
+ *
135
+ * @throws {@link ThrottlingException} (client fault)
136
+ * <p>The request was denied due to request throttling.</p>
137
+ *
138
+ * @throws {@link ValidationException} (client fault)
139
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
140
+ *
141
+ * @throws {@link FinspaceServiceException}
142
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
143
+ *
144
+ */
145
+ export declare class GetKxClusterCommand extends $Command<GetKxClusterCommandInput, GetKxClusterCommandOutput, FinspaceClientResolvedConfig> {
146
+ readonly input: GetKxClusterCommandInput;
147
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
148
+ /**
149
+ * @public
150
+ */
151
+ constructor(input: GetKxClusterCommandInput);
152
+ /**
153
+ * @internal
154
+ */
155
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKxClusterCommandInput, GetKxClusterCommandOutput>;
156
+ /**
157
+ * @internal
158
+ */
159
+ private serialize;
160
+ /**
161
+ * @internal
162
+ */
163
+ private deserialize;
164
+ }
@@ -0,0 +1,91 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
+ import { GetKxConnectionStringRequest, GetKxConnectionStringResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetKxConnectionStringCommand}.
14
+ */
15
+ export interface GetKxConnectionStringCommandInput extends GetKxConnectionStringRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetKxConnectionStringCommand}.
21
+ */
22
+ export interface GetKxConnectionStringCommandOutput extends GetKxConnectionStringResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user. </p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { FinspaceClient, GetKxConnectionStringCommand } from "@aws-sdk/client-finspace"; // ES Modules import
31
+ * // const { FinspaceClient, GetKxConnectionStringCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
32
+ * const client = new FinspaceClient(config);
33
+ * const input = { // GetKxConnectionStringRequest
34
+ * userArn: "STRING_VALUE", // required
35
+ * environmentId: "STRING_VALUE", // required
36
+ * clusterName: "STRING_VALUE", // required
37
+ * };
38
+ * const command = new GetKxConnectionStringCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // GetKxConnectionStringResponse
41
+ * // signedConnectionString: "STRING_VALUE",
42
+ * // };
43
+ *
44
+ * ```
45
+ *
46
+ * @param GetKxConnectionStringCommandInput - {@link GetKxConnectionStringCommandInput}
47
+ * @returns {@link GetKxConnectionStringCommandOutput}
48
+ * @see {@link GetKxConnectionStringCommandInput} for command's `input` shape.
49
+ * @see {@link GetKxConnectionStringCommandOutput} for command's `response` shape.
50
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
51
+ *
52
+ * @throws {@link AccessDeniedException} (client fault)
53
+ * <p>You do not have sufficient access to perform this action.</p>
54
+ *
55
+ * @throws {@link InternalServerException} (server fault)
56
+ * <p>The request processing has failed because of an unknown error, exception or
57
+ * failure.</p>
58
+ *
59
+ * @throws {@link ResourceNotFoundException} (client fault)
60
+ * <p>One or more resources can't be found.</p>
61
+ *
62
+ * @throws {@link ThrottlingException} (client fault)
63
+ * <p>The request was denied due to request throttling.</p>
64
+ *
65
+ * @throws {@link ValidationException} (client fault)
66
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
67
+ *
68
+ * @throws {@link FinspaceServiceException}
69
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
70
+ *
71
+ */
72
+ export declare class GetKxConnectionStringCommand extends $Command<GetKxConnectionStringCommandInput, GetKxConnectionStringCommandOutput, FinspaceClientResolvedConfig> {
73
+ readonly input: GetKxConnectionStringCommandInput;
74
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
78
+ constructor(input: GetKxConnectionStringCommandInput);
79
+ /**
80
+ * @internal
81
+ */
82
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKxConnectionStringCommandInput, GetKxConnectionStringCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
86
+ private serialize;
87
+ /**
88
+ * @internal
89
+ */
90
+ private deserialize;
91
+ }
@@ -0,0 +1,99 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
+ import { GetKxDatabaseRequest, GetKxDatabaseResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetKxDatabaseCommand}.
14
+ */
15
+ export interface GetKxDatabaseCommandInput extends GetKxDatabaseRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetKxDatabaseCommand}.
21
+ */
22
+ export interface GetKxDatabaseCommandOutput extends GetKxDatabaseResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns database information for the specified environment ID.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { FinspaceClient, GetKxDatabaseCommand } from "@aws-sdk/client-finspace"; // ES Modules import
31
+ * // const { FinspaceClient, GetKxDatabaseCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
32
+ * const client = new FinspaceClient(config);
33
+ * const input = { // GetKxDatabaseRequest
34
+ * environmentId: "STRING_VALUE", // required
35
+ * databaseName: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new GetKxDatabaseCommand(input);
38
+ * const response = await client.send(command);
39
+ * // { // GetKxDatabaseResponse
40
+ * // databaseName: "STRING_VALUE",
41
+ * // databaseArn: "STRING_VALUE",
42
+ * // environmentId: "STRING_VALUE",
43
+ * // description: "STRING_VALUE",
44
+ * // createdTimestamp: new Date("TIMESTAMP"),
45
+ * // lastModifiedTimestamp: new Date("TIMESTAMP"),
46
+ * // lastCompletedChangesetId: "STRING_VALUE",
47
+ * // numBytes: Number("long"),
48
+ * // numChangesets: Number("int"),
49
+ * // numFiles: Number("int"),
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param GetKxDatabaseCommandInput - {@link GetKxDatabaseCommandInput}
55
+ * @returns {@link GetKxDatabaseCommandOutput}
56
+ * @see {@link GetKxDatabaseCommandInput} for command's `input` shape.
57
+ * @see {@link GetKxDatabaseCommandOutput} for command's `response` shape.
58
+ * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
59
+ *
60
+ * @throws {@link AccessDeniedException} (client fault)
61
+ * <p>You do not have sufficient access to perform this action.</p>
62
+ *
63
+ * @throws {@link InternalServerException} (server fault)
64
+ * <p>The request processing has failed because of an unknown error, exception or
65
+ * failure.</p>
66
+ *
67
+ * @throws {@link ResourceNotFoundException} (client fault)
68
+ * <p>One or more resources can't be found.</p>
69
+ *
70
+ * @throws {@link ThrottlingException} (client fault)
71
+ * <p>The request was denied due to request throttling.</p>
72
+ *
73
+ * @throws {@link ValidationException} (client fault)
74
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
75
+ *
76
+ * @throws {@link FinspaceServiceException}
77
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
78
+ *
79
+ */
80
+ export declare class GetKxDatabaseCommand extends $Command<GetKxDatabaseCommandInput, GetKxDatabaseCommandOutput, FinspaceClientResolvedConfig> {
81
+ readonly input: GetKxDatabaseCommandInput;
82
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
86
+ constructor(input: GetKxDatabaseCommandInput);
87
+ /**
88
+ * @internal
89
+ */
90
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKxDatabaseCommandInput, GetKxDatabaseCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
94
+ private serialize;
95
+ /**
96
+ * @internal
97
+ */
98
+ private deserialize;
99
+ }