Package-level declarations

Types

Link copied to clipboard

Amazon Web Services Well-Architected helps you evaluate your architectures against Amazon Web Services best practices across operational excellence, security, reliability, performance efficiency, cost optimization, and sustainability. The service includes the Amazon Web Services Well-Architected Agent for AI-powered recommendations tailored to your specific environment, and the Well-Architected Tool for conducting reviews and tracking improvements.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

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

Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.

Link copied to clipboard

Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.

Link copied to clipboard

Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources.

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

Deletes a context associated with a profile.

Link copied to clipboard

Deletes an optimization goal from a profile.

Link copied to clipboard

Deletes an optimization profile and its associated configuration. This action cannot be undone.

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

Retrieves detailed information about a specific context associated with a profile.

Link copied to clipboard

Retrieves detailed information about a specific optimization goal.

Link copied to clipboard

Retrieves detailed information about an optimization profile, including its configuration and metadata.

Link copied to clipboard

Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.

Link copied to clipboard

Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS.

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

Lists contexts associated with a profile.

Link copied to clipboard

Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.

Link copied to clipboard

Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.

Link copied to clipboard

Lists recommendation generation processes for a specified profile.

Link copied to clipboard

Lists recommendation items for a specific recommendation. Recommendation items provide detailed information about individual optimization opportunities.

Link copied to clipboard

Lists active optimization recommendations for a specified profile with optional filtering by state.

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

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

Submits user feedback on a recommendation to help improve future optimization suggestions and track implementation outcomes.

Link copied to clipboard

Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status.

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

Updates an existing context associated with a profile.

Link copied to clipboard

Updates the pillars and title of an existing goal associated with a profile.

Link copied to clipboard

Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings.

Link copied to clipboard

Updates the status of a recommendation to track its progress through the implementation lifecycle.

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.