AWS.WellArchitected — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateLenses(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

associateProfiles(params = {}, callback) ⇒ AWS.Request

Associate a profile with a workload.

createLensShare(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

createLensVersion(params = {}, callback) ⇒ AWS.Request

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.

createMilestone(params = {}, callback) ⇒ AWS.Request

Create a milestone for an existing workload.

createProfile(params = {}, callback) ⇒ AWS.Request

createProfileShare(params = {}, callback) ⇒ AWS.Request

createReviewTemplate(params = {}, callback) ⇒ AWS.Request

Create a review template.

Note: Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template 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.

createTemplateShare(params = {}, callback) ⇒ AWS.Request

Create a review template share.

The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.

Shared access to a review template is not removed until the review template share invitation is deleted.

If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.

Note: Disclaimer By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

createWorkload(params = {}, callback) ⇒ AWS.Request

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.

When creating a workload using a review template, you must have the following IAM permissions:

createWorkloadShare(params = {}, callback) ⇒ AWS.Request

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.

deleteLens(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

deleteLensShare(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

deleteProfile(params = {}, callback) ⇒ AWS.Request

Delete a profile.

Note: Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.

deleteProfileShare(params = {}, callback) ⇒ AWS.Request

deleteReviewTemplate(params = {}, callback) ⇒ AWS.Request

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

deleteTemplateShare(params = {}, callback) ⇒ AWS.Request

Delete a review template share.

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

deleteWorkload(params = {}, callback) ⇒ AWS.Request

Delete an existing workload.

deleteWorkloadShare(params = {}, callback) ⇒ AWS.Request

disassociateLenses(params = {}, callback) ⇒ AWS.Request

Disassociate a lens from a workload.

Up to 10 lenses can be disassociated from a workload in a single API operation.

Note: The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

disassociateProfiles(params = {}, callback) ⇒ AWS.Request

Disassociate a profile from a workload.

exportLens(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

getAnswer(params = {}, callback) ⇒ AWS.Request

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

getConsolidatedReport(params = {}, callback) ⇒ AWS.Request

Get a consolidated report of your workloads.

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

getGlobalSettings(params = {}, callback) ⇒ AWS.Request

Global settings for all workloads.

getLensReview(params = {}, callback) ⇒ AWS.Request

getLensReviewReport(params = {}, callback) ⇒ AWS.Request

getLensVersionDifference(params = {}, callback) ⇒ AWS.Request

Get lens version differences.

getMilestone(params = {}, callback) ⇒ AWS.Request

Get a milestone for an existing workload.

getProfileTemplate(params = {}, callback) ⇒ AWS.Request

getReviewTemplate(params = {}, callback) ⇒ AWS.Request

getReviewTemplateAnswer(params = {}, callback) ⇒ AWS.Request

Get review template answer.

getReviewTemplateLensReview(params = {}, callback) ⇒ AWS.Request

Get a lens review associated with a review template.

getWorkload(params = {}, callback) ⇒ AWS.Request

Get an existing workload.

importLens(params = {}, callback) ⇒ AWS.Request

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.

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.

Note: 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.

listAnswers(params = {}, callback) ⇒ AWS.Request

List of answers for a particular workload and lens.

listCheckDetails(params = {}, callback) ⇒ AWS.Request

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

listCheckSummaries(params = {}, callback) ⇒ AWS.Request

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

listLenses(params = {}, callback) ⇒ AWS.Request

List the available lenses.

listLensReviewImprovements(params = {}, callback) ⇒ AWS.Request

List the improvements of a particular lens review.

listLensReviews(params = {}, callback) ⇒ AWS.Request

List lens reviews for a particular workload.

listLensShares(params = {}, callback) ⇒ AWS.Request

List the lens shares associated with the lens.

listMilestones(params = {}, callback) ⇒ AWS.Request

List all milestones for an existing workload.

listNotifications(params = {}, callback) ⇒ AWS.Request

listProfileNotifications(params = {}, callback) ⇒ AWS.Request

List profile notifications.

listProfileShares(params = {}, callback) ⇒ AWS.Request

listReviewTemplateAnswers(params = {}, callback) ⇒ AWS.Request

List the answers of a review template.

listReviewTemplates(params = {}, callback) ⇒ AWS.Request

listShareInvitations(params = {}, callback) ⇒ AWS.Request

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List the tags for a resource.

Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

listTemplateShares(params = {}, callback) ⇒ AWS.Request

List review template shares.

listWorkloads(params = {}, callback) ⇒ AWS.Request

Paginated list of workloads.

listWorkloadShares(params = {}, callback) ⇒ AWS.Request

List the workload shares associated with the workload.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to the specified resource.

Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes specified tags from a resource.

Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

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

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

updateAnswer(params = {}, callback) ⇒ AWS.Request

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

updateGlobalSettings(params = {}, callback) ⇒ AWS.Request

Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

updateIntegration(params = {}, callback) ⇒ AWS.Request

Update integration features.

updateLensReview(params = {}, callback) ⇒ AWS.Request

Update lens review for a particular workload.

updateProfile(params = {}, callback) ⇒ AWS.Request

updateReviewTemplate(params = {}, callback) ⇒ AWS.Request

Update a review template.

updateReviewTemplateAnswer(params = {}, callback) ⇒ AWS.Request

Update a review template answer.

updateReviewTemplateLensReview(params = {}, callback) ⇒ AWS.Request

Update a lens review associated with a review template.

updateShareInvitation(params = {}, callback) ⇒ AWS.Request

Update a workload or custom lens share invitation.

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

updateWorkload(params = {}, callback) ⇒ AWS.Request

Update an existing workload.

updateWorkloadShare(params = {}, callback) ⇒ AWS.Request

upgradeLensReview(params = {}, callback) ⇒ AWS.Request

Upgrade lens review for a particular workload.

upgradeProfileVersion(params = {}, callback) ⇒ AWS.Request

upgradeReviewTemplateLensReview(params = {}, callback) ⇒ AWS.Request

Upgrade the lens review of a review template.