Retrieves information about a recommendation generation process, including its status, progress, and results¶

Description¶

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.

Usage¶

wellarchitected_get_agent_recommendation_generation(profileArn,
  generationId)

Arguments¶

profileArn

[required] The ARN of the optimization profile associated with this generation.
generationId

[required] The unique identifier of the recommendation generation to retrieve.

Value¶

A list with the following syntax:

list(
  id = "string",
  profileArn = "string",
  name = "string",
  status = "QUEUED"|"IN_PROGRESS"|"COMPLETED"|"ERROR",
  estimatedCompletionTime = as.POSIXct(
    "2015-01-01"
  ),
  createdBy = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  lastModifiedBy = "string",
  lastModifiedAt = as.POSIXct(
    "2015-01-01"
  ),
  additionalContext = list(),
  scope = list(
    pillars = list(
      "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE"
    ),
    goalIds = list(
      "string"
    ),
    items = list(
      list(
        pillar = "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE",
        ids = list(
          "string"
        )
      )
    )
  ),
  startedAt = as.POSIXct(
    "2015-01-01"
  ),
  endedAt = as.POSIXct(
    "2015-01-01"
  ),
  progress = list(
    stepsCompleted = 123,
    totalSteps = 123,
    completionPercentage = 123.0
  ),
  errorDetails = list(
    code = "string",
    message = "string"
  )
)

Request syntax¶

svc$get_agent_recommendation_generation(
  profileArn = "string",
  generationId = "string"
)