Skip to content

Commit f4b5ea5

Browse files
author
AWS
committed
AWS Well-Architected Tool Update: This update provides support for Well-Architected API users to mark answer choices as not applicable.
1 parent 6322d03 commit f4b5ea5

File tree

2 files changed

+135
-7
lines changed

2 files changed

+135
-7
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Well-Architected Tool",
4+
"contributor": "",
5+
"description": "This update provides support for Well-Architected API users to mark answer choices as not applicable."
6+
}

services/wellarchitected/src/main/resources/codegen-resources/service-2.json

Lines changed: 129 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@
152152
{"shape":"AccessDeniedException"},
153153
{"shape":"ThrottlingException"}
154154
],
155-
"documentation":"<p>Get lens review.</p>"
155+
"documentation":"<p>Get the answer to a specific question in a workload review.</p>"
156156
},
157157
"GetLensReview":{
158158
"name":"GetLensReview",
@@ -428,7 +428,7 @@
428428
{"shape":"InternalServerException"},
429429
{"shape":"ResourceNotFoundException"}
430430
],
431-
"documentation":"<p>Deletes specified tags from a resource.</p>"
431+
"documentation":"<p>Deletes specified tags from a resource.</p> <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p> <p> <code>DELETE /tags/WorkloadArn?tagKeys=key1&amp;tagKeys=key2</code> </p>"
432432
},
433433
"UpdateAnswer":{
434434
"name":"UpdateAnswer",
@@ -560,12 +560,30 @@
560560
"HelpfulResourceUrl":{"shape":"HelpfulResourceUrl"},
561561
"Choices":{"shape":"Choices"},
562562
"SelectedChoices":{"shape":"SelectedChoices"},
563+
"ChoiceAnswers":{
564+
"shape":"ChoiceAnswers",
565+
"documentation":"<p>A list of selected choices to a question in your workload.</p>"
566+
},
563567
"IsApplicable":{"shape":"IsApplicable"},
564568
"Risk":{"shape":"Risk"},
565-
"Notes":{"shape":"Notes"}
569+
"Notes":{"shape":"Notes"},
570+
"Reason":{
571+
"shape":"AnswerReason",
572+
"documentation":"<p>The reason why the question is not applicable to your workload.</p>"
573+
}
566574
},
567575
"documentation":"<p>An answer of the question.</p>"
568576
},
577+
"AnswerReason":{
578+
"type":"string",
579+
"enum":[
580+
"OUT_OF_SCOPE",
581+
"BUSINESS_PRIORITIES",
582+
"ARCHITECTURE_CONSTRAINTS",
583+
"OTHER",
584+
"NONE"
585+
]
586+
},
569587
"AnswerSummaries":{
570588
"type":"list",
571589
"member":{"shape":"AnswerSummary"},
@@ -579,8 +597,16 @@
579597
"QuestionTitle":{"shape":"QuestionTitle"},
580598
"Choices":{"shape":"Choices"},
581599
"SelectedChoices":{"shape":"SelectedChoices"},
600+
"ChoiceAnswerSummaries":{
601+
"shape":"ChoiceAnswerSummaries",
602+
"documentation":"<p>A list of selected choices to a question in your workload.</p>"
603+
},
582604
"IsApplicable":{"shape":"IsApplicable"},
583-
"Risk":{"shape":"Risk"}
605+
"Risk":{"shape":"Risk"},
606+
"Reason":{
607+
"shape":"AnswerReason",
608+
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
609+
}
584610
},
585611
"documentation":"<p>An answer summary of a lens review in a workload.</p>"
586612
},
@@ -623,6 +649,48 @@
623649
},
624650
"documentation":"<p>A choice available to answer question.</p>"
625651
},
652+
"ChoiceAnswer":{
653+
"type":"structure",
654+
"members":{
655+
"ChoiceId":{"shape":"ChoiceId"},
656+
"Status":{
657+
"shape":"ChoiceStatus",
658+
"documentation":"<p>The status of a choice.</p>"
659+
},
660+
"Reason":{
661+
"shape":"ChoiceReason",
662+
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
663+
},
664+
"Notes":{
665+
"shape":"ChoiceNotes",
666+
"documentation":"<p>The notes associated with a choice.</p>"
667+
}
668+
},
669+
"documentation":"<p>A choice that has been answered on a question in your workload.</p>"
670+
},
671+
"ChoiceAnswerSummaries":{
672+
"type":"list",
673+
"member":{"shape":"ChoiceAnswerSummary"}
674+
},
675+
"ChoiceAnswerSummary":{
676+
"type":"structure",
677+
"members":{
678+
"ChoiceId":{"shape":"ChoiceId"},
679+
"Status":{
680+
"shape":"ChoiceStatus",
681+
"documentation":"<p>The status of a choice.</p>"
682+
},
683+
"Reason":{
684+
"shape":"ChoiceReason",
685+
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
686+
}
687+
},
688+
"documentation":"<p>A choice summary that has been answered on a question in your workload.</p>"
689+
},
690+
"ChoiceAnswers":{
691+
"type":"list",
692+
"member":{"shape":"ChoiceAnswer"}
693+
},
626694
"ChoiceDescription":{
627695
"type":"string",
628696
"documentation":"<p>The description of a choice.</p>",
@@ -635,12 +703,58 @@
635703
"max":64,
636704
"min":1
637705
},
706+
"ChoiceNotes":{
707+
"type":"string",
708+
"max":250
709+
},
710+
"ChoiceReason":{
711+
"type":"string",
712+
"enum":[
713+
"OUT_OF_SCOPE",
714+
"BUSINESS_PRIORITIES",
715+
"ARCHITECTURE_CONSTRAINTS",
716+
"OTHER",
717+
"NONE"
718+
]
719+
},
720+
"ChoiceStatus":{
721+
"type":"string",
722+
"enum":[
723+
"SELECTED",
724+
"NOT_APPLICABLE",
725+
"UNSELECTED"
726+
]
727+
},
638728
"ChoiceTitle":{
639729
"type":"string",
640730
"documentation":"<p>The title of a choice.</p>",
641731
"max":512,
642732
"min":1
643733
},
734+
"ChoiceUpdate":{
735+
"type":"structure",
736+
"required":["Status"],
737+
"members":{
738+
"Status":{
739+
"shape":"ChoiceStatus",
740+
"documentation":"<p>The status of a choice.</p>"
741+
},
742+
"Reason":{
743+
"shape":"ChoiceReason",
744+
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
745+
},
746+
"Notes":{
747+
"shape":"ChoiceNotes",
748+
"documentation":"<p>The notes associated with a choice.</p>"
749+
}
750+
},
751+
"documentation":"<p>A list of choices to be updated.</p>"
752+
},
753+
"ChoiceUpdates":{
754+
"type":"map",
755+
"key":{"shape":"ChoiceId"},
756+
"value":{"shape":"ChoiceUpdate"}
757+
},
644758
"Choices":{
645759
"type":"list",
646760
"member":{"shape":"Choice"},
@@ -1057,7 +1171,7 @@
10571171
},
10581172
"ImprovementPlanUrl":{
10591173
"type":"string",
1060-
"documentation":"<p>The improvement plan URL for a question.</p>",
1174+
"documentation":"<p>The improvement plan URL for a question.</p> <p>This value is only available if the question has been answered.</p>",
10611175
"max":2048,
10621176
"min":1
10631177
},
@@ -1946,7 +2060,7 @@
19462060
},
19472061
"TagKeys":{
19482062
"shape":"TagKeyList",
1949-
"documentation":"<p>The keys of the tags to be removed.</p>",
2063+
"documentation":"<p>A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.</p>",
19502064
"location":"querystring",
19512065
"locationName":"tagKeys"
19522066
}
@@ -1981,8 +2095,16 @@
19812095
"locationName":"QuestionId"
19822096
},
19832097
"SelectedChoices":{"shape":"SelectedChoices"},
2098+
"ChoiceUpdates":{
2099+
"shape":"ChoiceUpdates",
2100+
"documentation":"<p>A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.</p>"
2101+
},
19842102
"Notes":{"shape":"Notes"},
1985-
"IsApplicable":{"shape":"IsApplicable"}
2103+
"IsApplicable":{"shape":"IsApplicable"},
2104+
"Reason":{
2105+
"shape":"AnswerReason",
2106+
"documentation":"<p>The reason why a question is not applicable to your workload.</p>"
2107+
}
19862108
},
19872109
"documentation":"<p>Input to update answer.</p>"
19882110
},

0 commit comments

Comments
 (0)