Describe Portfolio Shares

servicecatalog_describe_portfolio_shares

R Documentation

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

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.

Usage¶

servicecatalog_describe_portfolio_shares(PortfolioId, Type, PageToken,
  PageSize)

Arguments¶

PortfolioId

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

Type

[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

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

PageSize

The maximum number of items to return with this call.

Value¶

A list with the following syntax:

list(
  NextPageToken = "string",
  PortfolioShareDetails = list(
    list(
      PrincipalId = "string",
      Type = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATIONAL_UNIT"|"ORGANIZATION_MEMBER_ACCOUNT",
      Accepted = TRUE|FALSE,
      ShareTagOptions = TRUE|FALSE,
      SharePrincipals = TRUE|FALSE
    )
  )
)

Request syntax¶

svc$describe_portfolio_shares(
  PortfolioId = "string",
  Type = "ACCOUNT"|"ORGANIZATION"|"ORGANIZATIONAL_UNIT"|"ORGANIZATION_MEMBER_ACCOUNT",
  PageToken = "string",
  PageSize = 123
)