Network.AWS.ServiceCatalog.DescribeProvisioningParameters

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

Creating a Request

describeProvisioningParameters

Arguments

:: Text

dppsProductId

-> Text

dppsProvisioningArtifactId

-> DescribeProvisioningParameters

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

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

• dppsAcceptLanguage - 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.
• dppsPathId - 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.
• dppsProductId - The product identifier.
• dppsProvisioningArtifactId - The provisioning artifact identifier for this product.

data DescribeProvisioningParameters

See: describeProvisioningParameters smart constructor.

Instances

Eq DescribeProvisioningParameters

Methods

(==) :: DescribeProvisioningParameters -> DescribeProvisioningParameters -> Bool

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

Data DescribeProvisioningParameters

Methods

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

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

toConstr :: DescribeProvisioningParameters -> Constr

dataTypeOf :: DescribeProvisioningParameters -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeProvisioningParameters

Methods

readsPrec :: Int -> ReadS DescribeProvisioningParameters

readList :: ReadS [DescribeProvisioningParameters]

readPrec :: ReadPrec DescribeProvisioningParameters

readListPrec :: ReadPrec [DescribeProvisioningParameters]

Show DescribeProvisioningParameters

Methods

showsPrec :: Int -> DescribeProvisioningParameters -> ShowS

show :: DescribeProvisioningParameters -> String

showList :: [DescribeProvisioningParameters] -> ShowS

Generic DescribeProvisioningParameters

Associated Types

type Rep DescribeProvisioningParameters :: * -> *

Methods

from :: DescribeProvisioningParameters -> Rep DescribeProvisioningParameters x

to :: Rep DescribeProvisioningParameters x -> DescribeProvisioningParameters

Hashable DescribeProvisioningParameters

Methods

hashWithSalt :: Int -> DescribeProvisioningParameters -> Int

hash :: DescribeProvisioningParameters -> Int

ToJSON DescribeProvisioningParameters

Methods

toJSON :: DescribeProvisioningParameters -> Value

toEncoding :: DescribeProvisioningParameters -> Encoding

toJSONList :: [DescribeProvisioningParameters] -> Value

toEncodingList :: [DescribeProvisioningParameters] -> Encoding

NFData DescribeProvisioningParameters

Methods

rnf :: DescribeProvisioningParameters -> ()

AWSRequest DescribeProvisioningParameters

Associated Types

type Rs DescribeProvisioningParameters :: *

Methods

request :: DescribeProvisioningParameters -> Request DescribeProvisioningParameters

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

ToPath DescribeProvisioningParameters

Methods

toPath :: DescribeProvisioningParameters -> ByteString

ToHeaders DescribeProvisioningParameters

Methods

toHeaders :: DescribeProvisioningParameters -> [Header]

ToQuery DescribeProvisioningParameters

Methods

toQuery :: DescribeProvisioningParameters -> QueryString

type Rep DescribeProvisioningParameters

type Rep DescribeProvisioningParameters = D1 (MetaData "DescribeProvisioningParameters" "Network.AWS.ServiceCatalog.DescribeProvisioningParameters" "amazonka-servicecatalog-1.4.5-8bdJVEiVZ77jaeUaDycc5" False) (C1 (MetaCons "DescribeProvisioningParameters'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dppsAcceptLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dppsPathId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dppsProductId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dppsProvisioningArtifactId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DescribeProvisioningParameters

type Rs DescribeProvisioningParameters = DescribeProvisioningParametersResponse

Request Lenses

dppsAcceptLanguage :: Lens' DescribeProvisioningParameters (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.

dppsPathId :: Lens' DescribeProvisioningParameters (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.

dppsProductId :: Lens' DescribeProvisioningParameters Text

The product identifier.

dppsProvisioningArtifactId :: Lens' DescribeProvisioningParameters Text

The provisioning artifact identifier for this product.

Destructuring the Response

describeProvisioningParametersResponse

Arguments

:: Int

dpprsResponseStatus

-> DescribeProvisioningParametersResponse

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

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

• dpprsProvisioningArtifactParameters - The list of parameters used to successfully provision the product. Each parameter includes a list of allowable values and additional metadata about each parameter.
• dpprsUsageInstructions - Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.
• dpprsConstraintSummaries - The list of constraint summaries that apply to provisioning this product.
• dpprsResponseStatus - -- | The response status code.

data DescribeProvisioningParametersResponse

See: describeProvisioningParametersResponse smart constructor.

Instances

Eq DescribeProvisioningParametersResponse

Methods

(==) :: DescribeProvisioningParametersResponse -> DescribeProvisioningParametersResponse -> Bool

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

Data DescribeProvisioningParametersResponse

Methods

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

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

toConstr :: DescribeProvisioningParametersResponse -> Constr

dataTypeOf :: DescribeProvisioningParametersResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeProvisioningParametersResponse

Methods

readsPrec :: Int -> ReadS DescribeProvisioningParametersResponse

readList :: ReadS [DescribeProvisioningParametersResponse]

readPrec :: ReadPrec DescribeProvisioningParametersResponse

readListPrec :: ReadPrec [DescribeProvisioningParametersResponse]

Show DescribeProvisioningParametersResponse

Methods

showsPrec :: Int -> DescribeProvisioningParametersResponse -> ShowS

show :: DescribeProvisioningParametersResponse -> String

showList :: [DescribeProvisioningParametersResponse] -> ShowS

Generic DescribeProvisioningParametersResponse

Associated Types

type Rep DescribeProvisioningParametersResponse :: * -> *

Methods

from :: DescribeProvisioningParametersResponse -> Rep DescribeProvisioningParametersResponse x

to :: Rep DescribeProvisioningParametersResponse x -> DescribeProvisioningParametersResponse

NFData DescribeProvisioningParametersResponse

Methods

rnf :: DescribeProvisioningParametersResponse -> ()

type Rep DescribeProvisioningParametersResponse

type Rep DescribeProvisioningParametersResponse = D1 (MetaData "DescribeProvisioningParametersResponse" "Network.AWS.ServiceCatalog.DescribeProvisioningParameters" "amazonka-servicecatalog-1.4.5-8bdJVEiVZ77jaeUaDycc5" False) (C1 (MetaCons "DescribeProvisioningParametersResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dpprsProvisioningArtifactParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ProvisioningArtifactParameter]))) (S1 (MetaSel (Just Symbol "_dpprsUsageInstructions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsageInstruction])))) ((:*:) (S1 (MetaSel (Just Symbol "_dpprsConstraintSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ConstraintSummary]))) (S1 (MetaSel (Just Symbol "_dpprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dpprsProvisioningArtifactParameters :: Lens' DescribeProvisioningParametersResponse [ProvisioningArtifactParameter]

The list of parameters used to successfully provision the product. Each parameter includes a list of allowable values and additional metadata about each parameter.

dpprsUsageInstructions :: Lens' DescribeProvisioningParametersResponse [UsageInstruction]

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

dpprsConstraintSummaries :: Lens' DescribeProvisioningParametersResponse [ConstraintSummary]

The list of constraint summaries that apply to provisioning this product.

dpprsResponseStatus :: Lens' DescribeProvisioningParametersResponse Int

• - | The response status code.