{ "opencollection": "1.0.0", "info": { "name": "AWS Well-Architected Tool ConsolidatedReport#Format Workloads API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Workloads", "type": "folder" }, "items": [ { "info": { "name": "Amazon Well-Architected Tool Associate Lenses", "type": "http" }, "http": { "method": "PATCH", "url": "http://wellarchitected.{region}.amazonaws.com/workloads/:WorkloadId/associateLenses", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "WorkloadId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Associate a lens to a workload.
Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.
Disclaimer
By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either Create a workload share. The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted. If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload. For more information, see Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a workload in a single API operation. The Amazon Web Services Well-Architected Framework lens (AwsRegions<"
},
{
"info": {
"name": "Amazon Well-Architected Tool List Workload Shares",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://wellarchitected.{region}.amazonaws.com/workloads/:WorkloadId/shares",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "WorkloadId",
"value": "",
"type": "path"
},
{
"name": "SharedWithPrefix",
"value": "",
"type": "query",
"description": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared."
},
{
"name": "NextToken",
"value": "",
"type": "query"
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "The maximum number of results to return for this request."
},
{
"name": "Status",
"value": "",
"type": "query"
}
]
},
"docs": "List the workload shares associated with the workload."
},
{
"info": {
"name": "Amazon Well-Architected Tool Create Workload Share",
"type": "http"
},
"http": {
"method": "POST",
"url": "http://wellarchitected.{region}.amazonaws.com/workloads/:WorkloadId/shares",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "WorkloadId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "wellarchitected) cannot be removed from a workload.