ListLensReviewImprovements
List the improvements of a particular lens review.
Request Syntax
GET /workloads/WorkloadId/lensReviews/LensAlias/improvements?MaxResults=MaxResults&MilestoneNumber=MilestoneNumber&NextToken=NextToken&PillarId=PillarId&QuestionPriority=QuestionPriority HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- LensAlias
-
The alias of the lens.
For AWS official lenses, this is either the lens alias, such as
serverless, or the lens ARN, such asarn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses.For custom lenses, this is the lens ARN, such as
arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.Each lens is identified by its LensSummary:LensAlias.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- MaxResults
-
The maximum number of results to return for this request.
Valid Range: Minimum value of 1. Maximum value of 100.
- MilestoneNumber
-
The milestone number.
A workload can have a maximum of 100 milestones.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token to use to retrieve the next set of results.
- PillarId
-
The ID used to identify a pillar, for example,
security.A pillar is identified by its PillarReviewSummary:PillarId.
Length Constraints: Minimum length of 1. Maximum length of 64.
- QuestionPriority
-
The priority of the question.
Valid Values:
PRIORITIZED | NONE - WorkloadId
-
The ID assigned to the workload. This ID is unique within an AWS Region.
Length Constraints: Fixed length of 32.
Pattern:
[0-9a-f]{32}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ImprovementSummaries": [
{
"ImprovementPlans": [
{
"ChoiceId": "string",
"DisplayText": "string",
"ImprovementPlanUrl": "string"
}
],
"ImprovementPlanUrl": "string",
"JiraConfiguration": {
"JiraIssueUrl": "string",
"LastSyncedTime": number
},
"PillarId": "string",
"QuestionId": "string",
"QuestionTitle": "string",
"Risk": "string"
}
],
"LensAlias": "string",
"LensArn": "string",
"MilestoneNumber": number,
"NextToken": "string",
"WorkloadId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ImprovementSummaries
-
List of improvement summaries of lens review in a workload.
Type: Array of ImprovementSummary objects
- LensAlias
-
The alias of the lens.
For AWS official lenses, this is either the lens alias, such as
serverless, or the lens ARN, such asarn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses.For custom lenses, this is the lens ARN, such as
arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.Each lens is identified by its LensSummary:LensAlias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- LensArn
-
The ARN for the lens.
Type: String
- MilestoneNumber
-
The milestone number.
A workload can have a maximum of 100 milestones.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token to use to retrieve the next set of results.
Type: String
- WorkloadId
-
The ID assigned to the workload. This ID is unique within an AWS Region.
Type: String
Length Constraints: Fixed length of 32.
Pattern:
[0-9a-f]{32}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
There is a problem with the AWS Well-Architected Tool API service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The user input is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
