Skip to content

list_recommendations 

list_recommendations(
    code_review_arn: Arn,
    *,
    config_overrides: Optional[CodeGuruReviewerClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[ListRecommendationsMaxResults] = None,
) -> ListRecommendationsResponse

Returns the list of all recommendations for a completed code review.

Parameters:

Raises:

Source code in docs_src/capo_codeguru_reviewer/_services/code_guru_reviewer.py 
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
def list_recommendations(
    self,
    code_review_arn: "capo_codeguru_reviewer.types.arn.Arn",
    *,
    config_overrides: Optional[CodeGuruReviewerClientConfig] = None,
    next_token: Optional[
        "capo_codeguru_reviewer.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_codeguru_reviewer.types.list_recommendations_max_results.ListRecommendationsMaxResults"
    ] = None,
) -> "capo_codeguru_reviewer.types.list_recommendations_response.ListRecommendationsResponse":
    """<p>Returns the list of all recommendations for a completed code review.</p>

    Args:
        next_token: <p>Pagination token.</p>
        max_results: <p>The maximum number of results that are returned per call. The default is 100.</p>
        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.list_recommendations_request.ListRecommendationsRequest]",
    ) -> OperationResponse[
        "capo_codeguru_reviewer.types.list_recommendations_response.ListRecommendationsResponse"
    ]:
        import capo_codeguru_reviewer._operations.aws_guru_frontend_service.list_recommendations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecommendations")
    )
    input_: capo_codeguru_reviewer.types.list_recommendations_request.ListRecommendationsRequest = {
        "code_review_arn": code_review_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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