Amazon Web Services, Inc.

Managed Streaming for Kafka

The operations for managing an Amazon MSK cluster.

Media & content#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The operations for managing an Amazon MSK cluster.

Endpoints 64

  • GETList scram secrets/v1/clusters/:ClusterArn/scram-secrets?maxResults=0&nextToken=stringReturns a list of the Scram Secrets associated with an Amazon MSK cluster.
  • POSTBatch associate scram secret/v1/clusters/:ClusterArn/scram-secretsAssociates one or more Scram Secrets with an Amazon MSK cluster.
  • PATCHBatch disassociate scram secret/v1/clusters/:ClusterArn/scram-secretsDisassociates one or more Scram Secrets from an Amazon MSK cluster.
  • GETList channels/v1/clusters/:ClusterArn/channels?maxResults=0&nextToken=string&topicNameFilter=stringReturns the list of channels in a cluster.
  • POSTCreate channel/v1/clusters/:ClusterArn/channelsCreates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.
  • GETList clusters/v1/clusters?clusterNameFilter=string&maxResults=0&nextToken=stringReturns a list of all the MSK clusters in the current Region.
  • POSTCreate cluster/v1/clustersCreates a new MSK cluster.
  • GETList clusters v2/api/v2/clusters?clusterNameFilter=string&clusterTypeFilter=string&maxResults=0&nextToken=stringReturns a list of all the MSK clusters in the current Region.
  • POSTCreate cluster v2/api/v2/clustersCreates a new MSK cluster.
  • GETList configurations/v1/configurations?maxResults=0&nextToken=stringReturns a list of all the MSK configurations in this Region.
  • POSTCreate configuration/v1/configurationsCreates a new MSK configuration.
  • GETList replicators/replication/v1/replicators?maxResults=0&nextToken=string&replicatorNameFilter=stringLists the replicators.
  • POSTCreate replicator/replication/v1/replicatorsCreates the replicator.
  • GETList topics/v1/clusters/:ClusterArn/topics?maxResults=0&nextToken=string&topicNameFilter=stringList topics in a MSK cluster.
  • POSTCreate topic/v1/clusters/:ClusterArn/topicsCreates a topic in the specified MSK cluster.
  • POSTCreate vpc connection/v1/vpc-connectionCreates a new MSK VPC connection.
  • GETDescribe channel/v1/clusters/:ClusterArn/channels/:ChannelArnReturns the current configuration and state of a channel.
  • PUTUpdate channel/v1/clusters/:ClusterArn/channels/:ChannelArnUpdates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.
  • DELETEDelete channel/v1/clusters/:ClusterArn/channels/:ChannelArnDeletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the…
  • GETDescribe cluster/v1/clusters/:ClusterArnReturns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
  • DELETEDelete cluster/v1/clusters/:ClusterArn?currentVersion=stringDeletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
  • GETGet cluster policy/v1/clusters/:ClusterArn/policyGet the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
  • PUTPut cluster policy/v1/clusters/:ClusterArn/policyCreates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
  • DELETEDelete cluster policy/v1/clusters/:ClusterArn/policyDeletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
  • GETDescribe configuration/v1/configurations/:ArnReturns a description of this MSK configuration.
  • PUTUpdate configuration/v1/configurations/:ArnUpdates an MSK configuration.
  • DELETEDelete configuration/v1/configurations/:ArnDeletes an MSK Configuration.
  • GETDescribe replicator/replication/v1/replicators/:ReplicatorArnDescribes a replicator.
  • DELETEDelete replicator/replication/v1/replicators/:ReplicatorArn?currentVersion=stringDeletes a replicator.
  • GETDescribe topic/v1/clusters/:ClusterArn/topics/:TopicNameReturns topic details of this topic on a MSK cluster.
  • PUTUpdate topic/v1/clusters/:ClusterArn/topics/:TopicNameUpdates the configuration of the specified topic.
  • DELETEDelete topic/v1/clusters/:ClusterArn/topics/:TopicNameDeletes a topic in the specified MSK cluster.
  • GETDescribe vpc connection/v1/vpc-connection/:ArnReturns a description of this MSK VPC connection.
  • DELETEDelete vpc connection/v1/vpc-connection/:ArnDeletes a MSK VPC connection.
  • GETDescribe cluster operation/v1/operations/:ClusterOperationArnReturns a description of the cluster operation specified by the ARN.
  • GETDescribe cluster operation v2/api/v2/operations/:ClusterOperationArnReturns a description of the cluster operation specified by the ARN.
  • GETDescribe cluster v2/api/v2/clusters/:ClusterArnReturns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
  • GETDescribe configuration revision/v1/configurations/:Arn/revisions/:RevisionReturns a description of this revision of the configuration.
  • GETDescribe topic partitions/v1/clusters/:ClusterArn/topics/:TopicName/partitions?maxResults=0&nextToken=stringReturns partition details of this topic on a MSK cluster.
  • GETGet bootstrap brokers/v1/clusters/:ClusterArn/bootstrap-brokersA list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following…
  • GETGet compatible kafka versions/v1/compatible-kafka-versions?clusterArn=stringGets the Apache Kafka versions to which you can update the MSK cluster.
  • GETList client vpc connections/v1/clusters/:ClusterArn/client-vpc-connections?maxResults=0&nextToken=stringReturns a list of all the VPC connections in this Region.
  • GETList cluster operations/v1/clusters/:ClusterArn/operations?maxResults=0&nextToken=stringReturns a list of all the operations that have been performed on the specified MSK cluster.
  • GETList cluster operations v2/api/v2/clusters/:ClusterArn/operations?maxResults=0&nextToken=stringReturns a list of all the operations that have been performed on the specified MSK cluster.
  • GETList configuration revisions/v1/configurations/:Arn/revisions?maxResults=0&nextToken=stringReturns a list of all the MSK configurations in this Region.
  • GETList kafka versions/v1/kafka-versions?maxResults=0&nextToken=stringReturns a list of Apache Kafka versions.
  • GETList nodes/v1/clusters/:ClusterArn/nodes?maxResults=0&nextToken=stringReturns a list of the broker nodes in the cluster.
  • GETList tags for resource/v1/tags/:ResourceArnReturns a list of the tags associated with the specified resource.
  • POSTTag resource/v1/tags/:ResourceArnAdds tags to the specified MSK resource.
  • DELETEUntag resource/v1/tags/:ResourceArn?tagKeys=Removes the tags associated with the keys that are provided in the query.
  • GETList vpc connections/v1/vpc-connections?maxResults=0&nextToken=stringReturns a list of all the VPC connections in this Region.
  • PUTReboot broker/v1/clusters/:ClusterArn/reboot-brokerReboots brokers.
  • PUTReject client vpc connection/v1/clusters/:ClusterArn/client-vpc-connectionReturns empty response.
  • PUTUpdate broker count/v1/clusters/:ClusterArn/nodes/countUpdates the number of broker nodes in the cluster.
  • PUTUpdate broker storage/v1/clusters/:ClusterArn/nodes/storageUpdates the EBS storage associated with MSK brokers.
  • PUTUpdate broker type/v1/clusters/:ClusterArn/nodes/typeUpdates EC2 instance type.
  • PUTUpdate cluster configuration/v1/clusters/:ClusterArn/configurationUpdates the cluster with the configuration that is specified in the request body.
  • PUTUpdate cluster kafka version/v1/clusters/:ClusterArn/versionUpdates the Apache Kafka version for the cluster.
  • PUTUpdate connectivity/v1/clusters/:ClusterArn/connectivityUpdates the cluster's connectivity configuration.
  • PUTUpdate monitoring/v1/clusters/:ClusterArn/monitoringUpdates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon…
  • PUTUpdate rebalancing/v1/clusters/:ClusterArn/rebalancingUse this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.
  • PUTUpdate replication info/replication/v1/replicators/:ReplicatorArn/replication-infoUpdates replication info of a replicator.
  • PATCHUpdate security/v1/clusters/:ClusterArn/securityUpdates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
  • PUTUpdate storage/v1/clusters/:ClusterArn/storageUpdates cluster broker volume size (or) sets cluster storage mode to TIERED.

API details

Base URL
https://kafka.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
64 operations on 43 pathsGET 29PUT 16POST 9DELETE 8PATCH 2
Description format
AWS Smithy model, API version 2018-11-14

How to test the Managed Streaming for Kafka in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Managed Streaming for Kafka collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List scram secrets” (GET /v1/clusters/:ClusterArn/scram-secrets?maxResults=0&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Managed Streaming for Kafka?

The operations for managing an Amazon MSK cluster. It is listed under Media & content and has 64 endpoints.

Who publishes the Managed Streaming for Kafka?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Managed Streaming for Kafka?

Requests go to https://kafka.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Managed Streaming for Kafka?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Managed Streaming for Kafka have?

64 operations on 43 paths (29 GET, 16 PUT, 9 POST, 8 DELETE, 2 PATCH).

Is forking the Managed Streaming for Kafka free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.