WellArchitected

import { WellArchitected } from "https://aws-api.deno.dev/v0.4/services/wellarchitected.ts?docs=full";

class WellArchitected {

constructor(apiFactory: client.ApiFactory);

async associateLenses(params: AssociateLensesInput, opts?: client.RequestOptions): Promise<void>;

async createLensShare(params: CreateLensShareInput, opts?: client.RequestOptions): Promise<CreateLensShareOutput>;

async createLensVersion(params: CreateLensVersionInput, opts?: client.RequestOptions): Promise<CreateLensVersionOutput>;

async createMilestone(params: CreateMilestoneInput, opts?: client.RequestOptions): Promise<CreateMilestoneOutput>;

async createWorkload(params: CreateWorkloadInput, opts?: client.RequestOptions): Promise<CreateWorkloadOutput>;

async createWorkloadShare(params: CreateWorkloadShareInput, opts?: client.RequestOptions): Promise<CreateWorkloadShareOutput>;

async deleteLens(params: DeleteLensInput, opts?: client.RequestOptions): Promise<void>;

async deleteLensShare(params: DeleteLensShareInput, opts?: client.RequestOptions): Promise<void>;

async deleteWorkload(params: DeleteWorkloadInput, opts?: client.RequestOptions): Promise<void>;

async deleteWorkloadShare(params: DeleteWorkloadShareInput, opts?: client.RequestOptions): Promise<void>;

async disassociateLenses(params: DisassociateLensesInput, opts?: client.RequestOptions): Promise<void>;

async exportLens(params: ExportLensInput, opts?: client.RequestOptions): Promise<ExportLensOutput>;

async getAnswer(params: GetAnswerInput, opts?: client.RequestOptions): Promise<GetAnswerOutput>;

async getLens(params: GetLensInput, opts?: client.RequestOptions): Promise<GetLensOutput>;

async getLensReview(params: GetLensReviewInput, opts?: client.RequestOptions): Promise<GetLensReviewOutput>;

async getLensReviewReport(params: GetLensReviewReportInput, opts?: client.RequestOptions): Promise<GetLensReviewReportOutput>;

async getLensVersionDifference(params: GetLensVersionDifferenceInput, opts?: client.RequestOptions): Promise<GetLensVersionDifferenceOutput>;

async getMilestone(params: GetMilestoneInput, opts?: client.RequestOptions): Promise<GetMilestoneOutput>;

async getWorkload(params: GetWorkloadInput, opts?: client.RequestOptions): Promise<GetWorkloadOutput>;

async importLens(params: ImportLensInput, opts?: client.RequestOptions): Promise<ImportLensOutput>;

async listAnswers(params: ListAnswersInput, opts?: client.RequestOptions): Promise<ListAnswersOutput>;

async listCheckDetails(params: ListCheckDetailsInput, opts?: client.RequestOptions): Promise<ListCheckDetailsOutput>;

async listCheckSummaries(params: ListCheckSummariesInput, opts?: client.RequestOptions): Promise<ListCheckSummariesOutput>;

async listLenses(params?: ListLensesInput, opts?: client.RequestOptions): Promise<ListLensesOutput>;

async listLensReviewImprovements(params: ListLensReviewImprovementsInput, opts?: client.RequestOptions): Promise<ListLensReviewImprovementsOutput>;

async listLensReviews(params: ListLensReviewsInput, opts?: client.RequestOptions): Promise<ListLensReviewsOutput>;

async listLensShares(params: ListLensSharesInput, opts?: client.RequestOptions): Promise<ListLensSharesOutput>;

async listMilestones(params: ListMilestonesInput, opts?: client.RequestOptions): Promise<ListMilestonesOutput>;

async listNotifications(params?: ListNotificationsInput, opts?: client.RequestOptions): Promise<ListNotificationsOutput>;

async listShareInvitations(params?: ListShareInvitationsInput, opts?: client.RequestOptions): Promise<ListShareInvitationsOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async listWorkloads(params?: ListWorkloadsInput, opts?: client.RequestOptions): Promise<ListWorkloadsOutput>;

async listWorkloadShares(params: ListWorkloadSharesInput, opts?: client.RequestOptions): Promise<ListWorkloadSharesOutput>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;

async updateAnswer(params: UpdateAnswerInput, opts?: client.RequestOptions): Promise<UpdateAnswerOutput>;

async updateGlobalSettings(params?: UpdateGlobalSettingsInput, opts?: client.RequestOptions): Promise<void>;

async updateLensReview(params: UpdateLensReviewInput, opts?: client.RequestOptions): Promise<UpdateLensReviewOutput>;

async updateShareInvitation(params: UpdateShareInvitationInput, opts?: client.RequestOptions): Promise<UpdateShareInvitationOutput>;

async updateWorkload(params: UpdateWorkloadInput, opts?: client.RequestOptions): Promise<UpdateWorkloadOutput>;

async updateWorkloadShare(params: UpdateWorkloadShareInput, opts?: client.RequestOptions): Promise<UpdateWorkloadShareOutput>;

async upgradeLensReview(params: UpgradeLensReviewInput, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new WellArchitected(apiFactory: client.ApiFactory)

[src]

§Methods

associateLenses(params: AssociateLensesInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

createLensShare(params: CreateLensShareInput, opts?: client.RequestOptions): Promise<CreateLensShareOutput>

[src]

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.

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: CreateLensVersionInput, opts?: client.RequestOptions): Promise<CreateLensVersionOutput>

[src]

Create a new lens version.

A lens can have up to 100 versions.

After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

createMilestone(params: CreateMilestoneInput, opts?: client.RequestOptions): Promise<CreateMilestoneOutput>

[src]

Create a milestone for an existing workload.

createWorkload(params: CreateWorkloadInput, opts?: client.RequestOptions): Promise<CreateWorkloadOutput>

[src]

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, IAM 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.

createWorkloadShare(params: CreateWorkloadShareInput, opts?: client.RequestOptions): Promise<CreateWorkloadShareOutput>

[src]

Create a workload share.

The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.

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

deleteLens(params: DeleteLensInput, opts?: client.RequestOptions): Promise<void>

[src]

Delete an existing lens.

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM 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

deleteLensShare(params: DeleteLensShareInput, opts?: client.RequestOptions): Promise<void>

[src]

Delete a lens share.

After the lens share is deleted, Amazon Web Services accounts, IAM 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

deleteWorkload(params: DeleteWorkloadInput, opts?: client.RequestOptions): Promise<void>

[src]

Delete an existing workload.

deleteWorkloadShare(params: DeleteWorkloadShareInput, opts?: client.RequestOptions): Promise<void>

[src]

Delete a workload share.

disassociateLenses(params: DisassociateLensesInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

exportLens(params: ExportLensInput, opts?: client.RequestOptions): Promise<ExportLensOutput>

[src]

Export an existing lens.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it.

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: GetAnswerInput, opts?: client.RequestOptions): Promise<GetAnswerOutput>

[src]

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

getLens(params: GetLensInput, opts?: client.RequestOptions): Promise<GetLensOutput>

[src]

Get an existing lens.

getLensReview(params: GetLensReviewInput, opts?: client.RequestOptions): Promise<GetLensReviewOutput>

[src]

Get lens review.

getLensReviewReport(params: GetLensReviewReportInput, opts?: client.RequestOptions): Promise<GetLensReviewReportOutput>

[src]

Get lens review report.

getLensVersionDifference(params: GetLensVersionDifferenceInput, opts?: client.RequestOptions): Promise<GetLensVersionDifferenceOutput>

[src]

Get lens version differences.

getMilestone(params: GetMilestoneInput, opts?: client.RequestOptions): Promise<GetMilestoneOutput>

[src]

Get a milestone for an existing workload.

getWorkload(params: GetWorkloadInput, opts?: client.RequestOptions): Promise<GetWorkloadOutput>

[src]

Get an existing workload.

importLens(params: ImportLensInput, opts?: client.RequestOptions): Promise<ImportLensOutput>

[src]

Import a new lens.

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

listAnswers(params: ListAnswersInput, opts?: client.RequestOptions): Promise<ListAnswersOutput>

[src]

List of answers.

listCheckDetails(params: ListCheckDetailsInput, opts?: client.RequestOptions): Promise<ListCheckDetailsOutput>

[src]

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

listCheckSummaries(params: ListCheckSummariesInput, opts?: client.RequestOptions): Promise<ListCheckSummariesOutput>

[src]

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

listLenses(params?: ListLensesInput, opts?: client.RequestOptions): Promise<ListLensesOutput>

[src]

List the available lenses.

listLensReviewImprovements(params: ListLensReviewImprovementsInput, opts?: client.RequestOptions): Promise<ListLensReviewImprovementsOutput>

[src]

List lens review improvements.

listLensReviews(params: ListLensReviewsInput, opts?: client.RequestOptions): Promise<ListLensReviewsOutput>

[src]

List lens reviews.

listLensShares(params: ListLensSharesInput, opts?: client.RequestOptions): Promise<ListLensSharesOutput>

[src]

List the lens shares associated with the lens.

listMilestones(params: ListMilestonesInput, opts?: client.RequestOptions): Promise<ListMilestonesOutput>

[src]

List all milestones for an existing workload.

listNotifications(params?: ListNotificationsInput, opts?: client.RequestOptions): Promise<ListNotificationsOutput>

[src]

List lens notifications.

listShareInvitations(params?: ListShareInvitationsInput, opts?: client.RequestOptions): Promise<ListShareInvitationsOutput>

[src]

List the workload invitations.

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

List the tags for a resource.

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

listWorkloads(params?: ListWorkloadsInput, opts?: client.RequestOptions): Promise<ListWorkloadsOutput>

[src]

List workloads. Paginated.

listWorkloadShares(params: ListWorkloadSharesInput, opts?: client.RequestOptions): Promise<ListWorkloadSharesOutput>

[src]

List the workload shares associated with the workload.

tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to the specified resource.

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

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes specified tags from a resource.

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

updateAnswer(params: UpdateAnswerInput, opts?: client.RequestOptions): Promise<UpdateAnswerOutput>

[src]

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

updateGlobalSettings(params?: UpdateGlobalSettingsInput, opts?: client.RequestOptions): Promise<void>

[src]

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

updateLensReview(params: UpdateLensReviewInput, opts?: client.RequestOptions): Promise<UpdateLensReviewOutput>

[src]

Update lens review.

updateShareInvitation(params: UpdateShareInvitationInput, opts?: client.RequestOptions): Promise<UpdateShareInvitationOutput>

[src]

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: UpdateWorkloadInput, opts?: client.RequestOptions): Promise<UpdateWorkloadOutput>

[src]

Update an existing workload.

updateWorkloadShare(params: UpdateWorkloadShareInput, opts?: client.RequestOptions): Promise<UpdateWorkloadShareOutput>

[src]

Update a workload share.

upgradeLensReview(params: UpgradeLensReviewInput, opts?: client.RequestOptions): Promise<void>

[src]

Upgrade lens review.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]