We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.
Essential cookies are necessary to provide our site and services and cannot be deactivated. They are usually set in response to your actions on the site, such as setting your privacy preferences, signing in, or filling in forms.
Performance cookies provide anonymous statistics about how customers navigate our site so we can improve site experience and performance. Approved third parties may perform analytics on our behalf, but they cannot use the data for their own purposes.
Functional cookies help us provide useful site features, remember your preferences, and display relevant content. Approved third parties may set these cookies to provide certain site features. If you do not allow these cookies, then some or all of these services may not function properly.
Advertising cookies may be set through our site by us or our advertising partners and help us deliver relevant marketing content. If you do not allow these cookies, you will experience less relevant advertising.
Blocking some types of cookies may impact your experience of our sites. You may review and change your choices at any time by clicking Cookie preferences in the footer of this site. We and selected third-parties use cookies or similar technologies as specified in the AWS Cookie Notice.
update_portfolio_share
(**kwargs)¶Updates the specified portfolio share. You can use this API to enable or disable TagOptions
sharing or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare
operation is IN_PROGRESS
, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId
or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare
separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare
API for that action.
Note
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using 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
Request Syntax
response = client.update_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
AccountId='string',
OrganizationNode={
'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
'Value': 'string'
},
ShareTagOptions=True|False,
SharePrincipals=True|False
)
The language code.
en
- English (default)jp
- Japanesezh
- Chinese[REQUIRED]
The unique identifier of the portfolio for which the share will be updated.
Information about the organization node.
The organization node type.
The identifier of the organization node.
TagOptions
sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.Principals
sharing in the portfolio. If this field is not provided, the current state of the Principals
sharing on the portfolio share will not be modified.dict
Response Syntax
{
'PortfolioShareToken': 'string',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'ERROR'
}
Response Structure
(dict) --
PortfolioShareToken (string) --
The token that tracks the status of the UpdatePortfolioShare
operation for external account to account or organizational type sharing.
Status (string) --
The status of UpdatePortfolioShare
operation. You can also obtain the operation status using DescribePortfolioShareStatus
API.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundException
ServiceCatalog.Client.exceptions.InvalidParametersException
ServiceCatalog.Client.exceptions.OperationNotSupportedException
ServiceCatalog.Client.exceptions.InvalidStateException