Skip to content

WorkloadData

Source code in docs_src/capo_launch_wizard/types/workload_data.py
class WorkloadData(TypedDict, closed=True):
    workload_name: NotRequired["capo_launch_wizard.types.workload_name.WorkloadName"]
    """<p>The name of the workload.</p>"""
    display_name: NotRequired["str"]
    """<p>The display name of a workload.</p>"""
    status: NotRequired["capo_launch_wizard.types.workload_status.WorkloadStatus"]
    """<p>The status of a workload.</p> <p> <i>You can list deployments in the <code>DISABLED</code> status.</i> </p>"""
    account_constraints: NotRequired[
        "capo_launch_wizard.types.account_constraints_list.AccountConstraintsList"
    ]
    """Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level."""
    description: NotRequired["str"]
    """<p>The description of a workload.</p>"""
    documentation_url: NotRequired["str"]
    """<p>The URL of a workload document.</p>"""
    icon_url: NotRequired["str"]
    """<p>The URL of a workload icon.</p>"""
    status_message: NotRequired["str"]
    """<p>The message about a workload's status.</p>"""

account_constraints instance-attribute

account_constraints: NotRequired[AccountConstraintsList]

Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

description instance-attribute

description: NotRequired[str]

The description of a workload.

display_name instance-attribute

display_name: NotRequired[str]

The display name of a workload.

documentation_url instance-attribute

documentation_url: NotRequired[str]

The URL of a workload document.

icon_url instance-attribute

icon_url: NotRequired[str]

The URL of a workload icon.

status instance-attribute

status: NotRequired[WorkloadStatus]

The status of a workload.

You can list deployments in the DISABLED status.

status_message instance-attribute

status_message: NotRequired[str]

The message about a workload's status.

workload_name instance-attribute

workload_name: NotRequired[WorkloadName]

The name of the workload.