libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ServiceCatalog.UpdatePortfolioShare

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

Read UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Show UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Generic UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Associated Types

type Rep UpdatePortfolioShare :: Type -> Type #

NFData UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Methods

rnf :: UpdatePortfolioShare -> () #

Hashable UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

ToJSON UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

AWSRequest UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Associated Types

type AWSResponse UpdatePortfolioShare #

ToHeaders UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

ToPath UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

ToQuery UpdatePortfolioShare Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

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

newUpdatePortfolioShare Source #

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

Read UpdatePortfolioShareResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Show UpdatePortfolioShareResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Generic UpdatePortfolioShareResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

Associated Types

type Rep UpdatePortfolioShareResponse :: Type -> Type #

NFData UpdatePortfolioShareResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdatePortfolioShare

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 #

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.