Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribePortfolioShares

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.

Request Syntax


{
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string",
   "Type": "string"
}

Request Parameters

The request accepts the following data in JSON format.

PageSize

The maximum number of items to return with this call.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

PageToken

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

Type: String

Length Constraints: Maximum length of 2024.

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

Required: No

PortfolioId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

Type

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.

Type: String

Valid Values: ACCOUNT | ORGANIZATION | ORGANIZATIONAL_UNIT | ORGANIZATION_MEMBER_ACCOUNT

Required: Yes

Response Syntax


{
   "NextPageToken": "string",
   "PortfolioShareDetails": [ 
      { 
         "Accepted": boolean,
         "PrincipalId": "string",
         "SharePrincipals": boolean,
         "ShareTagOptions": boolean,
         "Type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextPageToken

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

Type: String

Length Constraints: Maximum length of 2024.

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

PortfolioShareDetails

Summaries about each of the portfolio shares.

Type: Array of PortfolioShareDetail objects

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400