ServiceCatalog / Client / describe_portfolio_shares

describe_portfolio_shares#

ServiceCatalog.Client.describe_portfolio_shares(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_portfolio_shares(
    PortfolioId='string',
    Type='ACCOUNT'|'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ORGANIZATION_MEMBER_ACCOUNT',
    PageToken='string',
    PageSize=123
)
Parameters:

  • PortfolioId (string) –

    [REQUIRED]

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

  • Type (string) –

    [REQUIRED]

    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.

  • PageToken (string) – The page token for the next set of results. To retrieve the first set of results, use null.

  • PageSize (integer) – The maximum number of items to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'NextPageToken': 'string',
    'PortfolioShareDetails': [
        {
            'PrincipalId': 'string',
            'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ORGANIZATION_MEMBER_ACCOUNT',
            'Accepted': True|False,
            'ShareTagOptions': True|False,
            'SharePrincipals': True|False
        },
    ]
}

Response Structure

  • (dict) –

    • NextPageToken (string) –

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

    • PortfolioShareDetails (list) –

      Summaries about each of the portfolio shares.

      • (dict) –

        Information about the portfolio share.

        • PrincipalId (string) –

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

        • Type (string) –

          The type of the portfolio share.

        • Accepted (boolean) –

          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.

        • ShareTagOptions (boolean) –

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

        • SharePrincipals (boolean) –

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

Exceptions