Skip to content

Initiates a new recommendation generation process for the specified optimization profile

Description

Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status.

Usage

wellarchitected_start_agent_recommendation_generation(profileArn, types,
  name, additionalContext, scope)

Arguments

  • profileArn

    [required] The Amazon Resource Name (ARN) of the optimization profile to use for generating recommendations.

  • types

    [required] The types of recommendations to generate.

  • name

    An optional name for this generation process to help identify it in lists and logs.

  • additionalContext

    Optional additional context to guide the recommendation generation, such as specific business requirements or constraints.

  • scope

    [required] Scope configuration to focus the generation on specific pillars or goals.

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"
  )
)

Request syntax

svc$start_agent_recommendation_generation(
  profileArn = "string",
  types = list(
    "RESOURCE"|"ARCHITECTURE"|"APPLICATION"
  ),
  name = "string",
  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"
        )
      )
    )
  )
)