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.
Parameters:
-
profile_arn
(AgentProfileArn)
–
The ARN of the optimization profile associated with this generation.
-
generation_id
(UUID)
–
The unique identifier of the recommendation generation to retrieve.
Raises:
Source code in docs_src/capo_wellarchitected/_services/async_well_architected.py
| async def get_agent_recommendation_generation(
self,
profile_arn: "capo_wellarchitected.types.agent_profile_arn.AgentProfileArn",
generation_id: "capo_wellarchitected.types.uuid.UUID",
*,
config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
) -> "capo_wellarchitected.types.get_agent_recommendation_generation_response.GetAgentRecommendationGenerationResponse":
"""<p>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.</p>
Args:
profile_arn: <p>The ARN of the optimization profile associated with this generation.</p>
generation_id: <p>The unique identifier of the recommendation generation to retrieve.</p>
Raises:
capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_wellarchitected.types.get_agent_recommendation_generation_request.GetAgentRecommendationGenerationRequest]",
) -> AsyncOperationResponse[
"capo_wellarchitected.types.get_agent_recommendation_generation_response.GetAgentRecommendationGenerationResponse"
]:
import capo_wellarchitected._operations.well_architected_api_service_lambda.get_agent_recommendation_generation
(
output,
http_response,
) = await capo_wellarchitected._operations.well_architected_api_service_lambda.get_agent_recommendation_generation.async_get_agent_recommendation_generation(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetAgentRecommendationGeneration")
)
input_: capo_wellarchitected.types.get_agent_recommendation_generation_request.GetAgentRecommendationGenerationRequest = {
"profile_arn": profile_arn,
"generation_id": generation_id,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|