Values (p.awso.0.9.0.doc.awso.wellarchitected.Awso

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

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule ChoiceId : sig ... end

The ID of a choice.

Sourcemodule ChoiceTitle : sig ... end

The title of a choice.

Sourcemodule BestPractice : sig ... end

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

Sourcemodule ChoiceContentDisplayText : sig ... end

Sourcemodule ChoiceContentUrl : sig ... end

Sourcemodule BestPractices : sig ... end

Sourcemodule QuestionId : sig ... end

The ID of the question.

Sourcemodule Risk : sig ... end

Sourcemodule ChoiceContent : sig ... end

The choice content.

Sourcemodule QuestionMetric : sig ... end

A metric for a particular question in the pillar.

Sourcemodule Count : sig ... end

A non-negative integer that denotes how many.

Sourcemodule AdditionalResourceType : sig ... end

Sourcemodule Urls : sig ... end

Sourcemodule PillarId : sig ... end

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

Sourcemodule QuestionMetrics : sig ... end

Sourcemodule RiskCounts : sig ... end

Sourcemodule ChoiceDescription : sig ... end

The description of a choice.

Sourcemodule SelectedQuestionId : sig ... end

Sourcemodule AdditionalResources : sig ... end

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

Sourcemodule ProfileArn : sig ... end

Sourcemodule ProfileVersion : sig ... end

Sourcemodule DifferenceStatus : sig ... end

Sourcemodule QuestionTitle : sig ... end

The title of the question.

Sourcemodule PillarMetric : sig ... end

A metric for a particular pillar in a lens.

Sourcemodule Question : sig ... end

Sourcemodule ProfileChoice : sig ... end

The profile choice.

Sourcemodule SelectedQuestionIds : sig ... end

Sourcemodule ChoiceReason : sig ... end

Sourcemodule ChoiceStatus : sig ... end

Sourcemodule AdditionalResourcesList : sig ... end

Sourcemodule LensAlias : sig ... end

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.

Sourcemodule WorkloadProfile : sig ... end

The profile associated with a workload.

Sourcemodule DisplayText : sig ... end

Sourcemodule ImprovementPlanUrl : sig ... end

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.

Sourcemodule ProfileTemplateChoice : sig ... end

A profile template choice.

Sourcemodule DefinitionType : sig ... end

Sourcemodule QuestionDifference : sig ... end

A question difference return object.

Sourcemodule LensArn : sig ... end

Sourcemodule PillarMetrics : sig ... end

Sourcemodule ExceptionMessage : sig ... end

Description of the error.

Sourcemodule ValidationExceptionFieldName : sig ... end

The field name for which validation failed.

Sourcemodule Notes : sig ... end

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.

Sourcemodule PillarName : sig ... end

The name of the pillar.

Sourcemodule QuestionCounts : sig ... end

Sourcemodule ChoiceNotes : sig ... end

Sourcemodule MaxSelectedProfileChoices : sig ... end

Sourcemodule MinSelectedProfileChoices : sig ... end

Sourcemodule ProfileQuestionChoices : sig ... end

Sourcemodule QuestionDescription : sig ... end

The description of the question.

Sourcemodule SelectedChoiceIds : sig ... end

Sourcemodule SelectedPillar : sig ... end

The selected pillar.

Sourcemodule ChoiceAnswerSummary : sig ... end

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

Sourcemodule Choice : sig ... end

A choice available to answer question.

Sourcemodule LensVersion : sig ... end

Sourcemodule ResourceArn : sig ... end

Sourcemodule WorkloadId : sig ... end

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

Sourcemodule WorkloadName : sig ... end

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.

Sourcemodule AwsAccountId : sig ... end

An Amazon Web Services account ID.

Sourcemodule Timestamp : sig ... end

The date and time recorded.

Sourcemodule WorkloadArn : sig ... end

The ARN for the workload.

Sourcemodule WorkloadImprovementStatus : sig ... end

Sourcemodule WorkloadLenses : sig ... end

Sourcemodule WorkloadProfiles : sig ... end

Sourcemodule ChoiceImprovementPlan : sig ... end

The choice level improvement plan.

Sourcemodule JiraIssueUrl : sig ... end

Sourcemodule CheckStatus : sig ... end

Sourcemodule CheckStatusCount : sig ... end

Sourcemodule ProfileTemplateQuestionChoices : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule ApplicationArn : sig ... end

Sourcemodule AwsRegion : sig ... end

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

Sourcemodule TrustedAdvisorIntegrationStatus : sig ... end

Sourcemodule WorkloadResourceDefinition : sig ... end

Sourcemodule IssueManagementType : sig ... end

Sourcemodule JiraProjectKey : sig ... end

Sourcemodule StatusMessage : sig ... end

Sourcemodule WorkloadIssueManagementStatus : sig ... end

Sourcemodule WorkloadNonAwsRegion : sig ... end

Sourcemodule QuestionDifferences : sig ... end

Sourcemodule LensMetric : sig ... end

A metric for a particular lens in a workload.

Sourcemodule ValidationExceptionField : sig ... end

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

Sourcemodule ReviewTemplatePillarReviewSummary : sig ... end

Summary of a review template.

Sourcemodule ChoiceAnswer : sig ... end

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

Sourcemodule ProfileQuestion : sig ... end

A profile question.

Sourcemodule SelectedProfileChoiceIds : sig ... end

Sourcemodule SelectedPillars : sig ... end

Sourcemodule PillarReviewSummary : sig ... end

A pillar review summary of a lens review.

Sourcemodule PermissionType : sig ... end

Sourcemodule ShareId : sig ... end

The ID associated with the share.

Sourcemodule ShareStatus : sig ... end

Sourcemodule SharedWith : sig ... end

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

Sourcemodule LensName : sig ... end

The full name of the lens.

Sourcemodule ProfileName : sig ... end

Sourcemodule ShareInvitationId : sig ... end

Sourcemodule ShareResourceType : sig ... end

Sourcemodule TemplateArn : sig ... end

Sourcemodule TemplateName : sig ... end

Sourcemodule ReviewTemplateLenses : sig ... end

Sourcemodule ReviewTemplateUpdateStatus : sig ... end

Sourcemodule TemplateDescription : sig ... end

Sourcemodule AnswerReason : sig ... end

Sourcemodule ChoiceAnswerSummaries : sig ... end

Sourcemodule Choices : sig ... end

Sourcemodule IsApplicable : sig ... end

Defines whether this question is applicable to a lens review.

Sourcemodule QuestionType : sig ... end

Sourcemodule ReviewTemplateAnswerStatus : sig ... end

Sourcemodule SelectedChoices : sig ... end

Sourcemodule ProfileDescription : sig ... end

Sourcemodule ProfileNotificationType : sig ... end

Sourcemodule LensUpgradeSummary : sig ... end

Lens upgrade summary return object.

Sourcemodule NotificationType : sig ... end

Sourcemodule MilestoneName : sig ... end

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

Sourcemodule MilestoneNumber : sig ... end

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

Sourcemodule WorkloadSummary : sig ... end

A workload summary return object.

Sourcemodule LensDescription : sig ... end

The description of the lens.

Sourcemodule LensStatus : sig ... end

Sourcemodule LensType : sig ... end

Sourcemodule ChoiceImprovementPlans : sig ... end

Sourcemodule JiraConfiguration : sig ... end

Configuration of the Jira integration.

Sourcemodule AccountSummary : sig ... end

Sourcemodule CheckDescription : sig ... end

Sourcemodule CheckId : sig ... end

Sourcemodule CheckName : sig ... end

Sourcemodule CheckProvider : sig ... end

Sourcemodule CheckFailureReason : sig ... end

Sourcemodule FlaggedResources : sig ... end

Sourcemodule ProfileTemplateQuestion : sig ... end

A profile template question.

Sourcemodule IsReviewOwnerUpdateAcknowledged : sig ... end

Sourcemodule TagMap : sig ... end

Sourcemodule WorkloadAccountIds : sig ... end

Sourcemodule WorkloadApplications : sig ... end

Sourcemodule WorkloadArchitecturalDesign : sig ... end

The URL of the architectural design for the workload.

Sourcemodule WorkloadAwsRegions : sig ... end

Sourcemodule WorkloadDescription : sig ... end

The description for the workload.

Sourcemodule WorkloadDiscoveryConfig : sig ... end

Discovery configuration associated to the workload.

Sourcemodule WorkloadEnvironment : sig ... end

Sourcemodule WorkloadIndustry : sig ... end

The industry for the workload.

Sourcemodule WorkloadIndustryType : sig ... end

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

Sourcemodule WorkloadJiraConfigurationOutput : sig ... end

Workload-level: Output configuration of the Jira integration.

Sourcemodule WorkloadNonAwsRegions : sig ... end

Sourcemodule WorkloadPillarPriorities : sig ... end

Sourcemodule WorkloadReviewOwner : sig ... end

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

Sourcemodule PillarDifference : sig ... end

A pillar difference return object.

Sourcemodule LensMetrics : sig ... end

Sourcemodule LensesAppliedCount : sig ... end

Sourcemodule MetricType : sig ... end

Sourcemodule ExceptionResourceId : sig ... end

Identifier of the resource affected.

Sourcemodule ExceptionResourceType : sig ... end

Type of the resource affected.

Sourcemodule QuotaCode : sig ... end

Service Quotas requirement to identify originating quota.

Sourcemodule ServiceCode : sig ... end

Service Quotas requirement to identify originating service.

Sourcemodule ValidationExceptionFieldList : sig ... end

Sourcemodule ValidationExceptionReason : sig ... end

Sourcemodule NextToken : sig ... end

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

Sourcemodule ReviewTemplatePillarReviewSummaries : sig ... end

Sourcemodule ChoiceAnswers : sig ... end

Sourcemodule HelpfulResourceUrl : sig ... end

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.

Sourcemodule ChoiceUpdate : sig ... end

A list of choices to be updated.

Sourcemodule ProfileQuestions : sig ... end

Sourcemodule ProfileQuestionUpdate : sig ... end

An update to a profile question.

Sourcemodule JiraSelectedQuestionConfiguration : sig ... end

Selected questions in the workload.

Sourcemodule PillarReviewSummaries : sig ... end

Sourcemodule AccountJiraIssueManagementStatus : sig ... end

Sourcemodule IntegrationStatusInput : sig ... end

Sourcemodule WorkloadShareSummary : sig ... end

A workload share summary return object.

Sourcemodule TemplateShareSummary : sig ... end

Summary of a review template share.

Sourcemodule ShareInvitationSummary : sig ... end

A share invitation summary return object.

Sourcemodule ReviewTemplateSummary : sig ... end

Summary of a review template.

Sourcemodule ReviewTemplateAnswerSummary : sig ... end

The summary of review template answers.

Sourcemodule ProfileSummary : sig ... end

Summary of a profile.

Sourcemodule ProfileShareSummary : sig ... end

Summary of a profile share.

Sourcemodule ProfileNotificationSummary : sig ... end

The profile notification summary.

Sourcemodule NotificationSummary : sig ... end

A notification summary return object.

Sourcemodule MilestoneSummary : sig ... end

A milestone summary return object.

Sourcemodule LensSummary : sig ... end

A lens summary of a lens.

Sourcemodule LensShareSummary : sig ... end

A lens share summary return object.

Sourcemodule LensReviewSummary : sig ... end

A lens review summary of a workload.

Sourcemodule ImprovementSummary : sig ... end

An improvement summary of a lens review in a workload.

Sourcemodule CheckSummary : sig ... end

Trusted Advisor check summary.

Sourcemodule CheckDetail : sig ... end

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

Sourcemodule AnswerSummary : sig ... end

An answer summary of a lens review in a workload.

Sourcemodule TemplateQuestions : sig ... end

Sourcemodule Workload : sig ... end

A workload return object.

Sourcemodule PillarDifferences : sig ... end

Sourcemodule Base64String : sig ... end

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.

Sourcemodule LensOwner : sig ... end

Sourcemodule IntegrationStatus : sig ... end

Sourcemodule Subdomain : sig ... end

Sourcemodule ConsolidatedReportMetric : sig ... end

A metric that contributes to the consolidated report.

Sourcemodule ClientRequestToken : sig ... end

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.

Sourcemodule AccessDeniedException : sig ... end

User does not have sufficient access to perform this action.

Sourcemodule ConflictException : sig ... end

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

Sourcemodule InternalServerException : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

The requested resource was not found.

Sourcemodule ThrottlingException : sig ... end

Request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

The user input is not valid.

Sourcemodule WorkloadShare : sig ... end

A workload share return object.

Sourcemodule WorkloadJiraConfigurationInput : sig ... end

Workload-level: Input for the Jira configuration.

Sourcemodule ShareInvitation : sig ... end

The share invitation.

Sourcemodule ShareInvitationAction : sig ... end

Sourcemodule ReviewTemplate : sig ... end

A review template.

Sourcemodule ReviewTemplateLensReview : sig ... end

The lens review of a review template.

Sourcemodule PillarNotes : sig ... end

Sourcemodule ReviewTemplateLensAliases : sig ... end

Sourcemodule ReviewTemplateAnswer : sig ... end

An answer of the question.

Sourcemodule ChoiceUpdates : sig ... end

Sourcemodule Profile : sig ... end

A profile.

Sourcemodule ProfileQuestionUpdates : sig ... end

Sourcemodule LensReview : sig ... end

A lens review of a question.

Sourcemodule IntegratingService : sig ... end

Sourcemodule AccountJiraConfigurationInput : sig ... end

Account-level: Input for the Jira configuration.

Sourcemodule DiscoveryIntegrationStatus : sig ... end

Sourcemodule OrganizationSharingStatus : sig ... end

Sourcemodule Answer : sig ... end

An answer of the question.

Sourcemodule TagKeyList : sig ... end

Sourcemodule WorkloadSummaries : sig ... end

Sourcemodule ListWorkloadsMaxResults : sig ... end

Sourcemodule WorkloadNamePrefix : sig ... end

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

Sourcemodule WorkloadShareSummaries : sig ... end

Sourcemodule ListWorkloadSharesMaxResults : sig ... end

Sourcemodule SharedWithPrefix : sig ... end

Sourcemodule TemplateShareSummaries : sig ... end

Sourcemodule ListTemplateSharesMaxResults : sig ... end

Sourcemodule ShareInvitationSummaries : sig ... end

Sourcemodule LensNamePrefix : sig ... end

Sourcemodule ListShareInvitationsMaxResults : sig ... end

Sourcemodule ProfileNamePrefix : sig ... end

Sourcemodule TemplateNamePrefix : sig ... end

Sourcemodule ReviewTemplates : sig ... end

Sourcemodule MaxResults : sig ... end

The maximum number of results to return for this request.

Sourcemodule ReviewTemplateAnswerSummaries : sig ... end

Sourcemodule ListReviewTemplateAnswersMaxResults : sig ... end

Sourcemodule ProfileSummaries : sig ... end

Sourcemodule ProfileOwnerType : sig ... end

Sourcemodule ProfileShareSummaries : sig ... end

Sourcemodule ListProfileSharesMaxResults : sig ... end

Sourcemodule ProfileNotificationSummaries : sig ... end

Sourcemodule NotificationSummaries : sig ... end

Sourcemodule ListNotificationsMaxResults : sig ... end

Sourcemodule MilestoneSummaries : sig ... end

Sourcemodule LensSummaries : sig ... end

Sourcemodule LensStatusType : sig ... end

Sourcemodule LensShareSummaries : sig ... end

Sourcemodule LensReviewSummaries : sig ... end

Sourcemodule ImprovementSummaries : sig ... end

Sourcemodule ListLensReviewImprovementsMaxResults : sig ... end

Sourcemodule QuestionPriority : sig ... end

Sourcemodule CheckSummaries : sig ... end

Sourcemodule CheckDetails : sig ... end

Sourcemodule AnswerSummaries : sig ... end

Sourcemodule ListAnswersMaxResults : sig ... end

Sourcemodule ImportLensStatus : sig ... end

Sourcemodule ServiceQuotaExceededException : sig ... end

The user has reached their resource quota.

Sourcemodule LensJSON : sig ... end

Sourcemodule ProfileTemplate : sig ... end

The profile template.

Sourcemodule Milestone : sig ... end

A milestone return object.

Sourcemodule VersionDifferences : sig ... end

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

Sourcemodule LensReviewReport : sig ... end

A report of a lens review.

Sourcemodule Lens : sig ... end

A lens return object.

Sourcemodule AccountJiraConfigurationOutput : sig ... end

Account-level: Output configuration of the Jira integration.

Sourcemodule ConsolidatedReportMetrics : sig ... end

Sourcemodule GetConsolidatedReportMaxResults : sig ... end

Sourcemodule IncludeSharedResources : sig ... end

Sourcemodule ReportFormat : sig ... end

Sourcemodule ProfileArns : sig ... end

Sourcemodule LensAliases : sig ... end

Sourcemodule ReviewTemplateArns : sig ... end

Sourcemodule WorkloadProfileArns : sig ... end

Sourcemodule IsMajorVersion : sig ... end

Sourcemodule UpgradeReviewTemplateLensReviewInput : sig ... end

Upgrade the lens review of a review template.

Sourcemodule UpgradeProfileVersionInput : sig ... end

Upgrade a profile.

Sourcemodule UpgradeLensReviewInput : sig ... end

Upgrade lens review for a particular workload.

Sourcemodule UpdateWorkloadShareOutput : sig ... end

Input for Update Workload Share

Sourcemodule UpdateWorkloadShareInput : sig ... end

Input for Update Workload Share

Sourcemodule UpdateWorkloadOutput : sig ... end

Output of an update workload call.

Sourcemodule UpdateWorkloadInput : sig ... end

Input to update a workload.

Sourcemodule UpdateShareInvitationOutput : sig ... end

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.

Sourcemodule UpdateShareInvitationInput : sig ... end

Input for Update Share Invitation

Sourcemodule UpdateReviewTemplateOutput : sig ... end

Update a review template.

Sourcemodule UpdateReviewTemplateLensReviewOutput : sig ... end

Update a lens review associated with a review template.

Sourcemodule UpdateReviewTemplateLensReviewInput : sig ... end

Update a lens review associated with a review template.

Sourcemodule UpdateReviewTemplateInput : sig ... end

Update a review template.

Sourcemodule UpdateReviewTemplateAnswerOutput : sig ... end

Update a review template answer.

Sourcemodule UpdateReviewTemplateAnswerInput : sig ... end

Update a review template answer.

Sourcemodule UpdateProfileOutput : sig ... end

Update a profile.

Sourcemodule UpdateProfileInput : sig ... end

Update a profile.

Sourcemodule UpdateLensReviewOutput : sig ... end

Output of a update lens review call.

Sourcemodule UpdateLensReviewInput : sig ... end

Input for update lens review.

Sourcemodule UpdateIntegrationInput : sig ... end

Update integration features.

Sourcemodule UpdateGlobalSettingsInput : sig ... end

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

Sourcemodule UpdateAnswerOutput : sig ... end

Output of a update answer call.

Sourcemodule UpdateAnswerInput : sig ... end

Input to update answer.

Sourcemodule UntagResourceOutput : sig ... end

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

Sourcemodule UntagResourceInput : sig ... end

Sourcemodule TagResourceOutput : sig ... end

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.

Sourcemodule TagResourceInput : sig ... end

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.

Sourcemodule ListWorkloadsOutput : sig ... end

Output of a list workloads call.

Sourcemodule ListWorkloadsInput : sig ... end

Input to list all workloads.

Sourcemodule ListWorkloadSharesOutput : sig ... end

Input for List Workload Share

Sourcemodule ListWorkloadSharesInput : sig ... end

Input for List Workload Share

Sourcemodule ListTemplateSharesOutput : sig ... end

List review template shares.

Sourcemodule ListTemplateSharesInput : sig ... end

List review template shares.

Sourcemodule ListTagsForResourceOutput : sig ... end

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.

Sourcemodule ListTagsForResourceInput : sig ... end

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.

Sourcemodule ListShareInvitationsOutput : sig ... end

Input for List Share Invitations

Sourcemodule ListShareInvitationsInput : sig ... end

Input for List Share Invitations

Sourcemodule ListReviewTemplatesOutput : sig ... end

List review templates.

Sourcemodule ListReviewTemplatesInput : sig ... end

List review templates.

Sourcemodule ListReviewTemplateAnswersOutput : sig ... end

List the answers of a review template.

Sourcemodule ListReviewTemplateAnswersInput : sig ... end

List the answers of a review template.

Sourcemodule ListProfilesOutput : sig ... end

List profiles.

Sourcemodule ListProfilesInput : sig ... end

List profiles.

Sourcemodule ListProfileSharesOutput : sig ... end

List profile shares.

Sourcemodule ListProfileSharesInput : sig ... end

List profile shares.

Sourcemodule ListProfileNotificationsOutput : sig ... end

List profile notifications.

Sourcemodule ListProfileNotificationsInput : sig ... end

List profile notifications.

Sourcemodule ListNotificationsOutput : sig ... end

List lens notifications.

Sourcemodule ListNotificationsInput : sig ... end

List lens notifications.

Sourcemodule ListMilestonesOutput : sig ... end

Output of a list milestones call.

Sourcemodule ListMilestonesInput : sig ... end

Input to list all milestones for a workload.

Sourcemodule ListLensesOutput : sig ... end

Output of a list lenses call.

Sourcemodule ListLensesInput : sig ... end

Input to list lenses.

Sourcemodule ListLensSharesOutput : sig ... end

List the lens shares associated with the lens.

Sourcemodule ListLensSharesInput : sig ... end

List the lens shares associated with the lens.

Sourcemodule ListLensReviewsOutput : sig ... end

Output of a list lens reviews call.

Sourcemodule ListLensReviewsInput : sig ... end

Input to list lens reviews.

Sourcemodule ListLensReviewImprovementsOutput : sig ... end

Output of a list lens review improvements call.

Sourcemodule ListLensReviewImprovementsInput : sig ... end

Input to list lens review improvements.

Sourcemodule ListCheckSummariesOutput : sig ... end

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

Sourcemodule ListCheckSummariesInput : sig ... end

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

Sourcemodule ListCheckDetailsOutput : sig ... end

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

Sourcemodule ListCheckDetailsInput : sig ... end

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

Sourcemodule ListAnswersOutput : sig ... end

Output of a list answers call.

Sourcemodule ListAnswersInput : sig ... end

Input to list answers.

Sourcemodule ImportLensOutput : sig ... end

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.

Sourcemodule ImportLensInput : sig ... end

Sourcemodule GetWorkloadOutput : sig ... end

Output of a get workload call.

Sourcemodule GetWorkloadInput : sig ... end

Input to get a workload.

Sourcemodule GetReviewTemplateOutput : sig ... end

Get review template.

Sourcemodule GetReviewTemplateLensReviewOutput : sig ... end

Get a lens review associated with a review template.

Sourcemodule GetReviewTemplateLensReviewInput : sig ... end

Get a lens review associated with a review template.

Sourcemodule GetReviewTemplateInput : sig ... end

Get review template.

Sourcemodule GetReviewTemplateAnswerOutput : sig ... end

Get review template answer.

Sourcemodule GetReviewTemplateAnswerInput : sig ... end

Get review template answer.

Sourcemodule GetProfileTemplateOutput : sig ... end

Get profile template.

Sourcemodule GetProfileTemplateInput : sig ... end

Get profile template.

Sourcemodule GetProfileOutput : sig ... end

Get profile information.

Sourcemodule GetProfileInput : sig ... end

Get profile information.

Sourcemodule GetMilestoneOutput : sig ... end

Output of a get milestone call.

Sourcemodule GetMilestoneInput : sig ... end

Input to get a milestone.

Sourcemodule GetLensVersionDifferenceOutput : sig ... end

Get lens version differences.

Sourcemodule GetLensVersionDifferenceInput : sig ... end

Get lens version differences.

Sourcemodule GetLensReviewReportOutput : sig ... end

Output of a get lens review report call.

Sourcemodule GetLensReviewReportInput : sig ... end

Input to get lens review report.

Sourcemodule GetLensReviewOutput : sig ... end

Output of a get lens review call.

Sourcemodule GetLensReviewInput : sig ... end

Input to get lens review.

Sourcemodule GetLensOutput : sig ... end

Get an existing lens.

Sourcemodule GetLensInput : sig ... end

Get an existing lens.

Sourcemodule GetGlobalSettingsOutput : sig ... end

Global settings for all workloads.

Sourcemodule GetConsolidatedReportOutput : sig ... end

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

Sourcemodule GetConsolidatedReportInput : sig ... end

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

Sourcemodule GetAnswerOutput : sig ... end

Output of a get answer call.

Sourcemodule GetAnswerInput : sig ... end

Input to get answer.

Sourcemodule ExportLensOutput : sig ... end

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.

Sourcemodule ExportLensInput : sig ... end

Sourcemodule DisassociateProfilesInput : sig ... end

Disassociate a profile from a workload.

Sourcemodule DisassociateLensesInput : sig ... end

Input to disassociate lens reviews.

Sourcemodule DeleteWorkloadShareInput : sig ... end

Input for Delete Workload Share

Sourcemodule DeleteWorkloadInput : sig ... end

Input for workload deletion.

Sourcemodule DeleteTemplateShareInput : sig ... end

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.

Sourcemodule DeleteReviewTemplateInput : sig ... end

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.

Sourcemodule DeleteProfileShareInput : sig ... end

Delete a profile share.

Sourcemodule DeleteProfileInput : sig ... end

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.

Sourcemodule DeleteLensShareInput : sig ... end

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.

Sourcemodule DeleteLensInput : sig ... end

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.

Sourcemodule CreateWorkloadShareOutput : sig ... end

Input for Create Workload Share

Sourcemodule CreateWorkloadShareInput : sig ... end

Input for Create Workload Share

Sourcemodule CreateWorkloadOutput : sig ... end

Output of a create workload call.

Sourcemodule CreateWorkloadInput : sig ... end

Input for workload creation.

Sourcemodule CreateTemplateShareOutput : sig ... end

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.

Sourcemodule CreateTemplateShareInput : sig ... end

Sourcemodule CreateReviewTemplateOutput : sig ... end

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.

Sourcemodule CreateReviewTemplateInput : sig ... end

Sourcemodule CreateProfileShareOutput : sig ... end

Create a profile share.

Sourcemodule CreateProfileShareInput : sig ... end

Create a profile share.

Sourcemodule CreateProfileOutput : sig ... end

Create a profile.

Sourcemodule CreateProfileInput : sig ... end

Create a profile.

Sourcemodule CreateMilestoneOutput : sig ... end

Output of a create milestone call.

Sourcemodule CreateMilestoneInput : sig ... end

Input for milestone creation.

Sourcemodule CreateLensVersionOutput : sig ... end

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.

Sourcemodule CreateLensVersionInput : sig ... end

Sourcemodule CreateLensShareOutput : sig ... end

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.

Sourcemodule CreateLensShareInput : sig ... end

Sourcemodule AssociateProfilesInput : sig ... end

Associate a profile with a workload.

Sourcemodule AssociateLensesInput : sig ... end

Input to associate lens reviews.