Skip to content

Commit fda331d

Browse files
author
AWS
committed
Managed Streaming for Kafka Update: New APIs for upgrading the Apache Kafka version of a cluster and to find out compatible upgrade paths
1 parent 7e660b2 commit fda331d

File tree

2 files changed

+226
-1
lines changed

2 files changed

+226
-1
lines changed

‎.changes/next-release/feature-ManagedStreamingforKafka-06654b3.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "Managed Streaming for Kafka",
4+
"description": "New APIs for upgrading the Apache Kafka version of a cluster and to find out compatible upgrade paths"
5+
}

‎services/kafka/src/main/resources/codegen-resources/service-2.json

Lines changed: 221 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,53 @@
335335
],
336336
"documentation": "\n <p>A list of brokers that a client application can use to bootstrap.</p>\n "
337337
},
338+
"GetCompatibleKafkaVersions" : {
339+
"name" : "GetCompatibleKafkaVersions",
340+
"http" : {
341+
"method" : "GET",
342+
"requestUri" : "/v1/compatible-kafka-versions",
343+
"responseCode" : 200
344+
},
345+
"input" : {
346+
"shape" : "GetCompatibleKafkaVersionsRequest"
347+
},
348+
"output" : {
349+
"shape" : "GetCompatibleKafkaVersionsResponse",
350+
"documentation": "\n <p>Successful response.</p>\n "
351+
},
352+
"errors" :
353+
[
354+
{
355+
"shape" : "BadRequestException",
356+
"documentation" : "n <p>The request isn't valid because the input is incorrect. Correct your input and then submit it again.</p>n "
357+
},
358+
{
359+
"shape" : "UnauthorizedException",
360+
"documentation" : "n <p>The request is not authorized. The provided credentials couldn't be validated.</p>n "
361+
},
362+
{
363+
"shape" : "InternalServerErrorException",
364+
"documentation" : "n <p>There was an unexpected internal server error. Retrying your request might resolve the issue.</p>n "
365+
},
366+
{
367+
"shape" : "ForbiddenException",
368+
"documentation" : "n <p>Access forbidden. Check your credentials and then retry your request.</p>n "
369+
},
370+
{
371+
"shape" : "NotFoundException",
372+
"documentation" : "n <p>The resource could not be found due to incorrect input. Correct the input, then retry the request.</p>n "
373+
},
374+
{
375+
"shape" : "ServiceUnavailableException",
376+
"documentation" : "n <p>503 response</p>n "
377+
},
378+
{
379+
"shape" : "TooManyRequestsException",
380+
"documentation" : "n <p>429 response</p>n "
381+
}
382+
],
383+
"documentation": "\n <p>Gets the Apache Kafka versions to which you can update the MSK cluster.</p>\n "
384+
},
338385
"ListClusterOperations": {
339386
"name": "ListClusterOperations",
340387
"http": {
@@ -750,6 +797,52 @@
750797
],
751798
"documentation": "\n <p>Updates the cluster with the configuration that is specified in the request body.</p>\n "
752799
},
800+
"UpdateClusterKafkaVersion" : {
801+
"name" : "UpdateClusterKafkaVersion",
802+
"http" : {
803+
"method" : "PUT",
804+
"requestUri" : "/v1/clusters/{clusterArn}/version",
805+
"responseCode" : 200
806+
},
807+
"input" : {
808+
"shape" : "UpdateClusterKafkaVersionRequest"
809+
},
810+
"output" : {
811+
"shape" : "UpdateClusterKafkaVersionResponse",
812+
"documentation" : "\n <p>Successful response.</p>\n "
813+
},
814+
"errors" : [
815+
{
816+
"shape" : "BadRequestException",
817+
"documentation" : "\n <p>The request isn't valid because the input is incorrect. Correct your input and then submit it again.</p>\n "
818+
},
819+
{
820+
"shape" : "UnauthorizedException",
821+
"documentation" : "\n <p>The request is not authorized. The provided credentials couldn't be validated.</p>\n "
822+
},
823+
{
824+
"shape" : "InternalServerErrorException",
825+
"documentation" : "\n <p>There was an unexpected internal server error. Retrying your request might resolve the issue.</p>\n "
826+
},
827+
{
828+
"shape" : "ForbiddenException",
829+
"documentation" : "\n <p>Access forbidden. Check your credentials and then retry your request.</p>\n "
830+
},
831+
{
832+
"shape" : "NotFoundException",
833+
"documentation" : "\n <p>The resource could not be found due to incorrect input. Correct the input, then retry the request.</p>\n "
834+
},
835+
{
836+
"shape" : "ServiceUnavailableException",
837+
"documentation" : "\n <p>503 response</p>\n "
838+
},
839+
{
840+
"shape" : "TooManyRequestsException",
841+
"documentation" : "\n <p>429 response</p>\n "
842+
}
843+
],
844+
"documentation": "\n <p>Updates the Apache Kafka version for the cluster.</p>\n "
845+
},
753846
"UpdateMonitoring" : {
754847
"name" : "UpdateMonitoring",
755848
"http" : {
@@ -1101,6 +1194,11 @@
11011194
"locationName": "operationState",
11021195
"documentation": "\n <p>State of the cluster operation.</p>\n "
11031196
},
1197+
"OperationSteps" : {
1198+
"shape" : "__listOfClusterOperationStep",
1199+
"locationName" : "operationSteps",
1200+
"documentation" : "\n <p>Steps completed during the operation.</p>\n "
1201+
},
11041202
"OperationType": {
11051203
"shape": "__string",
11061204
"locationName": "operationType",
@@ -1119,6 +1217,33 @@
11191217
},
11201218
"documentation": "\n <p>Returns information about a cluster operation.</p>\n "
11211219
},
1220+
"ClusterOperationStep" : {
1221+
"type" : "structure",
1222+
"members" : {
1223+
"StepInfo" : {
1224+
"shape" : "ClusterOperationStepInfo",
1225+
"locationName" : "stepInfo",
1226+
"documentation" : "\n <p>Information about the step and its status.</p>\n "
1227+
},
1228+
"StepName" : {
1229+
"shape" : "__string",
1230+
"locationName" : "stepName",
1231+
"documentation" : "\n <p>The name of the step.</p>\n "
1232+
}
1233+
},
1234+
"documentation" : "\n <p>Step taken during a cluster operation.</p>\n "
1235+
},
1236+
"ClusterOperationStepInfo" : {
1237+
"type" : "structure",
1238+
"members" : {
1239+
"StepStatus" : {
1240+
"shape" : "__string",
1241+
"locationName" : "stepStatus",
1242+
"documentation" : "\n <p>The steps current status.</p>\n "
1243+
}
1244+
},
1245+
"documentation" : "\n <p>State information about the operation step.</p>\n "
1246+
},
11221247
"ClusterState": {
11231248
"type": "string",
11241249
"documentation": "\n <p>The state of a Kafka cluster.</p>\n ",
@@ -1130,6 +1255,22 @@
11301255
"FAILED"
11311256
]
11321257
},
1258+
"CompatibleKafkaVersion" : {
1259+
"type" : "structure",
1260+
"members" : {
1261+
"SourceVersion" : {
1262+
"shape" : "__string",
1263+
"locationName" : "sourceVersion",
1264+
"documentation": "\n <p>A Kafka version.</p>\n "
1265+
},
1266+
"TargetVersions" : {
1267+
"shape" : "__listOf__string",
1268+
"locationName" : "targetVersions",
1269+
"documentation": "\n <p>A list of Kafka versions.</p>\n "
1270+
}
1271+
},
1272+
"documentation": "\n <p>Contains source Kafka versions and compatible target Kafka versions.</p>\n "
1273+
},
11331274
"Configuration": {
11341275
"type": "structure",
11351276
"members": {
@@ -1350,7 +1491,6 @@
13501491
},
13511492
"required": [
13521493
"ServerProperties",
1353-
"KafkaVersions",
13541494
"Name"
13551495
]
13561496
},
@@ -1723,6 +1863,27 @@
17231863
}
17241864
}
17251865
},
1866+
"GetCompatibleKafkaVersionsRequest" : {
1867+
"type" : "structure",
1868+
"members" : {
1869+
"ClusterArn" : {
1870+
"shape" : "__string",
1871+
"location" : "querystring",
1872+
"locationName" : "clusterArn",
1873+
"documentation": "\n <p>The Amazon Resource Name (ARN) of the cluster check.</p>\n "
1874+
}
1875+
}
1876+
},
1877+
"GetCompatibleKafkaVersionsResponse" : {
1878+
"type" : "structure",
1879+
"members" : {
1880+
"CompatibleKafkaVersions" : {
1881+
"shape" : "__listOfCompatibleKafkaVersion",
1882+
"locationName" : "compatibleKafkaVersions",
1883+
"documentation": "\n <p>A list of CompatibleKafkaVersion objects.</p>\n "
1884+
}
1885+
}
1886+
},
17261887
"InternalServerErrorException": {
17271888
"type": "structure",
17281889
"members": {
@@ -2053,6 +2214,11 @@
20532214
"locationName" : "openMonitoring",
20542215
"documentation" : "\n <p>The settings for open monitoring.</p>\n "
20552216
},
2217+
"KafkaVersion" : {
2218+
"shape" : "__string",
2219+
"locationName" : "kafkaVersion",
2220+
"documentation" : "\n <p>The Kafka version.</p>\n "
2221+
},
20562222
"LoggingInfo": {
20572223
"shape": "LoggingInfo",
20582224
"locationName": "loggingInfo"
@@ -2504,6 +2670,48 @@
25042670
}
25052671
}
25062672
},
2673+
"UpdateClusterKafkaVersionRequest" : {
2674+
"type" : "structure",
2675+
"members" : {
2676+
"ClusterArn" : {
2677+
"shape" : "__string",
2678+
"location" : "uri",
2679+
"locationName" : "clusterArn",
2680+
"documentation" : "\n <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>\n "
2681+
},
2682+
"ConfigurationInfo" : {
2683+
"shape" : "ConfigurationInfo",
2684+
"locationName" : "configurationInfo",
2685+
"documentation": "\n <p>The custom configuration that should be applied on the new version of cluster.</p>\n "
2686+
},
2687+
"CurrentVersion" : {
2688+
"shape" : "__string",
2689+
"locationName" : "currentVersion",
2690+
"documentation": "\n <p>Current cluster version.</p>\n "
2691+
},
2692+
"TargetKafkaVersion" : {
2693+
"shape" : "__string",
2694+
"locationName" : "targetKafkaVersion"
2695+
,"documentation": "\n <p>Target Kafka version.</p>\n "
2696+
}
2697+
},
2698+
"required" : [ "ClusterArn", "TargetKafkaVersion", "CurrentVersion" ]
2699+
},
2700+
"UpdateClusterKafkaVersionResponse" : {
2701+
"type" : "structure",
2702+
"members" : {
2703+
"ClusterArn" : {
2704+
"shape" : "__string",
2705+
"locationName" : "clusterArn",
2706+
"documentation": "\n <p>The Amazon Resource Name (ARN) of the cluster.</p>\n "
2707+
},
2708+
"ClusterOperationArn" : {
2709+
"shape" : "__string",
2710+
"locationName" : "clusterOperationArn",
2711+
"documentation": "\n <p>The Amazon Resource Name (ARN) of the cluster operation.</p>\n "
2712+
}
2713+
}
2714+
},
25072715
"UpdateMonitoringRequest" : {
25082716
"type" : "structure",
25092717
"members" : {
@@ -2622,6 +2830,18 @@
26222830
"shape": "ClusterOperationInfo"
26232831
}
26242832
},
2833+
"__listOfClusterOperationStep" : {
2834+
"type" : "list",
2835+
"member" : {
2836+
"shape" : "ClusterOperationStep"
2837+
}
2838+
},
2839+
"__listOfCompatibleKafkaVersion" : {
2840+
"type" : "list",
2841+
"member" : {
2842+
"shape" : "CompatibleKafkaVersion"
2843+
}
2844+
},
26252845
"__listOfConfiguration": {
26262846
"type": "list",
26272847
"member": {

0 commit comments

Comments
 (0)