Skip to content

Choice

Source code in docs_src/capo_wellarchitected/types/choice.py
class Choice(TypedDict, closed=True):
    choice_id: NotRequired["capo_wellarchitected.types.choice_id.ChoiceId"]
    title: NotRequired["capo_wellarchitected.types.choice_title.ChoiceTitle"]
    description: NotRequired[
        "capo_wellarchitected.types.choice_description.ChoiceDescription"
    ]
    helpful_resource: NotRequired[
        "capo_wellarchitected.types.choice_content.ChoiceContent"
    ]
    """<p>The helpful resource (both text and URL) for a particular choice.</p> <p>This field only applies to custom lenses. Each choice can have only one helpful resource.</p>"""
    improvement_plan: NotRequired[
        "capo_wellarchitected.types.choice_content.ChoiceContent"
    ]
    """<p>The improvement plan (both text and URL) for a particular choice.</p> <p>This field only applies to custom lenses. Each choice can have only one improvement plan.</p>"""
    additional_resources: NotRequired[
        "capo_wellarchitected.types.additional_resources_list.AdditionalResourcesList"
    ]
    """<p>The additional resources for a choice in a custom lens.</p> <p>A choice can have up to two additional resources: one of type <code>HELPFUL_RESOURCE</code>, one of type <code>IMPROVEMENT_PLAN</code>, or both.</p>"""

additional_resources instance-attribute

additional_resources: NotRequired[AdditionalResourcesList]

The additional resources for a choice in a custom lens.

A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

choice_id instance-attribute

choice_id: NotRequired[ChoiceId]

description instance-attribute

description: NotRequired[ChoiceDescription]

helpful_resource instance-attribute

helpful_resource: NotRequired[ChoiceContent]

The helpful resource (both text and URL) for a particular choice.

This field only applies to custom lenses. Each choice can have only one helpful resource.

improvement_plan instance-attribute

improvement_plan: NotRequired[ChoiceContent]

The improvement plan (both text and URL) for a particular choice.

This field only applies to custom lenses. Each choice can have only one improvement plan.

title instance-attribute

title: NotRequired[ChoiceTitle]