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// Retrieves the specified RuleGroup.
15func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error) {
16	if params == nil {
17		params = &GetRuleGroupInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "GetRuleGroup", params, optFns, addOperationGetRuleGroupMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*GetRuleGroupOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type GetRuleGroupInput struct {
31
32	// A unique identifier for the rule group. This ID is returned in the responses to
33	// create and list commands. You provide it to operations like update and delete.
34	//
35	// This member is required.
36	Id *string
37
38	// The name of the rule group. You cannot change the name of a rule group after you
39	// create it.
40	//
41	// This member is required.
42	Name *string
43
44	// Specifies whether this is for an AWS CloudFront distribution or for a regional
45	// application. A regional application can be an Application Load Balancer (ALB),
46	// an API Gateway REST API, or an AppSync GraphQL API. To work with CloudFront, you
47	// must also specify the Region US East (N. Virginia) as follows:
48	//
49	// * CLI - Specify
50	// the Region when you use the CloudFront scope: --scope=CLOUDFRONT
51	// --region=us-east-1.
52	//
53	// * API and SDKs - For all calls, use the Region endpoint
54	// us-east-1.
55	//
56	// This member is required.
57	Scope types.Scope
58}
59
60type GetRuleGroupOutput struct {
61
62	// A token used for optimistic locking. AWS WAF returns a token to your get and
63	// list requests, to mark the state of the entity at the time of the request. To
64	// make changes to the entity associated with the token, you provide the token to
65	// operations like update and delete. AWS WAF uses the token to ensure that no
66	// changes have been made to the entity since you last retrieved it. If a change
67	// has been made, the update fails with a WAFOptimisticLockException. If this
68	// happens, perform another get, and use the new token returned by that operation.
69	LockToken *string
70
71	//
72	RuleGroup *types.RuleGroup
73
74	// Metadata pertaining to the operation's result.
75	ResultMetadata middleware.Metadata
76}
77
78func addOperationGetRuleGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
79	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetRuleGroup{}, middleware.After)
80	if err != nil {
81		return err
82	}
83	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRuleGroup{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	if err = addSetLoggerMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
91		return err
92	}
93	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
94		return err
95	}
96	if err = addResolveEndpointMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
100		return err
101	}
102	if err = addRetryMiddlewares(stack, options); err != nil {
103		return err
104	}
105	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
112		return err
113	}
114	if err = addClientUserAgent(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addOpGetRuleGroupValidationMiddleware(stack); err != nil {
124		return err
125	}
126	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRuleGroup(options.Region), middleware.Before); err != nil {
127		return err
128	}
129	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addResponseErrorMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addRequestResponseLogging(stack, options); err != nil {
136		return err
137	}
138	return nil
139}
140
141func newServiceMetadataMiddleware_opGetRuleGroup(region string) *awsmiddleware.RegisterServiceMetadata {
142	return &awsmiddleware.RegisterServiceMetadata{
143		Region:        region,
144		ServiceID:     ServiceID,
145		SigningName:   "wafv2",
146		OperationName: "GetRuleGroup",
147	}
148}
149