1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package personalize
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/personalize/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Describes the given campaign, including its status. A campaign can be in one of
15// the following states:
16//
17// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or-
18// CREATE FAILED
19//
20// * DELETE PENDING > DELETE IN_PROGRESS
21//
22// When the status is CREATE
23// FAILED, the response includes the failureReason key, which describes why. For
24// more information on campaigns, see CreateCampaign.
25func (c *Client) DescribeCampaign(ctx context.Context, params *DescribeCampaignInput, optFns ...func(*Options)) (*DescribeCampaignOutput, error) {
26	if params == nil {
27		params = &DescribeCampaignInput{}
28	}
29
30	result, metadata, err := c.invokeOperation(ctx, "DescribeCampaign", params, optFns, addOperationDescribeCampaignMiddlewares)
31	if err != nil {
32		return nil, err
33	}
34
35	out := result.(*DescribeCampaignOutput)
36	out.ResultMetadata = metadata
37	return out, nil
38}
39
40type DescribeCampaignInput struct {
41
42	// The Amazon Resource Name (ARN) of the campaign.
43	//
44	// This member is required.
45	CampaignArn *string
46}
47
48type DescribeCampaignOutput struct {
49
50	// The properties of the campaign.
51	Campaign *types.Campaign
52
53	// Metadata pertaining to the operation's result.
54	ResultMetadata middleware.Metadata
55}
56
57func addOperationDescribeCampaignMiddlewares(stack *middleware.Stack, options Options) (err error) {
58	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeCampaign{}, middleware.After)
59	if err != nil {
60		return err
61	}
62	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeCampaign{}, middleware.After)
63	if err != nil {
64		return err
65	}
66	if err = addSetLoggerMiddleware(stack, options); err != nil {
67		return err
68	}
69	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
70		return err
71	}
72	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
73		return err
74	}
75	if err = addResolveEndpointMiddleware(stack, options); err != nil {
76		return err
77	}
78	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
79		return err
80	}
81	if err = addRetryMiddlewares(stack, options); err != nil {
82		return err
83	}
84	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
85		return err
86	}
87	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
91		return err
92	}
93	if err = addClientUserAgent(stack); err != nil {
94		return err
95	}
96	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
97		return err
98	}
99	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
100		return err
101	}
102	if err = addOpDescribeCampaignValidationMiddleware(stack); err != nil {
103		return err
104	}
105	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeCampaign(options.Region), middleware.Before); err != nil {
106		return err
107	}
108	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
109		return err
110	}
111	if err = addResponseErrorMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addRequestResponseLogging(stack, options); err != nil {
115		return err
116	}
117	return nil
118}
119
120func newServiceMetadataMiddleware_opDescribeCampaign(region string) *awsmiddleware.RegisterServiceMetadata {
121	return &awsmiddleware.RegisterServiceMetadata{
122		Region:        region,
123		ServiceID:     ServiceID,
124		SigningName:   "personalize",
125		OperationName: "DescribeCampaign",
126	}
127}
128