servicecatalog_update_portfolio_share: Updates the specified portfolio share

Description Usage Arguments Value Request syntax

View source: R/servicecatalog_operations.R

Description

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing for an existing portfolio share.

The portfolio share cannot be updated if the create_portfolio_share 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 update_portfolio_share separately for each share type.

This API cannot be used for removing the portfolio share. You must use delete_portfolio_share API for that action.

Usage

1
2
servicecatalog_update_portfolio_share(AcceptLanguage, PortfolioId,
  AccountId, OrganizationNode, ShareTagOptions)

Arguments

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

PortfolioId

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

AccountId

The AWS Account Id of the recipient account. This field is required when updating an external account to account type share.

OrganizationNode
ShareTagOptions

A flag to enable or disable 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.

Value

A list with the following syntax:

1
2
3
4
list(
  PortfolioShareToken = "string",
  Status = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"ERROR"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$update_portfolio_share(
  AcceptLanguage = "string",
  PortfolioId = "string",
  AccountId = "string",
  OrganizationNode = list(
    Type = "ORGANIZATION"|"ORGANIZATIONAL_UNIT"|"ACCOUNT",
    Value = "string"
  ),
  ShareTagOptions = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.