Type definitions#
Auto-generated documentation for FMS type annotations stubs module mypy-boto3-fms.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AccountScopeTypeDef#
# AccountScopeTypeDef definition
class AccountScopeTypeDef(TypedDict):
Accounts: NotRequired[List[str]],
AllAccountsEnabled: NotRequired[bool],
ExcludeSpecifiedAccounts: NotRequired[bool],
ActionTargetTypeDef#
# ActionTargetTypeDef definition
class ActionTargetTypeDef(TypedDict):
ResourceId: NotRequired[str],
Description: NotRequired[str],
AdminAccountSummaryTypeDef#
# AdminAccountSummaryTypeDef definition
class AdminAccountSummaryTypeDef(TypedDict):
AdminAccount: NotRequired[str],
DefaultAdmin: NotRequired[bool],
Status: NotRequired[OrganizationStatusType], # (1)
OrganizationalUnitScopeTypeDef#
# OrganizationalUnitScopeTypeDef definition
class OrganizationalUnitScopeTypeDef(TypedDict):
OrganizationalUnits: NotRequired[List[str]],
AllOrganizationalUnitsEnabled: NotRequired[bool],
ExcludeSpecifiedOrganizationalUnits: NotRequired[bool],
PolicyTypeScopeTypeDef#
# PolicyTypeScopeTypeDef definition
class PolicyTypeScopeTypeDef(TypedDict):
PolicyTypes: NotRequired[List[SecurityServiceTypeType]], # (1)
AllPolicyTypesEnabled: NotRequired[bool],
RegionScopeTypeDef#
# RegionScopeTypeDef definition
class RegionScopeTypeDef(TypedDict):
Regions: NotRequired[List[str]],
AllRegionsEnabled: NotRequired[bool],
AppTypeDef#
# AppTypeDef definition
class AppTypeDef(TypedDict):
AppName: str,
Protocol: str,
Port: int,
AssociateAdminAccountRequestRequestTypeDef#
# AssociateAdminAccountRequestRequestTypeDef definition
class AssociateAdminAccountRequestRequestTypeDef(TypedDict):
AdminAccount: str,
AssociateThirdPartyFirewallRequestRequestTypeDef#
# AssociateThirdPartyFirewallRequestRequestTypeDef definition
class AssociateThirdPartyFirewallRequestRequestTypeDef(TypedDict):
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AwsEc2NetworkInterfaceViolationTypeDef#
# AwsEc2NetworkInterfaceViolationTypeDef definition
class AwsEc2NetworkInterfaceViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
ViolatingSecurityGroups: NotRequired[List[str]],
PartialMatchTypeDef#
# PartialMatchTypeDef definition
class PartialMatchTypeDef(TypedDict):
Reference: NotRequired[str],
TargetViolationReasons: NotRequired[List[str]],
BatchAssociateResourceRequestRequestTypeDef#
# BatchAssociateResourceRequestRequestTypeDef definition
class BatchAssociateResourceRequestRequestTypeDef(TypedDict):
ResourceSetIdentifier: str,
Items: Sequence[str],
FailedItemTypeDef#
# FailedItemTypeDef definition
class FailedItemTypeDef(TypedDict):
URI: NotRequired[str],
Reason: NotRequired[FailedItemReasonType], # (1)
BatchDisassociateResourceRequestRequestTypeDef#
# BatchDisassociateResourceRequestRequestTypeDef definition
class BatchDisassociateResourceRequestRequestTypeDef(TypedDict):
ResourceSetIdentifier: str,
Items: Sequence[str],
ComplianceViolatorTypeDef#
# ComplianceViolatorTypeDef definition
class ComplianceViolatorTypeDef(TypedDict):
ResourceId: NotRequired[str],
ViolationReason: NotRequired[ViolationReasonType], # (1)
ResourceType: NotRequired[str],
Metadata: NotRequired[Dict[str, str]],
DeleteAppsListRequestRequestTypeDef#
# DeleteAppsListRequestRequestTypeDef definition
class DeleteAppsListRequestRequestTypeDef(TypedDict):
ListId: str,
DeletePolicyRequestRequestTypeDef#
# DeletePolicyRequestRequestTypeDef definition
class DeletePolicyRequestRequestTypeDef(TypedDict):
PolicyId: str,
DeleteAllPolicyResources: NotRequired[bool],
DeleteProtocolsListRequestRequestTypeDef#
# DeleteProtocolsListRequestRequestTypeDef definition
class DeleteProtocolsListRequestRequestTypeDef(TypedDict):
ListId: str,
DeleteResourceSetRequestRequestTypeDef#
# DeleteResourceSetRequestRequestTypeDef definition
class DeleteResourceSetRequestRequestTypeDef(TypedDict):
Identifier: str,
DisassociateThirdPartyFirewallRequestRequestTypeDef#
# DisassociateThirdPartyFirewallRequestRequestTypeDef definition
class DisassociateThirdPartyFirewallRequestRequestTypeDef(TypedDict):
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
DiscoveredResourceTypeDef#
# DiscoveredResourceTypeDef definition
class DiscoveredResourceTypeDef(TypedDict):
URI: NotRequired[str],
AccountId: NotRequired[str],
Type: NotRequired[str],
Name: NotRequired[str],
DnsDuplicateRuleGroupViolationTypeDef#
# DnsDuplicateRuleGroupViolationTypeDef definition
class DnsDuplicateRuleGroupViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
ViolationTargetDescription: NotRequired[str],
DnsRuleGroupLimitExceededViolationTypeDef#
# DnsRuleGroupLimitExceededViolationTypeDef definition
class DnsRuleGroupLimitExceededViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
ViolationTargetDescription: NotRequired[str],
NumberOfRuleGroupsAlreadyAssociated: NotRequired[int],
DnsRuleGroupPriorityConflictViolationTypeDef#
# DnsRuleGroupPriorityConflictViolationTypeDef definition
class DnsRuleGroupPriorityConflictViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
ViolationTargetDescription: NotRequired[str],
ConflictingPriority: NotRequired[int],
ConflictingPolicyId: NotRequired[str],
UnavailablePriorities: NotRequired[List[int]],
EvaluationResultTypeDef#
# EvaluationResultTypeDef definition
class EvaluationResultTypeDef(TypedDict):
ComplianceStatus: NotRequired[PolicyComplianceStatusTypeType], # (1)
ViolatorCount: NotRequired[int],
EvaluationLimitExceeded: NotRequired[bool],
ExpectedRouteTypeDef#
# ExpectedRouteTypeDef definition
class ExpectedRouteTypeDef(TypedDict):
IpV4Cidr: NotRequired[str],
PrefixListId: NotRequired[str],
IpV6Cidr: NotRequired[str],
ContributingSubnets: NotRequired[List[str]],
AllowedTargets: NotRequired[List[str]],
RouteTableId: NotRequired[str],
FMSPolicyUpdateFirewallCreationConfigActionTypeDef#
# FMSPolicyUpdateFirewallCreationConfigActionTypeDef definition
class FMSPolicyUpdateFirewallCreationConfigActionTypeDef(TypedDict):
Description: NotRequired[str],
FirewallCreationConfig: NotRequired[str],
FirewallSubnetIsOutOfScopeViolationTypeDef#
# FirewallSubnetIsOutOfScopeViolationTypeDef definition
class FirewallSubnetIsOutOfScopeViolationTypeDef(TypedDict):
FirewallSubnetId: NotRequired[str],
VpcId: NotRequired[str],
SubnetAvailabilityZone: NotRequired[str],
SubnetAvailabilityZoneId: NotRequired[str],
VpcEndpointId: NotRequired[str],
FirewallSubnetMissingVPCEndpointViolationTypeDef#
# FirewallSubnetMissingVPCEndpointViolationTypeDef definition
class FirewallSubnetMissingVPCEndpointViolationTypeDef(TypedDict):
FirewallSubnetId: NotRequired[str],
VpcId: NotRequired[str],
SubnetAvailabilityZone: NotRequired[str],
SubnetAvailabilityZoneId: NotRequired[str],
GetAdminScopeRequestRequestTypeDef#
# GetAdminScopeRequestRequestTypeDef definition
class GetAdminScopeRequestRequestTypeDef(TypedDict):
AdminAccount: str,
GetAppsListRequestRequestTypeDef#
# GetAppsListRequestRequestTypeDef definition
class GetAppsListRequestRequestTypeDef(TypedDict):
ListId: str,
DefaultList: NotRequired[bool],
GetComplianceDetailRequestRequestTypeDef#
# GetComplianceDetailRequestRequestTypeDef definition
class GetComplianceDetailRequestRequestTypeDef(TypedDict):
PolicyId: str,
MemberAccount: str,
GetPolicyRequestRequestTypeDef#
# GetPolicyRequestRequestTypeDef definition
class GetPolicyRequestRequestTypeDef(TypedDict):
PolicyId: str,
GetProtocolsListRequestRequestTypeDef#
# GetProtocolsListRequestRequestTypeDef definition
class GetProtocolsListRequestRequestTypeDef(TypedDict):
ListId: str,
DefaultList: NotRequired[bool],
ProtocolsListDataTypeDef#
# ProtocolsListDataTypeDef definition
class ProtocolsListDataTypeDef(TypedDict):
ListName: str,
ProtocolsList: List[str],
ListId: NotRequired[str],
ListUpdateToken: NotRequired[str],
CreateTime: NotRequired[datetime],
LastUpdateTime: NotRequired[datetime],
PreviousProtocolsList: NotRequired[Dict[str, List[str]]],
GetResourceSetRequestRequestTypeDef#
# GetResourceSetRequestRequestTypeDef definition
class GetResourceSetRequestRequestTypeDef(TypedDict):
Identifier: str,
ResourceSetTypeDef#
# ResourceSetTypeDef definition
class ResourceSetTypeDef(TypedDict):
Name: str,
ResourceTypeList: List[str],
Id: NotRequired[str],
Description: NotRequired[str],
UpdateToken: NotRequired[str],
LastUpdateTime: NotRequired[datetime],
ResourceSetStatus: NotRequired[ResourceSetStatusType], # (1)
GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef#
# GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef definition
class GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef(TypedDict):
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
GetViolationDetailsRequestRequestTypeDef#
# GetViolationDetailsRequestRequestTypeDef definition
class GetViolationDetailsRequestRequestTypeDef(TypedDict):
PolicyId: str,
MemberAccount: str,
ResourceId: str,
ResourceType: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAdminAccountsForOrganizationRequestRequestTypeDef#
# ListAdminAccountsForOrganizationRequestRequestTypeDef definition
class ListAdminAccountsForOrganizationRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListAdminsManagingAccountRequestRequestTypeDef#
# ListAdminsManagingAccountRequestRequestTypeDef definition
class ListAdminsManagingAccountRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListAppsListsRequestRequestTypeDef#
# ListAppsListsRequestRequestTypeDef definition
class ListAppsListsRequestRequestTypeDef(TypedDict):
MaxResults: int,
DefaultLists: NotRequired[bool],
NextToken: NotRequired[str],
ListComplianceStatusRequestRequestTypeDef#
# ListComplianceStatusRequestRequestTypeDef definition
class ListComplianceStatusRequestRequestTypeDef(TypedDict):
PolicyId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDiscoveredResourcesRequestRequestTypeDef#
# ListDiscoveredResourcesRequestRequestTypeDef definition
class ListDiscoveredResourcesRequestRequestTypeDef(TypedDict):
MemberAccountIds: Sequence[str],
ResourceType: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListMemberAccountsRequestRequestTypeDef#
# ListMemberAccountsRequestRequestTypeDef definition
class ListMemberAccountsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListPoliciesRequestRequestTypeDef#
# ListPoliciesRequestRequestTypeDef definition
class ListPoliciesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PolicySummaryTypeDef#
# PolicySummaryTypeDef definition
class PolicySummaryTypeDef(TypedDict):
PolicyArn: NotRequired[str],
PolicyId: NotRequired[str],
PolicyName: NotRequired[str],
ResourceType: NotRequired[str],
SecurityServiceType: NotRequired[SecurityServiceTypeType], # (1)
RemediationEnabled: NotRequired[bool],
DeleteUnusedFMManagedResources: NotRequired[bool],
PolicyStatus: NotRequired[CustomerPolicyStatusType], # (2)
ListProtocolsListsRequestRequestTypeDef#
# ListProtocolsListsRequestRequestTypeDef definition
class ListProtocolsListsRequestRequestTypeDef(TypedDict):
MaxResults: int,
DefaultLists: NotRequired[bool],
NextToken: NotRequired[str],
ProtocolsListDataSummaryTypeDef#
# ProtocolsListDataSummaryTypeDef definition
class ProtocolsListDataSummaryTypeDef(TypedDict):
ListArn: NotRequired[str],
ListId: NotRequired[str],
ListName: NotRequired[str],
ProtocolsList: NotRequired[List[str]],
ListResourceSetResourcesRequestRequestTypeDef#
# ListResourceSetResourcesRequestRequestTypeDef definition
class ListResourceSetResourcesRequestRequestTypeDef(TypedDict):
Identifier: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ResourceTypeDef#
# ResourceTypeDef definition
class ResourceTypeDef(TypedDict):
URI: str,
AccountId: NotRequired[str],
ListResourceSetsRequestRequestTypeDef#
# ListResourceSetsRequestRequestTypeDef definition
class ListResourceSetsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ResourceSetSummaryTypeDef#
# ResourceSetSummaryTypeDef definition
class ResourceSetSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
LastUpdateTime: NotRequired[datetime],
ResourceSetStatus: NotRequired[ResourceSetStatusType], # (1)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef#
# ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef definition
class ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef(TypedDict):
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
MaxResults: int,
NextToken: NotRequired[str],
ThirdPartyFirewallFirewallPolicyTypeDef#
# ThirdPartyFirewallFirewallPolicyTypeDef definition
class ThirdPartyFirewallFirewallPolicyTypeDef(TypedDict):
FirewallPolicyId: NotRequired[str],
FirewallPolicyName: NotRequired[str],
RouteTypeDef#
# RouteTypeDef definition
class RouteTypeDef(TypedDict):
DestinationType: NotRequired[DestinationTypeType], # (1)
TargetType: NotRequired[TargetTypeType], # (2)
Destination: NotRequired[str],
Target: NotRequired[str],
- See DestinationTypeType
- See TargetTypeType
NetworkFirewallMissingExpectedRTViolationTypeDef#
# NetworkFirewallMissingExpectedRTViolationTypeDef definition
class NetworkFirewallMissingExpectedRTViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
VPC: NotRequired[str],
AvailabilityZone: NotRequired[str],
CurrentRouteTable: NotRequired[str],
ExpectedRouteTable: NotRequired[str],
NetworkFirewallMissingFirewallViolationTypeDef#
# NetworkFirewallMissingFirewallViolationTypeDef definition
class NetworkFirewallMissingFirewallViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
VPC: NotRequired[str],
AvailabilityZone: NotRequired[str],
TargetViolationReason: NotRequired[str],
NetworkFirewallMissingSubnetViolationTypeDef#
# NetworkFirewallMissingSubnetViolationTypeDef definition
class NetworkFirewallMissingSubnetViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
VPC: NotRequired[str],
AvailabilityZone: NotRequired[str],
TargetViolationReason: NotRequired[str],
StatefulEngineOptionsTypeDef#
# StatefulEngineOptionsTypeDef definition
class StatefulEngineOptionsTypeDef(TypedDict):
RuleOrder: NotRequired[RuleOrderType], # (1)
- See RuleOrderType
StatelessRuleGroupTypeDef#
# StatelessRuleGroupTypeDef definition
class StatelessRuleGroupTypeDef(TypedDict):
RuleGroupName: NotRequired[str],
ResourceId: NotRequired[str],
Priority: NotRequired[int],
NetworkFirewallPolicyTypeDef#
# NetworkFirewallPolicyTypeDef definition
class NetworkFirewallPolicyTypeDef(TypedDict):
FirewallDeploymentModel: NotRequired[FirewallDeploymentModelType], # (1)
NetworkFirewallStatefulRuleGroupOverrideTypeDef#
# NetworkFirewallStatefulRuleGroupOverrideTypeDef definition
class NetworkFirewallStatefulRuleGroupOverrideTypeDef(TypedDict):
Action: NotRequired[NetworkFirewallOverrideActionType], # (1)
ThirdPartyFirewallPolicyTypeDef#
# ThirdPartyFirewallPolicyTypeDef definition
class ThirdPartyFirewallPolicyTypeDef(TypedDict):
FirewallDeploymentModel: NotRequired[FirewallDeploymentModelType], # (1)
ResourceTagTypeDef#
# ResourceTagTypeDef definition
class ResourceTagTypeDef(TypedDict):
Key: str,
Value: NotRequired[str],
PutNotificationChannelRequestRequestTypeDef#
# PutNotificationChannelRequestRequestTypeDef definition
class PutNotificationChannelRequestRequestTypeDef(TypedDict):
SnsTopicArn: str,
SnsRoleName: str,
ThirdPartyFirewallMissingExpectedRouteTableViolationTypeDef#
# ThirdPartyFirewallMissingExpectedRouteTableViolationTypeDef definition
class ThirdPartyFirewallMissingExpectedRouteTableViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
VPC: NotRequired[str],
AvailabilityZone: NotRequired[str],
CurrentRouteTable: NotRequired[str],
ExpectedRouteTable: NotRequired[str],
ThirdPartyFirewallMissingFirewallViolationTypeDef#
# ThirdPartyFirewallMissingFirewallViolationTypeDef definition
class ThirdPartyFirewallMissingFirewallViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
VPC: NotRequired[str],
AvailabilityZone: NotRequired[str],
TargetViolationReason: NotRequired[str],
ThirdPartyFirewallMissingSubnetViolationTypeDef#
# ThirdPartyFirewallMissingSubnetViolationTypeDef definition
class ThirdPartyFirewallMissingSubnetViolationTypeDef(TypedDict):
ViolationTarget: NotRequired[str],
VPC: NotRequired[str],
AvailabilityZone: NotRequired[str],
TargetViolationReason: NotRequired[str],
SecurityGroupRuleDescriptionTypeDef#
# SecurityGroupRuleDescriptionTypeDef definition
class SecurityGroupRuleDescriptionTypeDef(TypedDict):
IPV4Range: NotRequired[str],
IPV6Range: NotRequired[str],
PrefixListId: NotRequired[str],
Protocol: NotRequired[str],
FromPort: NotRequired[int],
ToPort: NotRequired[int],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
EC2AssociateRouteTableActionTypeDef#
# EC2AssociateRouteTableActionTypeDef definition
class EC2AssociateRouteTableActionTypeDef(TypedDict):
RouteTableId: ActionTargetTypeDef, # (1)
Description: NotRequired[str],
SubnetId: NotRequired[ActionTargetTypeDef], # (1)
GatewayId: NotRequired[ActionTargetTypeDef], # (1)
EC2CopyRouteTableActionTypeDef#
# EC2CopyRouteTableActionTypeDef definition
class EC2CopyRouteTableActionTypeDef(TypedDict):
VpcId: ActionTargetTypeDef, # (1)
RouteTableId: ActionTargetTypeDef, # (1)
Description: NotRequired[str],
EC2CreateRouteActionTypeDef#
# EC2CreateRouteActionTypeDef definition
class EC2CreateRouteActionTypeDef(TypedDict):
RouteTableId: ActionTargetTypeDef, # (1)
Description: NotRequired[str],
DestinationCidrBlock: NotRequired[str],
DestinationPrefixListId: NotRequired[str],
DestinationIpv6CidrBlock: NotRequired[str],
VpcEndpointId: NotRequired[ActionTargetTypeDef], # (1)
GatewayId: NotRequired[ActionTargetTypeDef], # (1)
- See ActionTargetTypeDef
- See