1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package pinpointemail
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/pinpointemail/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Retrieve all the deliverability data for a specific campaign. This data is
15// available for a campaign only if the campaign sent email by using a domain that
16// the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
17// operation).
18func (c *Client) GetDomainDeliverabilityCampaign(ctx context.Context, params *GetDomainDeliverabilityCampaignInput, optFns ...func(*Options)) (*GetDomainDeliverabilityCampaignOutput, error) {
19	if params == nil {
20		params = &GetDomainDeliverabilityCampaignInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "GetDomainDeliverabilityCampaign", params, optFns, c.addOperationGetDomainDeliverabilityCampaignMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*GetDomainDeliverabilityCampaignOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33// Retrieve all the deliverability data for a specific campaign. This data is
34// available for a campaign only if the campaign sent email by using a domain that
35// the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption
36// operation).
37type GetDomainDeliverabilityCampaignInput struct {
38
39	// The unique identifier for the campaign. Amazon Pinpoint automatically generates
40	// and assigns this identifier to a campaign. This value is not the same as the
41	// campaign identifier that Amazon Pinpoint assigns to campaigns that you create
42	// and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
43	//
44	// This member is required.
45	CampaignId *string
46
47	noSmithyDocumentSerde
48}
49
50// An object that contains all the deliverability data for a specific campaign.
51// This data is available for a campaign only if the campaign sent email by using a
52// domain that the Deliverability dashboard is enabled for
53// (PutDeliverabilityDashboardOption operation).
54type GetDomainDeliverabilityCampaignOutput struct {
55
56	// An object that contains the deliverability data for the campaign.
57	//
58	// This member is required.
59	DomainDeliverabilityCampaign *types.DomainDeliverabilityCampaign
60
61	// Metadata pertaining to the operation's result.
62	ResultMetadata middleware.Metadata
63
64	noSmithyDocumentSerde
65}
66
67func (c *Client) addOperationGetDomainDeliverabilityCampaignMiddlewares(stack *middleware.Stack, options Options) (err error) {
68	err = stack.Serialize.Add(&awsRestjson1_serializeOpGetDomainDeliverabilityCampaign{}, middleware.After)
69	if err != nil {
70		return err
71	}
72	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetDomainDeliverabilityCampaign{}, middleware.After)
73	if err != nil {
74		return err
75	}
76	if err = addSetLoggerMiddleware(stack, options); err != nil {
77		return err
78	}
79	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
80		return err
81	}
82	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
83		return err
84	}
85	if err = addResolveEndpointMiddleware(stack, options); err != nil {
86		return err
87	}
88	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
89		return err
90	}
91	if err = addRetryMiddlewares(stack, options); err != nil {
92		return err
93	}
94	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
101		return err
102	}
103	if err = addClientUserAgent(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = addOpGetDomainDeliverabilityCampaignValidationMiddleware(stack); err != nil {
113		return err
114	}
115	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetDomainDeliverabilityCampaign(options.Region), middleware.Before); err != nil {
116		return err
117	}
118	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addResponseErrorMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addRequestResponseLogging(stack, options); err != nil {
125		return err
126	}
127	return nil
128}
129
130func newServiceMetadataMiddleware_opGetDomainDeliverabilityCampaign(region string) *awsmiddleware.RegisterServiceMetadata {
131	return &awsmiddleware.RegisterServiceMetadata{
132		Region:        region,
133		ServiceID:     ServiceID,
134		SigningName:   "ses",
135		OperationName: "GetDomainDeliverabilityCampaign",
136	}
137}
138