Module Awso_wellarchitected_asyncSource

Sourceval associate_lenses : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.AssociateLensesInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval associate_profiles : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.AssociateProfilesInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_lens : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteLensInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_lens_share : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteLensShareInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_profile : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteProfileInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_profile_share : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteProfileShareInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_review_template : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteReviewTemplateInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_template_share : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteTemplateShareInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_workload : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteWorkloadInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_workload_share : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DeleteWorkloadShareInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval disassociate_lenses : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DisassociateLensesInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval disassociate_profiles : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.DisassociateProfilesInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval update_global_settings : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.UpdateGlobalSettingsInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval update_integration : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.UpdateIntegrationInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval upgrade_lens_review : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.UpgradeLensReviewInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval upgrade_profile_version : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.UpgradeProfileVersionInput.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval upgrade_review_template_lens_review : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_wellarchitected.Values.UpgradeReviewTemplateLensReviewInput.t -> (unit, unit) Result.t Async.Deferred.t
include module type of struct include Awso_wellarchitected.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

The ID of a choice.

The title of a choice.

A best practice, or question choice, that has been identified as a risk in this question.

The ID of the question.

The choice content.

A metric for a particular question in the pillar.

A non-negative integer that denotes how many.

The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary$PillarId.

The description of a choice.

The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses.

The title of the question.

A metric for a particular pillar in a lens.

The profile choice.

The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary$LensAlias.

The profile associated with a workload.

The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses.

A profile template choice.

A question difference return object.

Description of the error.

The field name for which validation failed.

The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied.

The name of the pillar.

The description of the question.

The selected pillar.

A choice summary that has been answered on a question in your workload.

A choice available to answer question.

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

An Amazon Web Services account ID.

The date and time recorded.

The ARN for the workload.

The choice level improvement plan.

An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1.

A metric for a particular lens in a workload.

Stores information about a field passed inside a request that resulted in an exception.

Summary of a review template.

A choice that has been answered on a question in your workload.

A profile question.

A pillar review summary of a lens review.

The ID associated with the share.

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

The full name of the lens.

Defines whether this question is applicable to a lens review.

Lens upgrade summary return object.

The name of the milestone in a workload. Milestone names must be unique within a workload.

The milestone number. A workload can have a maximum of 100 milestones.

A workload summary return object.

The description of the lens.

Configuration of the Jira integration.

A profile template question.

The URL of the architectural design for the workload.

The description for the workload.

Discovery configuration associated to the workload.

The industry for the workload.

The industry type for the workload. If specified, must be one of the following: Agriculture Automobile Defense Design and Engineering Digital Advertising Education Environmental Protection Financial Services Gaming General Public Services Healthcare Hospitality InfoTech Justice and Public Safety Life Sciences Manufacturing Media & Entertainment Mining & Resources Oil & Gas Power & Utilities Professional Services Real Estate & Construction Retail & Wholesale Social Protection Telecommunications Travel, Transportation & Logistics Other

Workload-level: Output configuration of the Jira integration.

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

A pillar difference return object.

Identifier of the resource affected.

Type of the resource affected.

Service Quotas requirement to identify originating quota.

Service Quotas requirement to identify originating service.

The token to use to retrieve the next set of results.

The helpful resource URL. For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

A list of choices to be updated.

An update to a profile question.

Selected questions in the workload.

A workload share summary return object.

Summary of a review template share.

A share invitation summary return object.

Summary of a review template.

The summary of review template answers.

Summary of a profile.

Summary of a profile share.

The profile notification summary.

A notification summary return object.

A milestone summary return object.

A lens summary of a lens.

A lens share summary return object.

A lens review summary of a workload.

An improvement summary of a lens review in a workload.

Trusted Advisor check summary.

Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

An answer summary of a lens review in a workload.

A workload return object.

The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when PDF format is requested.

A metric that contributes to the consolidated report.

A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

User does not have sufficient access to perform this action.

The resource has already been processed, was deleted, or is too large.

There is a problem with the Well-Architected Tool API service.

The requested resource was not found.

Request was denied due to request throttling.

The user input is not valid.

A workload share return object.

Workload-level: Input for the Jira configuration.

The share invitation.

A review template.

The lens review of a review template.

An answer of the question.

A lens review of a question.

Account-level: Input for the Jira configuration.

An answer of the question.

An optional string added to the beginning of each workload name returned in the results.

The maximum number of results to return for this request.

The user has reached their resource quota.

The profile template.

A milestone return object.

The differences between the base and latest versions of the lens.

A report of a lens review.

A lens return object.

Account-level: Output configuration of the Jira integration.

Upgrade the lens review of a review template.

Upgrade a profile.

Upgrade lens review for a particular workload.

Input for Update Workload Share

Input for Update Workload Share

Output of an update workload call.

Input to update a workload.

Update a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

Input for Update Share Invitation

Update a review template.

Update a lens review associated with a review template.

Update a lens review associated with a review template.

Update a review template.

Update a review template answer.

Update a review template answer.

Update a profile.

Update a profile.

Output of a update lens review call.

Input for update lens review.

Update integration features.

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

Output of a update answer call.

Input to update answer.

Deletes specified tags from a resource. 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

Deletes specified tags from a resource. 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

Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

Output of a list workloads call.

Input to list all workloads.

Input for List Workload Share

Input for List Workload Share

List review template shares.

List review template shares.

List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

Input for List Share Invitations

Input for List Share Invitations

List review templates.

List review templates.

List the answers of a review template.

List the answers of a review template.

List profiles.

List profiles.

List profile shares.

List profile shares.

List profile notifications.

List profile notifications.

List lens notifications.

List lens notifications.

Output of a list milestones call.

Input to list all milestones for a workload.

Output of a list lenses call.

Input to list lenses.

List the lens shares associated with the lens.

List the lens shares associated with the lens.

Output of a list lens reviews call.

Input to list lens reviews.

Output of a list lens review improvements call.

Input to list lens review improvements.

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

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

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

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

Output of a list answers call.

Input to list answers.

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

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

Output of a get workload call.

Input to get a workload.

Get review template.

Get a lens review associated with a review template.

Get a lens review associated with a review template.

Get review template.

Get review template answer.

Get review template answer.

Get profile template.

Get profile template.

Get profile information.

Get profile information.

Output of a get milestone call.

Input to get a milestone.

Get lens version differences.

Get lens version differences.

Output of a get lens review report call.

Input to get lens review report.

Output of a get lens review call.

Input to get lens review.

Get an existing lens.

Get an existing lens.

Global settings for all workloads.

Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.

Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.

Output of a get answer call.

Input to get answer.

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

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

Disassociate a profile from a workload.

Input to disassociate lens reviews.

Input for Delete Workload Share

Input for workload deletion.

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.

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.

Delete a profile share.

Delete a profile. 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.

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

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

Input for Create Workload Share

Input for Create Workload Share

Output of a create workload call.

Input for workload creation.

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

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

Create a review template. 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.

Create a review template. 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.

Create a profile share.

Create a profile share.

Create a profile.

Create a profile.

Output of a create milestone call.

Input for milestone creation.

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.

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.

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

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

Associate a profile with a workload.

Input to associate lens reviews.

Sourcemodule Cli : sig ... end