amazonaws.com – wellarchitected

Tools (45)

Extracted live via the executor SDK.

• consolidatedReportFormat.getConsolidatedReport

  Get a consolidated report of your workloads.

  You can optionally choose to include workloads that have been shared with you.

• globalSettings.updateGlobalSettings

  Updates whether the Amazon Web Services account is opted into organization sharing features.

• importLens.putOperation

  Import a new custom lens or update an existing custom lens.

  To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created.

  The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion [blocked].

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

  A custom lens cannot exceed 500 KB in size.

  Disclaimer

  Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

• lenses.createLensShare

  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 lens.

  For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.

  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 continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

• lenses.createLensVersion

  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.

• lenses.deleteLens

  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 continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

• lenses.deleteLensShare

  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 may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

• lenses.exportLens

  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 identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

• lenses.getLens

  Get an existing lens.

• lenses.getLensVersionDifference

  Get lens version differences.

• lenses.listLenses

  List the available lenses.

• lenses.listLensShares

  List the lens shares associated with the lens.

• notifications.listNotifications

  List lens notifications.

• shareInvitations.listShareInvitations

  List the workload invitations.

• shareInvitations.updateShareInvitation

  Update a workload or custom lens share invitation.

  This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

• tags.listTagsForResource

  List the tags for a resource.

  The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

• tags.tagResource

  Adds one or more tags to the specified resource.

  The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

• tags.untagResource

  Deletes specified tags from a resource.

  The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

  To specify multiple tags, use separate tagKeys parameters, for example:

  DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

• workloads.associateLenses

  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.

• workloads.createMilestone

  Create a milestone for an existing workload.

• workloads.createWorkload

  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 AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

  You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

• workloads.createWorkloadShare

  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 Sharing a workload in the Well-Architected Tool User Guide.

• workloads.deleteWorkload

  Delete an existing workload.

• workloads.deleteWorkloadShare

  Delete a workload share.

• workloads.disassociateLenses

  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 (wellarchitected) cannot be removed from a workload.

• workloads.getAnswer

  Get the answer to a specific question in a workload review.

• workloads.getLensReview

  Get lens review.

• workloads.getLensReviewReport

  Get lens review report.

• workloads.getMilestone

  Get a milestone for an existing workload.

• workloads.getWorkload

  Get an existing workload.

• workloads.listAnswers

  List of answers for a particular workload and lens.

• workloads.listCheckDetails

  List of Trusted Advisor check details by account related to the workload.

• workloads.listCheckSummaries

  List of Trusted Advisor checks summarized for all accounts related to the workload.

• workloads.listLensReviewImprovements

  List lens review improvements.

• workloads.listLensReviews

  List lens reviews for a particular workload.

• workloads.listMilestones

  List all milestones for an existing workload.

• workloads.listWorkloadShares

  List the workload shares associated with the workload.

• workloads.updateAnswer

  Update the answer to a specific question in a workload review.

• workloads.updateLensReview

  Update lens review for a particular workload.

• workloads.updateWorkload

  Update an existing workload.

• workloads.updateWorkloadShare

  Update a workload share.

• workloads.upgradeLensReview

  Upgrade lens review for a particular workload.

• workloadsSummaries.listWorkloads

  Paginated list of workloads.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools