'2.0', 'service' => '
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.
', 'operations' => [ 'AssociateLenses' => 'Associate a lens to a workload.
Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.
Disclaimer
By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.
Associate a profile with a workload.
', 'CreateLensShare' => '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 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 milestone for an existing workload.
', 'CreateProfile' => 'Create a profile.
', 'CreateProfileShare' => 'Create a profile share.
', 'CreateWorkload' => 'Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either AwsRegions
, NonAwsRegions
, or both must be specified when creating a workload.
You also must specify ReviewOwner
, even though the parameter is listed as not being required in the following section.
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.
For more information, see Sharing a workload in the Well-Architected Tool User Guide.
', 'DeleteLens' => '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.
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 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 profile share.
', 'DeleteWorkload' => 'Delete an existing workload.
', 'DeleteWorkloadShare' => 'Delete a workload share.
', 'DisassociateLenses' => 'Disassociate a lens from a workload.
Up to 10 lenses can be disassociated from a workload in a single API operation.
The Amazon Web Services Well-Architected Framework lens (wellarchitected
) cannot be removed from a workload.
Disassociate a profile from a workload.
', 'ExportLens' => '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.
Get the answer to a specific question in a workload review.
', 'GetConsolidatedReport' => 'Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
', 'GetLens' => 'Get an existing lens.
', 'GetLensReview' => 'Get lens review.
', 'GetLensReviewReport' => 'Get lens review report.
', 'GetLensVersionDifference' => 'Get lens version differences.
', 'GetMilestone' => 'Get a milestone for an existing workload.
', 'GetProfile' => 'Get profile information.
', 'GetProfileTemplate' => 'Get profile template.
', 'GetWorkload' => 'Get an existing workload.
', 'ImportLens' => '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.
List of answers for a particular workload and lens.
', 'ListCheckDetails' => 'List of Trusted Advisor check details by account related to the workload.
', 'ListCheckSummaries' => 'List of Trusted Advisor checks summarized for all accounts related to the workload.
', 'ListLensReviewImprovements' => 'List lens review improvements.
', 'ListLensReviews' => 'List lens reviews for a particular workload.
', 'ListLensShares' => 'List the lens shares associated with the lens.
', 'ListLenses' => 'List the available lenses.
', 'ListMilestones' => 'List all milestones for an existing workload.
', 'ListNotifications' => 'List lens notifications.
', 'ListProfileNotifications' => 'List profile notifications.
', 'ListProfileShares' => 'List profile shares.
', 'ListProfiles' => 'List profiles.
', 'ListShareInvitations' => 'List the workload invitations.
', 'ListTagsForResource' => 'List the tags for a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
List the workload shares associated with the workload.
', 'ListWorkloads' => 'Paginated list of workloads.
', 'TagResource' => 'Adds one or more tags to the specified resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
Deletes specified tags from a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
Update the answer to a specific question in a workload review.
', 'UpdateGlobalSettings' => 'Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
', 'UpdateLensReview' => 'Update lens review for a particular workload.
', 'UpdateProfile' => 'Update a profile.
', 'UpdateShareInvitation' => '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.
Update an existing workload.
', 'UpdateWorkloadShare' => 'Update a workload share.
', 'UpgradeLensReview' => 'Upgrade lens review for a particular workload.
', 'UpgradeProfileVersion' => 'Upgrade a profile.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'User does not have sufficient access to perform this action.
', 'refs' => [], ], 'AccountSummary' => [ 'base' => 'Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.
', 'refs' => [ 'CheckSummary$AccountSummary' => 'Account summary associated to the check.
', ], ], 'AdditionalResourceType' => [ 'base' => NULL, 'refs' => [ 'AdditionalResources$Type' => 'Type of additional resource for a custom lens.
', ], ], 'AdditionalResources' => [ 'base' => 'The choice level additional resources for a custom lens.
This field does not apply to Amazon Web Services official lenses.
', 'refs' => [ 'AdditionalResourcesList$member' => NULL, ], ], 'AdditionalResourcesList' => [ 'base' => NULL, 'refs' => [ 'Choice$AdditionalResources' => 'The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE
, one of type IMPROVEMENT_PLAN
, or both.
An answer of the question.
', 'refs' => [ 'GetAnswerOutput$Answer' => NULL, 'UpdateAnswerOutput$Answer' => NULL, ], ], 'AnswerReason' => [ 'base' => NULL, 'refs' => [ 'Answer$Reason' => 'The reason why the question is not applicable to your workload.
', 'AnswerSummary$Reason' => 'The reason why a choice is non-applicable to a question in your workload.
', 'UpdateAnswerInput$Reason' => 'The reason why a question is not applicable to your workload.
', ], ], 'AnswerSummaries' => [ 'base' => 'List of answer summaries of lens review in a workload.
', 'refs' => [ 'ListAnswersOutput$AnswerSummaries' => NULL, ], ], 'AnswerSummary' => [ 'base' => 'An answer summary of a lens review in a workload.
', 'refs' => [ 'AnswerSummaries$member' => NULL, ], ], 'ApplicationArn' => [ 'base' => NULL, 'refs' => [ 'WorkloadApplications$member' => NULL, ], ], 'AssociateLensesInput' => [ 'base' => 'Input to associate lens reviews.
', 'refs' => [], ], 'AssociateProfilesInput' => [ 'base' => NULL, 'refs' => [], ], 'AwsAccountId' => [ 'base' => 'An Amazon Web Services account ID.
', 'refs' => [ 'CheckDetail$AccountId' => NULL, 'LensSummary$Owner' => NULL, 'Profile$Owner' => NULL, 'ProfileSummary$Owner' => NULL, 'ShareInvitationSummary$SharedBy' => NULL, 'Workload$Owner' => NULL, 'WorkloadAccountIds$member' => NULL, 'WorkloadShare$SharedBy' => NULL, 'WorkloadSummary$Owner' => NULL, ], ], 'AwsRegion' => [ 'base' => 'An Amazon Web Services Region, for example, us-west-2
or ap-northeast-1
.
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 best practice, or question choice, that has been identified as a risk in this question.
', 'refs' => [ 'BestPractices$member' => NULL, ], ], 'BestPractices' => [ 'base' => NULL, 'refs' => [ 'QuestionMetric$BestPractices' => 'The best practices, or choices, that have been identified as contributing to risk in a question.
', ], ], 'CheckDescription' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$Description' => 'Trusted Advisor check description.
', 'CheckSummary$Description' => 'Trusted Advisor check description.
', ], ], 'CheckDetail' => [ 'base' => 'Account details for a Well-Architected best practice in relation to Trusted Advisor checks.
', 'refs' => [ 'CheckDetails$member' => NULL, ], ], 'CheckDetails' => [ 'base' => NULL, 'refs' => [ 'ListCheckDetailsOutput$CheckDetails' => 'The details about the Trusted Advisor checks related to the Well-Architected best practice.
', ], ], 'CheckFailureReason' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$Reason' => 'Reason associated to the check.
', ], ], 'CheckId' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$Id' => 'Trusted Advisor check ID.
', 'CheckSummary$Id' => 'Trusted Advisor check ID.
', ], ], 'CheckName' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$Name' => 'Trusted Advisor check name.
', 'CheckSummary$Name' => 'Trusted Advisor check name.
', ], ], 'CheckProvider' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$Provider' => 'Provider of the check related to the best practice.
', 'CheckSummary$Provider' => 'Provider of the check related to the best practice.
', ], ], 'CheckStatus' => [ 'base' => NULL, 'refs' => [ 'AccountSummary$key' => NULL, 'CheckDetail$Status' => 'Status associated to the check.
', 'CheckSummary$Status' => 'Status associated to the check.
', ], ], 'CheckStatusCount' => [ 'base' => NULL, 'refs' => [ 'AccountSummary$value' => NULL, ], ], 'CheckSummaries' => [ 'base' => NULL, 'refs' => [ 'ListCheckSummariesOutput$CheckSummaries' => 'List of Trusted Advisor summaries related to the Well-Architected best practice.
', ], ], 'CheckSummary' => [ 'base' => 'Trusted Advisor check summary.
', 'refs' => [ 'CheckSummaries$member' => NULL, ], ], 'Choice' => [ 'base' => 'A choice available to answer question.
', 'refs' => [ 'Choices$member' => NULL, ], ], 'ChoiceAnswer' => [ 'base' => 'A choice that has been answered on a question in your workload.
', 'refs' => [ 'ChoiceAnswers$member' => NULL, ], ], 'ChoiceAnswerSummaries' => [ 'base' => NULL, 'refs' => [ 'AnswerSummary$ChoiceAnswerSummaries' => 'A list of selected choices to a question in your workload.
', ], ], 'ChoiceAnswerSummary' => [ 'base' => 'A choice summary that has been answered on a question in your workload.
', 'refs' => [ 'ChoiceAnswerSummaries$member' => NULL, ], ], 'ChoiceAnswers' => [ 'base' => NULL, 'refs' => [ 'Answer$ChoiceAnswers' => 'A list of selected choices to a question in your workload.
', ], ], 'ChoiceContent' => [ 'base' => 'The choice content.
', 'refs' => [ 'Choice$HelpfulResource' => 'The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
', 'Choice$ImprovementPlan' => 'The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
', 'Urls$member' => NULL, ], ], 'ChoiceContentDisplayText' => [ 'base' => NULL, 'refs' => [ 'ChoiceContent$DisplayText' => 'The display text for the choice content.
', ], ], 'ChoiceContentUrl' => [ 'base' => NULL, 'refs' => [ 'ChoiceContent$Url' => 'The URL for the choice content.
', ], ], 'ChoiceDescription' => [ 'base' => 'The description of a choice.
', 'refs' => [ 'Choice$Description' => NULL, 'ProfileChoice$ChoiceDescription' => NULL, 'ProfileTemplateChoice$ChoiceDescription' => NULL, ], ], 'ChoiceId' => [ 'base' => 'The ID of a choice.
', 'refs' => [ 'BestPractice$ChoiceId' => NULL, 'CheckDetail$ChoiceId' => NULL, 'CheckSummary$ChoiceId' => NULL, 'Choice$ChoiceId' => NULL, 'ChoiceAnswer$ChoiceId' => NULL, 'ChoiceAnswerSummary$ChoiceId' => NULL, 'ChoiceImprovementPlan$ChoiceId' => NULL, 'ChoiceUpdates$key' => NULL, 'ListCheckDetailsInput$ChoiceId' => NULL, 'ListCheckSummariesInput$ChoiceId' => NULL, 'ProfileChoice$ChoiceId' => NULL, 'ProfileTemplateChoice$ChoiceId' => NULL, 'SelectedChoiceIds$member' => NULL, 'SelectedChoices$member' => NULL, 'SelectedProfileChoiceIds$member' => NULL, ], ], 'ChoiceImprovementPlan' => [ 'base' => 'The choice level improvement plan.
', 'refs' => [ 'ChoiceImprovementPlans$member' => NULL, ], ], 'ChoiceImprovementPlans' => [ 'base' => NULL, 'refs' => [ 'ImprovementSummary$ImprovementPlans' => 'The improvement plan details.
', ], ], 'ChoiceNotes' => [ 'base' => NULL, 'refs' => [ 'ChoiceAnswer$Notes' => 'The notes associated with a choice.
', 'ChoiceUpdate$Notes' => 'The notes associated with a choice.
', ], ], 'ChoiceReason' => [ 'base' => NULL, 'refs' => [ 'ChoiceAnswer$Reason' => 'The reason why a choice is non-applicable to a question in your workload.
', 'ChoiceAnswerSummary$Reason' => 'The reason why a choice is non-applicable to a question in your workload.
', 'ChoiceUpdate$Reason' => 'The reason why a choice is non-applicable to a question in your workload.
', ], ], 'ChoiceStatus' => [ 'base' => NULL, 'refs' => [ 'ChoiceAnswer$Status' => 'The status of a choice.
', 'ChoiceAnswerSummary$Status' => 'The status of a choice.
', 'ChoiceUpdate$Status' => 'The status of a choice.
', ], ], 'ChoiceTitle' => [ 'base' => 'The title of a choice.
', 'refs' => [ 'BestPractice$ChoiceTitle' => NULL, 'Choice$Title' => NULL, 'ProfileChoice$ChoiceTitle' => NULL, 'ProfileTemplateChoice$ChoiceTitle' => NULL, ], ], 'ChoiceUpdate' => [ 'base' => 'A list of choices to be updated.
', 'refs' => [ 'ChoiceUpdates$value' => NULL, ], ], 'ChoiceUpdates' => [ 'base' => NULL, 'refs' => [ 'UpdateAnswerInput$ChoiceUpdates' => 'A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
', ], ], 'Choices' => [ 'base' => 'List of choices available for a question.
', 'refs' => [ 'Answer$Choices' => NULL, 'AnswerSummary$Choices' => NULL, ], ], 'ClientRequestToken' => [ 'base' => '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.
The resource has already been processed, was deleted, or is too large.
', 'refs' => [], ], 'ConsolidatedReportMetric' => [ 'base' => 'A metric that contributes to the consolidated report.
', 'refs' => [ 'ConsolidatedReportMetrics$member' => NULL, ], ], 'ConsolidatedReportMetrics' => [ 'base' => NULL, 'refs' => [ 'GetConsolidatedReportOutput$Metrics' => 'The metrics that make up the consolidated report.
Only returned when JSON
format is requested.
A non-negative integer that denotes how many.
', 'refs' => [ 'RiskCounts$value' => NULL, ], ], 'CreateLensShareInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateLensShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateLensVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateLensVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateMilestoneInput' => [ 'base' => 'Input for milestone creation.
', 'refs' => [], ], 'CreateMilestoneOutput' => [ 'base' => 'Output of a create milestone call.
', 'refs' => [], ], 'CreateProfileInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileShareInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProfileShareOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateWorkloadInput' => [ 'base' => 'Input for workload creation.
', 'refs' => [], ], 'CreateWorkloadOutput' => [ 'base' => 'Output of a create workload call.
', 'refs' => [], ], 'CreateWorkloadShareInput' => [ 'base' => 'Input for Create Workload Share
', 'refs' => [], ], 'CreateWorkloadShareOutput' => [ 'base' => 'Input for Create Workload Share
', 'refs' => [], ], 'DefinitionType' => [ 'base' => NULL, 'refs' => [ 'WorkloadResourceDefinition$member' => NULL, ], ], 'DeleteLensInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLensShareInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProfileInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProfileShareInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWorkloadInput' => [ 'base' => 'Input for workload deletion.
', 'refs' => [], ], 'DeleteWorkloadShareInput' => [ 'base' => 'Input for Delete Workload Share
', 'refs' => [], ], 'DifferenceStatus' => [ 'base' => NULL, 'refs' => [ 'PillarDifference$DifferenceStatus' => 'Indicates the type of change to the pillar.
', 'QuestionDifference$DifferenceStatus' => 'Indicates the type of change to the question.
', ], ], 'DisassociateLensesInput' => [ 'base' => 'Input to disassociate lens reviews.
', 'refs' => [], ], 'DisassociateProfilesInput' => [ 'base' => NULL, 'refs' => [], ], 'DiscoveryIntegrationStatus' => [ 'base' => NULL, 'refs' => [ 'UpdateGlobalSettingsInput$DiscoveryIntegrationStatus' => 'The status of discovery support settings.
', ], ], 'DisplayText' => [ 'base' => NULL, 'refs' => [ 'Answer$HelpfulResourceDisplayText' => 'The helpful resource text to be displayed for a custom lens.
This field does not apply to Amazon Web Services official lenses.
', 'ChoiceImprovementPlan$DisplayText' => 'The display text for the improvement plan.
', ], ], 'ExceptionMessage' => [ 'base' => 'Description of the error.
', 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ConflictException$Message' => NULL, 'InternalServerException$Message' => NULL, 'ResourceNotFoundException$Message' => NULL, 'ServiceQuotaExceededException$Message' => NULL, 'ThrottlingException$Message' => NULL, 'ValidationException$Message' => NULL, 'ValidationExceptionField$Message' => NULL, ], ], 'ExceptionResourceId' => [ 'base' => 'Identifier of the resource affected.
', 'refs' => [ 'ConflictException$ResourceId' => NULL, 'ResourceNotFoundException$ResourceId' => NULL, 'ServiceQuotaExceededException$ResourceId' => NULL, ], ], 'ExceptionResourceType' => [ 'base' => 'Type of the resource affected.
', 'refs' => [ 'ConflictException$ResourceType' => NULL, 'ResourceNotFoundException$ResourceType' => NULL, 'ServiceQuotaExceededException$ResourceType' => NULL, ], ], 'ExportLensInput' => [ 'base' => NULL, 'refs' => [], ], 'ExportLensOutput' => [ 'base' => NULL, 'refs' => [], ], 'FlaggedResources' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$FlaggedResources' => 'Count of flagged resources associated to the check.
', ], ], 'GetAnswerInput' => [ 'base' => 'Input to get answer.
', 'refs' => [], ], 'GetAnswerOutput' => [ 'base' => 'Output of a get answer call.
', 'refs' => [], ], 'GetConsolidatedReportInput' => [ 'base' => NULL, 'refs' => [], ], 'GetConsolidatedReportMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetConsolidatedReportInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'GetConsolidatedReportOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetLensInput' => [ 'base' => NULL, 'refs' => [], ], 'GetLensOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetLensReviewInput' => [ 'base' => 'Input to get lens review.
', 'refs' => [], ], 'GetLensReviewOutput' => [ 'base' => 'Output of a get lens review call.
', 'refs' => [], ], 'GetLensReviewReportInput' => [ 'base' => 'Input to get lens review report.
', 'refs' => [], ], 'GetLensReviewReportOutput' => [ 'base' => 'Output of a get lens review report call.
', 'refs' => [], ], 'GetLensVersionDifferenceInput' => [ 'base' => NULL, 'refs' => [], ], 'GetLensVersionDifferenceOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetMilestoneInput' => [ 'base' => 'Input to get a milestone.
', 'refs' => [], ], 'GetMilestoneOutput' => [ 'base' => 'Output of a get milestone call.
', 'refs' => [], ], 'GetProfileInput' => [ 'base' => NULL, 'refs' => [], ], 'GetProfileOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetProfileTemplateInput' => [ 'base' => NULL, 'refs' => [], ], 'GetProfileTemplateOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadInput' => [ 'base' => 'Input to get a workload.
', 'refs' => [], ], 'GetWorkloadOutput' => [ 'base' => 'Output of a get workload call.
', 'refs' => [], ], 'HelpfulResourceUrl' => [ 'base' => '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.
The status of the imported lens.
', ], ], 'ImprovementPlanUrl' => [ 'base' => '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.
', 'refs' => [ 'Answer$ImprovementPlanUrl' => NULL, 'ChoiceImprovementPlan$ImprovementPlanUrl' => NULL, 'ImprovementSummary$ImprovementPlanUrl' => NULL, ], ], 'ImprovementSummaries' => [ 'base' => 'List of improvement summaries of lens review in a workload.
', 'refs' => [ 'ListLensReviewImprovementsOutput$ImprovementSummaries' => NULL, ], ], 'ImprovementSummary' => [ 'base' => 'An improvement summary of a lens review in a workload.
', 'refs' => [ 'ImprovementSummaries$member' => NULL, ], ], 'IncludeSharedResources' => [ 'base' => NULL, 'refs' => [ 'GetConsolidatedReportInput$IncludeSharedResources' => 'Set to true
to have shared resources included in the report.
There is a problem with the Well-Architected Tool API service.
', 'refs' => [], ], 'IsApplicable' => [ 'base' => 'Defines whether this question is applicable to a lens review.
', 'refs' => [ 'Answer$IsApplicable' => NULL, 'AnswerSummary$IsApplicable' => NULL, 'UpdateAnswerInput$IsApplicable' => NULL, ], ], 'IsMajorVersion' => [ 'base' => NULL, 'refs' => [ 'CreateLensVersionInput$IsMajorVersion' => 'Set to true if this new major lens version.
', ], ], 'IsReviewOwnerUpdateAcknowledged' => [ 'base' => NULL, 'refs' => [ 'UpdateWorkloadInput$IsReviewOwnerUpdateAcknowledged' => '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$IsReviewOwnerUpdateAcknowledged' => '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.
', ], ], 'Lens' => [ 'base' => 'A lens return object.
', 'refs' => [ 'GetLensOutput$Lens' => 'A lens return object.
', ], ], 'LensAlias' => [ 'base' => '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.
', 'refs' => [ 'CreateLensShareInput$LensAlias' => NULL, 'CreateLensVersionInput$LensAlias' => NULL, 'DeleteLensInput$LensAlias' => NULL, 'DeleteLensShareInput$LensAlias' => NULL, 'ExportLensInput$LensAlias' => NULL, 'GetAnswerInput$LensAlias' => NULL, 'GetAnswerOutput$LensAlias' => NULL, 'GetLensInput$LensAlias' => NULL, 'GetLensReviewInput$LensAlias' => NULL, 'GetLensReviewReportInput$LensAlias' => NULL, 'GetLensVersionDifferenceInput$LensAlias' => NULL, 'GetLensVersionDifferenceOutput$LensAlias' => NULL, 'ImportLensInput$LensAlias' => NULL, 'LensAliases$member' => NULL, 'LensReview$LensAlias' => NULL, 'LensReviewReport$LensAlias' => NULL, 'LensReviewSummary$LensAlias' => NULL, 'LensSummary$LensAlias' => NULL, 'LensUpgradeSummary$LensAlias' => NULL, 'ListAnswersInput$LensAlias' => NULL, 'ListAnswersOutput$LensAlias' => NULL, 'ListLensReviewImprovementsInput$LensAlias' => NULL, 'ListLensReviewImprovementsOutput$LensAlias' => NULL, 'ListLensSharesInput$LensAlias' => NULL, 'ShareInvitation$LensAlias' => NULL, 'UpdateAnswerInput$LensAlias' => NULL, 'UpdateAnswerOutput$LensAlias' => NULL, 'UpdateLensReviewInput$LensAlias' => NULL, 'UpgradeLensReviewInput$LensAlias' => NULL, 'WorkloadLenses$member' => NULL, ], ], 'LensAliases' => [ 'base' => 'List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
Identify a lens using its LensSummary$LensAlias.
', 'refs' => [ 'AssociateLensesInput$LensAliases' => NULL, 'DisassociateLensesInput$LensAliases' => NULL, ], ], 'LensArn' => [ 'base' => NULL, 'refs' => [ 'CheckDetail$LensArn' => 'Well-Architected Lens ARN associated to the check.
', 'CheckSummary$LensArn' => 'Well-Architected Lens ARN associated to the check.
', 'CreateLensVersionOutput$LensArn' => 'The ARN for the lens.
', 'GetAnswerOutput$LensArn' => 'The ARN for the lens.
', 'GetLensVersionDifferenceOutput$LensArn' => 'The ARN for the lens.
', 'ImportLensOutput$LensArn' => 'The ARN for the lens that was created or updated.
', 'Lens$LensArn' => 'The ARN of a lens.
', 'LensMetric$LensArn' => 'The lens ARN.
', 'LensReview$LensArn' => 'The ARN for the lens.
', 'LensReviewReport$LensArn' => 'The ARN for the lens.
', 'LensReviewSummary$LensArn' => 'The ARN for the lens.
', 'LensSummary$LensArn' => 'The ARN of the lens.
', 'LensUpgradeSummary$LensArn' => 'The ARN for the lens.
', 'ListAnswersOutput$LensArn' => 'The ARN for the lens.
', 'ListCheckDetailsInput$LensArn' => 'Well-Architected Lens ARN.
', 'ListCheckSummariesInput$LensArn' => 'Well-Architected Lens ARN.
', 'ListLensReviewImprovementsOutput$LensArn' => 'The ARN for the lens.
', 'ShareInvitation$LensArn' => 'The ARN for the lens.
', 'ShareInvitationSummary$LensArn' => 'The ARN for the lens.
', 'UpdateAnswerOutput$LensArn' => 'The ARN for the lens.
', ], ], 'LensDescription' => [ 'base' => 'The description of the lens.
', 'refs' => [ 'Lens$Description' => NULL, 'LensSummary$Description' => NULL, ], ], 'LensJSON' => [ 'base' => NULL, 'refs' => [ 'ExportLensOutput$LensJSON' => 'The JSON representation of a lens.
', 'ImportLensInput$JSONString' => 'The JSON representation of a lens.
', ], ], 'LensMetric' => [ 'base' => 'A metric for a particular lens in a workload.
', 'refs' => [ 'LensMetrics$member' => NULL, ], ], 'LensMetrics' => [ 'base' => NULL, 'refs' => [ 'ConsolidatedReportMetric$Lenses' => 'The metrics for the lenses in the workload.
', ], ], 'LensName' => [ 'base' => 'The full name of the lens.
', 'refs' => [ 'Lens$Name' => NULL, 'LensReview$LensName' => NULL, 'LensReviewSummary$LensName' => NULL, 'LensSummary$LensName' => NULL, 'ListLensesInput$LensName' => NULL, 'ShareInvitationSummary$LensName' => NULL, ], ], 'LensNamePrefix' => [ 'base' => NULL, 'refs' => [ 'ListShareInvitationsInput$LensNamePrefix' => 'An optional string added to the beginning of each lens name returned in the results.
', ], ], 'LensOwner' => [ 'base' => NULL, 'refs' => [ 'Lens$Owner' => 'The Amazon Web Services account ID that owns the lens.
', ], ], 'LensReview' => [ 'base' => 'A lens review of a question.
', 'refs' => [ 'GetLensReviewOutput$LensReview' => NULL, 'UpdateLensReviewOutput$LensReview' => NULL, ], ], 'LensReviewReport' => [ 'base' => 'A report of a lens review.
', 'refs' => [ 'GetLensReviewReportOutput$LensReviewReport' => NULL, ], ], 'LensReviewSummaries' => [ 'base' => 'List of lens summaries of lens reviews of a workload.
', 'refs' => [ 'ListLensReviewsOutput$LensReviewSummaries' => NULL, ], ], 'LensReviewSummary' => [ 'base' => 'A lens review summary of a workload.
', 'refs' => [ 'LensReviewSummaries$member' => NULL, ], ], 'LensShareSummaries' => [ 'base' => NULL, 'refs' => [ 'ListLensSharesOutput$LensShareSummaries' => 'A list of lens share summaries.
', ], ], 'LensShareSummary' => [ 'base' => 'A lens share summary return object.
', 'refs' => [ 'LensShareSummaries$member' => NULL, ], ], 'LensStatus' => [ 'base' => NULL, 'refs' => [ 'LensReview$LensStatus' => 'The status of the lens.
', 'LensReviewSummary$LensStatus' => 'The status of the lens.
', 'LensSummary$LensStatus' => 'The status of the lens.
', ], ], 'LensStatusType' => [ 'base' => NULL, 'refs' => [ 'DeleteLensInput$LensStatus' => 'The status of the lens to be deleted.
', 'ListLensesInput$LensStatus' => 'The status of lenses to be returned.
', ], ], 'LensSummaries' => [ 'base' => 'List of lens summaries of available lenses.
', 'refs' => [ 'ListLensesOutput$LensSummaries' => NULL, ], ], 'LensSummary' => [ 'base' => 'A lens summary of a lens.
', 'refs' => [ 'LensSummaries$member' => NULL, ], ], 'LensType' => [ 'base' => NULL, 'refs' => [ 'LensSummary$LensType' => 'The type of the lens.
', 'ListLensesInput$LensType' => 'The type of lenses to be returned.
', ], ], 'LensUpgradeSummary' => [ 'base' => 'Lens upgrade summary return object.
', 'refs' => [ 'NotificationSummary$LensUpgradeSummary' => 'Summary of lens upgrade.
', ], ], 'LensVersion' => [ 'base' => NULL, 'refs' => [ 'CreateLensVersionInput$LensVersion' => 'The version of the lens being created.
', 'CreateLensVersionOutput$LensVersion' => 'The version of the lens.
', 'ExportLensInput$LensVersion' => 'The lens version to be exported.
', 'GetLensInput$LensVersion' => 'The lens version to be retrieved.
', 'GetLensVersionDifferenceInput$BaseLensVersion' => 'The base version of the lens.
', 'GetLensVersionDifferenceInput$TargetLensVersion' => 'The lens version to target a difference for.
', 'GetLensVersionDifferenceOutput$BaseLensVersion' => 'The base version of the lens.
', 'GetLensVersionDifferenceOutput$TargetLensVersion' => 'The target lens version for the lens.
', 'GetLensVersionDifferenceOutput$LatestLensVersion' => 'The latest version of the lens.
', 'Lens$LensVersion' => 'The version of a lens.
', 'LensReview$LensVersion' => 'The version of the lens.
', 'LensReviewSummary$LensVersion' => 'The version of the lens.
', 'LensSummary$LensVersion' => 'The version of the lens.
', 'LensUpgradeSummary$CurrentLensVersion' => 'The current version of the lens.
', 'LensUpgradeSummary$LatestLensVersion' => 'The latest version of the lens.
', ], ], 'LensesAppliedCount' => [ 'base' => NULL, 'refs' => [ 'ConsolidatedReportMetric$LensesAppliedCount' => 'The total number of lenses applied to the workload.
', ], ], 'ListAnswersInput' => [ 'base' => 'Input to list answers.
', 'refs' => [], ], 'ListAnswersMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListAnswersInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListAnswersOutput' => [ 'base' => 'Output of a list answers call.
', 'refs' => [], ], 'ListCheckDetailsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCheckDetailsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCheckSummariesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCheckSummariesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLensReviewImprovementsInput' => [ 'base' => 'Input to list lens review improvements.
', 'refs' => [], ], 'ListLensReviewImprovementsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListLensReviewImprovementsInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListLensReviewImprovementsOutput' => [ 'base' => 'Output of a list lens review improvements call.
', 'refs' => [], ], 'ListLensReviewsInput' => [ 'base' => 'Input to list lens reviews.
', 'refs' => [], ], 'ListLensReviewsOutput' => [ 'base' => 'Output of a list lens reviews call.
', 'refs' => [], ], 'ListLensSharesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListLensSharesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListLensesInput' => [ 'base' => 'Input to list lenses.
', 'refs' => [], ], 'ListLensesOutput' => [ 'base' => 'Output of a list lenses call.
', 'refs' => [], ], 'ListMilestonesInput' => [ 'base' => 'Input to list all milestones for a workload.
', 'refs' => [], ], 'ListMilestonesOutput' => [ 'base' => 'Output of a list milestones call.
', 'refs' => [], ], 'ListNotificationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListNotificationsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListNotificationsInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListNotificationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProfileNotificationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProfileNotificationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProfileSharesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProfileSharesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListProfileSharesInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListProfileSharesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProfilesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListShareInvitationsInput' => [ 'base' => 'Input for List Share Invitations
', 'refs' => [], ], 'ListShareInvitationsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListShareInvitationsInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListShareInvitationsOutput' => [ 'base' => 'Input for List Share Invitations
', 'refs' => [], ], 'ListTagsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadSharesInput' => [ 'base' => 'Input for List Workload Share
', 'refs' => [], ], 'ListWorkloadSharesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListLensSharesInput$MaxResults' => 'The maximum number of results to return for this request.
', 'ListWorkloadSharesInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListWorkloadSharesOutput' => [ 'base' => 'Input for List Workload Share
', 'refs' => [], ], 'ListWorkloadsInput' => [ 'base' => 'Input to list all workloads.
', 'refs' => [], ], 'ListWorkloadsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadsInput$MaxResults' => 'The maximum number of results to return for this request.
', ], ], 'ListWorkloadsOutput' => [ 'base' => 'Output of a list workloads call.
', 'refs' => [], ], 'MaxResults' => [ 'base' => 'The maximum number of results to return for this request.
', 'refs' => [ 'ListCheckDetailsInput$MaxResults' => NULL, 'ListCheckSummariesInput$MaxResults' => NULL, 'ListLensReviewsInput$MaxResults' => NULL, 'ListLensesInput$MaxResults' => NULL, 'ListMilestonesInput$MaxResults' => NULL, 'ListProfileNotificationsInput$MaxResults' => NULL, 'ListProfilesInput$MaxResults' => NULL, ], ], 'MaxSelectedProfileChoices' => [ 'base' => NULL, 'refs' => [ 'ProfileQuestion$MaxSelectedChoices' => 'The maximum number of selected choices.
', 'ProfileTemplateQuestion$MaxSelectedChoices' => 'The maximum number of choices selected.
', ], ], 'MetricType' => [ 'base' => NULL, 'refs' => [ 'ConsolidatedReportMetric$MetricType' => 'The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.
', ], ], 'Milestone' => [ 'base' => 'A milestone return object.
', 'refs' => [ 'GetMilestoneOutput$Milestone' => NULL, ], ], 'MilestoneName' => [ 'base' => 'The name of the milestone in a workload.
Milestone names must be unique within a workload.
', 'refs' => [ 'CreateMilestoneInput$MilestoneName' => NULL, 'Milestone$MilestoneName' => NULL, 'MilestoneSummary$MilestoneName' => NULL, 'UpgradeLensReviewInput$MilestoneName' => NULL, 'UpgradeProfileVersionInput$MilestoneName' => NULL, ], ], 'MilestoneNumber' => [ 'base' => 'The milestone number.
A workload can have a maximum of 100 milestones.
', 'refs' => [ 'CreateMilestoneOutput$MilestoneNumber' => NULL, 'GetAnswerInput$MilestoneNumber' => NULL, 'GetAnswerOutput$MilestoneNumber' => NULL, 'GetLensReviewInput$MilestoneNumber' => NULL, 'GetLensReviewOutput$MilestoneNumber' => NULL, 'GetLensReviewReportInput$MilestoneNumber' => NULL, 'GetLensReviewReportOutput$MilestoneNumber' => NULL, 'GetMilestoneInput$MilestoneNumber' => NULL, 'ListAnswersInput$MilestoneNumber' => NULL, 'ListAnswersOutput$MilestoneNumber' => NULL, 'ListLensReviewImprovementsInput$MilestoneNumber' => NULL, 'ListLensReviewImprovementsOutput$MilestoneNumber' => NULL, 'ListLensReviewsInput$MilestoneNumber' => NULL, 'ListLensReviewsOutput$MilestoneNumber' => NULL, 'Milestone$MilestoneNumber' => NULL, 'MilestoneSummary$MilestoneNumber' => NULL, ], ], 'MilestoneSummaries' => [ 'base' => 'A list of milestone summaries.
', 'refs' => [ 'ListMilestonesOutput$MilestoneSummaries' => NULL, ], ], 'MilestoneSummary' => [ 'base' => 'A milestone summary return object.
', 'refs' => [ 'MilestoneSummaries$member' => NULL, ], ], 'MinSelectedProfileChoices' => [ 'base' => NULL, 'refs' => [ 'ProfileQuestion$MinSelectedChoices' => 'The minimum number of selected choices.
', 'ProfileTemplateQuestion$MinSelectedChoices' => 'The minimum number of choices selected.
', ], ], 'NextToken' => [ 'base' => 'The token to use to retrieve the next set of results.
', 'refs' => [ 'GetConsolidatedReportInput$NextToken' => NULL, 'GetConsolidatedReportOutput$NextToken' => NULL, 'LensReview$NextToken' => NULL, 'ListAnswersInput$NextToken' => NULL, 'ListAnswersOutput$NextToken' => NULL, 'ListCheckDetailsInput$NextToken' => NULL, 'ListCheckDetailsOutput$NextToken' => NULL, 'ListCheckSummariesInput$NextToken' => NULL, 'ListCheckSummariesOutput$NextToken' => NULL, 'ListLensReviewImprovementsInput$NextToken' => NULL, 'ListLensReviewImprovementsOutput$NextToken' => NULL, 'ListLensReviewsInput$NextToken' => NULL, 'ListLensReviewsOutput$NextToken' => NULL, 'ListLensSharesInput$NextToken' => NULL, 'ListLensSharesOutput$NextToken' => NULL, 'ListLensesInput$NextToken' => NULL, 'ListLensesOutput$NextToken' => NULL, 'ListMilestonesInput$NextToken' => NULL, 'ListMilestonesOutput$NextToken' => NULL, 'ListNotificationsInput$NextToken' => NULL, 'ListNotificationsOutput$NextToken' => NULL, 'ListProfileNotificationsInput$NextToken' => NULL, 'ListProfileNotificationsOutput$NextToken' => NULL, 'ListProfileSharesInput$NextToken' => NULL, 'ListProfileSharesOutput$NextToken' => NULL, 'ListProfilesInput$NextToken' => NULL, 'ListProfilesOutput$NextToken' => NULL, 'ListShareInvitationsInput$NextToken' => NULL, 'ListShareInvitationsOutput$NextToken' => NULL, 'ListWorkloadSharesInput$NextToken' => NULL, 'ListWorkloadSharesOutput$NextToken' => NULL, 'ListWorkloadsInput$NextToken' => NULL, 'ListWorkloadsOutput$NextToken' => NULL, ], ], 'Notes' => [ 'base' => 'The notes associated with the workload.
', 'refs' => [ 'Answer$Notes' => NULL, 'CreateWorkloadInput$Notes' => NULL, 'LensReview$Notes' => NULL, 'PillarNotes$value' => NULL, 'PillarReviewSummary$Notes' => NULL, 'UpdateAnswerInput$Notes' => NULL, 'UpdateLensReviewInput$LensNotes' => NULL, 'UpdateWorkloadInput$Notes' => NULL, 'Workload$Notes' => NULL, ], ], 'NotificationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListNotificationsOutput$NotificationSummaries' => 'List of lens notification summaries in a workload.
', ], ], 'NotificationSummary' => [ 'base' => 'A notification summary return object.
', 'refs' => [ 'NotificationSummaries$member' => NULL, ], ], 'NotificationType' => [ 'base' => NULL, 'refs' => [ 'NotificationSummary$Type' => 'The type of notification.
', ], ], 'OrganizationSharingStatus' => [ 'base' => NULL, 'refs' => [ 'UpdateGlobalSettingsInput$OrganizationSharingStatus' => 'The status of organization sharing settings.
', ], ], 'PermissionType' => [ 'base' => 'Permission granted on a share request.
', 'refs' => [ 'CreateWorkloadShareInput$PermissionType' => NULL, 'ShareInvitationSummary$PermissionType' => NULL, 'UpdateWorkloadShareInput$PermissionType' => NULL, 'WorkloadShare$PermissionType' => NULL, 'WorkloadShareSummary$PermissionType' => NULL, ], ], 'PillarDifference' => [ 'base' => 'A pillar difference return object.
', 'refs' => [ 'PillarDifferences$member' => NULL, ], ], 'PillarDifferences' => [ 'base' => NULL, 'refs' => [ 'VersionDifferences$PillarDifferences' => 'The differences between the base and latest versions of the lens.
', ], ], 'PillarId' => [ 'base' => 'The ID used to identify a pillar, for example, security
.
A pillar is identified by its PillarReviewSummary$PillarId.
', 'refs' => [ 'Answer$PillarId' => NULL, 'AnswerSummary$PillarId' => NULL, 'CheckDetail$PillarId' => NULL, 'CheckSummary$PillarId' => NULL, 'ImprovementSummary$PillarId' => NULL, 'ListAnswersInput$PillarId' => NULL, 'ListCheckDetailsInput$PillarId' => NULL, 'ListCheckSummariesInput$PillarId' => NULL, 'ListLensReviewImprovementsInput$PillarId' => NULL, 'PillarDifference$PillarId' => NULL, 'PillarMetric$PillarId' => NULL, 'PillarNotes$key' => NULL, 'PillarReviewSummary$PillarId' => NULL, 'WorkloadPillarPriorities$member' => NULL, ], ], 'PillarMetric' => [ 'base' => 'A metric for a particular pillar in a lens.
', 'refs' => [ 'PillarMetrics$member' => NULL, ], ], 'PillarMetrics' => [ 'base' => NULL, 'refs' => [ 'LensMetric$Pillars' => 'The metrics for the pillars in a lens.
', ], ], 'PillarName' => [ 'base' => 'The name of the pillar.
', 'refs' => [ 'PillarDifference$PillarName' => NULL, 'PillarReviewSummary$PillarName' => NULL, ], ], 'PillarNotes' => [ 'base' => 'List of pillar notes of a lens review in a workload.
', 'refs' => [ 'UpdateLensReviewInput$PillarNotes' => NULL, ], ], 'PillarReviewSummaries' => [ 'base' => 'List of pillar review summaries of lens review in a workload.
', 'refs' => [ 'LensReview$PillarReviewSummaries' => NULL, ], ], 'PillarReviewSummary' => [ 'base' => 'A pillar review summary of a lens review.
', 'refs' => [ 'PillarReviewSummaries$member' => NULL, ], ], 'Profile' => [ 'base' => 'A profile.
', 'refs' => [ 'GetProfileOutput$Profile' => 'The profile.
', 'UpdateProfileOutput$Profile' => 'The profile.
', ], ], 'ProfileArn' => [ 'base' => NULL, 'refs' => [ 'CreateProfileOutput$ProfileArn' => 'The profile ARN.
', 'CreateProfileShareInput$ProfileArn' => 'The profile ARN.
', 'CreateProfileShareOutput$ProfileArn' => 'The profile ARN.
', 'DeleteProfileInput$ProfileArn' => 'The profile ARN.
', 'DeleteProfileShareInput$ProfileArn' => 'The profile ARN.
', 'GetProfileInput$ProfileArn' => 'The profile ARN.
', 'ListProfileSharesInput$ProfileArn' => 'The profile ARN.
', 'Profile$ProfileArn' => 'The profile ARN.
', 'ProfileArns$member' => NULL, 'ProfileNotificationSummary$ProfileArn' => 'The profile ARN.
', 'ProfileSummary$ProfileArn' => 'The profile ARN.
', 'ShareInvitation$ProfileArn' => 'The profile ARN.
', 'ShareInvitationSummary$ProfileArn' => 'The profile ARN.
', 'UpdateProfileInput$ProfileArn' => 'The profile ARN.
', 'UpgradeProfileVersionInput$ProfileArn' => 'The profile ARN.
', 'WorkloadProfile$ProfileArn' => 'The profile ARN.
', 'WorkloadProfileArns$member' => NULL, ], ], 'ProfileArns' => [ 'base' => NULL, 'refs' => [ 'AssociateProfilesInput$ProfileArns' => 'The list of profile ARNs to associate with the workload.
', 'DisassociateProfilesInput$ProfileArns' => 'The list of profile ARNs to disassociate from the workload.
', ], ], 'ProfileChoice' => [ 'base' => 'The profile choice.
', 'refs' => [ 'ProfileQuestionChoices$member' => NULL, ], ], 'ProfileDescription' => [ 'base' => NULL, 'refs' => [ 'CreateProfileInput$ProfileDescription' => 'The profile description.
', 'Profile$ProfileDescription' => 'The profile description.
', 'ProfileSummary$ProfileDescription' => 'The profile description.
', 'UpdateProfileInput$ProfileDescription' => 'The profile description.
', ], ], 'ProfileName' => [ 'base' => NULL, 'refs' => [ 'CreateProfileInput$ProfileName' => 'Name of the profile.
', 'Profile$ProfileName' => 'The profile name.
', 'ProfileNotificationSummary$ProfileName' => 'The profile name.
', 'ProfileSummary$ProfileName' => 'The profile name.
', 'ProfileTemplate$TemplateName' => 'The name of the profile template.
', 'ShareInvitationSummary$ProfileName' => 'The profile name.
', ], ], 'ProfileNamePrefix' => [ 'base' => NULL, 'refs' => [ 'ListProfilesInput$ProfileNamePrefix' => 'Prefix for profile name.
', 'ListShareInvitationsInput$ProfileNamePrefix' => 'Profile name prefix.
', ], ], 'ProfileNotificationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProfileNotificationsOutput$NotificationSummaries' => 'Notification summaries.
', ], ], 'ProfileNotificationSummary' => [ 'base' => 'The profile notification summary.
', 'refs' => [ 'ProfileNotificationSummaries$member' => NULL, ], ], 'ProfileNotificationType' => [ 'base' => NULL, 'refs' => [ 'ProfileNotificationSummary$Type' => 'Type of notification.
', ], ], 'ProfileOwnerType' => [ 'base' => NULL, 'refs' => [ 'ListProfilesInput$ProfileOwnerType' => 'Profile owner type.
', ], ], 'ProfileQuestion' => [ 'base' => 'A profile question.
', 'refs' => [ 'ProfileQuestions$member' => NULL, ], ], 'ProfileQuestionChoices' => [ 'base' => NULL, 'refs' => [ 'ProfileQuestion$QuestionChoices' => 'The question choices.
', ], ], 'ProfileQuestionUpdate' => [ 'base' => 'An update to a profile question.
', 'refs' => [ 'ProfileQuestionUpdates$member' => NULL, ], ], 'ProfileQuestionUpdates' => [ 'base' => NULL, 'refs' => [ 'CreateProfileInput$ProfileQuestions' => 'The profile questions.
', 'UpdateProfileInput$ProfileQuestions' => 'Profile questions.
', ], ], 'ProfileQuestions' => [ 'base' => NULL, 'refs' => [ 'Profile$ProfileQuestions' => 'Profile questions.
', ], ], 'ProfileShareSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProfileSharesOutput$ProfileShareSummaries' => 'Profile share summaries.
', ], ], 'ProfileShareSummary' => [ 'base' => 'Summary of a profile share.
', 'refs' => [ 'ProfileShareSummaries$member' => NULL, ], ], 'ProfileSummaries' => [ 'base' => NULL, 'refs' => [ 'ListProfilesOutput$ProfileSummaries' => 'Profile summaries.
', ], ], 'ProfileSummary' => [ 'base' => 'Summary of a profile.
', 'refs' => [ 'ProfileSummaries$member' => NULL, ], ], 'ProfileTemplate' => [ 'base' => 'The profile template.
', 'refs' => [ 'GetProfileTemplateOutput$ProfileTemplate' => 'The profile template.
', ], ], 'ProfileTemplateChoice' => [ 'base' => 'A profile template choice.
', 'refs' => [ 'ProfileTemplateQuestionChoices$member' => NULL, ], ], 'ProfileTemplateQuestion' => [ 'base' => 'A profile template question.
', 'refs' => [ 'TemplateQuestions$member' => NULL, ], ], 'ProfileTemplateQuestionChoices' => [ 'base' => NULL, 'refs' => [ 'ProfileTemplateQuestion$QuestionChoices' => 'The question choices.
', ], ], 'ProfileVersion' => [ 'base' => NULL, 'refs' => [ 'CreateProfileOutput$ProfileVersion' => 'Version of the profile.
', 'GetProfileInput$ProfileVersion' => 'The profile version.
', 'Profile$ProfileVersion' => 'The profile version.
', 'ProfileNotificationSummary$CurrentProfileVersion' => 'The current profile version.
', 'ProfileNotificationSummary$LatestProfileVersion' => 'The latest profile version.
', 'ProfileSummary$ProfileVersion' => 'The profile version.
', 'WorkloadProfile$ProfileVersion' => 'The profile version.
', ], ], 'QuestionDescription' => [ 'base' => 'The description of the question.
', 'refs' => [ 'Answer$QuestionDescription' => NULL, 'ProfileQuestion$QuestionDescription' => NULL, 'ProfileTemplateQuestion$QuestionDescription' => NULL, ], ], 'QuestionDifference' => [ 'base' => 'A question difference return object.
', 'refs' => [ 'QuestionDifferences$member' => NULL, ], ], 'QuestionDifferences' => [ 'base' => NULL, 'refs' => [ 'PillarDifference$QuestionDifferences' => 'List of question differences.
', ], ], 'QuestionId' => [ 'base' => 'The ID of the question.
', 'refs' => [ 'Answer$QuestionId' => NULL, 'AnswerSummary$QuestionId' => NULL, 'CheckDetail$QuestionId' => NULL, 'CheckSummary$QuestionId' => NULL, 'GetAnswerInput$QuestionId' => NULL, 'ImprovementSummary$QuestionId' => NULL, 'ListCheckDetailsInput$QuestionId' => NULL, 'ListCheckSummariesInput$QuestionId' => NULL, 'ProfileQuestion$QuestionId' => NULL, 'ProfileQuestionUpdate$QuestionId' => NULL, 'ProfileTemplateQuestion$QuestionId' => NULL, 'QuestionDifference$QuestionId' => NULL, 'QuestionMetric$QuestionId' => NULL, 'UpdateAnswerInput$QuestionId' => NULL, ], ], 'QuestionMetric' => [ 'base' => 'A metric for a particular question in the pillar.
', 'refs' => [ 'QuestionMetrics$member' => NULL, ], ], 'QuestionMetrics' => [ 'base' => NULL, 'refs' => [ 'PillarMetric$Questions' => 'The questions that have been identified as risks in the pillar.
', ], ], 'QuestionPriority' => [ 'base' => NULL, 'refs' => [ 'ListAnswersInput$QuestionPriority' => 'The priority of the question.
', 'ListLensReviewImprovementsInput$QuestionPriority' => 'The priority of the question.
', ], ], 'QuestionTitle' => [ 'base' => 'The title of the question.
', 'refs' => [ 'Answer$QuestionTitle' => NULL, 'AnswerSummary$QuestionTitle' => NULL, 'ImprovementSummary$QuestionTitle' => NULL, 'ProfileQuestion$QuestionTitle' => NULL, 'ProfileTemplateQuestion$QuestionTitle' => NULL, 'QuestionDifference$QuestionTitle' => NULL, ], ], 'QuestionType' => [ 'base' => NULL, 'refs' => [ 'AnswerSummary$QuestionType' => 'The type of the question.
', ], ], 'QuotaCode' => [ 'base' => 'Service Quotas requirement to identify originating quota.
', 'refs' => [ 'ServiceQuotaExceededException$QuotaCode' => NULL, 'ThrottlingException$QuotaCode' => NULL, ], ], 'ReportFormat' => [ 'base' => NULL, 'refs' => [ 'GetConsolidatedReportInput$Format' => 'The format of the consolidated report.
For PDF
, Base64String
is returned. For JSON
, Metrics
is returned.
The requested resource was not found.
', 'refs' => [], ], 'Risk' => [ 'base' => 'The risk for a given workload, lens review, pillar, or question.
', 'refs' => [ 'Answer$Risk' => NULL, 'AnswerSummary$Risk' => NULL, 'ImprovementSummary$Risk' => NULL, 'QuestionMetric$Risk' => NULL, 'RiskCounts$key' => NULL, ], ], 'RiskCounts' => [ 'base' => 'A map from risk names to the count of how many questions have that rating.
', 'refs' => [ 'ConsolidatedReportMetric$RiskCounts' => NULL, 'LensMetric$RiskCounts' => NULL, 'LensReview$RiskCounts' => NULL, 'LensReview$PrioritizedRiskCounts' => NULL, 'LensReviewSummary$RiskCounts' => NULL, 'LensReviewSummary$PrioritizedRiskCounts' => NULL, 'PillarMetric$RiskCounts' => NULL, 'PillarReviewSummary$RiskCounts' => NULL, 'PillarReviewSummary$PrioritizedRiskCounts' => NULL, 'Workload$RiskCounts' => NULL, 'Workload$PrioritizedRiskCounts' => NULL, 'WorkloadSummary$RiskCounts' => NULL, 'WorkloadSummary$PrioritizedRiskCounts' => NULL, ], ], 'SelectedChoiceIds' => [ 'base' => NULL, 'refs' => [ 'ProfileQuestion$SelectedChoiceIds' => 'The selected choices.
', ], ], 'SelectedChoices' => [ 'base' => 'List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
', 'refs' => [ 'Answer$SelectedChoices' => NULL, 'AnswerSummary$SelectedChoices' => NULL, 'UpdateAnswerInput$SelectedChoices' => NULL, ], ], 'SelectedProfileChoiceIds' => [ 'base' => NULL, 'refs' => [ 'ProfileQuestionUpdate$SelectedChoiceIds' => 'The selected choices.
', ], ], 'ServiceCode' => [ 'base' => 'Service Quotas requirement to identify originating service.
', 'refs' => [ 'ServiceQuotaExceededException$ServiceCode' => NULL, 'ThrottlingException$ServiceCode' => NULL, ], ], 'ServiceQuotaExceededException' => [ 'base' => 'The user has reached their resource quota.
', 'refs' => [], ], 'ShareId' => [ 'base' => 'The ID associated with the share.
', 'refs' => [ 'CreateLensShareOutput$ShareId' => NULL, 'CreateProfileShareOutput$ShareId' => NULL, 'CreateWorkloadShareOutput$ShareId' => NULL, 'DeleteLensShareInput$ShareId' => NULL, 'DeleteProfileShareInput$ShareId' => NULL, 'DeleteWorkloadShareInput$ShareId' => NULL, 'LensShareSummary$ShareId' => NULL, 'ProfileShareSummary$ShareId' => NULL, 'UpdateWorkloadShareInput$ShareId' => NULL, 'WorkloadShare$ShareId' => NULL, 'WorkloadShareSummary$ShareId' => NULL, ], ], 'ShareInvitation' => [ 'base' => 'The share invitation.
', 'refs' => [ 'UpdateShareInvitationOutput$ShareInvitation' => 'The updated workload or custom lens share invitation.
', ], ], 'ShareInvitationAction' => [ 'base' => 'Share invitation action taken by contributor.
', 'refs' => [ 'UpdateShareInvitationInput$ShareInvitationAction' => NULL, ], ], 'ShareInvitationId' => [ 'base' => NULL, 'refs' => [ 'Lens$ShareInvitationId' => 'The ID assigned to the share invitation.
', 'Profile$ShareInvitationId' => 'The ID assigned to the share invitation.
', 'ShareInvitation$ShareInvitationId' => 'The ID assigned to the share invitation.
', 'ShareInvitationSummary$ShareInvitationId' => 'The ID assigned to the share invitation.
', 'UpdateShareInvitationInput$ShareInvitationId' => 'The ID assigned to the share invitation.
', 'Workload$ShareInvitationId' => 'The ID assigned to the share invitation.
', ], ], 'ShareInvitationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListShareInvitationsOutput$ShareInvitationSummaries' => 'List of share invitation summaries in a workload.
', ], ], 'ShareInvitationSummary' => [ 'base' => 'A share invitation summary return object.
', 'refs' => [ 'ShareInvitationSummaries$member' => NULL, ], ], 'ShareResourceType' => [ 'base' => NULL, 'refs' => [ 'ListShareInvitationsInput$ShareResourceType' => 'The type of share invitations to be returned.
', 'ShareInvitation$ShareResourceType' => 'The resource type of the share invitation.
', 'ShareInvitationSummary$ShareResourceType' => 'The resource type of the share invitation.
', ], ], 'ShareStatus' => [ 'base' => 'The status of the share request.
', 'refs' => [ 'LensShareSummary$Status' => NULL, 'ListLensSharesInput$Status' => NULL, 'ListProfileSharesInput$Status' => NULL, 'ListWorkloadSharesInput$Status' => NULL, 'ProfileShareSummary$Status' => NULL, 'WorkloadShare$Status' => NULL, 'WorkloadShareSummary$Status' => NULL, ], ], 'SharedWith' => [ 'base' => 'The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
', 'refs' => [ 'CreateLensShareInput$SharedWith' => NULL, 'CreateProfileShareInput$SharedWith' => NULL, 'CreateWorkloadShareInput$SharedWith' => NULL, 'LensShareSummary$SharedWith' => NULL, 'ProfileShareSummary$SharedWith' => NULL, 'ShareInvitationSummary$SharedWith' => NULL, 'WorkloadShare$SharedWith' => NULL, 'WorkloadShareSummary$SharedWith' => NULL, ], ], 'SharedWithPrefix' => [ 'base' => NULL, 'refs' => [ 'ListLensSharesInput$SharedWithPrefix' => 'The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.
', 'ListProfileSharesInput$SharedWithPrefix' => 'The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared.
', 'ListWorkloadSharesInput$SharedWithPrefix' => 'The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
', ], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'LensShareSummary$StatusMessage' => 'Optional message to compliment the Status field.
', 'ProfileShareSummary$StatusMessage' => 'Profile share invitation status message.
', 'WorkloadShareSummary$StatusMessage' => 'Optional message to compliment the Status field.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'TagMap$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$TagKeys' => 'A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateProfileInput$Tags' => 'The tags assigned to the profile.
', 'CreateWorkloadInput$Tags' => 'The tags to be associated with the workload.
', 'ImportLensInput$Tags' => 'Tags to associate to a lens.
', 'Lens$Tags' => 'The tags assigned to the lens.
', 'ListTagsForResourceOutput$Tags' => 'The tags for the resource.
', 'Profile$Tags' => 'The tags assigned to the profile.
', 'TagResourceInput$Tags' => 'The tags for the resource.
', 'Workload$Tags' => 'The tags associated with the workload.
', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'TemplateQuestions' => [ 'base' => NULL, 'refs' => [ 'ProfileTemplate$TemplateQuestions' => 'Profile template questions.
', ], ], 'ThrottlingException' => [ 'base' => 'Request was denied due to request throttling.
', 'refs' => [], ], 'Timestamp' => [ 'base' => 'The date and time recorded.
', 'refs' => [ 'CheckDetail$UpdatedAt' => NULL, 'CheckSummary$UpdatedAt' => NULL, 'ConsolidatedReportMetric$UpdatedAt' => NULL, 'LensReview$UpdatedAt' => NULL, 'LensReviewSummary$UpdatedAt' => NULL, 'LensSummary$CreatedAt' => NULL, 'LensSummary$UpdatedAt' => NULL, 'Milestone$RecordedAt' => NULL, 'MilestoneSummary$RecordedAt' => NULL, 'Profile$CreatedAt' => NULL, 'Profile$UpdatedAt' => NULL, 'ProfileSummary$CreatedAt' => NULL, 'ProfileSummary$UpdatedAt' => NULL, 'ProfileTemplate$CreatedAt' => NULL, 'ProfileTemplate$UpdatedAt' => NULL, 'Workload$UpdatedAt' => NULL, 'Workload$ReviewRestrictionDate' => NULL, 'WorkloadSummary$UpdatedAt' => NULL, ], ], 'TrustedAdvisorIntegrationStatus' => [ 'base' => NULL, 'refs' => [ 'WorkloadDiscoveryConfig$TrustedAdvisorIntegrationStatus' => 'Discovery integration status in respect to Trusted Advisor for the workload.
', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAnswerInput' => [ 'base' => 'Input to update answer.
', 'refs' => [], ], 'UpdateAnswerOutput' => [ 'base' => 'Output of a update answer call.
', 'refs' => [], ], 'UpdateGlobalSettingsInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLensReviewInput' => [ 'base' => 'Input for update lens review.
', 'refs' => [], ], 'UpdateLensReviewOutput' => [ 'base' => 'Output of a update lens review call.
', 'refs' => [], ], 'UpdateProfileInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProfileOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateShareInvitationInput' => [ 'base' => 'Input for Update Share Invitation
', 'refs' => [], ], 'UpdateShareInvitationOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWorkloadInput' => [ 'base' => 'Input to update a workload.
', 'refs' => [], ], 'UpdateWorkloadOutput' => [ 'base' => 'Output of an update workload call.
', 'refs' => [], ], 'UpdateWorkloadShareInput' => [ 'base' => 'Input for Update Workload Share
', 'refs' => [], ], 'UpdateWorkloadShareOutput' => [ 'base' => 'Input for Update Workload Share
', 'refs' => [], ], 'UpgradeLensReviewInput' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeProfileVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'Urls' => [ 'base' => NULL, 'refs' => [ 'AdditionalResources$Content' => 'The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
', ], ], 'ValidationException' => [ 'base' => 'The user input is not valid.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'Stores information about a field passed inside a request that resulted in an exception.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => 'The fields that caused the error, if applicable.
', 'refs' => [ 'ValidationException$Fields' => NULL, ], ], 'ValidationExceptionFieldName' => [ 'base' => 'The field name for which validation failed.
', 'refs' => [ 'ValidationExceptionField$Name' => NULL, ], ], 'ValidationExceptionReason' => [ 'base' => 'The reason why the request failed validation.
', 'refs' => [ 'ValidationException$Reason' => NULL, ], ], 'VersionDifferences' => [ 'base' => 'The differences between the base and latest versions of the lens.
', 'refs' => [ 'GetLensVersionDifferenceOutput$VersionDifferences' => NULL, ], ], 'Workload' => [ 'base' => 'A workload return object.
', 'refs' => [ 'GetWorkloadOutput$Workload' => NULL, 'Milestone$Workload' => NULL, 'UpdateWorkloadOutput$Workload' => NULL, ], ], 'WorkloadAccountIds' => [ 'base' => 'The list of Amazon Web Services account IDs associated with the workload.
', 'refs' => [ 'CreateWorkloadInput$AccountIds' => NULL, 'UpdateWorkloadInput$AccountIds' => NULL, 'Workload$AccountIds' => NULL, ], ], 'WorkloadApplications' => [ 'base' => NULL, 'refs' => [ 'CreateWorkloadInput$Applications' => 'List of AppRegistry application ARNs associated to the workload.
', 'UpdateWorkloadInput$Applications' => 'List of AppRegistry application ARNs to associate to the workload.
', 'Workload$Applications' => 'List of AppRegistry application ARNs associated to the workload.
', ], ], 'WorkloadArchitecturalDesign' => [ 'base' => 'The URL of the architectural design for the workload.
', 'refs' => [ 'CreateWorkloadInput$ArchitecturalDesign' => NULL, 'UpdateWorkloadInput$ArchitecturalDesign' => NULL, 'Workload$ArchitecturalDesign' => NULL, ], ], 'WorkloadArn' => [ 'base' => 'The ARN for the workload.
', 'refs' => [ 'ConsolidatedReportMetric$WorkloadArn' => NULL, 'CreateWorkloadOutput$WorkloadArn' => NULL, 'ListTagsForResourceInput$WorkloadArn' => NULL, 'TagResourceInput$WorkloadArn' => NULL, 'UntagResourceInput$WorkloadArn' => NULL, 'Workload$WorkloadArn' => NULL, 'WorkloadSummary$WorkloadArn' => NULL, ], ], 'WorkloadAwsRegions' => [ 'base' => 'The list of Amazon Web Services Regions associated with the workload, for example, us-east-2
, or ca-central-1
.
The description for the workload.
', 'refs' => [ 'CreateWorkloadInput$Description' => NULL, 'UpdateWorkloadInput$Description' => NULL, 'Workload$Description' => NULL, ], ], 'WorkloadDiscoveryConfig' => [ 'base' => 'Discovery configuration associated to the workload.
', 'refs' => [ 'CreateWorkloadInput$DiscoveryConfig' => 'Well-Architected discovery configuration settings associated to the workload.
', 'UpdateWorkloadInput$DiscoveryConfig' => 'Well-Architected discovery configuration settings to associate to the workload.
', 'Workload$DiscoveryConfig' => 'Discovery configuration associated to the workload.
', ], ], 'WorkloadEnvironment' => [ 'base' => 'The environment for the workload.
', 'refs' => [ 'CreateWorkloadInput$Environment' => NULL, 'UpdateWorkloadInput$Environment' => NULL, 'Workload$Environment' => NULL, ], ], 'WorkloadId' => [ 'base' => 'The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
', 'refs' => [ 'AssociateLensesInput$WorkloadId' => NULL, 'AssociateProfilesInput$WorkloadId' => NULL, 'ConsolidatedReportMetric$WorkloadId' => NULL, 'CreateMilestoneInput$WorkloadId' => NULL, 'CreateMilestoneOutput$WorkloadId' => NULL, 'CreateWorkloadOutput$WorkloadId' => NULL, 'CreateWorkloadShareInput$WorkloadId' => NULL, 'CreateWorkloadShareOutput$WorkloadId' => NULL, 'DeleteWorkloadInput$WorkloadId' => NULL, 'DeleteWorkloadShareInput$WorkloadId' => NULL, 'DisassociateLensesInput$WorkloadId' => NULL, 'DisassociateProfilesInput$WorkloadId' => NULL, 'GetAnswerInput$WorkloadId' => NULL, 'GetAnswerOutput$WorkloadId' => NULL, 'GetLensReviewInput$WorkloadId' => NULL, 'GetLensReviewOutput$WorkloadId' => NULL, 'GetLensReviewReportInput$WorkloadId' => NULL, 'GetLensReviewReportOutput$WorkloadId' => NULL, 'GetMilestoneInput$WorkloadId' => NULL, 'GetMilestoneOutput$WorkloadId' => NULL, 'GetWorkloadInput$WorkloadId' => NULL, 'LensUpgradeSummary$WorkloadId' => NULL, 'ListAnswersInput$WorkloadId' => NULL, 'ListAnswersOutput$WorkloadId' => NULL, 'ListCheckDetailsInput$WorkloadId' => NULL, 'ListCheckSummariesInput$WorkloadId' => NULL, 'ListLensReviewImprovementsInput$WorkloadId' => NULL, 'ListLensReviewImprovementsOutput$WorkloadId' => NULL, 'ListLensReviewsInput$WorkloadId' => NULL, 'ListLensReviewsOutput$WorkloadId' => NULL, 'ListMilestonesInput$WorkloadId' => NULL, 'ListMilestonesOutput$WorkloadId' => NULL, 'ListNotificationsInput$WorkloadId' => NULL, 'ListProfileNotificationsInput$WorkloadId' => NULL, 'ListWorkloadSharesInput$WorkloadId' => NULL, 'ListWorkloadSharesOutput$WorkloadId' => NULL, 'ProfileNotificationSummary$WorkloadId' => NULL, 'ShareInvitation$WorkloadId' => NULL, 'ShareInvitationSummary$WorkloadId' => NULL, 'UpdateAnswerInput$WorkloadId' => NULL, 'UpdateAnswerOutput$WorkloadId' => NULL, 'UpdateLensReviewInput$WorkloadId' => NULL, 'UpdateLensReviewOutput$WorkloadId' => NULL, 'UpdateWorkloadInput$WorkloadId' => NULL, 'UpdateWorkloadShareInput$WorkloadId' => NULL, 'UpdateWorkloadShareOutput$WorkloadId' => NULL, 'UpgradeLensReviewInput$WorkloadId' => NULL, 'UpgradeProfileVersionInput$WorkloadId' => NULL, 'Workload$WorkloadId' => NULL, 'WorkloadShare$WorkloadId' => NULL, 'WorkloadSummary$WorkloadId' => NULL, ], ], 'WorkloadImprovementStatus' => [ 'base' => 'The improvement status for a workload.
', 'refs' => [ 'UpdateWorkloadInput$ImprovementStatus' => NULL, 'Workload$ImprovementStatus' => NULL, 'WorkloadSummary$ImprovementStatus' => NULL, ], ], 'WorkloadIndustry' => [ 'base' => 'The industry for the workload.
', 'refs' => [ 'CreateWorkloadInput$Industry' => NULL, 'UpdateWorkloadInput$Industry' => NULL, 'Workload$Industry' => NULL, ], ], 'WorkloadIndustryType' => [ 'base' => '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
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
', 'refs' => [ 'CreateWorkloadInput$Lenses' => NULL, 'Workload$Lenses' => NULL, 'WorkloadSummary$Lenses' => NULL, ], ], 'WorkloadName' => [ 'base' => '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.
', 'refs' => [ 'ConsolidatedReportMetric$WorkloadName' => NULL, 'CreateWorkloadInput$WorkloadName' => NULL, 'LensUpgradeSummary$WorkloadName' => NULL, 'ProfileNotificationSummary$WorkloadName' => NULL, 'ShareInvitationSummary$WorkloadName' => NULL, 'UpdateWorkloadInput$WorkloadName' => NULL, 'Workload$WorkloadName' => NULL, 'WorkloadShare$WorkloadName' => NULL, 'WorkloadSummary$WorkloadName' => NULL, ], ], 'WorkloadNamePrefix' => [ 'base' => 'An optional string added to the beginning of each workload name returned in the results.
', 'refs' => [ 'ListShareInvitationsInput$WorkloadNamePrefix' => NULL, 'ListWorkloadsInput$WorkloadNamePrefix' => NULL, ], ], 'WorkloadNonAwsRegion' => [ 'base' => NULL, 'refs' => [ 'WorkloadNonAwsRegions$member' => NULL, ], ], 'WorkloadNonAwsRegions' => [ 'base' => 'The list of non-Amazon Web Services Regions associated with the workload.
', 'refs' => [ 'CreateWorkloadInput$NonAwsRegions' => NULL, 'UpdateWorkloadInput$NonAwsRegions' => NULL, 'Workload$NonAwsRegions' => NULL, ], ], 'WorkloadPillarPriorities' => [ 'base' => 'The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
', 'refs' => [ 'CreateWorkloadInput$PillarPriorities' => NULL, 'UpdateWorkloadInput$PillarPriorities' => NULL, 'Workload$PillarPriorities' => NULL, ], ], 'WorkloadProfile' => [ 'base' => 'The profile associated with a workload.
', 'refs' => [ 'WorkloadProfiles$member' => NULL, ], ], 'WorkloadProfileArns' => [ 'base' => NULL, 'refs' => [ 'CreateWorkloadInput$ProfileArns' => 'The list of profile ARNs associated with the workload.
', ], ], 'WorkloadProfiles' => [ 'base' => NULL, 'refs' => [ 'LensReview$Profiles' => 'The profiles associated with the workload.
', 'LensReviewSummary$Profiles' => 'The profiles associated with the workload.
', 'Workload$Profiles' => 'Profile associated with a workload.
', 'WorkloadSummary$Profiles' => 'Profile associated with a workload.
', ], ], 'WorkloadResourceDefinition' => [ 'base' => NULL, 'refs' => [ 'WorkloadDiscoveryConfig$WorkloadResourceDefinition' => 'The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA
, APP_REGISTRY
, or both.
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
', 'refs' => [ 'CreateWorkloadInput$ReviewOwner' => NULL, 'UpdateWorkloadInput$ReviewOwner' => NULL, 'Workload$ReviewOwner' => NULL, ], ], 'WorkloadShare' => [ 'base' => 'A workload share return object.
', 'refs' => [ 'UpdateWorkloadShareOutput$WorkloadShare' => NULL, ], ], 'WorkloadShareSummaries' => [ 'base' => 'A list of workload share summaries.
', 'refs' => [ 'ListWorkloadSharesOutput$WorkloadShareSummaries' => NULL, ], ], 'WorkloadShareSummary' => [ 'base' => 'A workload share summary return object.
', 'refs' => [ 'WorkloadShareSummaries$member' => NULL, ], ], 'WorkloadSummaries' => [ 'base' => 'A list of workload summaries.
', 'refs' => [ 'ListWorkloadsOutput$WorkloadSummaries' => NULL, ], ], 'WorkloadSummary' => [ 'base' => 'A workload summary return object.
', 'refs' => [ 'MilestoneSummary$WorkloadSummary' => NULL, 'WorkloadSummaries$member' => NULL, ], ], ],];