Skip to content

/AWS1/CL_SCG=>UPDATEPORTFOLIOSHARE()

About UpdatePortfolioShare

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.

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.

Method Signature

IMPORTING

Required arguments:

iv_portfolioid TYPE /AWS1/SCGID /AWS1/SCGID

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

Optional arguments:

iv_acceptlanguage TYPE /AWS1/SCGACCEPTLANGUAGE /AWS1/SCGACCEPTLANGUAGE

The language code.

  • jp - Japanese

  • zh - Chinese

iv_accountid TYPE /AWS1/SCGACCOUNTID /AWS1/SCGACCOUNTID

The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

io_organizationnode TYPE REF TO /AWS1/CL_SCGORGANIZATIONNODE /AWS1/CL_SCGORGANIZATIONNODE

OrganizationNode

iv_sharetagoptions TYPE /AWS1/SCGNULLABLEBOOLEAN /AWS1/SCGNULLABLEBOOLEAN

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.

iv_shareprincipals TYPE /AWS1/SCGNULLABLEBOOLEAN /AWS1/SCGNULLABLEBOOLEAN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_scgupportfolioshare01 /AWS1/CL_SCGUPPORTFOLIOSHARE01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_scg~updateportfolioshare(
  io_organizationnode = new /aws1/cl_scgorganizationnode(
    iv_type = |string|
    iv_value = |string|
  )
  iv_acceptlanguage = |string|
  iv_accountid = |string|
  iv_portfolioid = |string|
  iv_shareprincipals = ABAP_TRUE
  iv_sharetagoptions = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_portfoliosharetoken( ).
  lv_sharestatus = lo_result->get_status( ).
ENDIF.