1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package waf 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/smithy-go/middleware" 10 smithyhttp "github.com/aws/smithy-go/transport/http" 11) 12 13// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic 14// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) 15// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API 16// and see the AWS WAF Developer Guide 17// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With 18// the latest version, AWS WAF has a single set of endpoints for regional and 19// global use. Permanently deletes a Rule. You can't delete a Rule if it's still 20// used in any WebACL objects or if it still includes any predicates, such as 21// ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use 22// UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following 23// steps: 24// 25// * Update the Rule to remove predicates, if any. For more information, 26// see UpdateRule. 27// 28// * Use GetChangeToken to get the change token that you provide 29// in the ChangeToken parameter of a DeleteRule request. 30// 31// * Submit a DeleteRule 32// request. 33func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { 34 if params == nil { 35 params = &DeleteRuleInput{} 36 } 37 38 result, metadata, err := c.invokeOperation(ctx, "DeleteRule", params, optFns, addOperationDeleteRuleMiddlewares) 39 if err != nil { 40 return nil, err 41 } 42 43 out := result.(*DeleteRuleOutput) 44 out.ResultMetadata = metadata 45 return out, nil 46} 47 48type DeleteRuleInput struct { 49 50 // The value returned by the most recent call to GetChangeToken. 51 // 52 // This member is required. 53 ChangeToken *string 54 55 // The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule 56 // and by ListRules. 57 // 58 // This member is required. 59 RuleId *string 60} 61 62type DeleteRuleOutput struct { 63 64 // The ChangeToken that you used to submit the DeleteRule request. You can also use 65 // this value to query the status of the request. For more information, see 66 // GetChangeTokenStatus. 67 ChangeToken *string 68 69 // Metadata pertaining to the operation's result. 70 ResultMetadata middleware.Metadata 71} 72 73func addOperationDeleteRuleMiddlewares(stack *middleware.Stack, options Options) (err error) { 74 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteRule{}, middleware.After) 75 if err != nil { 76 return err 77 } 78 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteRule{}, middleware.After) 79 if err != nil { 80 return err 81 } 82 if err = addSetLoggerMiddleware(stack, options); err != nil { 83 return err 84 } 85 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 86 return err 87 } 88 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 89 return err 90 } 91 if err = addResolveEndpointMiddleware(stack, options); err != nil { 92 return err 93 } 94 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 95 return err 96 } 97 if err = addRetryMiddlewares(stack, options); err != nil { 98 return err 99 } 100 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 101 return err 102 } 103 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 104 return err 105 } 106 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 107 return err 108 } 109 if err = addClientUserAgent(stack); err != nil { 110 return err 111 } 112 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 113 return err 114 } 115 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 116 return err 117 } 118 if err = addOpDeleteRuleValidationMiddleware(stack); err != nil { 119 return err 120 } 121 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteRule(options.Region), middleware.Before); err != nil { 122 return err 123 } 124 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 125 return err 126 } 127 if err = addResponseErrorMiddleware(stack); err != nil { 128 return err 129 } 130 if err = addRequestResponseLogging(stack, options); err != nil { 131 return err 132 } 133 return nil 134} 135 136func newServiceMetadataMiddleware_opDeleteRule(region string) *awsmiddleware.RegisterServiceMetadata { 137 return &awsmiddleware.RegisterServiceMetadata{ 138 Region: region, 139 ServiceID: ServiceID, 140 SigningName: "waf", 141 OperationName: "DeleteRule", 142 } 143} 144