The Agent Profiles API from Amazon Well-Architected Tool — 2 operation(s) for agent profiles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-well-architected-tool:amazon-well-architected-tool-agent-profiles-api"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.
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: 3.2.0
info:
title: AWS Well-Architected Tool Agent Profiles 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 Profiles
paths:
/api/v1/agent-profiles:
post:
operationId: CreateAgentProfile
summary: Create Agent Profile
description: Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAgentProfileResponse'
'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'
'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/CreateAgentProfileRequest'
tags:
- Agent Profiles
get:
operationId: ListAgentProfiles
summary: List Agent Profiles
description: Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAgentProfilesResponse'
'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/ListAgentProfilesRequest'
tags:
- Agent Profiles
/api/v1/agent-profiles/{profileArn}:
delete:
operationId: DeleteAgentProfile
summary: Delete Agent Profile
description: Deletes an optimization profile and its associated configuration. This action cannot be undone.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAgentProfileResponse'
'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'
'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/DeleteAgentProfileRequest'
tags:
- Agent Profiles
get:
operationId: GetAgentProfile
summary: Get Agent Profile
description: Retrieves detailed information about an optimization profile, including its configuration and metadata.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAgentProfileResponse'
'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/GetAgentProfileRequest'
tags:
- Agent Profiles
put:
operationId: UpdateAgentProfile
summary: Update Agent Profile
description: Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAgentProfileResponse'
'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/UpdateAgentProfileRequest'
tags:
- Agent Profiles
components:
schemas:
GetAgentProfileRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the optimization profile to retrieve.
required:
- profileArn
DeleteAgentProfileRequest:
type: object
properties:
profileArn:
type: string
description: The Amazon Resource Name (ARN) of the profile to delete.
required:
- profileArn
AccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
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
DeleteAgentProfileResponse:
type: object
properties: {}
ValidationExceptionField:
type: object
properties:
Name:
type: string
Message:
type: string
required:
- Name
- Message
GetAgentProfileResponse:
type: object
properties:
name:
type: string
description: The system name of the profile.
displayName:
type: string
description: The display name of the profile.
description:
type: string
description: A description of the profile.
businessOverview:
type: string
description: The business overview of the profile.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The Well-Architected Tool Framework pillars associated with the profile.
deletionProtection:
type: boolean
description: Indicates whether deletion protection is enabled.
executionRoleArn:
type: string
description: The ARN of the IAM execution role.
aggregationConfiguration:
type: array
items:
$ref: '#/components/schemas/AggregationConfiguration'
description: The aggregation configuration.
arn:
type: string
description: The Amazon Resource Name (ARN) of the profile.
eligibleForScheduledGeneration:
type: boolean
description: Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration:
type: boolean
description: Indicates whether the profile is valid for manual architecture generation.
fieldErrors:
type: object
additionalProperties:
type: string
description: A map of field paths to error messages for invalid or missing input fields.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags associated with the profile.
createdBy:
type: string
description: The identifier of the user or system that created this profile.
createdAt:
type: string
description: The timestamp when the profile was created.
lastModifiedBy:
type: string
description: The identifier of the user or system that last modified this profile.
lastModifiedAt:
type: string
description: The timestamp when the profile was last modified.
required:
- name
- pillars
- executionRoleArn
- aggregationConfiguration
- arn
- createdBy
- createdAt
CreateAgentProfileResponse:
type: object
properties:
name:
type: string
description: The system name of the created profile.
displayName:
type: string
description: The display name of the created profile.
description:
type: string
description: A description of the created profile.
businessOverview:
type: string
description: The business overview of the created profile.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The Well-Architected Tool Framework pillars associated with the created profile.
deletionProtection:
type: boolean
description: Indicates whether deletion protection is enabled.
executionRoleArn:
type: string
description: The ARN of the IAM execution role.
aggregationConfiguration:
type: array
items:
$ref: '#/components/schemas/AggregationConfiguration'
description: The aggregation configuration.
arn:
type: string
description: The Amazon Resource Name (ARN) of the created profile.
eligibleForScheduledGeneration:
type: boolean
description: Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration:
type: boolean
description: Indicates whether the profile is valid for manual architecture generation.
fieldErrors:
type: object
additionalProperties:
type: string
description: A map of field paths to error messages for invalid or missing input fields.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags associated with the created profile.
createdBy:
type: string
description: The identifier of the user or system that created this profile.
createdAt:
type: string
description: The timestamp when the profile was created.
lastModifiedBy:
type: string
description: The identifier of the user or system that last modified this profile.
lastModifiedAt:
type: string
description: The timestamp when the profile was last modified.
required:
- name
- pillars
- executionRoleArn
- aggregationConfiguration
- arn
- createdBy
- createdAt
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
CreateAgentProfileRequest:
type: object
properties:
name:
type: string
description: The system name of the profile.
displayName:
type: string
description: The display name of the profile shown to users.
description:
type: string
description: A description of the profile.
businessOverview:
type: string
description: The business overview for this profile.
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 profile.
deletionProtection:
type: boolean
description: Indicates whether deletion protection is enabled for the profile.
executionRoleArn:
type: string
description: The ARN of the IAM execution role used for recommendation actions.
aggregationConfiguration:
type: array
items:
$ref: '#/components/schemas/AggregationConfiguration'
description: The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags to associate with the profile.
required:
- name
- pillars
- executionRoleArn
- aggregationConfiguration
ResourceNotFoundException:
type: object
properties:
Message:
type: string
ResourceId:
type: string
ResourceType:
type: string
required:
- Message
- ResourceId
- ResourceType
UpdateAgentProfileResponse:
type: object
properties:
name:
type: string
description: The system name of the updated profile.
displayName:
type: string
description: The display name of the updated profile.
description:
type: string
description: A description of the updated profile.
businessOverview:
type: string
description: The business overview of the updated profile.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The Well-Architected Tool Framework pillars associated with the updated profile.
deletionProtection:
type: boolean
description: Indicates whether deletion protection is enabled.
executionRoleArn:
type: string
description: The ARN of the IAM execution role.
aggregationConfiguration:
type: array
items:
$ref: '#/components/schemas/AggregationConfiguration'
description: The aggregation configuration.
arn:
type: string
description: The Amazon Resource Name (ARN) of the updated profile.
eligibleForScheduledGeneration:
type: boolean
description: Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration:
type: boolean
description: Indicates whether the profile is valid for manual architecture generation.
fieldErrors:
type: object
additionalProperties:
type: string
description: A map of field paths to error messages for invalid or missing input fields.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags associated with the updated profile.
createdBy:
type: string
description: The identifier of the user or system that created this profile.
createdAt:
type: string
description: The timestamp when the profile was created.
lastModifiedBy:
type: string
description: The identifier of the user or system that last modified this profile.
lastModifiedAt:
type: string
description: The timestamp when the profile was last modified.
required:
- name
- pillars
- executionRoleArn
- aggregationConfiguration
- arn
- createdBy
- createdAt
ThrottlingException:
type: object
properties:
Message:
type: string
QuotaCode:
type: string
ServiceCode:
type: string
required:
- Message
AgentProfileSummary:
type: object
properties:
name:
type: string
description: The system name of the profile.
displayName:
type: string
description: The display name of the profile shown to users.
description:
type: string
description: A description of the profile.
businessOverview:
type: string
description: The business overview for this 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 profile.
deletionProtection:
type: boolean
description: Indicates whether deletion protection is enabled for the profile.
executionRoleArn:
type: string
description: The ARN of the IAM execution role used for recommendation actions.
aggregationConfiguration:
type: array
items:
$ref: '#/components/schemas/AggregationConfiguration'
description: The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.
arn:
type: string
description: The Amazon Resource Name (ARN) of the optimization profile.
eligibleForScheduledGeneration:
type: boolean
description: Indicates whether the profile is valid for scheduled recommendation generation.
eligibleForArchitectureGeneration:
type: boolean
description: Indicates whether the profile is valid for manual architecture generation.
fieldErrors:
type: object
additionalProperties:
type: string
description: A map of field paths to error messages for invalid or missing input fields.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags associated with the profile.
createdBy:
type: string
description: The identifier of the user or system that created this profile.
createdAt:
type: string
description: The timestamp when the profile was created.
lastModifiedBy:
type: string
description: The identifier of the user or system that last modified this profile.
lastModifiedAt:
type: string
description: The timestamp when the profile was last modified.
required:
- name
- pillars
- executionRoleArn
- aggregationConfiguration
- arn
- createdBy
- createdAt
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
AggregationConfiguration:
type: object
properties:
accountId:
type: string
description: The Amazon Web Services account ID to analyze.
regions:
type: array
items:
type: string
description: A list of Amazon Web Services Regions to include in the analysis.
accessRoleArn:
type: string
description: The ARN of an IAM role to assume for resource analysis in this account.
required:
- accountId
- regions
- accessRoleArn
UpdateAgentProfileRequest:
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 update.
displayName:
type: string
description: The updated display name of the profile.
description:
type: string
description: The updated description of the profile.
executionRoleArn:
type: string
description: The updated ARN of the IAM execution role.
aggregationConfiguration:
type: array
items:
$ref: '#/components/schemas/AggregationConfiguration'
description: The updated aggregation configuration.
businessOverview:
type: string
description: The updated business overview for the profile.
pillars:
type: array
items:
type: string
enum:
- COST_OPTIMIZATION
- SECURITY
- RESILIENCE
- PERFORMANCE
- OPERATIONAL_EXCELLENCE
description: The updated Well-Architected Tool Framework pillars for the profile.
deletionProtection:
type: boolean
description: Indicates whether deletion protection is enabled for the profile.
required:
- profileArn
InternalServerException:
type: object
properties:
Message:
type: string
required:
- Message
ListAgentProfilesResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AgentProfileSummary'
description: A list of profile summaries.
nextToken:
type: string
description: A pagination token to retrieve the next set of results, if available.
required:
- items
ListAgentProfilesRequest:
type: object
properties:
maxResults:
type: integer
description: The maximum number of profiles to return in a single call. Default is 100.
nextToken:
type: string
description: A pagination token returned from a previous call to continue retrieving results.
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)