Skip to content

aws.wellarchitected.list_share_invitations

Example SQL Queries

SELECT * FROM
aws.wellarchitected.list_share_invitations;

Description

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

Table Definition

Column NameColumn Data Type
lens_name_prefix Input Column

An optional string added to the beginning of each lens name returned in the results.

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
profile_name_prefix Input Column

An optional string added to the beginning of each profile name returned in the results.

VARCHAR
share_resource_type Input Column

The type of share invitations to be returned.

VARCHAR
template_name_prefix Input Column

An optional string added to the beginning of each review template name returned in the results.

VARCHAR
workload_name_prefix Input Column

An optional string added to the beginning of each workload name returned in the results.

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
share_invitation_summaries

List of share invitation summaries in a workload.

STRUCT(
"share_invitation_id" VARCHAR,
"shared_by" VARCHAR,
"shared_with" VARCHAR,
"permission_type" VARCHAR,
"share_resource_type" VARCHAR,
"workload_name" VARCHAR,
"workload_id" VARCHAR,
"lens_name" VARCHAR,
"lens_arn" VARCHAR,
"profile_name" VARCHAR,
"profile_arn" VARCHAR,
"template_name" VARCHAR,
"template_arn" VARCHAR
)[]
Show child fields
share_invitation_summaries[]
Show child fields
share_invitation_summaries[].lens_arn

The ARN for the lens.

share_invitation_summaries[].lens_name

The full name of the lens.

share_invitation_summaries[].permission_type

Permission granted on a share request.

share_invitation_summaries[].profile_arn

The profile ARN.

share_invitation_summaries[].profile_name

The profile name.

share_invitation_summaries[].share_invitation_id

The ID assigned to the share invitation.

share_invitation_summaries[].share_resource_type

The resource type of the share invitation.

share_invitation_summaries[].shared_by

An Amazon Web Services account ID.

share_invitation_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.

share_invitation_summaries[].template_arn

The review template ARN.

share_invitation_summaries[].template_name

The name of the review template.

share_invitation_summaries[].workload_id

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

share_invitation_summaries[].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.