Skip to content

Type definitions#

Index > NetworkFirewall > Type definitions

Auto-generated documentation for NetworkFirewall type annotations stubs module mypy-boto3-network-firewall.

AddressTypeDef#

# AddressTypeDef definition

class AddressTypeDef(TypedDict):
    AddressDefinition: str,

AnalysisResultTypeDef#

# AnalysisResultTypeDef definition

class AnalysisResultTypeDef(TypedDict):
    IdentifiedRuleIds: NotRequired[List[str]],
    IdentifiedType: NotRequired[IdentifiedTypeType],  # (1)
    AnalysisDetail: NotRequired[str],
  1. See IdentifiedTypeType

AssociateFirewallPolicyRequestRequestTypeDef#

# AssociateFirewallPolicyRequestRequestTypeDef definition

class AssociateFirewallPolicyRequestRequestTypeDef(TypedDict):
    FirewallPolicyArn: str,
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SubnetMappingTypeDef#

# SubnetMappingTypeDef definition

class SubnetMappingTypeDef(TypedDict):
    SubnetId: str,
    IPAddressType: NotRequired[IPAddressTypeType],  # (1)
  1. See IPAddressTypeType

AttachmentTypeDef#

# AttachmentTypeDef definition

class AttachmentTypeDef(TypedDict):
    SubnetId: NotRequired[str],
    EndpointId: NotRequired[str],
    Status: NotRequired[AttachmentStatusType],  # (1)
    StatusMessage: NotRequired[str],
  1. See AttachmentStatusType

IPSetMetadataTypeDef#

# IPSetMetadataTypeDef definition

class IPSetMetadataTypeDef(TypedDict):
    ResolvedCIDRCount: NotRequired[int],

CheckCertificateRevocationStatusActionsTypeDef#

# CheckCertificateRevocationStatusActionsTypeDef definition

class CheckCertificateRevocationStatusActionsTypeDef(TypedDict):
    RevokedStatusAction: NotRequired[RevocationCheckActionType],  # (1)
    UnknownStatusAction: NotRequired[RevocationCheckActionType],  # (1)
  1. See RevocationCheckActionType
  2. See RevocationCheckActionType

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    Type: EncryptionTypeType,  # (1)
    KeyId: NotRequired[str],
  1. See EncryptionTypeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

SourceMetadataTypeDef#

# SourceMetadataTypeDef definition

class SourceMetadataTypeDef(TypedDict):
    SourceArn: NotRequired[str],
    SourceUpdateToken: NotRequired[str],

DeleteFirewallPolicyRequestRequestTypeDef#

# DeleteFirewallPolicyRequestRequestTypeDef definition

class DeleteFirewallPolicyRequestRequestTypeDef(TypedDict):
    FirewallPolicyName: NotRequired[str],
    FirewallPolicyArn: NotRequired[str],

DeleteFirewallRequestRequestTypeDef#

# DeleteFirewallRequestRequestTypeDef definition

class DeleteFirewallRequestRequestTypeDef(TypedDict):
    FirewallName: NotRequired[str],
    FirewallArn: NotRequired[str],

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeleteRuleGroupRequestRequestTypeDef#

# DeleteRuleGroupRequestRequestTypeDef definition

class DeleteRuleGroupRequestRequestTypeDef(TypedDict):
    RuleGroupName: NotRequired[str],
    RuleGroupArn: NotRequired[str],
    Type: NotRequired[RuleGroupTypeType],  # (1)
  1. See RuleGroupTypeType

DeleteTLSInspectionConfigurationRequestRequestTypeDef#

# DeleteTLSInspectionConfigurationRequestRequestTypeDef definition

class DeleteTLSInspectionConfigurationRequestRequestTypeDef(TypedDict):
    TLSInspectionConfigurationArn: NotRequired[str],
    TLSInspectionConfigurationName: NotRequired[str],

DescribeFirewallPolicyRequestRequestTypeDef#

# DescribeFirewallPolicyRequestRequestTypeDef definition

class DescribeFirewallPolicyRequestRequestTypeDef(TypedDict):
    FirewallPolicyName: NotRequired[str],
    FirewallPolicyArn: NotRequired[str],

DescribeFirewallRequestRequestTypeDef#

# DescribeFirewallRequestRequestTypeDef definition

class DescribeFirewallRequestRequestTypeDef(TypedDict):
    FirewallName: NotRequired[str],
    FirewallArn: NotRequired[str],

DescribeLoggingConfigurationRequestRequestTypeDef#

# DescribeLoggingConfigurationRequestRequestTypeDef definition

class DescribeLoggingConfigurationRequestRequestTypeDef(TypedDict):
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],

DescribeResourcePolicyRequestRequestTypeDef#

# DescribeResourcePolicyRequestRequestTypeDef definition

class DescribeResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DescribeRuleGroupMetadataRequestRequestTypeDef#

# DescribeRuleGroupMetadataRequestRequestTypeDef definition

class DescribeRuleGroupMetadataRequestRequestTypeDef(TypedDict):
    RuleGroupName: NotRequired[str],
    RuleGroupArn: NotRequired[str],
    Type: NotRequired[RuleGroupTypeType],  # (1)
  1. See RuleGroupTypeType

StatefulRuleOptionsTypeDef#

# StatefulRuleOptionsTypeDef definition

class StatefulRuleOptionsTypeDef(TypedDict):
    RuleOrder: NotRequired[RuleOrderType],  # (1)
  1. See RuleOrderType

DescribeRuleGroupRequestRequestTypeDef#

# DescribeRuleGroupRequestRequestTypeDef definition

class DescribeRuleGroupRequestRequestTypeDef(TypedDict):
    RuleGroupName: NotRequired[str],
    RuleGroupArn: NotRequired[str],
    Type: NotRequired[RuleGroupTypeType],  # (1)
    AnalyzeRuleGroup: NotRequired[bool],
  1. See RuleGroupTypeType

DescribeTLSInspectionConfigurationRequestRequestTypeDef#

# DescribeTLSInspectionConfigurationRequestRequestTypeDef definition

class DescribeTLSInspectionConfigurationRequestRequestTypeDef(TypedDict):
    TLSInspectionConfigurationArn: NotRequired[str],
    TLSInspectionConfigurationName: NotRequired[str],

DimensionTypeDef#

# DimensionTypeDef definition

class DimensionTypeDef(TypedDict):
    Value: str,

DisassociateSubnetsRequestRequestTypeDef#

# DisassociateSubnetsRequestRequestTypeDef definition

class DisassociateSubnetsRequestRequestTypeDef(TypedDict):
    SubnetIds: Sequence[str],
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],

FirewallMetadataTypeDef#

# FirewallMetadataTypeDef definition

class FirewallMetadataTypeDef(TypedDict):
    FirewallName: NotRequired[str],
    FirewallArn: NotRequired[str],

FirewallPolicyMetadataTypeDef#

# FirewallPolicyMetadataTypeDef definition

class FirewallPolicyMetadataTypeDef(TypedDict):
    Name: NotRequired[str],
    Arn: NotRequired[str],

StatefulEngineOptionsTypeDef#

# StatefulEngineOptionsTypeDef definition

class StatefulEngineOptionsTypeDef(TypedDict):
    RuleOrder: NotRequired[RuleOrderType],  # (1)
    StreamExceptionPolicy: NotRequired[StreamExceptionPolicyType],  # (2)
  1. See RuleOrderType
  2. See StreamExceptionPolicyType

StatelessRuleGroupReferenceTypeDef#

# StatelessRuleGroupReferenceTypeDef definition

class StatelessRuleGroupReferenceTypeDef(TypedDict):
    ResourceArn: str,
    Priority: int,

HeaderTypeDef#

# HeaderTypeDef definition

class HeaderTypeDef(TypedDict):
    Protocol: StatefulRuleProtocolType,  # (1)
    Source: str,
    SourcePort: str,
    Direction: StatefulRuleDirectionType,  # (2)
    Destination: str,
    DestinationPort: str,
  1. See StatefulRuleProtocolType
  2. See StatefulRuleDirectionType

IPSetReferenceTypeDef#

# IPSetReferenceTypeDef definition

class IPSetReferenceTypeDef(TypedDict):
    ReferenceArn: NotRequired[str],

IPSetTypeDef#

# IPSetTypeDef definition

class IPSetTypeDef(TypedDict):
    Definition: Sequence[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListFirewallPoliciesRequestRequestTypeDef#

# ListFirewallPoliciesRequestRequestTypeDef definition

class ListFirewallPoliciesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListFirewallsRequestRequestTypeDef#

# ListFirewallsRequestRequestTypeDef definition

class ListFirewallsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    VpcIds: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],

ListRuleGroupsRequestRequestTypeDef#

# ListRuleGroupsRequestRequestTypeDef definition

class ListRuleGroupsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Scope: NotRequired[ResourceManagedStatusType],  # (1)
    ManagedType: NotRequired[ResourceManagedTypeType],  # (2)
    Type: NotRequired[RuleGroupTypeType],  # (3)
  1. See ResourceManagedStatusType
  2. See ResourceManagedTypeType
  3. See RuleGroupTypeType

RuleGroupMetadataTypeDef#

# RuleGroupMetadataTypeDef definition

class RuleGroupMetadataTypeDef(TypedDict):
    Name: NotRequired[str],
    Arn: NotRequired[str],

ListTLSInspectionConfigurationsRequestRequestTypeDef#

# ListTLSInspectionConfigurationsRequestRequestTypeDef definition

class ListTLSInspectionConfigurationsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

TLSInspectionConfigurationMetadataTypeDef#

# TLSInspectionConfigurationMetadataTypeDef definition

class TLSInspectionConfigurationMetadataTypeDef(TypedDict):
    Name: NotRequired[str],
    Arn: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

LogDestinationConfigTypeDef#

# LogDestinationConfigTypeDef definition

class LogDestinationConfigTypeDef(TypedDict):
    LogType: LogTypeType,  # (1)
    LogDestinationType: LogDestinationTypeType,  # (2)
    LogDestination: Dict[str, str],
  1. See LogTypeType
  2. See LogDestinationTypeType

PortRangeTypeDef#

# PortRangeTypeDef definition

class PortRangeTypeDef(TypedDict):
    FromPort: int,
    ToPort: int,

TCPFlagFieldTypeDef#

# TCPFlagFieldTypeDef definition

class TCPFlagFieldTypeDef(TypedDict):
    Flags: Sequence[TCPFlagType],  # (1)
    Masks: NotRequired[Sequence[TCPFlagType]],  # (1)
  1. See TCPFlagType
  2. See TCPFlagType

PerObjectStatusTypeDef#

# PerObjectStatusTypeDef definition

class PerObjectStatusTypeDef(TypedDict):
    SyncStatus: NotRequired[PerObjectSyncStatusType],  # (1)
    UpdateToken: NotRequired[str],
  1. See PerObjectSyncStatusType

PortSetTypeDef#

# PortSetTypeDef definition

class PortSetTypeDef(TypedDict):
    Definition: NotRequired[Sequence[str]],

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,

RuleOptionTypeDef#

# RuleOptionTypeDef definition

class RuleOptionTypeDef(TypedDict):
    Keyword: str,
    Settings: NotRequired[Sequence[str]],

RulesSourceListTypeDef#

# RulesSourceListTypeDef definition

class RulesSourceListTypeDef(TypedDict):
    Targets: Sequence[str],
    TargetTypes: Sequence[TargetTypeType],  # (1)
    GeneratedRulesType: GeneratedRulesTypeType,  # (2)
  1. See TargetTypeType
  2. See GeneratedRulesTypeType

ServerCertificateTypeDef#

# ServerCertificateTypeDef definition

class ServerCertificateTypeDef(TypedDict):
    ResourceArn: NotRequired[str],

StatefulRuleGroupOverrideTypeDef#

# StatefulRuleGroupOverrideTypeDef definition

class StatefulRuleGroupOverrideTypeDef(TypedDict):
    Action: NotRequired[OverrideActionType],  # (1)
  1. See OverrideActionType

TlsCertificateDataTypeDef#

# TlsCertificateDataTypeDef definition

class TlsCertificateDataTypeDef(TypedDict):
    CertificateArn: NotRequired[str],
    CertificateSerial: NotRequired[str],
    Status: NotRequired[str],
    StatusMessage: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateFirewallDeleteProtectionRequestRequestTypeDef#

# UpdateFirewallDeleteProtectionRequestRequestTypeDef definition

class UpdateFirewallDeleteProtectionRequestRequestTypeDef(TypedDict):
    DeleteProtection: bool,
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],

UpdateFirewallDescriptionRequestRequestTypeDef#

# UpdateFirewallDescriptionRequestRequestTypeDef definition

class UpdateFirewallDescriptionRequestRequestTypeDef(TypedDict):
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],
    Description: NotRequired[str],

UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef#

# UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef definition

class UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef(TypedDict):
    FirewallPolicyChangeProtection: bool,
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],

UpdateSubnetChangeProtectionRequestRequestTypeDef#

# UpdateSubnetChangeProtectionRequestRequestTypeDef definition

class UpdateSubnetChangeProtectionRequestRequestTypeDef(TypedDict):
    Subnet