openapi-directory/api/amazonaws.com/kafka.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2018-11-14","x-release":"v4","title":"Managed Streaming for Kafka","description":"The operations for managing an Amazon MSK cluster.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","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-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-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/kafka/"},"security":[{"hmac":[]}],"paths":{"/v1/clusters":{"post":{"operationId":"CreateCluster","description":"Creates a new MSK cluster.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClusterResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"486":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClusterRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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":"ListClusters","description":"Returns a list of clusters in an account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClustersResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClustersRequest"}}},"required":true}}},"/v1/clusters/{clusterArn}":{"delete":{"operationId":"DeleteCluster","description":"Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteClusterResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"clusterArn","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteClusterRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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":"DescribeCluster","description":"Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeClusterResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"clusterArn","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeClusterRequest"}}},"required":true}}},"/v1/clusters/{clusterArn}/bootstrap-brokers":{"get":{"operationId":"GetBootstrapBrokers","description":"A list of brokers that a client application can use to bootstrap.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBootstrapBrokersResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"clusterArn","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBootstrapBrokersRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}]},"/v1/clusters/{clusterArn}/nodes":{"get":{"operationId":"ListNodes","description":"Returns a list of the broker nodes in the cluster.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNodesResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"483":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}}},"parameters":[{"name":"clusterArn","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNodesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}]}},"servers":[{"url":"https://kafka.amazonaws.com/"},{"url":"http://kafka.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateClusterResponse":{"type":"object","properties":{"ClusterArn":{"$ref":"#/components/schemas/__string"},"ClusterName":{"$ref":"#/components/schemas/__string"},"State":{"$ref":"#/components/schemas/ClusterState"}}},"CreateClusterRequest":{"type":"object","required":["BrokerNodeGroupInfo","KafkaVersion","NumberOfBrokerNodes","ClusterName"],"properties":{"BrokerNodeGroupInfo":{"$ref":"#/components/schemas/BrokerNodeGroupInfo"},"ClusterName":{"$ref":"#/components/schemas/__stringMin1Max64"},"EncryptionInfo":{"$ref":"#/components/schemas/EncryptionInfo"},"EnhancedMonitoring":{"$ref":"#/components/schemas/EnhancedMonitoring"},"KafkaVersion":{"$ref":"#/components/schemas/__stringMin1Max128"},"NumberOfBrokerNodes":{"$ref":"#/components/schemas/__integerMin1Max15"}}},"BadRequestException":{},"InternalServerErrorException":{},"UnauthorizedException":{},"ForbiddenException":{},"ServiceUnavailableException":{},"TooManyRequestsException":{},"ConflictException":{},"DeleteClusterResponse":{"type":"object","properties":{"ClusterArn":{"$ref":"#/components/schemas/__string"},"State":{"$ref":"#/components/schemas/ClusterState"}}},"DeleteClusterRequest":{"type":"object","properties":{}},"NotFoundException":{},"DescribeClusterResponse":{"type":"object","properties":{"ClusterInfo":{"$ref":"#/components/schemas/ClusterInfo"}}},"DescribeClusterRequest":{"type":"object","properties":{}},"GetBootstrapBrokersResponse":{"type":"object","properties":{"BootstrapBrokerString":{"$ref":"#/components/schemas/__string"}}},"GetBootstrapBrokersRequest":{"type":"object","properties":{}},"ListClustersResponse":{"type":"object","properties":{"ClusterInfoList":{"$ref":"#/components/schemas/__listOfClusterInfo"},"NextToken":{"$ref":"#/components/schemas/__string"}}},"ListClustersRequest":{"type":"object","properties":{}},"ListNodesResponse":{"type":"object","properties":{"NextToken":{"$ref":"#/components/schemas/__string"},"NodeInfoList":{"$ref":"#/components/schemas/__listOfNodeInfo"}}},"ListNodesRequest":{"type":"object","properties":{}},"BrokerAZDistribution":{"type":"string","enum":["DEFAULT"],"description":"The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among three Availability Zones. Currently, the only supported value is DEFAULT. You can either specify this value explicitly or leave it out."},"__listOf__string":{"type":"array","items":{"$ref":"#/components/schemas/__string"}},"__stringMin5Max32":{"type":"string","minLength":5,"maxLength":32},"StorageInfo":{"type":"object","properties":{"EbsStorageInfo":{"$ref":"#/components/schemas/EBSStorageInfo"}},"description":"Contains information about storage volumes attached to MSK broker nodes."},"BrokerNodeGroupInfo":{"type":"object","required":["ClientSubnets","InstanceType"],"properties":{"BrokerAZDistribution":{"$ref":"#/components/schemas/BrokerAZDistribution"},"ClientSubnets":{"$ref":"#/components/schemas/__listOf__string"},"InstanceType":{"$ref":"#/components/schemas/__stringMin5Max32"},"SecurityGroups":{"$ref":"#/components/schemas/__listOf__string"},"StorageInfo":{"$ref":"#/components/schemas/StorageInfo"}},"description":"Describes the setup to be used for Kafka broker nodes in the cluster."},"__string":{"type":"string"},"__double":{"type":"number","format":"double"},"BrokerSoftwareInfo":{"type":"object","properties":{"ConfigurationArn":{"$ref":"#/components/schemas/__string"},"ConfigurationRevision":{"$ref":"#/components/schemas/__string"},"KafkaVersion":{"$ref":"#/components/schemas/__string"}},"description":"Information about the current software installed on the cluster."},"BrokerNodeInfo":{"type":"object","properties":{"AttachedENIId":{"$ref":"#/components/schemas/__string"},"BrokerId":{"$ref":"#/components/schemas/__double"},"ClientSubnet":{"$ref":"#/components/schemas/__string"},"ClientVpcIpAddress":{"$ref":"#/components/schemas/__string"},"CurrentBrokerSoftwareInfo":{"$ref":"#/components/schemas/BrokerSoftwareInfo"}},"description":"BrokerNodeInfo"},"__timestampIso8601":{"type":"string","format":"date-time"},"EncryptionInfo":{"type":"object","properties":{"EncryptionAtRest":{"$ref":"#/components/schemas/EncryptionAtRest"}},"description":"Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest."},"EnhancedMonitoring":{"type":"string","enum":["DEFAULT","PER_BROKER","PER_TOPIC_PER_BROKER"],"description":"Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER."},"__integer":{"type":"integer"},"ClusterState":{"type":"string","enum":["ACTIVE","CREATING","DELETING","FAILED"],"description":"The state of a Kafka cluster."},"ClusterInfo":{"type":"object","properties":{"BrokerNodeGroupInfo":{"$ref":"#/components/schemas/BrokerNodeGroupInfo"},"ClusterArn":{"$ref":"#/components/schemas/__string"},"ClusterName":{"$ref":"#/components/schemas/__string"},"CreationTime":{"$ref":"#/components/schemas/__timestampIso8601"},"CurrentBrokerSoftwareInfo":{"$ref":"#/components/schemas/BrokerSoftwareInfo"},"CurrentVersion":{"$ref":"#/components/schemas/__string"},"EncryptionInfo":{"$ref":"#/components/schemas/EncryptionInfo"},"EnhancedMonitoring":{"$ref":"#/components/schemas/EnhancedMonitoring"},"NumberOfBrokerNodes":{"$ref":"#/components/schemas/__integer"},"State":{"$ref":"#/components/schemas/ClusterState"},"ZookeeperConnectString":{"$ref":"#/components/schemas/__string"}},"description":"Returns information about a cluster."},"__stringMin1Max64":{"type":"string","minLength":1,"maxLength":64},"__stringMin1Max128":{"type":"string","minLength":1,"maxLength":128},"__integerMin1Max15":{"type":"integer","minimum":1,"maximum":15},"__integerMin1Max16384":{"type":"integer","minimum":1,"maximum":16384},"EBSStorageInfo":{"type":"object","properties":{"VolumeSize":{"$ref":"#/components/schemas/__integerMin1Max16384"}},"description":"Contains information about the EBS storage volumes attached to Kafka broker nodes."},"EncryptionAtRest":{"type":"object","required":["DataVolumeKMSKeyId"],"properties":{"DataVolumeKMSKeyId":{"$ref":"#/components/schemas/__string"}},"description":"The data volume encryption details."},"MaxResults":{"type":"integer","minimum":1,"maximum":100},"__listOfClusterInfo":{"type":"array","items":{"$ref":"#/components/schemas/ClusterInfo"}},"__listOfNodeInfo":{"type":"array","items":{"$ref":"#/components/schemas/NodeInfo"}},"NodeType":{"type":"string","enum":["BROKER"],"description":"The broker or Zookeeper node."},"ZookeeperNodeInfo":{"type":"object","properties":{"AttachedENIId":{"$ref":"#/components/schemas/__string"},"ClientVpcIpAddress":{"$ref":"#/components/schemas/__string"},"ZookeeperId":{"$ref":"#/components/schemas/__double"},"ZookeeperVersion":{"$ref":"#/components/schemas/__string"}},"description":"Zookeeper node information."},"NodeInfo":{"type":"object","properties":{"AddedToClusterTime":{"$ref":"#/components/schemas/__string"},"BrokerNodeInfo":{"$ref":"#/components/schemas/BrokerNodeInfo"},"InstanceType":{"$ref":"#/components/schemas/__string"},"NodeARN":{"$ref":"#/components/schemas/__string"},"NodeType":{"$ref":"#/components/schemas/NodeType"},"ZookeeperNodeInfo":{"$ref":"#/components/schemas/ZookeeperNodeInfo"}},"description":"The node information object."}}}}