How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Well-Architected Tool Profiles API

The Profiles API from Amazon Well-Architected Tool — 5 operation(s) for profiles.

Amazon Well-Architected Tool Profiles API is one of 13 APIs that Amazon Well-Architected Tool publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, a JSON-LD context, and 1 JSON Schema.

This API exposes 7 operations across 5 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://wellarchitected.{region}.amazonaws.com, https://wellarchitected.{region}.amazonaws.com, http://wellarchitected.{region}.amazonaws.com.cn, https://wellarchitected.{region}.amazonaws.com.cn.

7 operations 5 paths 44 schemas 2 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://wellarchitected.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Well-Architected Tool Profiles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Profiles 7
POST
/profiles
Amazon Well-Architected Tool Create Profile
CreateProfile 7 params body → 200480481482483484485
POST
/profiles/{ProfileArn}/shares
Amazon Well-Architected Tool Create Profile Share
CreateProfileShare 8 params body → 200480481482483484485486
GET
/profiles/{ProfileArn}/shares
Amazon Well-Architected Tool List Profile Shares
ListProfileShares 12 params → 200480481482483484
DELETE
/profiles/{ProfileArn}#ClientRequestToken
Amazon Well-Architected Tool Delete Profile
DeleteProfile 9 params → 200480481482483484485
DELETE
/profiles/{ProfileArn}/shares/{ShareId}#ClientRequestToken
Amazon Well-Architected Tool Delete Profile Share
DeleteProfileShare 10 params → 200480481482483484485
GET
/profiles/{ProfileArn}
Amazon Well-Architected Tool Get Profile
GetProfile 9 params → 200480481482483484
PATCH
/profiles/{ProfileArn}
Amazon Well-Architected Tool Update Profile
UpdateProfile 8 params body → 200480481482483484485

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Profile (10 properties), ProfileQuestion (7 properties), ProfileShareSummary (4 properties), ProfileChoice (3 properties). Each schema is shown below with its type and property counts.

QuestionId
string
The ID of the question.
ThrottlingException
ShareStatus
string
The status of the share request.
GetProfileOutput
object
1 property
ChoiceTitle
string
The title of a choice.
CreateProfileShareOutput
object
2 properties
SharedWith
string
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
QuestionTitle
string
The title of the question.
InternalServerException
ProfileShareSummary
object
Summary of a profile share.
4 properties
AccessDeniedException
ShareId
string
The ID associated with the share.
ServiceQuotaExceededException
ShareInvitationId
string
MaxSelectedProfileChoices
integer
ProfileVersion
string
SelectedProfileChoiceIds
array
ProfileDescription
string
ProfileQuestionUpdate
object
An update to a profile question.
2 properties
ConflictException
MinSelectedProfileChoices
integer
ValidationException
ListProfileSharesOutput
object
2 properties
AwsAccountId
string
An Amazon Web Services account ID.
Profile
object
A profile.
10 properties
ProfileQuestions
array
TagValue
string
ProfileQuestion
object
A profile question.
7 properties
SelectedChoiceIds
array
ChoiceId
string
The ID of a choice.
ProfileQuestionChoices
array
QuestionDescription
string
The description of the question.
ProfileChoice
object
The profile choice.
3 properties
NextToken
string
The token to use to retrieve the next set of results.
Timestamp
string
The date and time recorded.
StatusMessage
string
ResourceNotFoundException
TagMap
object
ProfileShareSummaries
array
ChoiceDescription
string
The description of a choice.
ProfileArn
string
UpdateProfileOutput
object
1 property
ProfileName
string
CreateProfileOutput
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-well-architected-tool-profiles-api-openapi.yml Raw ↑

Other APIs Amazon Well-Architected Tool publishes across the network.

Amazon Well-Architected Tool ConsolidatedReport#Format API
Amazon Well-Architected Tool Global Settings API
Amazon Well-Architected Tool ImportLens API
Amazon Well-Architected Tool Lenses API
Amazon Well-Architected Tool Notifications API
Amazon Well-Architected Tool ProfileNotifications API
Amazon Well-Architected Tool ProfileSummaries API
Amazon Well-Architected Tool ProfileTemplate API
Amazon Well-Architected Tool ShareInvitations API
Amazon Well-Architected Tool Tags API
Amazon Well-Architected Tool Workloads API
Amazon Well-Architected Tool WorkloadsSummaries API
Where this information came from

This is an independent, third-party profile of Amazon Well-Architected Tool Profiles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.