[ aws . servicecatalog ]

describe-portfolio-share-status

Description

Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization or by a delegated admin.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-portfolio-share-status
--portfolio-share-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--portfolio-share-token (string)

The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

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

Output

PortfolioShareToken -> (string)

The token for the portfolio share operation. For example, share-6v24abcdefghi .

PortfolioId -> (string)

The portfolio identifier.

OrganizationNodeValue -> (string)

Organization node identifier. It can be either account id, organizational unit id or organization id.

Status -> (string)

Status of the portfolio share operation.

ShareDetails -> (structure)

Information about the portfolio share operation.

SuccessfulShares -> (list)

List of accounts for whom the operation succeeded.

(string)

ShareErrors -> (list)

List of errors.

(structure)

Errors that occurred during the portfolio share operation.

Accounts -> (list)

List of accounts impacted by the error.

(string)

Message -> (string)

Information about the error.

Error -> (string)

Error type that happened when processing the operation.