Skip to content

get_recommendation

get_recommendation(
    agent_space_id: AgentSpaceIdentifier,
    recommendation_id: ResourceId,
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
    recommendation_version: Optional[int] = None,
) -> GetRecommendationResponse

Retrieves a specific recommendation by its ID

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 retrieve

  • recommendation_version (Optional[int], default: None ) –

    Specific version of the recommendation to retrieve. If not specified, returns the latest version.

Raises:

Source code in docs_src/capo_devops_agent/_services/dev_ops_agent.py
def get_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,
    recommendation_version: Optional[int] = None,
) -> (
    "capo_devops_agent.types.get_recommendation_response.GetRecommendationResponse"
):
    """<p>Retrieves a specific recommendation by its ID</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 retrieve</p>
        recommendation_version: <p>Specific version of the recommendation to retrieve. If not specified, returns the latest version.</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.get_recommendation_request.GetRecommendationRequest]",
    ) -> OperationResponse[
        "capo_devops_agent.types.get_recommendation_response.GetRecommendationResponse"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.get_recommendation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRecommendation")
    )
    input_: capo_devops_agent.types.get_recommendation_request.GetRecommendationRequest = {
        "agent_space_id": agent_space_id,
        "recommendation_id": recommendation_id,
    }
    if recommendation_version is not None:
        input_["recommendation_version"] = recommendation_version

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