Skip to content

update_goal

update_goal(
    agent_space_id: AgentSpaceIdentifier,
    goal_id: str,
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
    evaluation_schedule: Optional[GoalScheduleInput] = None,
    client_token: Optional[str] = None,
) -> UpdateGoalResponse

Update an existing goal

Parameters:

  • agent_space_id (AgentSpaceIdentifier) –

    The unique identifier for the agent space containing the goal

  • goal_id (str) –

    The unique identifier of the goal to update

  • evaluation_schedule (Optional[GoalScheduleInput], default: None ) –

    Update goal schedule state

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

    Client-provided token for idempotent operations

Raises:

Source code in docs_src/capo_devops_agent/_services/dev_ops_agent.py
def update_goal(
    self,
    agent_space_id: "capo_devops_agent.types.agent_space_identifier.AgentSpaceIdentifier",
    goal_id: str,
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
    evaluation_schedule: Optional[
        "capo_devops_agent.types.goal_schedule_input.GoalScheduleInput"
    ] = None,
    client_token: Optional[str] = None,
) -> "capo_devops_agent.types.update_goal_response.UpdateGoalResponse":
    """<p>Update an existing goal</p>

    Args:
        agent_space_id: <p>The unique identifier for the agent space containing the goal</p>
        goal_id: <p>The unique identifier of the goal to update</p>
        evaluation_schedule: <p>Update goal schedule state</p>
        client_token: <p>Client-provided token for idempotent operations</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_goal_request.UpdateGoalRequest]",
    ) -> OperationResponse[
        "capo_devops_agent.types.update_goal_response.UpdateGoalResponse"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.update_goal

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGoal")
    )
    input_: capo_devops_agent.types.update_goal_request.UpdateGoalRequest = {
        "agent_space_id": agent_space_id,
        "goal_id": goal_id,
    }
    if evaluation_schedule is not None:
        input_["evaluation_schedule"] = evaluation_schedule
    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