Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
Synopsis
- data UpdateFirewallDescription = UpdateFirewallDescription' {}
- newUpdateFirewallDescription :: UpdateFirewallDescription
- updateFirewallDescription_description :: Lens' UpdateFirewallDescription (Maybe Text)
- updateFirewallDescription_firewallArn :: Lens' UpdateFirewallDescription (Maybe Text)
- updateFirewallDescription_firewallName :: Lens' UpdateFirewallDescription (Maybe Text)
- updateFirewallDescription_updateToken :: Lens' UpdateFirewallDescription (Maybe Text)
- data UpdateFirewallDescriptionResponse = UpdateFirewallDescriptionResponse' {
- description :: Maybe Text
- firewallArn :: Maybe Text
- firewallName :: Maybe Text
- updateToken :: Maybe Text
- httpStatus :: Int
- newUpdateFirewallDescriptionResponse :: Int -> UpdateFirewallDescriptionResponse
- updateFirewallDescriptionResponse_description :: Lens' UpdateFirewallDescriptionResponse (Maybe Text)
- updateFirewallDescriptionResponse_firewallArn :: Lens' UpdateFirewallDescriptionResponse (Maybe Text)
- updateFirewallDescriptionResponse_firewallName :: Lens' UpdateFirewallDescriptionResponse (Maybe Text)
- updateFirewallDescriptionResponse_updateToken :: Lens' UpdateFirewallDescriptionResponse (Maybe Text)
- updateFirewallDescriptionResponse_httpStatus :: Lens' UpdateFirewallDescriptionResponse Int
Creating a Request
data UpdateFirewallDescription Source #
See: newUpdateFirewallDescription
smart constructor.
UpdateFirewallDescription' | |
|
Instances
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:
UpdateFirewallDescription
, updateFirewallDescription_description
- The new description for the firewall. If you omit this setting, Network
Firewall removes the description for the firewall.
UpdateFirewallDescription
, updateFirewallDescription_firewallArn
- The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
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.
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.
Request Lenses
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_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_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.
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.
Destructuring the Response
data UpdateFirewallDescriptionResponse Source #
See: newUpdateFirewallDescriptionResponse
smart constructor.
UpdateFirewallDescriptionResponse' | |
|
Instances
newUpdateFirewallDescriptionResponse Source #
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:
UpdateFirewallDescription
, updateFirewallDescriptionResponse_description
- A description of the firewall.
UpdateFirewallDescription
, updateFirewallDescriptionResponse_firewallArn
- The Amazon Resource Name (ARN) of the firewall.
UpdateFirewallDescription
, updateFirewallDescriptionResponse_firewallName
- The descriptive name of the firewall. You can't change the name of a
firewall after you create it.
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:httpStatus:UpdateFirewallDescriptionResponse'
, updateFirewallDescriptionResponse_httpStatus
- The response's http status code.
Response Lenses
updateFirewallDescriptionResponse_description :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #
A description of the firewall.
updateFirewallDescriptionResponse_firewallArn :: Lens' UpdateFirewallDescriptionResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) 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_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_httpStatus :: Lens' UpdateFirewallDescriptionResponse Int Source #
The response's http status code.