Network.AWS.ServiceCatalog.ProvisionProduct

Requests a Provision of a specified product. A ProvisionedProduct is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation.

Creating a Request

provisionProduct

Arguments

:: Text

ppProductId

-> Text

ppProvisioningArtifactId

-> Text

ppProvisionedProductName

-> Text

ppProvisionToken

-> ProvisionProduct

Creates a value of ProvisionProduct with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ppNotificationARNs - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
• ppAcceptLanguage - The language code to use for this operation. Supported language codes are as follows: "en" (English) "jp" (Japanese) "zh" (Chinese) If no code is specified, "en" is used as the default.
• ppPathId - The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
• ppProvisioningParameters - Parameters specified by the administrator that are required for provisioning the product.
• ppTags - A list of tags to use as provisioning options.
• ppProductId - The product identifier.
• ppProvisioningArtifactId - The provisioning artifact identifier for this product.
• ppProvisionedProductName - A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned.
• ppProvisionToken - An idempotency token that uniquely identifies the provisioning request.

data ProvisionProduct

See: provisionProduct smart constructor.

Instances

Eq ProvisionProduct

Methods

(==) :: ProvisionProduct -> ProvisionProduct -> Bool

(/=) :: ProvisionProduct -> ProvisionProduct -> Bool

Data ProvisionProduct

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProvisionProduct -> c ProvisionProduct

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProvisionProduct

toConstr :: ProvisionProduct -> Constr

dataTypeOf :: ProvisionProduct -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProvisionProduct)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProvisionProduct)

gmapT :: (forall b. Data b => b -> b) -> ProvisionProduct -> ProvisionProduct

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionProduct -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionProduct -> r

gmapQ :: (forall d. Data d => d -> u) -> ProvisionProduct -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProvisionProduct -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProvisionProduct -> m ProvisionProduct

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionProduct -> m ProvisionProduct

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionProduct -> m ProvisionProduct

Read ProvisionProduct

Methods

readsPrec :: Int -> ReadS ProvisionProduct

readList :: ReadS [ProvisionProduct]

readPrec :: ReadPrec ProvisionProduct

readListPrec :: ReadPrec [ProvisionProduct]

Show ProvisionProduct

Methods

showsPrec :: Int -> ProvisionProduct -> ShowS

show :: ProvisionProduct -> String

showList :: [ProvisionProduct] -> ShowS

Generic ProvisionProduct

Associated Types

type Rep ProvisionProduct :: * -> *

Methods

from :: ProvisionProduct -> Rep ProvisionProduct x

to :: Rep ProvisionProduct x -> ProvisionProduct

Hashable ProvisionProduct

Methods

hashWithSalt :: Int -> ProvisionProduct -> Int

hash :: ProvisionProduct -> Int

ToJSON ProvisionProduct

Methods

toJSON :: ProvisionProduct -> Value

toEncoding :: ProvisionProduct -> Encoding

toJSONList :: [ProvisionProduct] -> Value

toEncodingList :: [ProvisionProduct] -> Encoding

NFData ProvisionProduct

Methods

rnf :: ProvisionProduct -> ()

AWSRequest ProvisionProduct

Associated Types

type Rs ProvisionProduct :: *

Methods

request :: ProvisionProduct -> Request ProvisionProduct

response :: MonadResource m => Logger -> Service -> Proxy * ProvisionProduct -> ClientResponse -> m (Response ProvisionProduct)

ToPath ProvisionProduct

Methods

toPath :: ProvisionProduct -> ByteString

ToHeaders ProvisionProduct

Methods

toHeaders :: ProvisionProduct -> [Header]

ToQuery ProvisionProduct

Methods

toQuery :: ProvisionProduct -> QueryString

type Rep ProvisionProduct

type Rep ProvisionProduct = D1 (MetaData "ProvisionProduct" "Network.AWS.ServiceCatalog.ProvisionProduct" "amazonka-servicecatalog-1.4.5-8bdJVEiVZ77jaeUaDycc5" False) (C1 (MetaCons "ProvisionProduct'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ppNotificationARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_ppAcceptLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ppPathId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ppProvisioningParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ProvisioningParameter]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ppTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) (S1 (MetaSel (Just Symbol "_ppProductId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ppProvisioningArtifactId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_ppProvisionedProductName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ppProvisionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs ProvisionProduct

type Rs ProvisionProduct = ProvisionProductResponse

Request Lenses

ppNotificationARNs :: Lens' ProvisionProduct [Text]

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

ppAcceptLanguage :: Lens' ProvisionProduct (Maybe Text)

The language code to use for this operation. Supported language codes are as follows: "en" (English) "jp" (Japanese) "zh" (Chinese) If no code is specified, "en" is used as the default.

ppPathId :: Lens' ProvisionProduct (Maybe Text)

The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

ppProvisioningParameters :: Lens' ProvisionProduct [ProvisioningParameter]

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

ppTags :: Lens' ProvisionProduct [Tag]

A list of tags to use as provisioning options.

ppProductId :: Lens' ProvisionProduct Text

The product identifier.

ppProvisioningArtifactId :: Lens' ProvisionProduct Text

The provisioning artifact identifier for this product.

ppProvisionedProductName :: Lens' ProvisionProduct Text

A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

ppProvisionToken :: Lens' ProvisionProduct Text

An idempotency token that uniquely identifies the provisioning request.

Destructuring the Response

provisionProductResponse

Arguments

:: Int

pprsResponseStatus

-> ProvisionProductResponse

Creates a value of ProvisionProductResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pprsRecordDetail - The detailed result of the ProvisionProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object of the request, and a list of any errors that the request encountered.
• pprsResponseStatus - -- | The response status code.

data ProvisionProductResponse

See: provisionProductResponse smart constructor.

Instances

Eq ProvisionProductResponse

Methods

(==) :: ProvisionProductResponse -> ProvisionProductResponse -> Bool

(/=) :: ProvisionProductResponse -> ProvisionProductResponse -> Bool

Data ProvisionProductResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProvisionProductResponse -> c ProvisionProductResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProvisionProductResponse

toConstr :: ProvisionProductResponse -> Constr

dataTypeOf :: ProvisionProductResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProvisionProductResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProvisionProductResponse)

gmapT :: (forall b. Data b => b -> b) -> ProvisionProductResponse -> ProvisionProductResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionProductResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionProductResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ProvisionProductResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProvisionProductResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProvisionProductResponse -> m ProvisionProductResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionProductResponse -> m ProvisionProductResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionProductResponse -> m ProvisionProductResponse

Read ProvisionProductResponse

Methods

readsPrec :: Int -> ReadS ProvisionProductResponse

readList :: ReadS [ProvisionProductResponse]

readPrec :: ReadPrec ProvisionProductResponse

readListPrec :: ReadPrec [ProvisionProductResponse]

Show ProvisionProductResponse

Methods

showsPrec :: Int -> ProvisionProductResponse -> ShowS

show :: ProvisionProductResponse -> String

showList :: [ProvisionProductResponse] -> ShowS

Generic ProvisionProductResponse

Associated Types

type Rep ProvisionProductResponse :: * -> *

Methods

from :: ProvisionProductResponse -> Rep ProvisionProductResponse x

to :: Rep ProvisionProductResponse x -> ProvisionProductResponse

NFData ProvisionProductResponse

Methods

rnf :: ProvisionProductResponse -> ()

type Rep ProvisionProductResponse

type Rep ProvisionProductResponse = D1 (MetaData "ProvisionProductResponse" "Network.AWS.ServiceCatalog.ProvisionProduct" "amazonka-servicecatalog-1.4.5-8bdJVEiVZ77jaeUaDycc5" False) (C1 (MetaCons "ProvisionProductResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_pprsRecordDetail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RecordDetail))) (S1 (MetaSel (Just Symbol "_pprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

pprsRecordDetail :: Lens' ProvisionProductResponse (Maybe RecordDetail)

The detailed result of the ProvisionProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object of the request, and a list of any errors that the request encountered.

pprsResponseStatus :: Lens' ProvisionProductResponse Int

• - | The response status code.