Amazon Well-Architected Tool Well Architected Tool Goals API
The Well Architected Tool Goals API from Amazon Well-Architected Tool — 2 operation(s) for well architected tool goals.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-well-architected-tool:amazon-well-architected-tool-goals-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AWS Well-Architected Tool Goals API
version: '2020-03-31'
description: Generated from AWS's published Smithy model for AWS Well-Architected Tool. 5 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: Goals
paths:
/api/v1/agent-profiles/{profileArn}/goals:
post:
operationId: CreateAgentGoal
summary: Create Agent Goal
description: Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentGoalResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'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/CreateAgentGoalRequest'
tags:
- Goals
get:
operationId: ListAgentGoals
summary: List Agent Goals
description: Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAgentGoalsResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'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/ListAgentGoalsRequest'
tags:
- Goals
/api/v1/agent-profiles/{profileArn}/goals/{id}:
delete:
operationId: DeleteAgentGoal
summary: Delete Agent Goal
description: Deletes an optimization goal from a profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAgentGoalResponse'
'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/DeleteAgentGoalRequest'
tags:
- Goals
get:
operationId: GetAgentGoal
summary: Get Agent Goal
description: Retrieves detailed information about a specific optimization goal.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAgentGoalResponse'
'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/GetAgentGoalRequest'
tags:
- Goals
put:
operationId: UpdateAgentGoal
summary: Update Agent Goal
description: Updates the pillars and title of an existing goal associated with a profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAgentGoalResponse'
'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/UpdateAgentGoalRequest'
tags:
- Goals
components:
schemas:
DeleteAgentGoalRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile containing the goal.
id:
type: string
description: The unique identifier of the goal to delete.
required:
- profileArn
- id
AccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
UpdateAgentGoalRequest:
type: object
properties:
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile containing the goal to update.
id:
type: string
description: The unique identifier of the goal to update.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The updated pillars for the goal. Pillars define the optimization focus areas such as cost, performance, resilience, and operational excellence.
title:
type: string
description: The updated title for the goal. Maximum length of 1000 characters.
description:
type: string
description: A description of the goal.
required:
- profileArn
- id
ListAgentGoalsRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the optimization profile to list goals for.
maxResults:
type: integer
description: The maximum number of goals to return in a single response.
nextToken:
type: string
description: A pagination token returned from a previous call to continue retrieving results.
required:
- profileArn
CreateAgentGoalResponse:
type: object
properties:
goal:
$ref: '#/components/schemas/GoalSummary'
required:
- goal
ListAgentGoalsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/GoalSummary'
description: A list of goal summaries associated with the profile.
nextToken:
type: string
description: A pagination token to retrieve the next set of results, if available.
required:
- items
ValidationExceptionField:
type: object
properties:
Name:
type: string
Message:
type: string
required:
- Name
- Message
GetAgentGoalRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile containing the goal.
id:
type: string
description: The unique identifier of the goal to retrieve.
required:
- profileArn
- id
ConflictException:
type: object
properties:
Message:
type: string
ResourceId:
type: string
ResourceType:
type: string
required:
- Message
- ResourceId
- ResourceType
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
ResourceId:
type: string
ResourceType:
type: string
QuotaCode:
type: string
ServiceCode:
type: string
required:
- Message
- QuotaCode
- ServiceCode
ResourceNotFoundException:
type: object
properties:
Message:
type: string
ResourceId:
type: string
ResourceType:
type: string
required:
- Message
- ResourceId
- ResourceType
GoalSummary:
type: object
properties:
id:
type: string
description: The unique identifier of the goal.
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the associated profile.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The Well-Architected Tool Framework pillars associated with this goal.
title:
type: string
description: The title of the goal.
description:
type: string
description: A description of the goal.
createdBy:
type: string
description: The identifier of the user or system that created this goal.
createdAt:
type: string
description: The timestamp when the goal was created.
lastModifiedBy:
type: string
description: The identifier of the user or system that last modified this goal.
lastModifiedAt:
type: string
description: The timestamp when the goal was last modified.
required:
- id
- profileArn
- pillars
- title
- createdBy
- createdAt
GetAgentGoalResponse:
type: object
properties:
goal:
$ref: '#/components/schemas/GoalSummary'
required:
- goal
ThrottlingException:
type: object
properties:
Message:
type: string
QuotaCode:
type: string
ServiceCode:
type: string
required:
- Message
UpdateAgentGoalResponse:
type: object
properties:
goal:
$ref: '#/components/schemas/GoalSummary'
required:
- goal
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
InternalServerException:
type: object
properties:
Message:
type: string
required:
- Message
DeleteAgentGoalResponse:
type: object
properties: {}
CreateAgentGoalRequest:
type: object
properties:
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile to associate the goal with.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The Well-Architected Tool Framework pillars to associate with this goal.
title:
type: string
description: The title of the goal.
description:
type: string
description: A description of the goal.
required:
- profileArn
- pillars
- title
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)