AWS Network Firewall 2020-11-12

AssociateFirewallPolicy

$result = $client->associateFirewallPolicy([/* ... */]);
$promise = $client->associateFirewallPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->associateFirewallPolicy([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyArn' => '<string>', // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyArn' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

AssociateSubnets

$result = $client->associateSubnets([/* ... */]);
$promise = $client->associateSubnetsAsync([/* ... */]);

Parameter Syntax

$result = $client->associateSubnets([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetMappings' => [ // REQUIRED
        [
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetMappings' => [
        [
            'SubnetId' => '<string>',
        ],
        // ...
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

CreateFirewall

$result = $client->createFirewall([/* ... */]);
$promise = $client->createFirewallAsync([/* ... */]);

Parameter Syntax

$result = $client->createFirewall([
    'DeleteProtection' => true || false,
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallName' => '<string>', // REQUIRED
    'FirewallPolicyArn' => '<string>', // REQUIRED
    'FirewallPolicyChangeProtection' => true || false,
    'SubnetChangeProtection' => true || false,
    'SubnetMappings' => [ // REQUIRED
        [
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Firewall' => [
        'DeleteProtection' => true || false,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallArn' => '<string>',
        'FirewallId' => '<string>',
        'FirewallName' => '<string>',
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyChangeProtection' => true || false,
        'SubnetChangeProtection' => true || false,
        'SubnetMappings' => [
            [
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
    'FirewallStatus' => [
        'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC',
        'Status' => 'PROVISIONING|DELETING|READY',
        'SyncStates' => [
            '<AvailabilityZone>' => [
                'Attachment' => [
                    'EndpointId' => '<string>',
                    'Status' => 'CREATING|DELETING|SCALING|READY',
                    'SubnetId' => '<string>',
                ],
                'Config' => [
                    '<ResourceName>' => [
                        'SyncStatus' => 'PENDING|IN_SYNC',
                        'UpdateToken' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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

• InternalServerError:

  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.

CreateFirewallPolicy

$result = $client->createFirewallPolicy([/* ... */]);
$promise = $client->createFirewallPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->createFirewallPolicy([
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallPolicy' => [ // REQUIRED
        'StatefulDefaultActions' => ['<string>', ...],
        'StatefulEngineOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
        'StatefulRuleGroupReferences' => [
            [
                'Override' => [
                    'Action' => 'DROP_TO_ALERT',
                ],
                'Priority' => <integer>,
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessCustomActions' => [
            [
                'ActionDefinition' => [ // REQUIRED
                    'PublishMetricAction' => [
                        'Dimensions' => [ // REQUIRED
                            [
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'ActionName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessFragmentDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessRuleGroupReferences' => [
            [
                'Priority' => <integer>, // REQUIRED
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'FirewallPolicyName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

CreateRuleGroup

$result = $client->createRuleGroup([/* ... */]);
$promise = $client->createRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createRuleGroup([
    'Capacity' => <integer>, // REQUIRED
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'RuleGroup' => [
        'RuleVariables' => [
            'IPSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'PortSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'RulesSource' => [ // REQUIRED
            'RulesSourceList' => [
                'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', // REQUIRED
                'TargetTypes' => ['<string>', ...], // REQUIRED
                'Targets' => ['<string>', ...], // REQUIRED
            ],
            'RulesString' => '<string>',
            'StatefulRules' => [
                [
                    'Action' => 'PASS|DROP|ALERT', // REQUIRED
                    'Header' => [ // REQUIRED
                        'Destination' => '<string>', // REQUIRED
                        'DestinationPort' => '<string>', // REQUIRED
                        'Direction' => 'FORWARD|ANY', // REQUIRED
                        'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', // REQUIRED
                        'Source' => '<string>', // REQUIRED
                        'SourcePort' => '<string>', // REQUIRED
                    ],
                    'RuleOptions' => [ // REQUIRED
                        [
                            'Keyword' => '<string>', // REQUIRED
                            'Settings' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'StatelessRulesAndCustomActions' => [
                'CustomActions' => [
                    [
                        'ActionDefinition' => [ // REQUIRED
                            'PublishMetricAction' => [
                                'Dimensions' => [ // REQUIRED
                                    [
                                        'Value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'ActionName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'StatelessRules' => [ // REQUIRED
                    [
                        'Priority' => <integer>, // REQUIRED
                        'RuleDefinition' => [ // REQUIRED
                            'Actions' => ['<string>', ...], // REQUIRED
                            'MatchAttributes' => [ // REQUIRED
                                'DestinationPorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Destinations' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Protocols' => [<integer>, ...],
                                'SourcePorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Sources' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'TCPFlags' => [
                                    [
                                        'Flags' => ['<string>', ...], // REQUIRED
                                        'Masks' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'StatefulRuleOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
    ],
    'RuleGroupName' => '<string>', // REQUIRED
    'Rules' => '<string>',
    'SourceMetadata' => [
        'SourceArn' => '<string>',
        'SourceUpdateToken' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'STATELESS|STATEFUL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleGroupResponse' => [
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

DeleteFirewall

$result = $client->deleteFirewall([/* ... */]);
$promise = $client->deleteFirewallAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteFirewall([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Firewall' => [
        'DeleteProtection' => true || false,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallArn' => '<string>',
        'FirewallId' => '<string>',
        'FirewallName' => '<string>',
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyChangeProtection' => true || false,
        'SubnetChangeProtection' => true || false,
        'SubnetMappings' => [
            [
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
    'FirewallStatus' => [
        'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC',
        'Status' => 'PROVISIONING|DELETING|READY',
        'SyncStates' => [
            '<AvailabilityZone>' => [
                'Attachment' => [
                    'EndpointId' => '<string>',
                    'Status' => 'CREATING|DELETING|SCALING|READY',
                    'SubnetId' => '<string>',
                ],
                'Config' => [
                    '<ResourceName>' => [
                        'SyncStatus' => 'PENDING|IN_SYNC',
                        'UpdateToken' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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

• InternalServerError:

  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.

DeleteFirewallPolicy

$result = $client->deleteFirewallPolicy([/* ... */]);
$promise = $client->deleteFirewallPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteFirewallPolicy([
    'FirewallPolicyArn' => '<string>',
    'FirewallPolicyName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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

• InternalServerError:

  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.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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

• InternalServerError:

  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.

DeleteRuleGroup

$result = $client->deleteRuleGroup([/* ... */]);
$promise = $client->deleteRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRuleGroup([
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'RuleGroupResponse' => [
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
]

Result Details

Errors

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

• InternalServerError:

  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.

DescribeFirewall

$result = $client->describeFirewall([/* ... */]);
$promise = $client->describeFirewallAsync([/* ... */]);

Parameter Syntax

$result = $client->describeFirewall([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Firewall' => [
        'DeleteProtection' => true || false,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallArn' => '<string>',
        'FirewallId' => '<string>',
        'FirewallName' => '<string>',
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyChangeProtection' => true || false,
        'SubnetChangeProtection' => true || false,
        'SubnetMappings' => [
            [
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
    'FirewallStatus' => [
        'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC',
        'Status' => 'PROVISIONING|DELETING|READY',
        'SyncStates' => [
            '<AvailabilityZone>' => [
                'Attachment' => [
                    'EndpointId' => '<string>',
                    'Status' => 'CREATING|DELETING|SCALING|READY',
                    'SubnetId' => '<string>',
                ],
                'Config' => [
                    '<ResourceName>' => [
                        'SyncStatus' => 'PENDING|IN_SYNC',
                        'UpdateToken' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

DescribeFirewallPolicy

$result = $client->describeFirewallPolicy([/* ... */]);
$promise = $client->describeFirewallPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->describeFirewallPolicy([
    'FirewallPolicyArn' => '<string>',
    'FirewallPolicyName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallPolicy' => [
        'StatefulDefaultActions' => ['<string>', ...],
        'StatefulEngineOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
        'StatefulRuleGroupReferences' => [
            [
                'Override' => [
                    'Action' => 'DROP_TO_ALERT',
                ],
                'Priority' => <integer>,
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'StatelessCustomActions' => [
            [
                'ActionDefinition' => [
                    'PublishMetricAction' => [
                        'Dimensions' => [
                            [
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'ActionName' => '<string>',
            ],
            // ...
        ],
        'StatelessDefaultActions' => ['<string>', ...],
        'StatelessFragmentDefaultActions' => ['<string>', ...],
        'StatelessRuleGroupReferences' => [
            [
                'Priority' => <integer>,
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
    ],
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

DescribeLoggingConfiguration

$result = $client->describeLoggingConfiguration([/* ... */]);
$promise = $client->describeLoggingConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLoggingConfiguration([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => [
            [
                'LogDestination' => ['<string>', ...],
                'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose',
                'LogType' => 'ALERT|FLOW',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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

• InternalServerError:

  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.

DescribeResourcePolicy

$result = $client->describeResourcePolicy([/* ... */]);
$promise = $client->describeResourcePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->describeResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

DescribeRuleGroup

$result = $client->describeRuleGroup([/* ... */]);
$promise = $client->describeRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->describeRuleGroup([
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'RuleGroup' => [
        'RuleVariables' => [
            'IPSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
            'PortSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'RulesSource' => [
            'RulesSourceList' => [
                'GeneratedRulesType' => 'ALLOWLIST|DENYLIST',
                'TargetTypes' => ['<string>', ...],
                'Targets' => ['<string>', ...],
            ],
            'RulesString' => '<string>',
            'StatefulRules' => [
                [
                    'Action' => 'PASS|DROP|ALERT',
                    'Header' => [
                        'Destination' => '<string>',
                        'DestinationPort' => '<string>',
                        'Direction' => 'FORWARD|ANY',
                        'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP',
                        'Source' => '<string>',
                        'SourcePort' => '<string>',
                    ],
                    'RuleOptions' => [
                        [
                            'Keyword' => '<string>',
                            'Settings' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'StatelessRulesAndCustomActions' => [
                'CustomActions' => [
                    [
                        'ActionDefinition' => [
                            'PublishMetricAction' => [
                                'Dimensions' => [
                                    [
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'ActionName' => '<string>',
                    ],
                    // ...
                ],
                'StatelessRules' => [
                    [
                        'Priority' => <integer>,
                        'RuleDefinition' => [
                            'Actions' => ['<string>', ...],
                            'MatchAttributes' => [
                                'DestinationPorts' => [
                                    [
                                        'FromPort' => <integer>,
                                        'ToPort' => <integer>,
                                    ],
                                    // ...
                                ],
                                'Destinations' => [
                                    [
                                        'AddressDefinition' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Protocols' => [<integer>, ...],
                                'SourcePorts' => [
                                    [
                                        'FromPort' => <integer>,
                                        'ToPort' => <integer>,
                                    ],
                                    // ...
                                ],
                                'Sources' => [
                                    [
                                        'AddressDefinition' => '<string>',
                                    ],
                                    // ...
                                ],
                                'TCPFlags' => [
                                    [
                                        'Flags' => ['<string>', ...],
                                        'Masks' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'StatefulRuleOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
    ],
    'RuleGroupResponse' => [
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

DescribeRuleGroupMetadata

$result = $client->describeRuleGroupMetadata([/* ... */]);
$promise = $client->describeRuleGroupMetadataAsync([/* ... */]);

Parameter Syntax

$result = $client->describeRuleGroupMetadata([
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'Capacity' => <integer>,
    'Description' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'StatefulRuleOptions' => [
        'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
    ],
    'Type' => 'STATELESS|STATEFUL',
]

Result Details

Errors

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

• InternalServerError:

  Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

DisassociateSubnets

$result = $client->disassociateSubnets([/* ... */]);
$promise = $client->disassociateSubnetsAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateSubnets([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetMappings' => [
        [
            'SubnetId' => '<string>',
        ],
        // ...
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

ListFirewallPolicies

$result = $client->listFirewallPolicies([/* ... */]);
$promise = $client->listFirewallPoliciesAsync([/* ... */]);

Parameter Syntax

$result = $client->listFirewallPolicies([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallPolicies' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

ListFirewalls

$result = $client->listFirewalls([/* ... */]);
$promise = $client->listFirewallsAsync([/* ... */]);

Parameter Syntax

$result = $client->listFirewalls([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'VpcIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Firewalls' => [
        [
            'FirewallArn' => '<string>',
            'FirewallName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

ListRuleGroups

$result = $client->listRuleGroups([/* ... */]);
$promise = $client->listRuleGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->listRuleGroups([
    'ManagedType' => 'AWS_MANAGED_THREAT_SIGNATURES|AWS_MANAGED_DOMAIN_LISTS',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Scope' => 'MANAGED|ACCOUNT',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RuleGroups' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

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

• InternalServerError:

  Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ThrottlingException:

  Unable to process the request due to throttling limitations.

• InternalServerError:

  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.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

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

• InternalServerError:

  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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ThrottlingException:

  Unable to process the request due to throttling limitations.

• InternalServerError:

  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.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ThrottlingException:

  Unable to process the request due to throttling limitations.

• InternalServerError:

  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.

UpdateFirewallDeleteProtection

$result = $client->updateFirewallDeleteProtection([/* ... */]);
$promise = $client->updateFirewallDeleteProtectionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFirewallDeleteProtection([
    'DeleteProtection' => true || false, // REQUIRED
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DeleteProtection' => true || false,
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateFirewallDescription

$result = $client->updateFirewallDescription([/* ... */]);
$promise = $client->updateFirewallDescriptionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFirewallDescription([
    'Description' => '<string>',
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateFirewallEncryptionConfiguration

$result = $client->updateFirewallEncryptionConfiguration([/* ... */]);
$promise = $client->updateFirewallEncryptionConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFirewallEncryptionConfiguration([
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
    ],
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateFirewallPolicy

$result = $client->updateFirewallPolicy([/* ... */]);
$promise = $client->updateFirewallPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFirewallPolicy([
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallPolicy' => [ // REQUIRED
        'StatefulDefaultActions' => ['<string>', ...],
        'StatefulEngineOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
        'StatefulRuleGroupReferences' => [
            [
                'Override' => [
                    'Action' => 'DROP_TO_ALERT',
                ],
                'Priority' => <integer>,
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessCustomActions' => [
            [
                'ActionDefinition' => [ // REQUIRED
                    'PublishMetricAction' => [
                        'Dimensions' => [ // REQUIRED
                            [
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'ActionName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessFragmentDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessRuleGroupReferences' => [
            [
                'Priority' => <integer>, // REQUIRED
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'FirewallPolicyArn' => '<string>',
    'FirewallPolicyName' => '<string>',
    'UpdateToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateFirewallPolicyChangeProtection

$result = $client->updateFirewallPolicyChangeProtection([/* ... */]);
$promise = $client->updateFirewallPolicyChangeProtectionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateFirewallPolicyChangeProtection([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyChangeProtection' => true || false, // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyChangeProtection' => true || false,
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateLoggingConfiguration

$result = $client->updateLoggingConfiguration([/* ... */]);
$promise = $client->updateLoggingConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->updateLoggingConfiguration([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => [ // REQUIRED
            [
                'LogDestination' => ['<string>', ...], // REQUIRED
                'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose', // REQUIRED
                'LogType' => 'ALERT|FLOW', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => [
            [
                'LogDestination' => ['<string>', ...],
                'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose',
                'LogType' => 'ALERT|FLOW',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateRuleGroup

$result = $client->updateRuleGroup([/* ... */]);
$promise = $client->updateRuleGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->updateRuleGroup([
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'RuleGroup' => [
        'RuleVariables' => [
            'IPSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'PortSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'RulesSource' => [ // REQUIRED
            'RulesSourceList' => [
                'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', // REQUIRED
                'TargetTypes' => ['<string>', ...], // REQUIRED
                'Targets' => ['<string>', ...], // REQUIRED
            ],
            'RulesString' => '<string>',
            'StatefulRules' => [
                [
                    'Action' => 'PASS|DROP|ALERT', // REQUIRED
                    'Header' => [ // REQUIRED
                        'Destination' => '<string>', // REQUIRED
                        'DestinationPort' => '<string>', // REQUIRED
                        'Direction' => 'FORWARD|ANY', // REQUIRED
                        'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', // REQUIRED
                        'Source' => '<string>', // REQUIRED
                        'SourcePort' => '<string>', // REQUIRED
                    ],
                    'RuleOptions' => [ // REQUIRED
                        [
                            'Keyword' => '<string>', // REQUIRED
                            'Settings' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'StatelessRulesAndCustomActions' => [
                'CustomActions' => [
                    [
                        'ActionDefinition' => [ // REQUIRED
                            'PublishMetricAction' => [
                                'Dimensions' => [ // REQUIRED
                                    [
                                        'Value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'ActionName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'StatelessRules' => [ // REQUIRED
                    [
                        'Priority' => <integer>, // REQUIRED
                        'RuleDefinition' => [ // REQUIRED
                            'Actions' => ['<string>', ...], // REQUIRED
                            'MatchAttributes' => [ // REQUIRED
                                'DestinationPorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Destinations' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Protocols' => [<integer>, ...],
                                'SourcePorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Sources' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'TCPFlags' => [
                                    [
                                        'Flags' => ['<string>', ...], // REQUIRED
                                        'Masks' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'StatefulRuleOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
    ],
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Rules' => '<string>',
    'SourceMetadata' => [
        'SourceArn' => '<string>',
        'SourceUpdateToken' => '<string>',
    ],
    'Type' => 'STATELESS|STATEFUL',
    'UpdateToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleGroupResponse' => [
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

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

• InternalServerError:

  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.

UpdateSubnetChangeProtection

$result = $client->updateSubnetChangeProtection([/* ... */]);
$promise = $client->updateSubnetChangeProtectionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateSubnetChangeProtection([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetChangeProtection' => true || false, // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details