Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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 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.

Synopsis

Creating a Request

data UpdatePortfolioShare Source #

See: newUpdatePortfolioShare smart constructor.

Constructors

UpdatePortfolioShare'

Fields

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

Instances

Instances details

Eq UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods (==) :: UpdatePortfolioShare -> UpdatePortfolioShare -> Bool # (/=) :: UpdatePortfolioShare -> UpdatePortfolioShare -> Bool #
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 #
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 #
NFData UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods rnf :: UpdatePortfolioShare -> () #
Hashable UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods hashWithSalt :: Int -> UpdatePortfolioShare -> Int # hash :: UpdatePortfolioShare -> Int #
ToJSON UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods toJSON :: UpdatePortfolioShare -> Value # toEncoding :: UpdatePortfolioShare -> Encoding # toJSONList :: [UpdatePortfolioShare] -> Value # toEncodingList :: [UpdatePortfolioShare] -> Encoding #
AWSRequest UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Associated Types type AWSResponse UpdatePortfolioShare # Methods request :: UpdatePortfolioShare -> Request UpdatePortfolioShare # response :: MonadResource m => Logger -> Service -> Proxy UpdatePortfolioShare -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePortfolioShare))) #
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 #
type Rep UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare type Rep UpdatePortfolioShare = D1 ('MetaData "UpdatePortfolioShare" "Amazonka.ServiceCatalog.UpdatePortfolioShare" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "UpdatePortfolioShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "shareTagOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "organizationNode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationNode)) :: S1 ('MetaSel ('Just "portfolioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare type AWSResponse UpdatePortfolioShare = UpdatePortfolioShareResponse

newUpdatePortfolioShare Source #

Arguments

:: Text	`$sel:portfolioId: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:accountId:UpdatePortfolioShare', updatePortfolioShare_accountId - The AWS Account Id of the recipient account. This field is required when updating an external account to account type share.

$sel:shareTagOptions:UpdatePortfolioShare', updatePortfolioShare_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.

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

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

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

$sel:portfolioId:UpdatePortfolioShare', updatePortfolioShare_portfolioId - The unique identifier of the portfolio for which the share will be updated.

Request Lenses

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

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

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

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.

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

The language code.

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

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

Undocumented member.

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 status :: Maybe ShareStatus The status of `UpdatePortfolioShare` operation. You can also obtain the operation status using `DescribePortfolioShareStatus` API. portfolioShareToken :: Maybe Text The token that tracks the status of the `UpdatePortfolioShare` operation for external account to account or organizational type sharing. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods (==) :: UpdatePortfolioShareResponse -> UpdatePortfolioShareResponse -> Bool # (/=) :: UpdatePortfolioShareResponse -> UpdatePortfolioShareResponse -> Bool #
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 #
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 #
NFData UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare Methods rnf :: UpdatePortfolioShareResponse -> () #
type Rep UpdatePortfolioShareResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare type Rep UpdatePortfolioShareResponse = D1 ('MetaData "UpdatePortfolioShareResponse" "Amazonka.ServiceCatalog.UpdatePortfolioShare" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "UpdatePortfolioShareResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShareStatus)) :: (S1 ('MetaSel ('Just "portfolioShareToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:status:UpdatePortfolioShareResponse', updatePortfolioShareResponse_status - The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

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

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

Response Lenses

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

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

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_httpStatus :: Lens' UpdatePortfolioShareResponse Int Source #

The response's http status code.