Skip to content

FMSClient

Index > FMS > 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

Usage example
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.

Usage example
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)
Type checking example
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

Method definition
def associate_admin_account(
    self,
    *,
    AdminAccount: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateAdminAccountRequestRequestTypeDef = {  # (1)
    "AdminAccount": ...,
}

parent.associate_admin_account(**kwargs)
  1. See AssociateAdminAccountRequestRequestTypeDef

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

Method definition
def associate_third_party_firewall(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
) -> AssociateThirdPartyFirewallResponseTypeDef:  # (2)
    ...
  1. See ThirdPartyFirewallType
  2. See AssociateThirdPartyFirewallResponseTypeDef
Usage example with kwargs
kwargs: AssociateThirdPartyFirewallRequestRequestTypeDef = {  # (1)
    "ThirdPartyFirewall": ...,
}

parent.associate_third_party_firewall(**kwargs)
  1. See AssociateThirdPartyFirewallRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("fms").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("fms").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
def delete_apps_list(
    self,
    *,
    ListId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteAppsListRequestRequestTypeDef = {  # (1)
    "ListId": ...,
}

parent.delete_apps_list(**kwargs)
  1. See DeleteAppsListRequestRequestTypeDef

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

Method definition
def delete_notification_channel(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef

delete_policy

Permanently deletes an Firewall Manager policy.

Type annotations and code completion for boto3.client("fms").delete_policy method. boto3 documentation

Method definition
def delete_policy(
    self,
    *,
    PolicyId: str,
    DeleteAllPolicyResources: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeletePolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.delete_policy(**kwargs)
  1. See DeletePolicyRequestRequestTypeDef

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

Method definition
def delete_protocols_list(
    self,
    *,
    ListId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteProtocolsListRequestRequestTypeDef = {  # (1)
    "ListId": ...,
}

parent.delete_protocols_list(**kwargs)
  1. See DeleteProtocolsListRequestRequestTypeDef

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

Method definition
def disassociate_admin_account(
    self,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef

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

Method definition
def disassociate_third_party_firewall(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
) -> DisassociateThirdPartyFirewallResponseTypeDef:  # (2)
    ...
  1. See ThirdPartyFirewallType
  2. See DisassociateThirdPartyFirewallResponseTypeDef
Usage example with kwargs
kwargs: DisassociateThirdPartyFirewallRequestRequestTypeDef = {  # (1)
    "ThirdPartyFirewall": ...,
}

parent.disassociate_third_party_firewall(**kwargs)
  1. See DisassociateThirdPartyFirewallRequestRequestTypeDef

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

Method definition
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

Method definition
def get_admin_account(
    self,
) -> GetAdminAccountResponseTypeDef:  # (1)
    ...
  1. See GetAdminAccountResponseTypeDef

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

Method definition
def get_apps_list(
    self,
    *,
    ListId: str,
    DefaultList: bool = ...,
) -> GetAppsListResponseTypeDef:  # (1)
    ...
  1. See GetAppsListResponseTypeDef
Usage example with kwargs
kwargs: GetAppsListRequestRequestTypeDef = {  # (1)
    "ListId": ...,
}

parent.get_apps_list(**kwargs)
  1. See GetAppsListRequestRequestTypeDef

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

Method definition
def get_compliance_detail(
    self,
    *,
    PolicyId: str,
    MemberAccount: str,
) -> GetComplianceDetailResponseTypeDef:  # (1)
    ...
  1. See GetComplianceDetailResponseTypeDef
Usage example with kwargs
kwargs: GetComplianceDetailRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
    "MemberAccount": ...,
}

parent.get_compliance_detail(**kwargs)
  1. See GetComplianceDetailRequestRequestTypeDef

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

Method definition
def get_notification_channel(
    self,
) -> GetNotificationChannelResponseTypeDef:  # (1)
    ...
  1. See GetNotificationChannelResponseTypeDef

get_policy

Returns information about the specified Firewall Manager policy.

Type annotations and code completion for boto3.client("fms").get_policy method. boto3 documentation

Method definition
def get_policy(
    self,
    *,
    PolicyId: str,
) -> GetPolicyResponseTypeDef:  # (1)
    ...
  1. See GetPolicyResponseTypeDef
Usage example with kwargs
kwargs: GetPolicyRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.get_policy(**kwargs)
  1. See GetPolicyRequestRequestTypeDef

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

Method definition
def get_protection_status(
    self,
    *,
    PolicyId: str,
    MemberAccountId: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetProtectionStatusResponseTypeDef:  # (1)
    ...
  1. See GetProtectionStatusResponseTypeDef
Usage example with kwargs
kwargs: GetProtectionStatusRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.get_protection_status(**kwargs)
  1. See GetProtectionStatusRequestRequestTypeDef

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

Method definition
def get_protocols_list(
    self,
    *,
    ListId: str,
    DefaultList: bool = ...,
) -> GetProtocolsListResponseTypeDef:  # (1)
    ...
  1. See GetProtocolsListResponseTypeDef
Usage example with kwargs
kwargs: GetProtocolsListRequestRequestTypeDef = {  # (1)
    "ListId": ...,
}

parent.get_protocols_list(**kwargs)
  1. See GetProtocolsListRequestRequestTypeDef

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

Method definition
def get_third_party_firewall_association_status(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
) -> GetThirdPartyFirewallAssociationStatusResponseTypeDef:  # (2)
    ...
  1. See ThirdPartyFirewallType
  2. See GetThirdPartyFirewallAssociationStatusResponseTypeDef
Usage example with kwargs
kwargs: GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef = {  # (1)
    "ThirdPartyFirewall": ...,
}

parent.get_third_party_firewall_association_status(**kwargs)
  1. See GetThirdPartyFirewallAssociationStatusRequestRequestTypeDef

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

Method definition
def get_violation_details(
    self,
    *,
    PolicyId: str,
    MemberAccount: str,
    ResourceId: str,
    ResourceType: str,
) -> GetViolationDetailsResponseTypeDef:  # (1)
    ...
  1. See GetViolationDetailsResponseTypeDef
Usage example with kwargs
kwargs: GetViolationDetailsRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
    "MemberAccount": ...,
    "ResourceId": ...,
    "ResourceType": ...,
}

parent.get_violation_details(**kwargs)
  1. See GetViolationDetailsRequestRequestTypeDef

list_apps_lists

Returns an array of AppsListDataSummary objects.

Type annotations and code completion for boto3.client("fms").list_apps_lists method. boto3 documentation

Method definition
def list_apps_lists(
    self,
    *,
    MaxResults: int,
    DefaultLists: bool = ...,
    NextToken: str = ...,
) -> ListAppsListsResponseTypeDef:  # (1)
    ...
  1. See ListAppsListsResponseTypeDef
Usage example with kwargs
kwargs: ListAppsListsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_apps_lists(**kwargs)
  1. See ListAppsListsRequestRequestTypeDef

list_compliance_status

Returns an array of PolicyComplianceStatus objects.

Type annotations and code completion for boto3.client("fms").list_compliance_status method. boto3 documentation

Method definition
def list_compliance_status(
    self,
    *,
    PolicyId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListComplianceStatusResponseTypeDef:  # (1)
    ...
  1. See ListComplianceStatusResponseTypeDef
Usage example with kwargs
kwargs: ListComplianceStatusRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.list_compliance_status(**kwargs)
  1. See ListComplianceStatusRequestRequestTypeDef

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

Method definition
def list_member_accounts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMemberAccountsResponseTypeDef:  # (1)
    ...
  1. See ListMemberAccountsResponseTypeDef
Usage example with kwargs
kwargs: ListMemberAccountsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_member_accounts(**kwargs)
  1. See ListMemberAccountsRequestRequestTypeDef

list_policies

Returns an array of PolicySummary objects.

Type annotations and code completion for boto3.client("fms").list_policies method. boto3 documentation

Method definition
def list_policies(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListPoliciesResponseTypeDef
Usage example with kwargs
kwargs: ListPoliciesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_policies(**kwargs)
  1. See ListPoliciesRequestRequestTypeDef

list_protocols_lists

Returns an array of ProtocolsListDataSummary objects.

Type annotations and code completion for boto3.client("fms").list_protocols_lists method. boto3 documentation

Method definition
def list_protocols_lists(
    self,
    *,
    MaxResults: int,
    DefaultLists: bool = ...,
    NextToken: str = ...,
) -> ListProtocolsListsResponseTypeDef:  # (1)
    ...
  1. See ListProtocolsListsResponseTypeDef
Usage example with kwargs
kwargs: ListProtocolsListsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_protocols_lists(**kwargs)
  1. See ListProtocolsListsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition
def list_third_party_firewall_firewall_policies(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
    MaxResults: int,
    NextToken: str = ...,
) -> ListThirdPartyFirewallFirewallPoliciesResponseTypeDef:  # (2)
    ...
  1. See ThirdPartyFirewallType
  2. See ListThirdPartyFirewallFirewallPoliciesResponseTypeDef
Usage example with kwargs
kwargs: ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef = {  # (1)
    "ThirdPartyFirewall": ...,
    "MaxResults": ...,
}

parent.list_third_party_firewall_firewall_policies(**kwargs)
  1. See ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef

put_apps_list

Creates an Firewall Manager applications list.

Type annotations and code completion for boto3.client("fms").put_apps_list method. boto3 documentation

Method definition
def put_apps_list(
    self,
    *,
    AppsList: AppsListDataTypeDef,  # (1)
    TagList: Sequence[TagTypeDef] = ...,  # (2)
) -> PutAppsListResponseTypeDef:  # (3)
    ...
  1. See AppsListDataTypeDef
  2. See TagTypeDef
  3. See PutAppsListResponseTypeDef
Usage example with kwargs
kwargs: PutAppsListRequestRequestTypeDef = {  # (1)
    "AppsList": ...,
}

parent.put_apps_list(**kwargs)
  1. See PutAppsListRequestRequestTypeDef

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

Method definition
def put_notification_channel(
    self,
    *,
    SnsTopicArn: str,
    SnsRoleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: PutNotificationChannelRequestRequestTypeDef = {  # (1)
    "SnsTopicArn": ...,
    "SnsRoleName": ...,
}

parent.put_notification_channel(**kwargs)
  1. See PutNotificationChannelRequestRequestTypeDef

put_policy

Creates an Firewall Manager policy.

Type annotations and code completion for boto3.client("fms").put_policy method. boto3 documentation

Method definition
def put_policy(
    self,
    *,
    Policy: PolicyTypeDef,  # (1)
    TagList: Sequence[TagTypeDef] = ...,  # (2)
) -> PutPolicyResponseTypeDef:  # (3)
    ...
  1. See PolicyTypeDef
  2. See TagTypeDef
  3. See PutPolicyResponseTypeDef
Usage example with kwargs
kwargs: PutPolicyRequestRequestTypeDef = {  # (1)
    "Policy": ...,
}

parent.put_policy(**kwargs)
  1. See PutPolicyRequestRequestTypeDef

put_protocols_list

Creates an Firewall Manager protocols list.

Type annotations and code completion for boto3.client("fms").put_protocols_list method. boto3 documentation

Method definition
def put_protocols_list(
    self,
    *,
    ProtocolsList: ProtocolsListDataTypeDef,  # (1)
    TagList: Sequence[TagTypeDef] = ...,  # (2)
) -> PutProtocolsListResponseTypeDef:  # (3)
    ...
  1. See ProtocolsListDataTypeDef
  2. See TagTypeDef
  3. See PutProtocolsListResponseTypeDef
Usage example with kwargs
kwargs: PutProtocolsListRequestRequestTypeDef = {  # (1)
    "ProtocolsList": ...,
}

parent.put_protocols_list(**kwargs)
  1. See PutProtocolsListRequestRequestTypeDef

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

Method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    TagList: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagList": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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

Method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("fms").get_paginator method with overloads.