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 ConsolidatedReport#Format API

The ConsolidatedReport#Format API from Amazon Well-Architected Tool — 1 operation(s) for consolidatedreport#format.

Amazon Well-Architected Tool ConsolidatedReport#Format 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 ConsolidatedReport#Format. 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 1 operation across 1 path, and defines 32 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.

1 operations 1 paths 32 schemas 1 GET

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 ConsolidatedReport#Format 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

ConsolidatedReport#Format 1
GET
/consolidatedReport#Format
Amazon Well-Architected Tool Get Consolidated Report
GetConsolidatedReport 11 params → 200480481482483484

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ConsolidatedReportMetric (8 properties), PillarMetric (3 properties), QuestionMetric (3 properties), GetConsolidatedReportOutput (3 properties). Each schema is shown below with its type and property counts.

LensMetric
object
A metric for a particular lens in a workload.
3 properties
QuestionId
string
The ID of the question.
ThrottlingException
GetConsolidatedReportOutput
object
3 properties
RiskCounts
object
A map from risk names to the count of how many questions have that rating.
LensArn
string
ChoiceTitle
string
The title of a choice.
LensesAppliedCount
integer
LensMetrics
array
InternalServerException
AccessDeniedException
MetricType
string
ConflictException
ValidationException
QuestionMetric
object
A metric for a particular question in the pillar.
3 properties
WorkloadId
string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadName
string
The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking f…
ChoiceId
string
The ID of a choice.
ConsolidatedReportMetrics
array
BestPractice
object
A best practice, or question choice, that has been identified as a risk in this question.
2 properties
Risk
string
The risk for a given workload, lens review, pillar, or question.
NextToken
string
The token to use to retrieve the next set of results.
Timestamp
string
The date and time recorded.
PillarMetrics
array
BestPractices
array
QuestionMetrics
array
PillarId
string
The ID used to identify a pillar, for example, security . A pillar is identified by its PillarReviewSummary$PillarId .
PillarMetric
object
A metric for a particular pillar in a lens.
3 properties
Base64String
string
The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when PDF f…
Count
integer
A non-negative integer that denotes how many.
WorkloadArn
string
The ARN for the workload.
ConsolidatedReportMetric
object
A metric that contributes to the consolidated report.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-well-architected-tool-consolidatedreport-format-api-openapi.yml Raw ↑

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

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 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 ConsolidatedReport#Format 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.