Skip to content

update_agent_recommendation_status

update_agent_recommendation_status(
    recommendation_arn: AgentRecommendationArn,
    status: RecommendationStatus,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    update_reason: Optional[SensitiveString] = None,
) -> UpdateAgentRecommendationStatusResponse

Updates the status of a recommendation to track its progress through the implementation lifecycle.

Parameters:

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def update_agent_recommendation_status(
    self,
    recommendation_arn: "capo_wellarchitected.types.agent_recommendation_arn.AgentRecommendationArn",
    status: "capo_wellarchitected.types.recommendation_status.RecommendationStatus",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    update_reason: Optional[
        "capo_wellarchitected.types.sensitive_string.SensitiveString"
    ] = None,
) -> "capo_wellarchitected.types.update_agent_recommendation_status_response.UpdateAgentRecommendationStatusResponse":
    """<p>Updates the status of a recommendation to track its progress through the implementation lifecycle.</p>

    Args:
        recommendation_arn: <p>The Amazon Resource Name (ARN) of the recommendation to update.</p>
        status: <p>The new status to assign to the recommendation.</p>
        update_reason: <p>A free-text reason explaining this status update.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.update_agent_recommendation_status_request.UpdateAgentRecommendationStatusRequest]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.update_agent_recommendation_status_response.UpdateAgentRecommendationStatusResponse"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.update_agent_recommendation_status

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.update_agent_recommendation_status.update_agent_recommendation_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_wellarchitected.types.update_agent_recommendation_status_request.UpdateAgentRecommendationStatusRequest",
    ) -> dict[str, Any]:
        import capo_wellarchitected.types.update_agent_recommendation_status_request

        return capo_wellarchitected.types.update_agent_recommendation_status_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAgentRecommendationStatus", redact_input=_redact_input
        ),
    )
    input_: capo_wellarchitected.types.update_agent_recommendation_status_request.UpdateAgentRecommendationStatusRequest = {
        "recommendation_arn": recommendation_arn,
        "status": status,
    }
    if update_reason is not None:
        input_["update_reason"] = update_reason

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