Skip to content

describe_code_review 

describe_code_review(
    code_review_arn: Arn,
    *,
    config_overrides: Optional[CodeGuruReviewerClientConfig] = None,
) -> DescribeCodeReviewResponse

Returns the metadata associated with the code review along with its status.

Parameters:

  • code_review_arn (Arn) –

    The Amazon Resource Name (ARN) of the CodeReview object.

Raises:

Source code in docs_src/capo_codeguru_reviewer/_services/code_guru_reviewer.py 
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
def describe_code_review(
    self,
    code_review_arn: "capo_codeguru_reviewer.types.arn.Arn",
    *,
    config_overrides: Optional[CodeGuruReviewerClientConfig] = None,
) -> "capo_codeguru_reviewer.types.describe_code_review_response.DescribeCodeReviewResponse":
    """<p>Returns the metadata associated with the code review along with its status.</p>

    Args:
        code_review_arn: <p>The Amazon Resource Name (ARN) of the <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html">CodeReview</a> object. </p>

    Raises:
        capo_codeguru_reviewer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_codeguru_reviewer.errors.internal_server_exception.InternalServerException: <p>The server encountered an internal error and is unable to complete the request.</p>
        capo_codeguru_reviewer.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource specified in the request was not found. </p>
        capo_codeguru_reviewer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codeguru_reviewer.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_codeguru_reviewer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codeguru_reviewer.types.describe_code_review_request.DescribeCodeReviewRequest]",
    ) -> OperationResponse[
        "capo_codeguru_reviewer.types.describe_code_review_response.DescribeCodeReviewResponse"
    ]:
        import capo_codeguru_reviewer._operations.aws_guru_frontend_service.describe_code_review

        output, http_response = (
            capo_codeguru_reviewer._operations.aws_guru_frontend_service.describe_code_review.describe_code_review(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCodeReview")
    )
    input_: capo_codeguru_reviewer.types.describe_code_review_request.DescribeCodeReviewRequest = {
        "code_review_arn": code_review_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output