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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Synopsis

data ProvisionProduct = ProvisionProduct' {
- acceptLanguage :: Maybe Text
- notificationArns :: Maybe [Text]
- pathId :: Maybe Text
- pathName :: Maybe Text
- productId :: Maybe Text
- productName :: Maybe Text
- provisioningArtifactId :: Maybe Text
- provisioningArtifactName :: Maybe Text
- provisioningParameters :: Maybe [ProvisioningParameter]
- provisioningPreferences :: Maybe ProvisioningPreferences
- tags :: Maybe [Tag]
- provisionedProductName :: Text
- provisionToken :: Text
}
newProvisionProduct :: Text -> Text -> ProvisionProduct
provisionProduct_acceptLanguage :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_notificationArns :: Lens' ProvisionProduct (Maybe [Text])
provisionProduct_pathId :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_pathName :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_productId :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_productName :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_provisioningArtifactId :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_provisioningArtifactName :: Lens' ProvisionProduct (Maybe Text)
provisionProduct_provisioningParameters :: Lens' ProvisionProduct (Maybe [ProvisioningParameter])
provisionProduct_provisioningPreferences :: Lens' ProvisionProduct (Maybe ProvisioningPreferences)
provisionProduct_tags :: Lens' ProvisionProduct (Maybe [Tag])
provisionProduct_provisionedProductName :: Lens' ProvisionProduct Text
provisionProduct_provisionToken :: Lens' ProvisionProduct Text
data ProvisionProductResponse = ProvisionProductResponse' {
- recordDetail :: Maybe RecordDetail
- httpStatus :: Int
}
newProvisionProductResponse :: Int -> ProvisionProductResponse
provisionProductResponse_recordDetail :: Lens' ProvisionProductResponse (Maybe RecordDetail)
provisionProductResponse_httpStatus :: Lens' ProvisionProductResponse Int

Creating a Request

data ProvisionProduct Source #

See: newProvisionProduct smart constructor.

Constructors

ProvisionProduct'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
notificationArns :: Maybe [Text]
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
pathId :: Maybe Text
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
pathName :: Maybe Text
The name of the path. You must provide the name or ID, but not both.
productId :: Maybe Text
The product identifier. You must provide the name or ID, but not both.
productName :: Maybe Text
The name of the product. You must provide the name or ID, but not both.
provisioningArtifactId :: Maybe Text
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
provisioningArtifactName :: Maybe Text
The name of the provisioning artifact. You must provide the name or ID, but not both.
provisioningParameters :: Maybe [ProvisioningParameter]
Parameters specified by the administrator that are required for provisioning the product.
provisioningPreferences :: Maybe ProvisioningPreferences
An object that contains information about the provisioning preferences for a stack set.
tags :: Maybe [Tag]
One or more tags.
provisionedProductName :: Text
A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.
provisionToken :: Text
An idempotency token that uniquely identifies the provisioning request.

Instances

Instances details

ToJSON ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods toJSON :: ProvisionProduct -> Value # toEncoding :: ProvisionProduct -> Encoding # toJSONList :: [ProvisionProduct] -> Value # toEncodingList :: [ProvisionProduct] -> Encoding #
ToHeaders ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods toHeaders :: ProvisionProduct -> [Header] #
ToPath ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods toPath :: ProvisionProduct -> ByteString #
ToQuery ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods toQuery :: ProvisionProduct -> QueryString #
AWSRequest ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Associated Types type AWSResponse ProvisionProduct # Methods request :: (Service -> Service) -> ProvisionProduct -> Request ProvisionProduct # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ProvisionProduct -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ProvisionProduct))) #
Generic ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Associated Types type Rep ProvisionProduct :: Type -> Type # Methods from :: ProvisionProduct -> Rep ProvisionProduct x # to :: Rep ProvisionProduct x -> ProvisionProduct #
Read ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods readsPrec :: Int -> ReadS ProvisionProduct # readList :: ReadS [ProvisionProduct] # readPrec :: ReadPrec ProvisionProduct # readListPrec :: ReadPrec [ProvisionProduct] #
Show ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods showsPrec :: Int -> ProvisionProduct -> ShowS # show :: ProvisionProduct -> String # showList :: [ProvisionProduct] -> ShowS #
NFData ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods rnf :: ProvisionProduct -> () #
Eq ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods (==) :: ProvisionProduct -> ProvisionProduct -> Bool # (/=) :: ProvisionProduct -> ProvisionProduct -> Bool #
Hashable ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct Methods hashWithSalt :: Int -> ProvisionProduct -> Int # hash :: ProvisionProduct -> Int #
type AWSResponse ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct type AWSResponse ProvisionProduct = ProvisionProductResponse
type Rep ProvisionProduct Source #
Instance details Defined in Amazonka.ServiceCatalog.ProvisionProduct type Rep ProvisionProduct = D1 ('MetaData "ProvisionProduct" "Amazonka.ServiceCatalog.ProvisionProduct" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "ProvisionProduct'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "notificationArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "pathId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "pathName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "productName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "provisioningArtifactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "provisioningArtifactName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "provisioningParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProvisioningParameter])))) :: ((S1 ('MetaSel ('Just "provisioningPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningPreferences)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "provisionedProductName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "provisionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newProvisionProduct Source #

Arguments

:: Text	`ProvisionProduct`
-> Text	`$sel:provisionToken:ProvisionProduct'`
-> ProvisionProduct

Create a value of ProvisionProduct 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:ProvisionProduct', provisionProduct_acceptLanguage - The language code.

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

ProvisionProduct, provisionProduct_notificationArns - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

ProvisionProduct, provisionProduct_pathId - The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

$sel:pathName:ProvisionProduct', provisionProduct_pathName - The name of the path. You must provide the name or ID, but not both.

ProvisionProduct, provisionProduct_productId - The product identifier. You must provide the name or ID, but not both.

ProvisionProduct, provisionProduct_productName - The name of the product. You must provide the name or ID, but not both.

ProvisionProduct, provisionProduct_provisioningArtifactId - The identifier of the provisioning artifact. You must provide the name or ID, but not both.

ProvisionProduct, provisionProduct_provisioningArtifactName - The name of the provisioning artifact. You must provide the name or ID, but not both.

ProvisionProduct, provisionProduct_provisioningParameters - Parameters specified by the administrator that are required for provisioning the product.

$sel:provisioningPreferences:ProvisionProduct', provisionProduct_provisioningPreferences - An object that contains information about the provisioning preferences for a stack set.

ProvisionProduct, provisionProduct_tags - One or more tags.

ProvisionProduct, provisionProduct_provisionedProductName - A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

$sel:provisionToken:ProvisionProduct', provisionProduct_provisionToken - An idempotency token that uniquely identifies the provisioning request.

Request Lenses

provisionProduct_acceptLanguage :: Lens' ProvisionProduct (Maybe Text) Source #

The language code.

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

provisionProduct_notificationArns :: Lens' ProvisionProduct (Maybe [Text]) Source #

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

provisionProduct_pathId :: Lens' ProvisionProduct (Maybe Text) Source #

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

provisionProduct_pathName :: Lens' ProvisionProduct (Maybe Text) Source #

The name of the path. You must provide the name or ID, but not both.

provisionProduct_productId :: Lens' ProvisionProduct (Maybe Text) Source #

The product identifier. You must provide the name or ID, but not both.

provisionProduct_productName :: Lens' ProvisionProduct (Maybe Text) Source #

The name of the product. You must provide the name or ID, but not both.

provisionProduct_provisioningArtifactId :: Lens' ProvisionProduct (Maybe Text) Source #

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

provisionProduct_provisioningArtifactName :: Lens' ProvisionProduct (Maybe Text) Source #

The name of the provisioning artifact. You must provide the name or ID, but not both.

provisionProduct_provisioningParameters :: Lens' ProvisionProduct (Maybe [ProvisioningParameter]) Source #

Parameters specified by the administrator that are required for provisioning the product.

provisionProduct_provisioningPreferences :: Lens' ProvisionProduct (Maybe ProvisioningPreferences) Source #

An object that contains information about the provisioning preferences for a stack set.

provisionProduct_tags :: Lens' ProvisionProduct (Maybe [Tag]) Source #

One or more tags.

provisionProduct_provisionedProductName :: Lens' ProvisionProduct Text Source #

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

provisionProduct_provisionToken :: Lens' ProvisionProduct Text Source #

An idempotency token that uniquely identifies the provisioning request.

Destructuring the Response

data ProvisionProductResponse Source #

See: newProvisionProductResponse smart constructor.

Constructors

ProvisionProductResponse'
Fields recordDetail :: Maybe RecordDetail Information about the result of provisioning the product. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newProvisionProductResponse Source #

Arguments

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

Create a value of ProvisionProductResponse 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:recordDetail:ProvisionProductResponse', provisionProductResponse_recordDetail - Information about the result of provisioning the product.

$sel:httpStatus:ProvisionProductResponse', provisionProductResponse_httpStatus - The response's http status code.

Response Lenses

provisionProductResponse_recordDetail :: Lens' ProvisionProductResponse (Maybe RecordDetail) Source #

Information about the result of provisioning the product.

provisionProductResponse_httpStatus :: Lens' ProvisionProductResponse Int Source #

The response's http status code.