-
Notifications
You must be signed in to change notification settings - Fork 599
/
api_op_GetRuleGroup.go
178 lines (151 loc) · 5.57 KB
/
api_op_GetRuleGroup.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package wafv2
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
type GetRuleGroupInput struct {
_ struct{} `type:"structure"`
// A unique identifier for the rule group. This ID is returned in the responses
// to create and list commands. You provide it to operations like update and
// delete.
//
// Id is a required field
Id *string `min:"1" type:"string" required:"true"`
// The name of the rule group. You cannot change the name of a rule group after
// you create it.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
// Specifies whether this is for an AWS CloudFront distribution or for a regional
// application. A regional application can be an Application Load Balancer (ALB)
// or an API Gateway stage.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
//
// * CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT
// --region=us-east-1.
//
// * API and SDKs - For all calls, use the Region endpoint us-east-1.
//
// Scope is a required field
Scope Scope `type:"string" required:"true" enum:"true"`
}
// String returns the string representation
func (s GetRuleGroupInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetRuleGroupInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "GetRuleGroupInput"}
if s.Id == nil {
invalidParams.Add(aws.NewErrParamRequired("Id"))
}
if s.Id != nil && len(*s.Id) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Id", 1))
}
if s.Name == nil {
invalidParams.Add(aws.NewErrParamRequired("Name"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Name", 1))
}
if len(s.Scope) == 0 {
invalidParams.Add(aws.NewErrParamRequired("Scope"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
type GetRuleGroupOutput struct {
_ struct{} `type:"structure"`
// A token used for optimistic locking. AWS WAF returns a token to your get
// and list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
// token to operations like update and delete. AWS WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
// operation.
LockToken *string `min:"1" type:"string"`
//
// This is the latest version of AWS WAF, named AWS WAFV2, released in November,
// 2019. For information, including how to migrate your AWS WAF resources from
// the prior release, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// A rule group defines a collection of rules to inspect and control web requests
// that you can use in a WebACL. When you create a rule group, you define an
// immutable capacity limit. If you update a rule group, you must stay within
// the capacity. This allows others to reuse the rule group with confidence
// in its capacity requirements.
RuleGroup *RuleGroup `type:"structure"`
}
// String returns the string representation
func (s GetRuleGroupOutput) String() string {
return awsutil.Prettify(s)
}
const opGetRuleGroup = "GetRuleGroup"
// GetRuleGroupRequest returns a request value for making API operation for
// AWS WAFV2.
//
//
// This is the latest version of AWS WAF, named AWS WAFV2, released in November,
// 2019. For information, including how to migrate your AWS WAF resources from
// the prior release, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// Retrieves the specified RuleGroup.
//
// // Example sending a request using GetRuleGroupRequest.
// req := client.GetRuleGroupRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetRuleGroup
func (c *Client) GetRuleGroupRequest(input *GetRuleGroupInput) GetRuleGroupRequest {
op := &aws.Operation{
Name: opGetRuleGroup,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetRuleGroupInput{}
}
req := c.newRequest(op, input, &GetRuleGroupOutput{})
return GetRuleGroupRequest{Request: req, Input: input, Copy: c.GetRuleGroupRequest}
}
// GetRuleGroupRequest is the request type for the
// GetRuleGroup API operation.
type GetRuleGroupRequest struct {
*aws.Request
Input *GetRuleGroupInput
Copy func(*GetRuleGroupInput) GetRuleGroupRequest
}
// Send marshals and sends the GetRuleGroup API request.
func (r GetRuleGroupRequest) Send(ctx context.Context) (*GetRuleGroupResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &GetRuleGroupResponse{
GetRuleGroupOutput: r.Request.Data.(*GetRuleGroupOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// GetRuleGroupResponse is the response type for the
// GetRuleGroup API operation.
type GetRuleGroupResponse struct {
*GetRuleGroupOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// GetRuleGroup request.
func (r *GetRuleGroupResponse) SDKResponseMetdata() *aws.Response {
return r.response
}