goals

Creates, updates, deletes, gets or lists a goals resource.

Overview

Name	goals
Type	Resource
Id	aws.devops_agent.goals

Fields

The following fields are returned by SELECT queries:

list_goals

Name	Datatype	Description
agent_space_arn	string	The unique identifier for the agent space containing this goal
content	object	Content of the goal
created_at	string (date-time)	Timestamp when this goal was created
evaluation_schedule	object	Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily
goal_id	string	The unique identifier for this goal
goal_type	string	Type of goal based on its origin (CUSTOMER_DEFINED, ONCALL_REPORT)
last_evaluated_at	string (date-time)	Timestamp when the goal was last evaluated
last_successful_task_id	string	ID of the most recent successful task associated with this goal
last_task_id	string	ID of the most recent task associated with this goal
status	string	Possible states of a goal throughout its lifecycle (ACTIVE, PAUSED, COMPLETE)
title_	string	The title of the goal
updated_at	string (date-time)	Timestamp when this goal was last updated
version	integer	Version number for optimistic locking

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_goals	select	agent_space_id, region		Lists goals in the specified agent space with optional filtering
update_goal	update	agent_space_id, goal_id, region		Update an existing goal

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_space_id	string	The unique identifier for the agent space containing the goal
goal_id	string	The unique identifier of the goal to update
region	string	AWS region (default: us-east-1)

SELECT examples

list_goals

Lists goals in the specified agent space with optional filtering

SELECT
agent_space_arn,
content,
created_at,
evaluation_schedule,
goal_id,
goal_type,
last_evaluated_at,
last_successful_task_id,
last_task_id,
status,
title_,
updated_at,
version
FROM aws.devops_agent.goals
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_goal

Update an existing goal

UPDATE aws.devops_agent.goals
SET 
evaluationSchedule = '{{ evaluationSchedule }}',
clientToken = '{{ clientToken }}'
WHERE 
agent_space_id = '{{ agent_space_id }}' --required
AND goal_id = '{{ goal_id }}' --required
AND region = '{{ region }}' --required
RETURNING
goal;