@aws-sdk/client-schemas
Description
AWS SDK for JavaScript Schemas Client for Node.js, Browser and React Native.
Amazon EventBridge Schema Registry
Installing
To install this package, simply type add or install @aws-sdk/client-schemas
using your favorite package manager:
npm install @aws-sdk/client-schemas
yarn add @aws-sdk/client-schemas
pnpm add @aws-sdk/client-schemas
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SchemasClient
and
the commands you need, for example ListDiscoverersCommand
:
const { SchemasClient, ListDiscoverersCommand } = require("@aws-sdk/client-schemas");
import { SchemasClient, ListDiscoverersCommand } from "@aws-sdk/client-schemas";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new SchemasClient({ region: "REGION" });
const params = {
};
const command = new ListDiscoverersCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-schemas";
const client = new AWS.Schemas({ region: "REGION" });
try {
const data = await client.listDiscoverers(params);
} catch (error) {
}
client
.listDiscoverers(params)
.then((data) => {
})
.catch((error) => {
});
client.listDiscoverers(params, (err, data) => {
});
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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-schemas
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
CreateDiscoverer
Command API Reference / Input / Output
CreateRegistry
Command API Reference / Input / Output
CreateSchema
Command API Reference / Input / Output
DeleteDiscoverer
Command API Reference / Input / Output
DeleteRegistry
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteSchema
Command API Reference / Input / Output
DeleteSchemaVersion
Command API Reference / Input / Output
DescribeCodeBinding
Command API Reference / Input / Output
DescribeDiscoverer
Command API Reference / Input / Output
DescribeRegistry
Command API Reference / Input / Output
DescribeSchema
Command API Reference / Input / Output
ExportSchema
Command API Reference / Input / Output
GetCodeBindingSource
Command API Reference / Input / Output
GetDiscoveredSchema
Command API Reference / Input / Output
GetResourcePolicy
Command API Reference / Input / Output
ListDiscoverers
Command API Reference / Input / Output
ListRegistries
Command API Reference / Input / Output
ListSchemas
Command API Reference / Input / Output
ListSchemaVersions
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutCodeBinding
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
SearchSchemas
Command API Reference / Input / Output
StartDiscoverer
Command API Reference / Input / Output
StopDiscoverer
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateDiscoverer
Command API Reference / Input / Output
UpdateRegistry
Command API Reference / Input / Output
UpdateSchema
Command API Reference / Input / Output