Skip to content

Commit 80f1fbb

Browse files
author
AWS
committed
Managed Streaming for Kafka Update: Amazon MSK has introduced new versions of ListClusterOperations and DescribeClusterOperation APIs. These v2 APIs provide information and insights into the ongoing operations of both MSK Provisioned and MSK Serverless clusters.
1 parent 9e89668 commit 80f1fbb

File tree

3 files changed

+315
-0
lines changed

3 files changed

+315
-0
lines changed

‎.changes/next-release/feature-ManagedStreamingforKafka-f746510.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Managed Streaming for Kafka",
4+
"contributor": "",
5+
"description": "Amazon MSK has introduced new versions of ListClusterOperations and DescribeClusterOperation APIs. These v2 APIs provide information and insights into the ongoing operations of both MSK Provisioned and MSK Serverless clusters."
6+
}

‎services/kafka/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@
3636
"limit_key": "MaxResults",
3737
"result_key": "ClusterOperationInfoList"
3838
},
39+
"ListClusterOperationsV2": {
40+
"input_token": "NextToken",
41+
"output_token": "NextToken",
42+
"limit_key": "MaxResults",
43+
"result_key": "ClusterOperationInfoList"
44+
},
3945
"ListConfigurationRevisions": {
4046
"input_token": "NextToken",
4147
"output_token": "NextToken",

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

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,44 @@
478478
],
479479
"documentation": "\n <p>Returns a description of the cluster operation specified by the ARN.</p>\n "
480480
},
481+
"DescribeClusterOperationV2" : {
482+
"name" : "DescribeClusterOperationV2",
483+
"http" : {
484+
"method" : "GET",
485+
"requestUri" : "/api/v2/operations/{clusterOperationArn}",
486+
"responseCode" : 200
487+
},
488+
"input" : {
489+
"shape" : "DescribeClusterOperationV2Request"
490+
},
491+
"output" : {
492+
"shape" : "DescribeClusterOperationV2Response",
493+
"documentation" : "\n <p>HTTP Status Code 200: OK.</p>"
494+
},
495+
"errors" : [ {
496+
"shape" : "BadRequestException",
497+
"documentation" : "\n <p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p>"
498+
}, {
499+
"shape" : "UnauthorizedException",
500+
"documentation" : "\n <p>HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.</p>"
501+
}, {
502+
"shape" : "InternalServerErrorException",
503+
"documentation" : "\n <p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p>"
504+
}, {
505+
"shape" : "ForbiddenException",
506+
"documentation" : "\n <p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p>"
507+
}, {
508+
"shape" : "NotFoundException",
509+
"documentation" : "\n <p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p>"
510+
}, {
511+
"shape" : "ServiceUnavailableException",
512+
"documentation" : "\n <p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.</p>"
513+
}, {
514+
"shape" : "TooManyRequestsException",
515+
"documentation" : "\n <p>HTTP Status Code 429: Limit exceeded. Resource limit reached.</p>"
516+
} ],
517+
"documentation" : "\n <p>Returns a description of the cluster operation specified by the ARN.</p>\n"
518+
},
481519
"DescribeConfiguration": {
482520
"name": "DescribeConfiguration",
483521
"http": {
@@ -795,6 +833,44 @@
795833
],
796834
"documentation": "\n <p>Returns a list of all the operations that have been performed on the specified MSK cluster.</p>\n "
797835
},
836+
"ListClusterOperationsV2" : {
837+
"name" : "ListClusterOperationsV2",
838+
"http" : {
839+
"method" : "GET",
840+
"requestUri" : "/api/v2/clusters/{clusterArn}/operations",
841+
"responseCode" : 200
842+
},
843+
"input" : {
844+
"shape" : "ListClusterOperationsV2Request"
845+
},
846+
"output" : {
847+
"shape" : "ListClusterOperationsV2Response",
848+
"documentation" : "\n <p>HTTP Status Code 200: OK.</p>"
849+
},
850+
"errors" : [ {
851+
"shape" : "BadRequestException",
852+
"documentation" : "\n <p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p>"
853+
}, {
854+
"shape" : "UnauthorizedException",
855+
"documentation" : "\n <p>HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.</p>"
856+
}, {
857+
"shape" : "InternalServerErrorException",
858+
"documentation" : "\n <p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p>"
859+
}, {
860+
"shape" : "ForbiddenException",
861+
"documentation" : "\n <p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p>"
862+
}, {
863+
"shape" : "NotFoundException",
864+
"documentation" : "\n <p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p>"
865+
}, {
866+
"shape" : "ServiceUnavailableException",
867+
"documentation" : "\n <p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.</p>"
868+
}, {
869+
"shape" : "TooManyRequestsException",
870+
"documentation" : "\n <p>HTTP Status Code 429: Limit exceeded. Resource limit reached.</p>"
871+
} ],
872+
"documentation" : "\n <p>Returns a list of all the operations that have been performed on the specified MSK cluster.</p>\n "
873+
},
798874
"ListClusters": {
799875
"name": "ListClusters",
800876
"http": {
@@ -2977,6 +3053,140 @@
29773053
}
29783054
}
29793055
},
3056+
"ClusterOperationV2" : {
3057+
"type" : "structure",
3058+
"members" : {
3059+
"ClusterArn" : {
3060+
"shape" : "__string",
3061+
"locationName" : "clusterArn",
3062+
"documentation" : "\n <p>ARN of the cluster.</p>"
3063+
},
3064+
"ClusterType" : {
3065+
"shape" : "ClusterType",
3066+
"locationName" : "clusterType",
3067+
"documentation" : "\n <p>Type of the backend cluster.</p>"
3068+
},
3069+
"StartTime" : {
3070+
"shape" : "__timestampIso8601",
3071+
"locationName" : "startTime",
3072+
"documentation" : "\n <p>The time at which operation was started.</p>"
3073+
},
3074+
"EndTime" : {
3075+
"shape" : "__timestampIso8601",
3076+
"locationName" : "endTime",
3077+
"documentation" : "\n <p>The time at which the operation finished.</p>"
3078+
},
3079+
"ErrorInfo" : {
3080+
"shape" : "ErrorInfo",
3081+
"locationName" : "errorInfo",
3082+
"documentation" : "\n <p>If cluster operation failed from an error, it describes the error.</p>"
3083+
},
3084+
"OperationArn" : {
3085+
"shape" : "__string",
3086+
"locationName" : "operationArn",
3087+
"documentation" : "\n <p>ARN of the cluster operation.</p>"
3088+
},
3089+
"OperationState" : {
3090+
"shape" : "__string",
3091+
"locationName" : "operationState",
3092+
"documentation" : "\n <p>State of the cluster operation.</p>"
3093+
},
3094+
"OperationType" : {
3095+
"shape" : "__string",
3096+
"locationName" : "operationType",
3097+
"documentation" : "\n <p>Type of the cluster operation.</p>"
3098+
},
3099+
"Provisioned" : {
3100+
"shape" : "ClusterOperationV2Provisioned",
3101+
"locationName" : "provisioned",
3102+
"documentation" : "\n <p>Properties of a provisioned cluster.</p>"
3103+
},
3104+
"Serverless" : {
3105+
"shape" : "ClusterOperationV2Serverless",
3106+
"locationName" : "serverless",
3107+
"documentation" : "\n <p>Properties of a serverless cluster.</p>"
3108+
}
3109+
},
3110+
"documentation" : "\n <p>Returns information about a cluster operation.</p>"
3111+
},
3112+
"ClusterOperationV2Provisioned" : {
3113+
"type" : "structure",
3114+
"members" : {
3115+
"OperationSteps" : {
3116+
"shape" : "__listOfClusterOperationStep",
3117+
"locationName" : "operationSteps",
3118+
"documentation" : "\n <p>Steps completed during the operation.</p>"
3119+
},
3120+
"SourceClusterInfo" : {
3121+
"shape" : "MutableClusterInfo",
3122+
"locationName" : "sourceClusterInfo",
3123+
"documentation" : "\n <p>Information about cluster attributes before a cluster is updated.</p>"
3124+
},
3125+
"TargetClusterInfo" : {
3126+
"shape" : "MutableClusterInfo",
3127+
"locationName" : "targetClusterInfo",
3128+
"documentation" : "\n <p>Information about cluster attributes after a cluster is updated.</p>"
3129+
},
3130+
"VpcConnectionInfo" : {
3131+
"shape" : "VpcConnectionInfo",
3132+
"locationName" : "vpcConnectionInfo",
3133+
"documentation" : "\n <p>Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.</p>"
3134+
}
3135+
},
3136+
"documentation" : "\n <p>Returns information about a provisioned cluster operation.</p>"
3137+
},
3138+
"ClusterOperationV2Serverless" : {
3139+
"type" : "structure",
3140+
"members" : {
3141+
"VpcConnectionInfo" : {
3142+
"shape" : "VpcConnectionInfoServerless",
3143+
"locationName" : "vpcConnectionInfo",
3144+
"documentation" : "\n <p>Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.</p>"
3145+
}
3146+
},
3147+
"documentation" : "\n <p>Returns information about a serverless cluster operation.</p>"
3148+
},
3149+
"ClusterOperationV2Summary" : {
3150+
"type" : "structure",
3151+
"members" : {
3152+
"ClusterArn" : {
3153+
"shape" : "__string",
3154+
"locationName" : "clusterArn",
3155+
"documentation" : "\n <p>ARN of the cluster.</p>"
3156+
},
3157+
"ClusterType" : {
3158+
"shape" : "ClusterType",
3159+
"locationName" : "clusterType",
3160+
"documentation" : "\n <p>Type of the backend cluster.</p>"
3161+
},
3162+
"StartTime" : {
3163+
"shape" : "__timestampIso8601",
3164+
"locationName" : "startTime",
3165+
"documentation" : "\n <p>The time at which operation was started.</p>"
3166+
},
3167+
"EndTime" : {
3168+
"shape" : "__timestampIso8601",
3169+
"locationName" : "endTime",
3170+
"documentation" : "\n <p>The time at which the operation finished.</p>"
3171+
},
3172+
"OperationArn" : {
3173+
"shape" : "__string",
3174+
"locationName" : "operationArn",
3175+
"documentation" : "\n <p>ARN of the cluster operation.</p>"
3176+
},
3177+
"OperationState" : {
3178+
"shape" : "__string",
3179+
"locationName" : "operationState",
3180+
"documentation" : "\n <p>State of the cluster operation.</p>"
3181+
},
3182+
"OperationType" : {
3183+
"shape" : "__string",
3184+
"locationName" : "operationType",
3185+
"documentation" : "\n <p>Type of the cluster operation.</p>"
3186+
}
3187+
},
3188+
"documentation" : "\n <p>Returns information about a cluster operation.</p>"
3189+
},
29803190
"DeleteClusterRequest": {
29813191
"type": "structure",
29823192
"members": {
@@ -3103,6 +3313,18 @@
31033313
"ClusterOperationArn"
31043314
]
31053315
},
3316+
"DescribeClusterOperationV2Request" : {
3317+
"type" : "structure",
3318+
"members" : {
3319+
"ClusterOperationArn" : {
3320+
"shape" : "__string",
3321+
"location" : "uri",
3322+
"locationName" : "clusterOperationArn",
3323+
"documentation" : "ARN of the cluster operation to describe."
3324+
}
3325+
},
3326+
"required" : [ "ClusterOperationArn" ]
3327+
},
31063328
"DescribeClusterOperationResponse": {
31073329
"type": "structure",
31083330
"members": {
@@ -3113,6 +3335,16 @@
31133335
}
31143336
}
31153337
},
3338+
"DescribeClusterOperationV2Response" : {
3339+
"type" : "structure",
3340+
"members" : {
3341+
"ClusterOperationInfo" : {
3342+
"shape" : "ClusterOperationV2",
3343+
"locationName" : "clusterOperationInfo",
3344+
"documentation" : "\n <p>Cluster operation information</p>"
3345+
}
3346+
}
3347+
},
31163348
"DescribeClusterRequest": {
31173349
"type": "structure",
31183350
"members": {
@@ -3690,6 +3922,30 @@
36903922
"ClusterArn"
36913923
]
36923924
},
3925+
"ListClusterOperationsV2Request" : {
3926+
"type" : "structure",
3927+
"members" : {
3928+
"ClusterArn" : {
3929+
"shape" : "__string",
3930+
"location" : "uri",
3931+
"locationName" : "clusterArn",
3932+
"documentation" : "The arn of the cluster whose operations are being requested."
3933+
},
3934+
"MaxResults" : {
3935+
"shape" : "MaxResults",
3936+
"location" : "querystring",
3937+
"locationName" : "maxResults",
3938+
"documentation" : "The maxResults of the query."
3939+
},
3940+
"NextToken" : {
3941+
"shape" : "__string",
3942+
"location" : "querystring",
3943+
"locationName" : "nextToken",
3944+
"documentation" : "The nextToken of the query."
3945+
}
3946+
},
3947+
"required" : [ "ClusterArn" ]
3948+
},
36933949
"ListClusterOperationsResponse": {
36943950
"type": "structure",
36953951
"members": {
@@ -3705,6 +3961,21 @@
37053961
}
37063962
}
37073963
},
3964+
"ListClusterOperationsV2Response" : {
3965+
"type" : "structure",
3966+
"members" : {
3967+
"ClusterOperationInfoList" : {
3968+
"shape" : "__listOfClusterOperationV2Summary",
3969+
"locationName" : "clusterOperationInfoList",
3970+
"documentation" : "\n <p>An array of cluster operation information objects.</p>"
3971+
},
3972+
"NextToken" : {
3973+
"shape" : "__string",
3974+
"locationName" : "nextToken",
3975+
"documentation" : "\n <p>If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.</p>"
3976+
}
3977+
}
3978+
},
37083979
"ListClustersRequest": {
37093980
"type": "structure",
37103981
"members": {
@@ -5195,6 +5466,32 @@
51955466
},
51965467
"documentation": "\n <p>Description of the VPC connection.</p>\n "
51975468
},
5469+
"VpcConnectionInfoServerless" : {
5470+
"type" : "structure",
5471+
"members" : {
5472+
"CreationTime" : {
5473+
"shape" : "__timestampIso8601",
5474+
"locationName" : "creationTime",
5475+
"documentation" : "\n <p>The time when Amazon MSK creates the VPC Connnection.</p>"
5476+
},
5477+
"Owner" : {
5478+
"shape" : "__string",
5479+
"locationName" : "owner",
5480+
"documentation" : "\n <p>The owner of the VPC Connection.</p>"
5481+
},
5482+
"UserIdentity" : {
5483+
"shape" : "UserIdentity",
5484+
"locationName" : "userIdentity",
5485+
"documentation" : "\n <p>Description of the requester that calls the API operation.</p>"
5486+
},
5487+
"VpcConnectionArn" : {
5488+
"shape" : "__string",
5489+
"locationName" : "vpcConnectionArn",
5490+
"documentation" : "\n <p>The Amazon Resource Name (ARN) of the VPC connection.</p>"
5491+
}
5492+
},
5493+
"documentation" : "Description of the VPC connection."
5494+
},
51985495
"VpcConnectionState": {
51995496
"type": "string",
52005497
"documentation": "\n <p>The state of a VPC connection.</p>\n ",
@@ -5297,6 +5594,12 @@
52975594
"shape": "ClusterOperationInfo"
52985595
}
52995596
},
5597+
"__listOfClusterOperationV2Summary" : {
5598+
"type" : "list",
5599+
"member" : {
5600+
"shape" : "ClusterOperationV2Summary"
5601+
}
5602+
},
53005603
"__listOfClusterOperationStep" : {
53015604
"type" : "list",
53025605
"member" : {

0 commit comments

Comments
 (0)