AWS Well-Architected Tool 2020-03-31
- Client: Aws\WellArchitected\WellArchitectedClient
- Service ID: wellarchitected
- Version: 2020-03-31
This page describes the parameters and results for the operations of the AWS Well-Architected Tool (2020-03-31), and shows how to use the Aws\WellArchitected\WellArchitectedClient object to call the described operations. This documentation is specific to the 2020-03-31 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateLenses ( array $params = [] )
Associate a lens to a workload.
- CreateLensShare ( array $params = [] )
Create a lens share.
- CreateLensVersion ( array $params = [] )
Create a new lens version.
- CreateMilestone ( array $params = [] )
Create a milestone for an existing workload.
- CreateWorkload ( array $params = [] )
Create a new workload.
- CreateWorkloadShare ( array $params = [] )
Create a workload share.
- DeleteLens ( array $params = [] )
Delete an existing lens.
- DeleteLensShare ( array $params = [] )
Delete a lens share.
- DeleteWorkload ( array $params = [] )
Delete an existing workload.
- DeleteWorkloadShare ( array $params = [] )
Delete a workload share.
- DisassociateLenses ( array $params = [] )
Disassociate a lens from a workload.
- ExportLens ( array $params = [] )
Export an existing lens.
- GetAnswer ( array $params = [] )
Get the answer to a specific question in a workload review.
- GetLens ( array $params = [] )
Get an existing lens.
- GetLensReview ( array $params = [] )
Get lens review.
- GetLensReviewReport ( array $params = [] )
Get lens review report.
- GetLensVersionDifference ( array $params = [] )
Get lens version differences.
- GetMilestone ( array $params = [] )
Get a milestone for an existing workload.
- GetWorkload ( array $params = [] )
Get an existing workload.
- ImportLens ( array $params = [] )
Import a new lens.
- ListAnswers ( array $params = [] )
List of answers.
- ListLensReviewImprovements ( array $params = [] )
List lens review improvements.
- ListLensReviews ( array $params = [] )
List lens reviews.
- ListLensShares ( array $params = [] )
List the lens shares associated with the lens.
- ListLenses ( array $params = [] )
List the available lenses.
- ListMilestones ( array $params = [] )
List all milestones for an existing workload.
- ListNotifications ( array $params = [] )
List lens notifications.
- ListShareInvitations ( array $params = [] )
List the workload invitations.
- ListTagsForResource ( array $params = [] )
List the tags for a resource.
- ListWorkloadShares ( array $params = [] )
List the workload shares associated with the workload.
- ListWorkloads ( array $params = [] )
List workloads.
- TagResource ( array $params = [] )
Adds one or more tags to the specified resource.
- UntagResource ( array $params = [] )
Deletes specified tags from a resource.
- UpdateAnswer ( array $params = [] )
Update the answer to a specific question in a workload review.
- UpdateLensReview ( array $params = [] )
Update lens review.
- UpdateShareInvitation ( array $params = [] )
Update a workload invitation.
- UpdateWorkload ( array $params = [] )
Update an existing workload.
- UpdateWorkloadShare ( array $params = [] )
Update a workload share.
- UpgradeLensReview ( array $params = [] )
Upgrade lens review.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateLenses
$result = $client->associateLenses([/* ... */]); $promise = $client->associateLensesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateLenses([
'LensAliases' => ['<string>', ...], // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAliases
-
- Required: Yes
- Type: Array of strings
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.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
CreateLensShare
$result = $client->createLensShare([/* ... */]); $promise = $client->createLensShareAsync([/* ... */]);
Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.
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.
Parameter Syntax
$result = $client->createLensShare([
'ClientRequestToken' => '<string>', // REQUIRED
'LensAlias' => '<string>', // REQUIRED
'SharedWith' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- SharedWith
-
- Required: Yes
- Type: string
The Amazon Web Services account ID or IAM role with which the workload is shared.
Result Syntax
[
'ShareId' => '<string>',
]
Result Details
Errors
-
The user input is not valid.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
ServiceQuotaExceededException:
The user has reached their resource quota.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
CreateLensVersion
$result = $client->createLensVersion([/* ... */]); $promise = $client->createLensVersionAsync([/* ... */]);
Create a new lens version.
A lens can have up to 100 versions.
After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
Parameter Syntax
$result = $client->createLensVersion([
'ClientRequestToken' => '<string>', // REQUIRED
'IsMajorVersion' => true || false,
'LensAlias' => '<string>', // REQUIRED
'LensVersion' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- IsMajorVersion
-
- Type: boolean
Set to true if this new major lens version.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensVersion
-
- Required: Yes
- Type: string
The version of the lens being created.
Result Syntax
[
'LensArn' => '<string>',
'LensVersion' => '<string>',
]
Result Details
Members
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
ServiceQuotaExceededException:
The user has reached their resource quota.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
CreateMilestone
$result = $client->createMilestone([/* ... */]); $promise = $client->createMilestoneAsync([/* ... */]);
Create a milestone for an existing workload.
Parameter Syntax
$result = $client->createMilestone([
'ClientRequestToken' => '<string>', // REQUIRED
'MilestoneName' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- MilestoneName
-
- Required: Yes
- Type: string
The name of the milestone in a workload.
Milestone names must be unique within a workload.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'MilestoneNumber' => <integer>,
'WorkloadId' => '<string>',
]
Result Details
Members
Errors
-
The user input is not valid.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
ServiceQuotaExceededException:
The user has reached their resource quota.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
CreateWorkload
$result = $client->createWorkload([/* ... */]); $promise = $client->createWorkloadAsync([/* ... */]);
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts and IAM users 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.
Parameter Syntax
$result = $client->createWorkload([
'AccountIds' => ['<string>', ...],
'ArchitecturalDesign' => '<string>',
'AwsRegions' => ['<string>', ...],
'ClientRequestToken' => '<string>', // REQUIRED
'Description' => '<string>', // REQUIRED
'Environment' => 'PRODUCTION|PREPRODUCTION', // REQUIRED
'Industry' => '<string>',
'IndustryType' => '<string>',
'Lenses' => ['<string>', ...], // REQUIRED
'NonAwsRegions' => ['<string>', ...],
'Notes' => '<string>',
'PillarPriorities' => ['<string>', ...],
'ReviewOwner' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
'WorkloadName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AccountIds
-
- Type: Array of strings
The list of Amazon Web Services account IDs associated with the workload.
- ArchitecturalDesign
-
- Type: string
The URL of the architectural design for the workload.
- AwsRegions
-
- Type: Array of strings
The list of Amazon Web Services Regions associated with the workload, for example,
us-east-2, orca-central-1. - ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- Description
-
- Required: Yes
- Type: string
The description for the workload.
- Environment
-
- Required: Yes
- Type: string
The environment for the workload.
- Industry
-
- Type: string
The industry for the workload.
- IndustryType
-
- Type: string
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
- Lenses
-
- Required: Yes
- Type: Array of strings
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
- NonAwsRegions
-
- Type: Array of strings
The list of non-Amazon Web Services Regions associated with the workload.
- Notes
-
- Type: string
The notes associated with the workload.
- PillarPriorities
-
- Type: Array of strings
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
- ReviewOwner
-
- Required: Yes
- Type: string
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to be associated with the workload.
- WorkloadName
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'WorkloadArn' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
Errors
-
The user input is not valid.
-
The resource already exists.
-
ServiceQuotaExceededException:
The user has reached their resource quota.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
CreateWorkloadShare
$result = $client->createWorkloadShare([/* ... */]); $promise = $client->createWorkloadShareAsync([/* ... */]);
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
For more information, see Sharing a Workload in the Well-Architected Tool User Guide.
Parameter Syntax
$result = $client->createWorkloadShare([
'ClientRequestToken' => '<string>', // REQUIRED
'PermissionType' => 'READONLY|CONTRIBUTOR', // REQUIRED
'SharedWith' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- PermissionType
-
- Required: Yes
- Type: string
Permission granted on a workload share.
- SharedWith
-
- Required: Yes
- Type: string
The Amazon Web Services account ID or IAM role with which the workload is shared.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'ShareId' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
Errors
-
The user input is not valid.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
ServiceQuotaExceededException:
The user has reached their resource quota.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
DeleteLens
$result = $client->deleteLens([/* ... */]); $promise = $client->deleteLensAsync([/* ... */]);
Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM 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.
Parameter Syntax
$result = $client->deleteLens([
'ClientRequestToken' => '<string>', // REQUIRED
'LensAlias' => '<string>', // REQUIRED
'LensStatus' => 'ALL|DRAFT|PUBLISHED', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensStatus
-
- Required: Yes
- Type: string
The status of the lens to be deleted.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
DeleteLensShare
$result = $client->deleteLensShare([/* ... */]); $promise = $client->deleteLensShareAsync([/* ... */]);
Delete a lens share.
After the lens share is deleted, Amazon Web Services accounts and IAM 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.
Parameter Syntax
$result = $client->deleteLensShare([
'ClientRequestToken' => '<string>', // REQUIRED
'LensAlias' => '<string>', // REQUIRED
'ShareId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- ShareId
-
- Required: Yes
- Type: string
The ID associated with the workload share.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
The resource already exists.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
DeleteWorkload
$result = $client->deleteWorkload([/* ... */]); $promise = $client->deleteWorkloadAsync([/* ... */]);
Delete an existing workload.
Parameter Syntax
$result = $client->deleteWorkload([
'ClientRequestToken' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
DeleteWorkloadShare
$result = $client->deleteWorkloadShare([/* ... */]); $promise = $client->deleteWorkloadShareAsync([/* ... */]);
Delete a workload share.
Parameter Syntax
$result = $client->deleteWorkloadShare([
'ClientRequestToken' => '<string>', // REQUIRED
'ShareId' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- ShareId
-
- Required: Yes
- Type: string
The ID associated with the workload share.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
The resource already exists.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
DisassociateLenses
$result = $client->disassociateLenses([/* ... */]); $promise = $client->disassociateLensesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateLenses([
'LensAliases' => ['<string>', ...], // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAliases
-
- Required: Yes
- Type: Array of strings
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.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ExportLens
$result = $client->exportLens([/* ... */]); $promise = $client->exportLensAsync([/* ... */]);
Export an existing lens.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it.
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.
Parameter Syntax
$result = $client->exportLens([
'LensAlias' => '<string>', // REQUIRED
'LensVersion' => '<string>',
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensVersion
-
- Type: string
The lens version to be exported.
Result Syntax
[
'LensJSON' => '<string>',
]
Result Details
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetAnswer
$result = $client->getAnswer([/* ... */]); $promise = $client->getAnswerAsync([/* ... */]);
Get the answer to a specific question in a workload review.
Parameter Syntax
$result = $client->getAnswer([
'LensAlias' => '<string>', // REQUIRED
'MilestoneNumber' => <integer>,
'QuestionId' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- QuestionId
-
- Required: Yes
- Type: string
The ID of the question.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'Answer' => [
'ChoiceAnswers' => [
[
'ChoiceId' => '<string>',
'Notes' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
],
// ...
],
'Choices' => [
[
'ChoiceId' => '<string>',
'Description' => '<string>',
'HelpfulResource' => [
'DisplayText' => '<string>',
'Url' => '<string>',
],
'ImprovementPlan' => [
'DisplayText' => '<string>',
'Url' => '<string>',
],
'Title' => '<string>',
],
// ...
],
'HelpfulResourceDisplayText' => '<string>',
'HelpfulResourceUrl' => '<string>',
'ImprovementPlanUrl' => '<string>',
'IsApplicable' => true || false,
'Notes' => '<string>',
'PillarId' => '<string>',
'QuestionDescription' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
'SelectedChoices' => ['<string>', ...],
],
'LensAlias' => '<string>',
'LensArn' => '<string>',
'MilestoneNumber' => <integer>,
'WorkloadId' => '<string>',
]
Result Details
Members
- Answer
-
- Type: Answer structure
An answer of the question.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetLens
$result = $client->getLens([/* ... */]); $promise = $client->getLensAsync([/* ... */]);
Get an existing lens.
Parameter Syntax
$result = $client->getLens([
'LensAlias' => '<string>', // REQUIRED
'LensVersion' => '<string>',
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensVersion
-
- Type: string
The lens version to be retrieved.
Result Syntax
[
'Lens' => [
'Description' => '<string>',
'LensArn' => '<string>',
'LensVersion' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ShareInvitationId' => '<string>',
],
]
Result Details
Members
- Lens
-
- Type: Lens structure
A lens return object.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetLensReview
$result = $client->getLensReview([/* ... */]); $promise = $client->getLensReviewAsync([/* ... */]);
Get lens review.
Parameter Syntax
$result = $client->getLensReview([
'LensAlias' => '<string>', // REQUIRED
'MilestoneNumber' => <integer>,
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'LensReview' => [
'LensAlias' => '<string>',
'LensArn' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
'LensVersion' => '<string>',
'NextToken' => '<string>',
'Notes' => '<string>',
'PillarReviewSummaries' => [
[
'Notes' => '<string>',
'PillarId' => '<string>',
'PillarName' => '<string>',
'RiskCounts' => [<integer>, ...],
],
// ...
],
'RiskCounts' => [<integer>, ...],
'UpdatedAt' => <DateTime>,
],
'MilestoneNumber' => <integer>,
'WorkloadId' => '<string>',
]
Result Details
Members
- LensReview
-
- Type: LensReview structure
A lens review of a question.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetLensReviewReport
$result = $client->getLensReviewReport([/* ... */]); $promise = $client->getLensReviewReportAsync([/* ... */]);
Get lens review report.
Parameter Syntax
$result = $client->getLensReviewReport([
'LensAlias' => '<string>', // REQUIRED
'MilestoneNumber' => <integer>,
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'LensReviewReport' => [
'Base64String' => '<string>',
'LensAlias' => '<string>',
'LensArn' => '<string>',
],
'MilestoneNumber' => <integer>,
'WorkloadId' => '<string>',
]
Result Details
Members
- LensReviewReport
-
- Type: LensReviewReport structure
A report of a lens review.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetLensVersionDifference
$result = $client->getLensVersionDifference([/* ... */]); $promise = $client->getLensVersionDifferenceAsync([/* ... */]);
Get lens version differences.
Parameter Syntax
$result = $client->getLensVersionDifference([
'BaseLensVersion' => '<string>',
'LensAlias' => '<string>', // REQUIRED
'TargetLensVersion' => '<string>',
]);
Parameter Details
Members
- BaseLensVersion
-
- Type: string
The base version of the lens.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- TargetLensVersion
-
- Type: string
The lens version to target a difference for.
Result Syntax
[
'BaseLensVersion' => '<string>',
'LatestLensVersion' => '<string>',
'LensAlias' => '<string>',
'LensArn' => '<string>',
'TargetLensVersion' => '<string>',
'VersionDifferences' => [
'PillarDifferences' => [
[
'DifferenceStatus' => 'UPDATED|NEW|DELETED',
'PillarId' => '<string>',
'PillarName' => '<string>',
'QuestionDifferences' => [
[
'DifferenceStatus' => 'UPDATED|NEW|DELETED',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
],
// ...
],
],
// ...
],
],
]
Result Details
Members
- BaseLensVersion
-
- Type: string
The base version of the lens.
- LatestLensVersion
-
- Type: string
The latest version of the lens.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- TargetLensVersion
-
- Type: string
The target lens version for the lens.
- VersionDifferences
-
- Type: VersionDifferences structure
The differences between the base and latest versions of the lens.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetMilestone
$result = $client->getMilestone([/* ... */]); $promise = $client->getMilestoneAsync([/* ... */]);
Get a milestone for an existing workload.
Parameter Syntax
$result = $client->getMilestone([
'MilestoneNumber' => <integer>, // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Milestone' => [
'MilestoneName' => '<string>',
'MilestoneNumber' => <integer>,
'RecordedAt' => <DateTime>,
'Workload' => [
'AccountIds' => ['<string>', ...],
'ArchitecturalDesign' => '<string>',
'AwsRegions' => ['<string>', ...],
'Description' => '<string>',
'Environment' => 'PRODUCTION|PREPRODUCTION',
'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
'Industry' => '<string>',
'IndustryType' => '<string>',
'IsReviewOwnerUpdateAcknowledged' => true || false,
'Lenses' => ['<string>', ...],
'NonAwsRegions' => ['<string>', ...],
'Notes' => '<string>',
'Owner' => '<string>',
'PillarPriorities' => ['<string>', ...],
'ReviewOwner' => '<string>',
'ReviewRestrictionDate' => <DateTime>,
'RiskCounts' => [<integer>, ...],
'ShareInvitationId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
'WorkloadArn' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
],
'WorkloadId' => '<string>',
]
Result Details
Members
- Milestone
-
- Type: Milestone structure
A milestone return object.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
GetWorkload
$result = $client->getWorkload([/* ... */]); $promise = $client->getWorkloadAsync([/* ... */]);
Get an existing workload.
Parameter Syntax
$result = $client->getWorkload([
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Workload' => [
'AccountIds' => ['<string>', ...],
'ArchitecturalDesign' => '<string>',
'AwsRegions' => ['<string>', ...],
'Description' => '<string>',
'Environment' => 'PRODUCTION|PREPRODUCTION',
'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
'Industry' => '<string>',
'IndustryType' => '<string>',
'IsReviewOwnerUpdateAcknowledged' => true || false,
'Lenses' => ['<string>', ...],
'NonAwsRegions' => ['<string>', ...],
'Notes' => '<string>',
'Owner' => '<string>',
'PillarPriorities' => ['<string>', ...],
'ReviewOwner' => '<string>',
'ReviewRestrictionDate' => <DateTime>,
'RiskCounts' => [<integer>, ...],
'ShareInvitationId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
'WorkloadArn' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
]
Result Details
Members
- Workload
-
- Type: Workload structure
A workload return object.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ImportLens
$result = $client->importLens([/* ... */]); $promise = $client->importLensAsync([/* ... */]);
Import a new lens.
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.
Parameter Syntax
$result = $client->importLens([
'ClientRequestToken' => '<string>', // REQUIRED
'JSONString' => '<string>', // REQUIRED
'LensAlias' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClientRequestToken
-
- Required: Yes
- Type: string
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 it 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.
- JSONString
-
- Required: Yes
- Type: string
The JSON representation of a lens.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags to associate to a lens.
Result Syntax
[
'LensArn' => '<string>',
'Status' => 'IN_PROGRESS|COMPLETE|ERROR',
]
Result Details
Members
Errors
-
The user input is not valid.
-
The resource already exists.
-
The requested resource was not found.
-
ServiceQuotaExceededException:
The user has reached their resource quota.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListAnswers
$result = $client->listAnswers([/* ... */]); $promise = $client->listAnswersAsync([/* ... */]);
List of answers.
Parameter Syntax
$result = $client->listAnswers([
'LensAlias' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'MilestoneNumber' => <integer>,
'NextToken' => '<string>',
'PillarId' => '<string>',
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'AnswerSummaries' => [
[
'ChoiceAnswerSummaries' => [
[
'ChoiceId' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
],
// ...
],
'Choices' => [
[
'ChoiceId' => '<string>',
'Description' => '<string>',
'HelpfulResource' => [
'DisplayText' => '<string>',
'Url' => '<string>',
],
'ImprovementPlan' => [
'DisplayText' => '<string>',
'Url' => '<string>',
],
'Title' => '<string>',
],
// ...
],
'IsApplicable' => true || false,
'PillarId' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
'SelectedChoices' => ['<string>', ...],
],
// ...
],
'LensAlias' => '<string>',
'LensArn' => '<string>',
'MilestoneNumber' => <integer>,
'NextToken' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
- AnswerSummaries
-
- Type: Array of AnswerSummary structures
List of answer summaries of lens review in a workload.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListLensReviewImprovements
$result = $client->listLensReviewImprovements([/* ... */]); $promise = $client->listLensReviewImprovementsAsync([/* ... */]);
List lens review improvements.
Parameter Syntax
$result = $client->listLensReviewImprovements([
'LensAlias' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'MilestoneNumber' => <integer>,
'NextToken' => '<string>',
'PillarId' => '<string>',
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'ImprovementSummaries' => [
[
'ImprovementPlanUrl' => '<string>',
'ImprovementPlans' => [
[
'ChoiceId' => '<string>',
'DisplayText' => '<string>',
'ImprovementPlanUrl' => '<string>',
],
// ...
],
'PillarId' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
],
// ...
],
'LensAlias' => '<string>',
'LensArn' => '<string>',
'MilestoneNumber' => <integer>,
'NextToken' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
- ImprovementSummaries
-
- Type: Array of ImprovementSummary structures
List of improvement summaries of lens review in a workload.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListLensReviews
$result = $client->listLensReviews([/* ... */]); $promise = $client->listLensReviewsAsync([/* ... */]);
List lens reviews.
Parameter Syntax
$result = $client->listLensReviews([
'MaxResults' => <integer>,
'MilestoneNumber' => <integer>,
'NextToken' => '<string>',
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'LensReviewSummaries' => [
[
'LensAlias' => '<string>',
'LensArn' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
'LensVersion' => '<string>',
'RiskCounts' => [<integer>, ...],
'UpdatedAt' => <DateTime>,
],
// ...
],
'MilestoneNumber' => <integer>,
'NextToken' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
- LensReviewSummaries
-
- Type: Array of LensReviewSummary structures
List of lens summaries of lens reviews of a workload.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListLensShares
$result = $client->listLensShares([/* ... */]); $promise = $client->listLensSharesAsync([/* ... */]);
List the lens shares associated with the lens.
Parameter Syntax
$result = $client->listLensShares([
'LensAlias' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SharedWithPrefix' => '<string>',
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- SharedWithPrefix
-
- Type: string
The Amazon Web Services account ID or IAM role with which the lens is shared.
Result Syntax
[
'LensShareSummaries' => [
[
'ShareId' => '<string>',
'SharedWith' => '<string>',
'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LensShareSummaries
-
- Type: Array of LensShareSummary structures
A list of lens share summaries.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListLenses
$result = $client->listLenses([/* ... */]); $promise = $client->listLensesAsync([/* ... */]);
List the available lenses.
Parameter Syntax
$result = $client->listLenses([
'LensName' => '<string>',
'LensStatus' => 'ALL|DRAFT|PUBLISHED',
'LensType' => 'AWS_OFFICIAL|CUSTOM_SHARED|CUSTOM_SELF',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- LensName
-
- Type: string
The full name of the lens.
- LensStatus
-
- Type: string
The status of lenses to be returned.
- LensType
-
- Type: string
The type of lenses to be returned.
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
Result Syntax
[
'LensSummaries' => [
[
'CreatedAt' => <DateTime>,
'Description' => '<string>',
'LensAlias' => '<string>',
'LensArn' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
'LensType' => 'AWS_OFFICIAL|CUSTOM_SHARED|CUSTOM_SELF',
'LensVersion' => '<string>',
'Owner' => '<string>',
'UpdatedAt' => <DateTime>,
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LensSummaries
-
- Type: Array of LensSummary structures
List of lens summaries of available lenses.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListMilestones
$result = $client->listMilestones([/* ... */]); $promise = $client->listMilestonesAsync([/* ... */]);
List all milestones for an existing workload.
Parameter Syntax
$result = $client->listMilestones([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'MilestoneSummaries' => [
[
'MilestoneName' => '<string>',
'MilestoneNumber' => <integer>,
'RecordedAt' => <DateTime>,
'WorkloadSummary' => [
'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
'Lenses' => ['<string>', ...],
'Owner' => '<string>',
'RiskCounts' => [<integer>, ...],
'UpdatedAt' => <DateTime>,
'WorkloadArn' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
],
// ...
],
'NextToken' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
- MilestoneSummaries
-
- Type: Array of MilestoneSummary structures
A list of milestone summaries.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListNotifications
$result = $client->listNotifications([/* ... */]); $promise = $client->listNotificationsAsync([/* ... */]);
List lens notifications.
Parameter Syntax
$result = $client->listNotifications([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'WorkloadId' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'NotificationSummaries' => [
[
'LensUpgradeSummary' => [
'CurrentLensVersion' => '<string>',
'LatestLensVersion' => '<string>',
'LensAlias' => '<string>',
'LensArn' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
'Type' => 'LENS_VERSION_UPGRADED|LENS_VERSION_DEPRECATED',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- NotificationSummaries
-
- Type: Array of NotificationSummary structures
List of lens notification summaries in a workload.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListShareInvitations
$result = $client->listShareInvitations([/* ... */]); $promise = $client->listShareInvitationsAsync([/* ... */]);
List the workload invitations.
Parameter Syntax
$result = $client->listShareInvitations([
'LensNamePrefix' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ShareResourceType' => 'WORKLOAD|LENS',
'WorkloadNamePrefix' => '<string>',
]);
Parameter Details
Members
- LensNamePrefix
-
- Type: string
An optional string added to the beginning of each lens name returned in the results.
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- ShareResourceType
-
- Type: string
The type of share invitations to be returned.
- WorkloadNamePrefix
-
- Type: string
An optional string added to the beginning of each workload name returned in the results.
Result Syntax
[
'NextToken' => '<string>',
'ShareInvitationSummaries' => [
[
'LensArn' => '<string>',
'LensName' => '<string>',
'PermissionType' => 'READONLY|CONTRIBUTOR',
'ShareInvitationId' => '<string>',
'ShareResourceType' => 'WORKLOAD|LENS',
'SharedBy' => '<string>',
'SharedWith' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- ShareInvitationSummaries
-
- Type: Array of ShareInvitationSummary structures
List of share invitation summaries in a workload.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
List the tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'WorkloadArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
ListWorkloadShares
$result = $client->listWorkloadShares([/* ... */]); $promise = $client->listWorkloadSharesAsync([/* ... */]);
List the workload shares associated with the workload.
Parameter Syntax
$result = $client->listWorkloadShares([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'SharedWithPrefix' => '<string>',
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return for this request.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- SharedWithPrefix
-
- Type: string
The Amazon Web Services account ID or IAM role with which the workload is shared.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'NextToken' => '<string>',
'WorkloadId' => '<string>',
'WorkloadShareSummaries' => [
[
'PermissionType' => 'READONLY|CONTRIBUTOR',
'ShareId' => '<string>',
'SharedWith' => '<string>',
'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadShareSummaries
-
- Type: Array of WorkloadShareSummary structures
A list of workload share summaries.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
ListWorkloads
$result = $client->listWorkloads([/* ... */]); $promise = $client->listWorkloadsAsync([/* ... */]);
List workloads. Paginated.
Parameter Syntax
$result = $client->listWorkloads([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'WorkloadNamePrefix' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'WorkloadSummaries' => [
[
'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
'Lenses' => ['<string>', ...],
'Owner' => '<string>',
'RiskCounts' => [<integer>, ...],
'UpdatedAt' => <DateTime>,
'WorkloadArn' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- WorkloadSummaries
-
- Type: Array of WorkloadSummary structures
A list of workload summaries.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds one or more tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([
'Tags' => ['<string>', ...], // REQUIRED
'WorkloadArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Deletes specified tags from a resource.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
Parameter Syntax
$result = $client->untagResource([
'TagKeys' => ['<string>', ...], // REQUIRED
'WorkloadArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
UpdateAnswer
$result = $client->updateAnswer([/* ... */]); $promise = $client->updateAnswerAsync([/* ... */]);
Update the answer to a specific question in a workload review.
Parameter Syntax
$result = $client->updateAnswer([
'ChoiceUpdates' => [
'<ChoiceId>' => [
'Notes' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED', // REQUIRED
],
// ...
],
'IsApplicable' => true || false,
'LensAlias' => '<string>', // REQUIRED
'Notes' => '<string>',
'QuestionId' => '<string>', // REQUIRED
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'SelectedChoices' => ['<string>', ...],
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ChoiceUpdates
-
- Type: Associative array of custom strings keys (ChoiceId) to ChoiceUpdate structures
A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
- IsApplicable
-
- Type: boolean
Defines whether this question is applicable to a lens review.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- Notes
-
- Type: string
The notes associated with the workload.
- QuestionId
-
- Required: Yes
- Type: string
The ID of the question.
- Reason
-
- Type: string
The reason why a question is not applicable to your workload.
- SelectedChoices
-
- Type: Array of strings
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'Answer' => [
'ChoiceAnswers' => [
[
'ChoiceId' => '<string>',
'Notes' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
],
// ...
],
'Choices' => [
[
'ChoiceId' => '<string>',
'Description' => '<string>',
'HelpfulResource' => [
'DisplayText' => '<string>',
'Url' => '<string>',
],
'ImprovementPlan' => [
'DisplayText' => '<string>',
'Url' => '<string>',
],
'Title' => '<string>',
],
// ...
],
'HelpfulResourceDisplayText' => '<string>',
'HelpfulResourceUrl' => '<string>',
'ImprovementPlanUrl' => '<string>',
'IsApplicable' => true || false,
'Notes' => '<string>',
'PillarId' => '<string>',
'QuestionDescription' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
'SelectedChoices' => ['<string>', ...],
],
'LensAlias' => '<string>',
'LensArn' => '<string>',
'WorkloadId' => '<string>',
]
Result Details
Members
- Answer
-
- Type: Answer structure
An answer of the question.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
UpdateLensReview
$result = $client->updateLensReview([/* ... */]); $promise = $client->updateLensReviewAsync([/* ... */]);
Update lens review.
Parameter Syntax
$result = $client->updateLensReview([
'LensAlias' => '<string>', // REQUIRED
'LensNotes' => '<string>',
'PillarNotes' => ['<string>', ...],
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensNotes
-
- Type: string
The notes associated with the workload.
- PillarNotes
-
- Type: Associative array of custom strings keys (PillarId) to strings
List of pillar notes of a lens review in a workload.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[
'LensReview' => [
'LensAlias' => '<string>',
'LensArn' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
'LensVersion' => '<string>',
'NextToken' => '<string>',
'Notes' => '<string>',
'PillarReviewSummaries' => [
[
'Notes' => '<string>',
'PillarId' => '<string>',
'PillarName' => '<string>',
'RiskCounts' => [<integer>, ...],
],
// ...
],
'RiskCounts' => [<integer>, ...],
'UpdatedAt' => <DateTime>,
],
'WorkloadId' => '<string>',
]
Result Details
Members
- LensReview
-
- Type: LensReview structure
A lens review of a question.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
UpdateShareInvitation
$result = $client->updateShareInvitation([/* ... */]); $promise = $client->updateShareInvitationAsync([/* ... */]);
Update a workload invitation.
Parameter Syntax
$result = $client->updateShareInvitation([
'ShareInvitationAction' => 'ACCEPT|REJECT', // REQUIRED
'ShareInvitationId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ShareInvitation' => [
'LensAlias' => '<string>',
'LensArn' => '<string>',
'ShareInvitationId' => '<string>',
'ShareResourceType' => 'WORKLOAD|LENS',
'WorkloadId' => '<string>',
],
]
Result Details
Members
- ShareInvitation
-
- Type: ShareInvitation structure
The updated workload share invitation.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
The resource already exists.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
UpdateWorkload
$result = $client->updateWorkload([/* ... */]); $promise = $client->updateWorkloadAsync([/* ... */]);
Update an existing workload.
Parameter Syntax
$result = $client->updateWorkload([
'AccountIds' => ['<string>', ...],
'ArchitecturalDesign' => '<string>',
'AwsRegions' => ['<string>', ...],
'Description' => '<string>',
'Environment' => 'PRODUCTION|PREPRODUCTION',
'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
'Industry' => '<string>',
'IndustryType' => '<string>',
'IsReviewOwnerUpdateAcknowledged' => true || false,
'NonAwsRegions' => ['<string>', ...],
'Notes' => '<string>',
'PillarPriorities' => ['<string>', ...],
'ReviewOwner' => '<string>',
'WorkloadId' => '<string>', // REQUIRED
'WorkloadName' => '<string>',
]);
Parameter Details
Members
- AccountIds
-
- Type: Array of strings
The list of Amazon Web Services account IDs associated with the workload.
- ArchitecturalDesign
-
- Type: string
The URL of the architectural design for the workload.
- AwsRegions
-
- Type: Array of strings
The list of Amazon Web Services Regions associated with the workload, for example,
us-east-2, orca-central-1. - Description
-
- Type: string
The description for the workload.
- Environment
-
- Type: string
The environment for the workload.
- ImprovementStatus
-
- Type: string
The improvement status for a workload.
- Industry
-
- Type: string
The industry for the workload.
- IndustryType
-
- Type: string
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
- IsReviewOwnerUpdateAcknowledged
-
- Type: boolean
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.
- NonAwsRegions
-
- Type: Array of strings
The list of non-Amazon Web Services Regions associated with the workload.
- Notes
-
- Type: string
The notes associated with the workload.
- PillarPriorities
-
- Type: Array of strings
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
- ReviewOwner
-
- Type: string
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadName
-
- Type: string
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.
Result Syntax
[
'Workload' => [
'AccountIds' => ['<string>', ...],
'ArchitecturalDesign' => '<string>',
'AwsRegions' => ['<string>', ...],
'Description' => '<string>',
'Environment' => 'PRODUCTION|PREPRODUCTION',
'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
'Industry' => '<string>',
'IndustryType' => '<string>',
'IsReviewOwnerUpdateAcknowledged' => true || false,
'Lenses' => ['<string>', ...],
'NonAwsRegions' => ['<string>', ...],
'Notes' => '<string>',
'Owner' => '<string>',
'PillarPriorities' => ['<string>', ...],
'ReviewOwner' => '<string>',
'ReviewRestrictionDate' => <DateTime>,
'RiskCounts' => [<integer>, ...],
'ShareInvitationId' => '<string>',
'Tags' => ['<string>', ...],
'UpdatedAt' => <DateTime>,
'WorkloadArn' => '<string>',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
]
Result Details
Members
- Workload
-
- Type: Workload structure
A workload return object.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
UpdateWorkloadShare
$result = $client->updateWorkloadShare([/* ... */]); $promise = $client->updateWorkloadShareAsync([/* ... */]);
Update a workload share.
Parameter Syntax
$result = $client->updateWorkloadShare([
'PermissionType' => 'READONLY|CONTRIBUTOR', // REQUIRED
'ShareId' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'WorkloadId' => '<string>',
'WorkloadShare' => [
'PermissionType' => 'READONLY|CONTRIBUTOR',
'ShareId' => '<string>',
'SharedBy' => '<string>',
'SharedWith' => '<string>',
'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED',
'WorkloadId' => '<string>',
'WorkloadName' => '<string>',
],
]
Result Details
Members
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadShare
-
- Type: WorkloadShare structure
A workload share return object.
Errors
-
The user input is not valid.
-
There is a problem with the Well-Architected Tool API service.
-
The requested resource was not found.
-
The resource already exists.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
UpgradeLensReview
$result = $client->upgradeLensReview([/* ... */]); $promise = $client->upgradeLensReviewAsync([/* ... */]);
Upgrade lens review.
Parameter Syntax
$result = $client->upgradeLensReview([
'ClientRequestToken' => '<string>',
'LensAlias' => '<string>', // REQUIRED
'MilestoneName' => '<string>', // REQUIRED
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ClientRequestToken
-
- Type: string
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 it 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.
- LensAlias
-
- Required: Yes
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- MilestoneName
-
- Required: Yes
- Type: string
The name of the milestone in a workload.
Milestone names must be unique within a workload.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
Shapes
AccessDeniedException
Description
User does not have sufficient access to perform this action.
Members
Answer
Description
An answer of the question.
Members
- ChoiceAnswers
-
- Type: Array of ChoiceAnswer structures
A list of selected choices to a question in your workload.
- Choices
-
- Type: Array of Choice structures
List of choices available for a question.
- HelpfulResourceDisplayText
-
- Type: string
The helpful resource text to be displayed.
- HelpfulResourceUrl
-
- Type: string
The helpful resource URL for a question.
- ImprovementPlanUrl
-
- Type: string
The improvement plan URL for a question.
This value is only available if the question has been answered.
- IsApplicable
-
- Type: boolean
Defines whether this question is applicable to a lens review.
- Notes
-
- Type: string
The notes associated with the workload.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- QuestionDescription
-
- Type: string
The description of the question.
- QuestionId
-
- Type: string
The ID of the question.
- QuestionTitle
-
- Type: string
The title of the question.
- Reason
-
- Type: string
The reason why the question is not applicable to your workload.
- Risk
-
- Type: string
The risk for a given workload, lens review, pillar, or question.
- SelectedChoices
-
- Type: Array of strings
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
AnswerSummary
Description
An answer summary of a lens review in a workload.
Members
- ChoiceAnswerSummaries
-
- Type: Array of ChoiceAnswerSummary structures
A list of selected choices to a question in your workload.
- Choices
-
- Type: Array of Choice structures
List of choices available for a question.
- IsApplicable
-
- Type: boolean
Defines whether this question is applicable to a lens review.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- QuestionId
-
- Type: string
The ID of the question.
- QuestionTitle
-
- Type: string
The title of the question.
- Reason
-
- Type: string
The reason why a choice is non-applicable to a question in your workload.
- Risk
-
- Type: string
The risk for a given workload, lens review, pillar, or question.
- SelectedChoices
-
- Type: Array of strings
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
Choice
Description
A choice available to answer question.
Members
- ChoiceId
-
- Type: string
The ID of a choice.
- Description
-
- Type: string
The description of a choice.
- HelpfulResource
-
- Type: ChoiceContent structure
The choice level helpful resource.
- ImprovementPlan
-
- Type: ChoiceContent structure
The choice level improvement plan.
- Title
-
- Type: string
The title of a choice.
ChoiceAnswer
Description
A choice that has been answered on a question in your workload.
Members
ChoiceAnswerSummary
Description
A choice summary that has been answered on a question in your workload.
Members
ChoiceContent
Description
The choice content.
Members
ChoiceImprovementPlan
Description
The choice level improvement plan.
Members
ChoiceUpdate
Description
A list of choices to be updated.
Members
ConflictException
Description
The resource already exists.
Members
ImprovementSummary
Description
An improvement summary of a lens review in a workload.
Members
- ImprovementPlanUrl
-
- Type: string
The improvement plan URL for a question.
This value is only available if the question has been answered.
- ImprovementPlans
-
- Type: Array of ChoiceImprovementPlan structures
The improvement plan details.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- QuestionId
-
- Type: string
The ID of the question.
- QuestionTitle
-
- Type: string
The title of the question.
- Risk
-
- Type: string
The risk for a given workload, lens review, pillar, or question.
InternalServerException
Description
There is a problem with the Well-Architected Tool API service.
Members
Lens
Description
A lens return object.
Members
- Description
-
- Type: string
The description of the lens.
- LensArn
-
- Type: string
The ARN of a lens.
- LensVersion
-
- Type: string
The version of a lens.
- Name
-
- Type: string
The full name of the lens.
- Owner
-
- Type: string
The Amazon Web Services account ID that owns the lens.
- ShareInvitationId
-
- Type: string
The ID assigned to the share invitation.
LensReview
Description
A lens review of a question.
Members
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- LensName
-
- Type: string
The full name of the lens.
- LensStatus
-
- Type: string
The status of the lens.
- LensVersion
-
- Type: string
The version of the lens.
- NextToken
-
- Type: string
The token to use to retrieve the next set of results.
- Notes
-
- Type: string
The notes associated with the workload.
- PillarReviewSummaries
-
- Type: Array of PillarReviewSummary structures
List of pillar review summaries of lens review in a workload.
- RiskCounts
-
- Type: Associative array of custom strings keys (Risk) to ints
A map from risk names to the count of how questions have that rating.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
LensReviewReport
Description
A report of a lens review.
Members
- Base64String
-
- Type: string
The Base64-encoded string representation of a lens review report.
This data can be used to create a PDF file.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
LensReviewSummary
Description
A lens review summary of a workload.
Members
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- LensName
-
- Type: string
The full name of the lens.
- LensStatus
-
- Type: string
The status of the lens.
- LensVersion
-
- Type: string
The version of the lens.
- RiskCounts
-
- Type: Associative array of custom strings keys (Risk) to ints
A map from risk names to the count of how questions have that rating.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
LensShareSummary
Description
A lens share summary return object.
Members
LensSummary
Description
A lens summary of a lens.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
- Description
-
- Type: string
The description of the lens.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN of the lens.
- LensName
-
- Type: string
The full name of the lens.
- LensStatus
-
- Type: string
The status of the lens.
- LensType
-
- Type: string
The type of the lens.
- LensVersion
-
- Type: string
The version of the lens.
- Owner
-
- Type: string
An Amazon Web Services account ID.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
LensUpgradeSummary
Description
Lens upgrade summary return object.
Members
- CurrentLensVersion
-
- Type: string
The current version of the lens.
- LatestLensVersion
-
- Type: string
The latest version of the lens.
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadName
-
- Type: string
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.
Milestone
Description
A milestone return object.
Members
- MilestoneName
-
- Type: string
The name of the milestone in a workload.
Milestone names must be unique within a workload.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- RecordedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
- Workload
-
- Type: Workload structure
A workload return object.
MilestoneSummary
Description
A milestone summary return object.
Members
- MilestoneName
-
- Type: string
The name of the milestone in a workload.
Milestone names must be unique within a workload.
- MilestoneNumber
-
- Type: int
The milestone number.
A workload can have a maximum of 100 milestones.
- RecordedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
- WorkloadSummary
-
- Type: WorkloadSummary structure
A workload summary return object.
NotificationSummary
Description
A notification summary return object.
Members
- LensUpgradeSummary
-
- Type: LensUpgradeSummary structure
Summary of lens upgrade.
- Type
-
- Type: string
The type of notification.
PillarDifference
Description
A pillar difference return object.
Members
- DifferenceStatus
-
- Type: string
Indicates the type of change to the pillar.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- PillarName
-
- Type: string
The name of the pillar.
- QuestionDifferences
-
- Type: Array of QuestionDifference structures
List of question differences.
PillarReviewSummary
Description
A pillar review summary of a lens review.
Members
- Notes
-
- Type: string
The notes associated with the workload.
- PillarId
-
- Type: string
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary$PillarId.
- PillarName
-
- Type: string
The name of the pillar.
- RiskCounts
-
- Type: Associative array of custom strings keys (Risk) to ints
A map from risk names to the count of how questions have that rating.
QuestionDifference
Description
A question difference return object.
Members
ResourceNotFoundException
Description
The requested resource was not found.
Members
ServiceQuotaExceededException
Description
The user has reached their resource quota.
Members
- Message
-
- Required: Yes
- Type: string
Description of the error.
- QuotaCode
-
- Required: Yes
- Type: string
Service Quotas requirement to identify originating quota.
- ResourceId
-
- Type: string
Identifier of the resource affected.
- ResourceType
-
- Type: string
Type of the resource affected.
- ServiceCode
-
- Required: Yes
- Type: string
Service Quotas requirement to identify originating service.
ShareInvitation
Description
The share invitation.
Members
- LensAlias
-
- Type: string
The alias of the lens, for example,
serverless.Each lens is identified by its LensSummary$LensAlias.
- LensArn
-
- Type: string
The ARN for the lens.
- ShareInvitationId
-
- Type: string
The ID assigned to the share invitation.
- ShareResourceType
-
- Type: string
The resource type of the share invitation.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
ShareInvitationSummary
Description
A share invitation summary return object.
Members
- LensArn
-
- Type: string
The ARN for the lens.
- LensName
-
- Type: string
The full name of the lens.
- PermissionType
-
- Type: string
Permission granted on a workload share.
- ShareInvitationId
-
- Type: string
The ID assigned to the share invitation.
- ShareResourceType
-
- Type: string
The resource type of the share invitation.
- SharedBy
-
- Type: string
An Amazon Web Services account ID.
- SharedWith
-
- Type: string
The Amazon Web Services account ID or IAM role with which the workload is shared.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadName
-
- Type: string
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.
ThrottlingException
Description
Request was denied due to request throttling.
Members
ValidationException
Description
The user input is not valid.
Members
- Fields
-
- Type: Array of ValidationExceptionField structures
The fields that caused the error, if applicable.
- Message
-
- Required: Yes
- Type: string
Description of the error.
- Reason
-
- Type: string
The reason why the request failed validation.
ValidationExceptionField
Description
Stores information about a field passed inside a request that resulted in an exception.
Members
VersionDifferences
Description
The differences between the base and latest versions of the lens.
Members
- PillarDifferences
-
- Type: Array of PillarDifference structures
The differences between the base and latest versions of the lens.
Workload
Description
A workload return object.
Members
- AccountIds
-
- Type: Array of strings
The list of Amazon Web Services account IDs associated with the workload.
- ArchitecturalDesign
-
- Type: string
The URL of the architectural design for the workload.
- AwsRegions
-
- Type: Array of strings
The list of Amazon Web Services Regions associated with the workload, for example,
us-east-2, orca-central-1. - Description
-
- Type: string
The description for the workload.
- Environment
-
- Type: string
The environment for the workload.
- ImprovementStatus
-
- Type: string
The improvement status for a workload.
- Industry
-
- Type: string
The industry for the workload.
- IndustryType
-
- Type: string
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
- IsReviewOwnerUpdateAcknowledged
-
- Type: boolean
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.
- Lenses
-
- Type: Array of strings
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
- NonAwsRegions
-
- Type: Array of strings
The list of non-Amazon Web Services Regions associated with the workload.
- Notes
-
- Type: string
The notes associated with the workload.
- Owner
-
- Type: string
An Amazon Web Services account ID.
- PillarPriorities
-
- Type: Array of strings
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
- ReviewOwner
-
- Type: string
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
- ReviewRestrictionDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
- RiskCounts
-
- Type: Associative array of custom strings keys (Risk) to ints
A map from risk names to the count of how questions have that rating.
- ShareInvitationId
-
- Type: string
The ID assigned to the share invitation.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags associated with the workload.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
- WorkloadArn
-
- Type: string
The ARN for the workload.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadName
-
- Type: string
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.
WorkloadShare
Description
A workload share return object.
Members
- PermissionType
-
- Type: string
Permission granted on a workload share.
- ShareId
-
- Type: string
The ID associated with the workload share.
- SharedBy
-
- Type: string
An Amazon Web Services account ID.
- SharedWith
-
- Type: string
The Amazon Web Services account ID or IAM role with which the workload is shared.
- Status
-
- Type: string
The status of a workload share.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadName
-
- Type: string
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.
WorkloadShareSummary
Description
A workload share summary return object.
Members
WorkloadSummary
Description
A workload summary return object.
Members
- ImprovementStatus
-
- Type: string
The improvement status for a workload.
- Lenses
-
- Type: Array of strings
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
- Owner
-
- Type: string
An Amazon Web Services account ID.
- RiskCounts
-
- Type: Associative array of custom strings keys (Risk) to ints
A map from risk names to the count of how questions have that rating.
- UpdatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time recorded.
- WorkloadArn
-
- Type: string
The ARN for the workload.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- WorkloadName
-
- Type: string
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.