Skip to content

CreateAgentProfileRequest

Source code in docs_src/capo_wellarchitected/types/create_agent_profile_request.py
class CreateAgentProfileRequest(TypedDict, closed=True):
    name: "str"
    """<p>The system name of the profile.</p>"""
    display_name: NotRequired[
        "capo_wellarchitected.types.sensitive_string.SensitiveString"
    ]
    """<p>The display name of the profile shown to users.</p>"""
    description: NotRequired[
        "capo_wellarchitected.types.sensitive_string.SensitiveString"
    ]
    """<p>A description of the profile.</p>"""
    business_overview: NotRequired[
        "capo_wellarchitected.types.sensitive_string.SensitiveString"
    ]
    """<p>The business overview for this profile.</p>"""
    pillars: "capo_wellarchitected.types.pillars.Pillars"
    """<p>The Well-Architected Tool Framework pillars to associate with this profile.</p>"""
    deletion_protection: "bool"
    """<p>Indicates whether deletion protection is enabled for the profile.</p>"""
    execution_role_arn: "capo_wellarchitected.types.role_arn.RoleArn"
    """<p>The ARN of the IAM execution role used for recommendation actions.</p>"""
    aggregation_configuration: "capo_wellarchitected.types.aggregation_configurations.AggregationConfigurations"
    """<p>The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.</p>"""
    client_token: NotRequired["str"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    tags: NotRequired["capo_wellarchitected.types.tags.Tags"]
    """<p>The tags to associate with the profile.</p>"""

aggregation_configuration instance-attribute

aggregation_configuration: AggregationConfigurations

The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

business_overview instance-attribute

business_overview: NotRequired[SensitiveString]

The business overview for this profile.

client_token instance-attribute

client_token: NotRequired[str]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

deletion_protection instance-attribute

deletion_protection: bool

Indicates whether deletion protection is enabled for the profile.

description instance-attribute

description: NotRequired[SensitiveString]

A description of the profile.

display_name instance-attribute

display_name: NotRequired[SensitiveString]

The display name of the profile shown to users.

execution_role_arn instance-attribute

execution_role_arn: RoleArn

The ARN of the IAM execution role used for recommendation actions.

name instance-attribute

name: str

The system name of the profile.

pillars instance-attribute

pillars: Pillars

The Well-Architected Tool Framework pillars to associate with this profile.

tags instance-attribute

tags: NotRequired[Tags]

The tags to associate with the profile.