@aws-sdk/client-finspace 3.345.0 → 3.346.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +208 -0
- package/dist-cjs/Finspace.js +52 -0
- package/dist-cjs/commands/CreateKxChangesetCommand.js +46 -0
- package/dist-cjs/commands/CreateKxClusterCommand.js +46 -0
- package/dist-cjs/commands/CreateKxDatabaseCommand.js +46 -0
- package/dist-cjs/commands/CreateKxEnvironmentCommand.js +46 -0
- package/dist-cjs/commands/CreateKxUserCommand.js +46 -0
- package/dist-cjs/commands/DeleteKxClusterCommand.js +46 -0
- package/dist-cjs/commands/DeleteKxDatabaseCommand.js +46 -0
- package/dist-cjs/commands/DeleteKxEnvironmentCommand.js +46 -0
- package/dist-cjs/commands/DeleteKxUserCommand.js +46 -0
- package/dist-cjs/commands/GetKxChangesetCommand.js +46 -0
- package/dist-cjs/commands/GetKxClusterCommand.js +46 -0
- package/dist-cjs/commands/GetKxConnectionStringCommand.js +47 -0
- package/dist-cjs/commands/GetKxDatabaseCommand.js +46 -0
- package/dist-cjs/commands/GetKxEnvironmentCommand.js +46 -0
- package/dist-cjs/commands/GetKxUserCommand.js +46 -0
- package/dist-cjs/commands/ListKxChangesetsCommand.js +46 -0
- package/dist-cjs/commands/ListKxClusterNodesCommand.js +46 -0
- package/dist-cjs/commands/ListKxClustersCommand.js +46 -0
- package/dist-cjs/commands/ListKxDatabasesCommand.js +46 -0
- package/dist-cjs/commands/ListKxEnvironmentsCommand.js +46 -0
- package/dist-cjs/commands/ListKxUsersCommand.js +46 -0
- package/dist-cjs/commands/UpdateKxClusterDatabasesCommand.js +46 -0
- package/dist-cjs/commands/UpdateKxDatabaseCommand.js +46 -0
- package/dist-cjs/commands/UpdateKxEnvironmentCommand.js +46 -0
- package/dist-cjs/commands/UpdateKxEnvironmentNetworkCommand.js +46 -0
- package/dist-cjs/commands/UpdateKxUserCommand.js +46 -0
- package/dist-cjs/commands/index.js +26 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/models_0.js +98 -1
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListKxChangesetsPaginator.js +29 -0
- package/dist-cjs/pagination/ListKxClusterNodesPaginator.js +29 -0
- package/dist-cjs/pagination/ListKxDatabasesPaginator.js +29 -0
- package/dist-cjs/pagination/ListKxEnvironmentsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2270 -125
- package/dist-es/Finspace.js +52 -0
- package/dist-es/commands/CreateKxChangesetCommand.js +42 -0
- package/dist-es/commands/CreateKxClusterCommand.js +42 -0
- package/dist-es/commands/CreateKxDatabaseCommand.js +42 -0
- package/dist-es/commands/CreateKxEnvironmentCommand.js +42 -0
- package/dist-es/commands/CreateKxUserCommand.js +42 -0
- package/dist-es/commands/DeleteKxClusterCommand.js +42 -0
- package/dist-es/commands/DeleteKxDatabaseCommand.js +42 -0
- package/dist-es/commands/DeleteKxEnvironmentCommand.js +42 -0
- package/dist-es/commands/DeleteKxUserCommand.js +42 -0
- package/dist-es/commands/GetKxChangesetCommand.js +42 -0
- package/dist-es/commands/GetKxClusterCommand.js +42 -0
- package/dist-es/commands/GetKxConnectionStringCommand.js +43 -0
- package/dist-es/commands/GetKxDatabaseCommand.js +42 -0
- package/dist-es/commands/GetKxEnvironmentCommand.js +42 -0
- package/dist-es/commands/GetKxUserCommand.js +42 -0
- package/dist-es/commands/ListKxChangesetsCommand.js +42 -0
- package/dist-es/commands/ListKxClusterNodesCommand.js +42 -0
- package/dist-es/commands/ListKxClustersCommand.js +42 -0
- package/dist-es/commands/ListKxDatabasesCommand.js +42 -0
- package/dist-es/commands/ListKxEnvironmentsCommand.js +42 -0
- package/dist-es/commands/ListKxUsersCommand.js +42 -0
- package/dist-es/commands/UpdateKxClusterDatabasesCommand.js +42 -0
- package/dist-es/commands/UpdateKxDatabaseCommand.js +42 -0
- package/dist-es/commands/UpdateKxEnvironmentCommand.js +42 -0
- package/dist-es/commands/UpdateKxEnvironmentNetworkCommand.js +42 -0
- package/dist-es/commands/UpdateKxUserCommand.js +42 -0
- package/dist-es/commands/index.js +26 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +94 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListKxChangesetsPaginator.js +25 -0
- package/dist-es/pagination/ListKxClusterNodesPaginator.js +25 -0
- package/dist-es/pagination/ListKxDatabasesPaginator.js +25 -0
- package/dist-es/pagination/ListKxEnvironmentsPaginator.js +25 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +2192 -100
- package/dist-types/Finspace.d.ts +182 -0
- package/dist-types/FinspaceClient.d.ts +28 -2
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateKxChangesetCommand.d.ts +122 -0
- package/dist-types/commands/CreateKxClusterCommand.d.ts +233 -0
- package/dist-types/commands/CreateKxDatabaseCommand.d.ts +109 -0
- package/dist-types/commands/CreateKxEnvironmentCommand.d.ts +108 -0
- package/dist-types/commands/CreateKxUserCommand.d.ts +107 -0
- package/dist-types/commands/DeleteKxClusterCommand.d.ts +95 -0
- package/dist-types/commands/DeleteKxDatabaseCommand.d.ts +92 -0
- package/dist-types/commands/DeleteKxEnvironmentCommand.d.ts +87 -0
- package/dist-types/commands/DeleteKxUserCommand.d.ts +88 -0
- package/dist-types/commands/GetEnvironmentCommand.d.ts +2 -2
- package/dist-types/commands/GetKxChangesetCommand.d.ts +108 -0
- package/dist-types/commands/GetKxClusterCommand.d.ts +164 -0
- package/dist-types/commands/GetKxConnectionStringCommand.d.ts +91 -0
- package/dist-types/commands/GetKxDatabaseCommand.d.ts +99 -0
- package/dist-types/commands/GetKxEnvironmentCommand.d.ts +112 -0
- package/dist-types/commands/GetKxUserCommand.d.ts +93 -0
- package/dist-types/commands/ListEnvironmentsCommand.d.ts +2 -2
- package/dist-types/commands/ListKxChangesetsCommand.d.ts +101 -0
- package/dist-types/commands/ListKxClusterNodesCommand.d.ts +102 -0
- package/dist-types/commands/ListKxClustersCommand.d.ts +114 -0
- package/dist-types/commands/ListKxDatabasesCommand.d.ts +98 -0
- package/dist-types/commands/ListKxEnvironmentsCommand.d.ts +112 -0
- package/dist-types/commands/ListKxUsersCommand.d.ts +100 -0
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +3 -3
- package/dist-types/commands/UpdateKxClusterDatabasesCommand.d.ts +107 -0
- package/dist-types/commands/UpdateKxDatabaseCommand.d.ts +98 -0
- package/dist-types/commands/UpdateKxEnvironmentCommand.d.ts +120 -0
- package/dist-types/commands/UpdateKxEnvironmentNetworkCommand.d.ts +129 -0
- package/dist-types/commands/UpdateKxUserCommand.d.ts +101 -0
- package/dist-types/commands/index.d.ts +26 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2390 -105
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListKxChangesetsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKxClusterNodesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKxDatabasesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKxEnvironmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +234 -0
- package/dist-types/ts3.4/Finspace.d.ts +442 -0
- package/dist-types/ts3.4/FinspaceClient.d.ts +158 -2
- package/dist-types/ts3.4/commands/CreateKxChangesetCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateKxClusterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateKxDatabaseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateKxEnvironmentCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateKxUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeleteKxClusterCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteKxDatabaseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteKxEnvironmentCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteKxUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetKxChangesetCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetKxClusterCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetKxConnectionStringCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetKxDatabaseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetKxEnvironmentCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetKxUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListKxChangesetsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListKxClusterNodesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListKxClustersCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListKxDatabasesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListKxEnvironmentsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListKxUsersCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateKxClusterDatabasesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateKxDatabaseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateKxEnvironmentCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateKxEnvironmentNetworkCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateKxUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/index.d.ts +26 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +575 -3
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListKxChangesetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKxClusterNodesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKxDatabasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKxEnvironmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +312 -0
- package/package.json +4 -2
|
@@ -0,0 +1,112 @@
|
|
|
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 { GetKxEnvironmentRequest, GetKxEnvironmentResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetKxEnvironmentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetKxEnvironmentCommandInput extends GetKxEnvironmentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetKxEnvironmentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetKxEnvironmentCommandOutput extends GetKxEnvironmentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves all the information for 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, GetKxEnvironmentCommand } from "@aws-sdk/client-finspace"; // ES Modules import
|
|
31
|
+
* // const { FinspaceClient, GetKxEnvironmentCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
|
|
32
|
+
* const client = new FinspaceClient(config);
|
|
33
|
+
* const input = { // GetKxEnvironmentRequest
|
|
34
|
+
* environmentId: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetKxEnvironmentCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetKxEnvironmentResponse
|
|
39
|
+
* // name: "STRING_VALUE",
|
|
40
|
+
* // environmentId: "STRING_VALUE",
|
|
41
|
+
* // awsAccountId: "STRING_VALUE",
|
|
42
|
+
* // status: "CREATE_REQUESTED" || "CREATING" || "CREATED" || "DELETE_REQUESTED" || "DELETING" || "DELETED" || "FAILED_CREATION" || "RETRY_DELETION" || "FAILED_DELETION" || "UPDATE_NETWORK_REQUESTED" || "UPDATING_NETWORK" || "FAILED_UPDATING_NETWORK" || "SUSPENDED",
|
|
43
|
+
* // tgwStatus: "NONE" || "UPDATE_REQUESTED" || "UPDATING" || "FAILED_UPDATE" || "SUCCESSFULLY_UPDATED",
|
|
44
|
+
* // dnsStatus: "NONE" || "UPDATE_REQUESTED" || "UPDATING" || "FAILED_UPDATE" || "SUCCESSFULLY_UPDATED",
|
|
45
|
+
* // errorMessage: "STRING_VALUE",
|
|
46
|
+
* // description: "STRING_VALUE",
|
|
47
|
+
* // environmentArn: "STRING_VALUE",
|
|
48
|
+
* // kmsKeyId: "STRING_VALUE",
|
|
49
|
+
* // dedicatedServiceAccountId: "STRING_VALUE",
|
|
50
|
+
* // transitGatewayConfiguration: { // TransitGatewayConfiguration
|
|
51
|
+
* // transitGatewayID: "STRING_VALUE", // required
|
|
52
|
+
* // routableCIDRSpace: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // customDNSConfiguration: [ // CustomDNSConfiguration
|
|
55
|
+
* // { // CustomDNSServer
|
|
56
|
+
* // customDNSServerName: "STRING_VALUE", // required
|
|
57
|
+
* // customDNSServerIP: "STRING_VALUE", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // creationTimestamp: new Date("TIMESTAMP"),
|
|
61
|
+
* // updateTimestamp: new Date("TIMESTAMP"),
|
|
62
|
+
* // availabilityZoneIds: [ // AvailabilityZoneIds
|
|
63
|
+
* // "STRING_VALUE",
|
|
64
|
+
* // ],
|
|
65
|
+
* // certificateAuthorityArn: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param GetKxEnvironmentCommandInput - {@link GetKxEnvironmentCommandInput}
|
|
71
|
+
* @returns {@link GetKxEnvironmentCommandOutput}
|
|
72
|
+
* @see {@link GetKxEnvironmentCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link GetKxEnvironmentCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InternalServerException} (server fault)
|
|
80
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
81
|
+
* failure.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>One or more resources can't be found.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link FinspaceServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from Finspace service.</p>
|
|
91
|
+
*
|
|
92
|
+
*/
|
|
93
|
+
export declare class GetKxEnvironmentCommand extends $Command<GetKxEnvironmentCommandInput, GetKxEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
|
|
94
|
+
readonly input: GetKxEnvironmentCommandInput;
|
|
95
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
constructor(input: GetKxEnvironmentCommandInput);
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKxEnvironmentCommandInput, GetKxEnvironmentCommandOutput>;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private serialize;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private deserialize;
|
|
112
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
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 { GetKxUserRequest, GetKxUserResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetKxUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetKxUserCommandInput extends GetKxUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetKxUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetKxUserCommandOutput extends GetKxUserResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves information about the specified kdb 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, GetKxUserCommand } from "@aws-sdk/client-finspace"; // ES Modules import
|
|
31
|
+
* // const { FinspaceClient, GetKxUserCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
|
|
32
|
+
* const client = new FinspaceClient(config);
|
|
33
|
+
* const input = { // GetKxUserRequest
|
|
34
|
+
* userName: "STRING_VALUE", // required
|
|
35
|
+
* environmentId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetKxUserCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetKxUserResponse
|
|
40
|
+
* // userName: "STRING_VALUE",
|
|
41
|
+
* // userArn: "STRING_VALUE",
|
|
42
|
+
* // environmentId: "STRING_VALUE",
|
|
43
|
+
* // iamRole: "STRING_VALUE",
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param GetKxUserCommandInput - {@link GetKxUserCommandInput}
|
|
49
|
+
* @returns {@link GetKxUserCommandOutput}
|
|
50
|
+
* @see {@link GetKxUserCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link GetKxUserCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
59
|
+
* failure.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
+
* <p>One or more resources can't be found.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
+
* <p>The request was denied due to request throttling.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ValidationException} (client fault)
|
|
68
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link FinspaceServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from Finspace service.</p>
|
|
72
|
+
*
|
|
73
|
+
*/
|
|
74
|
+
export declare class GetKxUserCommand extends $Command<GetKxUserCommandInput, GetKxUserCommandOutput, FinspaceClientResolvedConfig> {
|
|
75
|
+
readonly input: GetKxUserCommandInput;
|
|
76
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
constructor(input: GetKxUserCommandInput);
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetKxUserCommandInput, GetKxUserCommandOutput>;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
private serialize;
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
private deserialize;
|
|
93
|
+
}
|
|
@@ -42,14 +42,14 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResponse,
|
|
|
42
42
|
* // name: "STRING_VALUE",
|
|
43
43
|
* // environmentId: "STRING_VALUE",
|
|
44
44
|
* // awsAccountId: "STRING_VALUE",
|
|
45
|
-
* // status: "
|
|
45
|
+
* // status: "CREATE_REQUESTED" || "CREATING" || "CREATED" || "DELETE_REQUESTED" || "DELETING" || "DELETED" || "FAILED_CREATION" || "RETRY_DELETION" || "FAILED_DELETION" || "UPDATE_NETWORK_REQUESTED" || "UPDATING_NETWORK" || "FAILED_UPDATING_NETWORK" || "SUSPENDED",
|
|
46
46
|
* // environmentUrl: "STRING_VALUE",
|
|
47
47
|
* // description: "STRING_VALUE",
|
|
48
48
|
* // environmentArn: "STRING_VALUE",
|
|
49
49
|
* // sageMakerStudioDomainUrl: "STRING_VALUE",
|
|
50
50
|
* // kmsKeyId: "STRING_VALUE",
|
|
51
51
|
* // dedicatedServiceAccountId: "STRING_VALUE",
|
|
52
|
-
* // federationMode: "
|
|
52
|
+
* // federationMode: "FEDERATED" || "LOCAL",
|
|
53
53
|
* // federationParameters: { // FederationParameters
|
|
54
54
|
* // samlMetadataDocument: "STRING_VALUE",
|
|
55
55
|
* // samlMetadataURL: "STRING_VALUE",
|
|
@@ -0,0 +1,101 @@
|
|
|
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 { ListKxChangesetsRequest, ListKxChangesetsResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListKxChangesetsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListKxChangesetsCommandInput extends ListKxChangesetsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListKxChangesetsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListKxChangesetsCommandOutput extends ListKxChangesetsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a list of all the changesets for a database.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { FinspaceClient, ListKxChangesetsCommand } from "@aws-sdk/client-finspace"; // ES Modules import
|
|
31
|
+
* // const { FinspaceClient, ListKxChangesetsCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
|
|
32
|
+
* const client = new FinspaceClient(config);
|
|
33
|
+
* const input = { // ListKxChangesetsRequest
|
|
34
|
+
* environmentId: "STRING_VALUE", // required
|
|
35
|
+
* databaseName: "STRING_VALUE", // required
|
|
36
|
+
* nextToken: "STRING_VALUE",
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListKxChangesetsCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListKxChangesetsResponse
|
|
42
|
+
* // kxChangesets: [ // KxChangesets
|
|
43
|
+
* // { // KxChangesetListEntry
|
|
44
|
+
* // changesetId: "STRING_VALUE",
|
|
45
|
+
* // createdTimestamp: new Date("TIMESTAMP"),
|
|
46
|
+
* // activeFromTimestamp: new Date("TIMESTAMP"),
|
|
47
|
+
* // lastModifiedTimestamp: new Date("TIMESTAMP"),
|
|
48
|
+
* // status: "PENDING" || "PROCESSING" || "FAILED" || "COMPLETED",
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // nextToken: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param ListKxChangesetsCommandInput - {@link ListKxChangesetsCommandInput}
|
|
57
|
+
* @returns {@link ListKxChangesetsCommandOutput}
|
|
58
|
+
* @see {@link ListKxChangesetsCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link ListKxChangesetsCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
67
|
+
* failure.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>One or more resources can't be found.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>The request was denied due to request throttling.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ValidationException} (client fault)
|
|
76
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link FinspaceServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Finspace service.</p>
|
|
80
|
+
*
|
|
81
|
+
*/
|
|
82
|
+
export declare class ListKxChangesetsCommand extends $Command<ListKxChangesetsCommandInput, ListKxChangesetsCommandOutput, FinspaceClientResolvedConfig> {
|
|
83
|
+
readonly input: ListKxChangesetsCommandInput;
|
|
84
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
constructor(input: ListKxChangesetsCommandInput);
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKxChangesetsCommandInput, ListKxChangesetsCommandOutput>;
|
|
93
|
+
/**
|
|
94
|
+
* @internal
|
|
95
|
+
*/
|
|
96
|
+
private serialize;
|
|
97
|
+
/**
|
|
98
|
+
* @internal
|
|
99
|
+
*/
|
|
100
|
+
private deserialize;
|
|
101
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
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 { ListKxClusterNodesRequest, ListKxClusterNodesResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListKxClusterNodesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListKxClusterNodesCommandInput extends ListKxClusterNodesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListKxClusterNodesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListKxClusterNodesCommandOutput extends ListKxClusterNodesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists all the nodes in 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, ListKxClusterNodesCommand } from "@aws-sdk/client-finspace"; // ES Modules import
|
|
31
|
+
* // const { FinspaceClient, ListKxClusterNodesCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
|
|
32
|
+
* const client = new FinspaceClient(config);
|
|
33
|
+
* const input = { // ListKxClusterNodesRequest
|
|
34
|
+
* environmentId: "STRING_VALUE", // required
|
|
35
|
+
* clusterName: "STRING_VALUE", // required
|
|
36
|
+
* nextToken: "STRING_VALUE",
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListKxClusterNodesCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListKxClusterNodesResponse
|
|
42
|
+
* // nodes: [ // KxNodeSummaries
|
|
43
|
+
* // { // KxNode
|
|
44
|
+
* // nodeId: "STRING_VALUE",
|
|
45
|
+
* // availabilityZoneId: "STRING_VALUE",
|
|
46
|
+
* // launchTime: new Date("TIMESTAMP"),
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // nextToken: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param ListKxClusterNodesCommandInput - {@link ListKxClusterNodesCommandInput}
|
|
55
|
+
* @returns {@link ListKxClusterNodesCommandOutput}
|
|
56
|
+
* @see {@link ListKxClusterNodesCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link ListKxClusterNodesCommandOutput} 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 LimitExceededException} (client fault)
|
|
68
|
+
* <p>A service limit or quota is exceeded.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <p>One or more resources can't be found.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
+
* <p>The request was denied due to request throttling.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link FinspaceServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Finspace service.</p>
|
|
81
|
+
*
|
|
82
|
+
*/
|
|
83
|
+
export declare class ListKxClusterNodesCommand extends $Command<ListKxClusterNodesCommandInput, ListKxClusterNodesCommandOutput, FinspaceClientResolvedConfig> {
|
|
84
|
+
readonly input: ListKxClusterNodesCommandInput;
|
|
85
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
constructor(input: ListKxClusterNodesCommandInput);
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKxClusterNodesCommandInput, ListKxClusterNodesCommandOutput>;
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
private serialize;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
private deserialize;
|
|
102
|
+
}
|
|
@@ -0,0 +1,114 @@
|
|
|
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 { ListKxClustersRequest, ListKxClustersResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListKxClustersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListKxClustersCommandInput extends ListKxClustersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListKxClustersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListKxClustersCommandOutput extends ListKxClustersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a list of clusters.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { FinspaceClient, ListKxClustersCommand } from "@aws-sdk/client-finspace"; // ES Modules import
|
|
31
|
+
* // const { FinspaceClient, ListKxClustersCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
|
|
32
|
+
* const client = new FinspaceClient(config);
|
|
33
|
+
* const input = { // ListKxClustersRequest
|
|
34
|
+
* environmentId: "STRING_VALUE", // required
|
|
35
|
+
* clusterType: "HDB" || "RDB" || "GATEWAY",
|
|
36
|
+
* maxResults: Number("int"),
|
|
37
|
+
* nextToken: "STRING_VALUE",
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListKxClustersCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListKxClustersResponse
|
|
42
|
+
* // kxClusterSummaries: [ // KxClusters
|
|
43
|
+
* // { // KxCluster
|
|
44
|
+
* // status: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
|
|
45
|
+
* // statusReason: "STRING_VALUE",
|
|
46
|
+
* // clusterName: "STRING_VALUE",
|
|
47
|
+
* // clusterType: "HDB" || "RDB" || "GATEWAY",
|
|
48
|
+
* // clusterDescription: "STRING_VALUE",
|
|
49
|
+
* // releaseLabel: "STRING_VALUE",
|
|
50
|
+
* // initializationScript: "STRING_VALUE",
|
|
51
|
+
* // executionRole: "STRING_VALUE",
|
|
52
|
+
* // azMode: "SINGLE" || "MULTI",
|
|
53
|
+
* // availabilityZoneId: "STRING_VALUE",
|
|
54
|
+
* // lastModifiedTimestamp: new Date("TIMESTAMP"),
|
|
55
|
+
* // createdTimestamp: new Date("TIMESTAMP"),
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // nextToken: "STRING_VALUE",
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param ListKxClustersCommandInput - {@link ListKxClustersCommandInput}
|
|
64
|
+
* @returns {@link ListKxClustersCommandOutput}
|
|
65
|
+
* @see {@link ListKxClustersCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link ListKxClustersCommandOutput} 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 ConflictException} (client fault)
|
|
73
|
+
* <p>There was a conflict with this action, and it could not be completed.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServerException} (server fault)
|
|
76
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
77
|
+
* failure.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
80
|
+
* <p>A service limit or quota is exceeded.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
|
+
* <p>One or more resources can't be found.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
86
|
+
* <p>The request was denied due to request throttling.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ValidationException} (client fault)
|
|
89
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link FinspaceServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from Finspace service.</p>
|
|
93
|
+
*
|
|
94
|
+
*/
|
|
95
|
+
export declare class ListKxClustersCommand extends $Command<ListKxClustersCommandInput, ListKxClustersCommandOutput, FinspaceClientResolvedConfig> {
|
|
96
|
+
readonly input: ListKxClustersCommandInput;
|
|
97
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
constructor(input: ListKxClustersCommandInput);
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKxClustersCommandInput, ListKxClustersCommandOutput>;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
private serialize;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
private deserialize;
|
|
114
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
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 { ListKxDatabasesRequest, ListKxDatabasesResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListKxDatabasesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListKxDatabasesCommandInput extends ListKxDatabasesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListKxDatabasesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListKxDatabasesCommandOutput extends ListKxDatabasesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a list of all the databases in the 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, ListKxDatabasesCommand } from "@aws-sdk/client-finspace"; // ES Modules import
|
|
31
|
+
* // const { FinspaceClient, ListKxDatabasesCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
|
|
32
|
+
* const client = new FinspaceClient(config);
|
|
33
|
+
* const input = { // ListKxDatabasesRequest
|
|
34
|
+
* environmentId: "STRING_VALUE", // required
|
|
35
|
+
* nextToken: "STRING_VALUE",
|
|
36
|
+
* maxResults: Number("int"),
|
|
37
|
+
* };
|
|
38
|
+
* const command = new ListKxDatabasesCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // ListKxDatabasesResponse
|
|
41
|
+
* // kxDatabases: [ // KxDatabases
|
|
42
|
+
* // { // KxDatabaseListEntry
|
|
43
|
+
* // databaseName: "STRING_VALUE",
|
|
44
|
+
* // createdTimestamp: new Date("TIMESTAMP"),
|
|
45
|
+
* // lastModifiedTimestamp: new Date("TIMESTAMP"),
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // nextToken: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param ListKxDatabasesCommandInput - {@link ListKxDatabasesCommandInput}
|
|
54
|
+
* @returns {@link ListKxDatabasesCommandOutput}
|
|
55
|
+
* @see {@link ListKxDatabasesCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link ListKxDatabasesCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
64
|
+
* failure.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* <p>One or more resources can't be found.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>The request was denied due to request throttling.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link FinspaceServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from Finspace service.</p>
|
|
77
|
+
*
|
|
78
|
+
*/
|
|
79
|
+
export declare class ListKxDatabasesCommand extends $Command<ListKxDatabasesCommandInput, ListKxDatabasesCommandOutput, FinspaceClientResolvedConfig> {
|
|
80
|
+
readonly input: ListKxDatabasesCommandInput;
|
|
81
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
82
|
+
/**
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
constructor(input: ListKxDatabasesCommandInput);
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListKxDatabasesCommandInput, ListKxDatabasesCommandOutput>;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
private serialize;
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
private deserialize;
|
|
98
|
+
}
|