amazonka-wellarchitected-2.0: Amazon Well-Architected Tool SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WellArchitected.Lens

Description

 
Synopsis

Operations

AssociateLenses

CreateLensShare

CreateLensVersion

createLensVersion_isMajorVersion :: Lens' CreateLensVersion (Maybe Bool) Source #

Set to true if this new major lens version.

createLensVersion_lensVersion :: Lens' CreateLensVersion Text Source #

The version of the lens being created.

CreateMilestone

CreateWorkload

createWorkload_applications :: Lens' CreateWorkload (Maybe [Text]) Source #

List of AppRegistry application ARNs associated to the workload.

createWorkload_discoveryConfig :: Lens' CreateWorkload (Maybe WorkloadDiscoveryConfig) Source #

Well-Architected discovery configuration settings associated to the workload.

createWorkload_tags :: Lens' CreateWorkload (Maybe (HashMap Text Text)) Source #

The tags to be associated with the workload.

CreateWorkloadShare

DeleteLens

deleteLens_lensStatus :: Lens' DeleteLens LensStatusType Source #

The status of the lens to be deleted.

DeleteLensShare

DeleteWorkload

DeleteWorkloadShare

DisassociateLenses

ExportLens

exportLens_lensVersion :: Lens' ExportLens (Maybe Text) Source #

The lens version to be exported.

GetAnswer

getAnswerResponse_httpStatus :: Lens' GetAnswerResponse Int Source #

The response's http status code.

GetLens

getLens_lensVersion :: Lens' GetLens (Maybe Text) Source #

The lens version to be retrieved.

getLens_lensAlias :: Lens' GetLens Text Source #

Undocumented member.

getLensResponse_httpStatus :: Lens' GetLensResponse Int Source #

The response's http status code.

GetLensReview

GetLensReviewReport

GetLensVersionDifference

GetMilestone

GetWorkload

ImportLens

importLens_tags :: Lens' ImportLens (Maybe (HashMap Text Text)) Source #

Tags to associate to a lens.

importLens_jSONString :: Lens' ImportLens Text Source #

The JSON representation of a lens.

ListAnswers

listAnswers_maxResults :: Lens' ListAnswers (Maybe Natural) Source #

The maximum number of results to return for this request.

ListCheckDetails

listCheckDetailsResponse_checkDetails :: Lens' ListCheckDetailsResponse (Maybe [CheckDetail]) Source #

The details about the Trusted Advisor checks related to the Well-Architected best practice.

ListCheckSummaries

listCheckSummariesResponse_checkSummaries :: Lens' ListCheckSummariesResponse (Maybe [CheckSummary]) Source #

List of Trusted Advisor summaries related to the Well-Architected best practice.

ListLensReviewImprovements

listLensReviewImprovements_maxResults :: Lens' ListLensReviewImprovements (Maybe Natural) Source #

The maximum number of results to return for this request.

ListLensReviews

ListLensShares

listLensShares_maxResults :: Lens' ListLensShares (Maybe Natural) Source #

The maximum number of results to return for this request.

listLensShares_sharedWithPrefix :: Lens' ListLensShares (Maybe Text) Source #

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.

ListLenses

listLenses_lensStatus :: Lens' ListLenses (Maybe LensStatusType) Source #

The status of lenses to be returned.

listLenses_lensType :: Lens' ListLenses (Maybe LensType) Source #

The type of lenses to be returned.

ListMilestones

ListNotifications

listNotifications_maxResults :: Lens' ListNotifications (Maybe Natural) Source #

The maximum number of results to return for this request.

ListShareInvitations

listShareInvitations_lensNamePrefix :: Lens' ListShareInvitations (Maybe Text) Source #

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

listShareInvitations_maxResults :: Lens' ListShareInvitations (Maybe Natural) Source #

The maximum number of results to return for this request.

ListTagsForResource

ListWorkloadShares

listWorkloadShares_maxResults :: Lens' ListWorkloadShares (Maybe Natural) Source #

The maximum number of results to return for this request.

listWorkloadShares_sharedWithPrefix :: Lens' ListWorkloadShares (Maybe Text) Source #

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

ListWorkloads

listWorkloads_maxResults :: Lens' ListWorkloads (Maybe Natural) Source #

The maximum number of results to return for this request.

TagResource

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags for the resource.

UntagResource

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

UpdateAnswer

updateAnswer_choiceUpdates :: Lens' UpdateAnswer (Maybe (HashMap Text ChoiceUpdate)) Source #

A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

updateAnswer_reason :: Lens' UpdateAnswer (Maybe AnswerReason) Source #

The reason why a question is not applicable to your workload.

UpdateGlobalSettings

UpdateLensReview

UpdateShareInvitation

UpdateWorkload

updateWorkload_applications :: Lens' UpdateWorkload (Maybe [Text]) Source #

List of AppRegistry application ARNs to associate to the workload.

updateWorkload_discoveryConfig :: Lens' UpdateWorkload (Maybe WorkloadDiscoveryConfig) Source #

Well-Architected discovery configuration settings to associate to the workload.

updateWorkload_isReviewOwnerUpdateAcknowledged :: Lens' UpdateWorkload (Maybe Bool) Source #

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

UpdateWorkloadShare

UpgradeLensReview

Types

AdditionalResources

additionalResources_content :: Lens' AdditionalResources (Maybe [ChoiceContent]) Source #

The URLs for additional resources, either helpful resources or improvement plans. Up to five additional URLs can be specified.

Answer

answer_choiceAnswers :: Lens' Answer (Maybe [ChoiceAnswer]) Source #

A list of selected choices to a question in your workload.

answer_choices :: Lens' Answer (Maybe [Choice]) Source #

Undocumented member.

answer_helpfulResourceDisplayText :: Lens' Answer (Maybe Text) Source #

The helpful resource text to be displayed.

answer_isApplicable :: Lens' Answer (Maybe Bool) Source #

Undocumented member.

answer_notes :: Lens' Answer (Maybe Text) Source #

Undocumented member.

answer_pillarId :: Lens' Answer (Maybe Text) Source #

Undocumented member.

answer_questionId :: Lens' Answer (Maybe Text) Source #

Undocumented member.

answer_reason :: Lens' Answer (Maybe AnswerReason) Source #

The reason why the question is not applicable to your workload.

answer_risk :: Lens' Answer (Maybe Risk) Source #

Undocumented member.

answer_selectedChoices :: Lens' Answer (Maybe [Text]) Source #

Undocumented member.

AnswerSummary

answerSummary_choiceAnswerSummaries :: Lens' AnswerSummary (Maybe [ChoiceAnswerSummary]) Source #

A list of selected choices to a question in your workload.

answerSummary_reason :: Lens' AnswerSummary (Maybe AnswerReason) Source #

The reason why a choice is non-applicable to a question in your workload.

CheckDetail

checkDetail_description :: Lens' CheckDetail (Maybe Text) Source #

Trusted Advisor check description.

checkDetail_flaggedResources :: Lens' CheckDetail (Maybe Natural) Source #

Count of flagged resources associated to the check.

checkDetail_id :: Lens' CheckDetail (Maybe Text) Source #

Trusted Advisor check ID.

checkDetail_lensArn :: Lens' CheckDetail (Maybe Text) Source #

Well-Architected Lens ARN associated to the check.

checkDetail_name :: Lens' CheckDetail (Maybe Text) Source #

Trusted Advisor check name.

checkDetail_provider :: Lens' CheckDetail (Maybe CheckProvider) Source #

Provider of the check related to the best practice.

checkDetail_status :: Lens' CheckDetail (Maybe CheckStatus) Source #

Status associated to the check.

CheckSummary

checkSummary_accountSummary :: Lens' CheckSummary (Maybe (HashMap CheckStatus Natural)) Source #

Account summary associated to the check.

checkSummary_description :: Lens' CheckSummary (Maybe Text) Source #

Trusted Advisor check description.

checkSummary_id :: Lens' CheckSummary (Maybe Text) Source #

Trusted Advisor check ID.

checkSummary_lensArn :: Lens' CheckSummary (Maybe Text) Source #

Well-Architected Lens ARN associated to the check.

checkSummary_name :: Lens' CheckSummary (Maybe Text) Source #

Trusted Advisor check name.

checkSummary_provider :: Lens' CheckSummary (Maybe CheckProvider) Source #

Provider of the check related to the best practice.

checkSummary_status :: Lens' CheckSummary (Maybe CheckStatus) Source #

Status associated to the check.

Choice

choice_additionalResources :: Lens' Choice (Maybe [AdditionalResources]) Source #

The additional resources for a choice. A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

choice_choiceId :: Lens' Choice (Maybe Text) Source #

Undocumented member.

choice_description :: Lens' Choice (Maybe Text) Source #

Undocumented member.

choice_helpfulResource :: Lens' Choice (Maybe ChoiceContent) Source #

The choice level helpful resource.

choice_improvementPlan :: Lens' Choice (Maybe ChoiceContent) Source #

The choice level improvement plan.

choice_title :: Lens' Choice (Maybe Text) Source #

Undocumented member.

ChoiceAnswer

choiceAnswer_notes :: Lens' ChoiceAnswer (Maybe Text) Source #

The notes associated with a choice.

choiceAnswer_reason :: Lens' ChoiceAnswer (Maybe ChoiceReason) Source #

The reason why a choice is non-applicable to a question in your workload.

ChoiceAnswerSummary

choiceAnswerSummary_reason :: Lens' ChoiceAnswerSummary (Maybe ChoiceReason) Source #

The reason why a choice is non-applicable to a question in your workload.

ChoiceContent

choiceContent_displayText :: Lens' ChoiceContent (Maybe Text) Source #

The display text for the choice content.

choiceContent_url :: Lens' ChoiceContent (Maybe Text) Source #

The URL for the choice content.

ChoiceImprovementPlan

choiceImprovementPlan_displayText :: Lens' ChoiceImprovementPlan (Maybe Text) Source #

The display text for the improvement plan.

ChoiceUpdate

choiceUpdate_notes :: Lens' ChoiceUpdate (Maybe Text) Source #

The notes associated with a choice.

choiceUpdate_reason :: Lens' ChoiceUpdate (Maybe ChoiceReason) Source #

The reason why a choice is non-applicable to a question in your workload.

ImprovementSummary

Lens

lens_description :: Lens' Lens (Maybe Text) Source #

Undocumented member.

lens_lensArn :: Lens' Lens (Maybe Text) Source #

The ARN of a lens.

lens_lensVersion :: Lens' Lens (Maybe Text) Source #

The version of a lens.

lens_name :: Lens' Lens (Maybe Text) Source #

Undocumented member.

lens_owner :: Lens' Lens (Maybe Text) Source #

The Amazon Web Services account ID that owns the lens.

lens_shareInvitationId :: Lens' Lens (Maybe Text) Source #

The ID assigned to the share invitation.

lens_tags :: Lens' Lens (Maybe (HashMap Text Text)) Source #

The tags assigned to the lens.

LensReview

LensReviewReport

LensReviewSummary

LensShareSummary

lensShareSummary_statusMessage :: Lens' LensShareSummary (Maybe Text) Source #

Optional message to compliment the Status field.

LensSummary

LensUpgradeSummary

Milestone

MilestoneSummary

NotificationSummary

PillarDifference

PillarReviewSummary

QuestionDifference

ShareInvitation

shareInvitation_shareInvitationId :: Lens' ShareInvitation (Maybe Text) Source #

The ID assigned to the share invitation.

ShareInvitationSummary

VersionDifferences

versionDifferences_pillarDifferences :: Lens' VersionDifferences (Maybe [PillarDifference]) Source #

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

Workload

workload_accountIds :: Lens' Workload (Maybe [Text]) Source #

Undocumented member.

workload_applications :: Lens' Workload (Maybe [Text]) Source #

List of AppRegistry application ARNs associated to the workload.

workload_awsRegions :: Lens' Workload (Maybe [Text]) Source #

Undocumented member.

workload_discoveryConfig :: Lens' Workload (Maybe WorkloadDiscoveryConfig) Source #

Discovery configuration associated to the workload.

workload_industry :: Lens' Workload (Maybe Text) Source #

Undocumented member.

workload_isReviewOwnerUpdateAcknowledged :: Lens' Workload (Maybe Bool) Source #

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

workload_lenses :: Lens' Workload (Maybe [Text]) Source #

Undocumented member.

workload_notes :: Lens' Workload (Maybe Text) Source #

Undocumented member.

workload_owner :: Lens' Workload (Maybe Text) Source #

Undocumented member.

workload_shareInvitationId :: Lens' Workload (Maybe Text) Source #

The ID assigned to the share invitation.

workload_tags :: Lens' Workload (Maybe (HashMap Text Text)) Source #

The tags associated with the workload.

WorkloadDiscoveryConfig

workloadDiscoveryConfig_trustedAdvisorIntegrationStatus :: Lens' WorkloadDiscoveryConfig (Maybe TrustedAdvisorIntegrationStatus) Source #

Discovery integration status in respect to Trusted Advisor for the workload.

WorkloadShare

WorkloadShareSummary

workloadShareSummary_statusMessage :: Lens' WorkloadShareSummary (Maybe Text) Source #

Optional message to compliment the Status field.

WorkloadSummary