# AWS Well-Architected Tool API

> AWS Well-Architected Tool API on Apizie: 56 endpoints (Associate a lens to a workload. Up to 10 lenses can be associated with a workload in a single API operation.…, Associate a profile with a workload., List the lens shares associated with the lens., Create a lens share. The owner of a lens can share it with other Amazon Web Services accounts, users, an…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-wellarchitected`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-wellarchitected
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-wellarchitected/openapi.json

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…

## Endpoints

### Associate a lens to a workload. Up to 10 lenses can be associated with a workload in a single API operation.…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/associate-lenses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Associate a profile with a workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/associate-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### List the lens shares associated with the lens.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-lens-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| SharedWithPrefix | string | no | The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared. |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |
| Status | string | no |  |

### Create a lens share. The owner of a lens can share it with other Amazon Web Services accounts, users, an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-lens-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| body | object | yes | JSON request body |

### Create a new lens version. A lens can have up to 100 versions. Use this operation to publish a new lens…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-lens-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| body | object | yes | JSON request body |

### Create a milestone for an existing workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-milestone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Create a profile.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### List profile shares.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-profile-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ProfileArn | string | yes | The profile ARN. |
| SharedWithPrefix | string | no | The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared. |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |
| Status | string | no |  |

### Create a profile share.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-profile-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ProfileArn | string | yes | The profile ARN. |
| body | object | yes | JSON request body |

### Create a new workload. The owner of a workload can share the workload with other Amazon Web Services…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-workload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### List the workload shares associated with the workload.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-workload-shares` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| SharedWithPrefix | string | no | The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared. |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |
| Status | string | no |  |

### Create a workload share. The owner of a workload can share it with other Amazon Web Services accounts and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/create-workload-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Delete an existing lens. Only the owner of a lens can delete it. After the lens is deleted, Amazon Web…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/delete-lens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| ClientRequestToken | string | yes |  |
| LensStatus | string | yes | The status of the lens to be deleted. |

### Delete a lens share. After the lens share is deleted, Amazon Web Services accounts, users, organizations,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/delete-lens-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ShareId | string | yes |  |
| LensAlias | string | yes |  |
| ClientRequestToken | string | yes |  |

### Delete a profile. Disclaimer By sharing your profile with other Amazon Web Services accounts, you…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/delete-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ProfileArn | string | yes | The profile ARN. |
| ClientRequestToken | string | yes |  |

### Delete a profile share.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/delete-profile-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ShareId | string | yes |  |
| ProfileArn | string | yes | The profile ARN. |
| ClientRequestToken | string | yes |  |

### Delete an existing workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/delete-workload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| ClientRequestToken | string | yes |  |

### Delete a workload share.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/delete-workload-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ShareId | string | yes |  |
| WorkloadId | string | yes |  |
| ClientRequestToken | string | yes |  |

### Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a workload in a single API…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/disassociate-lenses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Disassociate a profile from a workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/disassociate-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Export an existing lens. Only the owner of a lens can export it. Lenses provided by Amazon Web Services…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/export-lens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| LensVersion | string | no | The lens version to be exported. |

### Get the answer to a specific question in a workload review.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-answer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| QuestionId | string | yes |  |
| MilestoneNumber | integer | no |  |

### Update the answer to a specific question in a workload review.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-answer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| QuestionId | string | yes |  |
| body | object | yes | JSON request body |

### Get a consolidated report of your workloads. You can optionally choose to include workloads that have been…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-consolidated-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| Format | string | yes | The format of the consolidated report. For PDF , Base64String is returned. For JSON , Metrics is returned. |
| IncludeSharedResources | boolean | no | Set to true to have shared resources included in the report. |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |

### Get an existing lens.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-lens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| LensVersion | string | no | The lens version to be retrieved. |

### Get lens review.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-lens-review` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| MilestoneNumber | integer | no |  |

### Update lens review for a particular workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-lens-review` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| body | object | yes | JSON request body |

### Get lens review report.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-lens-review-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| MilestoneNumber | integer | no |  |

### Get lens version differences.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-lens-version-difference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| LensAlias | string | yes |  |
| BaseLensVersion | string | no | The base version of the lens. |
| TargetLensVersion | string | no | The lens version to target a difference for. |

### Get a milestone for an existing workload.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-milestone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| MilestoneNumber | integer | yes |  |

### Get profile information.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ProfileArn | string | yes | The profile ARN. |
| ProfileVersion | string | no | The profile version. |

### Update a profile.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ProfileArn | string | yes | The profile ARN. |
| body | object | yes | JSON request body |

### Get profile template.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-profile-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |

### Get an existing workload.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/get-workload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |

### Update an existing workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-workload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Import a new custom lens or update an existing custom lens. To update an existing custom lens, specify its…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/import-lens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### List of answers for a particular workload and lens.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-answers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| PillarId | string | no |  |
| MilestoneNumber | integer | no |  |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |
| QuestionPriority | string | no | The priority of the question. |

### List of Trusted Advisor check details by account related to the workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-check-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### List of Trusted Advisor checks summarized for all accounts related to the workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-check-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### List lens review improvements.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-lens-review-improvements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| PillarId | string | no |  |
| MilestoneNumber | integer | no |  |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |
| QuestionPriority | string | no | The priority of the question. |

### List lens reviews for a particular workload.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-lens-reviews` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| MilestoneNumber | integer | no |  |
| NextToken | string | no |  |
| MaxResults | integer | no |  |

### List the available lenses.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-lenses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NextToken | string | no |  |
| MaxResults | integer | no |  |
| LensType | string | no | The type of lenses to be returned. |
| LensStatus | string | no | The status of lenses to be returned. |
| LensName | string | no |  |

### List all milestones for an existing workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-milestones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### List lens notifications.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### List profile notifications.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-profile-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | no |  |
| NextToken | string | no |  |
| MaxResults | integer | no |  |

### List profiles.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ProfileNamePrefix | string | no | Prefix for profile name. |
| ProfileOwnerType | string | no | Profile owner type. |
| NextToken | string | no |  |
| MaxResults | integer | no |  |

### List the workload invitations.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-share-invitations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadNamePrefix | string | no |  |
| LensNamePrefix | string | no | An optional string added to the beginning of each lens name returned in the results. |
| ShareResourceType | string | no | The type of share invitations to be returned. |
| NextToken | string | no |  |
| MaxResults | integer | no | The maximum number of results to return for this request. |
| ProfileNamePrefix | string | no | Profile name prefix. |

### List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadArn | string | yes |  |

### Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadArn | string | yes |  |
| body | object | yes | JSON request body |

### Paginated list of workloads.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/list-workloads` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadArn | string | yes |  |
| tagKeys | array | yes | A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource. |

### Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-global-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Update a workload or custom lens share invitation. This API operation can be called independently of any…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-share-invitation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ShareInvitationId | string | yes | The ID assigned to the share invitation. |
| body | object | yes | JSON request body |

### Update a workload share.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/update-workload-share` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ShareId | string | yes |  |
| WorkloadId | string | yes |  |
| body | object | yes | JSON request body |

### Upgrade lens review for a particular workload.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/upgrade-lens-review` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| LensAlias | string | yes |  |
| body | object | yes | JSON request body |

### Upgrade a profile.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/upgrade-profile-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| WorkloadId | string | yes |  |
| ProfileArn | string | yes | The profile ARN. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/associate-lenses" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS Well-Architected Tool API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-wellarchitected/associate-lenses with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS Well-Architected Tool API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS Well-Architected Tool itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS Well-Architected Tool API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-wellarchitected.

### What is the status of the AWS Well-Architected Tool API?
Needs your own provider key (bring your own key)