@stedi/sdk-client-cloud v0.4.71
@stedi/sdk-client-cloud
Description
Stedi Cloud SDK for JavaScript.
Installing
To install the this package, simply type add or install @stedi/sdk-client-cloud using your favorite package manager:
npm install @stedi/sdk-client-cloud
yarn add @stedi/sdk-client-cloud
pnpm add @stedi/sdk-client-cloud
Getting Started
Initialize the client
First, create a new CloudClient
.
import { CloudClient, CreateCloudCommand } from "@stedi/sdk-client-cloud";
const client = new CloudClient({
region: "us",
apiKey: "my-api-key",
});
Usage
Once the client is initiated, you may use it to send multiple commands.
If you are using a custom http handler, you may call destroy()
to close open connections.
Create a command by creating a new CreateCloudCommand
.
import { CloudClient, CreateCloudCommand } from "@stedi/sdk-client-cloud";
const client = new CloudClient({
region: "us",
apiKey: "my-api-key",
});
const params = {
/** input parameters */
};
const command = new CreateCloudCommand(params);
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Troubleshooting
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by checking if it is a certain instance of exception:
* if (error instanceof SomeServiceException) {
* const value = error.specialKeyInException;
* }
*/
}
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
Client Commands (Operations List)
Command API Reference / Input / Output
Command API Reference / Input / Output
1 month ago
1 month ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
8 months ago
8 months ago
8 months ago
8 months ago
10 months ago
10 months ago
7 months ago
7 months ago
8 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
11 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago