Skip to content

AgentRecommendationSummary

Source code in docs_src/capo_wellarchitected/types/agent_recommendation_summary.py
class AgentRecommendationSummary(TypedDict, closed=True):
    recommendation_arn: (
        "capo_wellarchitected.types.recommendation_arn.RecommendationArn"
    )
    """<p>The Amazon Resource Name (ARN) of the recommendation.</p>"""
    profile_arn: "capo_wellarchitected.types.agent_profile_arn.AgentProfileArn"
    """<p>The Amazon Resource Name (ARN) of the associated profile.</p>"""
    generation_id: NotRequired["capo_wellarchitected.types.uuid.UUID"]
    """<p>The identifier of the generation process that produced this recommendation.</p>"""
    title: "capo_wellarchitected.types.sensitive_string.SensitiveString"
    """<p>The title of the recommendation.</p>"""
    description: "capo_wellarchitected.types.sensitive_string.SensitiveString"
    """<p>A description of the recommendation.</p>"""
    type: "capo_wellarchitected.types.recommendation_type.RecommendationType"
    """<p>The type of the recommendation.</p>"""
    pillar: "capo_wellarchitected.types.pillar.Pillar"
    """<p>The Well-Architected Tool Framework pillar that the recommendation addresses.</p>"""
    priority: "capo_wellarchitected.types.priority.Priority"
    """<p>The priority of the recommendation.</p>"""
    effort: "capo_wellarchitected.types.effort.Effort"
    """<p>The effort required to implement the recommendation.</p>"""
    status: "capo_wellarchitected.types.recommendation_status.RecommendationStatus"
    """<p>The current status of the recommendation.</p>"""
    state: "capo_wellarchitected.types.recommendation_state.RecommendationState"
    """<p>The current state of the recommendation.</p>"""
    update_reason: NotRequired[
        "capo_wellarchitected.types.sensitive_string.SensitiveString"
    ]
    """<p>The free-text reason associated with the recommendation's most recent status update.</p>"""
    impact: "capo_wellarchitected.types.impact_category.ImpactCategory"
    """<p>The severity of the recommendation's impact.</p>"""
    roi: "capo_wellarchitected.types.roi.Roi"
    """<p>The return on investment estimate for the recommendation.</p>"""
    number_of_resources: NotRequired["int"]
    """<p>The number of Amazon Web Services resources this recommendation affects.</p>"""
    aws_services: NotRequired["capo_wellarchitected.types.string_list.StringList"]
    """<p>The Amazon Web Services services that the recommendation applies to.</p>"""
    business_units: NotRequired["capo_wellarchitected.types.string_list.StringList"]
    """<p>The business units that own the affected resources.</p>"""
    applications: NotRequired["capo_wellarchitected.types.string_list.StringList"]
    """<p>The applications that the recommendation targets.</p>"""
    created_by: "str"
    """<p>The identifier of the user or system that created this recommendation.</p>"""
    created_at: "datetime.datetime"
    """<p>The timestamp when the recommendation was created.</p>"""
    last_modified_by: NotRequired["str"]
    """<p>The identifier of the user or system that last modified this recommendation.</p>"""
    last_modified_at: NotRequired["datetime.datetime"]
    """<p>The timestamp when the recommendation was last modified.</p>"""

applications instance-attribute

applications: NotRequired[StringList]

The applications that the recommendation targets.

aws_services instance-attribute

aws_services: NotRequired[StringList]

The Amazon Web Services services that the recommendation applies to.

business_units instance-attribute

business_units: NotRequired[StringList]

The business units that own the affected resources.

created_at instance-attribute

created_at: datetime

The timestamp when the recommendation was created.

created_by instance-attribute

created_by: str

The identifier of the user or system that created this recommendation.

description instance-attribute

description: SensitiveString

A description of the recommendation.

effort instance-attribute

effort: Effort

The effort required to implement the recommendation.

generation_id instance-attribute

generation_id: NotRequired[UUID]

The identifier of the generation process that produced this recommendation.

impact instance-attribute

The severity of the recommendation's impact.

last_modified_at instance-attribute

last_modified_at: NotRequired[datetime]

The timestamp when the recommendation was last modified.

last_modified_by instance-attribute

last_modified_by: NotRequired[str]

The identifier of the user or system that last modified this recommendation.

number_of_resources instance-attribute

number_of_resources: NotRequired[int]

The number of Amazon Web Services resources this recommendation affects.

pillar instance-attribute

pillar: Pillar

The Well-Architected Tool Framework pillar that the recommendation addresses.

priority instance-attribute

priority: Priority

The priority of the recommendation.

profile_arn instance-attribute

profile_arn: AgentProfileArn

The Amazon Resource Name (ARN) of the associated profile.

recommendation_arn instance-attribute

recommendation_arn: RecommendationArn

The Amazon Resource Name (ARN) of the recommendation.

roi instance-attribute

roi: Roi

The return on investment estimate for the recommendation.

state instance-attribute

The current state of the recommendation.

status instance-attribute

The current status of the recommendation.

title instance-attribute

The title of the recommendation.

type instance-attribute

The type of the recommendation.

update_reason instance-attribute

update_reason: NotRequired[SensitiveString]

The free-text reason associated with the recommendation's most recent status update.