[ aws . servicecatalog ]

list-portfolio-access

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-portfolio-access
[--accept-language <value>]
--portfolio-id <value>
[--organization-parent-id <value>]
[--page-token <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--portfolio-id (string)

The portfolio identifier.

--organization-parent-id (string)

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

--page-token (string)

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

--page-size (integer)

The maximum number of items to return with this call.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list accounts with access to a portfolio

The following list-portfolio-access example lists the AWS accounts that have access to the specified portfolio.

aws servicecatalog list-portfolio-access \
    --portfolio-id port-2s6abcdq5wdh4

Output:

{
    "AccountIds": [
        "123456789012"
    ]
}

Output

AccountIds -> (list)

Information about the AWS accounts with access to the portfolio.

(string)

NextPageToken -> (string)

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