2025/11/25 - AWS Network Firewall - 22 new api methods
Changes Network Firewall release of the Proxy feature.
Updates the properties of the specified proxy configuration.
See also: AWS API Documentation
Request Syntax
client.update_proxy_configuration(
ProxyConfigurationName='string',
ProxyConfigurationArn='string',
DefaultRulePhaseActions={
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
UpdateToken='string'
)
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
dict
[REQUIRED]
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
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.
dict
Response Syntax
{
'ProxyConfiguration': {
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'RuleGroups': [
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'Type': 'string',
'Priority': 123
},
],
'DefaultRulePhaseActions': {
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyConfiguration (dict) --
The updated proxy configuration resource that reflects the updates from the request.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
Description (string) --
A description of the proxy configuration.
CreateTime (datetime) --
Time the Proxy Configuration was created.
DeleteTime (datetime) --
Time the Proxy Configuration was deleted.
RuleGroups (list) --
Proxy rule groups within the proxy configuration.
(dict) --
Proxy rule group contained within a proxy configuration.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
Type (string) --
Proxy rule group type.
Priority (integer) --
Priority of the proxy rule group in the proxy configuration.
DefaultRulePhaseActions (dict) --
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
Pre-DNS - before domain resolution.
Pre-Request - after DNS, before request.
Post-Response - after receiving response.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
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.
Attaches ProxyRuleGroup resources to a ProxyConfiguration
A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.
See also: AWS API Documentation
Request Syntax
client.attach_rule_groups_to_proxy_configuration(
ProxyConfigurationName='string',
ProxyConfigurationArn='string',
RuleGroups=[
{
'ProxyRuleGroupName': 'string',
'InsertPosition': 123
},
],
UpdateToken='string'
)
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
list
[REQUIRED]
The proxy rule group(s) to attach to the proxy configuration
(dict) --
The proxy rule group(s) to attach to the proxy configuration
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.
InsertPosition (integer) --
Where to insert a proxy rule group in a proxy configuration.
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.
dict
Response Syntax
{
'ProxyConfiguration': {
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'RuleGroups': [
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'Type': 'string',
'Priority': 123
},
],
'DefaultRulePhaseActions': {
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyConfiguration (dict) --
The updated proxy configuration resource that reflects the updates from the request.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
Description (string) --
A description of the proxy configuration.
CreateTime (datetime) --
Time the Proxy Configuration was created.
DeleteTime (datetime) --
Time the Proxy Configuration was deleted.
RuleGroups (list) --
Proxy rule groups within the proxy configuration.
(dict) --
Proxy rule group contained within a proxy configuration.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
Type (string) --
Proxy rule group type.
Priority (integer) --
Priority of the proxy rule group in the proxy configuration.
DefaultRulePhaseActions (dict) --
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
Pre-DNS - before domain resolution.
Pre-Request - after DNS, before request.
Post-Response - after receiving response.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
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.
Creates an Network Firewall ProxyConfiguration
A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.
To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.
See also: AWS API Documentation
Request Syntax
client.create_proxy_configuration(
ProxyConfigurationName='string',
Description='string',
RuleGroupNames=[
'string',
],
RuleGroupArns=[
'string',
],
DefaultRulePhaseActions={
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
string
A description of the proxy configuration.
list
The proxy rule group name(s) to attach to the proxy configuration.
You must specify the ARNs or the names, and you can specify both.
(string) --
list
The proxy rule group arn(s) to attach to the proxy configuration.
You must specify the ARNs or the names, and you can specify both.
(string) --
dict
[REQUIRED]
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'ProxyConfiguration': {
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'RuleGroups': [
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'Type': 'string',
'Priority': 123
},
],
'DefaultRulePhaseActions': {
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyConfiguration (dict) --
The properties that define the proxy configuration.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
Description (string) --
A description of the proxy configuration.
CreateTime (datetime) --
Time the Proxy Configuration was created.
DeleteTime (datetime) --
Time the Proxy Configuration was deleted.
RuleGroups (list) --
Proxy rule groups within the proxy configuration.
(dict) --
Proxy rule group contained within a proxy configuration.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
Type (string) --
Proxy rule group type.
Priority (integer) --
Priority of the proxy rule group in the proxy configuration.
DefaultRulePhaseActions (dict) --
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
Pre-DNS - before domain resolution.
Pre-Request - after DNS, before request.
Post-Response - after receiving response.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
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.
Creates an Network Firewall Proxy
Attaches a Proxy configuration to a NAT Gateway.
To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about proxies, use ListProxies and DescribeProxy.
See also: AWS API Documentation
Request Syntax
client.create_proxy(
ProxyName='string',
NatGatewayId='string',
ProxyConfigurationName='string',
ProxyConfigurationArn='string',
ListenerProperties=[
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
TlsInterceptProperties={
'PcaArn': 'string',
'TlsInterceptMode': 'ENABLED'|'DISABLED'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
string
[REQUIRED]
A unique identifier for the NAT gateway to use with proxy resources.
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
list
Listener properties for HTTP and HTTPS traffic.
(dict) --
This data type is used specifically for the CreateProxy and UpdateProxy APIs.
Open port for taking HTTP or HTTPS traffic.
Port (integer) -- [REQUIRED]
Port for processing traffic.
Type (string) -- [REQUIRED]
Selection of HTTP or HTTPS traffic.
dict
[REQUIRED]
TLS decryption on traffic to filter on attributes in the HTTP header.
PcaArn (string) --
Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
TlsInterceptMode (string) --
Specifies whether to enable or disable TLS Intercept Mode.
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'Proxy': {
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'FailureCode': 'string',
'FailureMessage': 'string',
'ProxyState': 'ATTACHING'|'ATTACHED'|'DETACHING'|'DETACHED'|'ATTACH_FAILED'|'DETACH_FAILED',
'ProxyModifyState': 'MODIFYING'|'COMPLETED'|'FAILED',
'NatGatewayId': 'string',
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'ProxyName': 'string',
'ProxyArn': 'string',
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'TlsInterceptProperties': {
'PcaArn': 'string',
'TlsInterceptMode': 'ENABLED'|'DISABLED'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
Proxy (dict) --
Proxy attached to a NAT gateway.
CreateTime (datetime) --
Time the Proxy was created.
DeleteTime (datetime) --
Time the Proxy was deleted.
UpdateTime (datetime) --
Time the Proxy was updated.
FailureCode (string) --
Failure code for cases when the Proxy fails to attach or update.
FailureMessage (string) --
Failure message for cases when the Proxy fails to attach or update.
ProxyState (string) --
Current attachment/detachment status of the Proxy.
ProxyModifyState (string) --
Current modification status of the Proxy.
NatGatewayId (string) --
The NAT Gateway for the proxy.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
ProxyName (string) --
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
ProxyArn (string) --
The Amazon Resource Name (ARN) of a proxy.
ListenerProperties (list) --
Listener properties for HTTP and HTTPS traffic.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
TlsInterceptProperties (dict) --
TLS decryption on traffic to filter on attributes in the HTTP header.
PcaArn (string) --
Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
TlsInterceptMode (string) --
Specifies whether to enable or disable TLS Intercept Mode.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.
To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy 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.
Deletes the specified ProxyConfiguration.
See also: AWS API Documentation
Request Syntax
client.delete_proxy_configuration(
ProxyConfigurationName='string',
ProxyConfigurationArn='string'
)
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string'
}
Response Structure
(dict) --
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
Creates an Network Firewall ProxyRuleGroup
Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations.
To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup.
To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.
See also: AWS API Documentation
Request Syntax
client.create_proxy_rule_group(
ProxyRuleGroupName='string',
Description='string',
Rules={
'PreDNS': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PreREQUEST': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PostRESPONSE': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
string
A description of the proxy rule group.
dict
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
PreDNS (list) --
Before domain resolution.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PreREQUEST (list) --
After DNS, before request.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PostRESPONSE (list) --
After receiving response.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'ProxyRuleGroup': {
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'Rules': {
'PreDNS': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PreREQUEST': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PostRESPONSE': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
]
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyRuleGroup (dict) --
The properties that define the proxy rule group.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
CreateTime (datetime) --
Time the Proxy Rule Group was created.
DeleteTime (datetime) --
Time the Proxy Rule Group was deleted.
Rules (dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
PreDNS (list) --
Before domain resolution.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PreREQUEST (list) --
After DNS, before request.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PostRESPONSE (list) --
After receiving response.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
Description (string) --
A description of the proxy rule group.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.
To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group 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.
Returns the data objects for the specified proxy rule group.
See also: AWS API Documentation
Request Syntax
client.describe_proxy_rule_group(
ProxyRuleGroupName='string',
ProxyRuleGroupArn='string'
)
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'ProxyRuleGroup': {
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'Rules': {
'PreDNS': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PreREQUEST': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PostRESPONSE': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
]
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyRuleGroup (dict) --
The configuration for the specified proxy rule group.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
CreateTime (datetime) --
Time the Proxy Rule Group was created.
DeleteTime (datetime) --
Time the Proxy Rule Group was deleted.
Rules (dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
PreDNS (list) --
Before domain resolution.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PreREQUEST (list) --
After DNS, before request.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PostRESPONSE (list) --
After receiving response.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
Description (string) --
A description of the proxy rule group.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.
To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group 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.
Creates Network Firewall ProxyRule resources.
Attaches new proxy rule(s) to an existing proxy rule group.
To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.
See also: AWS API Documentation
Request Syntax
client.create_proxy_rules(
ProxyRuleGroupArn='string',
ProxyRuleGroupName='string',
Rules={
'PreDNS': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
],
'InsertPosition': 123
},
],
'PreREQUEST': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
],
'InsertPosition': 123
},
],
'PostRESPONSE': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
],
'InsertPosition': 123
},
]
}
)
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
dict
[REQUIRED]
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
PreDNS (list) --
Before domain resolution.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
InsertPosition (integer) --
Where to insert a proxy rule in a proxy rule group.
PreREQUEST (list) --
After DNS, before request.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
InsertPosition (integer) --
Where to insert a proxy rule in a proxy rule group.
PostRESPONSE (list) --
After receiving response.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
InsertPosition (integer) --
Where to insert a proxy rule in a proxy rule group.
dict
Response Syntax
{
'ProxyRuleGroup': {
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'Rules': {
'PreDNS': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PreREQUEST': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PostRESPONSE': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
]
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyRuleGroup (dict) --
The properties that define the proxy rule group with the newly created proxy rule(s).
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
CreateTime (datetime) --
Time the Proxy Rule Group was created.
DeleteTime (datetime) --
Time the Proxy Rule Group was deleted.
Rules (dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
PreDNS (list) --
Before domain resolution.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PreREQUEST (list) --
After DNS, before request.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PostRESPONSE (list) --
After receiving response.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
Description (string) --
A description of the proxy rule group.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.
To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule 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.
Deletes the specified Proxy.
Detaches a Proxy configuration from a NAT Gateway.
See also: AWS API Documentation
Request Syntax
client.delete_proxy(
NatGatewayId='string',
ProxyName='string',
ProxyArn='string'
)
string
[REQUIRED]
The NAT Gateway the proxy is attached to.
string
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'NatGatewayId': 'string',
'ProxyName': 'string',
'ProxyArn': 'string'
}
Response Structure
(dict) --
NatGatewayId (string) --
The NAT Gateway the Proxy was attached to.
ProxyName (string) --
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
ProxyArn (string) --
The Amazon Resource Name (ARN) of a proxy.
Deletes the specified ProxyRule(s). currently attached to a ProxyRuleGroup
See also: AWS API Documentation
Request Syntax
client.delete_proxy_rules(
ProxyRuleGroupArn='string',
ProxyRuleGroupName='string',
Rules=[
'string',
]
)
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
list
[REQUIRED]
The proxy rule(s) to remove from the existing proxy rule group.
(string) --
dict
Response Syntax
{
'ProxyRuleGroup': {
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'Rules': {
'PreDNS': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PreREQUEST': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
],
'PostRESPONSE': [
{
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
]
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ProxyRuleGroup (dict) --
The properties that define the proxy rule group with the newly created proxy rule(s).
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
CreateTime (datetime) --
Time the Proxy Rule Group was created.
DeleteTime (datetime) --
Time the Proxy Rule Group was deleted.
Rules (dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
PreDNS (list) --
Before domain resolution.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PreREQUEST (list) --
After DNS, before request.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
PostRESPONSE (list) --
After receiving response.
(dict) --
Individual rules that define match conditions and actions for application-layer traffic. Rules specify what to inspect (domains, headers, methods) and what action to take (allow, deny, alert).
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
Description (string) --
A description of the proxy rule group.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
Detaches ProxyRuleGroup resources from a ProxyConfiguration
A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.
See also: AWS API Documentation
Request Syntax
client.detach_rule_groups_from_proxy_configuration(
ProxyConfigurationName='string',
ProxyConfigurationArn='string',
RuleGroupNames=[
'string',
],
RuleGroupArns=[
'string',
],
UpdateToken='string'
)
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
list
The proxy rule group names to detach from the proxy configuration
(string) --
list
The proxy rule group arns to detach from the proxy configuration
(string) --
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.
dict
Response Syntax
{
'ProxyConfiguration': {
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'RuleGroups': [
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'Type': 'string',
'Priority': 123
},
],
'DefaultRulePhaseActions': {
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyConfiguration (dict) --
The updated proxy configuration resource that reflects the updates from the request.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
Description (string) --
A description of the proxy configuration.
CreateTime (datetime) --
Time the Proxy Configuration was created.
DeleteTime (datetime) --
Time the Proxy Configuration was deleted.
RuleGroups (list) --
Proxy rule groups within the proxy configuration.
(dict) --
Proxy rule group contained within a proxy configuration.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
Type (string) --
Proxy rule group type.
Priority (integer) --
Priority of the proxy rule group in the proxy configuration.
DefaultRulePhaseActions (dict) --
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
Pre-DNS - before domain resolution.
Pre-Request - after DNS, before request.
Post-Response - after receiving response.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
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.
Returns the data objects for the specified proxy configuration.
See also: AWS API Documentation
Request Syntax
client.describe_proxy_configuration(
ProxyConfigurationName='string',
ProxyConfigurationArn='string'
)
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'ProxyConfiguration': {
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'RuleGroups': [
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'Type': 'string',
'Priority': 123
},
],
'DefaultRulePhaseActions': {
'PreDNS': 'ALLOW'|'DENY'|'ALERT',
'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyConfiguration (dict) --
The configuration for the specified proxy configuration.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
Description (string) --
A description of the proxy configuration.
CreateTime (datetime) --
Time the Proxy Configuration was created.
DeleteTime (datetime) --
Time the Proxy Configuration was deleted.
RuleGroups (list) --
Proxy rule groups within the proxy configuration.
(dict) --
Proxy rule group contained within a proxy configuration.
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
Type (string) --
Proxy rule group type.
Priority (integer) --
Priority of the proxy rule group in the proxy configuration.
DefaultRulePhaseActions (dict) --
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
Pre-DNS - before domain resolution.
Pre-Request - after DNS, before request.
Post-Response - after receiving response.
PreDNS (string) --
Before domain resolution.
PreREQUEST (string) --
After DNS, before request.
PostRESPONSE (string) --
After receiving response.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
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.
Retrieves the metadata for the proxy configuration that you have defined. Depending on your setting for max results and the number of proxy configurations, a single call might not return the full list.
See also: AWS API Documentation
Request Syntax
client.list_proxy_configurations(
NextToken='string',
MaxResults=123
)
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
dict
Response Syntax
{
'ProxyConfigurations': [
{
'Name': 'string',
'Arn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProxyConfigurations (list) --
The metadata for the proxy configurations. Depending on your setting for max results and the number of proxy configurations that you have, this might not be the full list.
(dict) --
High-level information about a proxy configuration, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy configuration. You can retrieve all objects for a proxy configuration by calling DescribeProxyConfiguration.
Name (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
Arn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Updates the properties of the specified proxy rule.
See also: AWS API Documentation
Request Syntax
client.update_proxy_rule(
ProxyRuleGroupName='string',
ProxyRuleGroupArn='string',
ProxyRuleName='string',
Description='string',
Action='ALLOW'|'DENY'|'ALERT',
AddConditions=[
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
],
RemoveConditions=[
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
],
UpdateToken='string'
)
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
string
[REQUIRED]
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
string
A description of the proxy rule.
string
Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.
list
Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
list
Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
string
[REQUIRED]
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.
To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule 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.
dict
Response Syntax
{
'ProxyRule': {
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
'RemovedConditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
],
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyRule (dict) --
The updated proxy rule resource that reflects the updates from the request.
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
RemovedConditions (list) --
Proxy rule conditions removed from the rule.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.
To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule 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.
Updates the properties of the specified proxy.
See also: AWS API Documentation
Request Syntax
client.update_proxy(
NatGatewayId='string',
ProxyName='string',
ProxyArn='string',
ListenerPropertiesToAdd=[
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
ListenerPropertiesToRemove=[
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
TlsInterceptProperties={
'PcaArn': 'string',
'TlsInterceptMode': 'ENABLED'|'DISABLED'
},
UpdateToken='string'
)
string
[REQUIRED]
The NAT Gateway the proxy is attached to.
string
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy.
You must specify the ARN or the name, and you can specify both.
list
Listener properties for HTTP and HTTPS traffic to add.
(dict) --
This data type is used specifically for the CreateProxy and UpdateProxy APIs.
Open port for taking HTTP or HTTPS traffic.
Port (integer) -- [REQUIRED]
Port for processing traffic.
Type (string) -- [REQUIRED]
Selection of HTTP or HTTPS traffic.
list
Listener properties for HTTP and HTTPS traffic to remove.
(dict) --
This data type is used specifically for the CreateProxy and UpdateProxy APIs.
Open port for taking HTTP or HTTPS traffic.
Port (integer) -- [REQUIRED]
Port for processing traffic.
Type (string) -- [REQUIRED]
Selection of HTTP or HTTPS traffic.
dict
TLS decryption on traffic to filter on attributes in the HTTP header.
PcaArn (string) --
Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
TlsInterceptMode (string) --
Specifies whether to enable or disable TLS Intercept Mode.
string
[REQUIRED]
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.
To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy 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.
dict
Response Syntax
{
'Proxy': {
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'FailureCode': 'string',
'FailureMessage': 'string',
'ProxyState': 'ATTACHING'|'ATTACHED'|'DETACHING'|'DETACHED'|'ATTACH_FAILED'|'DETACH_FAILED',
'ProxyModifyState': 'MODIFYING'|'COMPLETED'|'FAILED',
'NatGatewayId': 'string',
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'ProxyName': 'string',
'ProxyArn': 'string',
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'TlsInterceptProperties': {
'PcaArn': 'string',
'TlsInterceptMode': 'ENABLED'|'DISABLED'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
Proxy (dict) --
The updated proxy resource that reflects the updates from the request.
CreateTime (datetime) --
Time the Proxy was created.
DeleteTime (datetime) --
Time the Proxy was deleted.
UpdateTime (datetime) --
Time the Proxy was updated.
FailureCode (string) --
Failure code for cases when the Proxy fails to attach or update.
FailureMessage (string) --
Failure message for cases when the Proxy fails to attach or update.
ProxyState (string) --
Current attachment/detachment status of the Proxy.
ProxyModifyState (string) --
Current modification status of the Proxy.
NatGatewayId (string) --
The NAT Gateway for the proxy.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
ProxyName (string) --
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
ProxyArn (string) --
The Amazon Resource Name (ARN) of a proxy.
ListenerProperties (list) --
Listener properties for HTTP and HTTPS traffic.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
TlsInterceptProperties (dict) --
TLS decryption on traffic to filter on attributes in the HTTP header.
PcaArn (string) --
Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
TlsInterceptMode (string) --
Specifies whether to enable or disable TLS Intercept Mode.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.
To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy 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.
Returns the data objects for the specified proxy configuration for the specified proxy rule group.
See also: AWS API Documentation
Request Syntax
client.describe_proxy_rule(
ProxyRuleName='string',
ProxyRuleGroupName='string',
ProxyRuleGroupArn='string'
)
string
[REQUIRED]
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'ProxyRule': {
'ProxyRuleName': 'string',
'Description': 'string',
'Action': 'ALLOW'|'DENY'|'ALERT',
'Conditions': [
{
'ConditionOperator': 'string',
'ConditionKey': 'string',
'ConditionValues': [
'string',
]
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
ProxyRule (dict) --
The configuration for the specified proxy rule.
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
Description (string) --
A description of the proxy rule.
Action (string) --
Action to take.
Conditions (list) --
Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.
(dict) --
Match criteria that specify what traffic attributes to examine.
ConditionOperator (string) --
Defines how to perform a match.
ConditionKey (string) --
Defines what is to be matched.
ConditionValues (list) --
Specifes the exact value that needs to be matched against.
(string) --
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.
To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule 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.
Updates proxy rule priorities within a proxy rule group.
See also: AWS API Documentation
Request Syntax
client.update_proxy_rule_priorities(
ProxyRuleGroupName='string',
ProxyRuleGroupArn='string',
RuleGroupRequestPhase='PRE_DNS'|'PRE_REQ'|'POST_RES',
Rules=[
{
'ProxyRuleName': 'string',
'NewPosition': 123
},
],
UpdateToken='string'
)
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
string
[REQUIRED]
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
list
[REQUIRED]
proxy rule resources to update to new positions.
(dict) --
Proxy rule name and new desired position.
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
NewPosition (integer) --
Where to move a proxy rule in a proxy rule group.
string
[REQUIRED]
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.
To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group 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.
dict
Response Syntax
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string',
'RuleGroupRequestPhase': 'PRE_DNS'|'PRE_REQ'|'POST_RES',
'Rules': [
{
'ProxyRuleName': 'string',
'NewPosition': 123
},
],
'UpdateToken': 'string'
}
Response Structure
(dict) --
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
RuleGroupRequestPhase (string) --
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
Rules (list) --
The updated proxy rule hierarchy that reflects the updates from the request.
(dict) --
Proxy rule name and new desired position.
ProxyRuleName (string) --
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.
NewPosition (integer) --
Where to move a proxy rule in a proxy rule group.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.
To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule group 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.
Updates proxy rule group priorities within a proxy configuration.
See also: AWS API Documentation
Request Syntax
client.update_proxy_rule_group_priorities(
ProxyConfigurationName='string',
ProxyConfigurationArn='string',
RuleGroups=[
{
'ProxyRuleGroupName': 'string',
'NewPosition': 123
},
],
UpdateToken='string'
)
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.
string
The Amazon Resource Name (ARN) of a proxy configuration.
You must specify the ARN or the name, and you can specify both.
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.
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.
dict
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.
Returns the data objects for the specified proxy.
See also: AWS API Documentation
Request Syntax
client.describe_proxy(
ProxyName='string',
ProxyArn='string'
)
string
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'Proxy': {
'ProxyName': 'string',
'ProxyArn': 'string',
'ProxyConfigurationName': 'string',
'ProxyConfigurationArn': 'string',
'NatGatewayId': 'string',
'ProxyState': 'ATTACHING'|'ATTACHED'|'DETACHING'|'DETACHED'|'ATTACH_FAILED'|'DETACH_FAILED',
'ProxyModifyState': 'MODIFYING'|'COMPLETED'|'FAILED',
'ListenerProperties': [
{
'Port': 123,
'Type': 'HTTP'|'HTTPS'
},
],
'TlsInterceptProperties': {
'PcaArn': 'string',
'TlsInterceptMode': 'ENABLED'|'DISABLED'
},
'VpcEndpointServiceName': 'string',
'PrivateDNSName': 'string',
'CreateTime': datetime(2015, 1, 1),
'DeleteTime': datetime(2015, 1, 1),
'UpdateTime': datetime(2015, 1, 1),
'FailureCode': 'string',
'FailureMessage': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'UpdateToken': 'string'
}
Response Structure
(dict) --
Proxy (dict) --
Proxy attached to a NAT gateway.
ProxyName (string) --
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
ProxyArn (string) --
The Amazon Resource Name (ARN) of a proxy.
ProxyConfigurationName (string) --
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.
ProxyConfigurationArn (string) --
The Amazon Resource Name (ARN) of a proxy configuration.
NatGatewayId (string) --
The NAT Gateway for the proxy.
ProxyState (string) --
Current attachment/detachment status of the Proxy.
ProxyModifyState (string) --
Current modification status of the Proxy.
ListenerProperties (list) --
Listener properties for HTTP and HTTPS traffic.
(dict) --
Open port for taking HTTP or HTTPS traffic.
Port (integer) --
Port for processing traffic.
Type (string) --
Selection of HTTP or HTTPS traffic.
TlsInterceptProperties (dict) --
TLS decryption on traffic to filter on attributes in the HTTP header.
PcaArn (string) --
Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.
TlsInterceptMode (string) --
Specifies whether to enable or disable TLS Intercept Mode.
VpcEndpointServiceName (string) --
The service endpoint created in the VPC.
PrivateDNSName (string) --
The private DNS name of the Proxy.
CreateTime (datetime) --
Time the Proxy was created.
DeleteTime (datetime) --
Time the Proxy was deleted.
UpdateTime (datetime) --
Time the Proxy was updated.
FailureCode (string) --
Failure code for cases when the Proxy fails to attach or update.
FailureMessage (string) --
Failure message for cases when the Proxy fails to attach or update.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
UpdateToken (string) --
A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.
To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy 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.
Retrieves the metadata for the proxies that you have defined. Depending on your setting for max results and the number of proxies, a single call might not return the full list.
See also: AWS API Documentation
Request Syntax
client.list_proxies(
NextToken='string',
MaxResults=123
)
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
dict
Response Syntax
{
'Proxies': [
{
'Name': 'string',
'Arn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Proxies (list) --
The metadata for the proxies. Depending on your setting for max results and the number of proxies that you have, this might not be the full list.
(dict) --
High-level information about a proxy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy. You can retrieve all objects for a proxy by calling DescribeProxy.
Name (string) --
The descriptive name of the proxy. You can't change the name of a proxy after you create it.
Arn (string) --
The Amazon Resource Name (ARN) of a proxy.
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.
See also: AWS API Documentation
Request Syntax
client.list_proxy_rule_groups(
NextToken='string',
MaxResults=123
)
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
dict
Response Syntax
{
'ProxyRuleGroups': [
{
'Name': 'string',
'Arn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProxyRuleGroups (list) --
The metadata for the proxy rule groups. Depending on your setting for max results and the number of proxy rule groups that you have, this might not be the full list.
(dict) --
High-level information about a proxy rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy rule group. You can retrieve all objects for a proxy rule group by calling DescribeProxyRuleGroup.
Name (string) --
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
Arn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
Deletes the specified ProxyRuleGroup.
See also: AWS API Documentation
Request Syntax
client.delete_proxy_rule_group(
ProxyRuleGroupName='string',
ProxyRuleGroupArn='string'
)
string
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of a proxy rule group.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'ProxyRuleGroupName': 'string',
'ProxyRuleGroupArn': 'string'
}
Response Structure
(dict) --
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.
ProxyRuleGroupArn (string) --
The Amazon Resource Name (ARN) of a proxy rule group.