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
179
180
181
182
183
184
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package networkfirewall
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/networkfirewall/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// High-level information about a rule group, returned by operations like create
// and describe. You can use the information provided in the metadata to retrieve
// and manage a rule group. You can retrieve all objects for a rule group by
// calling DescribeRuleGroup .
func (c *Client) DescribeRuleGroupMetadata(ctx context.Context, params *DescribeRuleGroupMetadataInput, optFns ...func(*Options)) (*DescribeRuleGroupMetadataOutput, error) {
if params == nil {
params = &DescribeRuleGroupMetadataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeRuleGroupMetadata", params, optFns, c.addOperationDescribeRuleGroupMetadataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeRuleGroupMetadataOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeRuleGroupMetadataInput struct {
// The descriptive name of the rule group. You can't change the name of a rule
// group after you create it. You must specify the ARN or the name, and you can
// specify both.
RuleGroupArn *string
// The descriptive name of the rule group. You can't change the name of a rule
// group after you create it. You must specify the ARN or the name, and you can
// specify both.
RuleGroupName *string
// Indicates whether the rule group is stateless or stateful. If the rule group is
// stateless, it contains stateless rules. If it is stateful, it contains stateful
// rules. This setting is required for requests that do not include the
// RuleGroupARN .
Type types.RuleGroupType
noSmithyDocumentSerde
}
type DescribeRuleGroupMetadataOutput struct {
// The descriptive name of the rule group. You can't change the name of a rule
// group after you create it. You must specify the ARN or the name, and you can
// specify both.
//
// This member is required.
RuleGroupArn *string
// The descriptive name of the rule group. You can't change the name of a rule
// group after you create it. You must specify the ARN or the name, and you can
// specify both.
//
// This member is required.
RuleGroupName *string
// The maximum operating resources that this rule group can use. Rule group
// capacity is fixed at creation. When you update a rule group, you are limited to
// this capacity. When you reference a rule group from a firewall policy, Network
// Firewall reserves this capacity for the rule group. You can retrieve the
// capacity that would be required for a rule group before you create the rule
// group by calling CreateRuleGroup with DryRun set to TRUE .
Capacity *int32
// Returns the metadata objects for the specified rule group.
Description *string
// The last time that the rule group was changed.
LastModifiedTime *time.Time
// Additional options governing how Network Firewall handles the rule group. You
// can only use these for stateful rule groups.
StatefulRuleOptions *types.StatefulRuleOptions
// Indicates whether the rule group is stateless or stateful. If the rule group is
// stateless, it contains stateless rules. If it is stateful, it contains stateful
// rules. This setting is required for requests that do not include the
// RuleGroupARN .
Type types.RuleGroupType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeRuleGroupMetadataMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpDescribeRuleGroupMetadata{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDescribeRuleGroupMetadata{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeRuleGroupMetadata"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeRuleGroupMetadata(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDescribeRuleGroupMetadata(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeRuleGroupMetadata",
}
}
|
