Amazon Web Services, Inc.

Managed Streaming for Kafka Connect

Managed Streaming for Kafka Connect endpoints from Amazon Web Services, Inc.

Media & content#openapi

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

<p/>

Endpoints 21

  • GETList connectors/v1/connectors?connectorNamePrefix=string&maxResults=0&nextToken=stringReturns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response…
  • POSTCreate connector/v1/connectorsCreates a connector using the specified properties.
  • GETList custom plugins/v1/custom-plugins?maxResults=0&nextToken=string&namePrefix=stringReturns a list of all of the custom plugins in this account and Region.
  • POSTCreate custom plugin/v1/custom-pluginsCreates a custom plugin using the specified properties.
  • GETList worker configurations/v1/worker-configurations?maxResults=0&nextToken=string&namePrefix=stringReturns a list of all of the worker configurations in this account and Region.
  • POSTCreate worker configuration/v1/worker-configurationsCreates a worker configuration using the specified properties.
  • GETDescribe connector/v1/connectors/:connectorArnReturns summary information about the connector.
  • PUTUpdate connector/v1/connectors/:connectorArn?currentVersion=stringUpdates the specified connector. In the request body, you can update either the connector's worker setting or its connector configuration, but not both in the…
  • DELETEDelete connector/v1/connectors/:connectorArn?currentVersion=stringDeletes the specified connector.
  • GETDescribe custom plugin/v1/custom-plugins/:customPluginArnA summary description of the custom plugin.
  • DELETEDelete custom plugin/v1/custom-plugins/:customPluginArnDeletes a custom plugin.
  • GETDescribe worker configuration/v1/worker-configurations/:workerConfigurationArnReturns information about a worker configuration.
  • DELETEDelete worker configuration/v1/worker-configurations/:workerConfigurationArnDeletes the specified worker configuration.
  • GETDescribe connector operation/v1/connectorOperations/:connectorOperationArnReturns information about the specified connector's operations.
  • GETList connector operations/v1/connectors/:connectorArn/operations?maxResults=0&nextToken=stringLists information about a connector's operation(s).
  • GETList tags for resource/v1/tags/:resourceArnLists all the tags attached to the specified resource.
  • POSTTag resource/v1/tags/:resourceArnAttaches tags to the specified resource.
  • DELETEUntag resource/v1/tags/:resourceArn?tagKeys=Removes tags from the specified resource.
  • PUTPause connector/v1/connectors/:connectorArn/pausePauses the specified connector. The operation runs asynchronously. To track the pause, pass the connector operation ARN from the response to…
  • POSTRestart connector/v1/connectors/:connectorArn/restart?onlyFailedTasks=trueRestarts the specified connector. By default, this operation restarts the connector and all of its tasks. This operation is asynchronous and returns a…
  • PUTResume connector/v1/connectors/:connectorArn/resumeResumes the specified paused connector. The operation runs asynchronously. To track the resume, pass the connector operation ARN from the response to…

API details

Base URL
https://kafkaconnect.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
21 operations on 12 pathsGET 9POST 5DELETE 4PUT 3
Description format
AWS Smithy model, API version 2021-09-14

How to test the Managed Streaming for Kafka Connect 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 Connect 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 connectors” (GET /v1/connectors?connectorNamePrefix=string&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 Connect?

Managed Streaming for Kafka Connect endpoints from Amazon Web Services, Inc. It is listed under Media & content and has 21 endpoints.

Who publishes the Managed Streaming for Kafka Connect?

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 Connect?

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

How do I authenticate with the Managed Streaming for Kafka Connect?

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

How many endpoints does the Managed Streaming for Kafka Connect have?

21 operations on 12 paths (9 GET, 5 POST, 4 DELETE, 3 PUT).

Is forking the Managed Streaming for Kafka Connect 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.