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
|
// 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/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Modifies the description for the specified firewall. Use the description to
// help you identify the firewall when you're working with it.
func (c *Client) UpdateFirewallDescription(ctx context.Context, params *UpdateFirewallDescriptionInput, optFns ...func(*Options)) (*UpdateFirewallDescriptionOutput, error) {
if params == nil {
params = &UpdateFirewallDescriptionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateFirewallDescription", params, optFns, c.addOperationUpdateFirewallDescriptionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateFirewallDescriptionOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateFirewallDescriptionInput struct {
// The new description for the firewall. If you omit this setting, Network
// Firewall removes the description for the firewall.
Description *string
// The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the
// name, and you can specify both.
FirewallArn *string
// The descriptive name of the firewall. You can't change the name of a firewall
// after you create it. You must specify the ARN or the name, and you can specify
// both.
FirewallName *string
// An optional token that you can use for optimistic locking. Network Firewall
// returns a token to your requests that access the firewall. The token marks the
// state of the firewall resource at the time of the request. To make an
// unconditional change to the firewall, omit the token in your update request.
// Without the token, Network Firewall performs your updates regardless of whether
// the firewall has changed since you last retrieved it. To make a conditional
// change to the firewall, provide the token in your update request. Network
// Firewall uses the token to ensure that the firewall hasn't changed since you
// last retrieved it. If it has changed, the operation fails with an
// InvalidTokenException . If this happens, retrieve the firewall again to get a
// current copy of it with a new token. Reapply your changes as needed, then try
// the operation again using the new token.
UpdateToken *string
noSmithyDocumentSerde
}
type UpdateFirewallDescriptionOutput struct {
// A description of the firewall.
Description *string
// The Amazon Resource Name (ARN) of the firewall.
FirewallArn *string
// The descriptive name of the firewall. You can't change the name of a firewall
// after you create it.
FirewallName *string
// An optional token that you can use for optimistic locking. Network Firewall
// returns a token to your requests that access the firewall. The token marks the
// state of the firewall resource at the time of the request. To make an
// unconditional change to the firewall, omit the token in your update request.
// Without the token, Network Firewall performs your updates regardless of whether
// the firewall has changed since you last retrieved it. To make a conditional
// change to the firewall, provide the token in your update request. Network
// Firewall uses the token to ensure that the firewall hasn't changed since you
// last retrieved it. If it has changed, the operation fails with an
// InvalidTokenException . If this happens, retrieve the firewall again to get a
// current copy of it with a new token. Reapply your changes as needed, then try
// the operation again using the new token.
UpdateToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateFirewallDescriptionMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpUpdateFirewallDescription{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpUpdateFirewallDescription{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateFirewallDescription"); 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_opUpdateFirewallDescription(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_opUpdateFirewallDescription(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateFirewallDescription",
}
}
|