Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Parameters:
-
cluster_arn
(__string)
–
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Raises:
Source code in docs_src/capo_kafka/_services/kafka.py
| def describe_cluster(
self,
cluster_arn: "capo_kafka.types.__string.__string",
*,
config_overrides: Optional[KafkaClientConfig] = None,
) -> "capo_kafka.types.describe_cluster_response.DescribeClusterResponse":
"""<p>Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.</p>
Args:
cluster_arn: <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
Raises:
capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
capo_kafka.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kafka.types.describe_cluster_request.DescribeClusterRequest]",
) -> OperationResponse[
"capo_kafka.types.describe_cluster_response.DescribeClusterResponse"
]:
import capo_kafka._operations.kafka.describe_cluster
output, http_response = (
capo_kafka._operations.kafka.describe_cluster.describe_cluster(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeCluster")
)
input_: capo_kafka.types.describe_cluster_request.DescribeClusterRequest = {
"cluster_arn": cluster_arn
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|