agent_goals

Creates, updates, deletes, gets or lists an agent_goals resource.

Overview

Name	agent_goals
Type	Resource
Id	aws.wellarchitected.agent_goals

Fields

The following fields are returned by SELECT queries:

get_agent_goal

Name	Datatype	Description
id	string	The unique identifier of the goal. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
created_at	string (date-time)	The timestamp when the goal was created.
created_by	string	The identifier of the user or system that created this goal.
description	string	A description of the goal. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])+</code>)
last_modified_at	string (date-time)	The timestamp when the goal was last modified.
last_modified_by	string	The identifier of the user or system that last modified this goal.
pillars	array	The Well-Architected Tool Framework pillars associated with this goal.
profile_arn	string	The Amazon Resource Name (ARN) of the associated profile. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
title_	string	The title of the goal. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])+</code>)

list_agent_goals

Name	Datatype	Description
id	string	The unique identifier of the goal. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
created_at	string (date-time)	The timestamp when the goal was created.
created_by	string	The identifier of the user or system that created this goal.
description	string	A description of the goal. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])+</code>)
last_modified_at	string (date-time)	The timestamp when the goal was last modified.
last_modified_by	string	The identifier of the user or system that last modified this goal.
pillars	array	The Well-Architected Tool Framework pillars associated with this goal.
profile_arn	string	The Amazon Resource Name (ARN) of the associated profile. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
title_	string	The title of the goal. (pattern: <code>(?:(?!$&#123;[a-zA-Z]+:)[\P{C}])+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_goal	select	profile_arn, id, region		Retrieves detailed information about a specific optimization goal.
list_agent_goals	select	profile_arn, region	maxResults, nextToken	Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.
create_agent_goal	insert	profile_arn, region, pillars, title		Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.
update_agent_goal	update	profile_arn, id, region		Updates the pillars and title of an existing goal associated with a profile.
delete_agent_goal	delete	profile_arn, id, region		Deletes an optimization goal from a profile.

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
id	string	The unique identifier of the goal to delete.
profile_arn	string	The Amazon Resource Name (ARN) of the profile containing the goal.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of goals to return in a single response.
nextToken	string	A pagination token returned from a previous call to continue retrieving results.

SELECT examples

get_agent_goal

Retrieves detailed information about a specific optimization goal.

SELECT
id,
created_at,
created_by,
description,
last_modified_at,
last_modified_by,
pillars,
profile_arn,
title_
FROM aws.wellarchitected.agent_goals
WHERE profile_arn = '{{ profile_arn }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_agent_goals

Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.

SELECT
id,
created_at,
created_by,
description,
last_modified_at,
last_modified_by,
pillars,
profile_arn,
title_
FROM aws.wellarchitected.agent_goals
WHERE profile_arn = '{{ profile_arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_agent_goal

Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.

INSERT INTO aws.wellarchitected.agent_goals (
clientToken,
pillars,
title,
description,
profile_arn,
region
)
SELECT 
'{{ clientToken }}',
'{{ pillars }}' /* required */,
'{{ title }}' /* required */,
'{{ description }}',
'{{ profile_arn }}',
'{{ region }}'
RETURNING
goal
;

Manifest

# Description fields are for documentation purposes
- name: agent_goals
props:
  - name: profile_arn
    value: "{{ profile_arn }}"
    description: Required parameter for the agent_goals resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agent_goals resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: pillars
    value:
      - "{{ pillars }}"
  - name: title
    value: "{{ title }}"
  - name: description
    value: "{{ description }}"

UPDATE examples

update_agent_goal

Updates the pillars and title of an existing goal associated with a profile.

UPDATE aws.wellarchitected.agent_goals
SET 
clientToken = '{{ clientToken }}',
pillars = '{{ pillars }}',
title = '{{ title }}',
description = '{{ description }}'
WHERE 
profile_arn = '{{ profile_arn }}' --required
AND id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
goal;

DELETE examples

delete_agent_goal

Deletes an optimization goal from a profile.

DELETE FROM aws.wellarchitected.agent_goals
WHERE profile_arn = '{{ profile_arn }}' --required
AND id = '{{ id }}' --required
AND region = '{{ region }}' --required
;