Skip to content

Workload

Source code in docs_src/capo_wellarchitected/types/workload.py
class Workload(TypedDict, closed=True):
    workload_id: NotRequired["capo_wellarchitected.types.workload_id.WorkloadId"]
    workload_arn: NotRequired["capo_wellarchitected.types.workload_arn.WorkloadArn"]
    workload_name: NotRequired["capo_wellarchitected.types.workload_name.WorkloadName"]
    description: NotRequired[
        "capo_wellarchitected.types.workload_description.WorkloadDescription"
    ]
    environment: NotRequired[
        "capo_wellarchitected.types.workload_environment.WorkloadEnvironment"
    ]
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the workload was last updated.</p>"""
    account_ids: NotRequired[
        "capo_wellarchitected.types.workload_account_ids.WorkloadAccountIds"
    ]
    aws_regions: NotRequired[
        "capo_wellarchitected.types.workload_aws_regions.WorkloadAwsRegions"
    ]
    non_aws_regions: NotRequired[
        "capo_wellarchitected.types.workload_non_aws_regions.WorkloadNonAwsRegions"
    ]
    architectural_design: NotRequired[
        "capo_wellarchitected.types.workload_architectural_design.WorkloadArchitecturalDesign"
    ]
    review_owner: NotRequired[
        "capo_wellarchitected.types.workload_review_owner.WorkloadReviewOwner"
    ]
    review_restriction_date: NotRequired["datetime.datetime"]
    """<p>The review restriction date for the workload.</p>"""
    is_review_owner_update_acknowledged: NotRequired[
        "capo_wellarchitected.types.is_review_owner_update_acknowledged.IsReviewOwnerUpdateAcknowledged"
    ]
    """<p>Flag indicating whether the workload owner has acknowledged that the <i>Review owner</i> field is required.</p> <p>If a <b>Review owner</b> is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.</p>"""
    industry_type: NotRequired[
        "capo_wellarchitected.types.workload_industry_type.WorkloadIndustryType"
    ]
    industry: NotRequired[
        "capo_wellarchitected.types.workload_industry.WorkloadIndustry"
    ]
    notes: NotRequired["capo_wellarchitected.types.notes.Notes"]
    improvement_status: NotRequired[
        "capo_wellarchitected.types.workload_improvement_status.WorkloadImprovementStatus"
    ]
    risk_counts: NotRequired["capo_wellarchitected.types.risk_counts.RiskCounts"]
    pillar_priorities: NotRequired[
        "capo_wellarchitected.types.workload_pillar_priorities.WorkloadPillarPriorities"
    ]
    lenses: NotRequired["capo_wellarchitected.types.workload_lenses.WorkloadLenses"]
    owner: NotRequired["capo_wellarchitected.types.aws_account_id.AwsAccountId"]
    share_invitation_id: NotRequired[
        "capo_wellarchitected.types.share_invitation_id.ShareInvitationId"
    ]
    """<p>The ID assigned to the share invitation.</p>"""
    tags: NotRequired["capo_wellarchitected.types.tag_map.TagMap"]
    """<p>The tags associated with the workload.</p>"""
    discovery_config: NotRequired[
        "capo_wellarchitected.types.workload_discovery_config.WorkloadDiscoveryConfig"
    ]
    """<p>Discovery configuration associated to the workload.</p>"""
    applications: NotRequired[
        "capo_wellarchitected.types.workload_applications.WorkloadApplications"
    ]
    """<p>List of AppRegistry application ARNs associated to the workload.</p>"""
    profiles: NotRequired[
        "capo_wellarchitected.types.workload_profiles.WorkloadProfiles"
    ]
    """<p>Profile associated with a workload.</p>"""
    prioritized_risk_counts: NotRequired[
        "capo_wellarchitected.types.risk_counts.RiskCounts"
    ]
    jira_configuration: NotRequired[
        "capo_wellarchitected.types.workload_jira_configuration_output.WorkloadJiraConfigurationOutput"
    ]
    """<p>Jira configuration for a specific workload.</p>"""

account_ids instance-attribute

account_ids: NotRequired[WorkloadAccountIds]

applications instance-attribute

applications: NotRequired[WorkloadApplications]

List of AppRegistry application ARNs associated to the workload.

architectural_design instance-attribute

architectural_design: NotRequired[WorkloadArchitecturalDesign]

aws_regions instance-attribute

aws_regions: NotRequired[WorkloadAwsRegions]

description instance-attribute

description: NotRequired[WorkloadDescription]

discovery_config instance-attribute

discovery_config: NotRequired[WorkloadDiscoveryConfig]

Discovery configuration associated to the workload.

environment instance-attribute

environment: NotRequired[WorkloadEnvironment]

improvement_status instance-attribute

improvement_status: NotRequired[WorkloadImprovementStatus]

industry instance-attribute

industry: NotRequired[WorkloadIndustry]

industry_type instance-attribute

industry_type: NotRequired[WorkloadIndustryType]

is_review_owner_update_acknowledged instance-attribute

is_review_owner_update_acknowledged: NotRequired[IsReviewOwnerUpdateAcknowledged]

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

jira_configuration instance-attribute

jira_configuration: NotRequired[WorkloadJiraConfigurationOutput]

Jira configuration for a specific workload.

lenses instance-attribute

lenses: NotRequired[WorkloadLenses]

non_aws_regions instance-attribute

non_aws_regions: NotRequired[WorkloadNonAwsRegions]

notes instance-attribute

notes: NotRequired[Notes]

owner instance-attribute

owner: NotRequired[AwsAccountId]

pillar_priorities instance-attribute

pillar_priorities: NotRequired[WorkloadPillarPriorities]

prioritized_risk_counts instance-attribute

prioritized_risk_counts: NotRequired[RiskCounts]

profiles instance-attribute

profiles: NotRequired[WorkloadProfiles]

Profile associated with a workload.

review_owner instance-attribute

review_owner: NotRequired[WorkloadReviewOwner]

review_restriction_date instance-attribute

review_restriction_date: NotRequired[datetime]

The review restriction date for the workload.

risk_counts instance-attribute

risk_counts: NotRequired[RiskCounts]

share_invitation_id instance-attribute

share_invitation_id: NotRequired[ShareInvitationId]

The ID assigned to the share invitation.

tags instance-attribute

tags: NotRequired[TagMap]

The tags associated with the workload.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The date and time when the workload was last updated.

workload_arn instance-attribute

workload_arn: NotRequired[WorkloadArn]

workload_id instance-attribute

workload_id: NotRequired[WorkloadId]

workload_name instance-attribute

workload_name: NotRequired[WorkloadName]