Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPortfolioAccess

Lists the account IDs that have access to the specified portfolio.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

Request Syntax


{
   "AcceptLanguage": "string",
   "OrganizationParentId": "string",
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

jp - Japanese
zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

OrganizationParentId

The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

Type: String

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

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

Required: No

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 portfolio identifier.

Type: String

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

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

Required: Yes

Response Syntax


{
   "AccountIds": [ "string" ],
   "NextPageToken": "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.

AccountIds

Information about the Amazon Web Services accounts with access to the portfolio.

Type: Array of strings

Pattern: ^[0-9]{12}$

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]*

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