ServiceCatalog / Client / update_portfolio_share

update_portfolio_share#

ServiceCatalog.Client.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
)
Parameters:

  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PortfolioId (string) –

    [REQUIRED]

    The unique identifier of the portfolio for which the share will be updated.

  • AccountId (string) – The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

  • OrganizationNode (dict) –

    Information about the organization node.

    • Type (string) –

      The organization node type.

    • Value (string) –

      The identifier of the organization node.

  • ShareTagOptions (boolean) – Enables or disables 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.

  • SharePrincipals (boolean) – A flag to enables or disables 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.

Return type:

dict

Returns:

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