amazonka-network-firewall-2.0: Amazon Network Firewall SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.NetworkFirewall.UpdateFirewallDescription

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

  • description :: Maybe Text

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

  • firewallArn :: Maybe Text

    The Amazon Resource Name (ARN) of the firewall.

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

  • 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.

  • 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.

Instances

Instances details
ToJSON UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

ToHeaders UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

ToPath UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

ToQuery UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

AWSRequest UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Generic UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Associated Types

type Rep UpdateFirewallDescription :: Type -> Type #

Read UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Show UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

NFData UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Eq UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Hashable UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

type AWSResponse UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

type Rep UpdateFirewallDescription Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

type Rep UpdateFirewallDescription = D1 ('MetaData "UpdateFirewallDescription" "Amazonka.NetworkFirewall.UpdateFirewallDescription" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "UpdateFirewallDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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.

Constructors

UpdateFirewallDescriptionResponse' 

Fields

  • description :: Maybe Text

    A description of the firewall.

  • firewallArn :: Maybe Text

    The Amazon Resource Name (ARN) 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.

  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateFirewallDescriptionResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Associated Types

type Rep UpdateFirewallDescriptionResponse :: Type -> Type #

Read UpdateFirewallDescriptionResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Show UpdateFirewallDescriptionResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

NFData UpdateFirewallDescriptionResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

Eq UpdateFirewallDescriptionResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

type Rep UpdateFirewallDescriptionResponse Source # 
Instance details

Defined in Amazonka.NetworkFirewall.UpdateFirewallDescription

type Rep UpdateFirewallDescriptionResponse = D1 ('MetaData "UpdateFirewallDescriptionResponse" "Amazonka.NetworkFirewall.UpdateFirewallDescription" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "UpdateFirewallDescriptionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "firewallArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "firewallName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "updateToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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_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.