Amazon Well-Architected Tool

Amazon Well-Architected Tool Agent Recommendations API

The Agent Recommendations API from Amazon Well-Architected Tool — 1 operation(s) for agent recommendations.

GitHub OpenAPI

Operations 1

GET /api/v1/agent-recommendations/{recommendationArn} Get Agent Recommendation #

Documentation

📖
Documentation
https://docs.aws.amazon.com/wellarchitected/latest/userguide/
📖
APIReference
https://docs.aws.amazon.com/wellarchitected/latest/APIReference/
📖
GettingStarted
https://docs.aws.amazon.com/wellarchitected/latest/userguide/getting-started.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-well-architected-tool/openapi/amazon-well-architected-tool-agent-recommendations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/amazon-well-architected-tool/json-schema/well-architected-tool-workload-schema.json

Other Resources

🔗
Pricing
https://aws.amazon.com/well-architected-tool/pricing/
🔗
FAQ
https://aws.amazon.com/well-architected-tool/faqs/
🔗
JSONLD
https://artifacts.apis.io/amazon-well-architected-tool/json-ld/amazon-well-architected-tool-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-well-architected-tool:amazon-well-architected-tool-agent-recommendations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-well-architected-tool-agent-recommendations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Well-Architected Tool Agent Recommendations API
  version: '2020-03-31'
  description: Generated from AWS's published Smithy model for AWS Well-Architected Tool. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://wellarchitected.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Agent Recommendations
paths:
  /api/v1/agent-recommendations/{recommendationArn}:
    get:
      operationId: GetAgentRecommendation
      summary: Get Agent Recommendation
      description: Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAgentRecommendationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAgentRecommendationRequest'
      tags:
      - Agent Recommendations
components:
  schemas:
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
      required:
      - Message
    Roi:
      type: object
      properties:
        estimate:
          type: string
          description: A short statistic or key metric. Optional when there is no quantifiable figure.
        detail:
          type: string
          description: A sentence providing context for the estimate.
      required:
      - detail
    GetAgentRecommendationResponse:
      type: object
      properties:
        recommendationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recommendation.
        profileArn:
          type: string
          description: The Amazon Resource Name (ARN) of the associated profile.
        generationId:
          type: string
          description: The identifier of the generation process that produced this recommendation.
        title:
          type: string
          description: The title of the recommendation.
        description:
          type: string
          description: A description of the recommendation.
        type:
          type: string
          enum:
          - RESOURCE
          - ARCHITECTURE
          - APPLICATION
          description: The type of the recommendation.
        pillar:
          type: string
          enum:
          - COST_OPTIMIZATION
          - SECURITY
          - RESILIENCE
          - PERFORMANCE
          - OPERATIONAL_EXCELLENCE
          description: The Well-Architected Tool Framework pillar that the recommendation addresses.
        priority:
          type: string
          enum:
          - HIGH
          - MEDIUM
          - LOW
          description: The priority of the recommendation.
        effort:
          type: string
          enum:
          - LARGE
          - MEDIUM
          - SMALL
          description: The effort required to implement the recommendation.
        status:
          type: string
          enum:
          - ACTIVE
          - SUPPRESSED
          - COMPLETED
          description: The current status of the recommendation.
        state:
          type: string
          enum:
          - OPEN
          - CLOSED
          description: The current state of the recommendation.
        updateReason:
          type: string
          description: The free-text reason associated with the recommendation's most recent status update.
        impact:
          type: string
          enum:
          - HIGH
          - MEDIUM
          - LOW
          description: The severity of the recommendation's impact.
        roi:
          $ref: '#/components/schemas/Roi'
        numberOfResources:
          type: integer
          description: The number of Amazon Web Services resources this recommendation affects.
        awsServices:
          type: array
          items:
            type: string
          description: The Amazon Web Services services that the recommendation applies to.
        businessUnits:
          type: array
          items:
            type: string
          description: The business units that own the affected resources.
        applications:
          type: array
          items:
            type: string
          description: The applications that the recommendation targets.
        impactDetails:
          type: array
          items:
            type: string
          description: Detailed impact information for the recommendation.
        insights:
          type: array
          items:
            $ref: '#/components/schemas/Insight'
          description: A list of insights about the recommendation.
        highlights:
          type: array
          items:
            type: string
          description: Highlights describing what was detected.
        remediationSummary:
          $ref: '#/components/schemas/RemediationSummary'
        crossPillarBenefits:
          type: array
          items:
            $ref: '#/components/schemas/CrossPillarBenefit'
          description: Cross-pillar benefits of acting on the recommendation.
        tradeOffs:
          type: array
          items:
            $ref: '#/components/schemas/TradeOff'
          description: Trade-offs of acting on the recommendation.
        sources:
          type: array
          items:
            type: string
            enum:
            - TRUSTED_ADVISOR
            - COST_EXPLORER
            - CLOUDWATCH
            - WELL_ARCHITECTED_TOOL
            - WELL_ARCHITECTED_AGENT
            - CUSTOMER_IAC
          description: Sources that generated this recommendation.
        goals:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationGoal'
          description: Goals that this recommendation targets.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A set of key-value pairs associated with the recommendation, used for cost allocation and access control.
        createdBy:
          type: string
          description: The identifier of the user or system that created this recommendation.
        createdAt:
          type: string
          description: The timestamp when the recommendation was created.
        lastModifiedBy:
          type: string
          description: The identifier of the user or system that last modified this recommendation.
        lastModifiedAt:
          type: string
          description: The timestamp when the recommendation was last modified.
        remediations:
          type: array
          items:
            $ref: '#/components/schemas/AgentRecommendationRemediation'
          description: A list of remediations for the recommendation.
      required:
      - recommendationArn
      - profileArn
      - title
      - description
      - type
      - pillar
      - priority
      - effort
      - status
      - state
      - impact
      - roi
      - impactDetails
      - insights
      - highlights
      - remediationSummary
      - createdBy
      - createdAt
    CrossPillarBenefit:
      type: object
      properties:
        pillar:
          type: string
          enum:
          - COST_OPTIMIZATION
          - SECURITY
          - RESILIENCE
          - PERFORMANCE
          - OPERATIONAL_EXCELLENCE
          description: The pillar that would be positively impacted.
        title:
          type: string
          description: A short phrase describing the outcome.
        description:
          type: string
          description: A description of what changes and why it matters.
        impact:
          type: string
          enum:
          - HIGH
          - MEDIUM
          - LOW
          description: The severity of the benefit.
      required:
      - pillar
      - title
      - description
      - impact
    GetAgentRecommendationRequest:
      type: object
      properties:
        recommendationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the recommendation to retrieve.
        remediationType:
          type: string
          enum:
          - AUTO_REMEDIATION
          - CONSOLE
          - CLI
          - SDK
          - IAC
          - MCP
          description: Optional filter on remediation type.
      required:
      - recommendationArn
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
        ResourceType:
          type: string
      required:
      - Message
      - ResourceId
      - ResourceType
    RemediationSummary:
      type: object
      properties:
        recommendation:
          type: string
          description: A short imperative statement of the recommended action.
        steps:
          type: array
          items:
            type: string
          description: High-level steps to implement the fix.
      required:
      - recommendation
      - steps
    TradeOff:
      type: object
      properties:
        pillar:
          type: string
          enum:
          - COST_OPTIMIZATION
          - SECURITY
          - RESILIENCE
          - PERFORMANCE
          - OPERATIONAL_EXCELLENCE
          description: The pillar that could be negatively impacted.
        title:
          type: string
          description: A short phrase describing what is lost or degraded.
        description:
          type: string
          description: A description of the specific risk and the condition that triggers it.
        risk:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          description: The risk rating for the trade-off.
        mitigation:
          type: string
          description: A specific action to mitigate the trade-off and when to take it.
        riskExplanation:
          type: string
          description: An optional explanation providing additional context for the risk rating.
      required:
      - pillar
      - title
      - description
      - risk
      - mitigation
    ResourceLink:
      type: object
      properties:
        url:
          type: string
          description: The URL of the external reference.
        title:
          type: string
          description: An optional human-readable title for the link.
      required:
      - url
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ValidationExceptionField:
      type: object
      properties:
        Name:
          type: string
        Message:
          type: string
      required:
      - Name
      - Message
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        QuotaCode:
          type: string
        ServiceCode:
          type: string
      required:
      - Message
    Insight:
      type: object
      properties:
        usagePattern:
          type: string
          description: A description of the usage pattern.
        signalsDetected:
          type: string
          description: A description of the signals detected.
      required:
      - usagePattern
    AgentRecommendationRemediation:
      type: object
      properties:
        recommendationArn:
          type: string
          description: The ARN of the recommendation that this remediation belongs to.
        type:
          type: string
          enum:
          - AUTO_REMEDIATION
          - CONSOLE
          - CLI
          - SDK
          - IAC
          - MCP
          description: The remediation method.
        steps:
          type: array
          items:
            $ref: '#/components/schemas/RemediationStep'
          description: The procedural steps to perform the remediation.
        resourceLinks:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
          description: External references associated with the steps.
        createdBy:
          type: string
          description: The identifier of the user or system that created this remediation.
        createdAt:
          type: string
          description: The timestamp when the remediation was created.
        lastModifiedBy:
          type: string
          description: The identifier of the user or system that last modified this remediation.
        lastModifiedAt:
          type: string
          description: The timestamp when the remediation was last modified.
      required:
      - recommendationArn
      - type
      - steps
      - createdBy
      - createdAt
    RemediationStep:
      type: object
      properties:
        title:
          type: string
          description: An optional short label for the step.
        content:
          type: string
          description: The content describing the step, which can include code examples and verification checklists.
      required:
      - content
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    RecommendationGoal:
      type: object
      properties:
        title:
          type: string
          description: The title of the goal associated with the recommendation.
      required:
      - title
    Tag:
      type: object
      properties:
        key:
          type: string
          description: The key of the tag.
        value:
          type: string
          description: The value of the tag.
      required:
      - key
      - value
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: wellarchitected
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/wellarchitected/service/2020-03-31/wellarchitected-2020-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)