{ "opencollection": "1.0.0", "info": { "name": "AWS Well-Architected Tool ConsolidatedReport#Format Lenses API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Lenses", "type": "folder" }, "items": [ { "info": { "name": "Amazon Well-Architected Tool List Lens Shares", "type": "http" }, "http": { "method": "GET", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias/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": "LensAlias", "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 lens 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 lens shares associated with the lens." }, { "info": { "name": "Amazon Well-Architected Tool Create Lens Share", "type": "http" }, "http": { "method": "POST", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias/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": "LensAlias", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

Shared access to a lens is not removed until the lens invitation is deleted.

If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the" }, { "info": { "name": "Amazon Well-Architected Tool Create Lens Version", "type": "http" }, "http": { "method": "POST", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias/versions", "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": "LensAlias", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Create a new lens version.

A lens can have up to 100 versions.

Use this operation to publish a new lens version after you have imported a lens. The LensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

" }, { "info": { "name": "Amazon Well-Architected Tool Delete Lens", "type": "http" }, "http": { "method": "DELETE", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias#ClientRequestToken&LensStatus", "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": "LensAlias", "value": "", "type": "path" }, { "name": "ClientRequestToken", "value": "", "type": "query" }, { "name": "LensStatus", "value": "", "type": "query", "description": "The status of the lens to be deleted." } ] }, "docs": "

Delete an existing lens.

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Disclaimer

By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may " }, { "info": { "name": "Amazon Well-Architected Tool Delete Lens Share", "type": "http" }, "http": { "method": "DELETE", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias/shares/:ShareId#ClientRequestToken", "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": "ShareId", "value": "", "type": "path" }, { "name": "LensAlias", "value": "", "type": "path" }, { "name": "ClientRequestToken", "value": "", "type": "query" } ] }, "docs": "

Delete a lens share.

After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Disclaimer

By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts" }, { "info": { "name": "Amazon Well-Architected Tool Export Lens", "type": "http" }, "http": { "method": "GET", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias/export", "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": "LensAlias", "value": "", "type": "path" }, { "name": "LensVersion", "value": "", "type": "query", "description": "The lens version to be exported." } ] }, "docs": "

Export an existing lens.

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.

Disclaimer

Do not include or gather personal identifia" }, { "info": { "name": "Amazon Well-Architected Tool Get Lens", "type": "http" }, "http": { "method": "GET", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias", "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": "LensAlias", "value": "", "type": "path" }, { "name": "LensVersion", "value": "", "type": "query", "description": "The lens version to be retrieved." } ] }, "docs": "Get an existing lens." }, { "info": { "name": "Amazon Well-Architected Tool Get Lens Version Difference", "type": "http" }, "http": { "method": "GET", "url": "http://wellarchitected.{region}.amazonaws.com/lenses/:LensAlias/versionDifference", "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": "LensAlias", "value": "", "type": "path" }, { "name": "BaseLensVersion", "value": "", "type": "query", "description": "The base version of the lens." }, { "name": "TargetLensVersion", "value": "", "type": "query", "description": "The lens version to target a difference for." } ] }, "docs": "Get lens version differences." }, { "info": { "name": "Amazon Well-Architected Tool List Lenses", "type": "http" }, "http": { "method": "GET", "url": "http://wellarchitected.{region}.amazonaws.com/lenses", "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": "NextToken", "value": "", "type": "query" }, { "name": "MaxResults", "value": "", "type": "query" }, { "name": "LensType", "value": "", "type": "query", "description": "The type of lenses to be returned." }, { "name": "LensStatus", "value": "", "type": "query", "description": "The status of lenses to be returned." }, { "name": "LensName", "value": "", "type": "query" } ] }, "docs": "List the available lenses." } ] } ], "bundled": true }