NetworkFirewall / Client / update_firewall_analysis_settings

update_firewall_analysis_settings#

NetworkFirewall.Client.update_firewall_analysis_settings(**kwargs)#

Enables specific types of firewall analysis on a specific firewall you define.

See also: AWS API Documentation

Request Syntax

response = client.update_firewall_analysis_settings(
    EnabledAnalysisTypes=[
        'TLS_SNI'|'HTTP_HOST',
    ],
    FirewallArn='string',
    FirewallName='string',
    UpdateToken='string'
)
Parameters:

  • EnabledAnalysisTypes (list) –

    An optional setting indicating the specific traffic analysis types to enable on the firewall.

    • (string) –

  • FirewallArn (string) –

    The Amazon Resource Name (ARN) of the firewall.

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'EnabledAnalysisTypes': [
        'TLS_SNI'|'HTTP_HOST',
    ],
    'FirewallArn': 'string',
    'FirewallName': 'string',
    'UpdateToken': 'string'
}

Response Structure

  • (dict) –

    • EnabledAnalysisTypes (list) –

      An optional setting indicating the specific traffic analysis types to enable on the firewall.

      • (string) –

    • FirewallArn (string) –

      The Amazon Resource Name (ARN) of the firewall.

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

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

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

Exceptions