Sign In to the Console
AWS Service Catalog
Developer Guide

AWS Documentation » AWS Service Catalog » Developer Guide » API Reference » Actions » CreatePortfolioShare

CreatePortfolioShare

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

Request Syntax

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

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. If OrganizationNode is passed in, PortfolioShare will be created for the node and its children (when applies), and a PortfolioShareToken will be returned in the output in order for 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

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 share unique identifier. This will only be returned if 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: