Skip to content
AWS for Query.Farm

aws.servicecatalog.describe_portfolio_shares

Example SQL Queries

SELECT * FROM
aws.servicecatalog.describe_portfolio_shares
WHERE
"portfolio_id" = 'VALUE'
AND "type" = 'VALUE';

Description

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

Table Definition

Column NameColumn Data Type
portfolio_id Required Input Column

The unique identifier of the portfolio for which shares will be retrieved.

VARCHAR
type Required Input Column

The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

1. ACCOUNT - Represents an external account to account share.

2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

VARCHAR
page_size Input Column

The maximum number of items to return with this call.

BIGINT
page_token Input Column

The page token for the next set of results. To retrieve the first set of results, use null.

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
next_page_token

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

VARCHAR
portfolio_share_details

Summaries about each of the portfolio shares.

STRUCT(
    "principal_id" VARCHAR,
    "type" VARCHAR,
    "accepted" BOOLEAN,
    "share_tag_options" BOOLEAN,
    "share_principals" BOOLEAN
)[]
Show child fields
portfolio_share_details[]
Show child fields
portfolio_share_details[].accepted

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

portfolio_share_details[].principal_id

The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:

1. An external account.

2. An organziation member account.

3. An organzational unit (OU).

4. The organization itself. (This shares with every account in the organization).

portfolio_share_details[].share_principals

Indicates if Principal sharing is enabled or disabled for the portfolio share.

portfolio_share_details[].share_tag_options

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

portfolio_share_details[].type

The type of the portfolio share.