Did you find this page useful? Do you have a suggestion to improve the documentation? Give us feedback.
If you would like to suggest an improvement or fix for the AWS CLI, check out our contributing guide on GitHub.
First time using the AWS CLI? See the User Guide for help getting started.
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 ]
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
AWSOrganizationsAccess
must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare
API instead.
PrincipalType
as IAM
. With this configuration, the PrincipalARN
must already exist in the recipient account before it can be associated.See also: AWS API Documentation
create-portfolio-share
[--accept-language <value>]
--portfolio-id <value>
[--account-id <value>]
[--organization-node <value>]
[--share-tag-options | --no-share-tag-options]
[--share-principals | --no-share-principals]
[--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>]
--accept-language
(string)
The language code.
jp
- Japanesezh
- Chinese
--portfolio-id
(string)
The portfolio identifier.
--account-id
(string)
The Amazon Web Services account ID. For example,123456789012
.
--organization-node
(structure)
The organization node to whom you are going to share. When you pass
OrganizationNode
, it createsPortfolioShare
for all of the Amazon Web Services accounts that are associated to theOrganizationNode
. The output returns aPortfolioShareToken
, which enables the administrator to monitor the status of thePortfolioShare
creation process.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"
}
--share-tag-options
| --no-share-tag-options
(boolean)
Enables or disablesTagOptions
sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.
--share-principals
| --no-share-principals
(boolean)
This parameter is only supported for portfolios with an OrganizationalNode Type of
ORGANIZATION
orORGANIZATIONAL_UNIT
.Enables or disables
Principal
sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of
PrincipalType
:IAM_PATTERN
on their portfolio. You can create the principals in the recipient account before or after creating the share.
--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.
--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.
--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.
--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.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To share a portfolio with an account
The following create-portfolio-share
example shares the specified portfolio with the specified account.
aws servicecatalog create-portfolio-share \
--portfolio-id port-2s6abcdef5wdh4 \
--account-id 794123456789
This command produceds no output.
PortfolioShareToken -> (string)
The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.