[ aws . servicecatalog ]

delete-portfolio-share

Description

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-portfolio-share
[--accept-language <value>]
--portfolio-id <value>
[--account-id <value>]
[--organization-node <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.

--account-id (string)

The AWS account ID.

--organization-node (structure)

The organization node to whom you are going to stop sharing.

Type -> (string)

The organization node type.

Value -> (string)

The identifier of the organization node.

Shorthand Syntax:

Type=string,Value=string

JSON Syntax:

{
  "Type": "ORGANIZATION"|"ORGANIZATIONAL_UNIT"|"ACCOUNT",
  "Value": "string"
}

--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 stop sharing a portfolio with an account

The following delete-portfolio-share example stops sharing the portfolio with the specified account.

aws servicecatalog delete-portfolio-share \
    --portfolio-id port-2s6abcdq5wdh4 \
    --account-id 123456789012

This command produces no output.

Output

PortfolioShareToken -> (string)

The portfolio share unique identifier. This will only be returned if delete is made to an organization node.