Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490485351.4 KB

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.

post/#X-Amz-Target=AWS242ServiceCatalogService.DescribePortfolioShares

Query parameters

PageSizestring

Pagination limit

PageTokenstring

Pagination token

Headers

X-Amz-Target'AWS242ServiceCatalogService.DescribePortfolioShares' required

Request body

PortfolioIdstring required

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

Type'ACCOUNT' | 'ORGANIZATION' | 'ORGANIZATIONAL_UNIT' | 'ORGANIZATION_MEMBER_ACCOUNT' required
<p>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:</p> <p>1. <code>ACCOUNT</code> - Represents an external account to account share.</p> <p>2. <code>ORGANIZATION</code> - Represents a share to an organization. This share is available to every account in the organization.</p> <p>3. <code>ORGANIZATIONAL_UNIT</code> - Represents a share to an organizational unit.</p> <p>4. <code>ORGANIZATION_MEMBER_ACCOUNT</code> - Represents a share to an account in the organization.</p>
PageTokenstring

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

PageSizeinteger

The maximum number of items to return with this call.

Response

Success

NextPageTokenstring

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