Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ServiceCatalog.UpdatePortfolioShare

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data UpdatePortfolioShare Source #

See: newUpdatePortfolioShare smart constructor.

Constructors

UpdatePortfolioShare'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
accountId :: Maybe Text
The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.
organizationNode :: Maybe OrganizationNode
sharePrincipals :: Maybe Bool
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.
shareTagOptions :: Maybe Bool
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.
portfolioId :: Text
The unique identifier of the portfolio for which the share will be updated.

Instances

Instances details

ToJSON UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods toJSON :: UpdatePortfolioShare -> Value # toEncoding :: UpdatePortfolioShare -> Encoding # toJSONList :: [UpdatePortfolioShare] -> Value # toEncodingList :: [UpdatePortfolioShare] -> Encoding #
ToHeaders UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods toHeaders :: UpdatePortfolioShare -> [Header] #
ToPath UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods toPath :: UpdatePortfolioShare -> ByteString #
ToQuery UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods toQuery :: UpdatePortfolioShare -> QueryString #
AWSRequest UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Associated Types type AWSResponse UpdatePortfolioShare # Methods request :: (Service -> Service) -> UpdatePortfolioShare -> Request UpdatePortfolioShare # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePortfolioShare -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePortfolioShare))) #
Generic UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Associated Types type Rep UpdatePortfolioShare :: Type -> Type # Methods from :: UpdatePortfolioShare -> Rep UpdatePortfolioShare x # to :: Rep UpdatePortfolioShare x -> UpdatePortfolioShare #
Read UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods readsPrec :: Int -> ReadS UpdatePortfolioShare # readList :: ReadS [UpdatePortfolioShare] # readPrec :: ReadPrec UpdatePortfolioShare # readListPrec :: ReadPrec [UpdatePortfolioShare] #
Show UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods showsPrec :: Int -> UpdatePortfolioShare -> ShowS # show :: UpdatePortfolioShare -> String # showList :: [UpdatePortfolioShare] -> ShowS #
NFData UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods rnf :: UpdatePortfolioShare -> () #
Eq UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods (==) :: UpdatePortfolioShare -> UpdatePortfolioShare -> Bool # (/=) :: UpdatePortfolioShare -> UpdatePortfolioShare -> Bool #
Hashable UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods hashWithSalt :: Int -> UpdatePortfolioShare -> Int # hash :: UpdatePortfolioShare -> Int #
type AWSResponse UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare type AWSResponse UpdatePortfolioShare = UpdatePortfolioShareResponse
type Rep UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare type Rep UpdatePortfolioShare = D1 ('MetaData "UpdatePortfolioShare" "Amazonka.ServiceCatalog.UpdatePortfolioShare" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "UpdatePortfolioShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "organizationNode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationNode)))) :: (S1 ('MetaSel ('Just "sharePrincipals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "shareTagOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "portfolioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdatePortfolioShare Source #

Arguments

:: Text	`UpdatePortfolioShare`
-> UpdatePortfolioShare

Create a value of UpdatePortfolioShare with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acceptLanguage:UpdatePortfolioShare', updatePortfolioShare_acceptLanguage - The language code.

en - English (default)
jp - Japanese
zh - Chinese

$sel:accountId:UpdatePortfolioShare', updatePortfolioShare_accountId - The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

$sel:organizationNode:UpdatePortfolioShare', updatePortfolioShare_organizationNode - Undocumented member.

UpdatePortfolioShare, updatePortfolioShare_sharePrincipals - 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.

UpdatePortfolioShare, updatePortfolioShare_shareTagOptions - 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.

UpdatePortfolioShare, updatePortfolioShare_portfolioId - The unique identifier of the portfolio for which the share will be updated.

Request Lenses

updatePortfolioShare_acceptLanguage :: Lens' UpdatePortfolioShare (Maybe Text) Source #

The language code.

en - English (default)
jp - Japanese
zh - Chinese

updatePortfolioShare_accountId :: Lens' UpdatePortfolioShare (Maybe Text) Source #

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

updatePortfolioShare_organizationNode :: Lens' UpdatePortfolioShare (Maybe OrganizationNode) Source #

Undocumented member.

updatePortfolioShare_sharePrincipals :: Lens' UpdatePortfolioShare (Maybe Bool) Source #

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.

updatePortfolioShare_shareTagOptions :: Lens' UpdatePortfolioShare (Maybe Bool) Source #

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.

updatePortfolioShare_portfolioId :: Lens' UpdatePortfolioShare Text Source #

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

Destructuring the Response

data UpdatePortfolioShareResponse Source #

See: newUpdatePortfolioShareResponse smart constructor.

Constructors

UpdatePortfolioShareResponse'
Fields portfolioShareToken :: Maybe Text The token that tracks the status of the `UpdatePortfolioShare` operation for external account to account or organizational type sharing. status :: Maybe ShareStatus The status of `UpdatePortfolioShare` operation. You can also obtain the operation status using `DescribePortfolioShareStatus` API. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Associated Types type Rep UpdatePortfolioShareResponse :: Type -> Type # Methods from :: UpdatePortfolioShareResponse -> Rep UpdatePortfolioShareResponse x # to :: Rep UpdatePortfolioShareResponse x -> UpdatePortfolioShareResponse #
Read UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods readsPrec :: Int -> ReadS UpdatePortfolioShareResponse # readList :: ReadS [UpdatePortfolioShareResponse] # readPrec :: ReadPrec UpdatePortfolioShareResponse # readListPrec :: ReadPrec [UpdatePortfolioShareResponse] #
Show UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods showsPrec :: Int -> UpdatePortfolioShareResponse -> ShowS # show :: UpdatePortfolioShareResponse -> String # showList :: [UpdatePortfolioShareResponse] -> ShowS #
NFData UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods rnf :: UpdatePortfolioShareResponse -> () #
Eq UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods (==) :: UpdatePortfolioShareResponse -> UpdatePortfolioShareResponse -> Bool # (/=) :: UpdatePortfolioShareResponse -> UpdatePortfolioShareResponse -> Bool #
type Rep UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare type Rep UpdatePortfolioShareResponse = D1 ('MetaData "UpdatePortfolioShareResponse" "Amazonka.ServiceCatalog.UpdatePortfolioShare" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "UpdatePortfolioShareResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "portfolioShareToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShareStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdatePortfolioShareResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdatePortfolioShareResponse'`
-> UpdatePortfolioShareResponse

Create a value of UpdatePortfolioShareResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:portfolioShareToken:UpdatePortfolioShareResponse', updatePortfolioShareResponse_portfolioShareToken - The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

UpdatePortfolioShareResponse, updatePortfolioShareResponse_status - The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

$sel:httpStatus:UpdatePortfolioShareResponse', updatePortfolioShareResponse_httpStatus - The response's http status code.

Response Lenses

updatePortfolioShareResponse_portfolioShareToken :: Lens' UpdatePortfolioShareResponse (Maybe Text) Source #

The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

updatePortfolioShareResponse_status :: Lens' UpdatePortfolioShareResponse (Maybe ShareStatus) Source #

The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

updatePortfolioShareResponse_httpStatus :: Lens' UpdatePortfolioShareResponse Int Source #

The response's http status code.