@aws-sdk/client-kafka

Description

AWS SDK for JavaScript Kafka Client for Node.js, Browser and React Native.

The operations for managing an Amazon MSK cluster.

Installing

To install this package, simply type add or install @aws-sdk/client-kafka
using your favorite package manager:
- npm install @aws-sdk/client-kafka
- yarn add @aws-sdk/client-kafka
- pnpm add @aws-sdk/client-kafka

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the KafkaClient and
the commands you need, for example ListClustersCommand:

``js
// ES5 example
const { KafkaClient, ListClustersCommand } = require("@aws-sdk/client-kafka");
`

`ts
// ES6+ example
import { KafkaClient, ListClustersCommand } from "@aws-sdk/client-kafka";
`

$3

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.

`js
// a client can be shared by different commands.
const client = new KafkaClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListClustersCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and 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

`ts
import * as AWS from "@aws-sdk/client-kafka";
const client = new AWS.Kafka({ region: "REGION" });

// async/await.
try {
const data = await client.listClusters(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listClusters(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listClusters(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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 specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

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.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

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-kafka` 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)

BatchAssociateScramSecret

Command API Reference / Input / Output

BatchDisassociateScramSecret

Command API Reference / Input / Output

CreateCluster

Command API Reference / Input / Output

CreateClusterV2

Command API Reference / Input / Output

CreateConfiguration

Command API Reference / Input / Output

CreateReplicator

Command API Reference / Input / Output

CreateVpcConnection

Command API Reference / Input / Output

DeleteCluster

Command API Reference / Input / Output

DeleteClusterPolicy

Command API Reference / Input / Output

DeleteConfiguration

Command API Reference / Input / Output

DeleteReplicator

Command API Reference / Input / Output

DeleteVpcConnection

Command API Reference / Input / Output

DescribeCluster

Command API Reference / Input / Output

DescribeClusterOperation

Command API Reference / Input / Output

DescribeClusterOperationV2

Command API Reference / Input / Output

DescribeClusterV2

Command API Reference / Input / Output

DescribeConfiguration

Command API Reference / Input / Output

DescribeConfigurationRevision

Command API Reference / Input / Output

DescribeReplicator

Command API Reference / Input / Output

DescribeTopic

Command API Reference / Input / Output

DescribeTopicPartitions

Command API Reference / Input / Output

DescribeVpcConnection

Command API Reference / Input / Output

GetBootstrapBrokers

Command API Reference / Input / Output

GetClusterPolicy

Command API Reference / Input / Output

GetCompatibleKafkaVersions

Command API Reference / Input / Output

ListClientVpcConnections

Command API Reference / Input / Output

ListClusterOperations

Command API Reference / Input / Output

ListClusterOperationsV2

Command API Reference / Input / Output

ListClusters

Command API Reference / Input / Output

ListClustersV2

Command API Reference / Input / Output

ListConfigurationRevisions

Command API Reference / Input / Output

ListConfigurations

Command API Reference / Input / Output

ListKafkaVersions

Command API Reference / Input / Output

ListNodes

Command API Reference / Input / Output

ListReplicators

Command API Reference / Input / Output

ListScramSecrets

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTopics

Command API Reference / Input / Output

ListVpcConnections

Command API Reference / Input / Output

PutClusterPolicy

Command API Reference / Input / Output

RebootBroker

Command API Reference / Input / Output

RejectClientVpcConnection

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateBrokerCount

Command API Reference / Input / Output

UpdateBrokerStorage

Command API Reference / Input / Output

UpdateBrokerType

Command API Reference / Input / Output

UpdateClusterConfiguration

Command API Reference / Input / Output

UpdateClusterKafkaVersion

Command API Reference / Input / Output

UpdateConfiguration

Command API Reference / Input / Output

UpdateConnectivity

Command API Reference / Input / Output

UpdateMonitoring

Command API Reference / Input / Output

UpdateRebalancing

Command API Reference / Input / Output

UpdateReplicationInfo

Command API Reference / Input / Output

UpdateSecurity

Command API Reference / Input / Output

UpdateStorage

Command API Reference / Input / Output