list_goals ¶

def list_goals(
    self,
    agent_space_id: "capo_devops_agent.types.agent_space_identifier.AgentSpaceIdentifier",
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
    status: Optional["capo_devops_agent.types.goal_status.GoalStatus"] = None,
    goal_type: Optional["capo_devops_agent.types.goal_type.GoalType"] = None,
    limit: Optional[int] = None,
    next_token: Optional["capo_devops_agent.types.next_token.NextToken"] = None,
) -> "capo_devops_agent.types.list_goals_response.ListGoalsResponse":
    """<p>Lists goals in the specified agent space with optional filtering</p>

    Args:
        agent_space_id: <p>The unique identifier for the agent space</p>
        status: <p>Filter goals by goal status</p>
        goal_type: <p>Filter goals by goal type</p>
        limit: <p>Maximum number of goals to return</p>
        next_token: <p>Pagination token for the next set of results</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.list_goals_request.ListGoalsRequest]",
    ) -> OperationResponse[
        "capo_devops_agent.types.list_goals_response.ListGoalsResponse"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.list_goals

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListGoals")
    )
    input_: capo_devops_agent.types.list_goals_request.ListGoalsRequest = {
        "agent_space_id": agent_space_id
    }
    if status is not None:
        input_["status"] = status
    if goal_type is not None:
        input_["goal_type"] = goal_type
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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