WellArchitectedClient

Well-Architected Tool

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.

Properties

Link copied to clipboard
abstract override val config: WellArchitectedClient.Config

WellArchitectedClient's configuration

Functions

Link copied to clipboard

Associate a lens to a workload.

Link copied to clipboard

Associate a profile with a workload.

Link copied to clipboard

Create a lens share.

Link copied to clipboard

Create a new lens version.

Link copied to clipboard

Create a milestone for an existing workload.

Link copied to clipboard

Create a profile.

Link copied to clipboard

Create a profile share.

Link copied to clipboard

Create a review template.

Link copied to clipboard

Create a review template share.

Link copied to clipboard

Create a new workload.

Link copied to clipboard

Create a workload share.

Link copied to clipboard
abstract suspend fun deleteLens(input: DeleteLensRequest): DeleteLensResponse

Delete an existing lens.

Link copied to clipboard

Delete a lens share.

Link copied to clipboard

Delete a profile.

Link copied to clipboard

Delete a profile share.

Link copied to clipboard

Delete a review template.

Link copied to clipboard

Delete a review template share.

Link copied to clipboard

Delete an existing workload.

Link copied to clipboard

Delete a workload share.

Link copied to clipboard

Disassociate a lens from a workload.

Link copied to clipboard

Disassociate a profile from a workload.

Link copied to clipboard
abstract suspend fun exportLens(input: ExportLensRequest): ExportLensResponse

Export an existing lens.

Link copied to clipboard
abstract suspend fun getAnswer(input: GetAnswerRequest): GetAnswerResponse

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

Link copied to clipboard

Get a consolidated report of your workloads.

Link copied to clipboard
abstract suspend fun getGlobalSettings(input: GetGlobalSettingsRequest = GetGlobalSettingsRequest { }): GetGlobalSettingsResponse

Global settings for all workloads.

Link copied to clipboard
abstract suspend fun getLens(input: GetLensRequest): GetLensResponse

Get an existing lens.

Link copied to clipboard

Get lens review.

Link copied to clipboard

Get lens review report.

Link copied to clipboard

Get lens version differences.

Link copied to clipboard

Get a milestone for an existing workload.

Link copied to clipboard
abstract suspend fun getProfile(input: GetProfileRequest): GetProfileResponse

Get profile information.

Link copied to clipboard
abstract suspend fun getProfileTemplate(input: GetProfileTemplateRequest = GetProfileTemplateRequest { }): GetProfileTemplateResponse

Get profile template.

Link copied to clipboard

Get review template.

Link copied to clipboard

Get review template answer.

Link copied to clipboard

Get a lens review associated with a review template.

Link copied to clipboard
abstract suspend fun getWorkload(input: GetWorkloadRequest): GetWorkloadResponse

Get an existing workload.

Link copied to clipboard
abstract suspend fun importLens(input: ImportLensRequest): ImportLensResponse

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

Link copied to clipboard
abstract suspend fun listAnswers(input: ListAnswersRequest): ListAnswersResponse

List of answers for a particular workload and lens.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listLenses(input: ListLensesRequest = ListLensesRequest { }): ListLensesResponse

List the available lenses.

Link copied to clipboard

List the improvements of a particular lens review.

Link copied to clipboard

List lens reviews for a particular workload.

Link copied to clipboard

List the lens shares associated with the lens.

Link copied to clipboard

List all milestones for an existing workload.

Link copied to clipboard
abstract suspend fun listNotifications(input: ListNotificationsRequest = ListNotificationsRequest { }): ListNotificationsResponse

List lens notifications.

Link copied to clipboard
abstract suspend fun listProfileNotifications(input: ListProfileNotificationsRequest = ListProfileNotificationsRequest { }): ListProfileNotificationsResponse

List profile notifications.

Link copied to clipboard
abstract suspend fun listProfiles(input: ListProfilesRequest = ListProfilesRequest { }): ListProfilesResponse

List profiles.

Link copied to clipboard

List profile shares.

Link copied to clipboard

List the answers of a review template.

Link copied to clipboard
abstract suspend fun listReviewTemplates(input: ListReviewTemplatesRequest = ListReviewTemplatesRequest { }): ListReviewTemplatesResponse

List review templates.

Link copied to clipboard
abstract suspend fun listShareInvitations(input: ListShareInvitationsRequest = ListShareInvitationsRequest { }): ListShareInvitationsResponse

List the share invitations.

Link copied to clipboard

List the tags for a resource.

Link copied to clipboard

List review template shares.

Link copied to clipboard
abstract suspend fun listWorkloads(input: ListWorkloadsRequest = ListWorkloadsRequest { }): ListWorkloadsResponse

Paginated list of workloads.

Link copied to clipboard

List the workload shares associated with the workload.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds one or more tags to the specified resource.

Link copied to clipboard

Deletes specified tags from a resource.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateGlobalSettings(input: UpdateGlobalSettingsRequest = UpdateGlobalSettingsRequest { }): UpdateGlobalSettingsResponse

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

Link copied to clipboard

Update integration features.

Link copied to clipboard

Update lens review for a particular workload.

Link copied to clipboard

Update a profile.

Link copied to clipboard

Update a review template.

Link copied to clipboard

Update a review template answer.

Link copied to clipboard

Update a lens review associated with a review template.

Link copied to clipboard

Update a workload or custom lens share invitation.

Link copied to clipboard

Update an existing workload.

Link copied to clipboard

Update a workload share.

Link copied to clipboard

Upgrade lens review for a particular workload.

Link copied to clipboard
Link copied to clipboard

Upgrade the lens review of a review template.

Inherited functions

Link copied to clipboard

Associate a lens to a workload.

Link copied to clipboard

Associate a profile with a workload.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Create a lens share.

Link copied to clipboard

Create a new lens version.

Link copied to clipboard

Create a milestone for an existing workload.

Link copied to clipboard

Create a profile.

Link copied to clipboard

Create a profile share.

Link copied to clipboard

Create a review template.

Link copied to clipboard

Create a review template share.

Link copied to clipboard

Create a new workload.

Link copied to clipboard

Create a workload share.

Link copied to clipboard

Delete an existing lens.

Link copied to clipboard

Delete a lens share.

Link copied to clipboard

Delete a profile.

Link copied to clipboard

Delete a profile share.

Link copied to clipboard

Delete a review template.

Link copied to clipboard

Delete a review template share.

Link copied to clipboard

Delete an existing workload.

Link copied to clipboard

Delete a workload share.

Link copied to clipboard

Disassociate a lens from a workload.

Link copied to clipboard

Disassociate a profile from a workload.

Link copied to clipboard

Export an existing lens.

Link copied to clipboard
inline suspend fun WellArchitectedClient.getAnswer(crossinline block: GetAnswerRequest.Builder.() -> Unit): GetAnswerResponse

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

Link copied to clipboard

Get a consolidated report of your workloads.

Link copied to clipboard

Global settings for all workloads.

Link copied to clipboard
inline suspend fun WellArchitectedClient.getLens(crossinline block: GetLensRequest.Builder.() -> Unit): GetLensResponse

Get an existing lens.

Link copied to clipboard

Get lens review.

Link copied to clipboard

Get lens review report.

Link copied to clipboard
Link copied to clipboard

Get a milestone for an existing workload.

Link copied to clipboard

Get profile information.

Link copied to clipboard

Get profile template.

Link copied to clipboard

Get review template.

Link copied to clipboard
Link copied to clipboard

Get a lens review associated with a review template.

Link copied to clipboard

Get an existing workload.

Link copied to clipboard

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

Link copied to clipboard

List of answers for a particular workload and lens.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

List the available lenses.

Link copied to clipboard
Link copied to clipboard

List the improvements of a particular lens review.

Link copied to clipboard

List lens reviews for a particular workload.

Link copied to clipboard

List the lens shares associated with the lens.

Link copied to clipboard

List all milestones for an existing workload.

Link copied to clipboard

List lens notifications.

Link copied to clipboard
Link copied to clipboard

List profiles.

Link copied to clipboard

List profile shares.

Link copied to clipboard

List the answers of a review template.

Link copied to clipboard

List review templates.

Link copied to clipboard

List the share invitations.

Link copied to clipboard

List the tags for a resource.

Link copied to clipboard

List review template shares.

Link copied to clipboard

Paginated list of workloads.

Link copied to clipboard

List the workload shares associated with the workload.

Link copied to clipboard

Adds one or more tags to the specified resource.

Link copied to clipboard

Deletes specified tags from a resource.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Update integration features.

Link copied to clipboard

Update lens review for a particular workload.

Link copied to clipboard

Update a profile.

Link copied to clipboard

Update a review template.

Link copied to clipboard
Link copied to clipboard

Update a lens review associated with a review template.

Link copied to clipboard

Update a workload or custom lens share invitation.

Link copied to clipboard

Update an existing workload.

Link copied to clipboard

Update a workload share.

Link copied to clipboard

Upgrade lens review for a particular workload.

Link copied to clipboard
Link copied to clipboard

Upgrade the lens review of a review template.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.