Skip to content
AWS for Query.Farm

aws.wellarchitected.get_workload

Example SQL Queries

SELECT * FROM
aws.wellarchitected.get_workload
WHERE
"workload_id" = 'VALUE';

Description

Get an existing workload.

Table Definition

Column NameColumn Data Type
workload_id Required Input Column

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
workload

A workload return object.

STRUCT(
    "workload_id" VARCHAR,
    "workload_arn" VARCHAR,
    "workload_name" VARCHAR,
    "description" VARCHAR,
    "environment" VARCHAR,
    "updated_at" TIMESTAMP_S,
    "account_ids" VARCHAR[],
    "aws_regions" VARCHAR[],
    "non_aws_regions" VARCHAR[],
    "architectural_design" VARCHAR,
    "review_owner" VARCHAR,
    "review_restriction_date" TIMESTAMP_S,
    "is_review_owner_update_acknowledged" BOOLEAN,
    "industry_type" VARCHAR,
    "industry" VARCHAR,
    "notes" VARCHAR,
    "improvement_status" VARCHAR,
    "risk_counts" MAP(VARCHAR, BIGINT),
    "pillar_priorities" VARCHAR[],
    "lenses" VARCHAR[],
    "owner" VARCHAR,
    "share_invitation_id" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "discovery_config" STRUCT(
        "trusted_advisor_integration_status" VARCHAR,
        "workload_resource_definition" VARCHAR[]
    ),
    "applications" VARCHAR[],
    "profiles" STRUCT(
        "profile_arn" VARCHAR,
        "profile_version" VARCHAR
    )[],
    "prioritized_risk_counts" MAP(VARCHAR, BIGINT),
    "jira_configuration" STRUCT(
        "issue_management_status" VARCHAR,
        "issue_management_type" VARCHAR,
        "jira_project_key" VARCHAR,
        "status_message" VARCHAR
    )
)
Show child fields
workload.account_ids[]
workload.applications[]
workload.architectural_design

The URL of the architectural design for the workload.

workload.aws_regions[]
workload.description

The description for the workload.

workload.discovery_config

Discovery configuration associated to the workload.

Show child fields
workload.discovery_config.trusted_advisor_integration_status

Discovery integration status in respect to Trusted Advisor for the workload.

workload.discovery_config.workload_resource_definition[]
workload.environment

The environment for the workload.

workload.improvement_status

The improvement status for a workload.

workload.industry

The industry for the workload.

workload.industry_type

The industry type for the workload.

If specified, must be one of the following:

  • Agriculture

  • Automobile

  • Defense

  • Design and Engineering

  • Digital Advertising

  • Education

  • Environmental Protection

  • Financial Services

  • Gaming

  • General Public Services

  • Healthcare

  • Hospitality

  • InfoTech

  • Justice and Public Safety

  • Life Sciences

  • Manufacturing

  • Media & Entertainment

  • Mining & Resources

  • Oil & Gas

  • Power & Utilities

  • Professional Services

  • Real Estate & Construction

  • Retail & Wholesale

  • Social Protection

  • Telecommunications

  • Travel, Transportation & Logistics

  • Other

workload.is_review_owner_update_acknowledged

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.

workload.jira_configuration

Jira configuration for a specific workload.

Show child fields
workload.jira_configuration.issue_management_status

Workload-level: Jira issue management status.

workload.jira_configuration.issue_management_type

Workload-level: Jira issue management type.

workload.jira_configuration.jira_project_key

Workload-level: Jira project key to sync workloads to.

workload.jira_configuration.status_message

Workload-level: Status message on configuration of the Jira integration.

workload.lenses[]
workload.non_aws_regions[]
workload.notes

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

workload.owner

An Amazon Web Services account ID.

workload.pillar_priorities[]
workload.prioritized_risk_counts

A map from risk names to the count of how many questions have that rating.

workload.profiles[]
Show child fields
workload.profiles[].profile_arn

The profile ARN.

workload.profiles[].profile_version

The profile version.

workload.review_owner

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

workload.review_restriction_date

The date and time recorded.

workload.risk_counts

A map from risk names to the count of how many questions have that rating.

workload.share_invitation_id

The ID assigned to the share invitation.

workload.tags

The tags associated with the workload.

workload.updated_at

The date and time recorded.

workload.workload_arn

The ARN for the workload.

workload.workload_id

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

workload.workload_name

The name of the workload.

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.