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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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):
    SubnetChangeProtection: bool,
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],

AssociateFirewallPolicyResponseTypeDef#

# AssociateFirewallPolicyResponseTypeDef definition

class AssociateFirewallPolicyResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    FirewallPolicyArn: str,
    UpdateToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeResourcePolicyResponseTypeDef#

# DescribeResourcePolicyResponseTypeDef definition

class DescribeResourcePolicyResponseTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateFirewallDeleteProtectionResponseTypeDef#

# UpdateFirewallDeleteProtectionResponseTypeDef definition

class UpdateFirewallDeleteProtectionResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    DeleteProtection: bool,
    UpdateToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateFirewallDescriptionResponseTypeDef#

# UpdateFirewallDescriptionResponseTypeDef definition

class UpdateFirewallDescriptionResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    Description: str,
    UpdateToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateFirewallPolicyChangeProtectionResponseTypeDef#

# UpdateFirewallPolicyChangeProtectionResponseTypeDef definition

class UpdateFirewallPolicyChangeProtectionResponseTypeDef(TypedDict):
    UpdateToken: str,
    FirewallArn: str,
    FirewallName: str,
    FirewallPolicyChangeProtection: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSubnetChangeProtectionResponseTypeDef#

# UpdateSubnetChangeProtectionResponseTypeDef definition

class UpdateSubnetChangeProtectionResponseTypeDef(TypedDict):
    UpdateToken: str,
    FirewallArn: str,
    FirewallName: str,
    SubnetChangeProtection: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AssociateSubnetsRequestRequestTypeDef#

# AssociateSubnetsRequestRequestTypeDef definition

class AssociateSubnetsRequestRequestTypeDef(TypedDict):
    SubnetMappings: Sequence[SubnetMappingTypeDef],  # (1)
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],
  1. See SubnetMappingTypeDef

AssociateSubnetsResponseTypeDef#

# AssociateSubnetsResponseTypeDef definition

class AssociateSubnetsResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    SubnetMappings: List[SubnetMappingTypeDef],  # (1)
    UpdateToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubnetMappingTypeDef
  2. See ResponseMetadataTypeDef

DisassociateSubnetsResponseTypeDef#

# DisassociateSubnetsResponseTypeDef definition

class DisassociateSubnetsResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    SubnetMappings: List[SubnetMappingTypeDef],  # (1)
    UpdateToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubnetMappingTypeDef
  2. See ResponseMetadataTypeDef

CIDRSummaryTypeDef#

# CIDRSummaryTypeDef definition

class CIDRSummaryTypeDef(TypedDict):
    AvailableCIDRCount: NotRequired[int],
    UtilizedCIDRCount: NotRequired[int],
    IPSetReferences: NotRequired[Dict[str, IPSetMetadataTypeDef]],  # (1)
  1. See IPSetMetadataTypeDef

UpdateFirewallEncryptionConfigurationRequestRequestTypeDef#

# UpdateFirewallEncryptionConfigurationRequestRequestTypeDef definition

class UpdateFirewallEncryptionConfigurationRequestRequestTypeDef(TypedDict):
    UpdateToken: NotRequired[str],
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (1)
  1. See EncryptionConfigurationTypeDef

UpdateFirewallEncryptionConfigurationResponseTypeDef#

# UpdateFirewallEncryptionConfigurationResponseTypeDef definition

class UpdateFirewallEncryptionConfigurationResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    UpdateToken: str,
    EncryptionConfiguration: EncryptionConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncryptionConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateFirewallRequestRequestTypeDef#

# CreateFirewallRequestRequestTypeDef definition

class CreateFirewallRequestRequestTypeDef(TypedDict):
    FirewallName: str,
    FirewallPolicyArn: str,
    VpcId: str,
    SubnetMappings: Sequence[SubnetMappingTypeDef],  # (1)
    DeleteProtection: NotRequired[bool],
    SubnetChangeProtection: NotRequired[bool],
    FirewallPolicyChangeProtection: NotRequired[bool],
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
  1. See SubnetMappingTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef

FirewallPolicyResponseTypeDef#

# FirewallPolicyResponseTypeDef definition

class FirewallPolicyResponseTypeDef(TypedDict):
    FirewallPolicyName: str,
    FirewallPolicyArn: str,
    FirewallPolicyId: str,
    Description: NotRequired[str],
    FirewallPolicyStatus: NotRequired[ResourceStatusType],  # (1)
    Tags: NotRequired[List[TagTypeDef]],  # (2)
    ConsumedStatelessRuleCapacity: NotRequired[int],
    ConsumedStatefulRuleCapacity: NotRequired[int],
    NumberOfAssociations: NotRequired[int],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    LastModifiedTime: NotRequired[datetime],
  1. See ResourceStatusType
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef

FirewallTypeDef#

# FirewallTypeDef definition

class FirewallTypeDef(TypedDict):
    FirewallPolicyArn: str,
    VpcId: str,
    SubnetMappings: List[SubnetMappingTypeDef],  # (1)
    FirewallId: str,
    FirewallName: NotRequired[str],
    FirewallArn: NotRequired[str],
    DeleteProtection: NotRequired[bool],
    SubnetChangeProtection: NotRequired[bool],
    FirewallPolicyChangeProtection: NotRequired[bool],
    Description: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
  1. See SubnetMappingTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    NextToken: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

RuleGroupResponseTypeDef#

# RuleGroupResponseTypeDef definition

class RuleGroupResponseTypeDef(TypedDict):
    RuleGroupArn: str,
    RuleGroupName: str,
    RuleGroupId: str,
    Description: NotRequired[str],
    Type: NotRequired[RuleGroupTypeType],  # (1)
    Capacity: NotRequired[int],
    RuleGroupStatus: NotRequired[ResourceStatusType],  # (2)
    Tags: NotRequired[List[TagTypeDef]],  # (3)
    ConsumedCapacity: NotRequired[int],
    NumberOfAssociations: NotRequired[int],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (4)
    SourceMetadata: NotRequired[SourceMetadataTypeDef],  # (5)
    SnsTopic: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],
    AnalysisResults: NotRequired[List[AnalysisResultTypeDef]],  # (6)
  1. See RuleGroupTypeType
  2. See ResourceStatusType
  3. See TagTypeDef
  4. See EncryptionConfigurationTypeDef
  5. See SourceMetadataTypeDef
  6. See AnalysisResultTypeDef

DescribeRuleGroupMetadataResponseTypeDef#

# DescribeRuleGroupMetadataResponseTypeDef definition

class DescribeRuleGroupMetadataResponseTypeDef(TypedDict):
    RuleGroupArn: str,
    RuleGroupName: str,
    Description: str,
    Type: RuleGroupTypeType,  # (1)
    Capacity: int,
    StatefulRuleOptions: StatefulRuleOptionsTypeDef,  # (2)
    LastModifiedTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RuleGroupTypeType
  2. See StatefulRuleOptionsTypeDef
  3. See ResponseMetadataTypeDef

PublishMetricActionTypeDef#

# PublishMetricActionTypeDef definition

class PublishMetricActionTypeDef(TypedDict):
    Dimensions: Sequence[DimensionTypeDef],  # (1)
  1. See DimensionTypeDef

ListFirewallsResponseTypeDef#

# ListFirewallsResponseTypeDef definition

class ListFirewallsResponseTypeDef(TypedDict):
    NextToken: str,
    Firewalls: List[FirewallMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FirewallMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListFirewallPoliciesResponseTypeDef#

# ListFirewallPoliciesResponseTypeDef definition

class ListFirewallPoliciesResponseTypeDef(TypedDict):
    NextToken: str,
    FirewallPolicies: List[FirewallPolicyMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FirewallPolicyMetadataTypeDef
  2. See ResponseMetadataTypeDef

ReferenceSetsTypeDef#

# ReferenceSetsTypeDef definition

class ReferenceSetsTypeDef(TypedDict):
    IPSetReferences: NotRequired[Mapping[str, IPSetReferenceTypeDef]],  # (1)
  1. See IPSetReferenceTypeDef

PolicyVariablesTypeDef#

# PolicyVariablesTypeDef definition

class PolicyVariablesTypeDef(TypedDict):
    RuleVariables: NotRequired[Mapping[str, IPSetTypeDef]],  # (1)
  1. See IPSetTypeDef

ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef#

# ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef definition

class ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFirewallsRequestListFirewallsPaginateTypeDef#

# ListFirewallsRequestListFirewallsPaginateTypeDef definition

class ListFirewallsRequestListFirewallsPaginateTypeDef(TypedDict):
    VpcIds: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRuleGroupsRequestListRuleGroupsPaginateTypeDef#

# ListRuleGroupsRequestListRuleGroupsPaginateTypeDef definition

class ListRuleGroupsRequestListRuleGroupsPaginateTypeDef(TypedDict):
    Scope: NotRequired[ResourceManagedStatusType],  # (1)
    ManagedType: NotRequired[ResourceManagedTypeType],  # (2)
    Type: NotRequired[RuleGroupTypeType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ResourceManagedStatusType
  2. See ResourceManagedTypeType
  3. See RuleGroupTypeType
  4. See PaginatorConfigTypeDef

ListTLSInspectionConfigurationsRequestListTLSInspectionConfigurationsPaginateTypeDef#

# ListTLSInspectionConfigurationsRequestListTLSInspectionConfigurationsPaginateTypeDef definition

class ListTLSInspectionConfigurationsRequestListTLSInspectionConfigurationsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#

# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRuleGroupsResponseTypeDef#

# ListRuleGroupsResponseTypeDef definition

class ListRuleGroupsResponseTypeDef(TypedDict):
    NextToken: str,
    RuleGroups: List[RuleGroupMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListTLSInspectionConfigurationsResponseTypeDef#

# ListTLSInspectionConfigurationsResponseTypeDef definition

class ListTLSInspectionConfigurationsResponseTypeDef(TypedDict):
    NextToken: str,
    TLSInspectionConfigurations: List[TLSInspectionConfigurationMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TLSInspectionConfigurationMetadataTypeDef
  2. See ResponseMetadataTypeDef

LoggingConfigurationTypeDef#

# LoggingConfigurationTypeDef definition

class LoggingConfigurationTypeDef(TypedDict):
    LogDestinationConfigs: List[LogDestinationConfigTypeDef],  # (1)
  1. See LogDestinationConfigTypeDef

ServerCertificateScopeTypeDef#

# ServerCertificateScopeTypeDef definition

class ServerCertificateScopeTypeDef(TypedDict):
    Sources: NotRequired[Sequence[AddressTypeDef]],  # (1)
    Destinations: NotRequired[Sequence[AddressTypeDef]],  # (1)
    SourcePorts: NotRequired[Sequence[PortRangeTypeDef]],  # (3)
    DestinationPorts: NotRequired[Sequence[PortRangeTypeDef]],  # (3)
    Protocols: NotRequired[Sequence[int]],
  1. See AddressTypeDef
  2. See AddressTypeDef
  3. See PortRangeTypeDef
  4. See PortRangeTypeDef

MatchAttributesTypeDef#

# MatchAttributesTypeDef definition

class MatchAttributesTypeDef(TypedDict):
    Sources: NotRequired[Sequence[AddressTypeDef]],  # (1)
    Destinations: NotRequired[Sequence[AddressTypeDef]],  # (1)
    SourcePorts: NotRequired[Sequence[PortRangeTypeDef]],  # (3)
    DestinationPorts: NotRequired[Sequence[PortRangeTypeDef]],  # (3)
    Protocols: NotRequired[Sequence[int]],
    TCPFlags: NotRequired[Sequence[TCPFlagFieldTypeDef]],  # (5)
  1. See AddressTypeDef
  2. See AddressTypeDef
  3. See PortRangeTypeDef
  4. See PortRangeTypeDef
  5. See TCPFlagFieldTypeDef

SyncStateTypeDef#

# SyncStateTypeDef definition

class SyncStateTypeDef(TypedDict):
    Attachment: NotRequired[AttachmentTypeDef],  # (1)
    Config: NotRequired[Dict[str, PerObjectStatusTypeDef]],  # (2)
  1. See AttachmentTypeDef
  2. See PerObjectStatusTypeDef

RuleVariablesTypeDef#

# RuleVariablesTypeDef definition

class RuleVariablesTypeDef(TypedDict):
    IPSets: NotRequired[Mapping[str, IPSetTypeDef]],  # (1)
    PortSets: NotRequired[Mapping[str, PortSetTypeDef]],  # (2)
  1. See IPSetTypeDef
  2. See PortSetTypeDef

StatefulRuleTypeDef#

# StatefulRuleTypeDef definition

class StatefulRuleTypeDef(TypedDict):
    Action: StatefulActionType,  # (1)
    Header: HeaderTypeDef,  # (2)
    RuleOptions: Sequence[RuleOptionTypeDef],  # (3)
  1. See StatefulActionType
  2. See HeaderTypeDef
  3. See RuleOptionTypeDef

StatefulRuleGroupReferenceTypeDef#

# StatefulRuleGroupReferenceTypeDef definition

class StatefulRuleGroupReferenceTypeDef(TypedDict):
    ResourceArn: str,
    Priority: NotRequired[int],
    Override: NotRequired[StatefulRuleGroupOverrideTypeDef],  # (1)
  1. See StatefulRuleGroupOverrideTypeDef

TLSInspectionConfigurationResponseTypeDef#

# TLSInspectionConfigurationResponseTypeDef definition

class TLSInspectionConfigurationResponseTypeDef(TypedDict):
    TLSInspectionConfigurationArn: str,
    TLSInspectionConfigurationName: str,
    TLSInspectionConfigurationId: str,
    TLSInspectionConfigurationStatus: NotRequired[ResourceStatusType],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (2)
    LastModifiedTime: NotRequired[datetime],
    NumberOfAssociations: NotRequired[int],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    Certificates: NotRequired[List[TlsCertificateDataTypeDef]],  # (4)
    CertificateAuthority: NotRequired[TlsCertificateDataTypeDef],  # (5)
  1. See ResourceStatusType
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef
  4. See TlsCertificateDataTypeDef
  5. See TlsCertificateDataTypeDef

CapacityUsageSummaryTypeDef#

# CapacityUsageSummaryTypeDef definition

class CapacityUsageSummaryTypeDef(TypedDict):
    CIDRs: NotRequired[CIDRSummaryTypeDef],  # (1)
  1. See CIDRSummaryTypeDef

CreateFirewallPolicyResponseTypeDef#

# CreateFirewallPolicyResponseTypeDef definition

class CreateFirewallPolicyResponseTypeDef(TypedDict):
    UpdateToken: str,
    FirewallPolicyResponse: FirewallPolicyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FirewallPolicyResponseTypeDef
  2. See ResponseMetadataTypeDef

DeleteFirewallPolicyResponseTypeDef#

# DeleteFirewallPolicyResponseTypeDef definition

class DeleteFirewallPolicyResponseTypeDef(TypedDict):
    FirewallPolicyResponse: FirewallPolicyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FirewallPolicyResponseTypeDef
  2. See ResponseMetadataTypeDef

UpdateFirewallPolicyResponseTypeDef#

# UpdateFirewallPolicyResponseTypeDef definition

class UpdateFirewallPolicyResponseTypeDef(TypedDict):
    UpdateToken: str,
    FirewallPolicyResponse: FirewallPolicyResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FirewallPolicyResponseTypeDef
  2. See ResponseMetadataTypeDef

CreateRuleGroupResponseTypeDef#

# CreateRuleGroupResponseTypeDef definition

class CreateRuleGroupResponseTypeDef(TypedDict):
    UpdateToken: str,
    RuleGroupResponse: RuleGroupResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupResponseTypeDef
  2. See ResponseMetadataTypeDef

DeleteRuleGroupResponseTypeDef#

# DeleteRuleGroupResponseTypeDef definition

class DeleteRuleGroupResponseTypeDef(TypedDict):
    RuleGroupResponse: RuleGroupResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupResponseTypeDef
  2. See ResponseMetadataTypeDef

UpdateRuleGroupResponseTypeDef#

# UpdateRuleGroupResponseTypeDef definition

class UpdateRuleGroupResponseTypeDef(TypedDict):
    UpdateToken: str,
    RuleGroupResponse: RuleGroupResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleGroupResponseTypeDef
  2. See ResponseMetadataTypeDef

ActionDefinitionTypeDef#

# ActionDefinitionTypeDef definition

class ActionDefinitionTypeDef(TypedDict):
    PublishMetricAction: NotRequired[PublishMetricActionTypeDef],  # (1)
  1. See PublishMetricActionTypeDef

DescribeLoggingConfigurationResponseTypeDef#

# DescribeLoggingConfigurationResponseTypeDef definition

class DescribeLoggingConfigurationResponseTypeDef(TypedDict):
    FirewallArn: str,
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateLoggingConfigurationRequestRequestTypeDef#

# UpdateLoggingConfigurationRequestRequestTypeDef definition

class UpdateLoggingConfigurationRequestRequestTypeDef(TypedDict):
    FirewallArn: NotRequired[str],
    FirewallName: NotRequired[str],
    LoggingConfiguration: NotRequired[LoggingConfigurationTypeDef],  # (1)
  1. See LoggingConfigurationTypeDef

UpdateLoggingConfigurationResponseTypeDef#

# UpdateLoggingConfigurationResponseTypeDef definition

class UpdateLoggingConfigurationResponseTypeDef(TypedDict):
    FirewallArn: str,
    FirewallName: str,
    LoggingConfiguration: LoggingConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

ServerCertificateConfigurationTypeDef#

# ServerCertificateConfigurationTypeDef definition

class ServerCertificateConfigurationTypeDef(TypedDict):
    ServerCertificates: NotRequired[Sequence[ServerCertificateTypeDef]],  # (1)
    Scopes: NotRequired[Sequence[ServerCertificateScopeTypeDef]],  # (2)
    CertificateAuthorityArn: NotRequired[str],
    CheckCertificateRevocationStatus: NotRequired[CheckCertificateRevocationStatusActionsTypeDef],  # (3)
  1. See ServerCertificateTypeDef
  2. See ServerCertificateScopeTypeDef
  3. See CheckCertificateRevocationStatusActionsTypeDef

RuleDefinitionTypeDef#

# RuleDefinitionTypeDef definition

class RuleDefinitionTypeDef(TypedDict):
    MatchAttributes: MatchAttributesTypeDef,  # (1)
    Actions: Sequence[str],
  1. See MatchAttributesTypeDef

CreateTLSInspectionConfigurationResponseTypeDef#

# CreateTLSInspectionConfigurationResponseTypeDef definition

class CreateTLSInspectionConfigurationResponseTypeDef(TypedDict):
    UpdateToken: str,
    TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TLSInspectionConfigurationResponseTypeDef
  2. See ResponseMetadataTypeDef

DeleteTLSInspectionConfigurationResponseTypeDef#

# DeleteTLSInspectionConfigurationResponseTypeDef definition

class DeleteTLSInspectionConfigurationResponseTypeDef(TypedDict):
    TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TLSInspectionConfigurationResponseTypeDef
  2. See ResponseMetadataTypeDef

UpdateTLSInspectionConfigurationResponseTypeDef#

# UpdateTLSInspectionConfigurationResponseTypeDef definition

class UpdateTLSInspectionConfigurationResponseTypeDef(TypedDict):
    UpdateToken: str,
    TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TLSInspectionConfigurationResponseTypeDef
  2. See ResponseMetadataTypeDef

FirewallStatusTypeDef#

# FirewallStatusTypeDef definition

class FirewallStatusTypeDef(TypedDict):
    Status: FirewallStatusValueType,  # (1)
    ConfigurationSyncStateSummary: ConfigurationSyncStateType,  # (2)
    SyncStates: NotRequired[Dict[str, SyncStateTypeDef]],  # (3)
    CapacityUsageSummary: NotRequired[CapacityUsageSummaryTypeDef],  # (4)
  1. See FirewallStatusValueType
  2. See ConfigurationSyncStateType
  3. See SyncStateTypeDef
  4. See CapacityUsageSummaryTypeDef

CustomActionTypeDef#

# CustomActionTypeDef definition

class CustomActionTypeDef(TypedDict):
    ActionName: str,
    ActionDefinition: ActionDefinitionTypeDef,  # (1)
  1. See ActionDefinitionTypeDef

TLSInspectionConfigurationTypeDef#

# TLSInspectionConfigurationTypeDef definition

class TLSInspectionConfigurationTypeDef(TypedDict):
    ServerCertificateConfigurations: NotRequired[Sequence[ServerCertificateConfigurationTypeDef]],  # (1)
  1. See ServerCertificateConfigurationTypeDef

StatelessRuleTypeDef#

# StatelessRuleTypeDef definition

class StatelessRuleTypeDef(TypedDict):
    RuleDefinition: RuleDefinitionTypeDef,  # (1)
    Priority: int,
  1. See RuleDefinitionTypeDef

CreateFirewallResponseTypeDef#

# CreateFirewallResponseTypeDef definition

class CreateFirewallResponseTypeDef(TypedDict):
    Firewall: FirewallTypeDef,  # (1)
    FirewallStatus: FirewallStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FirewallTypeDef
  2. See FirewallStatusTypeDef
  3. See ResponseMetadataTypeDef

DeleteFirewallResponseTypeDef#

# DeleteFirewallResponseTypeDef definition

class DeleteFirewallResponseTypeDef(TypedDict):
    Firewall: FirewallTypeDef,  # (1)
    FirewallStatus: FirewallStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FirewallTypeDef
  2. See FirewallStatusTypeDef
  3. See ResponseMetadataTypeDef

DescribeFirewallResponseTypeDef#

# DescribeFirewallResponseTypeDef definition

class DescribeFirewallResponseTypeDef(TypedDict):
    UpdateToken: str,
    Firewall: FirewallTypeDef,  # (1)
    FirewallStatus: FirewallStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FirewallTypeDef
  2. See FirewallStatusTypeDef
  3. See ResponseMetadataTypeDef

FirewallPolicyTypeDef#

# FirewallPolicyTypeDef definition

class FirewallPolicyTypeDef(TypedDict):
    StatelessDefaultActions: Sequence[str],
    StatelessFragmentDefaultActions: Sequence[str],
    StatelessRuleGroupReferences: NotRequired[Sequence[StatelessRuleGroupReferenceTypeDef]],  # (1)
    StatelessCustomActions: NotRequired[Sequence[CustomActionTypeDef]],  # (2)
    StatefulRuleGroupReferences: NotRequired[Sequence[StatefulRuleGroupReferenceTypeDef]],  # (3)
    StatefulDefaultActions: NotRequired[Sequence[str]],
    StatefulEngineOptions: NotRequired[StatefulEngineOptionsTypeDef],  # (4)
    TLSInspectionConfigurationArn: NotRequired[str],
    PolicyVariables: NotRequired[PolicyVariablesTypeDef],  # (5)
  1. See StatelessRuleGroupReferenceTypeDef
  2. See CustomActionTypeDef
  3. See StatefulRuleGroupReferenceTypeDef
  4. See StatefulEngineOptionsTypeDef
  5. See PolicyVariablesTypeDef

CreateTLSInspectionConfigurationRequestRequestTypeDef#

# CreateTLSInspectionConfigurationRequestRequestTypeDef definition

class CreateTLSInspectionConfigurationRequestRequestTypeDef(TypedDict):
    TLSInspectionConfigurationName: str,
    TLSInspectionConfiguration: TLSInspectionConfigurationTypeDef,  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
  1. See TLSInspectionConfigurationTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef

DescribeTLSInspectionConfigurationResponseTypeDef#

# DescribeTLSInspectionConfigurationResponseTypeDef definition

class DescribeTLSInspectionConfigurationResponseTypeDef(TypedDict):
    UpdateToken: str,
    TLSInspectionConfiguration: TLSInspectionConfigurationTypeDef,  # (1)
    TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TLSInspectionConfigurationTypeDef
  2. See TLSInspectionConfigurationResponseTypeDef
  3. See ResponseMetadataTypeDef

UpdateTLSInspectionConfigurationRequestRequestTypeDef#

# UpdateTLSInspectionConfigurationRequestRequestTypeDef definition

class UpdateTLSInspectionConfigurationRequestRequestTypeDef(TypedDict):
    TLSInspectionConfiguration: TLSInspectionConfigurationTypeDef,  # (1)
    UpdateToken: str,
    TLSInspectionConfigurationArn: NotRequired[str],
    TLSInspectionConfigurationName: NotRequired[str],
    Description: NotRequired[str],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (2)
  1. See TLSInspectionConfigurationTypeDef
  2. See EncryptionConfigurationTypeDef

StatelessRulesAndCustomActionsTypeDef#

# StatelessRulesAndCustomActionsTypeDef definition

class StatelessRulesAndCustomActionsTypeDef(TypedDict):
    StatelessRules: Sequence[StatelessRuleTypeDef],  # (1)
    CustomActions: NotRequired[Sequence[CustomActionTypeDef]],  # (2)
  1. See StatelessRuleTypeDef
  2. See CustomActionTypeDef

CreateFirewallPolicyRequestRequestTypeDef#

# CreateFirewallPolicyRequestRequestTypeDef definition

class CreateFirewallPolicyRequestRequestTypeDef(TypedDict):
    FirewallPolicyName: str,
    FirewallPolicy: FirewallPolicyTypeDef,  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    DryRun: NotRequired[bool],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
  1. See FirewallPolicyTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef

DescribeFirewallPolicyResponseTypeDef#

# DescribeFirewallPolicyResponseTypeDef definition

class DescribeFirewallPolicyResponseTypeDef(TypedDict):
    UpdateToken: str,
    FirewallPolicyResponse: FirewallPolicyResponseTypeDef,  # (1)
    FirewallPolicy: FirewallPolicyTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FirewallPolicyResponseTypeDef
  2. See FirewallPolicyTypeDef
  3. See ResponseMetadataTypeDef

UpdateFirewallPolicyRequestRequestTypeDef#

# UpdateFirewallPolicyRequestRequestTypeDef definition

class UpdateFirewallPolicyRequestRequestTypeDef(TypedDict):
    UpdateToken: str,
    FirewallPolicy: FirewallPolicyTypeDef,  # (1)
    FirewallPolicyArn: NotRequired[str],
    FirewallPolicyName: NotRequired[str],
    Description: NotRequired[str],
    DryRun: NotRequired[bool],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (2)
  1. See FirewallPolicyTypeDef
  2. See EncryptionConfigurationTypeDef

RulesSourceTypeDef#

# RulesSourceTypeDef definition

class RulesSourceTypeDef(TypedDict):
    RulesString: NotRequired[str],
    RulesSourceList: NotRequired[RulesSourceListTypeDef],  # (1)
    StatefulRules: NotRequired[Sequence[StatefulRuleTypeDef]],  # (2)
    StatelessRulesAndCustomActions: NotRequired[StatelessRulesAndCustomActionsTypeDef],  # (3)
  1. See RulesSourceListTypeDef
  2. See StatefulRuleTypeDef
  3. See StatelessRulesAndCustomActionsTypeDef

RuleGroupTypeDef#

# RuleGroupTypeDef definition

class RuleGroupTypeDef(TypedDict):
    RulesSource: RulesSourceTypeDef,  # (3)
    RuleVariables: NotRequired[RuleVariablesTypeDef],  # (1)
    ReferenceSets: NotRequired[ReferenceSetsTypeDef],  # (2)
    StatefulRuleOptions: NotRequired[StatefulRuleOptionsTypeDef],  # (4)
  1. See RuleVariablesTypeDef
  2. See ReferenceSetsTypeDef
  3. See RulesSourceTypeDef
  4. See StatefulRuleOptionsTypeDef

CreateRuleGroupRequestRequestTypeDef#

# CreateRuleGroupRequestRequestTypeDef definition

class CreateRuleGroupRequestRequestTypeDef(TypedDict):
    RuleGroupName: str,
    Type: RuleGroupTypeType,  # (1)
    Capacity: int,
    RuleGroup: NotRequired[RuleGroupTypeDef],  # (2)
    Rules: NotRequired[str],
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    DryRun: NotRequired[bool],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (4)
    SourceMetadata: NotRequired[SourceMetadataTypeDef],  # (5)
    AnalyzeRuleGroup: NotRequired[bool],
  1. See RuleGroupTypeType
  2. See RuleGroupTypeDef
  3. See TagTypeDef
  4. See EncryptionConfigurationTypeDef
  5. See SourceMetadataTypeDef

DescribeRuleGroupResponseTypeDef#

# DescribeRuleGroupResponseTypeDef definition

class DescribeRuleGroupResponseTypeDef(TypedDict):
    UpdateToken: str,
    RuleGroup: RuleGroupTypeDef,  # (1)
    RuleGroupResponse: RuleGroupResponseTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RuleGroupTypeDef
  2. See RuleGroupResponseTypeDef
  3. See ResponseMetadataTypeDef

UpdateRuleGroupRequestRequestTypeDef#

# UpdateRuleGroupRequestRequestTypeDef definition

class UpdateRuleGroupRequestRequestTypeDef(TypedDict):
    UpdateToken: str,
    RuleGroupArn: NotRequired[str],
    RuleGroupName: NotRequired[str],
    RuleGroup: NotRequired[RuleGroupTypeDef],  # (1)
    Rules: NotRequired[str],
    Type: NotRequired[RuleGroupTypeType],  # (2)
    Description: NotRequired[str],
    DryRun: NotRequired[bool],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    SourceMetadata: NotRequired[SourceMetadataTypeDef],  # (4)
    AnalyzeRuleGroup: NotRequired[bool],
  1. See RuleGroupTypeDef
  2. See RuleGroupTypeType
  3. See EncryptionConfigurationTypeDef
  4. See SourceMetadataTypeDef