1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package servicecatalog
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/servicecatalog/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Gets information about the configuration required to provision the specified
15// product using the specified provisioning artifact. If the output contains a
16// TagOption key with an empty list of values, there is a TagOption conflict for
17// that key. The end user cannot take action to fix the conflict, and launch is not
18// blocked. In subsequent calls to ProvisionProduct, do not include conflicted
19// TagOption keys as tags, or this causes the error "Parameter validation failed:
20// Missing required parameter in Tags[N]:Value". Tag the provisioned product with
21// the value sc-tagoption-conflict-portfolioId-productId.
22func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *DescribeProvisioningParametersInput, optFns ...func(*Options)) (*DescribeProvisioningParametersOutput, error) {
23	if params == nil {
24		params = &DescribeProvisioningParametersInput{}
25	}
26
27	result, metadata, err := c.invokeOperation(ctx, "DescribeProvisioningParameters", params, optFns, c.addOperationDescribeProvisioningParametersMiddlewares)
28	if err != nil {
29		return nil, err
30	}
31
32	out := result.(*DescribeProvisioningParametersOutput)
33	out.ResultMetadata = metadata
34	return out, nil
35}
36
37type DescribeProvisioningParametersInput struct {
38
39	// The language code.
40	//
41	// * en - English (default)
42	//
43	// * jp - Japanese
44	//
45	// * zh - Chinese
46	AcceptLanguage *string
47
48	// The path identifier of the product. This value is optional if the product has a
49	// default path, and required if the product has more than one path. To list the
50	// paths for a product, use ListLaunchPaths. You must provide the name or ID, but
51	// not both.
52	PathId *string
53
54	// The name of the path. You must provide the name or ID, but not both.
55	PathName *string
56
57	// The product identifier. You must provide the product name or ID, but not both.
58	ProductId *string
59
60	// The name of the product. You must provide the name or ID, but not both.
61	ProductName *string
62
63	// The identifier of the provisioning artifact. You must provide the name or ID,
64	// but not both.
65	ProvisioningArtifactId *string
66
67	// The name of the provisioning artifact. You must provide the name or ID, but not
68	// both.
69	ProvisioningArtifactName *string
70
71	noSmithyDocumentSerde
72}
73
74type DescribeProvisioningParametersOutput struct {
75
76	// Information about the constraints used to provision the product.
77	ConstraintSummaries []types.ConstraintSummary
78
79	// The output of the provisioning artifact.
80	ProvisioningArtifactOutputs []types.ProvisioningArtifactOutput
81
82	// Information about the parameters used to provision the product.
83	ProvisioningArtifactParameters []types.ProvisioningArtifactParameter
84
85	// An object that contains information about preferences, such as regions and
86	// accounts, for the provisioning artifact.
87	ProvisioningArtifactPreferences *types.ProvisioningArtifactPreferences
88
89	// Information about the TagOptions associated with the resource.
90	TagOptions []types.TagOptionSummary
91
92	// Any additional metadata specifically related to the provisioning of the product.
93	// For example, see the Version field of the CloudFormation template.
94	UsageInstructions []types.UsageInstruction
95
96	// Metadata pertaining to the operation's result.
97	ResultMetadata middleware.Metadata
98
99	noSmithyDocumentSerde
100}
101
102func (c *Client) addOperationDescribeProvisioningParametersMiddlewares(stack *middleware.Stack, options Options) (err error) {
103	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeProvisioningParameters{}, middleware.After)
104	if err != nil {
105		return err
106	}
107	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeProvisioningParameters{}, middleware.After)
108	if err != nil {
109		return err
110	}
111	if err = addSetLoggerMiddleware(stack, options); err != nil {
112		return err
113	}
114	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addResolveEndpointMiddleware(stack, options); err != nil {
121		return err
122	}
123	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
124		return err
125	}
126	if err = addRetryMiddlewares(stack, options); err != nil {
127		return err
128	}
129	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
130		return err
131	}
132	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
133		return err
134	}
135	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
136		return err
137	}
138	if err = addClientUserAgent(stack); err != nil {
139		return err
140	}
141	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
142		return err
143	}
144	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
145		return err
146	}
147	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeProvisioningParameters(options.Region), middleware.Before); err != nil {
148		return err
149	}
150	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
151		return err
152	}
153	if err = addResponseErrorMiddleware(stack); err != nil {
154		return err
155	}
156	if err = addRequestResponseLogging(stack, options); err != nil {
157		return err
158	}
159	return nil
160}
161
162func newServiceMetadataMiddleware_opDescribeProvisioningParameters(region string) *awsmiddleware.RegisterServiceMetadata {
163	return &awsmiddleware.RegisterServiceMetadata{
164		Region:        region,
165		ServiceID:     ServiceID,
166		SigningName:   "servicecatalog",
167		OperationName: "DescribeProvisioningParameters",
168	}
169}
170