NetworkFirewall / Client / update_proxy_rule_group_priorities

update_proxy_rule_group_priorities¶

NetworkFirewall.Client.update_proxy_rule_group_priorities(**kwargs)¶

Updates proxy rule group priorities within a proxy configuration.

Request Syntax

response = client.update_proxy_rule_group_priorities(
    ProxyConfigurationName='string',
    ProxyConfigurationArn='string',
    RuleGroups=[
        {
            'ProxyRuleGroupName': 'string',
            'NewPosition': 123
        },
    ],
    UpdateToken='string'
)

Parameters:

ProxyConfigurationName (string) –
The descriptive name of the proxy configuration. You can’t change the name of a proxy configuration after you create it.

You must specify the ARN or the name, and you can specify both.
ProxyConfigurationArn (string) –
The Amazon Resource Name (ARN) of a proxy configuration.

You must specify the ARN or the name, and you can specify both.
RuleGroups (list) –
[REQUIRED]

proxy rule group resources to update to new positions.
- (dict) –
  
  Proxy rule group name and new desired position.
  - ProxyRuleGroupName (string) –
    
    The descriptive name of the proxy rule group. You can’t change the name of a proxy rule group after you create it.
  - NewPosition (integer) –
    
    Where to move a proxy rule group in a proxy configuration.
UpdateToken (string) –
[REQUIRED]

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.

To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Return type:

dict

Returns:

Response Syntax

{
    'ProxyRuleGroups': [
        {
            'ProxyRuleGroupName': 'string',
            'Priority': 123
        },
    ],
    'UpdateToken': 'string'
}

Response Structure

(dict) –
- ProxyRuleGroups (list) –
  
  The updated proxy rule group hierarchy that reflects the updates from the request.
  - (dict) –
    
    Proxy rule group along with its priority.
    - ProxyRuleGroupName (string) –
      
      The descriptive name of the proxy rule group. You can’t change the name of a proxy rule group after you create it.
    - Priority (integer) –
      
      Priority of the proxy rule group in the proxy configuration.
- UpdateToken (string) –
  
  A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.
  
  To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Exceptions

NetworkFirewall.Client.exceptions.InvalidRequestException
NetworkFirewall.Client.exceptions.InternalServerError
NetworkFirewall.Client.exceptions.ResourceNotFoundException
NetworkFirewall.Client.exceptions.ThrottlingException