Amazon Well-Architected Tool Well Architected Tool Contexts API
The Well Architected Tool Contexts API from Amazon Well-Architected Tool — 2 operation(s) for well architected tool contexts.
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-contexts-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 Contexts 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: Contexts
paths:
/api/v1/agent-profiles/{profileArn}/contexts:
post:
operationId: CreateAgentContext
summary: Create Agent Context
description: Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentContextResponse'
'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/CreateAgentContextRequest'
tags:
- Contexts
get:
operationId: ListAgentContexts
summary: List Agent Contexts
description: Lists contexts associated with a profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAgentContextsResponse'
'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/ListAgentContextsRequest'
tags:
- Contexts
/api/v1/agent-profiles/{profileArn}/contexts/{id}:
delete:
operationId: DeleteAgentContext
summary: Delete Agent Context
description: Deletes a context associated with a profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAgentContextResponse'
'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/DeleteAgentContextRequest'
tags:
- Contexts
get:
operationId: GetAgentContext
summary: Get Agent Context
description: Retrieves detailed information about a specific context associated with a profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAgentContextResponse'
'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/GetAgentContextRequest'
tags:
- Contexts
put:
operationId: UpdateAgentContext
summary: Update Agent Context
description: Updates an existing context associated with a profile.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAgentContextResponse'
'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/UpdateAgentContextRequest'
tags:
- Contexts
components:
schemas:
AccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
ListAgentContextsResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ContextSummary'
description: A list of context summaries associated with the profile.
nextToken:
type: string
required:
- items
CreateAgentContextRequest:
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 context with.
title:
type: string
description: The title of the context.
contextType:
type: string
enum:
- APPLICATION
description: The type of the context.
content:
$ref: '#/components/schemas/ContextContent'
required:
- profileArn
- title
- contextType
- content
ContextSummary:
type: object
properties:
id:
type: string
description: The unique identifier of the context.
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the associated profile.
title:
type: string
description: The title of the context.
contextType:
type: string
enum:
- APPLICATION
description: The type of the context.
content:
$ref: '#/components/schemas/ContextContent'
applicationType:
type: string
enum:
- SAS
- DESKTOP_APPLICATION
- OTHER
description: The type of application described by this context.
criticality:
type: string
enum:
- MISSION_CRITICAL
- BUSINESS_CRITICAL
- NON_CRITICAL
- TEST_DEVELOPMENT
description: The business criticality of the application described by this context.
createdBy:
type: string
description: The identifier of the user or system that created this context.
createdAt:
type: string
description: The timestamp when the context was created.
lastModifiedBy:
type: string
description: The identifier of the user or system that last modified this context.
lastModifiedAt:
type: string
description: The timestamp when the context was last modified.
required:
- id
- profileArn
- title
- contextType
- content
- createdBy
- createdAt
GetAgentContextRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile containing the context.
id:
type: string
description: The unique identifier of the context to retrieve.
required:
- profileArn
- id
ContextResourceTag:
type: object
properties:
key:
type: string
description: The tag key.
value:
type: string
description: The tag value.
required:
- key
- value
ValidationExceptionField:
type: object
properties:
Name:
type: string
Message:
type: string
required:
- Name
- Message
UpdateAgentContextResponse:
type: object
properties:
context:
$ref: '#/components/schemas/ContextSummary'
required:
- context
ContextContent:
type: object
properties:
accountIds:
type: array
items:
type: string
description: The Amazon Web Services account IDs associated with this application context.
regions:
type: array
items:
type: string
description: The Amazon Web Services Regions where this application operates.
awsServices:
type: array
items:
type: string
description: The Amazon Web Services services used by this application.
resourceTypes:
type: array
items:
type: string
description: The Amazon Web Services resource types relevant to this application.
resourceTags:
type: array
items:
$ref: '#/components/schemas/ContextResourceTag'
description: Resource tags used to scope this application context.
applicationOverview:
type: string
description: A free-form overview of the application.
industry:
type: string
description: The industry vertical for this application.
applicationType:
type: string
enum:
- SAS
- DESKTOP_APPLICATION
- OTHER
description: The type of the application.
criticality:
type: string
enum:
- MISSION_CRITICAL
- BUSINESS_CRITICAL
- NON_CRITICAL
- TEST_DEVELOPMENT
description: The business criticality of the application.
architectureOverview:
type: string
description: A free-form description of the application architecture.
additionalContext:
type: string
description: Additional context not captured by other fields.
CreateAgentContextResponse:
type: object
properties:
context:
$ref: '#/components/schemas/ContextSummary'
required:
- context
DeleteAgentContextRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile containing the context.
id:
type: string
description: The unique identifier of the context to delete.
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
UpdateAgentContextRequest:
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 context.
id:
type: string
description: The unique identifier of the context to update.
title:
type: string
description: The updated title of the context.
content:
$ref: '#/components/schemas/ContextContent'
required:
- profileArn
- id
ThrottlingException:
type: object
properties:
Message:
type: string
QuotaCode:
type: string
ServiceCode:
type: string
required:
- Message
DeleteAgentContextResponse:
type: object
properties: {}
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
ListAgentContextsRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile to list contexts for.
maxResults:
type: integer
nextToken:
type: string
required:
- profileArn
InternalServerException:
type: object
properties:
Message:
type: string
required:
- Message
GetAgentContextResponse:
type: object
properties:
context:
$ref: '#/components/schemas/ContextSummary'
required:
- context
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)