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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Synopsis

Creating a Request

data DescribeProvisioningParameters Source #

See: newDescribeProvisioningParameters smart constructor.

Constructors

DescribeProvisioningParameters'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
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 product 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.

Instances

Instances details

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

newDescribeProvisioningParameters :: DescribeProvisioningParameters Source #

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

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

DescribeProvisioningParameters, describeProvisioningParameters_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:DescribeProvisioningParameters', describeProvisioningParameters_pathName - The name of the path. You must provide the name or ID, but not both.

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

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

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

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

Request Lenses

describeProvisioningParameters_acceptLanguage :: Lens' DescribeProvisioningParameters (Maybe Text) Source #

The language code.

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

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

describeProvisioningParameters_pathName :: Lens' DescribeProvisioningParameters (Maybe Text) Source #

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

describeProvisioningParameters_productId :: Lens' DescribeProvisioningParameters (Maybe Text) Source #

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

describeProvisioningParameters_productName :: Lens' DescribeProvisioningParameters (Maybe Text) Source #

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

describeProvisioningParameters_provisioningArtifactId :: Lens' DescribeProvisioningParameters (Maybe Text) Source #

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

describeProvisioningParameters_provisioningArtifactName :: Lens' DescribeProvisioningParameters (Maybe Text) Source #

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

Destructuring the Response

data DescribeProvisioningParametersResponse Source #

See: newDescribeProvisioningParametersResponse smart constructor.

Constructors

DescribeProvisioningParametersResponse'

Fields

constraintSummaries :: Maybe [ConstraintSummary]
Information about the constraints used to provision the product.
provisioningArtifactOutputKeys :: Maybe [ProvisioningArtifactOutput]
A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
provisioningArtifactOutputs :: Maybe [ProvisioningArtifactOutput]
The output of the provisioning artifact.
provisioningArtifactParameters :: Maybe [ProvisioningArtifactParameter]
Information about the parameters used to provision the product.
provisioningArtifactPreferences :: Maybe ProvisioningArtifactPreferences
An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.
tagOptions :: Maybe [TagOptionSummary]
Information about the TagOptions associated with the resource.
usageInstructions :: Maybe [UsageInstruction]
Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeProvisioningParametersResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeProvisioningParameters Associated Types type Rep DescribeProvisioningParametersResponse :: Type -> Type # Methods from :: DescribeProvisioningParametersResponse -> Rep DescribeProvisioningParametersResponse x # to :: Rep DescribeProvisioningParametersResponse x -> DescribeProvisioningParametersResponse #
Read DescribeProvisioningParametersResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeProvisioningParameters Methods readsPrec :: Int -> ReadS DescribeProvisioningParametersResponse # readList :: ReadS [DescribeProvisioningParametersResponse] # readPrec :: ReadPrec DescribeProvisioningParametersResponse # readListPrec :: ReadPrec [DescribeProvisioningParametersResponse] #
Show DescribeProvisioningParametersResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeProvisioningParameters Methods showsPrec :: Int -> DescribeProvisioningParametersResponse -> ShowS # show :: DescribeProvisioningParametersResponse -> String # showList :: [DescribeProvisioningParametersResponse] -> ShowS #
NFData DescribeProvisioningParametersResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeProvisioningParameters Methods rnf :: DescribeProvisioningParametersResponse -> () #
Eq DescribeProvisioningParametersResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeProvisioningParameters Methods (==) :: DescribeProvisioningParametersResponse -> DescribeProvisioningParametersResponse -> Bool # (/=) :: DescribeProvisioningParametersResponse -> DescribeProvisioningParametersResponse -> Bool #
type Rep DescribeProvisioningParametersResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeProvisioningParameters type Rep DescribeProvisioningParametersResponse = D1 ('MetaData "DescribeProvisioningParametersResponse" "Amazonka.ServiceCatalog.DescribeProvisioningParameters" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "DescribeProvisioningParametersResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "constraintSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConstraintSummary])) :: S1 ('MetaSel ('Just "provisioningArtifactOutputKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProvisioningArtifactOutput]))) :: (S1 ('MetaSel ('Just "provisioningArtifactOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProvisioningArtifactOutput])) :: S1 ('MetaSel ('Just "provisioningArtifactParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProvisioningArtifactParameter])))) :: ((S1 ('MetaSel ('Just "provisioningArtifactPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningArtifactPreferences)) :: S1 ('MetaSel ('Just "tagOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagOptionSummary]))) :: (S1 ('MetaSel ('Just "usageInstructions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsageInstruction])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeProvisioningParametersResponse Source #

Arguments

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

Create a value of DescribeProvisioningParametersResponse 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:

DescribeProvisioningParametersResponse, describeProvisioningParametersResponse_constraintSummaries - Information about the constraints used to provision the product.

$sel:provisioningArtifactOutputKeys:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_provisioningArtifactOutputKeys - A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

$sel:provisioningArtifactOutputs:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_provisioningArtifactOutputs - The output of the provisioning artifact.

$sel:provisioningArtifactParameters:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_provisioningArtifactParameters - Information about the parameters used to provision the product.

$sel:provisioningArtifactPreferences:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_provisioningArtifactPreferences - An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

$sel:tagOptions:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_tagOptions - Information about the TagOptions associated with the resource.

$sel:usageInstructions:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_usageInstructions - Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

$sel:httpStatus:DescribeProvisioningParametersResponse', describeProvisioningParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeProvisioningParametersResponse_constraintSummaries :: Lens' DescribeProvisioningParametersResponse (Maybe [ConstraintSummary]) Source #

Information about the constraints used to provision the product.

describeProvisioningParametersResponse_provisioningArtifactOutputKeys :: Lens' DescribeProvisioningParametersResponse (Maybe [ProvisioningArtifactOutput]) Source #

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

describeProvisioningParametersResponse_provisioningArtifactOutputs :: Lens' DescribeProvisioningParametersResponse (Maybe [ProvisioningArtifactOutput]) Source #

The output of the provisioning artifact.

describeProvisioningParametersResponse_provisioningArtifactParameters :: Lens' DescribeProvisioningParametersResponse (Maybe [ProvisioningArtifactParameter]) Source #

Information about the parameters used to provision the product.

describeProvisioningParametersResponse_provisioningArtifactPreferences :: Lens' DescribeProvisioningParametersResponse (Maybe ProvisioningArtifactPreferences) Source #

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

describeProvisioningParametersResponse_tagOptions :: Lens' DescribeProvisioningParametersResponse (Maybe [TagOptionSummary]) Source #

Information about the TagOptions associated with the resource.

describeProvisioningParametersResponse_usageInstructions :: Lens' DescribeProvisioningParametersResponse (Maybe [UsageInstruction]) Source #

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

describeProvisioningParametersResponse_httpStatus :: Lens' DescribeProvisioningParametersResponse Int Source #

The response's http status code.