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

# FMSClient 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.

# Exceptions.exceptions usage example

client = boto3.client("fms")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InternalErrorException,
    client.exceptions.InvalidInputException,
    client.exceptions.InvalidOperationException,
    client.exceptions.InvalidTypeException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_fms.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

associate_admin_account

Sets a Firewall Manager default administrator account.

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

# associate_admin_account method definition

def associate_admin_account(
    self,
    *,
    AdminAccount: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# associate_admin_account method usage example with argument unpacking

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

# associate_third_party_firewall method definition

def associate_third_party_firewall(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
) -> AssociateThirdPartyFirewallResponseTypeDef:  # (2)
    ...

1. See ThirdPartyFirewallType
2. See AssociateThirdPartyFirewallResponseTypeDef

# associate_third_party_firewall method usage example with argument unpacking

kwargs: AssociateThirdPartyFirewallRequestRequestTypeDef = {  # (1)
    "ThirdPartyFirewall": ...,
}

parent.associate_third_party_firewall(**kwargs)

1. See AssociateThirdPartyFirewallRequestRequestTypeDef

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

# batch_associate_resource method definition

def batch_associate_resource(
    self,
    *,
    ResourceSetIdentifier: str,
    Items: Sequence[str],
) -> BatchAssociateResourceResponseTypeDef:  # (1)
    ...

1. See BatchAssociateResourceResponseTypeDef

# batch_associate_resource method usage example with argument unpacking

kwargs: BatchAssociateResourceRequestRequestTypeDef = {  # (1)
    "ResourceSetIdentifier": ...,
    "Items": ...,
}

parent.batch_associate_resource(**kwargs)

1. See BatchAssociateResourceRequestRequestTypeDef

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

# batch_disassociate_resource method definition

def batch_disassociate_resource(
    self,
    *,
    ResourceSetIdentifier: str,
    Items: Sequence[str],
) -> BatchDisassociateResourceResponseTypeDef:  # (1)
    ...

1. See BatchDisassociateResourceResponseTypeDef

# batch_disassociate_resource method usage example with argument unpacking

kwargs: BatchDisassociateResourceRequestRequestTypeDef = {  # (1)
    "ResourceSetIdentifier": ...,
    "Items": ...,
}

parent.batch_disassociate_resource(**kwargs)

1. See BatchDisassociateResourceRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

# can_paginate 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

# close 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

# delete_apps_list method definition

def delete_apps_list(
    self,
    *,
    ListId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_apps_list method usage example with argument unpacking

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

# delete_notification_channel 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

# delete_policy method definition

def delete_policy(
    self,
    *,
    PolicyId: str,
    DeleteAllPolicyResources: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_policy method usage example with argument unpacking

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

# delete_protocols_list method definition

def delete_protocols_list(
    self,
    *,
    ListId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_protocols_list method usage example with argument unpacking

kwargs: DeleteProtocolsListRequestRequestTypeDef = {  # (1)
    "ListId": ...,
}

parent.delete_protocols_list(**kwargs)

1. See DeleteProtocolsListRequestRequestTypeDef

delete_resource_set

Deletes the specified ResourceSet.

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

# delete_resource_set method definition

def delete_resource_set(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_resource_set method usage example with argument unpacking

kwargs: DeleteResourceSetRequestRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_resource_set(**kwargs)

1. See DeleteResourceSetRequestRequestTypeDef

disassociate_admin_account

Disassociates an Firewall Manager administrator account.

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

# disassociate_admin_account 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

# disassociate_third_party_firewall method definition

def disassociate_third_party_firewall(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
) -> DisassociateThirdPartyFirewallResponseTypeDef:  # (2)
    ...

1. See ThirdPartyFirewallType
2. See DisassociateThirdPartyFirewallResponseTypeDef

# disassociate_third_party_firewall method usage example with argument unpacking

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

# generate_presigned_url 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 default administrator.

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

# get_admin_account method definition

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

1. See GetAdminAccountResponseTypeDef

get_admin_scope

Returns information about the specified account's administrative scope.

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

# get_admin_scope method definition

def get_admin_scope(
    self,
    *,
    AdminAccount: str,
) -> GetAdminScopeResponseTypeDef:  # (1)
    ...

1. See GetAdminScopeResponseTypeDef

# get_admin_scope method usage example with argument unpacking

kwargs: GetAdminScopeRequestRequestTypeDef = {  # (1)
    "AdminAccount": ...,
}

parent.get_admin_scope(**kwargs)

1. See GetAdminScopeRequestRequestTypeDef

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.