Type definitions#
Index > NetworkFirewall > Type definitions
Auto-generated documentation for NetworkFirewall type annotations stubs module types-aiobotocore-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],
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)
AttachmentTypeDef#
# AttachmentTypeDef definition
class AttachmentTypeDef(TypedDict):
SubnetId: NotRequired[str],
EndpointId: NotRequired[str],
Status: NotRequired[AttachmentStatusType], # (1)
StatusMessage: NotRequired[str],
IPSetMetadataTypeDef#
# IPSetMetadataTypeDef definition
class IPSetMetadataTypeDef(TypedDict):
ResolvedCIDRCount: NotRequired[int],
CheckCertificateRevocationStatusActionsTypeDef#
# CheckCertificateRevocationStatusActionsTypeDef definition
class CheckCertificateRevocationStatusActionsTypeDef(TypedDict):
RevokedStatusAction: NotRequired[RevocationCheckActionType], # (1)
UnknownStatusAction: NotRequired[RevocationCheckActionType], # (1)
EncryptionConfigurationTypeDef#
# EncryptionConfigurationTypeDef definition
class EncryptionConfigurationTypeDef(TypedDict):
Type: EncryptionTypeType, # (1)
KeyId: NotRequired[str],
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)
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)
StatefulRuleOptionsTypeDef#
# StatefulRuleOptionsTypeDef definition
class StatefulRuleOptionsTypeDef(TypedDict):
RuleOrder: NotRequired[RuleOrderType], # (1)
- See RuleOrderType
DescribeRuleGroupRequestRequestTypeDef#
# DescribeRuleGroupRequestRequestTypeDef definition
class DescribeRuleGroupRequestRequestTypeDef(TypedDict):
RuleGroupName: NotRequired[str],
RuleGroupArn: NotRequired[str],
Type: NotRequired[RuleGroupTypeType], # (1)
AnalyzeRuleGroup: NotRequired[bool],
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)
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,
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)
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],
- See LogTypeType
- 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)
- See TCPFlagType
- See TCPFlagType
PerObjectStatusTypeDef#
# PerObjectStatusTypeDef definition
class PerObjectStatusTypeDef(TypedDict):
SyncStatus: NotRequired[PerObjectSyncStatusType], # (1)
UpdateToken: NotRequired[str],
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)
- See TargetTypeType
- See GeneratedRulesTypeType
ServerCertificateTypeDef#
# ServerCertificateTypeDef definition
class ServerCertificateTypeDef(TypedDict):
ResourceArn: NotRequired[str],
StatefulRuleGroupOverrideTypeDef#
# StatefulRuleGroupOverrideTypeDef definition
class StatefulRuleGroupOverrideTypeDef(TypedDict):
Action: NotRequired[OverrideActionType], # (1)
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)
DescribeResourcePolicyResponseTypeDef#
# DescribeResourcePolicyResponseTypeDef definition
class DescribeResourcePolicyResponseTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateFirewallDeleteProtectionResponseTypeDef#
# UpdateFirewallDeleteProtectionResponseTypeDef definition
class UpdateFirewallDeleteProtectionResponseTypeDef(TypedDict):
FirewallArn: str,
FirewallName: str,
DeleteProtection: bool,
UpdateToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateFirewallDescriptionResponseTypeDef#
# UpdateFirewallDescriptionResponseTypeDef definition
class UpdateFirewallDescriptionResponseTypeDef(TypedDict):
FirewallArn: str,
FirewallName: str,
Description: str,
UpdateToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateFirewallPolicyChangeProtectionResponseTypeDef#
# UpdateFirewallPolicyChangeProtectionResponseTypeDef definition
class UpdateFirewallPolicyChangeProtectionResponseTypeDef(TypedDict):
UpdateToken: str,
FirewallArn: str,
FirewallName: str,
FirewallPolicyChangeProtection: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateSubnetChangeProtectionResponseTypeDef#
# UpdateSubnetChangeProtectionResponseTypeDef definition
class UpdateSubnetChangeProtectionResponseTypeDef(TypedDict):
UpdateToken: str,
FirewallArn: str,
FirewallName: str,
SubnetChangeProtection: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AssociateSubnetsRequestRequestTypeDef#
# AssociateSubnetsRequestRequestTypeDef definition
class AssociateSubnetsRequestRequestTypeDef(TypedDict):
SubnetMappings: Sequence[SubnetMappingTypeDef], # (1)
UpdateToken: NotRequired[str],
FirewallArn: NotRequired[str],
FirewallName: NotRequired[str],
AssociateSubnetsResponseTypeDef#
# AssociateSubnetsResponseTypeDef definition
class AssociateSubnetsResponseTypeDef(TypedDict):
FirewallArn: str,
FirewallName: str,
SubnetMappings: List[SubnetMappingTypeDef], # (1)
UpdateToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociateSubnetsResponseTypeDef#
# DisassociateSubnetsResponseTypeDef definition
class DisassociateSubnetsResponseTypeDef(TypedDict):
FirewallArn: str,
FirewallName: str,
SubnetMappings: List[SubnetMappingTypeDef], # (1)
UpdateToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CIDRSummaryTypeDef#
# CIDRSummaryTypeDef definition
class CIDRSummaryTypeDef(TypedDict):
AvailableCIDRCount: NotRequired[int],
UtilizedCIDRCount: NotRequired[int],
IPSetReferences: NotRequired[Dict[str, IPSetMetadataTypeDef]], # (1)
UpdateFirewallEncryptionConfigurationRequestRequestTypeDef#
# UpdateFirewallEncryptionConfigurationRequestRequestTypeDef definition
class UpdateFirewallEncryptionConfigurationRequestRequestTypeDef(TypedDict):
UpdateToken: NotRequired[str],
FirewallArn: NotRequired[str],
FirewallName: NotRequired[str],
EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef], # (1)
UpdateFirewallEncryptionConfigurationResponseTypeDef#
# UpdateFirewallEncryptionConfigurationResponseTypeDef definition
class UpdateFirewallEncryptionConfigurationResponseTypeDef(TypedDict):
FirewallArn: str,
FirewallName: str,
UpdateToken: str,
EncryptionConfiguration: EncryptionConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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)
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],
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)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
NextToken: str,
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (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)
- See RuleGroupTypeType
- See ResourceStatusType
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See SourceMetadataTypeDef
- 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)
PublishMetricActionTypeDef#
# PublishMetricActionTypeDef definition
class PublishMetricActionTypeDef(TypedDict):
Dimensions: Sequence[DimensionTypeDef], # (1)
- See DimensionTypeDef
ListFirewallsResponseTypeDef#
# ListFirewallsResponseTypeDef definition
class ListFirewallsResponseTypeDef(TypedDict):
NextToken: str,
Firewalls: List[FirewallMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFirewallPoliciesResponseTypeDef#
# ListFirewallPoliciesResponseTypeDef definition
class ListFirewallPoliciesResponseTypeDef(TypedDict):
NextToken: str,
FirewallPolicies: List[FirewallPolicyMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ReferenceSetsTypeDef#
# ReferenceSetsTypeDef definition
class ReferenceSetsTypeDef(TypedDict):
IPSetReferences: NotRequired[Mapping[str, IPSetReferenceTypeDef]], # (1)
PolicyVariablesTypeDef#
# PolicyVariablesTypeDef definition
class PolicyVariablesTypeDef(TypedDict):
RuleVariables: NotRequired[Mapping[str, IPSetTypeDef]], # (1)
- See IPSetTypeDef
ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef#
# ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef definition
class ListFirewallPoliciesRequestListFirewallPoliciesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFirewallsRequestListFirewallsPaginateTypeDef#
# ListFirewallsRequestListFirewallsPaginateTypeDef definition
class ListFirewallsRequestListFirewallsPaginateTypeDef(TypedDict):
VpcIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRuleGroupsRequestListRuleGroupsPaginateTypeDef#
# ListRuleGroupsRequestListRuleGroupsPaginateTypeDef definition
class ListRuleGroupsRequestListRuleGroupsPaginateTypeDef(TypedDict):
Scope: NotRequired[ResourceManagedStatusType], # (1)
ManagedType: NotRequired[ResourceManagedTypeType], # (2)
Type: NotRequired[RuleGroupTypeType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ResourceManagedStatusType
- See ResourceManagedTypeType
- See RuleGroupTypeType
- See PaginatorConfigTypeDef
ListTLSInspectionConfigurationsRequestListTLSInspectionConfigurationsPaginateTypeDef#
# ListTLSInspectionConfigurationsRequestListTLSInspectionConfigurationsPaginateTypeDef definition
class ListTLSInspectionConfigurationsRequestListTLSInspectionConfigurationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#
# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
ResourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRuleGroupsResponseTypeDef#
# ListRuleGroupsResponseTypeDef definition
class ListRuleGroupsResponseTypeDef(TypedDict):
NextToken: str,
RuleGroups: List[RuleGroupMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTLSInspectionConfigurationsResponseTypeDef#
# ListTLSInspectionConfigurationsResponseTypeDef definition
class ListTLSInspectionConfigurationsResponseTypeDef(TypedDict):
NextToken: str,
TLSInspectionConfigurations: List[TLSInspectionConfigurationMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LoggingConfigurationTypeDef#
# LoggingConfigurationTypeDef definition
class LoggingConfigurationTypeDef(TypedDict):
LogDestinationConfigs: List[LogDestinationConfigTypeDef], # (1)
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]],
- See AddressTypeDef
- See AddressTypeDef
- See PortRangeTypeDef
- 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)
- See AddressTypeDef
- See AddressTypeDef
- See PortRangeTypeDef
- See PortRangeTypeDef
- See TCPFlagFieldTypeDef
SyncStateTypeDef#
# SyncStateTypeDef definition
class SyncStateTypeDef(TypedDict):
Attachment: NotRequired[AttachmentTypeDef], # (1)
Config: NotRequired[Dict[str, PerObjectStatusTypeDef]], # (2)
RuleVariablesTypeDef#
# RuleVariablesTypeDef definition
class RuleVariablesTypeDef(TypedDict):
IPSets: NotRequired[Mapping[str, IPSetTypeDef]], # (1)
PortSets: NotRequired[Mapping[str, PortSetTypeDef]], # (2)
- See IPSetTypeDef
- See PortSetTypeDef
StatefulRuleTypeDef#
# StatefulRuleTypeDef definition
class StatefulRuleTypeDef(TypedDict):
Action: StatefulActionType, # (1)
Header: HeaderTypeDef, # (2)
RuleOptions: Sequence[RuleOptionTypeDef], # (3)
- See StatefulActionType
- See HeaderTypeDef
- See RuleOptionTypeDef
StatefulRuleGroupReferenceTypeDef#
# StatefulRuleGroupReferenceTypeDef definition
class StatefulRuleGroupReferenceTypeDef(TypedDict):
ResourceArn: str,
Priority: NotRequired[int],
Override: NotRequired[StatefulRuleGroupOverrideTypeDef], # (1)
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)
- See ResourceStatusType
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See TlsCertificateDataTypeDef
- See TlsCertificateDataTypeDef
CapacityUsageSummaryTypeDef#
# CapacityUsageSummaryTypeDef definition
class CapacityUsageSummaryTypeDef(TypedDict):
CIDRs: NotRequired[CIDRSummaryTypeDef], # (1)
CreateFirewallPolicyResponseTypeDef#
# CreateFirewallPolicyResponseTypeDef definition
class CreateFirewallPolicyResponseTypeDef(TypedDict):
UpdateToken: str,
FirewallPolicyResponse: FirewallPolicyResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteFirewallPolicyResponseTypeDef#
# DeleteFirewallPolicyResponseTypeDef definition
class DeleteFirewallPolicyResponseTypeDef(TypedDict):
FirewallPolicyResponse: FirewallPolicyResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateFirewallPolicyResponseTypeDef#
# UpdateFirewallPolicyResponseTypeDef definition
class UpdateFirewallPolicyResponseTypeDef(TypedDict):
UpdateToken: str,
FirewallPolicyResponse: FirewallPolicyResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateRuleGroupResponseTypeDef#
# CreateRuleGroupResponseTypeDef definition
class CreateRuleGroupResponseTypeDef(TypedDict):
UpdateToken: str,
RuleGroupResponse: RuleGroupResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteRuleGroupResponseTypeDef#
# DeleteRuleGroupResponseTypeDef definition
class DeleteRuleGroupResponseTypeDef(TypedDict):
RuleGroupResponse: RuleGroupResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateRuleGroupResponseTypeDef#
# UpdateRuleGroupResponseTypeDef definition
class UpdateRuleGroupResponseTypeDef(TypedDict):
UpdateToken: str,
RuleGroupResponse: RuleGroupResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ActionDefinitionTypeDef#
# ActionDefinitionTypeDef definition
class ActionDefinitionTypeDef(TypedDict):
PublishMetricAction: NotRequired[PublishMetricActionTypeDef], # (1)
DescribeLoggingConfigurationResponseTypeDef#
# DescribeLoggingConfigurationResponseTypeDef definition
class DescribeLoggingConfigurationResponseTypeDef(TypedDict):
FirewallArn: str,
LoggingConfiguration: LoggingConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateLoggingConfigurationRequestRequestTypeDef#
# UpdateLoggingConfigurationRequestRequestTypeDef definition
class UpdateLoggingConfigurationRequestRequestTypeDef(TypedDict):
FirewallArn: NotRequired[str],
FirewallName: NotRequired[str],
LoggingConfiguration: NotRequired[LoggingConfigurationTypeDef], # (1)
UpdateLoggingConfigurationResponseTypeDef#
# UpdateLoggingConfigurationResponseTypeDef definition
class UpdateLoggingConfigurationResponseTypeDef(TypedDict):
FirewallArn: str,
FirewallName: str,
LoggingConfiguration: LoggingConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ServerCertificateConfigurationTypeDef#
# ServerCertificateConfigurationTypeDef definition
class ServerCertificateConfigurationTypeDef(TypedDict):
ServerCertificates: NotRequired[Sequence[ServerCertificateTypeDef]], # (1)
Scopes: NotRequired[Sequence[ServerCertificateScopeTypeDef]], # (2)
CertificateAuthorityArn: NotRequired[str],
CheckCertificateRevocationStatus: NotRequired[CheckCertificateRevocationStatusActionsTypeDef], # (3)
- See ServerCertificateTypeDef
- See ServerCertificateScopeTypeDef
- See CheckCertificateRevocationStatusActionsTypeDef
RuleDefinitionTypeDef#
# RuleDefinitionTypeDef definition
class RuleDefinitionTypeDef(TypedDict):
MatchAttributes: MatchAttributesTypeDef, # (1)
Actions: Sequence[str],
CreateTLSInspectionConfigurationResponseTypeDef#
# CreateTLSInspectionConfigurationResponseTypeDef definition
class CreateTLSInspectionConfigurationResponseTypeDef(TypedDict):
UpdateToken: str,
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteTLSInspectionConfigurationResponseTypeDef#
# DeleteTLSInspectionConfigurationResponseTypeDef definition
class DeleteTLSInspectionConfigurationResponseTypeDef(TypedDict):
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTLSInspectionConfigurationResponseTypeDef#
# UpdateTLSInspectionConfigurationResponseTypeDef definition
class UpdateTLSInspectionConfigurationResponseTypeDef(TypedDict):
UpdateToken: str,
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FirewallStatusTypeDef#
# FirewallStatusTypeDef definition
class FirewallStatusTypeDef(TypedDict):
Status: FirewallStatusValueType, # (1)
ConfigurationSyncStateSummary: ConfigurationSyncStateType, # (2)
SyncStates: NotRequired[Dict[str, SyncStateTypeDef]], # (3)
CapacityUsageSummary: NotRequired[CapacityUsageSummaryTypeDef], # (4)
- See FirewallStatusValueType
- See ConfigurationSyncStateType
- See SyncStateTypeDef
- See CapacityUsageSummaryTypeDef
CustomActionTypeDef#
# CustomActionTypeDef definition
class CustomActionTypeDef(TypedDict):
ActionName: str,
ActionDefinition: ActionDefinitionTypeDef, # (1)
TLSInspectionConfigurationTypeDef#
# TLSInspectionConfigurationTypeDef definition
class TLSInspectionConfigurationTypeDef(TypedDict):
ServerCertificateConfigurations: NotRequired[Sequence[ServerCertificateConfigurationTypeDef]], # (1)
StatelessRuleTypeDef#
# StatelessRuleTypeDef definition
class StatelessRuleTypeDef(TypedDict):
RuleDefinition: RuleDefinitionTypeDef, # (1)
Priority: int,
CreateFirewallResponseTypeDef#
# CreateFirewallResponseTypeDef definition
class CreateFirewallResponseTypeDef(TypedDict):
Firewall: FirewallTypeDef, # (1)
FirewallStatus: FirewallStatusTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DeleteFirewallResponseTypeDef#
# DeleteFirewallResponseTypeDef definition
class DeleteFirewallResponseTypeDef(TypedDict):
Firewall: FirewallTypeDef, # (1)
FirewallStatus: FirewallStatusTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeFirewallResponseTypeDef#
# DescribeFirewallResponseTypeDef definition
class DescribeFirewallResponseTypeDef(TypedDict):
UpdateToken: str,
Firewall: FirewallTypeDef, # (1)
FirewallStatus: FirewallStatusTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
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)
- See StatelessRuleGroupReferenceTypeDef
- See CustomActionTypeDef
- See StatefulRuleGroupReferenceTypeDef
- See StatefulEngineOptionsTypeDef
- 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)
DescribeTLSInspectionConfigurationResponseTypeDef#
# DescribeTLSInspectionConfigurationResponseTypeDef definition
class DescribeTLSInspectionConfigurationResponseTypeDef(TypedDict):
UpdateToken: str,
TLSInspectionConfiguration: TLSInspectionConfigurationTypeDef, # (1)
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponseTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See TLSInspectionConfigurationTypeDef
- See TLSInspectionConfigurationResponseTypeDef
- 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)
StatelessRulesAndCustomActionsTypeDef#
# StatelessRulesAndCustomActionsTypeDef definition
class StatelessRulesAndCustomActionsTypeDef(TypedDict):
StatelessRules: Sequence[StatelessRuleTypeDef], # (1)
CustomActions: NotRequired[Sequence[CustomActionTypeDef]], # (2)
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)
DescribeFirewallPolicyResponseTypeDef#
# DescribeFirewallPolicyResponseTypeDef definition
class DescribeFirewallPolicyResponseTypeDef(TypedDict):
UpdateToken: str,
FirewallPolicyResponse: FirewallPolicyResponseTypeDef, # (1)
FirewallPolicy: FirewallPolicyTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
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)
RulesSourceTypeDef#
# RulesSourceTypeDef definition
class RulesSourceTypeDef(TypedDict):
RulesString: NotRequired[str],
RulesSourceList: NotRequired[RulesSourceListTypeDef], # (1)
StatefulRules: NotRequired[Sequence[StatefulRuleTypeDef]], # (2)
StatelessRulesAndCustomActions: NotRequired[StatelessRulesAndCustomActionsTypeDef], # (3)
RuleGroupTypeDef#
# RuleGroupTypeDef definition
class RuleGroupTypeDef(TypedDict):
RulesSource: RulesSourceTypeDef, # (3)
RuleVariables: NotRequired[RuleVariablesTypeDef], # (1)
ReferenceSets: NotRequired[ReferenceSetsTypeDef], # (2)
StatefulRuleOptions: NotRequired[StatefulRuleOptionsTypeDef], # (4)
- See RuleVariablesTypeDef
- See ReferenceSetsTypeDef
- See RulesSourceTypeDef
- 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],
- See RuleGroupTypeType
- See RuleGroupTypeDef
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See SourceMetadataTypeDef
DescribeRuleGroupResponseTypeDef#
# DescribeRuleGroupResponseTypeDef definition
class DescribeRuleGroupResponseTypeDef(TypedDict):
UpdateToken: str,
RuleGroup: RuleGroupTypeDef, # (1)
RuleGroupResponse: RuleGroupResponseTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
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],