Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.NetworkFirewall.UpdateFirewallDescription

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

Synopsis

Creating a Request

data UpdateFirewallDescription Source #

See: newUpdateFirewallDescription smart constructor.

Constructors

UpdateFirewallDescription'

Fields

updateToken :: Maybe Text
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.
firewallArn :: Maybe Text
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
description :: Maybe Text
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.
firewallName :: Maybe Text
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.

Instances

Instances details

Eq UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods (==) :: UpdateFirewallDescription -> UpdateFirewallDescription -> Bool # (/=) :: UpdateFirewallDescription -> UpdateFirewallDescription -> Bool #
Read UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods readsPrec :: Int -> ReadS UpdateFirewallDescription # readList :: ReadS [UpdateFirewallDescription] # readPrec :: ReadPrec UpdateFirewallDescription # readListPrec :: ReadPrec [UpdateFirewallDescription] #
Show UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods showsPrec :: Int -> UpdateFirewallDescription -> ShowS # show :: UpdateFirewallDescription -> String # showList :: [UpdateFirewallDescription] -> ShowS #
Generic UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Associated Types type Rep UpdateFirewallDescription :: Type -> Type # Methods from :: UpdateFirewallDescription -> Rep UpdateFirewallDescription x # to :: Rep UpdateFirewallDescription x -> UpdateFirewallDescription #
NFData UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods rnf :: UpdateFirewallDescription -> () #
Hashable UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods hashWithSalt :: Int -> UpdateFirewallDescription -> Int # hash :: UpdateFirewallDescription -> Int #
ToJSON UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods toJSON :: UpdateFirewallDescription -> Value # toEncoding :: UpdateFirewallDescription -> Encoding # toJSONList :: [UpdateFirewallDescription] -> Value # toEncodingList :: [UpdateFirewallDescription] -> Encoding #
AWSRequest UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Associated Types type AWSResponse UpdateFirewallDescription # Methods request :: UpdateFirewallDescription -> Request UpdateFirewallDescription # response :: MonadResource m => Logger -> Service -> Proxy UpdateFirewallDescription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFirewallDescription))) #
ToHeaders UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods toHeaders :: UpdateFirewallDescription -> [Header] #
ToPath UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods toPath :: UpdateFirewallDescription -> ByteString #
ToQuery UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods toQuery :: UpdateFirewallDescription -> QueryString #
type Rep UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription type Rep UpdateFirewallDescription = D1 ('MetaData "UpdateFirewallDescription" "Amazonka.NetworkFirewall.UpdateFirewallDescription" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "UpdateFirewallDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse UpdateFirewallDescription Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription type AWSResponse UpdateFirewallDescription = UpdateFirewallDescriptionResponse

newUpdateFirewallDescription :: UpdateFirewallDescription Source #

Create a value of UpdateFirewallDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:updateToken:UpdateFirewallDescription', updateFirewallDescription_updateToken - 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.

$sel:firewallArn:UpdateFirewallDescription', updateFirewallDescription_firewallArn - The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

$sel:description:UpdateFirewallDescription', updateFirewallDescription_description - The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

$sel:firewallName:UpdateFirewallDescription', updateFirewallDescription_firewallName - 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.

Request Lenses

updateFirewallDescription_updateToken :: Lens' UpdateFirewallDescription (Maybe Text) Source #

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.

updateFirewallDescription_firewallArn :: Lens' UpdateFirewallDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

updateFirewallDescription_description :: Lens' UpdateFirewallDescription (Maybe Text) Source #

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

updateFirewallDescription_firewallName :: Lens' UpdateFirewallDescription (Maybe Text) Source #

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.

Destructuring the Response

data UpdateFirewallDescriptionResponse Source #

See: newUpdateFirewallDescriptionResponse smart constructor.

Constructors

UpdateFirewallDescriptionResponse'

Fields

updateToken :: Maybe Text
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.
firewallArn :: Maybe Text
The Amazon Resource Name (ARN) of the firewall.
description :: Maybe Text
A description of the firewall.
firewallName :: Maybe Text
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq UpdateFirewallDescriptionResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods (==) :: UpdateFirewallDescriptionResponse -> UpdateFirewallDescriptionResponse -> Bool # (/=) :: UpdateFirewallDescriptionResponse -> UpdateFirewallDescriptionResponse -> Bool #
Read UpdateFirewallDescriptionResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods readsPrec :: Int -> ReadS UpdateFirewallDescriptionResponse # readList :: ReadS [UpdateFirewallDescriptionResponse] # readPrec :: ReadPrec UpdateFirewallDescriptionResponse # readListPrec :: ReadPrec [UpdateFirewallDescriptionResponse] #
Show UpdateFirewallDescriptionResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods showsPrec :: Int -> UpdateFirewallDescriptionResponse -> ShowS # show :: UpdateFirewallDescriptionResponse -> String # showList :: [UpdateFirewallDescriptionResponse] -> ShowS #
Generic UpdateFirewallDescriptionResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Associated Types type Rep UpdateFirewallDescriptionResponse :: Type -> Type # Methods from :: UpdateFirewallDescriptionResponse -> Rep UpdateFirewallDescriptionResponse x # to :: Rep UpdateFirewallDescriptionResponse x -> UpdateFirewallDescriptionResponse #
NFData UpdateFirewallDescriptionResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription Methods rnf :: UpdateFirewallDescriptionResponse -> () #
type Rep UpdateFirewallDescriptionResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription type Rep UpdateFirewallDescriptionResponse = D1 ('MetaData "UpdateFirewallDescriptionResponse" "Amazonka.NetworkFirewall.UpdateFirewallDescription" "libZSservicesZSamazonka-network-firewallZSamazonka-network-firewall" 'False) (C1 ('MetaCons "UpdateFirewallDescriptionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateFirewallDescriptionResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateFirewallDescriptionResponse'`
-> UpdateFirewallDescriptionResponse

Create a value of UpdateFirewallDescriptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:updateToken:UpdateFirewallDescription', updateFirewallDescriptionResponse_updateToken - 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.

$sel:firewallArn:UpdateFirewallDescription', updateFirewallDescriptionResponse_firewallArn - The Amazon Resource Name (ARN) of the firewall.

$sel:description:UpdateFirewallDescription', updateFirewallDescriptionResponse_description - A description of the firewall.

$sel:firewallName:UpdateFirewallDescription', updateFirewallDescriptionResponse_firewallName - The descriptive name of the firewall. You can't change the name of a firewall after you create it.

$sel:httpStatus:UpdateFirewallDescriptionResponse', updateFirewallDescriptionResponse_httpStatus - The response's http status code.

Response Lenses

updateFirewallDescriptionResponse_updateToken :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #

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.

updateFirewallDescriptionResponse_firewallArn :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the firewall.

updateFirewallDescriptionResponse_description :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #

A description of the firewall.

updateFirewallDescriptionResponse_firewallName :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

updateFirewallDescriptionResponse_httpStatus :: Lens' UpdateFirewallDescriptionResponse Int Source #

The response's http status code.