# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AcceptNetworkFirewallTransitGatewayAttachment](API_AcceptNetworkFirewallTransitGatewayAttachment.md) 
+  [AssociateAvailabilityZones](API_AssociateAvailabilityZones.md) 
+  [AssociateFirewallPolicy](API_AssociateFirewallPolicy.md) 
+  [AssociateSubnets](API_AssociateSubnets.md) 
+  [AttachRuleGroupsToProxyConfiguration](API_AttachRuleGroupsToProxyConfiguration.md) 
+  [CreateFirewall](API_CreateFirewall.md) 
+  [CreateFirewallPolicy](API_CreateFirewallPolicy.md) 
+  [CreateProxy](API_CreateProxy.md) 
+  [CreateProxyConfiguration](API_CreateProxyConfiguration.md) 
+  [CreateProxyRuleGroup](API_CreateProxyRuleGroup.md) 
+  [CreateProxyRules](API_CreateProxyRules.md) 
+  [CreateRuleGroup](API_CreateRuleGroup.md) 
+  [CreateTLSInspectionConfiguration](API_CreateTLSInspectionConfiguration.md) 
+  [CreateVpcEndpointAssociation](API_CreateVpcEndpointAssociation.md) 
+  [DeleteFirewall](API_DeleteFirewall.md) 
+  [DeleteFirewallPolicy](API_DeleteFirewallPolicy.md) 
+  [DeleteNetworkFirewallTransitGatewayAttachment](API_DeleteNetworkFirewallTransitGatewayAttachment.md) 
+  [DeleteProxy](API_DeleteProxy.md) 
+  [DeleteProxyConfiguration](API_DeleteProxyConfiguration.md) 
+  [DeleteProxyRuleGroup](API_DeleteProxyRuleGroup.md) 
+  [DeleteProxyRules](API_DeleteProxyRules.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeleteRuleGroup](API_DeleteRuleGroup.md) 
+  [DeleteTLSInspectionConfiguration](API_DeleteTLSInspectionConfiguration.md) 
+  [DeleteVpcEndpointAssociation](API_DeleteVpcEndpointAssociation.md) 
+  [DescribeFirewall](API_DescribeFirewall.md) 
+  [DescribeFirewallMetadata](API_DescribeFirewallMetadata.md) 
+  [DescribeFirewallPolicy](API_DescribeFirewallPolicy.md) 
+  [DescribeFlowOperation](API_DescribeFlowOperation.md) 
+  [DescribeLoggingConfiguration](API_DescribeLoggingConfiguration.md) 
+  [DescribeProxy](API_DescribeProxy.md) 
+  [DescribeProxyConfiguration](API_DescribeProxyConfiguration.md) 
+  [DescribeProxyRule](API_DescribeProxyRule.md) 
+  [DescribeProxyRuleGroup](API_DescribeProxyRuleGroup.md) 
+  [DescribeResourcePolicy](API_DescribeResourcePolicy.md) 
+  [DescribeRuleGroup](API_DescribeRuleGroup.md) 
+  [DescribeRuleGroupMetadata](API_DescribeRuleGroupMetadata.md) 
+  [DescribeRuleGroupSummary](API_DescribeRuleGroupSummary.md) 
+  [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md) 
+  [DescribeVpcEndpointAssociation](API_DescribeVpcEndpointAssociation.md) 
+  [DetachRuleGroupsFromProxyConfiguration](API_DetachRuleGroupsFromProxyConfiguration.md) 
+  [DisassociateAvailabilityZones](API_DisassociateAvailabilityZones.md) 
+  [DisassociateSubnets](API_DisassociateSubnets.md) 
+  [GetAnalysisReportResults](API_GetAnalysisReportResults.md) 
+  [ListAnalysisReports](API_ListAnalysisReports.md) 
+  [ListFirewallPolicies](API_ListFirewallPolicies.md) 
+  [ListFirewalls](API_ListFirewalls.md) 
+  [ListFlowOperationResults](API_ListFlowOperationResults.md) 
+  [ListFlowOperations](API_ListFlowOperations.md) 
+  [ListProxies](API_ListProxies.md) 
+  [ListProxyConfigurations](API_ListProxyConfigurations.md) 
+  [ListProxyRuleGroups](API_ListProxyRuleGroups.md) 
+  [ListRuleGroups](API_ListRuleGroups.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTLSInspectionConfigurations](API_ListTLSInspectionConfigurations.md) 
+  [ListVpcEndpointAssociations](API_ListVpcEndpointAssociations.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [RejectNetworkFirewallTransitGatewayAttachment](API_RejectNetworkFirewallTransitGatewayAttachment.md) 
+  [StartAnalysisReport](API_StartAnalysisReport.md) 
+  [StartFlowCapture](API_StartFlowCapture.md) 
+  [StartFlowFlush](API_StartFlowFlush.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAvailabilityZoneChangeProtection](API_UpdateAvailabilityZoneChangeProtection.md) 
+  [UpdateFirewallAnalysisSettings](API_UpdateFirewallAnalysisSettings.md) 
+  [UpdateFirewallDeleteProtection](API_UpdateFirewallDeleteProtection.md) 
+  [UpdateFirewallDescription](API_UpdateFirewallDescription.md) 
+  [UpdateFirewallEncryptionConfiguration](API_UpdateFirewallEncryptionConfiguration.md) 
+  [UpdateFirewallPolicy](API_UpdateFirewallPolicy.md) 
+  [UpdateFirewallPolicyChangeProtection](API_UpdateFirewallPolicyChangeProtection.md) 
+  [UpdateLoggingConfiguration](API_UpdateLoggingConfiguration.md) 
+  [UpdateProxy](API_UpdateProxy.md) 
+  [UpdateProxyConfiguration](API_UpdateProxyConfiguration.md) 
+  [UpdateProxyRule](API_UpdateProxyRule.md) 
+  [UpdateProxyRuleGroupPriorities](API_UpdateProxyRuleGroupPriorities.md) 
+  [UpdateProxyRulePriorities](API_UpdateProxyRulePriorities.md) 
+  [UpdateRuleGroup](API_UpdateRuleGroup.md) 
+  [UpdateSubnetChangeProtection](API_UpdateSubnetChangeProtection.md) 
+  [UpdateTLSInspectionConfiguration](API_UpdateTLSInspectionConfiguration.md) 

# AcceptNetworkFirewallTransitGatewayAttachment
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment"></a>

Accepts a transit gateway attachment request for Network Firewall. When you accept the attachment request, Network Firewall creates the necessary routing components to enable traffic flow between the transit gateway and firewall endpoints.

You must accept a transit gateway attachment to complete the creation of a transit gateway-attached firewall, unless auto-accept is enabled on the transit gateway. After acceptance, use [DescribeFirewall](API_DescribeFirewall.md) to verify the firewall status.

To reject an attachment instead of accepting it, use [RejectNetworkFirewallTransitGatewayAttachment](API_RejectNetworkFirewallTransitGatewayAttachment.md).

**Note**  
It can take several minutes for the attachment acceptance to complete and the firewall to become available.

## Request Syntax
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment_RequestSyntax"></a>

```
{
   "TransitGatewayAttachmentId": "string"
}
```

## Request Parameters
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TransitGatewayAttachmentId](#API_AcceptNetworkFirewallTransitGatewayAttachment_RequestSyntax) **   <a name="networkfirewall-AcceptNetworkFirewallTransitGatewayAttachment-request-TransitGatewayAttachmentId"></a>
Required. The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$`   
Required: Yes

## Response Syntax
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment_ResponseSyntax"></a>

```
{
   "TransitGatewayAttachmentId": "string",
   "TransitGatewayAttachmentStatus": "string"
}
```

## Response Elements
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TransitGatewayAttachmentId](#API_AcceptNetworkFirewallTransitGatewayAttachment_ResponseSyntax) **   <a name="networkfirewall-AcceptNetworkFirewallTransitGatewayAttachment-response-TransitGatewayAttachmentId"></a>
The unique identifier of the transit gateway attachment that was accepted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$` 

 ** [TransitGatewayAttachmentStatus](#API_AcceptNetworkFirewallTransitGatewayAttachment_ResponseSyntax) **   <a name="networkfirewall-AcceptNetworkFirewallTransitGatewayAttachment-response-TransitGatewayAttachmentStatus"></a>
The current status of the transit gateway attachment. Valid values are:  
+  `CREATING` - The attachment is being created
+  `DELETING` - The attachment is being deleted
+  `DELETED` - The attachment has been deleted
+  `FAILED` - The attachment creation has failed and cannot be recovered
+  `ERROR` - The attachment is in an error state that might be recoverable
+  `READY` - The attachment is active and processing traffic
+  `PENDING_ACCEPTANCE` - The attachment is waiting to be accepted
+  `REJECTING` - The attachment is in the process of being rejected
+  `REJECTED` - The attachment has been rejected
Type: String  
Valid Values: `CREATING | DELETING | DELETED | FAILED | ERROR | READY | PENDING_ACCEPTANCE | REJECTING | REJECTED` 

## Errors
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_AcceptNetworkFirewallTransitGatewayAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/AcceptNetworkFirewallTransitGatewayAttachment) 

# AssociateAvailabilityZones
<a name="API_AssociateAvailabilityZones"></a>

Associates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall.

After adding Availability Zones, you must update your transit gateway route tables to direct traffic through the new firewall endpoints. Use [DescribeFirewall](API_DescribeFirewall.md) to monitor the status of the new endpoints.

## Request Syntax
<a name="API_AssociateAvailabilityZones_RequestSyntax"></a>

```
{
   "AvailabilityZoneMappings": [ 
      { 
         "AvailabilityZone": "string"
      }
   ],
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_AssociateAvailabilityZones_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZoneMappings](#API_AssociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-request-AvailabilityZoneMappings"></a>
Required. The Availability Zones where you want to create firewall endpoints. You must specify at least one Availability Zone.  
Type: Array of [AvailabilityZoneMapping](API_AvailabilityZoneMapping.md) objects  
Required: Yes

 ** [FirewallArn](#API_AssociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_AssociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_AssociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_AssociateAvailabilityZones_ResponseSyntax"></a>

```
{
   "AvailabilityZoneMappings": [ 
      { 
         "AvailabilityZone": "string"
      }
   ],
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_AssociateAvailabilityZones_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AvailabilityZoneMappings](#API_AssociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-response-AvailabilityZoneMappings"></a>
The Availability Zones where Network Firewall created firewall endpoints. Each mapping specifies an Availability Zone where the firewall processes traffic.  
Type: Array of [AvailabilityZoneMapping](API_AvailabilityZoneMapping.md) objects

 ** [FirewallArn](#API_AssociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_AssociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_AssociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-AssociateAvailabilityZones-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_AssociateAvailabilityZones_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateAvailabilityZones_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/AssociateAvailabilityZones) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/AssociateAvailabilityZones) 

# AssociateFirewallPolicy
<a name="API_AssociateFirewallPolicy"></a>

Associates a [FirewallPolicy](API_FirewallPolicy.md) to a [Firewall](API_Firewall.md). 

A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls. 

## Request Syntax
<a name="API_AssociateFirewallPolicy_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "FirewallPolicyArn": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_AssociateFirewallPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_AssociateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_AssociateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [FirewallPolicyArn](#API_AssociateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-request-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the firewall policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [UpdateToken](#API_AssociateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_AssociateFirewallPolicy_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "FirewallPolicyArn": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_AssociateFirewallPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_AssociateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_AssociateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [FirewallPolicyArn](#API_AssociateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-response-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the firewall policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [UpdateToken](#API_AssociateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-AssociateFirewallPolicy-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_AssociateFirewallPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateFirewallPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/AssociateFirewallPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/AssociateFirewallPolicy) 

# AssociateSubnets
<a name="API_AssociateSubnets"></a>

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans. 

This request creates an AWS Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint. 

## Request Syntax
<a name="API_AssociateSubnets_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "SubnetMappings": [ 
      { 
         "IPAddressType": "string",
         "SubnetId": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_AssociateSubnets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_AssociateSubnets_RequestSyntax) **   <a name="networkfirewall-AssociateSubnets-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_AssociateSubnets_RequestSyntax) **   <a name="networkfirewall-AssociateSubnets-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [SubnetMappings](#API_AssociateSubnets_RequestSyntax) **   <a name="networkfirewall-AssociateSubnets-request-SubnetMappings"></a>
The IDs of the subnets that you want to associate with the firewall.   
Type: Array of [SubnetMapping](API_SubnetMapping.md) objects  
Required: Yes

 ** [UpdateToken](#API_AssociateSubnets_RequestSyntax) **   <a name="networkfirewall-AssociateSubnets-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_AssociateSubnets_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "SubnetMappings": [ 
      { 
         "IPAddressType": "string",
         "SubnetId": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_AssociateSubnets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_AssociateSubnets_ResponseSyntax) **   <a name="networkfirewall-AssociateSubnets-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_AssociateSubnets_ResponseSyntax) **   <a name="networkfirewall-AssociateSubnets-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [SubnetMappings](#API_AssociateSubnets_ResponseSyntax) **   <a name="networkfirewall-AssociateSubnets-response-SubnetMappings"></a>
The IDs of the subnets that are associated with the firewall.   
Type: Array of [SubnetMapping](API_SubnetMapping.md) objects

 ** [UpdateToken](#API_AssociateSubnets_ResponseSyntax) **   <a name="networkfirewall-AssociateSubnets-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_AssociateSubnets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateSubnets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/AssociateSubnets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/AssociateSubnets) 

# AttachRuleGroupsToProxyConfiguration
<a name="API_AttachRuleGroupsToProxyConfiguration"></a>

Attaches [ProxyRuleGroup](API_ProxyRuleGroup.md) resources to a [ProxyConfiguration](API_ProxyConfiguration.md) 

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. 

## Request Syntax
<a name="API_AttachRuleGroupsToProxyConfiguration_RequestSyntax"></a>

```
{
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string",
   "RuleGroups": [ 
      { 
         "InsertPosition": number,
         "ProxyRuleGroupName": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_AttachRuleGroupsToProxyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyConfigurationArn](#API_AttachRuleGroupsToProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-AttachRuleGroupsToProxyConfiguration-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_AttachRuleGroupsToProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-AttachRuleGroupsToProxyConfiguration-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [RuleGroups](#API_AttachRuleGroupsToProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-AttachRuleGroupsToProxyConfiguration-request-RuleGroups"></a>
The proxy rule group(s) to attach to the proxy configuration  
Type: Array of [ProxyRuleGroupAttachment](API_ProxyRuleGroupAttachment.md) objects  
Required: Yes

 ** [UpdateToken](#API_AttachRuleGroupsToProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-AttachRuleGroupsToProxyConfiguration-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_AttachRuleGroupsToProxyConfiguration_ResponseSyntax"></a>

```
{
   "ProxyConfiguration": { 
      "CreateTime": number,
      "DefaultRulePhaseActions": { 
         "PostRESPONSE": "string",
         "PreDNS": "string",
         "PreREQUEST": "string"
      },
      "DeleteTime": number,
      "Description": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "RuleGroups": [ 
         { 
            "Priority": number,
            "ProxyRuleGroupArn": "string",
            "ProxyRuleGroupName": "string",
            "Type": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_AttachRuleGroupsToProxyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyConfiguration](#API_AttachRuleGroupsToProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-AttachRuleGroupsToProxyConfiguration-response-ProxyConfiguration"></a>
The updated proxy configuration resource that reflects the updates from the request.  
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object

 ** [UpdateToken](#API_AttachRuleGroupsToProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-AttachRuleGroupsToProxyConfiguration-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_AttachRuleGroupsToProxyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_AttachRuleGroupsToProxyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/AttachRuleGroupsToProxyConfiguration) 

# CreateFirewall
<a name="API_CreateFirewall"></a>

Creates an AWS Network Firewall [Firewall](API_Firewall.md) and accompanying [FirewallStatus](API_FirewallStatus.md) for a VPC. 

The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource. 

After you create a firewall, you can provide additional settings, like the logging configuration. 

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example [UpdateLoggingConfiguration](API_UpdateLoggingConfiguration.md), [AssociateSubnets](API_AssociateSubnets.md), and [UpdateFirewallDeleteProtection](API_UpdateFirewallDeleteProtection.md). 

To manage a firewall's tags, use the standard AWS resource tagging operations, [ListTagsForResource](API_ListTagsForResource.md), [TagResource](API_TagResource.md), and [UntagResource](API_UntagResource.md).

To retrieve information about firewalls, use [ListFirewalls](API_ListFirewalls.md) and [DescribeFirewall](API_DescribeFirewall.md).

To generate a report on the last 30 days of traffic monitored by a firewall, use [StartAnalysisReport](API_StartAnalysisReport.md).

## Request Syntax
<a name="API_CreateFirewall_RequestSyntax"></a>

```
{
   "AvailabilityZoneChangeProtection": boolean,
   "AvailabilityZoneMappings": [ 
      { 
         "AvailabilityZone": "string"
      }
   ],
   "DeleteProtection": boolean,
   "Description": "string",
   "EnabledAnalysisTypes": [ "string" ],
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "FirewallName": "string",
   "FirewallPolicyArn": "string",
   "FirewallPolicyChangeProtection": boolean,
   "SubnetChangeProtection": boolean,
   "SubnetMappings": [ 
      { 
         "IPAddressType": "string",
         "SubnetId": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TransitGatewayId": "string",
   "VpcId": "string"
}
```

## Request Parameters
<a name="API_CreateFirewall_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZoneChangeProtection](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-AvailabilityZoneChangeProtection"></a>
Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to `TRUE`, you cannot add or remove Availability Zones without first disabling this protection using [UpdateAvailabilityZoneChangeProtection](API_UpdateAvailabilityZoneChangeProtection.md).  
Default value: `FALSE`   
Type: Boolean  
Required: No

 ** [AvailabilityZoneMappings](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-AvailabilityZoneMappings"></a>
Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.  
You can modify Availability Zones later using [AssociateAvailabilityZones](API_AssociateAvailabilityZones.md) or [DisassociateAvailabilityZones](API_DisassociateAvailabilityZones.md), but this may briefly disrupt traffic. The `AvailabilityZoneChangeProtection` setting controls whether you can make these modifications.  
Type: Array of [AvailabilityZoneMapping](API_AvailabilityZoneMapping.md) objects  
Required: No

 ** [DeleteProtection](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-DeleteProtection"></a>
A flag indicating whether it is possible to delete the firewall. A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE`.  
Type: Boolean  
Required: No

 ** [Description](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-Description"></a>
A description of the firewall.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [EnabledAnalysisTypes](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-EnabledAnalysisTypes"></a>
An optional setting indicating the specific traffic analysis types to enable on the firewall.   
Type: Array of strings  
Valid Values: `TLS_SNI | HTTP_HOST`   
Required: No

 ** [EncryptionConfiguration](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-EncryptionConfiguration"></a>
A complex type that contains settings for encryption of your firewall resources.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [FirewallName](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [FirewallPolicyArn](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the [FirewallPolicy](API_FirewallPolicy.md) that you want to use for the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [FirewallPolicyChangeProtection](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-FirewallPolicyChangeProtection"></a>
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean  
Required: No

 ** [SubnetChangeProtection](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-SubnetChangeProtection"></a>
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean  
Required: No

 ** [SubnetMappings](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-SubnetMappings"></a>
The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.   
Type: Array of [SubnetMapping](API_SubnetMapping.md) objects  
Required: No

 ** [Tags](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

 ** [TransitGatewayId](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-TransitGatewayId"></a>
Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through AWS Resource Access Manager.  
After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.
For information about creating firewalls, see [CreateFirewall](#API_CreateFirewall). For specific guidance about transit gateway-attached firewalls, see [Considerations for transit gateway-attached firewalls](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tgw-firewall-considerations.html) in the * AWS Network Firewall Developer Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-[0-9a-z]+$`   
Required: No

 ** [VpcId](#API_CreateFirewall_RequestSyntax) **   <a name="networkfirewall-CreateFirewall-request-VpcId"></a>
The unique identifier of the VPC where Network Firewall should create the firewall.   
You can't change this setting after you create the firewall.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^vpc-[0-9a-f]+$`   
Required: No

## Response Syntax
<a name="API_CreateFirewall_ResponseSyntax"></a>

```
{
   "Firewall": { 
      "AvailabilityZoneChangeProtection": boolean,
      "AvailabilityZoneMappings": [ 
         { 
            "AvailabilityZone": "string"
         }
      ],
      "DeleteProtection": boolean,
      "Description": "string",
      "EnabledAnalysisTypes": [ "string" ],
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallArn": "string",
      "FirewallId": "string",
      "FirewallName": "string",
      "FirewallPolicyArn": "string",
      "FirewallPolicyChangeProtection": boolean,
      "NumberOfAssociations": number,
      "SubnetChangeProtection": boolean,
      "SubnetMappings": [ 
         { 
            "IPAddressType": "string",
            "SubnetId": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TransitGatewayId": "string",
      "TransitGatewayOwnerAccountId": "string",
      "VpcId": "string"
   },
   "FirewallStatus": { 
      "CapacityUsageSummary": { 
         "CIDRs": { 
            "AvailableCIDRCount": number,
            "IPSetReferences": { 
               "string" : { 
                  "ResolvedCIDRCount": number
               }
            },
            "UtilizedCIDRCount": number
         }
      },
      "ConfigurationSyncStateSummary": "string",
      "Status": "string",
      "SyncStates": { 
         "string" : { 
            "Attachment": { 
               "EndpointId": "string",
               "Status": "string",
               "StatusMessage": "string",
               "SubnetId": "string"
            },
            "Config": { 
               "string" : { 
                  "SyncStatus": "string",
                  "UpdateToken": "string"
               }
            }
         }
      },
      "TransitGatewayAttachmentSyncState": { 
         "AttachmentId": "string",
         "StatusMessage": "string",
         "TransitGatewayAttachmentStatus": "string"
      }
   }
}
```

## Response Elements
<a name="API_CreateFirewall_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Firewall](#API_CreateFirewall_ResponseSyntax) **   <a name="networkfirewall-CreateFirewall-response-Firewall"></a>
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.   
Type: [Firewall](API_Firewall.md) object

 ** [FirewallStatus](#API_CreateFirewall_ResponseSyntax) **   <a name="networkfirewall-CreateFirewall-response-FirewallStatus"></a>
Detailed information about the current status of a [Firewall](API_Firewall.md). You can retrieve this for a firewall by calling [DescribeFirewall](API_DescribeFirewall.md) and providing the firewall name and ARN.  
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.   
Type: [FirewallStatus](API_FirewallStatus.md) object

## Errors
<a name="API_CreateFirewall_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateFirewall_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateFirewall) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateFirewall) 

# CreateFirewallPolicy
<a name="API_CreateFirewallPolicy"></a>

Creates the firewall policy for the firewall according to the specifications. 

An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls. 

## Request Syntax
<a name="API_CreateFirewallPolicy_RequestSyntax"></a>

```
{
   "Description": "string",
   "DryRun": boolean,
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "FirewallPolicy": { 
      "EnableTLSSessionHolding": boolean,
      "PolicyVariables": { 
         "RuleVariables": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         }
      },
      "StatefulDefaultActions": [ "string" ],
      "StatefulEngineOptions": { 
         "FlowTimeouts": { 
            "TcpIdleTimeoutSeconds": number
         },
         "RuleOrder": "string",
         "StreamExceptionPolicy": "string"
      },
      "StatefulRuleGroupReferences": [ 
         { 
            "DeepThreatInspection": boolean,
            "Override": { 
               "Action": "string"
            },
            "Priority": number,
            "ResourceArn": "string"
         }
      ],
      "StatelessCustomActions": [ 
         { 
            "ActionDefinition": { 
               "PublishMetricAction": { 
                  "Dimensions": [ 
                     { 
                        "Value": "string"
                     }
                  ]
               }
            },
            "ActionName": "string"
         }
      ],
      "StatelessDefaultActions": [ "string" ],
      "StatelessFragmentDefaultActions": [ "string" ],
      "StatelessRuleGroupReferences": [ 
         { 
            "Priority": number,
            "ResourceArn": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string"
   },
   "FirewallPolicyName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateFirewallPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_CreateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-request-Description"></a>
A description of the firewall policy.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [DryRun](#API_CreateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-request-DryRun"></a>
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.   
If set to `TRUE`, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to `FALSE`, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.   
If set to `FALSE`, Network Firewall makes the requested changes to your resources.   
Type: Boolean  
Required: No

 ** [EncryptionConfiguration](#API_CreateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-request-EncryptionConfiguration"></a>
A complex type that contains settings for encryption of your firewall policy resources.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [FirewallPolicy](#API_CreateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-request-FirewallPolicy"></a>
The rule groups and policy actions to use in the firewall policy.  
Type: [FirewallPolicy](API_FirewallPolicy.md) object  
Required: Yes

 ** [FirewallPolicyName](#API_CreateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-request-FirewallPolicyName"></a>
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [Tags](#API_CreateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateFirewallPolicy_ResponseSyntax"></a>

```
{
   "FirewallPolicyResponse": { 
      "ConsumedStatefulDomainCapacity": number,
      "ConsumedStatefulRuleCapacity": number,
      "ConsumedStatelessRuleCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallPolicyArn": "string",
      "FirewallPolicyId": "string",
      "FirewallPolicyName": "string",
      "FirewallPolicyStatus": "string",
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateFirewallPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallPolicyResponse](#API_CreateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-response-FirewallPolicyResponse"></a>
The high-level properties of a firewall policy. This, along with the [FirewallPolicy](API_FirewallPolicy.md), define the policy. You can retrieve all objects for a firewall policy by calling [DescribeFirewallPolicy](API_DescribeFirewallPolicy.md).   
Type: [FirewallPolicyResponse](API_FirewallPolicyResponse.md) object

 ** [UpdateToken](#API_CreateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-CreateFirewallPolicy-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.   
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateFirewallPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateFirewallPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateFirewallPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateFirewallPolicy) 

# CreateProxy
<a name="API_CreateProxy"></a>

Creates an AWS Network Firewall [Proxy](API_Proxy.md) 

Attaches a Proxy configuration to a NAT Gateway. 

To manage a proxy's tags, use the standard AWS resource tagging operations, [ListTagsForResource](API_ListTagsForResource.md), [TagResource](API_TagResource.md), and [UntagResource](API_UntagResource.md).

To retrieve information about proxies, use [ListProxies](API_ListProxies.md) and [DescribeProxy](API_DescribeProxy.md).

## Request Syntax
<a name="API_CreateProxy_RequestSyntax"></a>

```
{
   "ListenerProperties": [ 
      { 
         "Port": number,
         "Type": "string"
      }
   ],
   "NatGatewayId": "string",
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string",
   "ProxyName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TlsInterceptProperties": { 
      "PcaArn": "string",
      "TlsInterceptMode": "string"
   }
}
```

## Request Parameters
<a name="API_CreateProxy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ListenerProperties](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-ListenerProperties"></a>
Listener properties for HTTP and HTTPS traffic.  
Type: Array of [ListenerPropertyRequest](API_ListenerPropertyRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

 ** [NatGatewayId](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-NatGatewayId"></a>
A unique identifier for the NAT gateway to use with proxy resources.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [ProxyConfigurationArn](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [ProxyName](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-ProxyName"></a>
The descriptive name of the proxy. You can't change the name of a proxy after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [Tags](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

 ** [TlsInterceptProperties](#API_CreateProxy_RequestSyntax) **   <a name="networkfirewall-CreateProxy-request-TlsInterceptProperties"></a>
TLS decryption on traffic to filter on attributes in the HTTP header.   
Type: [TlsInterceptPropertiesRequest](API_TlsInterceptPropertiesRequest.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateProxy_ResponseSyntax"></a>

```
{
   "Proxy": { 
      "CreateTime": number,
      "DeleteTime": number,
      "FailureCode": "string",
      "FailureMessage": "string",
      "ListenerProperties": [ 
         { 
            "Port": number,
            "Type": "string"
         }
      ],
      "NatGatewayId": "string",
      "ProxyArn": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "ProxyModifyState": "string",
      "ProxyName": "string",
      "ProxyState": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TlsInterceptProperties": { 
         "PcaArn": "string",
         "TlsInterceptMode": "string"
      },
      "UpdateTime": number
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Proxy](#API_CreateProxy_ResponseSyntax) **   <a name="networkfirewall-CreateProxy-response-Proxy"></a>
Proxy attached to a NAT gateway.   
Type: [Proxy](API_Proxy.md) object

 ** [UpdateToken](#API_CreateProxy_ResponseSyntax) **   <a name="networkfirewall-CreateProxy-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation you requested isn't supported by Network Firewall.   
HTTP Status Code: 400

## See Also
<a name="API_CreateProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateProxy) 

# CreateProxyConfiguration
<a name="API_CreateProxyConfiguration"></a>

Creates an AWS Network Firewall [ProxyConfiguration](API_ProxyConfiguration.md) 

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 AWS resource tagging operations, [ListTagsForResource](API_ListTagsForResource.md), [TagResource](API_TagResource.md), and [UntagResource](API_UntagResource.md).

To retrieve information about proxies, use [ListProxyConfigurations](API_ListProxyConfigurations.md) and [DescribeProxyConfiguration](API_DescribeProxyConfiguration.md).

## Request Syntax
<a name="API_CreateProxyConfiguration_RequestSyntax"></a>

```
{
   "DefaultRulePhaseActions": { 
      "PostRESPONSE": "string",
      "PreDNS": "string",
      "PreREQUEST": "string"
   },
   "Description": "string",
   "ProxyConfigurationName": "string",
   "RuleGroupArns": [ "string" ],
   "RuleGroupNames": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateProxyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DefaultRulePhaseActions](#API_CreateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-request-DefaultRulePhaseActions"></a>
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.   
Type: [ProxyConfigDefaultRulePhaseActionsRequest](API_ProxyConfigDefaultRulePhaseActionsRequest.md) object  
Required: Yes

 ** [Description](#API_CreateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-request-Description"></a>
A description of the proxy configuration.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [ProxyConfigurationName](#API_CreateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-request-ProxyConfigurationName"></a>
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [RuleGroupArns](#API_CreateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-request-RuleGroupArns"></a>
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.   
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupNames](#API_CreateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-request-RuleGroupNames"></a>
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.   
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Tags](#API_CreateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateProxyConfiguration_ResponseSyntax"></a>

```
{
   "ProxyConfiguration": { 
      "CreateTime": number,
      "DefaultRulePhaseActions": { 
         "PostRESPONSE": "string",
         "PreDNS": "string",
         "PreREQUEST": "string"
      },
      "DeleteTime": number,
      "Description": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "RuleGroups": [ 
         { 
            "Priority": number,
            "ProxyRuleGroupArn": "string",
            "ProxyRuleGroupName": "string",
            "Type": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateProxyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyConfiguration](#API_CreateProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-response-ProxyConfiguration"></a>
The properties that define the proxy configuration.   
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object

 ** [UpdateToken](#API_CreateProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-CreateProxyConfiguration-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateProxyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProxyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateProxyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateProxyConfiguration) 

# CreateProxyRuleGroup
<a name="API_CreateProxyRuleGroup"></a>

Creates an AWS Network Firewall [ProxyRuleGroup](API_ProxyRuleGroup.md) 

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 AWS resource tagging operations, [ListTagsForResource](API_ListTagsForResource.md), [TagResource](API_TagResource.md), and [UntagResource](API_UntagResource.md).

To retrieve information about proxy rule groups, use [ListProxyRuleGroups](API_ListProxyRuleGroups.md) and [DescribeProxyRuleGroup](API_DescribeProxyRuleGroup.md).

To retrieve information about individual proxy rules, use [DescribeProxyRuleGroup](API_DescribeProxyRuleGroup.md) and [DescribeProxyRule](API_DescribeProxyRule.md).

## Request Syntax
<a name="API_CreateProxyRuleGroup_RequestSyntax"></a>

```
{
   "Description": "string",
   "ProxyRuleGroupName": "string",
   "Rules": { 
      "PostRESPONSE": [ 
         { 
            "Action": "string",
            "Conditions": [ 
               { 
                  "ConditionKey": "string",
                  "ConditionOperator": "string",
                  "ConditionValues": [ "string" ]
               }
            ],
            "Description": "string",
            "ProxyRuleName": "string"
         }
      ],
      "PreDNS": [ 
         { 
            "Action": "string",
            "Conditions": [ 
               { 
                  "ConditionKey": "string",
                  "ConditionOperator": "string",
                  "ConditionValues": [ "string" ]
               }
            ],
            "Description": "string",
            "ProxyRuleName": "string"
         }
      ],
      "PreREQUEST": [ 
         { 
            "Action": "string",
            "Conditions": [ 
               { 
                  "ConditionKey": "string",
                  "ConditionOperator": "string",
                  "ConditionValues": [ "string" ]
               }
            ],
            "Description": "string",
            "ProxyRuleName": "string"
         }
      ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateProxyRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_CreateProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateProxyRuleGroup-request-Description"></a>
A description of the proxy rule group.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [ProxyRuleGroupName](#API_CreateProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateProxyRuleGroup-request-ProxyRuleGroupName"></a>
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [Rules](#API_CreateProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateProxyRuleGroup-request-Rules"></a>
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).   
Type: [ProxyRulesByRequestPhase](API_ProxyRulesByRequestPhase.md) object  
Required: No

 ** [Tags](#API_CreateProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateProxyRuleGroup-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateProxyRuleGroup_ResponseSyntax"></a>

```
{
   "ProxyRuleGroup": { 
      "CreateTime": number,
      "DeleteTime": number,
      "Description": "string",
      "ProxyRuleGroupArn": "string",
      "ProxyRuleGroupName": "string",
      "Rules": { 
         "PostRESPONSE": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreDNS": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreREQUEST": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateProxyRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroup](#API_CreateProxyRuleGroup_ResponseSyntax) **   <a name="networkfirewall-CreateProxyRuleGroup-response-ProxyRuleGroup"></a>
The properties that define the proxy rule group.   
Type: [ProxyRuleGroup](API_ProxyRuleGroup.md) object

 ** [UpdateToken](#API_CreateProxyRuleGroup_ResponseSyntax) **   <a name="networkfirewall-CreateProxyRuleGroup-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateProxyRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProxyRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateProxyRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateProxyRuleGroup) 

# CreateProxyRules
<a name="API_CreateProxyRules"></a>

Creates AWS Network Firewall [ProxyRule](API_ProxyRule.md) resources. 

Attaches new proxy rule(s) to an existing proxy rule group. 

To retrieve information about individual proxy rules, use [DescribeProxyRuleGroup](API_DescribeProxyRuleGroup.md) and [DescribeProxyRule](API_DescribeProxyRule.md).

## Request Syntax
<a name="API_CreateProxyRules_RequestSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string",
   "Rules": { 
      "PostRESPONSE": [ 
         { 
            "Action": "string",
            "Conditions": [ 
               { 
                  "ConditionKey": "string",
                  "ConditionOperator": "string",
                  "ConditionValues": [ "string" ]
               }
            ],
            "Description": "string",
            "InsertPosition": number,
            "ProxyRuleName": "string"
         }
      ],
      "PreDNS": [ 
         { 
            "Action": "string",
            "Conditions": [ 
               { 
                  "ConditionKey": "string",
                  "ConditionOperator": "string",
                  "ConditionValues": [ "string" ]
               }
            ],
            "Description": "string",
            "InsertPosition": number,
            "ProxyRuleName": "string"
         }
      ],
      "PreREQUEST": [ 
         { 
            "Action": "string",
            "Conditions": [ 
               { 
                  "ConditionKey": "string",
                  "ConditionOperator": "string",
                  "ConditionValues": [ "string" ]
               }
            ],
            "Description": "string",
            "InsertPosition": number,
            "ProxyRuleName": "string"
         }
      ]
   }
}
```

## Request Parameters
<a name="API_CreateProxyRules_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyRuleGroupArn](#API_CreateProxyRules_RequestSyntax) **   <a name="networkfirewall-CreateProxyRules-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_CreateProxyRules_RequestSyntax) **   <a name="networkfirewall-CreateProxyRules-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Rules](#API_CreateProxyRules_RequestSyntax) **   <a name="networkfirewall-CreateProxyRules-request-Rules"></a>
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).   
Type: [CreateProxyRulesByRequestPhase](API_CreateProxyRulesByRequestPhase.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateProxyRules_ResponseSyntax"></a>

```
{
   "ProxyRuleGroup": { 
      "CreateTime": number,
      "DeleteTime": number,
      "Description": "string",
      "ProxyRuleGroupArn": "string",
      "ProxyRuleGroupName": "string",
      "Rules": { 
         "PostRESPONSE": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreDNS": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreREQUEST": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateProxyRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroup](#API_CreateProxyRules_ResponseSyntax) **   <a name="networkfirewall-CreateProxyRules-response-ProxyRuleGroup"></a>
The properties that define the proxy rule group with the newly created proxy rule(s).   
Type: [ProxyRuleGroup](API_ProxyRuleGroup.md) object

 ** [UpdateToken](#API_CreateProxyRules_ResponseSyntax) **   <a name="networkfirewall-CreateProxyRules-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateProxyRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProxyRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateProxyRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateProxyRules) 

# CreateRuleGroup
<a name="API_CreateRuleGroup"></a>

Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags. 

You provide your rule group specification in your request using either `RuleGroup` or `Rules`.

## Request Syntax
<a name="API_CreateRuleGroup_RequestSyntax"></a>

```
{
   "AnalyzeRuleGroup": boolean,
   "Capacity": number,
   "Description": "string",
   "DryRun": boolean,
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "RuleGroup": { 
      "ReferenceSets": { 
         "IPSetReferences": { 
            "string" : { 
               "ReferenceArn": "string"
            }
         }
      },
      "RulesSource": { 
         "RulesSourceList": { 
            "GeneratedRulesType": "string",
            "Targets": [ "string" ],
            "TargetTypes": [ "string" ]
         },
         "RulesString": "string",
         "StatefulRules": [ 
            { 
               "Action": "string",
               "Header": { 
                  "Destination": "string",
                  "DestinationPort": "string",
                  "Direction": "string",
                  "Protocol": "string",
                  "Source": "string",
                  "SourcePort": "string"
               },
               "RuleOptions": [ 
                  { 
                     "Keyword": "string",
                     "Settings": [ "string" ]
                  }
               ]
            }
         ],
         "StatelessRulesAndCustomActions": { 
            "CustomActions": [ 
               { 
                  "ActionDefinition": { 
                     "PublishMetricAction": { 
                        "Dimensions": [ 
                           { 
                              "Value": "string"
                           }
                        ]
                     }
                  },
                  "ActionName": "string"
               }
            ],
            "StatelessRules": [ 
               { 
                  "Priority": number,
                  "RuleDefinition": { 
                     "Actions": [ "string" ],
                     "MatchAttributes": { 
                        "DestinationPorts": [ 
                           { 
                              "FromPort": number,
                              "ToPort": number
                           }
                        ],
                        "Destinations": [ 
                           { 
                              "AddressDefinition": "string"
                           }
                        ],
                        "Protocols": [ number ],
                        "SourcePorts": [ 
                           { 
                              "FromPort": number,
                              "ToPort": number
                           }
                        ],
                        "Sources": [ 
                           { 
                              "AddressDefinition": "string"
                           }
                        ],
                        "TCPFlags": [ 
                           { 
                              "Flags": [ "string" ],
                              "Masks": [ "string" ]
                           }
                        ]
                     }
                  }
               }
            ]
         }
      },
      "RuleVariables": { 
         "IPSets": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         },
         "PortSets": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         }
      },
      "StatefulRuleOptions": { 
         "RuleOrder": "string"
      }
   },
   "RuleGroupName": "string",
   "Rules": "string",
   "SourceMetadata": { 
      "SourceArn": "string",
      "SourceUpdateToken": "string"
   },
   "SummaryConfiguration": { 
      "RuleOptions": [ "string" ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string"
}
```

## Request Parameters
<a name="API_CreateRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AnalyzeRuleGroup](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-AnalyzeRuleGroup"></a>
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to `TRUE`, Network Firewall runs the analysis and then creates the rule group for you. To run the stateless rule group analyzer without creating the rule group, set `DryRun` to `TRUE`.  
Type: Boolean  
Required: No

 ** [Capacity](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-Capacity"></a>
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.   
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling [CreateRuleGroup](#API_CreateRuleGroup) with `DryRun` set to `TRUE`.   
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow. 
 **Capacity for a stateless rule group**   
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.   
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:  
+ A match setting with no criteria specified has a value of 1. 
+ A match setting with `Any` specified has a value of 1. 
+ All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3. 
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.   
 **Capacity for a stateful rule group**   
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.   
Type: Integer  
Required: Yes

 ** [Description](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-Description"></a>
A description of the rule group.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [DryRun](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-DryRun"></a>
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.   
If set to `TRUE`, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to `FALSE`, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.   
If set to `FALSE`, Network Firewall makes the requested changes to your resources.   
Type: Boolean  
Required: No

 ** [EncryptionConfiguration](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-EncryptionConfiguration"></a>
A complex type that contains settings for encryption of your rule group resources.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [RuleGroup](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-RuleGroup"></a>
An object that defines the rule group rules.   
You must provide either this rule group setting or a `Rules` setting, but not both. 
Type: [RuleGroup](API_RuleGroup.md) object  
Required: No

 ** [RuleGroupName](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [Rules](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-Rules"></a>
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.   
You must provide either this rules setting or a populated `RuleGroup` setting, but not both. 
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a [RuleGroup](API_RuleGroup.md) object that Network Firewall has populated from your string.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000000.  
Required: No

 ** [SourceMetadata](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-SourceMetadata"></a>
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.  
Type: [SourceMetadata](API_SourceMetadata.md) object  
Required: No

 ** [SummaryConfiguration](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-SummaryConfiguration"></a>
An object that contains a `RuleOptions` array of strings. You use `RuleOptions` to determine which of the following [RuleSummary](API_RuleSummary.md) values are returned in response to `DescribeRuleGroupSummary`.  
+  `Metadata` - returns
+  `Msg` 
+  `SID` 
Type: [SummaryConfiguration](API_SummaryConfiguration.md) object  
Required: No

 ** [Tags](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

 ** [Type](#API_CreateRuleGroup_RequestSyntax) **   <a name="networkfirewall-CreateRuleGroup-request-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.   
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: Yes

## Response Syntax
<a name="API_CreateRuleGroup_ResponseSyntax"></a>

```
{
   "RuleGroupResponse": { 
      "AnalysisResults": [ 
         { 
            "AnalysisDetail": "string",
            "IdentifiedRuleIds": [ "string" ],
            "IdentifiedType": "string"
         }
      ],
      "Capacity": number,
      "ConsumedCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "RuleGroupArn": "string",
      "RuleGroupId": "string",
      "RuleGroupName": "string",
      "RuleGroupStatus": "string",
      "SnsTopic": "string",
      "SourceMetadata": { 
         "SourceArn": "string",
         "SourceUpdateToken": "string"
      },
      "SummaryConfiguration": { 
         "RuleOptions": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RuleGroupResponse](#API_CreateRuleGroup_ResponseSyntax) **   <a name="networkfirewall-CreateRuleGroup-response-RuleGroupResponse"></a>
The high-level properties of a rule group. This, along with the [RuleGroup](API_RuleGroup.md), define the rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](API_DescribeRuleGroup.md).   
Type: [RuleGroupResponse](API_RuleGroupResponse.md) object

 ** [UpdateToken](#API_CreateRuleGroup_ResponseSyntax) **   <a name="networkfirewall-CreateRuleGroup-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.   
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the 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 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateRuleGroup) 

# CreateTLSInspectionConfiguration
<a name="API_CreateTLSInspectionConfiguration"></a>

Creates an AWS Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.

To update the settings for a TLS inspection configuration, use [UpdateTLSInspectionConfiguration](API_UpdateTLSInspectionConfiguration.md).

To manage a TLS inspection configuration's tags, use the standard AWS resource tagging operations, [ListTagsForResource](API_ListTagsForResource.md), [TagResource](API_TagResource.md), and [UntagResource](API_UntagResource.md).

To retrieve information about TLS inspection configurations, use [ListTLSInspectionConfigurations](API_ListTLSInspectionConfigurations.md) and [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md).

 For more information about TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the * AWS Network Firewall Developer Guide*. 

## Request Syntax
<a name="API_CreateTLSInspectionConfiguration_RequestSyntax"></a>

```
{
   "Description": "string",
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TLSInspectionConfiguration": { 
      "ServerCertificateConfigurations": [ 
         { 
            "CertificateAuthorityArn": "string",
            "CheckCertificateRevocationStatus": { 
               "RevokedStatusAction": "string",
               "UnknownStatusAction": "string"
            },
            "Scopes": [ 
               { 
                  "DestinationPorts": [ 
                     { 
                        "FromPort": number,
                        "ToPort": number
                     }
                  ],
                  "Destinations": [ 
                     { 
                        "AddressDefinition": "string"
                     }
                  ],
                  "Protocols": [ number ],
                  "SourcePorts": [ 
                     { 
                        "FromPort": number,
                        "ToPort": number
                     }
                  ],
                  "Sources": [ 
                     { 
                        "AddressDefinition": "string"
                     }
                  ]
               }
            ],
            "ServerCertificates": [ 
               { 
                  "ResourceArn": "string"
               }
            ]
         }
      ]
   },
   "TLSInspectionConfigurationName": "string"
}
```

## Request Parameters
<a name="API_CreateTLSInspectionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_CreateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-request-Description"></a>
A description of the TLS inspection configuration.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [EncryptionConfiguration](#API_CreateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-request-EncryptionConfiguration"></a>
A complex type that contains optional AWS Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an AWS owned key that AWS owns and manages for you. You can use either the AWS owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see [Encryption at rest with AWS Key Managment Service](https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) in the *Network Firewall Developer Guide*.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [Tags](#API_CreateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

 ** [TLSInspectionConfiguration](#API_CreateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-request-TLSInspectionConfiguration"></a>
The object that defines a TLS inspection configuration. This, along with [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md).   
 AWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.  
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the * AWS Network Firewall Developer Guide*.  
Type: [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md) object  
Required: Yes

 ** [TLSInspectionConfigurationName](#API_CreateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-request-TLSInspectionConfigurationName"></a>
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

## Response Syntax
<a name="API_CreateTLSInspectionConfiguration_ResponseSyntax"></a>

```
{
   "TLSInspectionConfigurationResponse": { 
      "CertificateAuthority": { 
         "CertificateArn": "string",
         "CertificateSerial": "string",
         "Status": "string",
         "StatusMessage": "string"
      },
      "Certificates": [ 
         { 
            "CertificateArn": "string",
            "CertificateSerial": "string",
            "Status": "string",
            "StatusMessage": "string"
         }
      ],
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string",
      "TLSInspectionConfigurationId": "string",
      "TLSInspectionConfigurationName": "string",
      "TLSInspectionConfigurationStatus": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_CreateTLSInspectionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TLSInspectionConfigurationResponse](#API_CreateTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-response-TLSInspectionConfigurationResponse"></a>
The high-level properties of a TLS inspection configuration. This, along with the [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md).   
Type: [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md) object

 ** [UpdateToken](#API_CreateTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-CreateTLSInspectionConfiguration-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.   
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the TLS inspection 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_CreateTLSInspectionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateTLSInspectionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateTLSInspectionConfiguration) 

# CreateVpcEndpointAssociation
<a name="API_CreateVpcEndpointAssociation"></a>

Creates a firewall endpoint for an AWS Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the `Firewall` itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications. 

## Request Syntax
<a name="API_CreateVpcEndpointAssociation_RequestSyntax"></a>

```
{
   "Description": "string",
   "FirewallArn": "string",
   "SubnetMapping": { 
      "IPAddressType": "string",
      "SubnetId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VpcId": "string"
}
```

## Request Parameters
<a name="API_CreateVpcEndpointAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_CreateVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-request-Description"></a>
A description of the VPC endpoint association.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [FirewallArn](#API_CreateVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [SubnetMapping](#API_CreateVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-request-SubnetMapping"></a>
The ID for a subnet that's used in an association with a firewall. This is used in [CreateFirewall](API_CreateFirewall.md), [AssociateSubnets](API_AssociateSubnets.md), and [CreateVpcEndpointAssociation](#API_CreateVpcEndpointAssociation). AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.  
Type: [SubnetMapping](API_SubnetMapping.md) object  
Required: Yes

 ** [Tags](#API_CreateVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-request-Tags"></a>
The key:value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

 ** [VpcId](#API_CreateVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-request-VpcId"></a>
The unique identifier of the VPC where you want to create a firewall endpoint.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^vpc-[0-9a-f]+$`   
Required: Yes

## Response Syntax
<a name="API_CreateVpcEndpointAssociation_ResponseSyntax"></a>

```
{
   "VpcEndpointAssociation": { 
      "Description": "string",
      "FirewallArn": "string",
      "SubnetMapping": { 
         "IPAddressType": "string",
         "SubnetId": "string"
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "VpcEndpointAssociationArn": "string",
      "VpcEndpointAssociationId": "string",
      "VpcId": "string"
   },
   "VpcEndpointAssociationStatus": { 
      "AssociationSyncState": { 
         "string" : { 
            "Attachment": { 
               "EndpointId": "string",
               "Status": "string",
               "StatusMessage": "string",
               "SubnetId": "string"
            }
         }
      },
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_CreateVpcEndpointAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VpcEndpointAssociation](#API_CreateVpcEndpointAssociation_ResponseSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-response-VpcEndpointAssociation"></a>
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.   
Type: [VpcEndpointAssociation](API_VpcEndpointAssociation.md) object

 ** [VpcEndpointAssociationStatus](#API_CreateVpcEndpointAssociation_ResponseSyntax) **   <a name="networkfirewall-CreateVpcEndpointAssociation-response-VpcEndpointAssociationStatus"></a>
Detailed information about the current status of a [VpcEndpointAssociation](API_VpcEndpointAssociation.md). You can retrieve this by calling [DescribeVpcEndpointAssociation](API_DescribeVpcEndpointAssociation.md) and providing the VPC endpoint association ARN.  
Type: [VpcEndpointAssociationStatus](API_VpcEndpointAssociationStatus.md) object

## Errors
<a name="API_CreateVpcEndpointAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapacityException **   
 AWS doesn't currently have enough available capacity to fulfill your request. Try your request later.   
HTTP Status Code: 500

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** LimitExceededException **   
Unable to perform the operation because doing so would violate a limit setting.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_CreateVpcEndpointAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/CreateVpcEndpointAssociation) 

# DeleteFirewall
<a name="API_DeleteFirewall"></a>

Deletes the specified [Firewall](API_Firewall.md) and its [FirewallStatus](API_FirewallStatus.md). This operation requires the firewall's `DeleteProtection` flag to be `FALSE`. You can't revert this operation. 

You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling [DescribeFirewall](API_DescribeFirewall.md). You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.

To delete a firewall, remove the delete protection if you need to using [UpdateFirewallDeleteProtection](API_UpdateFirewallDeleteProtection.md), then delete the firewall by calling [DeleteFirewall](#API_DeleteFirewall). 

## Request Syntax
<a name="API_DeleteFirewall_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string"
}
```

## Request Parameters
<a name="API_DeleteFirewall_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_DeleteFirewall_RequestSyntax) **   <a name="networkfirewall-DeleteFirewall-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_DeleteFirewall_RequestSyntax) **   <a name="networkfirewall-DeleteFirewall-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DeleteFirewall_ResponseSyntax"></a>

```
{
   "Firewall": { 
      "AvailabilityZoneChangeProtection": boolean,
      "AvailabilityZoneMappings": [ 
         { 
            "AvailabilityZone": "string"
         }
      ],
      "DeleteProtection": boolean,
      "Description": "string",
      "EnabledAnalysisTypes": [ "string" ],
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallArn": "string",
      "FirewallId": "string",
      "FirewallName": "string",
      "FirewallPolicyArn": "string",
      "FirewallPolicyChangeProtection": boolean,
      "NumberOfAssociations": number,
      "SubnetChangeProtection": boolean,
      "SubnetMappings": [ 
         { 
            "IPAddressType": "string",
            "SubnetId": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TransitGatewayId": "string",
      "TransitGatewayOwnerAccountId": "string",
      "VpcId": "string"
   },
   "FirewallStatus": { 
      "CapacityUsageSummary": { 
         "CIDRs": { 
            "AvailableCIDRCount": number,
            "IPSetReferences": { 
               "string" : { 
                  "ResolvedCIDRCount": number
               }
            },
            "UtilizedCIDRCount": number
         }
      },
      "ConfigurationSyncStateSummary": "string",
      "Status": "string",
      "SyncStates": { 
         "string" : { 
            "Attachment": { 
               "EndpointId": "string",
               "Status": "string",
               "StatusMessage": "string",
               "SubnetId": "string"
            },
            "Config": { 
               "string" : { 
                  "SyncStatus": "string",
                  "UpdateToken": "string"
               }
            }
         }
      },
      "TransitGatewayAttachmentSyncState": { 
         "AttachmentId": "string",
         "StatusMessage": "string",
         "TransitGatewayAttachmentStatus": "string"
      }
   }
}
```

## Response Elements
<a name="API_DeleteFirewall_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Firewall](#API_DeleteFirewall_ResponseSyntax) **   <a name="networkfirewall-DeleteFirewall-response-Firewall"></a>
A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.  
In addition to the firewall endpoints that you define in this `Firewall` specification, you can create firewall endpoints in `VpcEndpointAssociation` resources for any VPC, in any Availability Zone where the firewall is already in use.   
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding [FirewallStatus](API_FirewallStatus.md). You can retrieve both the firewall and firewall status by calling [DescribeFirewall](API_DescribeFirewall.md).  
Type: [Firewall](API_Firewall.md) object

 ** [FirewallStatus](#API_DeleteFirewall_ResponseSyntax) **   <a name="networkfirewall-DeleteFirewall-response-FirewallStatus"></a>
Detailed information about the current status of a [Firewall](API_Firewall.md). You can retrieve this for a firewall by calling [DescribeFirewall](API_DescribeFirewall.md) and providing the firewall name and ARN.  
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.   
Type: [FirewallStatus](API_FirewallStatus.md) object

## Errors
<a name="API_DeleteFirewall_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation you requested isn't supported by Network Firewall.   
HTTP Status Code: 400

## See Also
<a name="API_DeleteFirewall_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteFirewall) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteFirewall) 

# DeleteFirewallPolicy
<a name="API_DeleteFirewallPolicy"></a>

Deletes the specified [FirewallPolicy](API_FirewallPolicy.md). 

## Request Syntax
<a name="API_DeleteFirewallPolicy_RequestSyntax"></a>

```
{
   "FirewallPolicyArn": "string",
   "FirewallPolicyName": "string"
}
```

## Request Parameters
<a name="API_DeleteFirewallPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallPolicyArn](#API_DeleteFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-DeleteFirewallPolicy-request-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the firewall policy.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallPolicyName](#API_DeleteFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-DeleteFirewallPolicy-request-FirewallPolicyName"></a>
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DeleteFirewallPolicy_ResponseSyntax"></a>

```
{
   "FirewallPolicyResponse": { 
      "ConsumedStatefulDomainCapacity": number,
      "ConsumedStatefulRuleCapacity": number,
      "ConsumedStatelessRuleCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallPolicyArn": "string",
      "FirewallPolicyId": "string",
      "FirewallPolicyName": "string",
      "FirewallPolicyStatus": "string",
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DeleteFirewallPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallPolicyResponse](#API_DeleteFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-DeleteFirewallPolicy-response-FirewallPolicyResponse"></a>
The object containing the definition of the [FirewallPolicyResponse](API_FirewallPolicyResponse.md) that you asked to delete.   
Type: [FirewallPolicyResponse](API_FirewallPolicyResponse.md) object

## Errors
<a name="API_DeleteFirewallPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation you requested isn't supported by Network Firewall.   
HTTP Status Code: 400

## See Also
<a name="API_DeleteFirewallPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteFirewallPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteFirewallPolicy) 

# DeleteNetworkFirewallTransitGatewayAttachment
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment"></a>

Deletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment.

**Important**  
After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints.

After you initiate the delete operation, use [DescribeFirewall](API_DescribeFirewall.md) to monitor the deletion status.

## Request Syntax
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment_RequestSyntax"></a>

```
{
   "TransitGatewayAttachmentId": "string"
}
```

## Request Parameters
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TransitGatewayAttachmentId](#API_DeleteNetworkFirewallTransitGatewayAttachment_RequestSyntax) **   <a name="networkfirewall-DeleteNetworkFirewallTransitGatewayAttachment-request-TransitGatewayAttachmentId"></a>
Required. The unique identifier of the transit gateway attachment to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$`   
Required: Yes

## Response Syntax
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment_ResponseSyntax"></a>

```
{
   "TransitGatewayAttachmentId": "string",
   "TransitGatewayAttachmentStatus": "string"
}
```

## Response Elements
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TransitGatewayAttachmentId](#API_DeleteNetworkFirewallTransitGatewayAttachment_ResponseSyntax) **   <a name="networkfirewall-DeleteNetworkFirewallTransitGatewayAttachment-response-TransitGatewayAttachmentId"></a>
The ID of the transit gateway attachment that was deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$` 

 ** [TransitGatewayAttachmentStatus](#API_DeleteNetworkFirewallTransitGatewayAttachment_ResponseSyntax) **   <a name="networkfirewall-DeleteNetworkFirewallTransitGatewayAttachment-response-TransitGatewayAttachmentStatus"></a>
The current status of the transit gateway attachment deletion process.  
Valid values are:  
+  `CREATING` - The attachment is being created
+  `DELETING` - The attachment is being deleted
+  `DELETED` - The attachment has been deleted
+  `FAILED` - The attachment creation has failed and cannot be recovered
+  `ERROR` - The attachment is in an error state that might be recoverable
+  `READY` - The attachment is active and processing traffic
+  `PENDING_ACCEPTANCE` - The attachment is waiting to be accepted
+  `REJECTING` - The attachment is in the process of being rejected
+  `REJECTED` - The attachment has been rejected
Type: String  
Valid Values: `CREATING | DELETING | DELETED | FAILED | ERROR | READY | PENDING_ACCEPTANCE | REJECTING | REJECTED` 

## Errors
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteNetworkFirewallTransitGatewayAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteNetworkFirewallTransitGatewayAttachment) 

# DeleteProxy
<a name="API_DeleteProxy"></a>

Deletes the specified [Proxy](API_Proxy.md). 

Detaches a Proxy configuration from a NAT Gateway. 

## Request Syntax
<a name="API_DeleteProxy_RequestSyntax"></a>

```
{
   "NatGatewayId": "string",
   "ProxyArn": "string",
   "ProxyName": "string"
}
```

## Request Parameters
<a name="API_DeleteProxy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [NatGatewayId](#API_DeleteProxy_RequestSyntax) **   <a name="networkfirewall-DeleteProxy-request-NatGatewayId"></a>
The NAT Gateway the proxy is attached to.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [ProxyArn](#API_DeleteProxy_RequestSyntax) **   <a name="networkfirewall-DeleteProxy-request-ProxyArn"></a>
The Amazon Resource Name (ARN) of a proxy.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyName](#API_DeleteProxy_RequestSyntax) **   <a name="networkfirewall-DeleteProxy-request-ProxyName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DeleteProxy_ResponseSyntax"></a>

```
{
   "NatGatewayId": "string",
   "ProxyArn": "string",
   "ProxyName": "string"
}
```

## Response Elements
<a name="API_DeleteProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NatGatewayId](#API_DeleteProxy_ResponseSyntax) **   <a name="networkfirewall-DeleteProxy-response-NatGatewayId"></a>
The NAT Gateway the Proxy was attached to.   
Type: String  
Length Constraints: Minimum length of 1.

 ** [ProxyArn](#API_DeleteProxy_ResponseSyntax) **   <a name="networkfirewall-DeleteProxy-response-ProxyArn"></a>
The Amazon Resource Name (ARN) of a proxy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [ProxyName](#API_DeleteProxy_ResponseSyntax) **   <a name="networkfirewall-DeleteProxy-response-ProxyName"></a>
The descriptive name of the proxy. You can't change the name of a proxy after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

## Errors
<a name="API_DeleteProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation you requested isn't supported by Network Firewall.   
HTTP Status Code: 400

## See Also
<a name="API_DeleteProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteProxy) 

# DeleteProxyConfiguration
<a name="API_DeleteProxyConfiguration"></a>

Deletes the specified [ProxyConfiguration](API_ProxyConfiguration.md). 

## Request Syntax
<a name="API_DeleteProxyConfiguration_RequestSyntax"></a>

```
{
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string"
}
```

## Request Parameters
<a name="API_DeleteProxyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyConfigurationArn](#API_DeleteProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DeleteProxyConfiguration-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_DeleteProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DeleteProxyConfiguration-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DeleteProxyConfiguration_ResponseSyntax"></a>

```
{
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string"
}
```

## Response Elements
<a name="API_DeleteProxyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyConfigurationArn](#API_DeleteProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-DeleteProxyConfiguration-response-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [ProxyConfigurationName](#API_DeleteProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-DeleteProxyConfiguration-response-ProxyConfigurationName"></a>
The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

## Errors
<a name="API_DeleteProxyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProxyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteProxyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteProxyConfiguration) 

# DeleteProxyRuleGroup
<a name="API_DeleteProxyRuleGroup"></a>

Deletes the specified [ProxyRuleGroup](API_ProxyRuleGroup.md). 

## Request Syntax
<a name="API_DeleteProxyRuleGroup_RequestSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string"
}
```

## Request Parameters
<a name="API_DeleteProxyRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyRuleGroupArn](#API_DeleteProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-DeleteProxyRuleGroup-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_DeleteProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-DeleteProxyRuleGroup-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DeleteProxyRuleGroup_ResponseSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string"
}
```

## Response Elements
<a name="API_DeleteProxyRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroupArn](#API_DeleteProxyRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DeleteProxyRuleGroup-response-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [ProxyRuleGroupName](#API_DeleteProxyRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DeleteProxyRuleGroup-response-ProxyRuleGroupName"></a>
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

## Errors
<a name="API_DeleteProxyRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProxyRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteProxyRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteProxyRuleGroup) 

# DeleteProxyRules
<a name="API_DeleteProxyRules"></a>

Deletes the specified [ProxyRule](API_ProxyRule.md)(s). currently attached to a [ProxyRuleGroup](API_ProxyRuleGroup.md) 

## Request Syntax
<a name="API_DeleteProxyRules_RequestSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string",
   "Rules": [ "string" ]
}
```

## Request Parameters
<a name="API_DeleteProxyRules_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyRuleGroupArn](#API_DeleteProxyRules_RequestSyntax) **   <a name="networkfirewall-DeleteProxyRules-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_DeleteProxyRules_RequestSyntax) **   <a name="networkfirewall-DeleteProxyRules-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Rules](#API_DeleteProxyRules_RequestSyntax) **   <a name="networkfirewall-DeleteProxyRules-request-Rules"></a>
The proxy rule(s) to remove from the existing proxy rule group.   
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

## Response Syntax
<a name="API_DeleteProxyRules_ResponseSyntax"></a>

```
{
   "ProxyRuleGroup": { 
      "CreateTime": number,
      "DeleteTime": number,
      "Description": "string",
      "ProxyRuleGroupArn": "string",
      "ProxyRuleGroupName": "string",
      "Rules": { 
         "PostRESPONSE": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreDNS": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreREQUEST": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DeleteProxyRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroup](#API_DeleteProxyRules_ResponseSyntax) **   <a name="networkfirewall-DeleteProxyRules-response-ProxyRuleGroup"></a>
The properties that define the proxy rule group with the newly created proxy rule(s).   
Type: [ProxyRuleGroup](API_ProxyRuleGroup.md) object

## Errors
<a name="API_DeleteProxyRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProxyRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteProxyRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteProxyRules) 

# DeleteResourcePolicy
<a name="API_DeleteResourcePolicy"></a>

Deletes a resource policy that you created in a [PutResourcePolicy](API_PutResourcePolicy.md) request. 

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="networkfirewall-DeleteResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidResourcePolicyException **   
The policy statement failed validation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteResourcePolicy) 

# DeleteRuleGroup
<a name="API_DeleteRuleGroup"></a>

Deletes the specified [RuleGroup](API_RuleGroup.md). 

## Request Syntax
<a name="API_DeleteRuleGroup_RequestSyntax"></a>

```
{
   "RuleGroupArn": "string",
   "RuleGroupName": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DeleteRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RuleGroupArn](#API_DeleteRuleGroup_RequestSyntax) **   <a name="networkfirewall-DeleteRuleGroup-request-RuleGroupArn"></a>
The Amazon Resource Name (ARN) of the rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupName](#API_DeleteRuleGroup_RequestSyntax) **   <a name="networkfirewall-DeleteRuleGroup-request-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Type](#API_DeleteRuleGroup_RequestSyntax) **   <a name="networkfirewall-DeleteRuleGroup-request-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.   
This setting is required for requests that do not include the `RuleGroupARN`.
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: No

## Response Syntax
<a name="API_DeleteRuleGroup_ResponseSyntax"></a>

```
{
   "RuleGroupResponse": { 
      "AnalysisResults": [ 
         { 
            "AnalysisDetail": "string",
            "IdentifiedRuleIds": [ "string" ],
            "IdentifiedType": "string"
         }
      ],
      "Capacity": number,
      "ConsumedCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "RuleGroupArn": "string",
      "RuleGroupId": "string",
      "RuleGroupName": "string",
      "RuleGroupStatus": "string",
      "SnsTopic": "string",
      "SourceMetadata": { 
         "SourceArn": "string",
         "SourceUpdateToken": "string"
      },
      "SummaryConfiguration": { 
         "RuleOptions": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_DeleteRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RuleGroupResponse](#API_DeleteRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DeleteRuleGroup-response-RuleGroupResponse"></a>
The high-level properties of a rule group. This, along with the [RuleGroup](API_RuleGroup.md), define the rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](API_DescribeRuleGroup.md).   
Type: [RuleGroupResponse](API_RuleGroupResponse.md) object

## Errors
<a name="API_DeleteRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation you requested isn't supported by Network Firewall.   
HTTP Status Code: 400

## See Also
<a name="API_DeleteRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteRuleGroup) 

# DeleteTLSInspectionConfiguration
<a name="API_DeleteTLSInspectionConfiguration"></a>

Deletes the specified [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md).

## Request Syntax
<a name="API_DeleteTLSInspectionConfiguration_RequestSyntax"></a>

```
{
   "TLSInspectionConfigurationArn": "string",
   "TLSInspectionConfigurationName": "string"
}
```

## Request Parameters
<a name="API_DeleteTLSInspectionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TLSInspectionConfigurationArn](#API_DeleteTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-DeleteTLSInspectionConfiguration-request-TLSInspectionConfigurationArn"></a>
The Amazon Resource Name (ARN) of the TLS inspection configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [TLSInspectionConfigurationName](#API_DeleteTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-DeleteTLSInspectionConfiguration-request-TLSInspectionConfigurationName"></a>
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DeleteTLSInspectionConfiguration_ResponseSyntax"></a>

```
{
   "TLSInspectionConfigurationResponse": { 
      "CertificateAuthority": { 
         "CertificateArn": "string",
         "CertificateSerial": "string",
         "Status": "string",
         "StatusMessage": "string"
      },
      "Certificates": [ 
         { 
            "CertificateArn": "string",
            "CertificateSerial": "string",
            "Status": "string",
            "StatusMessage": "string"
         }
      ],
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string",
      "TLSInspectionConfigurationId": "string",
      "TLSInspectionConfigurationName": "string",
      "TLSInspectionConfigurationStatus": "string"
   }
}
```

## Response Elements
<a name="API_DeleteTLSInspectionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TLSInspectionConfigurationResponse](#API_DeleteTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-DeleteTLSInspectionConfiguration-response-TLSInspectionConfigurationResponse"></a>
The high-level properties of a TLS inspection configuration. This, along with the [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md).   
Type: [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md) object

## Errors
<a name="API_DeleteTLSInspectionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteTLSInspectionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteTLSInspectionConfiguration) 

# DeleteVpcEndpointAssociation
<a name="API_DeleteVpcEndpointAssociation"></a>

Deletes the specified [VpcEndpointAssociation](API_VpcEndpointAssociation.md).

You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling [DescribeVpcEndpointAssociation](API_DescribeVpcEndpointAssociation.md). You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.

## Request Syntax
<a name="API_DeleteVpcEndpointAssociation_RequestSyntax"></a>

```
{
   "VpcEndpointAssociationArn": "string"
}
```

## Request Parameters
<a name="API_DeleteVpcEndpointAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VpcEndpointAssociationArn](#API_DeleteVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-DeleteVpcEndpointAssociation-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

## Response Syntax
<a name="API_DeleteVpcEndpointAssociation_ResponseSyntax"></a>

```
{
   "VpcEndpointAssociation": { 
      "Description": "string",
      "FirewallArn": "string",
      "SubnetMapping": { 
         "IPAddressType": "string",
         "SubnetId": "string"
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "VpcEndpointAssociationArn": "string",
      "VpcEndpointAssociationId": "string",
      "VpcId": "string"
   },
   "VpcEndpointAssociationStatus": { 
      "AssociationSyncState": { 
         "string" : { 
            "Attachment": { 
               "EndpointId": "string",
               "Status": "string",
               "StatusMessage": "string",
               "SubnetId": "string"
            }
         }
      },
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_DeleteVpcEndpointAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VpcEndpointAssociation](#API_DeleteVpcEndpointAssociation_ResponseSyntax) **   <a name="networkfirewall-DeleteVpcEndpointAssociation-response-VpcEndpointAssociation"></a>
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.   
Type: [VpcEndpointAssociation](API_VpcEndpointAssociation.md) object

 ** [VpcEndpointAssociationStatus](#API_DeleteVpcEndpointAssociation_ResponseSyntax) **   <a name="networkfirewall-DeleteVpcEndpointAssociation-response-VpcEndpointAssociationStatus"></a>
Detailed information about the current status of a [VpcEndpointAssociation](API_VpcEndpointAssociation.md). You can retrieve this by calling [DescribeVpcEndpointAssociation](API_DescribeVpcEndpointAssociation.md) and providing the VPC endpoint association ARN.  
Type: [VpcEndpointAssociationStatus](API_VpcEndpointAssociationStatus.md) object

## Errors
<a name="API_DeleteVpcEndpointAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteVpcEndpointAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DeleteVpcEndpointAssociation) 

# DescribeFirewall
<a name="API_DescribeFirewall"></a>

Returns the data objects for the specified firewall. 

## Request Syntax
<a name="API_DescribeFirewall_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string"
}
```

## Request Parameters
<a name="API_DescribeFirewall_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_DescribeFirewall_RequestSyntax) **   <a name="networkfirewall-DescribeFirewall-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_DescribeFirewall_RequestSyntax) **   <a name="networkfirewall-DescribeFirewall-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeFirewall_ResponseSyntax"></a>

```
{
   "Firewall": { 
      "AvailabilityZoneChangeProtection": boolean,
      "AvailabilityZoneMappings": [ 
         { 
            "AvailabilityZone": "string"
         }
      ],
      "DeleteProtection": boolean,
      "Description": "string",
      "EnabledAnalysisTypes": [ "string" ],
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallArn": "string",
      "FirewallId": "string",
      "FirewallName": "string",
      "FirewallPolicyArn": "string",
      "FirewallPolicyChangeProtection": boolean,
      "NumberOfAssociations": number,
      "SubnetChangeProtection": boolean,
      "SubnetMappings": [ 
         { 
            "IPAddressType": "string",
            "SubnetId": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TransitGatewayId": "string",
      "TransitGatewayOwnerAccountId": "string",
      "VpcId": "string"
   },
   "FirewallStatus": { 
      "CapacityUsageSummary": { 
         "CIDRs": { 
            "AvailableCIDRCount": number,
            "IPSetReferences": { 
               "string" : { 
                  "ResolvedCIDRCount": number
               }
            },
            "UtilizedCIDRCount": number
         }
      },
      "ConfigurationSyncStateSummary": "string",
      "Status": "string",
      "SyncStates": { 
         "string" : { 
            "Attachment": { 
               "EndpointId": "string",
               "Status": "string",
               "StatusMessage": "string",
               "SubnetId": "string"
            },
            "Config": { 
               "string" : { 
                  "SyncStatus": "string",
                  "UpdateToken": "string"
               }
            }
         }
      },
      "TransitGatewayAttachmentSyncState": { 
         "AttachmentId": "string",
         "StatusMessage": "string",
         "TransitGatewayAttachmentStatus": "string"
      }
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeFirewall_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Firewall](#API_DescribeFirewall_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewall-response-Firewall"></a>
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.   
Type: [Firewall](API_Firewall.md) object

 ** [FirewallStatus](#API_DescribeFirewall_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewall-response-FirewallStatus"></a>
Detailed information about the current status of a [Firewall](API_Firewall.md). You can retrieve this for a firewall by calling [DescribeFirewall](#API_DescribeFirewall) and providing the firewall name and ARN.  
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.   
Type: [FirewallStatus](API_FirewallStatus.md) object

 ** [UpdateToken](#API_DescribeFirewall_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewall-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeFirewall_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeFirewall_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeFirewall) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeFirewall) 

# DescribeFirewallMetadata
<a name="API_DescribeFirewallMetadata"></a>

Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use. 

## Request Syntax
<a name="API_DescribeFirewallMetadata_RequestSyntax"></a>

```
{
   "FirewallArn": "string"
}
```

## Request Parameters
<a name="API_DescribeFirewallMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_DescribeFirewallMetadata_RequestSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

## Response Syntax
<a name="API_DescribeFirewallMetadata_ResponseSyntax"></a>

```
{
   "Description": "string",
   "FirewallArn": "string",
   "FirewallPolicyArn": "string",
   "Status": "string",
   "SupportedAvailabilityZones": { 
      "string" : { 
         "IPAddressType": "string"
      }
   },
   "TransitGatewayAttachmentId": "string"
}
```

## Response Elements
<a name="API_DescribeFirewallMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_DescribeFirewallMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-response-Description"></a>
A description of the firewall.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$` 

 ** [FirewallArn](#API_DescribeFirewallMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallPolicyArn](#API_DescribeFirewallMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-response-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the firewall policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [Status](#API_DescribeFirewallMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-response-Status"></a>
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is `READY` only when the `ConfigurationSyncStateSummary` value is `IN_SYNC` and the `Attachment` `Status` values for all of the configured subnets are `READY`.   
Type: String  
Valid Values: `PROVISIONING | DELETING | READY` 

 ** [SupportedAvailabilityZones](#API_DescribeFirewallMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-response-SupportedAvailabilityZones"></a>
The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.   
Type: String to [AvailabilityZoneMetadata](API_AvailabilityZoneMetadata.md) object map

 ** [TransitGatewayAttachmentId](#API_DescribeFirewallMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallMetadata-response-TransitGatewayAttachmentId"></a>
The unique identifier of the transit gateway attachment associated with this firewall. This field is only present for transit gateway-attached firewalls.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$` 

## Errors
<a name="API_DescribeFirewallMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeFirewallMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeFirewallMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeFirewallMetadata) 

# DescribeFirewallPolicy
<a name="API_DescribeFirewallPolicy"></a>

Returns the data objects for the specified firewall policy. 

## Request Syntax
<a name="API_DescribeFirewallPolicy_RequestSyntax"></a>

```
{
   "FirewallPolicyArn": "string",
   "FirewallPolicyName": "string"
}
```

## Request Parameters
<a name="API_DescribeFirewallPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallPolicyArn](#API_DescribeFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-DescribeFirewallPolicy-request-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the firewall policy.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallPolicyName](#API_DescribeFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-DescribeFirewallPolicy-request-FirewallPolicyName"></a>
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeFirewallPolicy_ResponseSyntax"></a>

```
{
   "FirewallPolicy": { 
      "EnableTLSSessionHolding": boolean,
      "PolicyVariables": { 
         "RuleVariables": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         }
      },
      "StatefulDefaultActions": [ "string" ],
      "StatefulEngineOptions": { 
         "FlowTimeouts": { 
            "TcpIdleTimeoutSeconds": number
         },
         "RuleOrder": "string",
         "StreamExceptionPolicy": "string"
      },
      "StatefulRuleGroupReferences": [ 
         { 
            "DeepThreatInspection": boolean,
            "Override": { 
               "Action": "string"
            },
            "Priority": number,
            "ResourceArn": "string"
         }
      ],
      "StatelessCustomActions": [ 
         { 
            "ActionDefinition": { 
               "PublishMetricAction": { 
                  "Dimensions": [ 
                     { 
                        "Value": "string"
                     }
                  ]
               }
            },
            "ActionName": "string"
         }
      ],
      "StatelessDefaultActions": [ "string" ],
      "StatelessFragmentDefaultActions": [ "string" ],
      "StatelessRuleGroupReferences": [ 
         { 
            "Priority": number,
            "ResourceArn": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string"
   },
   "FirewallPolicyResponse": { 
      "ConsumedStatefulDomainCapacity": number,
      "ConsumedStatefulRuleCapacity": number,
      "ConsumedStatelessRuleCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallPolicyArn": "string",
      "FirewallPolicyId": "string",
      "FirewallPolicyName": "string",
      "FirewallPolicyStatus": "string",
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeFirewallPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallPolicy](#API_DescribeFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallPolicy-response-FirewallPolicy"></a>
The policy for the specified firewall policy.   
Type: [FirewallPolicy](API_FirewallPolicy.md) object

 ** [FirewallPolicyResponse](#API_DescribeFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallPolicy-response-FirewallPolicyResponse"></a>
The high-level properties of a firewall policy. This, along with the [FirewallPolicy](API_FirewallPolicy.md), define the policy. You can retrieve all objects for a firewall policy by calling [DescribeFirewallPolicy](#API_DescribeFirewallPolicy).   
Type: [FirewallPolicyResponse](API_FirewallPolicyResponse.md) object

 ** [UpdateToken](#API_DescribeFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-DescribeFirewallPolicy-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.   
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeFirewallPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeFirewallPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeFirewallPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeFirewallPolicy) 

# DescribeFlowOperation
<a name="API_DescribeFlowOperation"></a>

Returns key information about a specific flow operation.

## Request Syntax
<a name="API_DescribeFlowOperation_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowOperationId": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Request Parameters
<a name="API_DescribeFlowOperation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_DescribeFlowOperation_RequestSyntax) **   <a name="networkfirewall-DescribeFlowOperation-request-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String  
Required: No

 ** [FirewallArn](#API_DescribeFlowOperation_RequestSyntax) **   <a name="networkfirewall-DescribeFlowOperation-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [FlowOperationId](#API_DescribeFlowOperation_RequestSyntax) **   <a name="networkfirewall-DescribeFlowOperation-request-FlowOperationId"></a>
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

 ** [VpcEndpointAssociationArn](#API_DescribeFlowOperation_RequestSyntax) **   <a name="networkfirewall-DescribeFlowOperation-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [VpcEndpointId](#API_DescribeFlowOperation_RequestSyntax) **   <a name="networkfirewall-DescribeFlowOperation-request-VpcEndpointId"></a>
A unique identifier for the primary endpoint associated with a firewall.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$`   
Required: No

## Response Syntax
<a name="API_DescribeFlowOperation_ResponseSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowOperation": { 
      "FlowFilters": [ 
         { 
            "DestinationAddress": { 
               "AddressDefinition": "string"
            },
            "DestinationPort": "string",
            "Protocols": [ "string" ],
            "SourceAddress": { 
               "AddressDefinition": "string"
            },
            "SourcePort": "string"
         }
      ],
      "MinimumFlowAgeInSeconds": number
   },
   "FlowOperationId": "string",
   "FlowOperationStatus": "string",
   "FlowOperationType": "string",
   "FlowRequestTimestamp": number,
   "StatusMessage": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Response Elements
<a name="API_DescribeFlowOperation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AvailabilityZone](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String

 ** [FirewallArn](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FlowOperation](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-FlowOperation"></a>
Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.  
Type: [FlowOperation](API_FlowOperation.md) object

 ** [FlowOperationId](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-FlowOperationId"></a>
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

 ** [FlowOperationStatus](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-FlowOperationStatus"></a>
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.  
If the status is `COMPLETED_WITH_ERRORS`, results may be returned with any number of `Flows` missing from the response. If the status is `FAILED`, `Flows` returned will be empty.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED | COMPLETED_WITH_ERRORS` 

 ** [FlowOperationType](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-FlowOperationType"></a>
Defines the type of `FlowOperation`.  
Type: String  
Valid Values: `FLOW_FLUSH | FLOW_CAPTURE` 

 ** [FlowRequestTimestamp](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-FlowRequestTimestamp"></a>
A timestamp indicating when the Suricata engine identified flows impacted by an operation.   
Type: Timestamp

 ** [StatusMessage](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-StatusMessage"></a>
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include `Flow operation error` and `Flow timeout`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9- ]+$` 

 ** [VpcEndpointAssociationArn](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [VpcEndpointId](#API_DescribeFlowOperation_ResponseSyntax) **   <a name="networkfirewall-DescribeFlowOperation-response-VpcEndpointId"></a>
A unique identifier for the primary endpoint associated with a firewall.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$` 

## Errors
<a name="API_DescribeFlowOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeFlowOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeFlowOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeFlowOperation) 

# DescribeLoggingConfiguration
<a name="API_DescribeLoggingConfiguration"></a>

Returns the logging configuration for the specified firewall. 

## Request Syntax
<a name="API_DescribeLoggingConfiguration_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string"
}
```

## Request Parameters
<a name="API_DescribeLoggingConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_DescribeLoggingConfiguration_RequestSyntax) **   <a name="networkfirewall-DescribeLoggingConfiguration-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_DescribeLoggingConfiguration_RequestSyntax) **   <a name="networkfirewall-DescribeLoggingConfiguration-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeLoggingConfiguration_ResponseSyntax"></a>

```
{
   "EnableMonitoringDashboard": boolean,
   "FirewallArn": "string",
   "LoggingConfiguration": { 
      "LogDestinationConfigs": [ 
         { 
            "LogDestination": { 
               "string" : "string" 
            },
            "LogDestinationType": "string",
            "LogType": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EnableMonitoringDashboard](#API_DescribeLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeLoggingConfiguration-response-EnableMonitoringDashboard"></a>
A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.  
 Returns `TRUE` when the firewall monitoring dashboard is enabled on the firewall. Returns `FALSE` when the firewall monitoring dashboard is not enabled on the firewall.   
Type: Boolean

 ** [FirewallArn](#API_DescribeLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeLoggingConfiguration-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [LoggingConfiguration](#API_DescribeLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeLoggingConfiguration-response-LoggingConfiguration"></a>
Defines how AWS Network Firewall performs logging for a [Firewall](API_Firewall.md).   
Type: [LoggingConfiguration](API_LoggingConfiguration.md) object

## Errors
<a name="API_DescribeLoggingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeLoggingConfiguration) 

# DescribeProxy
<a name="API_DescribeProxy"></a>

Returns the data objects for the specified proxy. 

## Request Syntax
<a name="API_DescribeProxy_RequestSyntax"></a>

```
{
   "ProxyArn": "string",
   "ProxyName": "string"
}
```

## Request Parameters
<a name="API_DescribeProxy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyArn](#API_DescribeProxy_RequestSyntax) **   <a name="networkfirewall-DescribeProxy-request-ProxyArn"></a>
The Amazon Resource Name (ARN) of a proxy.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyName](#API_DescribeProxy_RequestSyntax) **   <a name="networkfirewall-DescribeProxy-request-ProxyName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeProxy_ResponseSyntax"></a>

```
{
   "Proxy": { 
      "CreateTime": number,
      "DeleteTime": number,
      "FailureCode": "string",
      "FailureMessage": "string",
      "ListenerProperties": [ 
         { 
            "Port": number,
            "Type": "string"
         }
      ],
      "NatGatewayId": "string",
      "PrivateDNSName": "string",
      "ProxyArn": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "ProxyModifyState": "string",
      "ProxyName": "string",
      "ProxyState": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TlsInterceptProperties": { 
         "PcaArn": "string",
         "TlsInterceptMode": "string"
      },
      "UpdateTime": number,
      "VpcEndpointServiceName": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Proxy](#API_DescribeProxy_ResponseSyntax) **   <a name="networkfirewall-DescribeProxy-response-Proxy"></a>
Proxy attached to a NAT gateway.   
Type: [DescribeProxyResource](API_DescribeProxyResource.md) object

 ** [UpdateToken](#API_DescribeProxy_ResponseSyntax) **   <a name="networkfirewall-DescribeProxy-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeProxy) 

# DescribeProxyConfiguration
<a name="API_DescribeProxyConfiguration"></a>

Returns the data objects for the specified proxy configuration. 

## Request Syntax
<a name="API_DescribeProxyConfiguration_RequestSyntax"></a>

```
{
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string"
}
```

## Request Parameters
<a name="API_DescribeProxyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyConfigurationArn](#API_DescribeProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DescribeProxyConfiguration-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_DescribeProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DescribeProxyConfiguration-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeProxyConfiguration_ResponseSyntax"></a>

```
{
   "ProxyConfiguration": { 
      "CreateTime": number,
      "DefaultRulePhaseActions": { 
         "PostRESPONSE": "string",
         "PreDNS": "string",
         "PreREQUEST": "string"
      },
      "DeleteTime": number,
      "Description": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "RuleGroups": [ 
         { 
            "Priority": number,
            "ProxyRuleGroupArn": "string",
            "ProxyRuleGroupName": "string",
            "Type": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeProxyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyConfiguration](#API_DescribeProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeProxyConfiguration-response-ProxyConfiguration"></a>
The configuration for the specified proxy configuration.   
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object

 ** [UpdateToken](#API_DescribeProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeProxyConfiguration-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeProxyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProxyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeProxyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeProxyConfiguration) 

# DescribeProxyRule
<a name="API_DescribeProxyRule"></a>

Returns the data objects for the specified proxy configuration for the specified proxy rule group.

## Request Syntax
<a name="API_DescribeProxyRule_RequestSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string",
   "ProxyRuleName": "string"
}
```

## Request Parameters
<a name="API_DescribeProxyRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyRuleGroupArn](#API_DescribeProxyRule_RequestSyntax) **   <a name="networkfirewall-DescribeProxyRule-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_DescribeProxyRule_RequestSyntax) **   <a name="networkfirewall-DescribeProxyRule-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [ProxyRuleName](#API_DescribeProxyRule_RequestSyntax) **   <a name="networkfirewall-DescribeProxyRule-request-ProxyRuleName"></a>
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

## Response Syntax
<a name="API_DescribeProxyRule_ResponseSyntax"></a>

```
{
   "ProxyRule": { 
      "Action": "string",
      "Conditions": [ 
         { 
            "ConditionKey": "string",
            "ConditionOperator": "string",
            "ConditionValues": [ "string" ]
         }
      ],
      "Description": "string",
      "ProxyRuleName": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeProxyRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRule](#API_DescribeProxyRule_ResponseSyntax) **   <a name="networkfirewall-DescribeProxyRule-response-ProxyRule"></a>
The configuration for the specified proxy rule.   
Type: [ProxyRule](API_ProxyRule.md) object

 ** [UpdateToken](#API_DescribeProxyRule_ResponseSyntax) **   <a name="networkfirewall-DescribeProxyRule-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeProxyRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProxyRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeProxyRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeProxyRule) 

# DescribeProxyRuleGroup
<a name="API_DescribeProxyRuleGroup"></a>

Returns the data objects for the specified proxy rule group. 

## Request Syntax
<a name="API_DescribeProxyRuleGroup_RequestSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string"
}
```

## Request Parameters
<a name="API_DescribeProxyRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyRuleGroupArn](#API_DescribeProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-DescribeProxyRuleGroup-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_DescribeProxyRuleGroup_RequestSyntax) **   <a name="networkfirewall-DescribeProxyRuleGroup-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeProxyRuleGroup_ResponseSyntax"></a>

```
{
   "ProxyRuleGroup": { 
      "CreateTime": number,
      "DeleteTime": number,
      "Description": "string",
      "ProxyRuleGroupArn": "string",
      "ProxyRuleGroupName": "string",
      "Rules": { 
         "PostRESPONSE": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreDNS": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ],
         "PreREQUEST": [ 
            { 
               "Action": "string",
               "Conditions": [ 
                  { 
                     "ConditionKey": "string",
                     "ConditionOperator": "string",
                     "ConditionValues": [ "string" ]
                  }
               ],
               "Description": "string",
               "ProxyRuleName": "string"
            }
         ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeProxyRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroup](#API_DescribeProxyRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DescribeProxyRuleGroup-response-ProxyRuleGroup"></a>
The configuration for the specified proxy rule group.   
Type: [ProxyRuleGroup](API_ProxyRuleGroup.md) object

 ** [UpdateToken](#API_DescribeProxyRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DescribeProxyRuleGroup-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeProxyRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProxyRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeProxyRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeProxyRuleGroup) 

# DescribeResourcePolicy
<a name="API_DescribeResourcePolicy"></a>

Retrieves a resource policy that you created in a [PutResourcePolicy](API_PutResourcePolicy.md) request. 

## Request Syntax
<a name="API_DescribeResourcePolicy_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_DescribeResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_DescribeResourcePolicy_RequestSyntax) **   <a name="networkfirewall-DescribeResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

## Response Syntax
<a name="API_DescribeResourcePolicy_ResponseSyntax"></a>

```
{
   "Policy": "string"
}
```

## Response Elements
<a name="API_DescribeResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Policy](#API_DescribeResourcePolicy_ResponseSyntax) **   <a name="networkfirewall-DescribeResourcePolicy-response-Policy"></a>
The IAM policy for the resource.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 395000.  
Pattern: `.*\S.*` 

## Errors
<a name="API_DescribeResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeResourcePolicy) 

# DescribeRuleGroup
<a name="API_DescribeRuleGroup"></a>

Returns the data objects for the specified rule group. 

## Request Syntax
<a name="API_DescribeRuleGroup_RequestSyntax"></a>

```
{
   "AnalyzeRuleGroup": boolean,
   "RuleGroupArn": "string",
   "RuleGroupName": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DescribeRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AnalyzeRuleGroup](#API_DescribeRuleGroup_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroup-request-AnalyzeRuleGroup"></a>
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to `TRUE`, Network Firewall runs the analysis.  
Type: Boolean  
Required: No

 ** [RuleGroupArn](#API_DescribeRuleGroup_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroup-request-RuleGroupArn"></a>
The Amazon Resource Name (ARN) of the rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupName](#API_DescribeRuleGroup_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroup-request-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Type](#API_DescribeRuleGroup_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroup-request-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.   
This setting is required for requests that do not include the `RuleGroupARN`.
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: No

## Response Syntax
<a name="API_DescribeRuleGroup_ResponseSyntax"></a>

```
{
   "RuleGroup": { 
      "ReferenceSets": { 
         "IPSetReferences": { 
            "string" : { 
               "ReferenceArn": "string"
            }
         }
      },
      "RulesSource": { 
         "RulesSourceList": { 
            "GeneratedRulesType": "string",
            "Targets": [ "string" ],
            "TargetTypes": [ "string" ]
         },
         "RulesString": "string",
         "StatefulRules": [ 
            { 
               "Action": "string",
               "Header": { 
                  "Destination": "string",
                  "DestinationPort": "string",
                  "Direction": "string",
                  "Protocol": "string",
                  "Source": "string",
                  "SourcePort": "string"
               },
               "RuleOptions": [ 
                  { 
                     "Keyword": "string",
                     "Settings": [ "string" ]
                  }
               ]
            }
         ],
         "StatelessRulesAndCustomActions": { 
            "CustomActions": [ 
               { 
                  "ActionDefinition": { 
                     "PublishMetricAction": { 
                        "Dimensions": [ 
                           { 
                              "Value": "string"
                           }
                        ]
                     }
                  },
                  "ActionName": "string"
               }
            ],
            "StatelessRules": [ 
               { 
                  "Priority": number,
                  "RuleDefinition": { 
                     "Actions": [ "string" ],
                     "MatchAttributes": { 
                        "DestinationPorts": [ 
                           { 
                              "FromPort": number,
                              "ToPort": number
                           }
                        ],
                        "Destinations": [ 
                           { 
                              "AddressDefinition": "string"
                           }
                        ],
                        "Protocols": [ number ],
                        "SourcePorts": [ 
                           { 
                              "FromPort": number,
                              "ToPort": number
                           }
                        ],
                        "Sources": [ 
                           { 
                              "AddressDefinition": "string"
                           }
                        ],
                        "TCPFlags": [ 
                           { 
                              "Flags": [ "string" ],
                              "Masks": [ "string" ]
                           }
                        ]
                     }
                  }
               }
            ]
         }
      },
      "RuleVariables": { 
         "IPSets": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         },
         "PortSets": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         }
      },
      "StatefulRuleOptions": { 
         "RuleOrder": "string"
      }
   },
   "RuleGroupResponse": { 
      "AnalysisResults": [ 
         { 
            "AnalysisDetail": "string",
            "IdentifiedRuleIds": [ "string" ],
            "IdentifiedType": "string"
         }
      ],
      "Capacity": number,
      "ConsumedCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "RuleGroupArn": "string",
      "RuleGroupId": "string",
      "RuleGroupName": "string",
      "RuleGroupStatus": "string",
      "SnsTopic": "string",
      "SourceMetadata": { 
         "SourceArn": "string",
         "SourceUpdateToken": "string"
      },
      "SummaryConfiguration": { 
         "RuleOptions": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RuleGroup](#API_DescribeRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroup-response-RuleGroup"></a>
The object that defines the rules in a rule group. This, along with [RuleGroupResponse](API_RuleGroupResponse.md), define the rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](#API_DescribeRuleGroup).   
 AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.   
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.   
Type: [RuleGroup](API_RuleGroup.md) object

 ** [RuleGroupResponse](#API_DescribeRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroup-response-RuleGroupResponse"></a>
The high-level properties of a rule group. This, along with the [RuleGroup](API_RuleGroup.md), define the rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](#API_DescribeRuleGroup).   
Type: [RuleGroupResponse](API_RuleGroupResponse.md) object

 ** [UpdateToken](#API_DescribeRuleGroup_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroup-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.   
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the 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 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeRuleGroup) 

# DescribeRuleGroupMetadata
<a name="API_DescribeRuleGroupMetadata"></a>

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](API_DescribeRuleGroup.md). 

## Request Syntax
<a name="API_DescribeRuleGroupMetadata_RequestSyntax"></a>

```
{
   "RuleGroupArn": "string",
   "RuleGroupName": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DescribeRuleGroupMetadata_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RuleGroupArn](#API_DescribeRuleGroupMetadata_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-request-RuleGroupArn"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupName](#API_DescribeRuleGroupMetadata_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-request-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Type](#API_DescribeRuleGroupMetadata_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-request-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.   
This setting is required for requests that do not include the `RuleGroupARN`.
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: No

## Response Syntax
<a name="API_DescribeRuleGroupMetadata_ResponseSyntax"></a>

```
{
   "Capacity": number,
   "Description": "string",
   "LastModifiedTime": number,
   "ListingName": "string",
   "ProductId": "string",
   "RuleGroupArn": "string",
   "RuleGroupName": "string",
   "StatefulRuleOptions": { 
      "RuleOrder": "string"
   },
   "Type": "string",
   "VendorName": "string"
}
```

## Response Elements
<a name="API_DescribeRuleGroupMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Capacity](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-Capacity"></a>
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.   
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling [CreateRuleGroup](API_CreateRuleGroup.md) with `DryRun` set to `TRUE`.   
Type: Integer

 ** [Description](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-Description"></a>
Returns the metadata objects for the specified rule group.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$` 

 ** [LastModifiedTime](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-LastModifiedTime"></a>
A timestamp indicating when the rule group was last modified.  
Type: Timestamp

 ** [ListingName](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-ListingName"></a>
The display name of the product listing for this rule group.  
Type: String

 ** [ProductId](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-ProductId"></a>
The unique identifier for the product listing associated with this rule group.  
Type: String

 ** [RuleGroupArn](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-RuleGroupArn"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [RuleGroupName](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [StatefulRuleOptions](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-StatefulRuleOptions"></a>
Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.  
Type: [StatefulRuleOptions](API_StatefulRuleOptions.md) object

 ** [Type](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.   
This setting is required for requests that do not include the `RuleGroupARN`.
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN` 

 ** [VendorName](#API_DescribeRuleGroupMetadata_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupMetadata-response-VendorName"></a>
The name of the AWS Marketplace vendor that provides this rule group.  
Type: String

## Errors
<a name="API_DescribeRuleGroupMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeRuleGroupMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeRuleGroupMetadata) 

# DescribeRuleGroupSummary
<a name="API_DescribeRuleGroupSummary"></a>

Returns detailed information for a stateful rule group.

For active threat defense AWS managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense AWS managed rule groups.

To modify how threat information appears in summaries, use the `SummaryConfiguration` parameter in [UpdateRuleGroup](API_UpdateRuleGroup.md).

## Request Syntax
<a name="API_DescribeRuleGroupSummary_RequestSyntax"></a>

```
{
   "RuleGroupArn": "string",
   "RuleGroupName": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DescribeRuleGroupSummary_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [RuleGroupArn](#API_DescribeRuleGroupSummary_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroupSummary-request-RuleGroupArn"></a>
Required. The Amazon Resource Name (ARN) of the rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupName](#API_DescribeRuleGroupSummary_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroupSummary-request-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Type](#API_DescribeRuleGroupSummary_RequestSyntax) **   <a name="networkfirewall-DescribeRuleGroupSummary-request-Type"></a>
The type of rule group you want a summary for. This is a required field.  
Valid value: `STATEFUL`   
Note that `STATELESS` exists but is not currently supported. If you provide `STATELESS`, an exception is returned.  
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: No

## Response Syntax
<a name="API_DescribeRuleGroupSummary_ResponseSyntax"></a>

```
{
   "Description": "string",
   "RuleGroupName": "string",
   "Summary": { 
      "RuleSummaries": [ 
         { 
            "Metadata": "string",
            "Msg": "string",
            "SID": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeRuleGroupSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_DescribeRuleGroupSummary_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupSummary-response-Description"></a>
A description of the rule group.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$` 

 ** [RuleGroupName](#API_DescribeRuleGroupSummary_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupSummary-response-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [Summary](#API_DescribeRuleGroupSummary_ResponseSyntax) **   <a name="networkfirewall-DescribeRuleGroupSummary-response-Summary"></a>
A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:  
+ Rule identifiers
+ Rule descriptions
+ Any metadata fields that you specified in your SummaryConfiguration
Type: [Summary](API_Summary.md) object

## Errors
<a name="API_DescribeRuleGroupSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeRuleGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeRuleGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeRuleGroupSummary) 

# DescribeTLSInspectionConfiguration
<a name="API_DescribeTLSInspectionConfiguration"></a>

Returns the data objects for the specified TLS inspection configuration.

## Request Syntax
<a name="API_DescribeTLSInspectionConfiguration_RequestSyntax"></a>

```
{
   "TLSInspectionConfigurationArn": "string",
   "TLSInspectionConfigurationName": "string"
}
```

## Request Parameters
<a name="API_DescribeTLSInspectionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TLSInspectionConfigurationArn](#API_DescribeTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-DescribeTLSInspectionConfiguration-request-TLSInspectionConfigurationArn"></a>
The Amazon Resource Name (ARN) of the TLS inspection configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [TLSInspectionConfigurationName](#API_DescribeTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-DescribeTLSInspectionConfiguration-request-TLSInspectionConfigurationName"></a>
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_DescribeTLSInspectionConfiguration_ResponseSyntax"></a>

```
{
   "TLSInspectionConfiguration": { 
      "ServerCertificateConfigurations": [ 
         { 
            "CertificateAuthorityArn": "string",
            "CheckCertificateRevocationStatus": { 
               "RevokedStatusAction": "string",
               "UnknownStatusAction": "string"
            },
            "Scopes": [ 
               { 
                  "DestinationPorts": [ 
                     { 
                        "FromPort": number,
                        "ToPort": number
                     }
                  ],
                  "Destinations": [ 
                     { 
                        "AddressDefinition": "string"
                     }
                  ],
                  "Protocols": [ number ],
                  "SourcePorts": [ 
                     { 
                        "FromPort": number,
                        "ToPort": number
                     }
                  ],
                  "Sources": [ 
                     { 
                        "AddressDefinition": "string"
                     }
                  ]
               }
            ],
            "ServerCertificates": [ 
               { 
                  "ResourceArn": "string"
               }
            ]
         }
      ]
   },
   "TLSInspectionConfigurationResponse": { 
      "CertificateAuthority": { 
         "CertificateArn": "string",
         "CertificateSerial": "string",
         "Status": "string",
         "StatusMessage": "string"
      },
      "Certificates": [ 
         { 
            "CertificateArn": "string",
            "CertificateSerial": "string",
            "Status": "string",
            "StatusMessage": "string"
         }
      ],
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string",
      "TLSInspectionConfigurationId": "string",
      "TLSInspectionConfigurationName": "string",
      "TLSInspectionConfigurationStatus": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DescribeTLSInspectionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TLSInspectionConfiguration](#API_DescribeTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeTLSInspectionConfiguration-response-TLSInspectionConfiguration"></a>
The object that defines a TLS inspection configuration. This, along with [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](#API_DescribeTLSInspectionConfiguration).   
 AWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.  
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the * AWS Network Firewall Developer Guide*.  
Type: [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md) object

 ** [TLSInspectionConfigurationResponse](#API_DescribeTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeTLSInspectionConfiguration-response-TLSInspectionConfigurationResponse"></a>
The high-level properties of a TLS inspection configuration. This, along with the [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](#API_DescribeTLSInspectionConfiguration).   
Type: [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md) object

 ** [UpdateToken](#API_DescribeTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-DescribeTLSInspectionConfiguration-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.   
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the TLS inspection 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DescribeTLSInspectionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeTLSInspectionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeTLSInspectionConfiguration) 

# DescribeVpcEndpointAssociation
<a name="API_DescribeVpcEndpointAssociation"></a>

Returns the data object for the specified VPC endpoint association. 

## Request Syntax
<a name="API_DescribeVpcEndpointAssociation_RequestSyntax"></a>

```
{
   "VpcEndpointAssociationArn": "string"
}
```

## Request Parameters
<a name="API_DescribeVpcEndpointAssociation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [VpcEndpointAssociationArn](#API_DescribeVpcEndpointAssociation_RequestSyntax) **   <a name="networkfirewall-DescribeVpcEndpointAssociation-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

## Response Syntax
<a name="API_DescribeVpcEndpointAssociation_ResponseSyntax"></a>

```
{
   "VpcEndpointAssociation": { 
      "Description": "string",
      "FirewallArn": "string",
      "SubnetMapping": { 
         "IPAddressType": "string",
         "SubnetId": "string"
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "VpcEndpointAssociationArn": "string",
      "VpcEndpointAssociationId": "string",
      "VpcId": "string"
   },
   "VpcEndpointAssociationStatus": { 
      "AssociationSyncState": { 
         "string" : { 
            "Attachment": { 
               "EndpointId": "string",
               "Status": "string",
               "StatusMessage": "string",
               "SubnetId": "string"
            }
         }
      },
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_DescribeVpcEndpointAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VpcEndpointAssociation](#API_DescribeVpcEndpointAssociation_ResponseSyntax) **   <a name="networkfirewall-DescribeVpcEndpointAssociation-response-VpcEndpointAssociation"></a>
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.   
Type: [VpcEndpointAssociation](API_VpcEndpointAssociation.md) object

 ** [VpcEndpointAssociationStatus](#API_DescribeVpcEndpointAssociation_ResponseSyntax) **   <a name="networkfirewall-DescribeVpcEndpointAssociation-response-VpcEndpointAssociationStatus"></a>
Detailed information about the current status of a [VpcEndpointAssociation](API_VpcEndpointAssociation.md). You can retrieve this by calling [DescribeVpcEndpointAssociation](#API_DescribeVpcEndpointAssociation) and providing the VPC endpoint association ARN.  
Type: [VpcEndpointAssociationStatus](API_VpcEndpointAssociationStatus.md) object

## Errors
<a name="API_DescribeVpcEndpointAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeVpcEndpointAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DescribeVpcEndpointAssociation) 

# DetachRuleGroupsFromProxyConfiguration
<a name="API_DetachRuleGroupsFromProxyConfiguration"></a>

Detaches [ProxyRuleGroup](API_ProxyRuleGroup.md) resources from a [ProxyConfiguration](API_ProxyConfiguration.md) 

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. 

## Request Syntax
<a name="API_DetachRuleGroupsFromProxyConfiguration_RequestSyntax"></a>

```
{
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string",
   "RuleGroupArns": [ "string" ],
   "RuleGroupNames": [ "string" ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_DetachRuleGroupsFromProxyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyConfigurationArn](#API_DetachRuleGroupsFromProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_DetachRuleGroupsFromProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [RuleGroupArns](#API_DetachRuleGroupsFromProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-request-RuleGroupArns"></a>
The proxy rule group arns to detach from the proxy configuration  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupNames](#API_DetachRuleGroupsFromProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-request-RuleGroupNames"></a>
The proxy rule group names to detach from the proxy configuration  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_DetachRuleGroupsFromProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_DetachRuleGroupsFromProxyConfiguration_ResponseSyntax"></a>

```
{
   "ProxyConfiguration": { 
      "CreateTime": number,
      "DefaultRulePhaseActions": { 
         "PostRESPONSE": "string",
         "PreDNS": "string",
         "PreREQUEST": "string"
      },
      "DeleteTime": number,
      "Description": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "RuleGroups": [ 
         { 
            "Priority": number,
            "ProxyRuleGroupArn": "string",
            "ProxyRuleGroupName": "string",
            "Type": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DetachRuleGroupsFromProxyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyConfiguration](#API_DetachRuleGroupsFromProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-response-ProxyConfiguration"></a>
The updated proxy configuration resource that reflects the updates from the request.  
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object

 ** [UpdateToken](#API_DetachRuleGroupsFromProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-DetachRuleGroupsFromProxyConfiguration-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DetachRuleGroupsFromProxyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DetachRuleGroupsFromProxyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DetachRuleGroupsFromProxyConfiguration) 

# DisassociateAvailabilityZones
<a name="API_DisassociateAvailabilityZones"></a>

Removes the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately.

**Note**  
If `AvailabilityZoneChangeProtection` is enabled, you must first disable it using [UpdateAvailabilityZoneChangeProtection](API_UpdateAvailabilityZoneChangeProtection.md).

To verify the status of your Availability Zone changes, use [DescribeFirewall](API_DescribeFirewall.md).

## Request Syntax
<a name="API_DisassociateAvailabilityZones_RequestSyntax"></a>

```
{
   "AvailabilityZoneMappings": [ 
      { 
         "AvailabilityZone": "string"
      }
   ],
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_DisassociateAvailabilityZones_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZoneMappings](#API_DisassociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-request-AvailabilityZoneMappings"></a>
Required. The Availability Zones to remove from the firewall's configuration.  
Type: Array of [AvailabilityZoneMapping](API_AvailabilityZoneMapping.md) objects  
Required: Yes

 ** [FirewallArn](#API_DisassociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_DisassociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_DisassociateAvailabilityZones_RequestSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_DisassociateAvailabilityZones_ResponseSyntax"></a>

```
{
   "AvailabilityZoneMappings": [ 
      { 
         "AvailabilityZone": "string"
      }
   ],
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DisassociateAvailabilityZones_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AvailabilityZoneMappings](#API_DisassociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-response-AvailabilityZoneMappings"></a>
The remaining Availability Zones where the firewall has endpoints after the disassociation.  
Type: Array of [AvailabilityZoneMapping](API_AvailabilityZoneMapping.md) objects

 ** [FirewallArn](#API_DisassociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_DisassociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_DisassociateAvailabilityZones_ResponseSyntax) **   <a name="networkfirewall-DisassociateAvailabilityZones-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DisassociateAvailabilityZones_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateAvailabilityZones_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DisassociateAvailabilityZones) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DisassociateAvailabilityZones) 

# DisassociateSubnets
<a name="API_DisassociateSubnets"></a>

Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing. 

## Request Syntax
<a name="API_DisassociateSubnets_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "SubnetIds": [ "string" ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_DisassociateSubnets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_DisassociateSubnets_RequestSyntax) **   <a name="networkfirewall-DisassociateSubnets-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_DisassociateSubnets_RequestSyntax) **   <a name="networkfirewall-DisassociateSubnets-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [SubnetIds](#API_DisassociateSubnets_RequestSyntax) **   <a name="networkfirewall-DisassociateSubnets-request-SubnetIds"></a>
The unique identifiers for the subnets that you want to disassociate.   
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^subnet-[0-9a-f]+$`   
Required: Yes

 ** [UpdateToken](#API_DisassociateSubnets_RequestSyntax) **   <a name="networkfirewall-DisassociateSubnets-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_DisassociateSubnets_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "SubnetMappings": [ 
      { 
         "IPAddressType": "string",
         "SubnetId": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_DisassociateSubnets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_DisassociateSubnets_ResponseSyntax) **   <a name="networkfirewall-DisassociateSubnets-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_DisassociateSubnets_ResponseSyntax) **   <a name="networkfirewall-DisassociateSubnets-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [SubnetMappings](#API_DisassociateSubnets_ResponseSyntax) **   <a name="networkfirewall-DisassociateSubnets-response-SubnetMappings"></a>
The IDs of the subnets that are associated with the firewall.   
Type: Array of [SubnetMapping](API_SubnetMapping.md) objects

 ** [UpdateToken](#API_DisassociateSubnets_ResponseSyntax) **   <a name="networkfirewall-DisassociateSubnets-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_DisassociateSubnets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidOperationException **   
The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateSubnets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/DisassociateSubnets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/DisassociateSubnets) 

# GetAnalysisReportResults
<a name="API_GetAnalysisReportResults"></a>

The results of a `COMPLETED` analysis report generated with [StartAnalysisReport](API_StartAnalysisReport.md).

For more information, see [AnalysisTypeReportResult](API_AnalysisTypeReportResult.md). 

## Request Syntax
<a name="API_GetAnalysisReportResults_RequestSyntax"></a>

```
{
   "AnalysisReportId": "string",
   "FirewallArn": "string",
   "FirewallName": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_GetAnalysisReportResults_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AnalysisReportId](#API_GetAnalysisReportResults_RequestSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-request-AnalysisReportId"></a>
The unique ID of the query that ran when you requested an analysis report.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `\S+`   
Required: Yes

 ** [FirewallArn](#API_GetAnalysisReportResults_RequestSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_GetAnalysisReportResults_RequestSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [MaxResults](#API_GetAnalysisReportResults_RequestSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_GetAnalysisReportResults_RequestSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_GetAnalysisReportResults_ResponseSyntax"></a>

```
{
   "AnalysisReportResults": [ 
      { 
         "Domain": "string",
         "FirstAccessed": number,
         "Hits": { 
            "Count": number
         },
         "LastAccessed": number,
         "Protocol": "string",
         "UniqueSources": { 
            "Count": number
         }
      }
   ],
   "AnalysisType": "string",
   "EndTime": number,
   "NextToken": "string",
   "ReportTime": number,
   "StartTime": number,
   "Status": "string"
}
```

## Response Elements
<a name="API_GetAnalysisReportResults_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AnalysisReportResults](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-AnalysisReportResults"></a>
Retrieves the results of a traffic analysis report.  
Type: Array of [AnalysisTypeReportResult](API_AnalysisTypeReportResult.md) objects

 ** [AnalysisType](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-AnalysisType"></a>
The type of traffic that will be used to generate a report.   
Type: String  
Valid Values: `TLS_SNI | HTTP_HOST` 

 ** [EndTime](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-EndTime"></a>
The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, `YYYY-MM-DDTHH:MM:SSZ`).   
Type: Timestamp

 ** [NextToken](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ReportTime](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-ReportTime"></a>
The date and time the analysis report was ran.   
Type: Timestamp

 ** [StartTime](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-StartTime"></a>
 The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, `YYYY-MM-DDTHH:MM:SSZ`.   
Type: Timestamp

 ** [Status](#API_GetAnalysisReportResults_ResponseSyntax) **   <a name="networkfirewall-GetAnalysisReportResults-response-Status"></a>
The status of the analysis report you specify. Statuses include `RUNNING`, `COMPLETED`, or `FAILED`.  
Type: String

## Errors
<a name="API_GetAnalysisReportResults_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_GetAnalysisReportResults_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/GetAnalysisReportResults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/GetAnalysisReportResults) 

# ListAnalysisReports
<a name="API_ListAnalysisReports"></a>

Returns a list of all traffic analysis reports generated within the last 30 days.

## Request Syntax
<a name="API_ListAnalysisReports_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListAnalysisReports_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_ListAnalysisReports_RequestSyntax) **   <a name="networkfirewall-ListAnalysisReports-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_ListAnalysisReports_RequestSyntax) **   <a name="networkfirewall-ListAnalysisReports-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [MaxResults](#API_ListAnalysisReports_RequestSyntax) **   <a name="networkfirewall-ListAnalysisReports-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListAnalysisReports_RequestSyntax) **   <a name="networkfirewall-ListAnalysisReports-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListAnalysisReports_ResponseSyntax"></a>

```
{
   "AnalysisReports": [ 
      { 
         "AnalysisReportId": "string",
         "AnalysisType": "string",
         "ReportTime": number,
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAnalysisReports_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AnalysisReports](#API_ListAnalysisReports_ResponseSyntax) **   <a name="networkfirewall-ListAnalysisReports-response-AnalysisReports"></a>
The `id` and `ReportTime` associated with a requested analysis report. Does not provide the status of the analysis report.   
Type: Array of [AnalysisReport](API_AnalysisReport.md) objects

 ** [NextToken](#API_ListAnalysisReports_ResponseSyntax) **   <a name="networkfirewall-ListAnalysisReports-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

## Errors
<a name="API_ListAnalysisReports_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListAnalysisReports_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListAnalysisReports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListAnalysisReports) 

# ListFirewallPolicies
<a name="API_ListFirewallPolicies"></a>

Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list. 

## Request Syntax
<a name="API_ListFirewallPolicies_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListFirewallPolicies_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListFirewallPolicies_RequestSyntax) **   <a name="networkfirewall-ListFirewallPolicies-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListFirewallPolicies_RequestSyntax) **   <a name="networkfirewall-ListFirewallPolicies-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListFirewallPolicies_ResponseSyntax"></a>

```
{
   "FirewallPolicies": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListFirewallPolicies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallPolicies](#API_ListFirewallPolicies_ResponseSyntax) **   <a name="networkfirewall-ListFirewallPolicies-response-FirewallPolicies"></a>
The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.   
Type: Array of [FirewallPolicyMetadata](API_FirewallPolicyMetadata.md) objects

 ** [NextToken](#API_ListFirewallPolicies_ResponseSyntax) **   <a name="networkfirewall-ListFirewallPolicies-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

## Errors
<a name="API_ListFirewallPolicies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListFirewallPolicies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListFirewallPolicies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListFirewallPolicies) 

# ListFirewalls
<a name="API_ListFirewalls"></a>

Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.

Depending on your setting for max results and the number of firewalls, a single call might not return the full list. 

## Request Syntax
<a name="API_ListFirewalls_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "VpcIds": [ "string" ]
}
```

## Request Parameters
<a name="API_ListFirewalls_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListFirewalls_RequestSyntax) **   <a name="networkfirewall-ListFirewalls-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListFirewalls_RequestSyntax) **   <a name="networkfirewall-ListFirewalls-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

 ** [VpcIds](#API_ListFirewalls_RequestSyntax) **   <a name="networkfirewall-ListFirewalls-request-VpcIds"></a>
The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^vpc-[0-9a-f]+$`   
Required: No

## Response Syntax
<a name="API_ListFirewalls_ResponseSyntax"></a>

```
{
   "Firewalls": [ 
      { 
         "FirewallArn": "string",
         "FirewallName": "string",
         "TransitGatewayAttachmentId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListFirewalls_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Firewalls](#API_ListFirewalls_ResponseSyntax) **   <a name="networkfirewall-ListFirewalls-response-Firewalls"></a>
The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.   
Type: Array of [FirewallMetadata](API_FirewallMetadata.md) objects

 ** [NextToken](#API_ListFirewalls_ResponseSyntax) **   <a name="networkfirewall-ListFirewalls-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

## Errors
<a name="API_ListFirewalls_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListFirewalls_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListFirewalls) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListFirewalls) 

# ListFlowOperationResults
<a name="API_ListFlowOperationResults"></a>

Returns the results of a specific flow operation. 

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. 

## Request Syntax
<a name="API_ListFlowOperationResults_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowOperationId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Request Parameters
<a name="API_ListFlowOperationResults_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String  
Required: No

 ** [FirewallArn](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [FlowOperationId](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-FlowOperationId"></a>
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

 ** [MaxResults](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

 ** [VpcEndpointAssociationArn](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [VpcEndpointId](#API_ListFlowOperationResults_RequestSyntax) **   <a name="networkfirewall-ListFlowOperationResults-request-VpcEndpointId"></a>
A unique identifier for the primary endpoint associated with a firewall.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$`   
Required: No

## Response Syntax
<a name="API_ListFlowOperationResults_ResponseSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowOperationId": "string",
   "FlowOperationStatus": "string",
   "FlowRequestTimestamp": number,
   "Flows": [ 
      { 
         "Age": number,
         "ByteCount": number,
         "DestinationAddress": { 
            "AddressDefinition": "string"
         },
         "DestinationPort": "string",
         "PacketCount": number,
         "Protocol": "string",
         "SourceAddress": { 
            "AddressDefinition": "string"
         },
         "SourcePort": "string"
      }
   ],
   "NextToken": "string",
   "StatusMessage": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Response Elements
<a name="API_ListFlowOperationResults_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AvailabilityZone](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String

 ** [FirewallArn](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FlowOperationId](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-FlowOperationId"></a>
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

 ** [FlowOperationStatus](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-FlowOperationStatus"></a>
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.  
If the status is `COMPLETED_WITH_ERRORS`, results may be returned with any number of `Flows` missing from the response. If the status is `FAILED`, `Flows` returned will be empty.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED | COMPLETED_WITH_ERRORS` 

 ** [FlowRequestTimestamp](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-FlowRequestTimestamp"></a>
A timestamp indicating when the Suricata engine identified flows impacted by an operation.   
Type: Timestamp

 ** [Flows](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-Flows"></a>
Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple `Flows` arrays are returned.  
Type: Array of [Flow](API_Flow.md) objects

 ** [NextToken](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [StatusMessage](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-StatusMessage"></a>
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include `Flow operation error` and `Flow timeout`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9- ]+$` 

 ** [VpcEndpointAssociationArn](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-VpcEndpointAssociationArn"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [VpcEndpointId](#API_ListFlowOperationResults_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperationResults-response-VpcEndpointId"></a>
  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$` 

## Errors
<a name="API_ListFlowOperationResults_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListFlowOperationResults_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListFlowOperationResults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListFlowOperationResults) 

# ListFlowOperations
<a name="API_ListFlowOperations"></a>

Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations. 

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. 

## Request Syntax
<a name="API_ListFlowOperations_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowOperationType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Request Parameters
<a name="API_ListFlowOperations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String  
Required: No

 ** [FirewallArn](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [FlowOperationType](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-FlowOperationType"></a>
An optional string that defines whether any or all operation types are returned.  
Type: String  
Valid Values: `FLOW_FLUSH | FLOW_CAPTURE`   
Required: No

 ** [MaxResults](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

 ** [VpcEndpointAssociationArn](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [VpcEndpointId](#API_ListFlowOperations_RequestSyntax) **   <a name="networkfirewall-ListFlowOperations-request-VpcEndpointId"></a>
A unique identifier for the primary endpoint associated with a firewall.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$`   
Required: No

## Response Syntax
<a name="API_ListFlowOperations_ResponseSyntax"></a>

```
{
   "FlowOperations": [ 
      { 
         "FlowOperationId": "string",
         "FlowOperationStatus": "string",
         "FlowOperationType": "string",
         "FlowRequestTimestamp": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListFlowOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FlowOperations](#API_ListFlowOperations_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperations-response-FlowOperations"></a>
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.  
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.   
Type: Array of [FlowOperationMetadata](API_FlowOperationMetadata.md) objects

 ** [NextToken](#API_ListFlowOperations_ResponseSyntax) **   <a name="networkfirewall-ListFlowOperations-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

## Errors
<a name="API_ListFlowOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListFlowOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListFlowOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListFlowOperations) 

# ListProxies
<a name="API_ListProxies"></a>

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. 

## Request Syntax
<a name="API_ListProxies_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListProxies_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListProxies_RequestSyntax) **   <a name="networkfirewall-ListProxies-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListProxies_RequestSyntax) **   <a name="networkfirewall-ListProxies-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListProxies_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Proxies": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListProxies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListProxies_ResponseSyntax) **   <a name="networkfirewall-ListProxies-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [Proxies](#API_ListProxies_ResponseSyntax) **   <a name="networkfirewall-ListProxies-response-Proxies"></a>
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.   
Type: Array of [ProxyMetadata](API_ProxyMetadata.md) objects

## Errors
<a name="API_ListProxies_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListProxies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListProxies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListProxies) 

# ListProxyConfigurations
<a name="API_ListProxyConfigurations"></a>

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. 

## Request Syntax
<a name="API_ListProxyConfigurations_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListProxyConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListProxyConfigurations_RequestSyntax) **   <a name="networkfirewall-ListProxyConfigurations-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListProxyConfigurations_RequestSyntax) **   <a name="networkfirewall-ListProxyConfigurations-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListProxyConfigurations_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ProxyConfigurations": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListProxyConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListProxyConfigurations_ResponseSyntax) **   <a name="networkfirewall-ListProxyConfigurations-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [ProxyConfigurations](#API_ListProxyConfigurations_ResponseSyntax) **   <a name="networkfirewall-ListProxyConfigurations-response-ProxyConfigurations"></a>
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.   
Type: Array of [ProxyConfigurationMetadata](API_ProxyConfigurationMetadata.md) objects

## Errors
<a name="API_ListProxyConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListProxyConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListProxyConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListProxyConfigurations) 

# ListProxyRuleGroups
<a name="API_ListProxyRuleGroups"></a>

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. 

## Request Syntax
<a name="API_ListProxyRuleGroups_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListProxyRuleGroups_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListProxyRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListProxyRuleGroups-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListProxyRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListProxyRuleGroups-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListProxyRuleGroups_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ProxyRuleGroups": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListProxyRuleGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListProxyRuleGroups_ResponseSyntax) **   <a name="networkfirewall-ListProxyRuleGroups-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [ProxyRuleGroups](#API_ListProxyRuleGroups_ResponseSyntax) **   <a name="networkfirewall-ListProxyRuleGroups-response-ProxyRuleGroups"></a>
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.   
Type: Array of [ProxyRuleGroupMetadata](API_ProxyRuleGroupMetadata.md) objects

## Errors
<a name="API_ListProxyRuleGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListProxyRuleGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListProxyRuleGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListProxyRuleGroups) 

# ListRuleGroups
<a name="API_ListRuleGroups"></a>

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list. 

## Request Syntax
<a name="API_ListRuleGroups_RequestSyntax"></a>

```
{
   "ManagedType": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Scope": "string",
   "SubscriptionStatus": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_ListRuleGroups_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ManagedType](#API_ListRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListRuleGroups-request-ManagedType"></a>
Indicates the general category of the AWS managed rule group.  
Type: String  
Valid Values: `AWS_MANAGED_THREAT_SIGNATURES | AWS_MANAGED_DOMAIN_LISTS | ACTIVE_THREAT_DEFENSE | PARTNER_MANAGED`   
Required: No

 ** [MaxResults](#API_ListRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListRuleGroups-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListRuleGroups-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

 ** [Scope](#API_ListRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListRuleGroups-request-Scope"></a>
The scope of the request. The default setting of `ACCOUNT` or a setting of `NULL` returns all of the rule groups in your account. A setting of `MANAGED` returns all available managed rule groups.  
Type: String  
Valid Values: `MANAGED | ACCOUNT`   
Required: No

 ** [SubscriptionStatus](#API_ListRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListRuleGroups-request-SubscriptionStatus"></a>
Filters the results to show only rule groups with the specified subscription status. Use this to find subscribed or unsubscribed rule groups.  
Type: String  
Valid Values: `NOT_SUBSCRIBED | SUBSCRIBED`   
Required: No

 ** [Type](#API_ListRuleGroups_RequestSyntax) **   <a name="networkfirewall-ListRuleGroups-request-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.  
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: No

## Response Syntax
<a name="API_ListRuleGroups_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "RuleGroups": [ 
      { 
         "Arn": "string",
         "Name": "string",
         "VendorName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRuleGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRuleGroups_ResponseSyntax) **   <a name="networkfirewall-ListRuleGroups-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [RuleGroups](#API_ListRuleGroups_ResponseSyntax) **   <a name="networkfirewall-ListRuleGroups-response-RuleGroups"></a>
The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.   
Type: Array of [RuleGroupMetadata](API_RuleGroupMetadata.md) objects

## Errors
<a name="API_ListRuleGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListRuleGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListRuleGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListRuleGroups) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. 

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListTagsForResource_RequestSyntax) **   <a name="networkfirewall-ListTagsForResource-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="networkfirewall-ListTagsForResource-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="networkfirewall-ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="networkfirewall-ListTagsForResource-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="networkfirewall-ListTagsForResource-response-Tags"></a>
The tags that are associated with the resource.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListTagsForResource) 

# ListTLSInspectionConfigurations
<a name="API_ListTLSInspectionConfigurations"></a>

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

## Request Syntax
<a name="API_ListTLSInspectionConfigurations_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListTLSInspectionConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListTLSInspectionConfigurations_RequestSyntax) **   <a name="networkfirewall-ListTLSInspectionConfigurations-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListTLSInspectionConfigurations_RequestSyntax) **   <a name="networkfirewall-ListTLSInspectionConfigurations-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListTLSInspectionConfigurations_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "TLSInspectionConfigurations": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTLSInspectionConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTLSInspectionConfigurations_ResponseSyntax) **   <a name="networkfirewall-ListTLSInspectionConfigurations-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [TLSInspectionConfigurations](#API_ListTLSInspectionConfigurations_ResponseSyntax) **   <a name="networkfirewall-ListTLSInspectionConfigurations-response-TLSInspectionConfigurations"></a>
The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.  
Type: Array of [TLSInspectionConfigurationMetadata](API_TLSInspectionConfigurationMetadata.md) objects

## Errors
<a name="API_ListTLSInspectionConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListTLSInspectionConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListTLSInspectionConfigurations) 

# ListVpcEndpointAssociations
<a name="API_ListVpcEndpointAssociations"></a>

Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall. 

Depending on your setting for max results and the number of associations, a single call might not return the full list. 

## Request Syntax
<a name="API_ListVpcEndpointAssociations_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListVpcEndpointAssociations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_ListVpcEndpointAssociations_RequestSyntax) **   <a name="networkfirewall-ListVpcEndpointAssociations-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
If you don't specify this, Network Firewall retrieves all VPC endpoint associations that you have defined.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [MaxResults](#API_ListVpcEndpointAssociations_RequestSyntax) **   <a name="networkfirewall-ListVpcEndpointAssociations-request-MaxResults"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListVpcEndpointAssociations_RequestSyntax) **   <a name="networkfirewall-ListVpcEndpointAssociations-request-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$`   
Required: No

## Response Syntax
<a name="API_ListVpcEndpointAssociations_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "VpcEndpointAssociations": [ 
      { 
         "VpcEndpointAssociationArn": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListVpcEndpointAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListVpcEndpointAssociations_ResponseSyntax) **   <a name="networkfirewall-ListVpcEndpointAssociations-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[0-9A-Za-z:\/+=]+$` 

 ** [VpcEndpointAssociations](#API_ListVpcEndpointAssociations_ResponseSyntax) **   <a name="networkfirewall-ListVpcEndpointAssociations-response-VpcEndpointAssociations"></a>
The VPC endpoint assocation metadata objects for the firewall that you specified. If you didn't specify a firewall, this is all VPC endpoint associations that you have defined.   
Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.   
Type: Array of [VpcEndpointAssociationMetadata](API_VpcEndpointAssociationMetadata.md) objects

## Errors
<a name="API_ListVpcEndpointAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_ListVpcEndpointAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/ListVpcEndpointAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/ListVpcEndpointAssociations) 

# PutResourcePolicy
<a name="API_PutResourcePolicy"></a>

Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the AWS Resource Access Manager (RAM) service to manage resource sharing for Network Firewall. 

For information about using sharing with Network Firewall resources, see [Sharing Network Firewall resources](https://docs.aws.amazon.com/network-firewall/latest/developerguide/sharing.html) in the * AWS Network Firewall Developer Guide*.

Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform. 

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource. 
+  [GetResourceShareInvitations](https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html) - Returns the Amazon Resource Names (ARNs) of the resource share invitations. 
+  [AcceptResourceShareInvitation](https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html) - Accepts the share invitation for a specified resource share. 

For additional information about resource sharing using RAM, see [AWS Resource Access Manager User Guide](https://docs.aws.amazon.com/ram/latest/userguide/what-is.html).

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
{
   "Policy": "string",
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Policy](#API_PutResourcePolicy_RequestSyntax) **   <a name="networkfirewall-PutResourcePolicy-request-Policy"></a>
The IAM policy statement that lists the accounts that you want to share your Network Firewall resources with and the operations that you want the accounts to be able to perform.   
For a rule group resource, you can specify the following operations in the Actions section of the statement:  
+ network-firewall:CreateFirewallPolicy
+ network-firewall:UpdateFirewallPolicy
+ network-firewall:ListRuleGroups
For a firewall policy resource, you can specify the following operations in the Actions section of the statement:  
+ network-firewall:AssociateFirewallPolicy
+ network-firewall:ListFirewallPolicies
For a firewall resource, you can specify the following operations in the Actions section of the statement:  
+ network-firewall:CreateVpcEndpointAssociation
+ network-firewall:DescribeFirewallMetadata
+ network-firewall:ListFirewalls
In the Resource section of the statement, you specify the ARNs for the Network Firewall resources that you want to share with the account that you specified in `Arn`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 395000.  
Pattern: `.*\S.*`   
Required: Yes

 ** [ResourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="networkfirewall-PutResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the account that you want to share your Network Firewall resources with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutResourcePolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidResourcePolicyException **   
The policy statement failed validation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/PutResourcePolicy) 

# RejectNetworkFirewallTransitGatewayAttachment
<a name="API_RejectNetworkFirewallTransitGatewayAttachment"></a>

Rejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints.

Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment.

Use [DescribeFirewall](API_DescribeFirewall.md) to monitor the rejection status. To accept the attachment instead of rejecting it, use [AcceptNetworkFirewallTransitGatewayAttachment](API_AcceptNetworkFirewallTransitGatewayAttachment.md).

**Note**  
Once rejected, you cannot reverse this action. To establish connectivity, you must create a new transit gateway-attached firewall.

## Request Syntax
<a name="API_RejectNetworkFirewallTransitGatewayAttachment_RequestSyntax"></a>

```
{
   "TransitGatewayAttachmentId": "string"
}
```

## Request Parameters
<a name="API_RejectNetworkFirewallTransitGatewayAttachment_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TransitGatewayAttachmentId](#API_RejectNetworkFirewallTransitGatewayAttachment_RequestSyntax) **   <a name="networkfirewall-RejectNetworkFirewallTransitGatewayAttachment-request-TransitGatewayAttachmentId"></a>
Required. The unique identifier of the transit gateway attachment to reject. This ID is returned in the response when creating a transit gateway-attached firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$`   
Required: Yes

## Response Syntax
<a name="API_RejectNetworkFirewallTransitGatewayAttachment_ResponseSyntax"></a>

```
{
   "TransitGatewayAttachmentId": "string",
   "TransitGatewayAttachmentStatus": "string"
}
```

## Response Elements
<a name="API_RejectNetworkFirewallTransitGatewayAttachment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TransitGatewayAttachmentId](#API_RejectNetworkFirewallTransitGatewayAttachment_ResponseSyntax) **   <a name="networkfirewall-RejectNetworkFirewallTransitGatewayAttachment-response-TransitGatewayAttachmentId"></a>
The unique identifier of the transit gateway attachment that was rejected.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^tgw-attach-[0-9a-z]+$` 

 ** [TransitGatewayAttachmentStatus](#API_RejectNetworkFirewallTransitGatewayAttachment_ResponseSyntax) **   <a name="networkfirewall-RejectNetworkFirewallTransitGatewayAttachment-response-TransitGatewayAttachmentStatus"></a>
The current status of the transit gateway attachment. Valid values are:  
+  `CREATING` - The attachment is being created
+  `DELETING` - The attachment is being deleted
+  `DELETED` - The attachment has been deleted
+  `FAILED` - The attachment creation has failed and cannot be recovered
+  `ERROR` - The attachment is in an error state that might be recoverable
+  `READY` - The attachment is active and processing traffic
+  `PENDING_ACCEPTANCE` - The attachment is waiting to be accepted
+  `REJECTING` - The attachment is in the process of being rejected
+  `REJECTED` - The attachment has been rejected
For information about troubleshooting endpoint failures, see [Troubleshooting firewall endpoint failures](https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html) in the * AWS Network Firewall Developer Guide*.  
Type: String  
Valid Values: `CREATING | DELETING | DELETED | FAILED | ERROR | READY | PENDING_ACCEPTANCE | REJECTING | REJECTED` 

## Errors
<a name="API_RejectNetworkFirewallTransitGatewayAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_RejectNetworkFirewallTransitGatewayAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/RejectNetworkFirewallTransitGatewayAttachment) 

# StartAnalysisReport
<a name="API_StartAnalysisReport"></a>

Generates a traffic analysis report for the timeframe and traffic type you specify.

For information on the contents of a traffic analysis report, see [AnalysisReport](API_AnalysisReport.md).

## Request Syntax
<a name="API_StartAnalysisReport_RequestSyntax"></a>

```
{
   "AnalysisType": "string",
   "FirewallArn": "string",
   "FirewallName": "string"
}
```

## Request Parameters
<a name="API_StartAnalysisReport_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AnalysisType](#API_StartAnalysisReport_RequestSyntax) **   <a name="networkfirewall-StartAnalysisReport-request-AnalysisType"></a>
The type of traffic that will be used to generate a report.   
Type: String  
Valid Values: `TLS_SNI | HTTP_HOST`   
Required: Yes

 ** [FirewallArn](#API_StartAnalysisReport_RequestSyntax) **   <a name="networkfirewall-StartAnalysisReport-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_StartAnalysisReport_RequestSyntax) **   <a name="networkfirewall-StartAnalysisReport-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

## Response Syntax
<a name="API_StartAnalysisReport_ResponseSyntax"></a>

```
{
   "AnalysisReportId": "string"
}
```

## Response Elements
<a name="API_StartAnalysisReport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AnalysisReportId](#API_StartAnalysisReport_ResponseSyntax) **   <a name="networkfirewall-StartAnalysisReport-response-AnalysisReportId"></a>
The unique ID of the query that ran when you requested an analysis report.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `\S+` 

## Errors
<a name="API_StartAnalysisReport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_StartAnalysisReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/StartAnalysisReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/StartAnalysisReport) 

# StartFlowCapture
<a name="API_StartFlowCapture"></a>

Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view. 

A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. 

**Note**  
To avoid encountering operation limits, you should avoid starting captures with broad filters, like wide IP ranges. Instead, we recommend you define more specific criteria with `FlowFilters`, like narrow IP ranges, ports, or protocols.

## Request Syntax
<a name="API_StartFlowCapture_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowFilters": [ 
      { 
         "DestinationAddress": { 
            "AddressDefinition": "string"
         },
         "DestinationPort": "string",
         "Protocols": [ "string" ],
         "SourceAddress": { 
            "AddressDefinition": "string"
         },
         "SourcePort": "string"
      }
   ],
   "MinimumFlowAgeInSeconds": number,
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Request Parameters
<a name="API_StartFlowCapture_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_StartFlowCapture_RequestSyntax) **   <a name="networkfirewall-StartFlowCapture-request-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String  
Required: No

 ** [FirewallArn](#API_StartFlowCapture_RequestSyntax) **   <a name="networkfirewall-StartFlowCapture-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [FlowFilters](#API_StartFlowCapture_RequestSyntax) **   <a name="networkfirewall-StartFlowCapture-request-FlowFilters"></a>
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: Array of [FlowFilter](API_FlowFilter.md) objects  
Required: Yes

 ** [MinimumFlowAgeInSeconds](#API_StartFlowCapture_RequestSyntax) **   <a name="networkfirewall-StartFlowCapture-request-MinimumFlowAgeInSeconds"></a>
The reqested `FlowOperation` ignores flows with an age (in seconds) lower than `MinimumFlowAgeInSeconds`. You provide this for start commands.  
We recommend setting this value to at least 1 minute (60 seconds) to reduce chance of capturing flows that are not yet established.
Type: Integer  
Required: No

 ** [VpcEndpointAssociationArn](#API_StartFlowCapture_RequestSyntax) **   <a name="networkfirewall-StartFlowCapture-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [VpcEndpointId](#API_StartFlowCapture_RequestSyntax) **   <a name="networkfirewall-StartFlowCapture-request-VpcEndpointId"></a>
A unique identifier for the primary endpoint associated with a firewall.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$`   
Required: No

## Response Syntax
<a name="API_StartFlowCapture_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FlowOperationId": "string",
   "FlowOperationStatus": "string"
}
```

## Response Elements
<a name="API_StartFlowCapture_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_StartFlowCapture_ResponseSyntax) **   <a name="networkfirewall-StartFlowCapture-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FlowOperationId](#API_StartFlowCapture_ResponseSyntax) **   <a name="networkfirewall-StartFlowCapture-response-FlowOperationId"></a>
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

 ** [FlowOperationStatus](#API_StartFlowCapture_ResponseSyntax) **   <a name="networkfirewall-StartFlowCapture-response-FlowOperationStatus"></a>
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.  
If the status is `COMPLETED_WITH_ERRORS`, results may be returned with any number of `Flows` missing from the response. If the status is `FAILED`, `Flows` returned will be empty.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED | COMPLETED_WITH_ERRORS` 

## Errors
<a name="API_StartFlowCapture_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_StartFlowCapture_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/StartFlowCapture) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/StartFlowCapture) 

# StartFlowFlush
<a name="API_StartFlowFlush"></a>

Begins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.

**Important**  
While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.

## Request Syntax
<a name="API_StartFlowFlush_RequestSyntax"></a>

```
{
   "AvailabilityZone": "string",
   "FirewallArn": "string",
   "FlowFilters": [ 
      { 
         "DestinationAddress": { 
            "AddressDefinition": "string"
         },
         "DestinationPort": "string",
         "Protocols": [ "string" ],
         "SourceAddress": { 
            "AddressDefinition": "string"
         },
         "SourcePort": "string"
      }
   ],
   "MinimumFlowAgeInSeconds": number,
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}
```

## Request Parameters
<a name="API_StartFlowFlush_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZone](#API_StartFlowFlush_RequestSyntax) **   <a name="networkfirewall-StartFlowFlush-request-AvailabilityZone"></a>
The ID of the Availability Zone where the firewall is located. For example, `us-east-2a`.  
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: String  
Required: No

 ** [FirewallArn](#API_StartFlowFlush_RequestSyntax) **   <a name="networkfirewall-StartFlowFlush-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [FlowFilters](#API_StartFlowFlush_RequestSyntax) **   <a name="networkfirewall-StartFlowFlush-request-FlowFilters"></a>
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.  
Type: Array of [FlowFilter](API_FlowFilter.md) objects  
Required: Yes

 ** [MinimumFlowAgeInSeconds](#API_StartFlowFlush_RequestSyntax) **   <a name="networkfirewall-StartFlowFlush-request-MinimumFlowAgeInSeconds"></a>
The reqested `FlowOperation` ignores flows with an age (in seconds) lower than `MinimumFlowAgeInSeconds`. You provide this for start commands.  
Type: Integer  
Required: No

 ** [VpcEndpointAssociationArn](#API_StartFlowFlush_RequestSyntax) **   <a name="networkfirewall-StartFlowFlush-request-VpcEndpointAssociationArn"></a>
The Amazon Resource Name (ARN) of a VPC endpoint association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [VpcEndpointId](#API_StartFlowFlush_RequestSyntax) **   <a name="networkfirewall-StartFlowFlush-request-VpcEndpointId"></a>
A unique identifier for the primary endpoint associated with a firewall.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 256.  
Pattern: `^vpce-[a-zA-Z0-9]*$`   
Required: No

## Response Syntax
<a name="API_StartFlowFlush_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FlowOperationId": "string",
   "FlowOperationStatus": "string"
}
```

## Response Elements
<a name="API_StartFlowFlush_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_StartFlowFlush_ResponseSyntax) **   <a name="networkfirewall-StartFlowFlush-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FlowOperationId](#API_StartFlowFlush_ResponseSyntax) **   <a name="networkfirewall-StartFlowFlush-response-FlowOperationId"></a>
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

 ** [FlowOperationStatus](#API_StartFlowFlush_ResponseSyntax) **   <a name="networkfirewall-StartFlowFlush-response-FlowOperationStatus"></a>
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.  
If the status is `COMPLETED_WITH_ERRORS`, results may be returned with any number of `Flows` missing from the response. If the status is `FAILED`, `Flows` returned will be empty.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED | COMPLETED_WITH_ERRORS` 

## Errors
<a name="API_StartFlowFlush_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_StartFlowFlush_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/StartFlowFlush) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/StartFlowFlush) 

# TagResource
<a name="API_TagResource"></a>

Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. 

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="networkfirewall-TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="networkfirewall-TagResource-request-Tags"></a>
  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can manage tags for the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. 

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="networkfirewall-UntagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="networkfirewall-UntagResource-request-TagKeys"></a>
  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^.*$`   
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UntagResource) 

# UpdateAvailabilityZoneChangeProtection
<a name="API_UpdateAvailabilityZoneChangeProtection"></a>

Modifies the `AvailabilityZoneChangeProtection` setting for a transit gateway-attached firewall. When enabled, this setting prevents accidental changes to the firewall's Availability Zone configuration. This helps protect against disrupting traffic flow in production environments.

When enabled, you must disable this protection before using [AssociateAvailabilityZones](API_AssociateAvailabilityZones.md) or [DisassociateAvailabilityZones](API_DisassociateAvailabilityZones.md) to modify the firewall's Availability Zone configuration.

## Request Syntax
<a name="API_UpdateAvailabilityZoneChangeProtection_RequestSyntax"></a>

```
{
   "AvailabilityZoneChangeProtection": boolean,
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateAvailabilityZoneChangeProtection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AvailabilityZoneChangeProtection](#API_UpdateAvailabilityZoneChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-request-AvailabilityZoneChangeProtection"></a>
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean  
Required: Yes

 ** [FirewallArn](#API_UpdateAvailabilityZoneChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateAvailabilityZoneChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateAvailabilityZoneChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateAvailabilityZoneChangeProtection_ResponseSyntax"></a>

```
{
   "AvailabilityZoneChangeProtection": boolean,
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateAvailabilityZoneChangeProtection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AvailabilityZoneChangeProtection](#API_UpdateAvailabilityZoneChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-response-AvailabilityZoneChangeProtection"></a>
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean

 ** [FirewallArn](#API_UpdateAvailabilityZoneChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateAvailabilityZoneChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_UpdateAvailabilityZoneChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateAvailabilityZoneChangeProtection-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateAvailabilityZoneChangeProtection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ResourceOwnerCheckException **   
Unable to change the resource because your account doesn't own it.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateAvailabilityZoneChangeProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateAvailabilityZoneChangeProtection) 

# UpdateFirewallAnalysisSettings
<a name="API_UpdateFirewallAnalysisSettings"></a>

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

## Request Syntax
<a name="API_UpdateFirewallAnalysisSettings_RequestSyntax"></a>

```
{
   "EnabledAnalysisTypes": [ "string" ],
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateFirewallAnalysisSettings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EnabledAnalysisTypes](#API_UpdateFirewallAnalysisSettings_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-request-EnabledAnalysisTypes"></a>
An optional setting indicating the specific traffic analysis types to enable on the firewall.   
Type: Array of strings  
Valid Values: `TLS_SNI | HTTP_HOST`   
Required: No

 ** [FirewallArn](#API_UpdateFirewallAnalysisSettings_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateFirewallAnalysisSettings_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateFirewallAnalysisSettings_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateFirewallAnalysisSettings_ResponseSyntax"></a>

```
{
   "EnabledAnalysisTypes": [ "string" ],
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateFirewallAnalysisSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EnabledAnalysisTypes](#API_UpdateFirewallAnalysisSettings_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-response-EnabledAnalysisTypes"></a>
An optional setting indicating the specific traffic analysis types to enable on the firewall.   
Type: Array of strings  
Valid Values: `TLS_SNI | HTTP_HOST` 

 ** [FirewallArn](#API_UpdateFirewallAnalysisSettings_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateFirewallAnalysisSettings_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_UpdateFirewallAnalysisSettings_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallAnalysisSettings-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateFirewallAnalysisSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateFirewallAnalysisSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateFirewallAnalysisSettings) 

# UpdateFirewallDeleteProtection
<a name="API_UpdateFirewallDeleteProtection"></a>

Modifies the flag, `DeleteProtection`, which indicates whether it is possible to delete the firewall. If the flag is set to `TRUE`, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use. 

## Request Syntax
<a name="API_UpdateFirewallDeleteProtection_RequestSyntax"></a>

```
{
   "DeleteProtection": boolean,
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateFirewallDeleteProtection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DeleteProtection](#API_UpdateFirewallDeleteProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-request-DeleteProtection"></a>
A flag indicating whether it is possible to delete the firewall. A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE`.  
Type: Boolean  
Required: Yes

 ** [FirewallArn](#API_UpdateFirewallDeleteProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateFirewallDeleteProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateFirewallDeleteProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateFirewallDeleteProtection_ResponseSyntax"></a>

```
{
   "DeleteProtection": boolean,
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateFirewallDeleteProtection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeleteProtection](#API_UpdateFirewallDeleteProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-response-DeleteProtection"></a>
A flag indicating whether it is possible to delete the firewall. A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE`.  
Type: Boolean

 ** [FirewallArn](#API_UpdateFirewallDeleteProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateFirewallDeleteProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_UpdateFirewallDeleteProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDeleteProtection-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateFirewallDeleteProtection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ResourceOwnerCheckException **   
Unable to change the resource because your account doesn't own it.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateFirewallDeleteProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateFirewallDeleteProtection) 

# UpdateFirewallDescription
<a name="API_UpdateFirewallDescription"></a>

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it. 

## Request Syntax
<a name="API_UpdateFirewallDescription_RequestSyntax"></a>

```
{
   "Description": "string",
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateFirewallDescription_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateFirewallDescription_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-request-Description"></a>
The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [FirewallArn](#API_UpdateFirewallDescription_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateFirewallDescription_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateFirewallDescription_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateFirewallDescription_ResponseSyntax"></a>

```
{
   "Description": "string",
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateFirewallDescription_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_UpdateFirewallDescription_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-response-Description"></a>
A description of the firewall.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$` 

 ** [FirewallArn](#API_UpdateFirewallDescription_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateFirewallDescription_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_UpdateFirewallDescription_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallDescription-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateFirewallDescription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateFirewallDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateFirewallDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateFirewallDescription) 

# UpdateFirewallEncryptionConfiguration
<a name="API_UpdateFirewallEncryptionConfiguration"></a>

A complex type that contains settings for encryption of your firewall resources.

## Request Syntax
<a name="API_UpdateFirewallEncryptionConfiguration_RequestSyntax"></a>

```
{
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateFirewallEncryptionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EncryptionConfiguration](#API_UpdateFirewallEncryptionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-request-EncryptionConfiguration"></a>
A complex type that contains optional AWS Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an AWS owned key that AWS owns and manages for you. You can use either the AWS owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see [Encryption at rest with AWS Key Managment Service](https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) in the *Network Firewall Developer Guide*.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [FirewallArn](#API_UpdateFirewallEncryptionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateFirewallEncryptionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateFirewallEncryptionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateFirewallEncryptionConfiguration_ResponseSyntax"></a>

```
{
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "FirewallArn": "string",
   "FirewallName": "string",
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateFirewallEncryptionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EncryptionConfiguration](#API_UpdateFirewallEncryptionConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-response-EncryptionConfiguration"></a>
A complex type that contains optional AWS Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an AWS owned key that AWS owns and manages for you. You can use either the AWS owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see [Encryption at rest with AWS Key Managment Service](https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) in the *Network Firewall Developer Guide*.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object

 ** [FirewallArn](#API_UpdateFirewallEncryptionConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateFirewallEncryptionConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [UpdateToken](#API_UpdateFirewallEncryptionConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallEncryptionConfiguration-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateFirewallEncryptionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ResourceOwnerCheckException **   
Unable to change the resource because your account doesn't own it.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateFirewallEncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration) 

# UpdateFirewallPolicy
<a name="API_UpdateFirewallPolicy"></a>

Updates the properties of the specified firewall policy.

## Request Syntax
<a name="API_UpdateFirewallPolicy_RequestSyntax"></a>

```
{
   "Description": "string",
   "DryRun": boolean,
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "FirewallPolicy": { 
      "EnableTLSSessionHolding": boolean,
      "PolicyVariables": { 
         "RuleVariables": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         }
      },
      "StatefulDefaultActions": [ "string" ],
      "StatefulEngineOptions": { 
         "FlowTimeouts": { 
            "TcpIdleTimeoutSeconds": number
         },
         "RuleOrder": "string",
         "StreamExceptionPolicy": "string"
      },
      "StatefulRuleGroupReferences": [ 
         { 
            "DeepThreatInspection": boolean,
            "Override": { 
               "Action": "string"
            },
            "Priority": number,
            "ResourceArn": "string"
         }
      ],
      "StatelessCustomActions": [ 
         { 
            "ActionDefinition": { 
               "PublishMetricAction": { 
                  "Dimensions": [ 
                     { 
                        "Value": "string"
                     }
                  ]
               }
            },
            "ActionName": "string"
         }
      ],
      "StatelessDefaultActions": [ "string" ],
      "StatelessFragmentDefaultActions": [ "string" ],
      "StatelessRuleGroupReferences": [ 
         { 
            "Priority": number,
            "ResourceArn": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string"
   },
   "FirewallPolicyArn": "string",
   "FirewallPolicyName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateFirewallPolicy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-Description"></a>
A description of the firewall policy.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [DryRun](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-DryRun"></a>
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.   
If set to `TRUE`, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to `FALSE`, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.   
If set to `FALSE`, Network Firewall makes the requested changes to your resources.   
Type: Boolean  
Required: No

 ** [EncryptionConfiguration](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-EncryptionConfiguration"></a>
A complex type that contains settings for encryption of your firewall policy resources.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [FirewallPolicy](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-FirewallPolicy"></a>
The updated firewall policy to use for the firewall. You can't add or remove a [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md) after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another `TLSInspectionConfiguration`.  
Type: [FirewallPolicy](API_FirewallPolicy.md) object  
Required: Yes

 ** [FirewallPolicyArn](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-FirewallPolicyArn"></a>
The Amazon Resource Name (ARN) of the firewall policy.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallPolicyName](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-FirewallPolicyName"></a>
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateFirewallPolicy_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-request-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.   
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateFirewallPolicy_ResponseSyntax"></a>

```
{
   "FirewallPolicyResponse": { 
      "ConsumedStatefulDomainCapacity": number,
      "ConsumedStatefulRuleCapacity": number,
      "ConsumedStatelessRuleCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "FirewallPolicyArn": "string",
      "FirewallPolicyId": "string",
      "FirewallPolicyName": "string",
      "FirewallPolicyStatus": "string",
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateFirewallPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallPolicyResponse](#API_UpdateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-response-FirewallPolicyResponse"></a>
The high-level properties of a firewall policy. This, along with the [FirewallPolicy](API_FirewallPolicy.md), define the policy. You can retrieve all objects for a firewall policy by calling [DescribeFirewallPolicy](API_DescribeFirewallPolicy.md).   
Type: [FirewallPolicyResponse](API_FirewallPolicyResponse.md) object

 ** [UpdateToken](#API_UpdateFirewallPolicy_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallPolicy-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.   
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateFirewallPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateFirewallPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateFirewallPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateFirewallPolicy) 

# UpdateFirewallPolicyChangeProtection
<a name="API_UpdateFirewallPolicyChangeProtection"></a>

Modifies the flag, `ChangeProtection`, which indicates whether it is possible to change the firewall. If the flag is set to `TRUE`, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.

## Request Syntax
<a name="API_UpdateFirewallPolicyChangeProtection_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "FirewallPolicyChangeProtection": boolean,
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateFirewallPolicyChangeProtection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_UpdateFirewallPolicyChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateFirewallPolicyChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [FirewallPolicyChangeProtection](#API_UpdateFirewallPolicyChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-request-FirewallPolicyChangeProtection"></a>
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean  
Required: Yes

 ** [UpdateToken](#API_UpdateFirewallPolicyChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateFirewallPolicyChangeProtection_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "FirewallPolicyChangeProtection": boolean,
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateFirewallPolicyChangeProtection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_UpdateFirewallPolicyChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateFirewallPolicyChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [FirewallPolicyChangeProtection](#API_UpdateFirewallPolicyChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-response-FirewallPolicyChangeProtection"></a>
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean

 ** [UpdateToken](#API_UpdateFirewallPolicyChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateFirewallPolicyChangeProtection-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateFirewallPolicyChangeProtection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ResourceOwnerCheckException **   
Unable to change the resource because your account doesn't own it.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateFirewallPolicyChangeProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection) 

# UpdateLoggingConfiguration
<a name="API_UpdateLoggingConfiguration"></a>

Sets the logging configuration for the specified firewall. 

To change the logging configuration, retrieve the [LoggingConfiguration](API_LoggingConfiguration.md) by calling [DescribeLoggingConfiguration](API_DescribeLoggingConfiguration.md), then change it and provide the modified object to this update call. You must change the logging configuration one [LogDestinationConfig](API_LogDestinationConfig.md) at a time inside the retrieved [LoggingConfiguration](API_LoggingConfiguration.md) object. 

You can perform only one of the following actions in any call to `UpdateLoggingConfiguration`: 
+ Create a new log destination object by adding a single `LogDestinationConfig` array element to `LogDestinationConfigs`.
+ Delete a log destination object by removing a single `LogDestinationConfig` array element from `LogDestinationConfigs`.
+ Change the `LogDestination` setting in a single `LogDestinationConfig` array element.

You can't change the `LogDestinationType` or `LogType` in a `LogDestinationConfig`. To change these settings, delete the existing `LogDestinationConfig` object and create a new one, using two separate calls to this update operation.

## Request Syntax
<a name="API_UpdateLoggingConfiguration_RequestSyntax"></a>

```
{
   "EnableMonitoringDashboard": boolean,
   "FirewallArn": "string",
   "FirewallName": "string",
   "LoggingConfiguration": { 
      "LogDestinationConfigs": [ 
         { 
            "LogDestination": { 
               "string" : "string" 
            },
            "LogDestinationType": "string",
            "LogType": "string"
         }
      ]
   }
}
```

## Request Parameters
<a name="API_UpdateLoggingConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EnableMonitoringDashboard](#API_UpdateLoggingConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-request-EnableMonitoringDashboard"></a>
A boolean that lets you enable or disable the detailed firewall monitoring dashboard on the firewall.   
The monitoring dashboard provides comprehensive visibility into your firewall's flow logs and alert logs. After you enable detailed monitoring, you can access these dashboards directly from the **Monitoring** page of the Network Firewall console.  
 Specify `TRUE` to enable the the detailed monitoring dashboard on the firewall. Specify `FALSE` to disable the the detailed monitoring dashboard on the firewall.   
Type: Boolean  
Required: No

 ** [FirewallArn](#API_UpdateLoggingConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateLoggingConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [LoggingConfiguration](#API_UpdateLoggingConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-request-LoggingConfiguration"></a>
Defines how Network Firewall performs logging for a firewall. If you omit this setting, Network Firewall disables logging for the firewall.  
Type: [LoggingConfiguration](API_LoggingConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_UpdateLoggingConfiguration_ResponseSyntax"></a>

```
{
   "EnableMonitoringDashboard": boolean,
   "FirewallArn": "string",
   "FirewallName": "string",
   "LoggingConfiguration": { 
      "LogDestinationConfigs": [ 
         { 
            "LogDestination": { 
               "string" : "string" 
            },
            "LogDestinationType": "string",
            "LogType": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_UpdateLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EnableMonitoringDashboard](#API_UpdateLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-response-EnableMonitoringDashboard"></a>
A boolean that reflects whether or not the firewall monitoring dashboard is enabled on a firewall.  
 Returns `TRUE` when the firewall monitoring dashboard is enabled on the firewall. Returns `FALSE` when the firewall monitoring dashboard is not enabled on the firewall.   
Type: Boolean

 ** [FirewallArn](#API_UpdateLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [LoggingConfiguration](#API_UpdateLoggingConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateLoggingConfiguration-response-LoggingConfiguration"></a>
Defines how AWS Network Firewall performs logging for a [Firewall](API_Firewall.md).   
Type: [LoggingConfiguration](API_LoggingConfiguration.md) object

## Errors
<a name="API_UpdateLoggingConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** LogDestinationPermissionException **   
Unable to send logs to a configured logging destination.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateLoggingConfiguration) 

# UpdateProxy
<a name="API_UpdateProxy"></a>

Updates the properties of the specified proxy.

## Request Syntax
<a name="API_UpdateProxy_RequestSyntax"></a>

```
{
   "ListenerPropertiesToAdd": [ 
      { 
         "Port": number,
         "Type": "string"
      }
   ],
   "ListenerPropertiesToRemove": [ 
      { 
         "Port": number,
         "Type": "string"
      }
   ],
   "NatGatewayId": "string",
   "ProxyArn": "string",
   "ProxyName": "string",
   "TlsInterceptProperties": { 
      "PcaArn": "string",
      "TlsInterceptMode": "string"
   },
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateProxy_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ListenerPropertiesToAdd](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-ListenerPropertiesToAdd"></a>
Listener properties for HTTP and HTTPS traffic to add.   
Type: Array of [ListenerPropertyRequest](API_ListenerPropertyRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

 ** [ListenerPropertiesToRemove](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-ListenerPropertiesToRemove"></a>
Listener properties for HTTP and HTTPS traffic to remove.   
Type: Array of [ListenerPropertyRequest](API_ListenerPropertyRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

 ** [NatGatewayId](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-NatGatewayId"></a>
The NAT Gateway the proxy is attached to.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [ProxyArn](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-ProxyArn"></a>
The Amazon Resource Name (ARN) of a proxy.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyName](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-ProxyName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [TlsInterceptProperties](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-TlsInterceptProperties"></a>
TLS decryption on traffic to filter on attributes in the HTTP header.   
Type: [TlsInterceptPropertiesRequest](API_TlsInterceptPropertiesRequest.md) object  
Required: No

 ** [UpdateToken](#API_UpdateProxy_RequestSyntax) **   <a name="networkfirewall-UpdateProxy-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateProxy_ResponseSyntax"></a>

```
{
   "Proxy": { 
      "CreateTime": number,
      "DeleteTime": number,
      "FailureCode": "string",
      "FailureMessage": "string",
      "ListenerProperties": [ 
         { 
            "Port": number,
            "Type": "string"
         }
      ],
      "NatGatewayId": "string",
      "ProxyArn": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "ProxyModifyState": "string",
      "ProxyName": "string",
      "ProxyState": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TlsInterceptProperties": { 
         "PcaArn": "string",
         "TlsInterceptMode": "string"
      },
      "UpdateTime": number
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateProxy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Proxy](#API_UpdateProxy_ResponseSyntax) **   <a name="networkfirewall-UpdateProxy-response-Proxy"></a>
The updated proxy resource that reflects the updates from the request.  
Type: [Proxy](API_Proxy.md) object

 ** [UpdateToken](#API_UpdateProxy_ResponseSyntax) **   <a name="networkfirewall-UpdateProxy-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateProxy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
The operation you requested isn't supported by Network Firewall.   
HTTP Status Code: 400

## See Also
<a name="API_UpdateProxy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateProxy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateProxy) 

# UpdateProxyConfiguration
<a name="API_UpdateProxyConfiguration"></a>

Updates the properties of the specified proxy configuration.

## Request Syntax
<a name="API_UpdateProxyConfiguration_RequestSyntax"></a>

```
{
   "DefaultRulePhaseActions": { 
      "PostRESPONSE": "string",
      "PreDNS": "string",
      "PreREQUEST": "string"
   },
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateProxyConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DefaultRulePhaseActions](#API_UpdateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateProxyConfiguration-request-DefaultRulePhaseActions"></a>
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.   
Type: [ProxyConfigDefaultRulePhaseActionsRequest](API_ProxyConfigDefaultRulePhaseActionsRequest.md) object  
Required: Yes

 ** [ProxyConfigurationArn](#API_UpdateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateProxyConfiguration-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_UpdateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateProxyConfiguration-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateProxyConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateProxyConfiguration-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateProxyConfiguration_ResponseSyntax"></a>

```
{
   "ProxyConfiguration": { 
      "CreateTime": number,
      "DefaultRulePhaseActions": { 
         "PostRESPONSE": "string",
         "PreDNS": "string",
         "PreREQUEST": "string"
      },
      "DeleteTime": number,
      "Description": "string",
      "ProxyConfigurationArn": "string",
      "ProxyConfigurationName": "string",
      "RuleGroups": [ 
         { 
            "Priority": number,
            "ProxyRuleGroupArn": "string",
            "ProxyRuleGroupName": "string",
            "Type": "string"
         }
      ],
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateProxyConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyConfiguration](#API_UpdateProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyConfiguration-response-ProxyConfiguration"></a>
The updated proxy configuration resource that reflects the updates from the request.  
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object

 ** [UpdateToken](#API_UpdateProxyConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyConfiguration-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateProxyConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProxyConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateProxyConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateProxyConfiguration) 

# UpdateProxyRule
<a name="API_UpdateProxyRule"></a>

Updates the properties of the specified proxy rule.

## Request Syntax
<a name="API_UpdateProxyRule_RequestSyntax"></a>

```
{
   "Action": "string",
   "AddConditions": [ 
      { 
         "ConditionKey": "string",
         "ConditionOperator": "string",
         "ConditionValues": [ "string" ]
      }
   ],
   "Description": "string",
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string",
   "ProxyRuleName": "string",
   "RemoveConditions": [ 
      { 
         "ConditionKey": "string",
         "ConditionOperator": "string",
         "ConditionValues": [ "string" ]
      }
   ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateProxyRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Action](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-Action"></a>
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.   
Type: String  
Valid Values: `ALLOW | DENY | ALERT`   
Required: No

 ** [AddConditions](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-AddConditions"></a>
Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.   
Type: Array of [ProxyRuleCondition](API_ProxyRuleCondition.md) objects  
Required: No

 ** [Description](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-Description"></a>
A description of the proxy rule.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [ProxyRuleGroupArn](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [ProxyRuleName](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-ProxyRuleName"></a>
The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** [RemoveConditions](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-RemoveConditions"></a>
Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.   
Type: Array of [ProxyRuleCondition](API_ProxyRuleCondition.md) objects  
Required: No

 ** [UpdateToken](#API_UpdateProxyRule_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRule-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateProxyRule_ResponseSyntax"></a>

```
{
   "ProxyRule": { 
      "Action": "string",
      "Conditions": [ 
         { 
            "ConditionKey": "string",
            "ConditionOperator": "string",
            "ConditionValues": [ "string" ]
         }
      ],
      "Description": "string",
      "ProxyRuleName": "string"
   },
   "RemovedConditions": [ 
      { 
         "ConditionKey": "string",
         "ConditionOperator": "string",
         "ConditionValues": [ "string" ]
      }
   ],
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateProxyRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRule](#API_UpdateProxyRule_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRule-response-ProxyRule"></a>
The updated proxy rule resource that reflects the updates from the request.  
Type: [ProxyRule](API_ProxyRule.md) object

 ** [RemovedConditions](#API_UpdateProxyRule_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRule-response-RemovedConditions"></a>
Proxy rule conditions removed from the rule.   
Type: Array of [ProxyRuleCondition](API_ProxyRuleCondition.md) objects

 ** [UpdateToken](#API_UpdateProxyRule_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRule-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateProxyRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProxyRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateProxyRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateProxyRule) 

# UpdateProxyRuleGroupPriorities
<a name="API_UpdateProxyRuleGroupPriorities"></a>

Updates proxy rule group priorities within a proxy configuration.

## Request Syntax
<a name="API_UpdateProxyRuleGroupPriorities_RequestSyntax"></a>

```
{
   "ProxyConfigurationArn": "string",
   "ProxyConfigurationName": "string",
   "RuleGroups": [ 
      { 
         "NewPosition": number,
         "ProxyRuleGroupName": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateProxyRuleGroupPriorities_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyConfigurationArn](#API_UpdateProxyRuleGroupPriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRuleGroupPriorities-request-ProxyConfigurationArn"></a>
The Amazon Resource Name (ARN) of a proxy configuration.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyConfigurationName](#API_UpdateProxyRuleGroupPriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRuleGroupPriorities-request-ProxyConfigurationName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [RuleGroups](#API_UpdateProxyRuleGroupPriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRuleGroupPriorities-request-RuleGroups"></a>
proxy rule group resources to update to new positions.   
Type: Array of [ProxyRuleGroupPriority](API_ProxyRuleGroupPriority.md) objects  
Required: Yes

 ** [UpdateToken](#API_UpdateProxyRuleGroupPriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRuleGroupPriorities-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateProxyRuleGroupPriorities_ResponseSyntax"></a>

```
{
   "ProxyRuleGroups": [ 
      { 
         "Priority": number,
         "ProxyRuleGroupName": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateProxyRuleGroupPriorities_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroups](#API_UpdateProxyRuleGroupPriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRuleGroupPriorities-response-ProxyRuleGroups"></a>
The updated proxy rule group hierarchy that reflects the updates from the request.  
Type: Array of [ProxyRuleGroupPriorityResult](API_ProxyRuleGroupPriorityResult.md) objects

 ** [UpdateToken](#API_UpdateProxyRuleGroupPriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRuleGroupPriorities-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateProxyRuleGroupPriorities_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProxyRuleGroupPriorities_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateProxyRuleGroupPriorities) 

# UpdateProxyRulePriorities
<a name="API_UpdateProxyRulePriorities"></a>

Updates proxy rule priorities within a proxy rule group.

## Request Syntax
<a name="API_UpdateProxyRulePriorities_RequestSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string",
   "RuleGroupRequestPhase": "string",
   "Rules": [ 
      { 
         "NewPosition": number,
         "ProxyRuleName": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateProxyRulePriorities_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ProxyRuleGroupArn](#API_UpdateProxyRulePriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-request-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [ProxyRuleGroupName](#API_UpdateProxyRulePriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-request-ProxyRuleGroupName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [RuleGroupRequestPhase](#API_UpdateProxyRulePriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-request-RuleGroupRequestPhase"></a>
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.   
Type: String  
Valid Values: `PRE_DNS | PRE_REQ | POST_RES`   
Required: Yes

 ** [Rules](#API_UpdateProxyRulePriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-request-Rules"></a>
proxy rule resources to update to new positions.   
Type: Array of [ProxyRulePriority](API_ProxyRulePriority.md) objects  
Required: Yes

 ** [UpdateToken](#API_UpdateProxyRulePriorities_RequestSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-request-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateProxyRulePriorities_ResponseSyntax"></a>

```
{
   "ProxyRuleGroupArn": "string",
   "ProxyRuleGroupName": "string",
   "RuleGroupRequestPhase": "string",
   "Rules": [ 
      { 
         "NewPosition": number,
         "ProxyRuleName": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateProxyRulePriorities_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProxyRuleGroupArn](#API_UpdateProxyRulePriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-response-ProxyRuleGroupArn"></a>
The Amazon Resource Name (ARN) of a proxy rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [ProxyRuleGroupName](#API_UpdateProxyRulePriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-response-ProxyRuleGroupName"></a>
The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [RuleGroupRequestPhase](#API_UpdateProxyRulePriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-response-RuleGroupRequestPhase"></a>
Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.   
Type: String  
Valid Values: `PRE_DNS | PRE_REQ | POST_RES` 

 ** [Rules](#API_UpdateProxyRulePriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-response-Rules"></a>
The updated proxy rule hierarchy that reflects the updates from the request.  
Type: Array of [ProxyRulePriority](API_ProxyRulePriority.md) objects

 ** [UpdateToken](#API_UpdateProxyRulePriorities_ResponseSyntax) **   <a name="networkfirewall-UpdateProxyRulePriorities-response-UpdateToken"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateProxyRulePriorities_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProxyRulePriorities_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateProxyRulePriorities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateProxyRulePriorities) 

# UpdateRuleGroup
<a name="API_UpdateRuleGroup"></a>

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group. 

To update a rule group, first call [DescribeRuleGroup](API_DescribeRuleGroup.md) to retrieve the current [RuleGroup](API_RuleGroup.md) object, update the object as needed, and then provide the updated object to this call. 

## Request Syntax
<a name="API_UpdateRuleGroup_RequestSyntax"></a>

```
{
   "AnalyzeRuleGroup": boolean,
   "Description": "string",
   "DryRun": boolean,
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "RuleGroup": { 
      "ReferenceSets": { 
         "IPSetReferences": { 
            "string" : { 
               "ReferenceArn": "string"
            }
         }
      },
      "RulesSource": { 
         "RulesSourceList": { 
            "GeneratedRulesType": "string",
            "Targets": [ "string" ],
            "TargetTypes": [ "string" ]
         },
         "RulesString": "string",
         "StatefulRules": [ 
            { 
               "Action": "string",
               "Header": { 
                  "Destination": "string",
                  "DestinationPort": "string",
                  "Direction": "string",
                  "Protocol": "string",
                  "Source": "string",
                  "SourcePort": "string"
               },
               "RuleOptions": [ 
                  { 
                     "Keyword": "string",
                     "Settings": [ "string" ]
                  }
               ]
            }
         ],
         "StatelessRulesAndCustomActions": { 
            "CustomActions": [ 
               { 
                  "ActionDefinition": { 
                     "PublishMetricAction": { 
                        "Dimensions": [ 
                           { 
                              "Value": "string"
                           }
                        ]
                     }
                  },
                  "ActionName": "string"
               }
            ],
            "StatelessRules": [ 
               { 
                  "Priority": number,
                  "RuleDefinition": { 
                     "Actions": [ "string" ],
                     "MatchAttributes": { 
                        "DestinationPorts": [ 
                           { 
                              "FromPort": number,
                              "ToPort": number
                           }
                        ],
                        "Destinations": [ 
                           { 
                              "AddressDefinition": "string"
                           }
                        ],
                        "Protocols": [ number ],
                        "SourcePorts": [ 
                           { 
                              "FromPort": number,
                              "ToPort": number
                           }
                        ],
                        "Sources": [ 
                           { 
                              "AddressDefinition": "string"
                           }
                        ],
                        "TCPFlags": [ 
                           { 
                              "Flags": [ "string" ],
                              "Masks": [ "string" ]
                           }
                        ]
                     }
                  }
               }
            ]
         }
      },
      "RuleVariables": { 
         "IPSets": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         },
         "PortSets": { 
            "string" : { 
               "Definition": [ "string" ]
            }
         }
      },
      "StatefulRuleOptions": { 
         "RuleOrder": "string"
      }
   },
   "RuleGroupArn": "string",
   "RuleGroupName": "string",
   "Rules": "string",
   "SourceMetadata": { 
      "SourceArn": "string",
      "SourceUpdateToken": "string"
   },
   "SummaryConfiguration": { 
      "RuleOptions": [ "string" ]
   },
   "Type": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateRuleGroup_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AnalyzeRuleGroup](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-AnalyzeRuleGroup"></a>
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to `TRUE`, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set `DryRun` to `TRUE`.   
Type: Boolean  
Required: No

 ** [Description](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-Description"></a>
A description of the rule group.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [DryRun](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-DryRun"></a>
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.   
If set to `TRUE`, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to `FALSE`, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.   
If set to `FALSE`, Network Firewall makes the requested changes to your resources.   
Type: Boolean  
Required: No

 ** [EncryptionConfiguration](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-EncryptionConfiguration"></a>
A complex type that contains settings for encryption of your rule group resources.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [RuleGroup](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-RuleGroup"></a>
An object that defines the rule group rules.   
You must provide either this rule group setting or a `Rules` setting, but not both. 
Type: [RuleGroup](API_RuleGroup.md) object  
Required: No

 ** [RuleGroupArn](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-RuleGroupArn"></a>
The Amazon Resource Name (ARN) of the rule group.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [RuleGroupName](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-RuleGroupName"></a>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [Rules](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-Rules"></a>
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.   
You must provide either this rules setting or a populated `RuleGroup` setting, but not both. 
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a [RuleGroup](API_RuleGroup.md) object that Network Firewall has populated from your string.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2000000.  
Required: No

 ** [SourceMetadata](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-SourceMetadata"></a>
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.  
Type: [SourceMetadata](API_SourceMetadata.md) object  
Required: No

 ** [SummaryConfiguration](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-SummaryConfiguration"></a>
Updates the selected summary configuration for a rule group.  
Changes affect subsequent responses from [DescribeRuleGroupSummary](API_DescribeRuleGroupSummary.md).  
Type: [SummaryConfiguration](API_SummaryConfiguration.md) object  
Required: No

 ** [Type](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-Type"></a>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.   
This setting is required for requests that do not include the `RuleGroupARN`.
Type: String  
Valid Values: `STATELESS | STATEFUL | STATEFUL_DOMAIN`   
Required: No

 ** [UpdateToken](#API_UpdateRuleGroup_RequestSyntax) **   <a name="networkfirewall-UpdateRuleGroup-request-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.   
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the 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 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateRuleGroup_ResponseSyntax"></a>

```
{
   "RuleGroupResponse": { 
      "AnalysisResults": [ 
         { 
            "AnalysisDetail": "string",
            "IdentifiedRuleIds": [ "string" ],
            "IdentifiedType": "string"
         }
      ],
      "Capacity": number,
      "ConsumedCapacity": number,
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "RuleGroupArn": "string",
      "RuleGroupId": "string",
      "RuleGroupName": "string",
      "RuleGroupStatus": "string",
      "SnsTopic": "string",
      "SourceMetadata": { 
         "SourceArn": "string",
         "SourceUpdateToken": "string"
      },
      "SummaryConfiguration": { 
         "RuleOptions": [ "string" ]
      },
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateRuleGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RuleGroupResponse](#API_UpdateRuleGroup_ResponseSyntax) **   <a name="networkfirewall-UpdateRuleGroup-response-RuleGroupResponse"></a>
The high-level properties of a rule group. This, along with the [RuleGroup](API_RuleGroup.md), define the rule group. You can retrieve all objects for a rule group by calling [DescribeRuleGroup](API_DescribeRuleGroup.md).   
Type: [RuleGroupResponse](API_RuleGroupResponse.md) object

 ** [UpdateToken](#API_UpdateRuleGroup_ResponseSyntax) **   <a name="networkfirewall-UpdateRuleGroup-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.   
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the 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 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateRuleGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateRuleGroup) 

# UpdateSubnetChangeProtection
<a name="API_UpdateSubnetChangeProtection"></a>



## Request Syntax
<a name="API_UpdateSubnetChangeProtection_RequestSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "SubnetChangeProtection": boolean,
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateSubnetChangeProtection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [FirewallArn](#API_UpdateSubnetChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-request-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [FirewallName](#API_UpdateSubnetChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-request-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
You must specify the ARN or the name, and you can specify both.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [SubnetChangeProtection](#API_UpdateSubnetChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-request-SubnetChangeProtection"></a>
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean  
Required: Yes

 ** [UpdateToken](#API_UpdateSubnetChangeProtection_RequestSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-request-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: No

## Response Syntax
<a name="API_UpdateSubnetChangeProtection_ResponseSyntax"></a>

```
{
   "FirewallArn": "string",
   "FirewallName": "string",
   "SubnetChangeProtection": boolean,
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateSubnetChangeProtection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FirewallArn](#API_UpdateSubnetChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-response-FirewallArn"></a>
The Amazon Resource Name (ARN) of the firewall.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*` 

 ** [FirewallName](#API_UpdateSubnetChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-response-FirewallName"></a>
The descriptive name of the firewall. You can't change the name of a firewall after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$` 

 ** [SubnetChangeProtection](#API_UpdateSubnetChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-response-SubnetChangeProtection"></a>
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE`.  
Type: Boolean

 ** [UpdateToken](#API_UpdateSubnetChangeProtection_ResponseSyntax) **   <a name="networkfirewall-UpdateSubnetChangeProtection-response-UpdateToken"></a>
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.   
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.  
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateSubnetChangeProtection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ResourceOwnerCheckException **   
Unable to change the resource because your account doesn't own it.   
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSubnetChangeProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateSubnetChangeProtection) 

# UpdateTLSInspectionConfiguration
<a name="API_UpdateTLSInspectionConfiguration"></a>

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration. 

To update a TLS inspection configuration, first call [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md) to retrieve the current [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md) object, update the object as needed, and then provide the updated object to this call. 

## Request Syntax
<a name="API_UpdateTLSInspectionConfiguration_RequestSyntax"></a>

```
{
   "Description": "string",
   "EncryptionConfiguration": { 
      "KeyId": "string",
      "Type": "string"
   },
   "TLSInspectionConfiguration": { 
      "ServerCertificateConfigurations": [ 
         { 
            "CertificateAuthorityArn": "string",
            "CheckCertificateRevocationStatus": { 
               "RevokedStatusAction": "string",
               "UnknownStatusAction": "string"
            },
            "Scopes": [ 
               { 
                  "DestinationPorts": [ 
                     { 
                        "FromPort": number,
                        "ToPort": number
                     }
                  ],
                  "Destinations": [ 
                     { 
                        "AddressDefinition": "string"
                     }
                  ],
                  "Protocols": [ number ],
                  "SourcePorts": [ 
                     { 
                        "FromPort": number,
                        "ToPort": number
                     }
                  ],
                  "Sources": [ 
                     { 
                        "AddressDefinition": "string"
                     }
                  ]
               }
            ],
            "ServerCertificates": [ 
               { 
                  "ResourceArn": "string"
               }
            ]
         }
      ]
   },
   "TLSInspectionConfigurationArn": "string",
   "TLSInspectionConfigurationName": "string",
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateTLSInspectionConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-request-Description"></a>
A description of the TLS inspection configuration.   
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `^.*$`   
Required: No

 ** [EncryptionConfiguration](#API_UpdateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-request-EncryptionConfiguration"></a>
A complex type that contains the AWS KMS encryption configuration settings for your TLS inspection configuration.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** [TLSInspectionConfiguration](#API_UpdateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-request-TLSInspectionConfiguration"></a>
The object that defines a TLS inspection configuration. This, along with [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md).   
 AWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.  
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the * AWS Network Firewall Developer Guide*.  
Type: [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md) object  
Required: Yes

 ** [TLSInspectionConfigurationArn](#API_UpdateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-request-TLSInspectionConfigurationArn"></a>
The Amazon Resource Name (ARN) of the TLS inspection configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws.*`   
Required: No

 ** [TLSInspectionConfigurationName](#API_UpdateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-request-TLSInspectionConfigurationName"></a>
The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [UpdateToken](#API_UpdateTLSInspectionConfiguration_RequestSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-request-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.   
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the TLS inspection 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$`   
Required: Yes

## Response Syntax
<a name="API_UpdateTLSInspectionConfiguration_ResponseSyntax"></a>

```
{
   "TLSInspectionConfigurationResponse": { 
      "CertificateAuthority": { 
         "CertificateArn": "string",
         "CertificateSerial": "string",
         "Status": "string",
         "StatusMessage": "string"
      },
      "Certificates": [ 
         { 
            "CertificateArn": "string",
            "CertificateSerial": "string",
            "Status": "string",
            "StatusMessage": "string"
         }
      ],
      "Description": "string",
      "EncryptionConfiguration": { 
         "KeyId": "string",
         "Type": "string"
      },
      "LastModifiedTime": number,
      "NumberOfAssociations": number,
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "TLSInspectionConfigurationArn": "string",
      "TLSInspectionConfigurationId": "string",
      "TLSInspectionConfigurationName": "string",
      "TLSInspectionConfigurationStatus": "string"
   },
   "UpdateToken": "string"
}
```

## Response Elements
<a name="API_UpdateTLSInspectionConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TLSInspectionConfigurationResponse](#API_UpdateTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-response-TLSInspectionConfigurationResponse"></a>
The high-level properties of a TLS inspection configuration. This, along with the [TLSInspectionConfiguration](API_TLSInspectionConfiguration.md), define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling [DescribeTLSInspectionConfiguration](API_DescribeTLSInspectionConfiguration.md).   
Type: [TLSInspectionConfigurationResponse](API_TLSInspectionConfigurationResponse.md) object

 ** [UpdateToken](#API_UpdateTLSInspectionConfiguration_ResponseSyntax) **   <a name="networkfirewall-UpdateTLSInspectionConfiguration-response-UpdateToken"></a>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.   
To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an `InvalidTokenException`. If this happens, retrieve the TLS inspection 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$` 

## Errors
<a name="API_UpdateTLSInspectionConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerError **   
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.   
HTTP Status Code: 500

 ** InvalidRequestException **   
The operation failed because of a problem with your request. Examples include:   
+ You specified an unsupported parameter name or value.
+ You tried to update a property with a value that isn't among the available types.
+ Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400

 ** InvalidTokenException **   
The token you provided is stale or isn't valid for the operation.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Unable to locate a resource using the parameters that you provided.  
HTTP Status Code: 400

 ** ThrottlingException **   
Unable to process the request due to throttling limitations.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateTLSInspectionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/network-firewall-2020-11-12/UpdateTLSInspectionConfiguration)