Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

WellArchitected

import { WellArchitected } from "https://aws-api.deno.dev/v0.2/services/wellarchitected.ts?docs=full";
class WellArchitected {
constructor(apiFactory: client.ApiFactory);
async associateLenses(params: AssociateLensesInput, opts?: client.RequestOptions): Promise<void>;
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 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 getAnswer(params: GetAnswerInput, opts?: client.RequestOptions): Promise<GetAnswerOutput>;
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 listAnswers(params: ListAnswersInput, opts?: client.RequestOptions): Promise<ListAnswersOutput>;
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 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 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.

§
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 AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the AWS 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 AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.

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

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

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

§
getAnswer(params: GetAnswerInput, opts?: client.RequestOptions): Promise<GetAnswerOutput>
[src]

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

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

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

List of answers.

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

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

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

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

Deletes specified tags from a resource.

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.

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

Update lens review.

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

Update a workload invitation.

§
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