Skip to content
AWS for Query.Farm

aws.wellarchitected.list_workload_shares

Example SQL Queries

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

Description

List the workload shares associated with the 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
max_results Input Column

The maximum number of results to return for this request.

BIGINT
next_token Input Column

The token to use to retrieve the next set of results.

VARCHAR
shared_with_prefix Input Column

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.

VARCHAR
status Input Column

The status of the share request.

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_share_summaries

A list of workload share summaries.

STRUCT(
    "share_id" VARCHAR,
    "shared_with" VARCHAR,
    "permission_type" VARCHAR,
    "status" VARCHAR,
    "status_message" VARCHAR
)[]
Show child fields
workload_share_summaries[]
Show child fields
workload_share_summaries[].permission_type

Permission granted on a share request.

workload_share_summaries[].share_id

The ID associated with the share.

workload_share_summaries[].shared_with

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

workload_share_summaries[].status

The status of the share request.

workload_share_summaries[].status_message

Optional message to compliment the Status field.