openapi: 3.0.0 info: version: 2018-11-14 x-release: v4 title: Managed Streaming for Kafka Clusters Operations API description: "\n
The operations for managing an Amazon MSK cluster.
" x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: kafka x-aws-signingName: kafka x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kafka-2018-11-14.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://kafka.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kafka multi-region endpoint - url: https://kafka.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kafka multi-region endpoint - url: http://kafka.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kafka endpoint for China (Beijing) and China (Ningxia) - url: https://kafka.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kafka endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Operations paths: /v1/operations/{clusterOperationArn}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeClusterOperation description: "\nReturns a description of the cluster operation specified by the ARN.
" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeClusterOperationResponse' examples: DescribeClusterOperation200Example: summary: Default DescribeClusterOperation 200 response x-microcks-default: true value: ClusterOperationInfo: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeClusterOperation480Example: summary: Default DescribeClusterOperation 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeClusterOperation481Example: summary: Default DescribeClusterOperation 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: DescribeClusterOperation482Example: summary: Default DescribeClusterOperation 482 response x-microcks-default: true value: {} '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeClusterOperation483Example: summary: Default DescribeClusterOperation 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeClusterOperation484Example: summary: Default DescribeClusterOperation 484 response x-microcks-default: true value: {} parameters: - name: clusterOperationArn in: path required: true description: "\nThe Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
" schema: type: string summary: Amazon MSK Describe Cluster Operation x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Operations components: parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false schemas: __stringMin5Max32: type: string minLength: 5 maxLength: 32 DescribeClusterOperationResponse: type: object properties: ClusterOperationInfo: allOf: - $ref: '#/components/schemas/ClusterOperationInfo' - xml: name: clusterOperationInfo description: "\nCluster operation information
" Prometheus: type: object properties: JmxExporter: allOf: - $ref: '#/components/schemas/JmxExporter' - xml: name: jmxExporter description: "\nIndicates whether you want to turn on or turn off the JMX Exporter.
" NodeExporter: allOf: - $ref: '#/components/schemas/NodeExporter' - xml: name: nodeExporter description: "\nIndicates whether you want to turn on or turn off the Node Exporter.
" description: "\nPrometheus settings.
" __listOf__string: type: array items: $ref: '#/components/schemas/__string' ConfigurationInfo: type: object required: - Revision - Arn properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: "\nARN of the configuration to use.
" Revision: allOf: - $ref: '#/components/schemas/__long' - xml: name: revision description: "\nThe revision of the configuration to use.
" description: "\nSpecifies the configuration to use for the brokers.
" EncryptionInfo: type: object properties: EncryptionAtRest: allOf: - $ref: '#/components/schemas/EncryptionAtRest' - xml: name: encryptionAtRest description: "\nThe data-volume encryption details.
" EncryptionInTransit: allOf: - $ref: '#/components/schemas/EncryptionInTransit' - xml: name: encryptionInTransit description: "\nThe details for encryption in transit.
" description: "\nIncludes 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.
" Tls: type: object properties: CertificateAuthorityArnList: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: certificateAuthorityArnList description: "\nList of ACM Certificate Authority ARNs.
" Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\nSpecifies whether you want to turn on or turn off TLS authentication.
" description: "\nDetails for client authentication using TLS.
" ErrorInfo: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/__string' - xml: name: errorCode description: "\nA number describing the error programmatically.
" ErrorString: allOf: - $ref: '#/components/schemas/__string' - xml: name: errorString description: "\nAn optional field to provide more details about the error.
" description: "\nReturns information about an error state of the cluster.
" EncryptionAtRest: type: object required: - DataVolumeKMSKeyId properties: DataVolumeKMSKeyId: allOf: - $ref: '#/components/schemas/__string' - xml: name: dataVolumeKMSKeyId description: "\nThe ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
" description: "\nThe data-volume encryption details.
" __integer: type: integer S3: type: object required: - Enabled properties: Bucket: allOf: - $ref: '#/components/schemas/__string' - xml: name: bucket Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled Prefix: allOf: - $ref: '#/components/schemas/__string' - xml: name: prefix __long: type: integer CloudWatchLogs: type: object required: - Enabled properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled LogGroup: allOf: - $ref: '#/components/schemas/__string' - xml: name: logGroup Unauthenticated: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\nSpecifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
" Scram: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\nSASL/SCRAM authentication is enabled or not.
" description: "\nDetails for SASL/SCRAM client authentication.
" OpenMonitoring: type: object required: - Prometheus properties: Prometheus: allOf: - $ref: '#/components/schemas/Prometheus' - xml: name: prometheus description: "\nPrometheus settings.
" description: "\nJMX and Node monitoring for the MSK cluster.
" InternalServerErrorException: {} ProvisionedThroughput: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\nProvisioned throughput is enabled or not.
" VolumeThroughput: allOf: - $ref: '#/components/schemas/__integer' - xml: name: volumeThroughput description: "\nThroughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
" description: "\nContains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
" BrokerLogs: type: object properties: CloudWatchLogs: allOf: - $ref: '#/components/schemas/CloudWatchLogs' - xml: name: cloudWatchLogs Firehose: allOf: - $ref: '#/components/schemas/Firehose' - xml: name: firehose S3: allOf: - $ref: '#/components/schemas/S3' - xml: name: s3 ClientBroker: type: string enum: - TLS - TLS_PLAINTEXT - PLAINTEXT description: "\nClient-broker encryption in transit setting.
" NodeExporter: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabledInBroker description: "\nIndicates whether you want to turn on or turn off the Node Exporter.
" description: "\nIndicates whether you want to turn on or turn off the Node Exporter.
" ClusterOperationStepInfo: type: object properties: StepStatus: allOf: - $ref: '#/components/schemas/__string' - xml: name: stepStatus description: "\nThe steps current status.
" description: "\nState information about the operation step.
" Sasl: type: object properties: Scram: allOf: - $ref: '#/components/schemas/Scram' - xml: name: scram description: "\nDetails for SASL/SCRAM client authentication.
" Iam: allOf: - $ref: '#/components/schemas/Iam' - xml: name: iam description: "\nIndicates whether IAM access control is enabled.
" description: "\nDetails for client authentication using SASL.
" StorageMode: type: string enum: - LOCAL - TIERED description: Controls storage mode for various supported storage tiers. JmxExporter: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabledInBroker description: "\nIndicates whether you want to turn on or turn off the JMX Exporter.
" description: "\nIndicates whether you want to turn on or turn off the JMX Exporter.
" __listOfClusterOperationStep: type: array items: $ref: '#/components/schemas/ClusterOperationStep' ClusterOperationInfo: type: object properties: ClientRequestId: allOf: - $ref: '#/components/schemas/__string' - xml: name: clientRequestId description: "\nThe ID of the API request that triggered this operation.
" ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\nARN of the cluster.
" CreationTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - xml: name: creationTime description: "\nThe time that the operation was created.
" EndTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - xml: name: endTime description: "\nThe time at which the operation finished.
" ErrorInfo: allOf: - $ref: '#/components/schemas/ErrorInfo' - xml: name: errorInfo description: "\nDescribes the error if the operation fails.
" OperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: operationArn description: "\nARN of the cluster operation.
" OperationState: allOf: - $ref: '#/components/schemas/__string' - xml: name: operationState description: "\nState of the cluster operation.
" OperationSteps: allOf: - $ref: '#/components/schemas/__listOfClusterOperationStep' - xml: name: operationSteps description: "\nSteps completed during the operation.
" OperationType: allOf: - $ref: '#/components/schemas/__string' - xml: name: operationType description: "\nType of the cluster operation.
" SourceClusterInfo: allOf: - $ref: '#/components/schemas/MutableClusterInfo' - xml: name: sourceClusterInfo description: "\nInformation about cluster attributes before a cluster is updated.
" TargetClusterInfo: allOf: - $ref: '#/components/schemas/MutableClusterInfo' - xml: name: targetClusterInfo description: "\nInformation about cluster attributes after a cluster is updated.
" description: "\nReturns information about a cluster operation.
" EncryptionInTransit: type: object properties: ClientBroker: allOf: - $ref: '#/components/schemas/ClientBroker' - xml: name: clientBroker description: "\nIndicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
\n\n TLS means that client-broker communication is enabled with TLS only.
\n\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
\n\n PLAINTEXT means that client-broker communication is enabled in plaintext only.
\nThe default value is TLS_PLAINTEXT.
" InCluster: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: inCluster description: "\nWhen set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
\nThe default value is true.
" description: "\nThe settings for encrypting data in transit.
" ForbiddenException: {} UnauthorizedException: {} BadRequestException: {} __boolean: type: boolean __timestampIso8601: type: string format: date-time MutableClusterInfo: type: object properties: BrokerEBSVolumeInfo: allOf: - $ref: '#/components/schemas/__listOfBrokerEBSVolumeInfo' - xml: name: brokerEBSVolumeInfo description: "\nSpecifies the size of the EBS volume and the ID of the associated broker.
" ConfigurationInfo: allOf: - $ref: '#/components/schemas/ConfigurationInfo' - xml: name: configurationInfo description: "\nInformation about the changes in the configuration of the brokers.
" NumberOfBrokerNodes: allOf: - $ref: '#/components/schemas/__integer' - xml: name: numberOfBrokerNodes description: "\nThe number of broker nodes in the cluster.
" EnhancedMonitoring: allOf: - $ref: '#/components/schemas/EnhancedMonitoring' - xml: name: enhancedMonitoring description: "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
" OpenMonitoring: allOf: - $ref: '#/components/schemas/OpenMonitoring' - xml: name: openMonitoring description: "\nThe settings for open monitoring.
" KafkaVersion: allOf: - $ref: '#/components/schemas/__string' - xml: name: kafkaVersion description: "\nThe Apache Kafka version.
" LoggingInfo: allOf: - $ref: '#/components/schemas/LoggingInfo' - xml: name: loggingInfo description: "\nYou can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
" InstanceType: allOf: - $ref: '#/components/schemas/__stringMin5Max32' - xml: name: instanceType description: "\nInformation about the Amazon MSK broker type.
" ClientAuthentication: allOf: - $ref: '#/components/schemas/ClientAuthentication' - xml: name: clientAuthentication description: "\nIncludes all client authentication information.
" EncryptionInfo: allOf: - $ref: '#/components/schemas/EncryptionInfo' - xml: name: encryptionInfo description: "\nIncludes all encryption-related information.
" ConnectivityInfo: allOf: - $ref: '#/components/schemas/ConnectivityInfo' - xml: name: connectivityInfo description: "\nInformation about the broker access configuration.
" StorageMode: allOf: - $ref: '#/components/schemas/StorageMode' - xml: name: storageMode description: "\nThis controls storage mode for supported storage tiers.
" description: "\nInformation about cluster attributes that can be updated via update APIs.
" PublicAccess: type: object properties: Type: allOf: - $ref: '#/components/schemas/__string' - xml: name: type description: "\nThe value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
" description: Public access control for brokers. NotFoundException: {} ClusterOperationStep: type: object properties: StepInfo: allOf: - $ref: '#/components/schemas/ClusterOperationStepInfo' - xml: name: stepInfo description: "\nInformation about the step and its status.
" StepName: allOf: - $ref: '#/components/schemas/__string' - xml: name: stepName description: "\nThe name of the step.
" description: "\nStep taken during a cluster operation.
" ConnectivityInfo: type: object properties: PublicAccess: allOf: - $ref: '#/components/schemas/PublicAccess' - xml: name: publicAccess description: "\nPublic access control for brokers.
" description: "\nInformation about the broker access configuration.
" Firehose: type: object required: - Enabled properties: DeliveryStream: allOf: - $ref: '#/components/schemas/__string' - xml: name: deliveryStream Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled ClientAuthentication: type: object properties: Sasl: allOf: - $ref: '#/components/schemas/Sasl' - xml: name: sasl description: "\nDetails for ClientAuthentication using SASL.
" Tls: allOf: - $ref: '#/components/schemas/Tls' - xml: name: tls description: "\nDetails for ClientAuthentication using TLS.
" Unauthenticated: allOf: - $ref: '#/components/schemas/Unauthenticated' - xml: name: unauthenticated description: "\nContains information about unauthenticated traffic to the cluster.
" description: "\nIncludes all client authentication information.
" EnhancedMonitoring: type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION description: "\nSpecifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
" __string: type: string __listOfBrokerEBSVolumeInfo: type: array items: $ref: '#/components/schemas/BrokerEBSVolumeInfo' BrokerEBSVolumeInfo: type: object required: - KafkaBrokerNodeId properties: KafkaBrokerNodeId: allOf: - $ref: '#/components/schemas/__string' - xml: name: kafkaBrokerNodeId description: "\nThe ID of the broker to update.
" ProvisionedThroughput: allOf: - $ref: '#/components/schemas/ProvisionedThroughput' - xml: name: provisionedThroughput description: "\nEBS volume provisioned throughput information.
" VolumeSizeGB: allOf: - $ref: '#/components/schemas/__integer' - xml: name: volumeSizeGB description: "\nSize of the EBS volume to update.
" description: "\nSpecifies 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 cluster.
" LoggingInfo: type: object required: - BrokerLogs properties: BrokerLogs: allOf: - $ref: '#/components/schemas/BrokerLogs' - xml: name: brokerLogs Iam: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\nIndicates whether IAM access control is enabled.
" description: "\nDetails for IAM access control.
" securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/kafka/ x-hasEquivalentPaths: true