Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . servicecatalog ]

describe-portfolio-shares

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.

See also: AWS API Documentation

Synopsis

  describe-portfolio-shares
--portfolio-id <value>
--type <value>
[--page-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--portfolio-id (string)

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

--type (string)

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.

Possible values:

• ACCOUNT
• ORGANIZATION
• ORGANIZATIONAL_UNIT
• ORGANIZATION_MEMBER_ACCOUNT

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

NextPageToken -> (string)

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

PortfolioShareDetails -> (list)

Summaries about each of the portfolio shares.

(structure)

Information about the portfolio share.

PrincipalId -> (string)

The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:

1. An external account.
2. An organziation member account.
3. An organzational unit (OU).
4. The organization itself. (This shares with every account in the organization).

Type -> (string)

The type of the portfolio share.

Accepted -> (boolean)

Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

ShareTagOptions -> (boolean)

Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

SharePrincipals -> (boolean)

Indicates if Principal sharing is enabled or disabled for the portfolio share.