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.
- CreateMilestone ( array $params = [] )
Create a milestone for an existing workload.
- CreateWorkload ( array $params = [] )
Create a new workload.
- CreateWorkloadShare ( array $params = [] )
Create a workload share.
- DeleteWorkload ( array $params = [] )
Delete an existing workload.
- DeleteWorkloadShare ( array $params = [] )
Delete a workload share.
- DisassociateLenses ( array $params = [] )
Disassociate a lens from a workload.
- GetAnswer ( array $params = [] )
Get lens review.
- 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.
- ListAnswers ( array $params = [] )
List of answers.
- ListLensReviewImprovements ( array $params = [] )
List lens review improvements.
- ListLensReviews ( array $params = [] )
List lens reviews.
- 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.
- ListWorkloadShares ( array $params = [] )
List the workload shares associated with the workload.
- ListWorkloads ( array $params = [] )
List workloads.
- UpdateAnswer ( array $params = [] )
Update the answer.
- 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.
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.
Identify a lens using its LensSummary$LensAlias.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an AWS 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 AWS 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS 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 AWS 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 AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the AWS 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
'WorkloadName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AccountIds
-
- Type: Array of strings
The list of AWS 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 AWS 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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-AWS 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.
- WorkloadName
-
- Required: Yes
- Type: string
The name of the workload.
The name must be unique within an account within a 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 AWS 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 AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.
For more information, see Sharing a Workload in the AWS 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS 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 AWS 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 AWS 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.
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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS 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 AWS 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS Region.
Result Syntax
[]
Result Details
Errors
-
The user input is not valid.
-
There is a problem with the AWS 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.
The AWS 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.
Identify a lens using its LensSummary$LensAlias.
- WorkloadId
-
- Required: Yes
- Type: string
The ID assigned to the workload. This ID is unique within an AWS 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 AWS 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 lens 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 AWS Region.
Result Syntax
[
'Answer' => [
'Choices' => [
[
'ChoiceId' => '<string>',
'Description' => '<string>',
'Title' => '<string>',
],
// ...
],
'HelpfulResourceUrl' => '<string>',
'ImprovementPlanUrl' => '<string>',
'IsApplicable' => true || false,
'Notes' => '<string>',
'PillarId' => '<string>',
'QuestionDescription' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
'SelectedChoices' => ['<string>', ...],
],
'LensAlias' => '<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.
- 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 AWS Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the AWS 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 AWS Region.
Result Syntax
[
'LensReview' => [
'LensAlias' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED',
'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 AWS Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the AWS 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 AWS Region.
Result Syntax
[
'LensReviewReport' => [
'Base64String' => '<string>',
'LensAlias' => '<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 AWS Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the AWS 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>', // REQUIRED
'LensAlias' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BaseLensVersion
-
- Required: Yes
- 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.
Result Syntax
[
'BaseLensVersion' => '<string>',
'LatestLensVersion' => '<string>',
'LensAlias' => '<string>',
'VersionDifferences' => [
'PillarDifferences' => [
[
'DifferenceStatus' => 'UPDATED|NEW|DELETED',
'PillarId' => '<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.
- 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 AWS 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>',
'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 AWS Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
There is a problem with the AWS 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>',
'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 AWS 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 AWS Region.
Result Syntax
[
'AnswerSummaries' => [
[
'Choices' => [
[
'ChoiceId' => '<string>',
'Description' => '<string>',
'Title' => '<string>',
],
// ...
],
'IsApplicable' => true || false,
'PillarId' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
'SelectedChoices' => ['<string>', ...],
],
// ...
],
'LensAlias' => '<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.
- 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 AWS Region.
Errors
-
The user input is not valid.
-
There is a problem with the AWS 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 AWS Region.
Result Syntax
[
'ImprovementSummaries' => [
[
'ImprovementPlanUrl' => '<string>',
'PillarId' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
],
// ...
],
'LensAlias' => '<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.
- 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 AWS Region.
Errors
-
The user input is not valid.
-
There is a problem with the AWS 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 AWS Region.
Result Syntax
[
'LensReviewSummaries' => [
[
'LensAlias' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED',
'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 AWS Region.
Errors
-
The user input is not valid.
-
There is a problem with the AWS 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([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'LensSummaries' => [
[
'Description' => '<string>',
'LensAlias' => '<string>',
'LensName' => '<string>',
'LensVersion' => '<string>',
],
// ...
],
'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 AWS 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 AWS Region.
Errors
-
The user input is not valid.
-
There is a problem with the AWS 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>',
'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 AWS 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([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'WorkloadNamePrefix' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'ShareInvitationSummaries' => [
[
'PermissionType' => 'READONLY|CONTRIBUTOR',
'ShareInvitationId' => '<string>',
'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 AWS Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
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 AWS 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 AWS 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 AWS 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 AWS 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 AWS Well-Architected Tool API service.
-
User does not have sufficient access to perform this action.
-
Request was denied due to request throttling.
UpdateAnswer
$result = $client->updateAnswer([/* ... */]); $promise = $client->updateAnswerAsync([/* ... */]);
Update the answer.
Parameter Syntax
$result = $client->updateAnswer([
'IsApplicable' => true || false,
'LensAlias' => '<string>', // REQUIRED
'Notes' => '<string>',
'QuestionId' => '<string>', // REQUIRED
'SelectedChoices' => ['<string>', ...],
'WorkloadId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- 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.
- 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 AWS Region.
Result Syntax
[
'Answer' => [
'Choices' => [
[
'ChoiceId' => '<string>',
'Description' => '<string>',
'Title' => '<string>',
],
// ...
],
'HelpfulResourceUrl' => '<string>',
'ImprovementPlanUrl' => '<string>',
'IsApplicable' => true || false,
'Notes' => '<string>',
'PillarId' => '<string>',
'QuestionDescription' => '<string>',
'QuestionId' => '<string>',
'QuestionTitle' => '<string>',
'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
'SelectedChoices' => ['<string>', ...],
],
'LensAlias' => '<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.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an AWS Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the AWS 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 AWS Region.
Result Syntax
[
'LensReview' => [
'LensAlias' => '<string>',
'LensName' => '<string>',
'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED',
'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 AWS Region.
Errors
-
The user input is not valid.
-
The requested resource was not found.
-
The resource already exists.
-
There is a problem with the AWS 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' => [
'ShareInvitationId' => '<string>',
'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 AWS 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 AWS 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 AWS 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-AWS 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 AWS Region.
- WorkloadName
-
- Type: string
The name of the workload.
The name must be unique within an account within a 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>',
'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 AWS 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 AWS Region.
- WorkloadShare
-
- Type: WorkloadShare structure
A workload share return object.
Errors
-
The user input is not valid.
-
There is a problem with the AWS 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS 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 AWS 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 AWS 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
- Choices
-
- Type: Array of Choice structures
List of choices available for a question.
- HelpfulResourceUrl
-
- Type: string
The helpful resource URL for a question.
- ImprovementPlanUrl
-
- Type: string
The improvement plan URL for a question.
- 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.
- 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
- 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.
- 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
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.
- 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 AWS Well-Architected Tool API service.
Members
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.
- 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.
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.
- 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.
LensSummary
Description
A lens summary of a lens.
Members
- 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.
- LensName
-
- Type: string
The full name of the lens.
- LensVersion
-
- Type: string
The version of the lens.
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.
- WorkloadId
-
- Type: string
The ID assigned to the workload. This ID is unique within an AWS Region.
- WorkloadName
-
- Type: string
The name of the workload.
The name must be unique within an account within a 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.
- 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
ShareInvitationSummary
Description
A share invitation summary return object.
Members
- PermissionType
-
- Type: string
Permission granted on a workload share.
- ShareInvitationId
-
- Type: string
The ID assigned to the share invitation.
- SharedBy
-
- Type: string
An AWS account ID.
- SharedWith
-
- Type: string
The AWS 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 AWS Region.
- WorkloadName
-
- Type: string
The name of the workload.
The name must be unique within an account within a 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 AWS 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 AWS 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-AWS Regions associated with the workload.
- Notes
-
- Type: string
The notes associated with the workload.
- Owner
-
- Type: string
An AWS 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.
- 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 AWS Region.
- WorkloadName
-
- Type: string
The name of the workload.
The name must be unique within an account within a 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 AWS account ID.
- SharedWith
-
- Type: string
The AWS 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 AWS Region.
- WorkloadName
-
- Type: string
The name of the workload.
The name must be unique within an account within a 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 AWS 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 AWS Region.
- WorkloadName
-
- Type: string
The name of the workload.
The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.