Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance¶

Description¶

Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.

Usage¶

wellarchitected_get_agent_recommendation(recommendationArn,
  remediationType)

Arguments¶

recommendationArn

[required] The Amazon Resource Name (ARN) of the recommendation to retrieve.
remediationType

Optional filter on remediation type.

Value¶

A list with the following syntax:

list(
  recommendationArn = "string",
  profileArn = "string",
  generationId = "string",
  title = "string",
  description = "string",
  type = "RESOURCE"|"ARCHITECTURE"|"APPLICATION",
  pillar = "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE",
  priority = "HIGH"|"MEDIUM"|"LOW",
  effort = "LARGE"|"MEDIUM"|"SMALL",
  status = "ACTIVE"|"SUPPRESSED"|"COMPLETED",
  state = "OPEN"|"CLOSED",
  updateReason = "string",
  impact = "HIGH"|"MEDIUM"|"LOW",
  roi = list(
    estimate = "string",
    detail = "string"
  ),
  numberOfResources = 123,
  awsServices = list(
    "string"
  ),
  businessUnits = list(
    "string"
  ),
  applications = list(
    "string"
  ),
  impactDetails = list(
    "string"
  ),
  insights = list(
    list(
      usagePattern = "string",
      signalsDetected = "string"
    )
  ),
  highlights = list(
    "string"
  ),
  remediationSummary = list(
    recommendation = "string",
    steps = list(
      "string"
    )
  ),
  crossPillarBenefits = list(
    list(
      pillar = "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE",
      title = "string",
      description = "string",
      impact = "HIGH"|"MEDIUM"|"LOW"
    )
  ),
  tradeOffs = list(
    list(
      pillar = "COST_OPTIMIZATION"|"SECURITY"|"RESILIENCE"|"PERFORMANCE"|"OPERATIONAL_EXCELLENCE",
      title = "string",
      description = "string",
      risk = "LOW"|"MEDIUM"|"HIGH",
      mitigation = "string",
      riskExplanation = "string"
    )
  ),
  sources = list(
    "TRUSTED_ADVISOR"|"COST_EXPLORER"|"CLOUDWATCH"|"WELL_ARCHITECTED_TOOL"|"WELL_ARCHITECTED_AGENT"|"CUSTOMER_IAC"
  ),
  goals = list(
    list(
      title = "string"
    )
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  createdBy = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  lastModifiedBy = "string",
  lastModifiedAt = as.POSIXct(
    "2015-01-01"
  ),
  remediations = list(
    list(
      recommendationArn = "string",
      type = "AUTO_REMEDIATION"|"CONSOLE"|"CLI"|"SDK"|"IAC"|"MCP",
      steps = list(
        list(
          title = "string",
          content = "string"
        )
      ),
      resourceLinks = list(
        list(
          url = "string",
          title = "string"
        )
      ),
      createdBy = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastModifiedBy = "string",
      lastModifiedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$get_agent_recommendation(
  recommendationArn = "string",
  remediationType = "AUTO_REMEDIATION"|"CONSOLE"|"CLI"|"SDK"|"IAC"|"MCP"
)