list_organization_portfolio_access

ServiceCatalog.Client.list_organization_portfolio_access(**kwargs)

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

See also: AWS API Documentation

Request Syntax

response = client.list_organization_portfolio_access(
    AcceptLanguage='string',
    PortfolioId='string',
    OrganizationNodeType='ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
    PageToken='string',
    PageSize=123
)
Parameters
  • AcceptLanguage (string) --

    The language code.

    • en - English (default)
    • jp - Japanese
    • zh - Chinese
  • PortfolioId (string) --

    [REQUIRED]

    The portfolio identifier. For example, port-2abcdext3y5fk .

  • OrganizationNodeType (string) --

    [REQUIRED]

    The organization node type that will be returned in the output.

    • ORGANIZATION - Organization that has access to the portfolio.
    • ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.
    • ACCOUNT - Account that has access to the portfolio within your 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

{
    'OrganizationNodes': [
        {
            'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
            'Value': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) --

    • OrganizationNodes (list) --

      Displays information about the organization nodes.

      • (dict) --

        Information about the organization node.

        • Type (string) --

          The organization node type.

        • Value (string) --

          The identifier of the organization node.

    • NextPageToken (string) --

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

Exceptions

  • ServiceCatalog.Client.exceptions.ResourceNotFoundException
  • ServiceCatalog.Client.exceptions.InvalidParametersException
  • ServiceCatalog.Client.exceptions.OperationNotSupportedException