FMS module#
Index > FMS
Auto-generated documentation for FMS type annotations stubs module mypy-boto3-fms.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and FMS
.
From PyPI with pip#
Install boto3-stubs
for FMS
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[fms]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[fms]'
# standalone installation
python -m pip install mypy-boto3-fms
How to uninstall#
python -m pip uninstall -y mypy-boto3-fms
Usage#
Code samples can be found in Examples.
FMSClient#
Type annotations and code completion for boto3.client("fms")
as FMSClient
boto3 documentation
# FMSClient usage example
from boto3.session import Session
from mypy_boto3_fms.client import FMSClient
def get_client() -> FMSClient:
return Session().client("fms")
Paginators#
Type annotations and code completion for paginators
from boto3.client("fms").get_paginator("...")
.
# ListAdminAccountsForOrganizationPaginator usage example
from boto3.session import Session
from mypy_boto3_fms.paginator import ListAdminAccountsForOrganizationPaginator
def get_list_admin_accounts_for_organization_paginator() -> ListAdminAccountsForOrganizationPaginator:
return Session().client("fms").get_paginator("list_admin_accounts_for_organization"))
- ListAdminAccountsForOrganizationPaginator
- ListAdminsManagingAccountPaginator
- ListAppsListsPaginator
- ListComplianceStatusPaginator
- ListMemberAccountsPaginator
- ListPoliciesPaginator
- ListProtocolsListsPaginator
- ListThirdPartyFirewallFirewallPoliciesPaginator
Literals#
Type annotations for literals used in methods and schema.
# AccountRoleStatusType usage example
from mypy_boto3_fms.literals import AccountRoleStatusType
def get_value() -> AccountRoleStatusType:
return "CREATING"
- AccountRoleStatusType
- CustomerPolicyScopeIdTypeType
- CustomerPolicyStatusType
- DependentServiceNameType
- DestinationTypeType
- EntryTypeType
- EntryViolationReasonType
- FailedItemReasonType
- FirewallDeploymentModelType
- ListAdminAccountsForOrganizationPaginatorName
- ListAdminsManagingAccountPaginatorName
- ListAppsListsPaginatorName
- ListComplianceStatusPaginatorName
- ListMemberAccountsPaginatorName
- ListPoliciesPaginatorName
- ListProtocolsListsPaginatorName
- ListThirdPartyFirewallFirewallPoliciesPaginatorName
- MarketplaceSubscriptionOnboardingStatusType
- NetworkAclRuleActionType
- NetworkFirewallOverrideActionType
- OrganizationStatusType
- PolicyComplianceStatusTypeType
- RemediationActionTypeType
- ResourceSetStatusType
- RuleOrderType
- SecurityServiceTypeType
- StreamExceptionPolicyType
- TargetTypeType
- ThirdPartyFirewallAssociationStatusType
- ThirdPartyFirewallType
- ViolationReasonType
- FMSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountScopeOutputTypeDef
- AccountScopeTypeDef
- ActionTargetTypeDef
- AdminAccountSummaryTypeDef
- OrganizationalUnitScopeOutputTypeDef
- PolicyTypeScopeOutputTypeDef
- RegionScopeOutputTypeDef
- OrganizationalUnitScopeTypeDef
- PolicyTypeScopeTypeDef
- RegionScopeTypeDef
- AppTypeDef
- TimestampTypeDef
- AssociateAdminAccountRequestRequestTypeDef
- AssociateThirdPartyFirewallRequestRequestTypeDef
- ResponseMetadataTypeDef
- AwsEc2NetworkInterfaceViolationTypeDef
- PartialMatchTypeDef
- BatchAssociateResourceRequestRequestTypeDef
- FailedItemTypeDef
- BatchDisassociateResourceRequestRequestTypeDef
- ComplianceViolatorTypeDef
- DeleteAppsListRequestRequestTypeDef
- DeletePolicyRequestRequestTypeDef
- DeleteProtocolsListRequestRequestTypeDef
- DeleteResourceSetRequestRequestTypeDef
- DisassociateThirdPartyFirewallRequestRequestTypeDef
- DiscoveredResourceTypeDef
- DnsDuplicateRuleGroupViolationTypeDef
- DnsRuleGroupLimitExceededViolationTypeDef
- DnsRuleGroupPriorityConflictViolationTypeDef
- EvaluationResultTypeDef
- ExpectedRouteTypeDef
- FMSPolicyUpdateFirewallCreationConfigActionTypeDef
- FirewallSubnetIsOutOfScopeViolationTypeDef
- FirewallSubnetMissingVPCEndpointViolationTypeDef
- GetAdminScopeRequestRequestTypeDef
- GetAppsListRequestRequestTypeDef
- GetComplianceDetailRequestRequestTypeDef
- GetPolicyRequestRequestTypeDef
- GetProtocolsListRequestRequestTypeDef
- ProtocolsListDataOutputTypeDef
- GetResourceSetRequestRequestTypeDef
- ResourceSetOutputTypeDef
- GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef
- GetViolationDetailsRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListAdminAccountsForOrganizationRequestRequestTypeDef
- ListAdminsManagingAccountRequestRequestTypeDef
- ListAppsListsRequestRequestTypeDef
- ListComplianceStatusRequestRequestTypeDef
- ListDiscoveredResourcesRequestRequestTypeDef
- ListMemberAccountsRequestRequestTypeDef
- ListPoliciesRequestRequestTypeDef
- PolicySummaryTypeDef
- ListProtocolsListsRequestRequestTypeDef
- ProtocolsListDataSummaryTypeDef
- ListResourceSetResourcesRequestRequestTypeDef
- ResourceTypeDef
- ListResourceSetsRequestRequestTypeDef
- ResourceSetSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TagTypeDef
- ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef
- ThirdPartyFirewallFirewallPolicyTypeDef
- NetworkAclIcmpTypeCodeTypeDef
- NetworkAclPortRangeTypeDef
- RouteTypeDef
- NetworkFirewallMissingExpectedRTViolationTypeDef
- NetworkFirewallMissingFirewallViolationTypeDef
- NetworkFirewallMissingSubnetViolationTypeDef
- StatefulEngineOptionsTypeDef
- StatelessRuleGroupTypeDef
- NetworkFirewallPolicyTypeDef
- NetworkFirewallStatefulRuleGroupOverrideTypeDef
- ThirdPartyFirewallPolicyTypeDef
- ResourceTagTypeDef
- PutNotificationChannelRequestRequestTypeDef
- ThirdPartyFirewallMissingExpectedRouteTableViolationTypeDef
- ThirdPartyFirewallMissingFirewallViolationTypeDef
- ThirdPartyFirewallMissingSubnetViolationTypeDef
- SecurityGroupRuleDescriptionTypeDef
- UntagResourceRequestRequestTypeDef
- CreateNetworkAclActionTypeDef
- EC2AssociateRouteTableActionTypeDef
- EC2CopyRouteTableActionTypeDef
- EC2CreateRouteActionTypeDef
- EC2CreateRouteTableActionTypeDef
- EC2DeleteRouteActionTypeDef
- EC2ReplaceRouteActionTypeDef
- EC2ReplaceRouteTableAssociationActionTypeDef
- ReplaceNetworkAclAssociationActionTypeDef
- AdminScopeOutputTypeDef
- AdminScopeTypeDef
- AppsListDataOutputTypeDef
- AppsListDataSummaryTypeDef
- AppsListDataTypeDef
- GetProtectionStatusRequestRequestTypeDef
- ProtocolsListDataTypeDef
- ResourceSetTypeDef
- AssociateThirdPartyFirewallResponseTypeDef
- DisassociateThirdPartyFirewallResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetAdminAccountResponseTypeDef
- GetNotificationChannelResponseTypeDef
- GetProtectionStatusResponseTypeDef
- GetThirdPartyFirewallAssociationStatusResponseTypeDef
- ListAdminAccountsForOrganizationResponseTypeDef
- ListAdminsManagingAccountResponseTypeDef
- ListMemberAccountsResponseTypeDef
- AwsEc2InstanceViolationTypeDef
- BatchAssociateResourceResponseTypeDef
- BatchDisassociateResourceResponseTypeDef
- PolicyComplianceDetailTypeDef
- ListDiscoveredResourcesResponseTypeDef
- PolicyComplianceStatusTypeDef
- NetworkFirewallMissingExpectedRoutesViolationTypeDef
- GetProtocolsListResponseTypeDef
- PutProtocolsListResponseTypeDef
- GetResourceSetResponseTypeDef
- PutResourceSetResponseTypeDef
- ListAdminAccountsForOrganizationRequestListAdminAccountsForOrganizationPaginateTypeDef
- ListAdminsManagingAccountRequestListAdminsManagingAccountPaginateTypeDef
- ListAppsListsRequestListAppsListsPaginateTypeDef
- ListComplianceStatusRequestListComplianceStatusPaginateTypeDef
- ListMemberAccountsRequestListMemberAccountsPaginateTypeDef
- ListPoliciesRequestListPoliciesPaginateTypeDef
- ListProtocolsListsRequestListProtocolsListsPaginateTypeDef
- ListThirdPartyFirewallFirewallPoliciesRequestListThirdPartyFirewallFirewallPoliciesPaginateTypeDef
- ListPoliciesResponseTypeDef
- ListProtocolsListsResponseTypeDef
- ListResourceSetResourcesResponseTypeDef
- ListResourceSetsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- ListThirdPartyFirewallFirewallPoliciesResponseTypeDef
- NetworkAclEntryTypeDef
- NetworkFirewallBlackHoleRouteDetectedViolationTypeDef
- NetworkFirewallInternetTrafficNotInspectedViolationTypeDef
- NetworkFirewallInvalidRouteConfigurationViolationTypeDef
- NetworkFirewallUnexpectedFirewallRoutesViolationTypeDef
- NetworkFirewallUnexpectedGatewayRoutesViolationTypeDef
- RouteHasOutOfScopeEndpointViolationTypeDef
- StatefulRuleGroupTypeDef
- SecurityGroupRemediationActionTypeDef
- GetAdminScopeResponseTypeDef
- AdminScopeUnionTypeDef
- PutAdminAccountRequestRequestTypeDef
- GetAppsListResponseTypeDef
- PutAppsListResponseTypeDef
- ListAppsListsResponseTypeDef
- AppsListDataUnionTypeDef
- PutAppsListRequestRequestTypeDef
- ProtocolsListDataUnionTypeDef
- PutProtocolsListRequestRequestTypeDef
- PutResourceSetRequestRequestTypeDef
- ResourceSetUnionTypeDef
- GetComplianceDetailResponseTypeDef
- ListComplianceStatusResponseTypeDef
- EntryDescriptionTypeDef
- NetworkAclEntrySetOutputTypeDef
- NetworkAclEntrySetTypeDef
- NetworkFirewallPolicyDescriptionTypeDef
- AwsVPCSecurityGroupViolationTypeDef
- CreateNetworkAclEntriesActionTypeDef
- DeleteNetworkAclEntriesActionTypeDef
- EntryViolationTypeDef
- NetworkAclCommonPolicyOutputTypeDef
- NetworkAclCommonPolicyTypeDef
- NetworkFirewallPolicyModifiedViolationTypeDef
- RemediationActionTypeDef
- InvalidNetworkAclEntriesViolationTypeDef
- PolicyOptionOutputTypeDef
- PolicyOptionTypeDef
- RemediationActionWithOrderTypeDef
- SecurityServicePolicyDataOutputTypeDef
- SecurityServicePolicyDataTypeDef
- PossibleRemediationActionTypeDef
- PolicyOutputTypeDef
- PolicyTypeDef
- PossibleRemediationActionsTypeDef
- GetPolicyResponseTypeDef
- PutPolicyResponseTypeDef
- PolicyUnionTypeDef
- PutPolicyRequestRequestTypeDef
- ResourceViolationTypeDef
- ViolationDetailTypeDef
- GetViolationDetailsResponseTypeDef