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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can't share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

Synopsis

Creating a Request

data CreatePortfolioShare Source #

See: newCreatePortfolioShare smart constructor.

Constructors

CreatePortfolioShare'

Fields

accountId :: Maybe Text
The AWS account ID. For example, 123456789012.
shareTagOptions :: Maybe Bool
Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.
acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
organizationNode :: Maybe OrganizationNode
The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node an ListOrganizationPortfolioAccessd its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.
portfolioId :: Text
The portfolio identifier.

Instances

Instances details

Eq CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods (==) :: CreatePortfolioShare -> CreatePortfolioShare -> Bool # (/=) :: CreatePortfolioShare -> CreatePortfolioShare -> Bool #
Read CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods readsPrec :: Int -> ReadS CreatePortfolioShare # readList :: ReadS [CreatePortfolioShare] # readPrec :: ReadPrec CreatePortfolioShare # readListPrec :: ReadPrec [CreatePortfolioShare] #
Show CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods showsPrec :: Int -> CreatePortfolioShare -> ShowS # show :: CreatePortfolioShare -> String # showList :: [CreatePortfolioShare] -> ShowS #
Generic CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Associated Types type Rep CreatePortfolioShare :: Type -> Type # Methods from :: CreatePortfolioShare -> Rep CreatePortfolioShare x # to :: Rep CreatePortfolioShare x -> CreatePortfolioShare #
NFData CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods rnf :: CreatePortfolioShare -> () #
Hashable CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods hashWithSalt :: Int -> CreatePortfolioShare -> Int # hash :: CreatePortfolioShare -> Int #
ToJSON CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods toJSON :: CreatePortfolioShare -> Value # toEncoding :: CreatePortfolioShare -> Encoding # toJSONList :: [CreatePortfolioShare] -> Value # toEncodingList :: [CreatePortfolioShare] -> Encoding #
AWSRequest CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Associated Types type AWSResponse CreatePortfolioShare # Methods request :: CreatePortfolioShare -> Request CreatePortfolioShare # response :: MonadResource m => Logger -> Service -> Proxy CreatePortfolioShare -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePortfolioShare))) #
ToHeaders CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods toHeaders :: CreatePortfolioShare -> [Header] #
ToPath CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods toPath :: CreatePortfolioShare -> ByteString #
ToQuery CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare Methods toQuery :: CreatePortfolioShare -> QueryString #
type Rep CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare type Rep CreatePortfolioShare = D1 ('MetaData "CreatePortfolioShare" "Amazonka.ServiceCatalog.CreatePortfolioShare" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "CreatePortfolioShare'" '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 CreatePortfolioShare Source #
Instance details Defined in Amazonka.ServiceCatalog.CreatePortfolioShare type AWSResponse CreatePortfolioShare = CreatePortfolioShareResponse

newCreatePortfolioShare Source #

Arguments

:: Text	`$sel:portfolioId:CreatePortfolioShare'`
-> CreatePortfolioShare

Create a value of CreatePortfolioShare 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:CreatePortfolioShare', createPortfolioShare_accountId - The AWS account ID. For example, 123456789012.

$sel:shareTagOptions:CreatePortfolioShare', createPortfolioShare_shareTagOptions - Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

$sel:acceptLanguage:CreatePortfolioShare', createPortfolioShare_acceptLanguage - The language code.

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

$sel:organizationNode:CreatePortfolioShare', createPortfolioShare_organizationNode - The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node an ListOrganizationPortfolioAccessd its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.

$sel:portfolioId:CreatePortfolioShare', createPortfolioShare_portfolioId - The portfolio identifier.

Request Lenses

createPortfolioShare_accountId :: Lens' CreatePortfolioShare (Maybe Text) Source #

The AWS account ID. For example, 123456789012.

createPortfolioShare_shareTagOptions :: Lens' CreatePortfolioShare (Maybe Bool) Source #

Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

createPortfolioShare_acceptLanguage :: Lens' CreatePortfolioShare (Maybe Text) Source #

The language code.

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

createPortfolioShare_organizationNode :: Lens' CreatePortfolioShare (Maybe OrganizationNode) Source #

The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node an ListOrganizationPortfolioAccessd its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.

createPortfolioShare_portfolioId :: Lens' CreatePortfolioShare Text Source #

The portfolio identifier.

Destructuring the Response

data CreatePortfolioShareResponse Source #

See: newCreatePortfolioShareResponse smart constructor.

Constructors

CreatePortfolioShareResponse'
Fields portfolioShareToken :: Maybe Text The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreatePortfolioShareResponse Source #

Arguments

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

Create a value of CreatePortfolioShareResponse 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:CreatePortfolioShareResponse', createPortfolioShareResponse_portfolioShareToken - The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

$sel:httpStatus:CreatePortfolioShareResponse', createPortfolioShareResponse_httpStatus - The response's http status code.

Response Lenses

createPortfolioShareResponse_portfolioShareToken :: Lens' CreatePortfolioShareResponse (Maybe Text) Source #

The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

createPortfolioShareResponse_httpStatus :: Lens' CreatePortfolioShareResponse Int Source #

The response's http status code.