Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreatePortfolioShare

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.

Request Syntax


{
   "AcceptLanguage": "string",
   "AccountId": "string",
   "OrganizationNode": { 
      "Type": "string",
      "Value": "string"
   },
   "PortfolioId": "string",
   "ShareTagOptions": boolean
}

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

en - English (default)
jp - Japanese
zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

AccountId

The AWS account ID. For example, 123456789012.

Type: String

Pattern: ^[0-9]{12}$

Required: No

OrganizationNode

The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the AWS accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

Type: OrganizationNode object

Required: No

PortfolioId

The portfolio identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: Yes

ShareTagOptions

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

Type: Boolean

Required: No

Response Syntax


{
   "PortfolioShareToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PortfolioShareToken

The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

InvalidStateException

An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

HTTP Status Code: 400

LimitExceededException

The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

HTTP Status Code: 400

OperationNotSupportedException

The operation is not supported.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400