1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. wellarchitected
  6. getWorkload

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.80.0
published on Monday, Sep 21, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.80.0
published on Monday, Sep 21, 2026 by Pulumi

    Definition of AWS::WellArchitected::Workload Resource Type

    Using getWorkload

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkload(args: GetWorkloadArgs, opts?: InvokeOptions): Promise<GetWorkloadResult>
    function getWorkloadOutput(args: GetWorkloadOutputArgs, opts?: InvokeOutputOptions): Output<GetWorkloadResult>
    def get_workload(workload_arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetWorkloadResult
    def get_workload_output(workload_arn: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetWorkloadResult]
    func LookupWorkload(ctx *Context, args *LookupWorkloadArgs, opts ...InvokeOption) (*LookupWorkloadResult, error)
    func LookupWorkloadOutput(ctx *Context, args *LookupWorkloadOutputArgs, opts ...InvokeOption) LookupWorkloadResultOutput

    > Note: This function is named LookupWorkload in the Go SDK.

    public static class GetWorkload 
    {
        public static Task<GetWorkloadResult> InvokeAsync(GetWorkloadArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkloadResult> Invoke(GetWorkloadInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkloadResult> Invoke(GetWorkloadInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetWorkloadResult> getWorkload(GetWorkloadArgs args, InvokeOptions options)
    public static Output<GetWorkloadResult> getWorkload(GetWorkloadArgs args, InvokeOptions options)
    public static Output<GetWorkloadResult> getWorkload(GetWorkloadArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws-native:wellarchitected:getWorkload
      arguments:
        # arguments dictionary
    data "aws-native_wellarchitected_get_workload" "name" {
        # arguments
    }

    The following arguments are supported:

    WorkloadArn string
    The ARN for the workload.
    WorkloadArn string
    The ARN for the workload.
    workload_arn string
    The ARN for the workload.
    workloadArn String
    The ARN for the workload.
    workloadArn string
    The ARN for the workload.
    workload_arn str
    The ARN for the workload.
    workloadArn String
    The ARN for the workload.

    getWorkload Result

    The following output properties are available:

    AccountIds List<string>
    The list of Amazon Web Services account IDs associated with the workload.
    ArchitecturalDesign string
    The URL of the architectural design for the workload.
    AwsRegions List<string>
    The list of Amazon Web Services Regions associated with the workload.
    Description string
    The description for the workload.
    DiscoveryConfig Pulumi.AwsNative.WellArchitected.Outputs.DiscoveryConfigProperties
    Discovery configuration associated to the workload.
    Environment Pulumi.AwsNative.WellArchitected.WorkloadEnvironment
    The environment for the workload.
    ImprovementStatus Pulumi.AwsNative.WellArchitected.WorkloadImprovementStatus
    The improvement status for a workload.
    Industry string
    The industry for the workload.
    IndustryType string
    The industry type for the workload.
    NonAwsRegions List<string>
    The list of non-Amazon Web Services Regions associated with the workload.
    Notes string
    The notes associated with the workload.
    ReviewOwner string
    The review owner of the workload.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags associated with the workload.
    WorkloadArn string
    The ARN for the workload.
    WorkloadId string
    The ID assigned to the workload.
    WorkloadName string
    The name of the workload.
    AccountIds []string
    The list of Amazon Web Services account IDs associated with the workload.
    ArchitecturalDesign string
    The URL of the architectural design for the workload.
    AwsRegions []string
    The list of Amazon Web Services Regions associated with the workload.
    Description string
    The description for the workload.
    DiscoveryConfig DiscoveryConfigProperties
    Discovery configuration associated to the workload.
    Environment WorkloadEnvironment
    The environment for the workload.
    ImprovementStatus WorkloadImprovementStatus
    The improvement status for a workload.
    Industry string
    The industry for the workload.
    IndustryType string
    The industry type for the workload.
    NonAwsRegions []string
    The list of non-Amazon Web Services Regions associated with the workload.
    Notes string
    The notes associated with the workload.
    ReviewOwner string
    The review owner of the workload.
    Tags Tag
    The tags associated with the workload.
    WorkloadArn string
    The ARN for the workload.
    WorkloadId string
    The ID assigned to the workload.
    WorkloadName string
    The name of the workload.
    account_ids list(string)
    The list of Amazon Web Services account IDs associated with the workload.
    architectural_design string
    The URL of the architectural design for the workload.
    aws_regions list(string)
    The list of Amazon Web Services Regions associated with the workload.
    description string
    The description for the workload.
    discovery_config object
    Discovery configuration associated to the workload.
    environment "PRODUCTION" | "PREPRODUCTION"
    The environment for the workload.
    improvement_status "NOT_APPLICABLE" | "NOT_STARTED" | "IN_PROGRESS" | "COMPLETE" | "RISK_ACKNOWLEDGED"
    The improvement status for a workload.
    industry string
    The industry for the workload.
    industry_type string
    The industry type for the workload.
    non_aws_regions list(string)
    The list of non-Amazon Web Services Regions associated with the workload.
    notes string
    The notes associated with the workload.
    review_owner string
    The review owner of the workload.
    tags list(object)
    The tags associated with the workload.
    workload_arn string
    The ARN for the workload.
    workload_id string
    The ID assigned to the workload.
    workload_name string
    The name of the workload.
    accountIds List<String>
    The list of Amazon Web Services account IDs associated with the workload.
    architecturalDesign String
    The URL of the architectural design for the workload.
    awsRegions List<String>
    The list of Amazon Web Services Regions associated with the workload.
    description String
    The description for the workload.
    discoveryConfig DiscoveryConfigProperties
    Discovery configuration associated to the workload.
    environment WorkloadEnvironment
    The environment for the workload.
    improvementStatus WorkloadImprovementStatus
    The improvement status for a workload.
    industry String
    The industry for the workload.
    industryType String
    The industry type for the workload.
    nonAwsRegions List<String>
    The list of non-Amazon Web Services Regions associated with the workload.
    notes String
    The notes associated with the workload.
    reviewOwner String
    The review owner of the workload.
    tags List<Tag>
    The tags associated with the workload.
    workloadArn String
    The ARN for the workload.
    workloadId String
    The ID assigned to the workload.
    workloadName String
    The name of the workload.
    accountIds string[]
    The list of Amazon Web Services account IDs associated with the workload.
    architecturalDesign string
    The URL of the architectural design for the workload.
    awsRegions string[]
    The list of Amazon Web Services Regions associated with the workload.
    description string
    The description for the workload.
    discoveryConfig DiscoveryConfigProperties
    Discovery configuration associated to the workload.
    environment WorkloadEnvironment
    The environment for the workload.
    improvementStatus WorkloadImprovementStatus
    The improvement status for a workload.
    industry string
    The industry for the workload.
    industryType string
    The industry type for the workload.
    nonAwsRegions string[]
    The list of non-Amazon Web Services Regions associated with the workload.
    notes string
    The notes associated with the workload.
    reviewOwner string
    The review owner of the workload.
    tags Tag[]
    The tags associated with the workload.
    workloadArn string
    The ARN for the workload.
    workloadId string
    The ID assigned to the workload.
    workloadName string
    The name of the workload.
    account_ids Sequence[str]
    The list of Amazon Web Services account IDs associated with the workload.
    architectural_design str
    The URL of the architectural design for the workload.
    aws_regions Sequence[str]
    The list of Amazon Web Services Regions associated with the workload.
    description str
    The description for the workload.
    discovery_config DiscoveryConfigProperties
    Discovery configuration associated to the workload.
    environment WorkloadEnvironment
    The environment for the workload.
    improvement_status WorkloadImprovementStatus
    The improvement status for a workload.
    industry str
    The industry for the workload.
    industry_type str
    The industry type for the workload.
    non_aws_regions Sequence[str]
    The list of non-Amazon Web Services Regions associated with the workload.
    notes str
    The notes associated with the workload.
    review_owner str
    The review owner of the workload.
    tags Sequence[root_Tag]
    The tags associated with the workload.
    workload_arn str
    The ARN for the workload.
    workload_id str
    The ID assigned to the workload.
    workload_name str
    The name of the workload.
    accountIds List<String>
    The list of Amazon Web Services account IDs associated with the workload.
    architecturalDesign String
    The URL of the architectural design for the workload.
    awsRegions List<String>
    The list of Amazon Web Services Regions associated with the workload.
    description String
    The description for the workload.
    discoveryConfig Property Map
    Discovery configuration associated to the workload.
    environment "PRODUCTION" | "PREPRODUCTION"
    The environment for the workload.
    improvementStatus "NOT_APPLICABLE" | "NOT_STARTED" | "IN_PROGRESS" | "COMPLETE" | "RISK_ACKNOWLEDGED"
    The improvement status for a workload.
    industry String
    The industry for the workload.
    industryType String
    The industry type for the workload.
    nonAwsRegions List<String>
    The list of non-Amazon Web Services Regions associated with the workload.
    notes String
    The notes associated with the workload.
    reviewOwner String
    The review owner of the workload.
    tags List<Property Map>
    The tags associated with the workload.
    workloadArn String
    The ARN for the workload.
    workloadId String
    The ID assigned to the workload.
    workloadName String
    The name of the workload.

    Supporting Types

    DiscoveryConfigProperties

    TrustedAdvisorIntegrationStatus WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatus
    Discovery integration status in respect to Trusted Advisor for the workload.
    WorkloadResourceDefinition []WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItem
    The mode to use for identifying resources associated with the workload.
    trusted_advisor_integration_status "ENABLED" | "DISABLED"
    Discovery integration status in respect to Trusted Advisor for the workload.
    workload_resource_definition list("WORKLOAD_METADATA" | "APP_REGISTRY")
    The mode to use for identifying resources associated with the workload.
    trustedAdvisorIntegrationStatus WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatus
    Discovery integration status in respect to Trusted Advisor for the workload.
    workloadResourceDefinition List<WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItem>
    The mode to use for identifying resources associated with the workload.
    trustedAdvisorIntegrationStatus WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatus
    Discovery integration status in respect to Trusted Advisor for the workload.
    workloadResourceDefinition WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItem[]
    The mode to use for identifying resources associated with the workload.
    trusted_advisor_integration_status WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatus
    Discovery integration status in respect to Trusted Advisor for the workload.
    workload_resource_definition Sequence[WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItem]
    The mode to use for identifying resources associated with the workload.
    trustedAdvisorIntegrationStatus "ENABLED" | "DISABLED"
    Discovery integration status in respect to Trusted Advisor for the workload.
    workloadResourceDefinition List<"WORKLOAD_METADATA" | "APP_REGISTRY">
    The mode to use for identifying resources associated with the workload.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WorkloadDiscoveryConfigPropertiesTrustedAdvisorIntegrationStatus

    WorkloadDiscoveryConfigPropertiesWorkloadResourceDefinitionItem

    WorkloadEnvironment

    WorkloadImprovementStatus

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.80.0
    published on Monday, Sep 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial