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 Lenses API

The Lenses API from Amazon Well-Architected Tool — 8 operation(s) for lenses.

Amazon Well-Architected Tool Lenses 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 Lenses. 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 9 operations across 8 paths, and defines 48 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.

9 operations 8 paths 48 schemas 2 DELETE5 GET2 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 Lenses 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 9

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

Lenses 9
POST
/lenses/{LensAlias}/shares
Amazon Well-Architected Tool Create Lens Share
CreateLensShare 8 params body → 200480481482483484485486
GET
/lenses/{LensAlias}/shares
Amazon Well-Architected Tool List Lens Shares
ListLensShares 12 params → 200480481482483484
POST
/lenses/{LensAlias}/versions
Amazon Well-Architected Tool Create Lens Version
CreateLensVersion 8 params body → 200480481482483484485486
DELETE
/lenses/{LensAlias}#ClientRequestToken&LensStatus
Amazon Well-Architected Tool Delete Lens
DeleteLens 10 params → 200480481482483484485
DELETE
/lenses/{LensAlias}/shares/{ShareId}#ClientRequestToken
Amazon Well-Architected Tool Delete Lens Share
DeleteLensShare 10 params → 200480481482483484485
GET
/lenses/{LensAlias}/export
Amazon Well-Architected Tool Export Lens
ExportLens 9 params → 200480481482483484
GET
/lenses/{LensAlias}
Amazon Well-Architected Tool Get Lens
GetLens 9 params → 200480481482483484
GET
/lenses/{LensAlias}/versionDifference
Amazon Well-Architected Tool Get Lens Version Difference
GetLensVersionDifference 10 params → 200480481482483484
GET
/lenses
Amazon Well-Architected Tool List Lenses
ListLenses 12 params → 200480481482483

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are LensSummary (10 properties), Lens (7 properties), GetLensVersionDifferenceOutput (6 properties), LensShareSummary (4 properties). Each schema is shown below with its type and property counts.

QuestionDifference
object
A question difference return object.
3 properties
QuestionId
string
The ID of the question.
LensType
string
ThrottlingException
PillarName
string
The name of the pillar.
LensArn
string
ListLensSharesOutput
object
2 properties
LensShareSummary
object
A lens share summary return object.
4 properties
ShareStatus
string
The status of the share request.
LensStatus
string
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
AccessDeniedException
ShareId
string
The ID associated with the share.
ServiceQuotaExceededException
CreateLensVersionOutput
object
2 properties
ShareInvitationId
string
LensJSON
string
DifferenceStatus
string
LensSummary
object
A lens summary of a lens.
10 properties
GetLensOutput
object
1 property
PillarDifferences
array
ConflictException
ValidationException
LensShareSummaries
array
AwsAccountId
string
An Amazon Web Services account ID.
VersionDifferences
object
The differences between the base and latest versions of the lens.
1 property
LensDescription
string
The description of the lens.
Lens
object
A lens return object.
7 properties
TagValue
string
ListLensesOutput
object
Output of a list lenses call.
2 properties
NextToken
string
The token to use to retrieve the next set of results.
LensSummaries
array
List of lens summaries of available lenses.
ExportLensOutput
object
1 property
Timestamp
string
The date and time recorded.
QuestionDifferences
array
LensVersion
string
PillarId
string
The ID used to identify a pillar, for example, security . A pillar is identified by its PillarReviewSummary$PillarId .
LensOwner
string
CreateLensShareOutput
object
1 property
StatusMessage
string
GetLensVersionDifferenceOutput
object
6 properties
ResourceNotFoundException
TagMap
object
LensName
string
The full name of the lens.
LensAlias
string
The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchit…
PillarDifference
object
A pillar difference return object.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-well-architected-tool-lenses-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 Notifications API
Amazon Well-Architected Tool ProfileNotifications API
Amazon Well-Architected Tool Profiles 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 Lenses 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.