Skip to content

update_recommendation

update_recommendation(
    agent_space_id: AgentSpaceIdentifier,
    recommendation_id: ResourceId,
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
    status: Optional[RecommendationStatus] = None,
    additional_context: Optional[str] = None,
    client_token: Optional[str] = None,
) -> UpdateRecommendationResponse

Updates an existing recommendation with new content, status, or metadata

Parameters:

  • agent_space_id (AgentSpaceIdentifier) –

    The unique identifier for the agent space containing the recommendation

  • recommendation_id (ResourceId) –

    The unique identifier for the recommendation to update

  • status (Optional[RecommendationStatus], default: None ) –

    Current status of the recommendation

  • additional_context (Optional[str], default: None ) –

    Additional context for recommendation

  • client_token (Optional[str], default: None ) –

    A unique token that ensures idempotency of the request

Raises:

Source code in docs_src/capo_devops_agent/_services/dev_ops_agent.py
def update_recommendation(
    self,
    agent_space_id: "capo_devops_agent.types.agent_space_identifier.AgentSpaceIdentifier",
    recommendation_id: "capo_devops_agent.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
    status: Optional[
        "capo_devops_agent.types.recommendation_status.RecommendationStatus"
    ] = None,
    additional_context: Optional[str] = None,
    client_token: Optional[str] = None,
) -> "capo_devops_agent.types.update_recommendation_response.UpdateRecommendationResponse":
    """<p>Updates an existing recommendation with new content, status, or metadata</p>

    Args:
        agent_space_id: <p>The unique identifier for the agent space containing the recommendation</p>
        recommendation_id: <p>The unique identifier for the recommendation to update</p>
        status: <p>Current status of the recommendation</p>
        additional_context: <p>Additional context for recommendation</p>
        client_token: <p>A unique token that ensures idempotency of the request</p>

    Raises:
        capo_devops_agent.errors.access_denied_exception.AccessDeniedException: <p>Access to the requested resource is denied due to insufficient permissions.</p>
        capo_devops_agent.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_devops_agent.errors.content_size_exceeded_exception.ContentSizeExceededException: <p>This exception is thrown when the content size exceeds the allowed limit.</p>
        capo_devops_agent.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an unexpected error occurs in the processing of a request.</p>
        capo_devops_agent.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters provided in the request are invalid.</p>
        capo_devops_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_devops_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed the service quota limit.</p>
        capo_devops_agent.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please slow down and try again.</p>
        capo_devops_agent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_devops_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_devops_agent.types.update_recommendation_request.UpdateRecommendationRequest]",
    ) -> OperationResponse[
        "capo_devops_agent.types.update_recommendation_response.UpdateRecommendationResponse"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.update_recommendation

        output, http_response = (
            capo_devops_agent._operations.dev_ops_agent.update_recommendation.update_recommendation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRecommendation")
    )
    input_: capo_devops_agent.types.update_recommendation_request.UpdateRecommendationRequest = {
        "agent_space_id": agent_space_id,
        "recommendation_id": recommendation_id,
    }
    if status is not None:
        input_["status"] = status
    if additional_context is not None:
        input_["additional_context"] = additional_context
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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