agent_recommendation_generations

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

Overview

Name	agent_recommendation_generations
Type	Resource
Id	aws.wellarchitected.agent_recommendation_generations

Fields

The following fields are returned by SELECT queries:

get_agent_recommendation_generation

Name	Datatype	Description
id	string	The unique identifier of the recommendation generation. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	The name of the recommendation generation.
additional_context	object	Additional context information provided to guide the recommendation generation process.
created_at	string (date-time)	The timestamp when the generation was started.
created_by	string	The identifier of the user or system that started this generation.
ended_at	string (date-time)	The timestamp when the recommendation generation process completed.
error_details	object	Details about the error if the generation status is ERROR.
estimated_completion_time	string (date-time)	The estimated time for the generation to complete.
last_modified_at	string (date-time)	The timestamp when the generation was last modified.
last_modified_by	string	The identifier of the user or system that last modified this generation.
profile_arn	string	The Amazon Resource Name (ARN) of the profile used for this generation. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
progress	object	Current progress information including steps completed and completion percentage.
scope	object	The scope configuration that defines which pillars and goals to focus on during generation.
started_at	string (date-time)	The timestamp when the recommendation generation process started.
status	string	The current status of the recommendation generation. (QUEUED, IN_PROGRESS, COMPLETED, ERROR)

list_agent_recommendation_generations

Name	Datatype	Description
id	string	The unique identifier of the recommendation generation. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	The name of the recommendation generation.
created_at	string (date-time)	The timestamp when the generation was started.
created_by	string	The identifier of the user or system that started this generation.
estimated_completion_time	string (date-time)	The estimated time for the generation to complete.
last_modified_at	string (date-time)	The timestamp when the generation was last modified.
last_modified_by	string	The identifier of the user or system that last modified this generation.
profile_arn	string	The Amazon Resource Name (ARN) of the profile used for this generation. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
status	string	The current status of the recommendation generation. (QUEUED, IN_PROGRESS, COMPLETED, ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_recommendation_generation	select	profile_arn, generation_id, region		Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS.
list_agent_recommendation_generations	select	profile_arn, region	RecommendationType, MaxResults, NextToken	Lists recommendation generation processes for a specified 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
generation_id	string	The unique identifier of the recommendation generation to retrieve.
profile_arn	string	The Amazon Resource Name (ARN) of the optimization profile to list generation processes for.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of generation processes to return in a single response.
NextToken	string	A pagination token returned from a previous call to continue retrieving results.
RecommendationType	string	Optional filter by recommendation type.

SELECT examples

get_agent_recommendation_generation

Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS.

SELECT
id,
name,
additional_context,
created_at,
created_by,
ended_at,
error_details,
estimated_completion_time,
last_modified_at,
last_modified_by,
profile_arn,
progress,
scope,
started_at,
status
FROM aws.wellarchitected.agent_recommendation_generations
WHERE profile_arn = '{{ profile_arn }}' -- required
AND generation_id = '{{ generation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_agent_recommendation_generations

Lists recommendation generation processes for a specified profile.

SELECT
id,
name,
created_at,
created_by,
estimated_completion_time,
last_modified_at,
last_modified_by,
profile_arn,
status
FROM aws.wellarchitected.agent_recommendation_generations
WHERE profile_arn = '{{ profile_arn }}' -- required
AND region = '{{ region }}' -- required
AND RecommendationType = '{{ RecommendationType }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;