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// Returns the web ACL capacity unit (WCU) requirements for a specified scope and 19// set of rules. You can use this to check the capacity requirements for the rules 20// you want to use in a RuleGroup or WebACL. AWS WAF uses WCUs to calculate and 21// control the operating resources that are used to run your rules, rule groups, 22// and web ACLs. AWS WAF calculates capacity differently for each rule type, to 23// reflect the relative cost of each rule. Simple rules that cost little to run use 24// fewer WCUs than more complex rules that use more processing power. Rule group 25// capacity is fixed at creation, which helps users plan their web ACL WCU usage 26// when they use a rule group. The WCU limit for web ACLs is 1,500. 27func (c *Client) CheckCapacity(ctx context.Context, params *CheckCapacityInput, optFns ...func(*Options)) (*CheckCapacityOutput, error) { 28 if params == nil { 29 params = &CheckCapacityInput{} 30 } 31 32 result, metadata, err := c.invokeOperation(ctx, "CheckCapacity", params, optFns, addOperationCheckCapacityMiddlewares) 33 if err != nil { 34 return nil, err 35 } 36 37 out := result.(*CheckCapacityOutput) 38 out.ResultMetadata = metadata 39 return out, nil 40} 41 42type CheckCapacityInput struct { 43 44 // An array of Rule that you're configuring to use in a rule group or web ACL. 45 // 46 // This member is required. 47 Rules []types.Rule 48 49 // Specifies whether this is for an AWS CloudFront distribution or for a regional 50 // application. A regional application can be an Application Load Balancer (ALB), 51 // an API Gateway REST API, or an AppSync GraphQL API. To work with CloudFront, you 52 // must also specify the Region US East (N. Virginia) as follows: 53 // 54 // * CLI - Specify 55 // the Region when you use the CloudFront scope: --scope=CLOUDFRONT 56 // --region=us-east-1. 57 // 58 // * API and SDKs - For all calls, use the Region endpoint 59 // us-east-1. 60 // 61 // This member is required. 62 Scope types.Scope 63} 64 65type CheckCapacityOutput struct { 66 67 // The capacity required by the rules and scope. 68 Capacity int64 69 70 // Metadata pertaining to the operation's result. 71 ResultMetadata middleware.Metadata 72} 73 74func addOperationCheckCapacityMiddlewares(stack *middleware.Stack, options Options) (err error) { 75 err = stack.Serialize.Add(&awsAwsjson11_serializeOpCheckCapacity{}, middleware.After) 76 if err != nil { 77 return err 78 } 79 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCheckCapacity{}, middleware.After) 80 if err != nil { 81 return err 82 } 83 if err = addSetLoggerMiddleware(stack, options); err != nil { 84 return err 85 } 86 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 87 return err 88 } 89 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 90 return err 91 } 92 if err = addResolveEndpointMiddleware(stack, options); err != nil { 93 return err 94 } 95 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 96 return err 97 } 98 if err = addRetryMiddlewares(stack, options); err != nil { 99 return err 100 } 101 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 102 return err 103 } 104 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 105 return err 106 } 107 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 108 return err 109 } 110 if err = addClientUserAgent(stack); err != nil { 111 return err 112 } 113 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 114 return err 115 } 116 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 117 return err 118 } 119 if err = addOpCheckCapacityValidationMiddleware(stack); err != nil { 120 return err 121 } 122 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCheckCapacity(options.Region), middleware.Before); err != nil { 123 return err 124 } 125 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 126 return err 127 } 128 if err = addResponseErrorMiddleware(stack); err != nil { 129 return err 130 } 131 if err = addRequestResponseLogging(stack, options); err != nil { 132 return err 133 } 134 return nil 135} 136 137func newServiceMetadataMiddleware_opCheckCapacity(region string) *awsmiddleware.RegisterServiceMetadata { 138 return &awsmiddleware.RegisterServiceMetadata{ 139 Region: region, 140 ServiceID: ServiceID, 141 SigningName: "wafv2", 142 OperationName: "CheckCapacity", 143 } 144} 145