1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package ses
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/ses/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Returns the details of the specified receipt rule. For information about setting
15// up receipt rules, see the Amazon SES Developer Guide
16// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html).
17// You can execute this operation no more than once per second.
18func (c *Client) DescribeReceiptRule(ctx context.Context, params *DescribeReceiptRuleInput, optFns ...func(*Options)) (*DescribeReceiptRuleOutput, error) {
19	if params == nil {
20		params = &DescribeReceiptRuleInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "DescribeReceiptRule", params, optFns, addOperationDescribeReceiptRuleMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*DescribeReceiptRuleOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33// Represents a request to return the details of a receipt rule. You use receipt
34// rules to receive email with Amazon SES. For more information, see the Amazon SES
35// Developer Guide
36// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html).
37type DescribeReceiptRuleInput struct {
38
39	// The name of the receipt rule.
40	//
41	// This member is required.
42	RuleName *string
43
44	// The name of the receipt rule set that the receipt rule belongs to.
45	//
46	// This member is required.
47	RuleSetName *string
48}
49
50// Represents the details of a receipt rule.
51type DescribeReceiptRuleOutput struct {
52
53	// A data structure that contains the specified receipt rule's name, actions,
54	// recipients, domains, enabled status, scan status, and Transport Layer Security
55	// (TLS) policy.
56	Rule *types.ReceiptRule
57
58	// Metadata pertaining to the operation's result.
59	ResultMetadata middleware.Metadata
60}
61
62func addOperationDescribeReceiptRuleMiddlewares(stack *middleware.Stack, options Options) (err error) {
63	err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeReceiptRule{}, middleware.After)
64	if err != nil {
65		return err
66	}
67	err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeReceiptRule{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	if err = addSetLoggerMiddleware(stack, options); err != nil {
72		return err
73	}
74	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
75		return err
76	}
77	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
78		return err
79	}
80	if err = addResolveEndpointMiddleware(stack, options); err != nil {
81		return err
82	}
83	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
84		return err
85	}
86	if err = addRetryMiddlewares(stack, options); err != nil {
87		return err
88	}
89	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
90		return err
91	}
92	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
96		return err
97	}
98	if err = addClientUserAgent(stack); err != nil {
99		return err
100	}
101	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
105		return err
106	}
107	if err = addOpDescribeReceiptRuleValidationMiddleware(stack); err != nil {
108		return err
109	}
110	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeReceiptRule(options.Region), middleware.Before); err != nil {
111		return err
112	}
113	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
114		return err
115	}
116	if err = addResponseErrorMiddleware(stack); err != nil {
117		return err
118	}
119	if err = addRequestResponseLogging(stack, options); err != nil {
120		return err
121	}
122	return nil
123}
124
125func newServiceMetadataMiddleware_opDescribeReceiptRule(region string) *awsmiddleware.RegisterServiceMetadata {
126	return &awsmiddleware.RegisterServiceMetadata{
127		Region:        region,
128		ServiceID:     ServiceID,
129		SigningName:   "ses",
130		OperationName: "DescribeReceiptRule",
131	}
132}
133