1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package wafv2
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/wafv2/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// This is the latest version of AWS WAF, named AWS WAFV2, released in November,
15// 2019. For information, including how to migrate your AWS WAF resources from the
16// prior release, see the AWS WAF Developer Guide
17// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
18// Provides high-level information for a managed rule group, including descriptions
19// of the rules.
20func (c *Client) DescribeManagedRuleGroup(ctx context.Context, params *DescribeManagedRuleGroupInput, optFns ...func(*Options)) (*DescribeManagedRuleGroupOutput, error) {
21	if params == nil {
22		params = &DescribeManagedRuleGroupInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeManagedRuleGroup", params, optFns, addOperationDescribeManagedRuleGroupMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeManagedRuleGroupOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type DescribeManagedRuleGroupInput struct {
36
37	// The name of the managed rule group. You use this, along with the vendor name, to
38	// identify the rule group.
39	//
40	// This member is required.
41	Name *string
42
43	// Specifies whether this is for an AWS CloudFront distribution or for a regional
44	// application. A regional application can be an Application Load Balancer (ALB),
45	// an API Gateway REST API, or an AppSync GraphQL API. To work with CloudFront, you
46	// must also specify the Region US East (N. Virginia) as follows:
47	//
48	// * CLI - Specify
49	// the Region when you use the CloudFront scope: --scope=CLOUDFRONT
50	// --region=us-east-1.
51	//
52	// * API and SDKs - For all calls, use the Region endpoint
53	// us-east-1.
54	//
55	// This member is required.
56	Scope types.Scope
57
58	// The name of the managed rule group vendor. You use this, along with the rule
59	// group name, to identify the rule group.
60	//
61	// This member is required.
62	VendorName *string
63}
64
65type DescribeManagedRuleGroupOutput struct {
66
67	// The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web
68	// ACL capacity units (WCU) to calculate and control the operating resources that
69	// are used to run your rules, rule groups, and web ACLs. AWS WAF calculates
70	// capacity differently for each rule type, to reflect each rule's relative cost.
71	// Rule group capacity is fixed at creation, so users can plan their web ACL WCU
72	// usage when they use a rule group. The WCU limit for web ACLs is 1,500.
73	Capacity int64
74
75	//
76	Rules []types.RuleSummary
77
78	// Metadata pertaining to the operation's result.
79	ResultMetadata middleware.Metadata
80}
81
82func addOperationDescribeManagedRuleGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
83	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeManagedRuleGroup{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeManagedRuleGroup{}, middleware.After)
88	if err != nil {
89		return err
90	}
91	if err = addSetLoggerMiddleware(stack, options); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
95		return err
96	}
97	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
98		return err
99	}
100	if err = addResolveEndpointMiddleware(stack, options); err != nil {
101		return err
102	}
103	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
104		return err
105	}
106	if err = addRetryMiddlewares(stack, options); err != nil {
107		return err
108	}
109	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
110		return err
111	}
112	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
113		return err
114	}
115	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
116		return err
117	}
118	if err = addClientUserAgent(stack); err != nil {
119		return err
120	}
121	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
122		return err
123	}
124	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addOpDescribeManagedRuleGroupValidationMiddleware(stack); err != nil {
128		return err
129	}
130	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeManagedRuleGroup(options.Region), middleware.Before); err != nil {
131		return err
132	}
133	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
134		return err
135	}
136	if err = addResponseErrorMiddleware(stack); err != nil {
137		return err
138	}
139	if err = addRequestResponseLogging(stack, options); err != nil {
140		return err
141	}
142	return nil
143}
144
145func newServiceMetadataMiddleware_opDescribeManagedRuleGroup(region string) *awsmiddleware.RegisterServiceMetadata {
146	return &awsmiddleware.RegisterServiceMetadata{
147		Region:        region,
148		ServiceID:     ServiceID,
149		SigningName:   "wafv2",
150		OperationName: "DescribeManagedRuleGroup",
151	}
152}
153