Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetAgentRecommendationGeneration

Note

AWS Well-Architected Agent is in preview release and is subject to change.

Important

Application-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and relevance. As with any AI-generated content, please thoroughly review each recommendation before taking any action based on it.

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.

Request Syntax


GET /api/v1/agent-profiles/profileArn/generations/generationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

generationId

The unique identifier of the recommendation generation to retrieve.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

profileArn

The ARN of the optimization profile associated with this generation.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "additionalContext": JSON value,
   "createdAt": "string",
   "createdBy": "string",
   "endedAt": "string",
   "errorDetails": { 
      "code": "string",
      "message": "string"
   },
   "estimatedCompletionTime": "string",
   "id": "string",
   "lastModifiedAt": "string",
   "lastModifiedBy": "string",
   "name": "string",
   "profileArn": "string",
   "progress": { 
      "completionPercentage": number,
      "stepsCompleted": number,
      "totalSteps": number
   },
   "scope": { 
      "goalIds": [ "string" ],
      "items": [ 
         { 
            "ids": [ "string" ],
            "pillar": "string"
         }
      ],
      "pillars": [ "string" ]
   },
   "startedAt": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

additionalContext

The additional context that was provided when the generation was started. For ARCHITECTURE generations, this includes the location of the reviewed IaC template and the lenses used.

Type: JSON value

createdAt