FMSClient
Auto-generated documentation for FMS type annotations stubs module mypy-boto3-fms.
FMSClient
Type annotations and code completion for boto3.client("fms")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_fms.client import FMSClient
def get_fms_client() -> FMSClient:
return Session().client("fms")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("fms").exceptions
structure.
client = boto3.client("fms")
try:
do_something(client)
except (
client.ClientError,
client.InternalErrorException,
client.InvalidInputException,
client.InvalidOperationException,
client.InvalidTypeException,
client.LimitExceededException,
client.ResourceNotFoundException,
) as e:
print(e)
from mypy_boto3_fms.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
associate_admin_account
Sets the Firewall Manager administrator account.
Type annotations and code completion for boto3.client("fms").associate_admin_account
method.
boto3 documentation
def associate_admin_account(
self,
*,
AdminAccount: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssociateAdminAccountRequestRequestTypeDef = { # (1)
"AdminAccount": ...,
}
parent.associate_admin_account(**kwargs)
associate_third_party_firewall
Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.
Type annotations and code completion for boto3.client("fms").associate_third_party_firewall
method.
boto3 documentation
def associate_third_party_firewall(
self,
*,
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
) -> AssociateThirdPartyFirewallResponseTypeDef: # (2)
...
kwargs: AssociateThirdPartyFirewallRequestRequestTypeDef = { # (1)
"ThirdPartyFirewall": ...,
}
parent.associate_third_party_firewall(**kwargs)
batch_associate_resource
Associate resources to a Firewall Manager resource set.
Type annotations and code completion for boto3.client("fms").batch_associate_resource
method.
boto3 documentation
def batch_associate_resource(
self,
*,
ResourceSetIdentifier: str,
Items: Sequence[str],
) -> BatchAssociateResourceResponseTypeDef: # (1)
...
kwargs: BatchAssociateResourceRequestRequestTypeDef = { # (1)
"ResourceSetIdentifier": ...,
"Items": ...,
}
parent.batch_associate_resource(**kwargs)
batch_disassociate_resource
Disassociates resources from a Firewall Manager resource set.
Type annotations and code completion for boto3.client("fms").batch_disassociate_resource
method.
boto3 documentation
def batch_disassociate_resource(
self,
*,
ResourceSetIdentifier: str,
Items: Sequence[str],
) -> BatchDisassociateResourceResponseTypeDef: # (1)
...
kwargs: BatchDisassociateResourceRequestRequestTypeDef = { # (1)
"ResourceSetIdentifier": ...,
"Items": ...,
}
parent.batch_disassociate_resource(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("fms").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("fms").close
method.
boto3 documentation
delete_apps_list
Permanently deletes an Firewall Manager applications list.
Type annotations and code completion for boto3.client("fms").delete_apps_list
method.
boto3 documentation
def delete_apps_list(
self,
*,
ListId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAppsListRequestRequestTypeDef = { # (1)
"ListId": ...,
}
parent.delete_apps_list(**kwargs)
delete_notification_channel
Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
Type annotations and code completion for boto3.client("fms").delete_notification_channel
method.
boto3 documentation
def delete_notification_channel(
self,
) -> EmptyResponseMetadataTypeDef: # (1)
...
delete_policy
Permanently deletes an Firewall Manager policy.
Type annotations and code completion for boto3.client("fms").delete_policy
method.
boto3 documentation
def delete_policy(
self,
*,
PolicyId: str,
DeleteAllPolicyResources: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePolicyRequestRequestTypeDef = { # (1)
"PolicyId": ...,
}
parent.delete_policy(**kwargs)
delete_protocols_list
Permanently deletes an Firewall Manager protocols list.
Type annotations and code completion for boto3.client("fms").delete_protocols_list
method.
boto3 documentation
def delete_protocols_list(
self,
*,
ListId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteProtocolsListRequestRequestTypeDef = { # (1)
"ListId": ...,
}
parent.delete_protocols_list(**kwargs)
delete_resource_set
Deletes the specified ResourceSet.
Type annotations and code completion for boto3.client("fms").delete_resource_set
method.
boto3 documentation
def delete_resource_set(
self,
*,
Identifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteResourceSetRequestRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.delete_resource_set(**kwargs)
disassociate_admin_account
Disassociates the account that has been set as the Firewall Manager administrator account.
Type annotations and code completion for boto3.client("fms").disassociate_admin_account
method.
boto3 documentation
disassociate_third_party_firewall
Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
Type annotations and code completion for boto3.client("fms").disassociate_third_party_firewall
method.
boto3 documentation
def disassociate_third_party_firewall(
self,
*,
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
) -> DisassociateThirdPartyFirewallResponseTypeDef: # (2)
...
kwargs: DisassociateThirdPartyFirewallRequestRequestTypeDef = { # (1)
"ThirdPartyFirewall": ...,
}
parent.disassociate_third_party_firewall(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("fms").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_admin_account
Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
Type annotations and code completion for boto3.client("fms").get_admin_account
method.
boto3 documentation
get_apps_list
Returns information about the specified Firewall Manager applications list.
Type annotations and code completion for boto3.client("fms").get_apps_list
method.
boto3 documentation
def get_apps_list(
self,
*,
ListId: str,
DefaultList: bool = ...,
) -> GetAppsListResponseTypeDef: # (1)
...
kwargs: GetAppsListRequestRequestTypeDef = { # (1)
"ListId": ...,
}
parent.get_apps_list(**kwargs)
get_compliance_detail
Returns detailed compliance information about the specified member account.
Type annotations and code completion for boto3.client("fms").get_compliance_detail
method.
boto3 documentation
def get_compliance_detail(
self,
*,
PolicyId: str,
MemberAccount: str,
) -> GetComplianceDetailResponseTypeDef: # (1)
...
kwargs: GetComplianceDetailRequestRequestTypeDef = { # (1)
"PolicyId": ...,
"MemberAccount": ...,
}
parent.get_compliance_detail(**kwargs)
get_notification_channel
Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
Type annotations and code completion for boto3.client("fms").get_notification_channel
method.
boto3 documentation
def get_notification_channel(
self,
) -> GetNotificationChannelResponseTypeDef: # (1)
...
get_policy
Returns information about the specified Firewall Manager policy.
Type annotations and code completion for boto3.client("fms").get_policy
method.
boto3 documentation
kwargs: GetPolicyRequestRequestTypeDef = { # (1)
"PolicyId": ...,
}
parent.get_policy(**kwargs)
get_protection_status
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
Type annotations and code completion for boto3.client("fms").get_protection_status
method.
boto3 documentation
def get_protection_status(
self,
*,
PolicyId: str,
MemberAccountId: str = ...,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetProtectionStatusResponseTypeDef: # (1)
...
kwargs: GetProtectionStatusRequestRequestTypeDef = { # (1)
"PolicyId": ...,
}
parent.get_protection_status(**kwargs)
get_protocols_list
Returns information about the specified Firewall Manager protocols list.
Type annotations and code completion for boto3.client("fms").get_protocols_list
method.
boto3 documentation
def get_protocols_list(
self,
*,
ListId: str,
DefaultList: bool = ...,
) -> GetProtocolsListResponseTypeDef: # (1)
...
kwargs: GetProtocolsListRequestRequestTypeDef = { # (1)
"ListId": ...,
}
parent.get_protocols_list(**kwargs)
get_resource_set
Gets information about a specific resource set.
Type annotations and code completion for boto3.client("fms").get_resource_set
method.
boto3 documentation
def get_resource_set(
self,
*,
Identifier: str,
) -> GetResourceSetResponseTypeDef: # (1)
...
kwargs: GetResourceSetRequestRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.get_resource_set(**kwargs)
get_third_party_firewall_association_status
The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
Type annotations and code completion for boto3.client("fms").get_third_party_firewall_association_status
method.
boto3 documentation
def get_third_party_firewall_association_status(
self,
*,
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
) -> GetThirdPartyFirewallAssociationStatusResponseTypeDef: # (2)
...
kwargs: GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef = { # (1)
"ThirdPartyFirewall": ...,
}
parent.get_third_party_firewall_association_status(**kwargs)
get_violation_details
Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
Type annotations and code completion for boto3.client("fms").get_violation_details
method.
boto3 documentation
def get_violation_details(
self,
*,
PolicyId: str,
MemberAccount: str,
ResourceId: str,
ResourceType: str,
) -> GetViolationDetailsResponseTypeDef: # (1)
...
kwargs: GetViolationDetailsRequestRequestTypeDef = { # (1)
"PolicyId": ...,
"MemberAccount": ...,
"ResourceId": ...,
"ResourceType": ...,
}
parent.get_violation_details(**kwargs)
list_apps_lists
Returns an array of AppsListDataSummary
objects.
Type annotations and code completion for boto3.client("fms").list_apps_lists
method.
boto3 documentation
def list_apps_lists(
self,
*,
MaxResults: int,
DefaultLists: bool = ...,
NextToken: str = ...,
) -> ListAppsListsResponseTypeDef: # (1)
...
kwargs: ListAppsListsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_apps_lists(**kwargs)
list_compliance_status
Returns an array of PolicyComplianceStatus
objects.
Type annotations and code completion for boto3.client("fms").list_compliance_status
method.
boto3 documentation
def list_compliance_status(
self,
*,
PolicyId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListComplianceStatusResponseTypeDef: # (1)
...
kwargs: ListComplianceStatusRequestRequestTypeDef = { # (1)
"PolicyId": ...,
}
parent.list_compliance_status(**kwargs)
list_discovered_resources
Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
Type annotations and code completion for boto3.client("fms").list_discovered_resources
method.
boto3 documentation
def list_discovered_resources(
self,
*,
MemberAccountIds: Sequence[str],
ResourceType: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDiscoveredResourcesResponseTypeDef: # (1)
...
kwargs: ListDiscoveredResourcesRequestRequestTypeDef = { # (1)
"MemberAccountIds": ...,
"ResourceType": ...,
}
parent.list_discovered_resources(**kwargs)
list_member_accounts
Returns a MemberAccounts
object that lists the member accounts in the
administrator's Amazon Web Services organization.
Type annotations and code completion for boto3.client("fms").list_member_accounts
method.
boto3 documentation
def list_member_accounts(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListMemberAccountsResponseTypeDef: # (1)
...
kwargs: ListMemberAccountsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_member_accounts(**kwargs)
list_policies
Returns an array of PolicySummary
objects.
Type annotations and code completion for boto3.client("fms").list_policies
method.
boto3 documentation
def list_policies(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPoliciesResponseTypeDef: # (1)
...
kwargs: ListPoliciesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_policies(**kwargs)
list_protocols_lists
Returns an array of ProtocolsListDataSummary
objects.
Type annotations and code completion for boto3.client("fms").list_protocols_lists
method.
boto3 documentation
def list_protocols_lists(
self,
*,
MaxResults: int,
DefaultLists: bool = ...,
NextToken: str = ...,
) -> ListProtocolsListsResponseTypeDef: # (1)
...
kwargs: ListProtocolsListsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_protocols_lists(**kwargs)
list_resource_set_resources
Returns an array of resources that are currently associated to a resource set.
Type annotations and code completion for boto3.client("fms").list_resource_set_resources
method.
boto3 documentation
def list_resource_set_resources(
self,
*,
Identifier: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListResourceSetResourcesResponseTypeDef: # (1)
...
kwargs: ListResourceSetResourcesRequestRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.list_resource_set_resources(**kwargs)
list_resource_sets
Returns an array of ResourceSetSummary
objects.
Type annotations and code completion for boto3.client("fms").list_resource_sets
method.
boto3 documentation
def list_resource_sets(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListResourceSetsResponseTypeDef: # (1)
...
kwargs: ListResourceSetsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_resource_sets(**kwargs)
list_tags_for_resource
Retrieves the list of tags for the specified Amazon Web Services resource.
Type annotations and code completion for boto3.client("fms").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_third_party_firewall_firewall_policies
Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
Type annotations and code completion for boto3.client("fms").list_third_party_firewall_firewall_policies
method.
boto3 documentation
def list_third_party_firewall_firewall_policies(
self,
*,
ThirdPartyFirewall: ThirdPartyFirewallType, # (1)
MaxResults: int,
NextToken: str = ...,
) -> ListThirdPartyFirewallFirewallPoliciesResponseTypeDef: # (2)
...
kwargs: ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef = { # (1)
"ThirdPartyFirewall": ...,
"MaxResults": ...,
}
parent.list_third_party_firewall_firewall_policies(**kwargs)
put_apps_list
Creates an Firewall Manager applications list.
Type annotations and code completion for boto3.client("fms").put_apps_list
method.
boto3 documentation
def put_apps_list(
self,
*,
AppsList: AppsListDataTypeDef, # (1)
TagList: Sequence[TagTypeDef] = ..., # (2)
) -> PutAppsListResponseTypeDef: # (3)
...
- See AppsListDataTypeDef
- See TagTypeDef
- See PutAppsListResponseTypeDef
kwargs: PutAppsListRequestRequestTypeDef = { # (1)
"AppsList": ...,
}
parent.put_apps_list(**kwargs)
put_notification_channel
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
Type annotations and code completion for boto3.client("fms").put_notification_channel
method.
boto3 documentation
def put_notification_channel(
self,
*,
SnsTopicArn: str,
SnsRoleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutNotificationChannelRequestRequestTypeDef = { # (1)
"SnsTopicArn": ...,
"SnsRoleName": ...,
}
parent.put_notification_channel(**kwargs)
put_policy
Creates an Firewall Manager policy.
Type annotations and code completion for boto3.client("fms").put_policy
method.
boto3 documentation
def put_policy(
self,
*,
Policy: PolicyTypeDef, # (1)
TagList: Sequence[TagTypeDef] = ..., # (2)
) -> PutPolicyResponseTypeDef: # (3)
...
- See PolicyTypeDef
- See TagTypeDef
- See PutPolicyResponseTypeDef
kwargs: PutPolicyRequestRequestTypeDef = { # (1)
"Policy": ...,
}
parent.put_policy(**kwargs)
put_protocols_list
Creates an Firewall Manager protocols list.
Type annotations and code completion for boto3.client("fms").put_protocols_list
method.
boto3 documentation
def put_protocols_list(
self,
*,
ProtocolsList: ProtocolsListDataTypeDef, # (1)
TagList: Sequence[TagTypeDef] = ..., # (2)
) -> PutProtocolsListResponseTypeDef: # (3)
...
kwargs: PutProtocolsListRequestRequestTypeDef = { # (1)
"ProtocolsList": ...,
}
parent.put_protocols_list(**kwargs)
put_resource_set
Creates the resource set.
Type annotations and code completion for boto3.client("fms").put_resource_set
method.
boto3 documentation
def put_resource_set(
self,
*,
ResourceSet: ResourceSetTypeDef, # (1)
TagList: Sequence[TagTypeDef] = ..., # (2)
) -> PutResourceSetResponseTypeDef: # (3)
...
kwargs: PutResourceSetRequestRequestTypeDef = { # (1)
"ResourceSet": ...,
}
parent.put_resource_set(**kwargs)
tag_resource
Adds one or more tags to an Amazon Web Services resource.
Type annotations and code completion for boto3.client("fms").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
TagList: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagList": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes one or more tags from an Amazon Web Services resource.
Type annotations and code completion for boto3.client("fms").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("fms").get_paginator
method with overloads.
client.get_paginator("list_apps_lists")
-> ListAppsListsPaginatorclient.get_paginator("list_compliance_status")
-> ListComplianceStatusPaginatorclient.get_paginator("list_member_accounts")
-> ListMemberAccountsPaginatorclient.get_paginator("list_policies")
-> ListPoliciesPaginatorclient.get_paginator("list_protocols_lists")
-> ListProtocolsListsPaginatorclient.get_paginator("list_third_party_firewall_firewall_policies")
-> ListThirdPartyFirewallFirewallPoliciesPaginator