How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon MSK Operations API

The Operations API from Amazon MSK — 1 operation(s) for operations.

Amazon MSK Operations API is one of 6 APIs that Amazon MSK publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 1 operation across 1 path, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 2018-11-14.

Requests are made against 4 base URLs: http://kafka.{region}.amazonaws.com, https://kafka.{region}.amazonaws.com, http://kafka.{region}.amazonaws.com.cn, https://kafka.{region}.amazonaws.com.cn.

1 operations 1 paths 46 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2018-11-14
Base URL
http://kafka.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon MSK Operations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Operations 1
GET
/v1/operations/{clusterOperationArn}
Amazon MSK Describe Cluster Operation
DescribeClusterOperation 8 params → 200480481482483484

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are MutableClusterInfo (12 properties), ClusterOperationInfo (11 properties), ClientAuthentication (3 properties), BrokerLogs (3 properties). Each schema is shown below with its type and property counts.

JmxExporter
object
Indicates whether you want to turn on or turn off the JMX Exporter.
1 property 1 required
Tls
object
Details for client authentication using TLS.
2 properties
PublicAccess
object
Public access control for brokers.
1 property
__integer
integer
Sasl
object
Details for client authentication using SASL.
2 properties
Iam
object
Details for IAM access control.
1 property
EncryptionInfo
object
Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
2 properties
StorageMode
string
Controls storage mode for various supported storage tiers.
ClusterOperationInfo
object
Returns information about a cluster operation.
11 properties
ClientAuthentication
object
Includes all client authentication information.
3 properties
S3
object
3 properties 1 required
ConfigurationInfo
object
Specifies the configuration to use for the brokers.
2 properties 2 required
__listOfBrokerEBSVolumeInfo
array
__timestampIso8601
string
__boolean
boolean
BrokerLogs
object
3 properties
InternalServerErrorException
NodeExporter
object
Indicates whether you want to turn on or turn off the Node Exporter.
1 property 1 required
ProvisionedThroughput
object
Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
2 properties
EnhancedMonitoring
string
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PERBROKER, PERTOPICPERBROKER, and PERTOPICP…
Firehose
object
2 properties 1 required
__listOfClusterOperationStep
array
ClientBroker
string
Client-broker encryption in transit setting.
ConnectivityInfo
object
Information about the broker access configuration.
1 property
Scram
object
Details for SASL/SCRAM client authentication.
1 property
BrokerEBSVolumeInfo
object
Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the clus…
3 properties 1 required
OpenMonitoring
object
JMX and Node monitoring for the MSK cluster.
1 property 1 required
UnauthorizedException
ErrorInfo
object
Returns information about an error state of the cluster.
2 properties
ForbiddenException
EncryptionAtRest
object
The data-volume encryption details.
1 property 1 required
NotFoundException
ClusterOperationStepInfo
object
State information about the operation step.
1 property
CloudWatchLogs
object
2 properties 1 required
EncryptionInTransit
object
The settings for encrypting data in transit.
2 properties
__long
integer
DescribeClusterOperationResponse
object
1 property
Prometheus
object
Prometheus settings.
2 properties
BadRequestException
MutableClusterInfo
object
Information about cluster attributes that can be updated via update APIs.
12 properties
__stringMin5Max32
string
__listOf__string
array
ClusterOperationStep
object
Step taken during a cluster operation.
2 properties
LoggingInfo
object
1 property 1 required
Unauthenticated
object
1 property
__string
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-msk-operations-api-openapi.yml Raw ↑

Other APIs Amazon MSK publishes across the network.

Amazon MSK Clusters API
Amazon MSK Compatible Kafka Versions API
Amazon MSK Configurations API
Amazon MSK Kafka Versions API
Amazon MSK Tags API
Where this information came from

This is an independent, third-party profile of Amazon MSK Operations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.