AWS Well-Architected Tool

amazonaws · Cloud

Cloud No Auth Free & Open cloud

Well-Architected Tool This is the Well-Architected Tool API Reference . The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console . For information about the Well-Architected Tool, see the Well-Architected To

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET GetConsolidatedReport

Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.

https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format?Format=PDF&NextToken=example&MaxResults=1&IncludeSharedResources=true

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format?Format=PDF&NextToken=example&MaxResults=1&IncludeSharedResources=true"

import requests
params = {
    "Format": "PDF",
    "NextToken": "example",
    "MaxResults": "1",
    "IncludeSharedResources": "true"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format');
url.searchParams.set('Format', 'PDF');
url.searchParams.set('NextToken', 'example');
url.searchParams.set('MaxResults', '1');
url.searchParams.set('IncludeSharedResources', 'true');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format")
	q := baseURL.Query()
	q.Set("Format", "PDF")
	q.Set("NextToken", "example")
	q.Set("MaxResults", "1")
	q.Set("IncludeSharedResources", "true")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format")
uri.query = URI.encode_www_form({
  "Format" => "PDF",
  "NextToken" => "example",
  "MaxResults" => "1",
  "IncludeSharedResources" => "true"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/consolidatedReport#Format?" . http_build_query([
    "Format" => "PDF",
    "NextToken" => "example",
    "MaxResults" => "1",
    "IncludeSharedResources" => "true"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET ListLenses

List the available lenses.

https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses?LensName=example&LensType=AWS_OFFICIAL&NextToken=example&LensStatus=ALL&MaxResults=1

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses?LensName=example&LensType=AWS_OFFICIAL&NextToken=example&LensStatus=ALL&MaxResults=1"

import requests
params = {
    "LensName": "example",
    "LensType": "AWS_OFFICIAL",
    "NextToken": "example",
    "LensStatus": "ALL",
    "MaxResults": "1"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses');
url.searchParams.set('LensName', 'example');
url.searchParams.set('LensType', 'AWS_OFFICIAL');
url.searchParams.set('NextToken', 'example');
url.searchParams.set('LensStatus', 'ALL');
url.searchParams.set('MaxResults', '1');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses")
	q := baseURL.Query()
	q.Set("LensName", "example")
	q.Set("LensType", "AWS_OFFICIAL")
	q.Set("NextToken", "example")
	q.Set("LensStatus", "ALL")
	q.Set("MaxResults", "1")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses")
uri.query = URI.encode_www_form({
  "LensName" => "example",
  "LensType" => "AWS_OFFICIAL",
  "NextToken" => "example",
  "LensStatus" => "ALL",
  "MaxResults" => "1"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/lenses?" . http_build_query([
    "LensName" => "example",
    "LensType" => "AWS_OFFICIAL",
    "NextToken" => "example",
    "LensStatus" => "ALL",
    "MaxResults" => "1"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET ListShareInvitations

List the workload invitations.

https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations?NextToken=example&MaxResults=1&LensNamePrefix=example&ShareResourceType=WORKLOAD&WorkloadNamePrefix=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations?NextToken=example&MaxResults=1&LensNamePrefix=example&ShareResourceType=WORKLOAD&WorkloadNamePrefix=example"

import requests
params = {
    "NextToken": "example",
    "MaxResults": "1",
    "LensNamePrefix": "example",
    "ShareResourceType": "WORKLOAD",
    "WorkloadNamePrefix": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations');
url.searchParams.set('NextToken', 'example');
url.searchParams.set('MaxResults', '1');
url.searchParams.set('LensNamePrefix', 'example');
url.searchParams.set('ShareResourceType', 'WORKLOAD');
url.searchParams.set('WorkloadNamePrefix', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations")
	q := baseURL.Query()
	q.Set("NextToken", "example")
	q.Set("MaxResults", "1")
	q.Set("LensNamePrefix", "example")
	q.Set("ShareResourceType", "WORKLOAD")
	q.Set("WorkloadNamePrefix", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations")
uri.query = URI.encode_www_form({
  "NextToken" => "example",
  "MaxResults" => "1",
  "LensNamePrefix" => "example",
  "ShareResourceType" => "WORKLOAD",
  "WorkloadNamePrefix" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/wellarchitected/2020-03-31/shareInvitations?" . http_build_query([
    "NextToken" => "example",
    "MaxResults" => "1",
    "LensNamePrefix" => "example",
    "ShareResourceType" => "WORKLOAD",
    "WorkloadNamePrefix" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with AWS Well-Architected Tool?

AWS Well-Architected Tool is a Cloud API. Developers commonly use cloud APIs for:

provisioning and managing cloud infrastructure
automating deployments and container orchestration
monitoring uptime and performance metrics
managing storage buckets and databases
setting up auto-scaling and load balancing

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. AWS Well-Architected Tool is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗