@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSNetworkFirewall
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSNetworkFirewall instead.
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
To access Network Firewall using the REST API endpoint:
https://network-firewall.<region>.amazonaws.com
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the Network Firewall Developer Guide.
Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 6.0.9. For information about Suricata, see the Suricata website.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.
In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AssociateFirewallPolicyResult |
associateFirewallPolicy(AssociateFirewallPolicyRequest associateFirewallPolicyRequest)
Associates a FirewallPolicy to a Firewall.
|
AssociateSubnetsResult |
associateSubnets(AssociateSubnetsRequest associateSubnetsRequest)
Associates the specified subnets in the Amazon VPC to the firewall.
|
CreateFirewallResult |
createFirewall(CreateFirewallRequest createFirewallRequest)
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
|
CreateFirewallPolicyResult |
createFirewallPolicy(CreateFirewallPolicyRequest createFirewallPolicyRequest)
Creates the firewall policy for the firewall according to the specifications.
|
CreateRuleGroupResult |
createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest)
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection,
a capacity setting, and tags.
|
CreateTLSInspectionConfigurationResult |
createTLSInspectionConfiguration(CreateTLSInspectionConfigurationRequest createTLSInspectionConfigurationRequest)
Creates an Network Firewall TLS inspection configuration.
|
DeleteFirewallResult |
deleteFirewall(DeleteFirewallRequest deleteFirewallRequest)
Deletes the specified Firewall and its FirewallStatus.
|
DeleteFirewallPolicyResult |
deleteFirewallPolicy(DeleteFirewallPolicyRequest deleteFirewallPolicyRequest)
Deletes the specified FirewallPolicy.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy that you created in a PutResourcePolicy request.
|
DeleteRuleGroupResult |
deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest)
Deletes the specified RuleGroup.
|
DeleteTLSInspectionConfigurationResult |
deleteTLSInspectionConfiguration(DeleteTLSInspectionConfigurationRequest deleteTLSInspectionConfigurationRequest)
Deletes the specified TLSInspectionConfiguration.
|
DescribeFirewallResult |
describeFirewall(DescribeFirewallRequest describeFirewallRequest)
Returns the data objects for the specified firewall.
|
DescribeFirewallPolicyResult |
describeFirewallPolicy(DescribeFirewallPolicyRequest describeFirewallPolicyRequest)
Returns the data objects for the specified firewall policy.
|
DescribeLoggingConfigurationResult |
describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest)
Returns the logging configuration for the specified firewall.
|
DescribeResourcePolicyResult |
describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest)
Retrieves a resource policy that you created in a PutResourcePolicy request.
|
DescribeRuleGroupResult |
describeRuleGroup(DescribeRuleGroupRequest describeRuleGroupRequest)
Returns the data objects for the specified rule group.
|
DescribeRuleGroupMetadataResult |
describeRuleGroupMetadata(DescribeRuleGroupMetadataRequest describeRuleGroupMetadataRequest)
High-level information about a rule group, returned by operations like create and describe.
|
DescribeTLSInspectionConfigurationResult |
describeTLSInspectionConfiguration(DescribeTLSInspectionConfigurationRequest describeTLSInspectionConfigurationRequest)
Returns the data objects for the specified TLS inspection configuration.
|
DisassociateSubnetsResult |
disassociateSubnets(DisassociateSubnetsRequest disassociateSubnetsRequest)
Removes the specified subnet associations from the firewall.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListFirewallPoliciesResult |
listFirewallPolicies(ListFirewallPoliciesRequest listFirewallPoliciesRequest)
Retrieves the metadata for the firewall policies that you have defined.
|
ListFirewallsResult |
listFirewalls(ListFirewallsRequest listFirewallsRequest)
Retrieves the metadata for the firewalls that you have defined.
|
ListRuleGroupsResult |
listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest)
Retrieves the metadata for the rule groups that you have defined.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the tags associated with the specified resource.
|
ListTLSInspectionConfigurationsResult |
listTLSInspectionConfigurations(ListTLSInspectionConfigurationsRequest listTLSInspectionConfigurationsRequest)
Retrieves the metadata for the TLS inspection configurations that you have defined.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates an IAM policy for your rule group or firewall policy.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the tags with the specified keys from the specified resource.
|
UpdateFirewallDeleteProtectionResult |
updateFirewallDeleteProtection(UpdateFirewallDeleteProtectionRequest updateFirewallDeleteProtectionRequest)
Modifies the flag,
DeleteProtection, which indicates whether it is possible to delete the firewall. |
UpdateFirewallDescriptionResult |
updateFirewallDescription(UpdateFirewallDescriptionRequest updateFirewallDescriptionRequest)
Modifies the description for the specified firewall.
|
UpdateFirewallEncryptionConfigurationResult |
updateFirewallEncryptionConfiguration(UpdateFirewallEncryptionConfigurationRequest updateFirewallEncryptionConfigurationRequest)
A complex type that contains settings for encryption of your firewall resources.
|
UpdateFirewallPolicyResult |
updateFirewallPolicy(UpdateFirewallPolicyRequest updateFirewallPolicyRequest)
Updates the properties of the specified firewall policy.
|
UpdateFirewallPolicyChangeProtectionResult |
updateFirewallPolicyChangeProtection(UpdateFirewallPolicyChangeProtectionRequest updateFirewallPolicyChangeProtectionRequest)
Modifies the flag,
ChangeProtection, which indicates whether it is possible to change the firewall. |
UpdateLoggingConfigurationResult |
updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)
Sets the logging configuration for the specified firewall.
|
UpdateRuleGroupResult |
updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest)
Updates the rule settings for the specified rule group.
|
UpdateSubnetChangeProtectionResult |
updateSubnetChangeProtection(UpdateSubnetChangeProtectionRequest updateSubnetChangeProtectionRequest)
|
UpdateTLSInspectionConfigurationResult |
updateTLSInspectionConfiguration(UpdateTLSInspectionConfigurationRequest updateTLSInspectionConfigurationRequest)
Updates the TLS inspection configuration settings for the specified TLS inspection configuration.
|
static final String ENDPOINT_PREFIX
AssociateFirewallPolicyResult associateFirewallPolicy(AssociateFirewallPolicyRequest associateFirewallPolicyRequest)
Associates a FirewallPolicy to a Firewall.
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.
associateFirewallPolicyRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.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.AssociateSubnetsResult associateSubnets(AssociateSubnetsRequest associateSubnetsRequest)
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 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.
associateSubnetsRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.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.InsufficientCapacityException - Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your
request later.CreateFirewallResult createFirewall(CreateFirewallRequest createFirewallRequest)
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an 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 Amazon Web Services 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, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
createFirewallRequest - 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.
LimitExceededException - Unable to perform the operation because doing so would violate a limit setting.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ThrottlingException - Unable to process the request due to throttling limitations.InsufficientCapacityException - Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your
request later.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.CreateFirewallPolicyResult createFirewallPolicy(CreateFirewallPolicyRequest createFirewallPolicyRequest)
Creates the firewall policy for the firewall according to the specifications.
An 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.
createFirewallPolicyRequest - LimitExceededException - Unable to perform the operation because doing so would violate a limit setting.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.
ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.InsufficientCapacityException - Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your
request later.CreateRuleGroupResult createRuleGroup(CreateRuleGroupRequest createRuleGroupRequest)
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.
createRuleGroupRequest - LimitExceededException - Unable to perform the operation because doing so would violate a limit setting.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.
ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.InsufficientCapacityException - Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your
request later.CreateTLSInspectionConfigurationResult createTLSInspectionConfiguration(CreateTLSInspectionConfigurationRequest createTLSInspectionConfigurationRequest)
Creates an 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.
To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
createTLSInspectionConfigurationRequest - 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.
ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.LimitExceededException - Unable to perform the operation because doing so would violate a limit setting.InsufficientCapacityException - Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your
request later.DeleteFirewallResult deleteFirewall(DeleteFirewallRequest deleteFirewallRequest)
Deletes the specified Firewall and its FirewallStatus. 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. 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, then delete the firewall by calling DeleteFirewall.
deleteFirewallRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.UnsupportedOperationException - The operation you requested isn't supported by Network Firewall.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.DeleteFirewallPolicyResult deleteFirewallPolicy(DeleteFirewallPolicyRequest deleteFirewallPolicyRequest)
Deletes the specified FirewallPolicy.
deleteFirewallPolicyRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.UnsupportedOperationException - The operation you requested isn't supported by Network Firewall.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.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy that you created in a PutResourcePolicy request.
deleteResourcePolicyRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidResourcePolicyException - The policy statement failed validation.DeleteRuleGroupResult deleteRuleGroup(DeleteRuleGroupRequest deleteRuleGroupRequest)
Deletes the specified RuleGroup.
deleteRuleGroupRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.UnsupportedOperationException - The operation you requested isn't supported by Network Firewall.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.DeleteTLSInspectionConfigurationResult deleteTLSInspectionConfiguration(DeleteTLSInspectionConfigurationRequest deleteTLSInspectionConfigurationRequest)
Deletes the specified TLSInspectionConfiguration.
deleteTLSInspectionConfigurationRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.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.DescribeFirewallResult describeFirewall(DescribeFirewallRequest describeFirewallRequest)
Returns the data objects for the specified firewall.
describeFirewallRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.DescribeFirewallPolicyResult describeFirewallPolicy(DescribeFirewallPolicyRequest describeFirewallPolicyRequest)
Returns the data objects for the specified firewall policy.
describeFirewallPolicyRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.DescribeLoggingConfigurationResult describeLoggingConfiguration(DescribeLoggingConfigurationRequest describeLoggingConfigurationRequest)
Returns the logging configuration for the specified firewall.
describeLoggingConfigurationRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest describeResourcePolicyRequest)
Retrieves a resource policy that you created in a PutResourcePolicy request.
describeResourcePolicyRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.DescribeRuleGroupResult describeRuleGroup(DescribeRuleGroupRequest describeRuleGroupRequest)
Returns the data objects for the specified rule group.
describeRuleGroupRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.DescribeRuleGroupMetadataResult describeRuleGroupMetadata(DescribeRuleGroupMetadataRequest describeRuleGroupMetadataRequest)
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.
describeRuleGroupMetadataRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.DescribeTLSInspectionConfigurationResult describeTLSInspectionConfiguration(DescribeTLSInspectionConfigurationRequest describeTLSInspectionConfigurationRequest)
Returns the data objects for the specified TLS inspection configuration.
describeTLSInspectionConfigurationRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.DisassociateSubnetsResult disassociateSubnets(DisassociateSubnetsRequest disassociateSubnetsRequest)
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.
disassociateSubnetsRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.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.ListFirewallPoliciesResult listFirewallPolicies(ListFirewallPoliciesRequest listFirewallPoliciesRequest)
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.
listFirewallPoliciesRequest - 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.
ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ListFirewallsResult listFirewalls(ListFirewallsRequest listFirewallsRequest)
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.
listFirewallsRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ThrottlingException - Unable to process the request due to throttling limitations.ListRuleGroupsResult listRuleGroups(ListRuleGroupsRequest listRuleGroupsRequest)
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.
listRuleGroupsRequest - 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.
ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ListTLSInspectionConfigurationsResult listTLSInspectionConfigurations(ListTLSInspectionConfigurationsRequest listTLSInspectionConfigurationsRequest)
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.
listTLSInspectionConfigurationsRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ThrottlingException - Unable to process the request due to throttling limitations.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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 Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
listTagsForResourceRequest - ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.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.
PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the 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 rule group or firewall policy.
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
putResourcePolicyRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidResourcePolicyException - The policy statement failed validation.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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 Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
tagResourceRequest - ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.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.
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
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 Amazon Web Services resource, up to 50 tags for a resource.
You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.
untagResourceRequest - ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.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.
UpdateFirewallDeleteProtectionResult updateFirewallDeleteProtection(UpdateFirewallDeleteProtectionRequest updateFirewallDeleteProtectionRequest)
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.
updateFirewallDeleteProtectionRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.ResourceOwnerCheckException - Unable to change the resource because your account doesn't own it.UpdateFirewallDescriptionResult updateFirewallDescription(UpdateFirewallDescriptionRequest updateFirewallDescriptionRequest)
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
updateFirewallDescriptionRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.UpdateFirewallEncryptionConfigurationResult updateFirewallEncryptionConfiguration(UpdateFirewallEncryptionConfigurationRequest updateFirewallEncryptionConfigurationRequest)
A complex type that contains settings for encryption of your firewall resources.
updateFirewallEncryptionConfigurationRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.ResourceOwnerCheckException - Unable to change the resource because your account doesn't own it.UpdateFirewallPolicyResult updateFirewallPolicy(UpdateFirewallPolicyRequest updateFirewallPolicyRequest)
Updates the properties of the specified firewall policy.
updateFirewallPolicyRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.InvalidTokenException - The token you provided is stale or isn't valid for the operation.UpdateFirewallPolicyChangeProtectionResult updateFirewallPolicyChangeProtection(UpdateFirewallPolicyChangeProtectionRequest updateFirewallPolicyChangeProtectionRequest)
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.
updateFirewallPolicyChangeProtectionRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.ResourceOwnerCheckException - Unable to change the resource because your account doesn't own it.UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest updateLoggingConfigurationRequest)
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration 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.
updateLoggingConfigurationRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.LogDestinationPermissionException - Unable to send logs to a configured logging destination.UpdateRuleGroupResult updateRuleGroup(UpdateRuleGroupRequest updateRuleGroupRequest)
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 to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.
updateRuleGroupRequest - ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.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.
ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.InvalidTokenException - The token you provided is stale or isn't valid for the operation.UpdateSubnetChangeProtectionResult updateSubnetChangeProtection(UpdateSubnetChangeProtectionRequest updateSubnetChangeProtectionRequest)
updateSubnetChangeProtectionRequest - 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.
InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InvalidTokenException - The token you provided is stale or isn't valid for the operation.ResourceOwnerCheckException - Unable to change the resource because your account doesn't own it.UpdateTLSInspectionConfigurationResult updateTLSInspectionConfiguration(UpdateTLSInspectionConfigurationRequest updateTLSInspectionConfigurationRequest)
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 to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.
updateTLSInspectionConfigurationRequest - 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.
ResourceNotFoundException - Unable to locate a resource using the parameters that you provided.ThrottlingException - Unable to process the request due to throttling limitations.InternalServerErrorException - Your request is valid, but Network Firewall couldn't perform the operation because of a system problem.
Retry your request.InvalidTokenException - The token you provided is stale or isn't valid for the operation.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.