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

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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

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

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. boto3 documentation

# get_apps_list method definition

def get_apps_list(
    self,
    *,
    ListId: str,
    DefaultList: bool = ...,
) -> GetAppsListResponseTypeDef:  # (1)
    ...

1. See GetAppsListResponseTypeDef

# get_apps_list method usage example with argument unpacking

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

# get_compliance_detail method definition

def get_compliance_detail(
    self,
    *,
    PolicyId: str,
    MemberAccount: str,
) -> GetComplianceDetailResponseTypeDef:  # (1)
    ...

1. See GetComplianceDetailResponseTypeDef

# get_compliance_detail method usage example with argument unpacking

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

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

# get_policy method definition

def get_policy(
    self,
    *,
    PolicyId: str,
) -> GetPolicyResponseTypeDef:  # (1)
    ...

1. See GetPolicyResponseTypeDef

# get_policy method usage example with argument unpacking

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

# get_protection_status method definition

def get_protection_status(
    self,
    *,
    PolicyId: str,
    MemberAccountId: str = ...,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetProtectionStatusResponseTypeDef:  # (1)
    ...

1. See GetProtectionStatusResponseTypeDef

# get_protection_status method usage example with argument unpacking

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

# get_protocols_list method definition

def get_protocols_list(
    self,
    *,
    ListId: str,
    DefaultList: bool = ...,
) -> GetProtocolsListResponseTypeDef:  # (1)
    ...

1. See GetProtocolsListResponseTypeDef

# get_protocols_list method usage example with argument unpacking

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

parent.get_protocols_list(**kwargs)

1. See GetProtocolsListRequestRequestTypeDef

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

# get_resource_set method definition

def get_resource_set(
    self,
    *,
    Identifier: str,
) -> GetResourceSetResponseTypeDef:  # (1)
    ...

1. See GetResourceSetResponseTypeDef

# get_resource_set method usage example with argument unpacking

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

parent.get_resource_set(**kwargs)

1. See GetResourceSetRequestRequestTypeDef

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

# get_third_party_firewall_association_status method definition

def get_third_party_firewall_association_status(
    self,
    *,
    ThirdPartyFirewall: ThirdPartyFirewallType,  # (1)
) -> GetThirdPartyFirewallAssociationStatusResponseTypeDef:  # (2)
    ...

1. See ThirdPartyFirewallType
2. See GetThirdPartyFirewallAssociationStatusResponseTypeDef

# get_third_party_firewall_association_status method usage example with argument unpacking

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

# get_violation_details method definition

def get_violation_details(
    self,
    *,
    PolicyId: str,
    MemberAccount: str,
    ResourceId: str,
    ResourceType: str,
) -> GetViolationDetailsResponseTypeDef:  # (1)
    ...

1. See GetViolationDetailsResponseTypeDef

# get_violation_details method usage example with argument unpacking

kwargs: GetViolationDetailsRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
    "MemberAccount": ...,
    "ResourceId": ...,
    "ResourceType": ...,
}

parent.get_violation_details(**kwargs)

1. See GetViolationDetailsRequestRequestTypeDef

list_admin_accounts_for_organization

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.

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

# list_admin_accounts_for_organization method definition

def list_admin_accounts_for_organization(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAdminAccountsForOrganizationResponseTypeDef:  # (1)
    ...

1. See ListAdminAccountsForOrganizationResponseTypeDef

# list_admin_accounts_for_organization method usage example with argument unpacking

kwargs: ListAdminAccountsForOrganizationRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_admin_accounts_for_organization(**kwargs)

1. See ListAdminAccountsForOrganizationRequestRequestTypeDef

list_admins_managing_account

Lists the accounts that are managing the specified Organizations member account.

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

# list_admins_managing_account method definition

def list_admins_managing_account(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAdminsManagingAccountResponseTypeDef:  # (1)
    ...

1. See ListAdminsManagingAccountResponseTypeDef

# list_admins_managing_account method usage example with argument unpacking

kwargs: ListAdminsManagingAccountRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_admins_managing_account(**kwargs)

1. See ListAdminsManagingAccountRequestRequestTypeDef

list_apps_lists

Returns an array of AppsListDataSummary objects.

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

# list_apps_lists method definition

def list_apps_lists(
    self,
    *,
    MaxResults: int,
    DefaultLists: bool = ...,
    NextToken: str = ...,
) -> ListAppsListsResponseTypeDef:  # (1)
    ...

1. See ListAppsListsResponseTypeDef

# list_apps_lists method usage example with argument unpacking

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

# list_compliance_status method definition

def list_compliance_status(
    self,
    *,
    PolicyId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListComplianceStatusResponseTypeDef:  # (1)
    ...

1. See ListComplianceStatusResponseTypeDef

# list_compliance_status method usage example with argument unpacking

kwargs: ListComplianceStatusRequestRequestTypeDef = {  # (1)
    "PolicyId": ...,
}

parent.list_compliance_status(**kwargs)

1. See ListComplianceStatusRequestRequestTypeDef

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

# list_discovered_resources method definition

def list_discovered_resources(
    self,
    *,
    MemberAccountIds: Sequence[str],
    ResourceType: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDiscoveredResourcesResponseTypeDef:  # (1)
    ...

1. See ListDiscoveredResourcesResponseTypeDef

# list_discovered_resources method usage example with argument unpacking

kwargs: ListDiscoveredResourcesRequestRequestTypeDef = {  # (1)
    "MemberAccountIds": ...,
    "ResourceType": ...,
}

parent.list_discovered_resources(**kwargs)

1. See ListDiscoveredResourcesRequestRequestTypeDef

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

# list_member_accounts method definition

def list_member_accounts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMemberAccountsResponseTypeDef:  # (1)
    ...

1. See ListMemberAccountsResponseTypeDef

# list_member_accounts method usage example with argument unpacking

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

# list_policies method definition

def list_policies(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPoliciesResponseTypeDef:  # (1)
    ...

1. See ListPoliciesResponseTypeDef

# list_policies method usage example with argument unpacking

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

# list_protocols_lists method definition

def list_protocols_lists(
    self,
    *,
    MaxResults: int,
    DefaultLists: bool = ...,
    NextToken: str = ...,
) -> ListProtocolsListsResponseTypeDef:  # (1)
    ...

1. See ListProtocolsListsResponseTypeDef

# list_protocols_lists method usage example with argument unpacking

kwargs: ListProtocolsListsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_protocols_lists(**kwargs)

1. See ListProtocolsListsRequestRequestTypeDef

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

# list_resource_set_resources method definition

def list_resource_set_resources(
    self,
    *,
    Identifier: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourceSetResourcesResponseTypeDef:  # (1)
    ...

1. See ListResourceSetResourcesResponseTypeDef

# list_resource_set_resources method usage example with argument unpacking

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

parent.list_resource_set_resources(**kwargs)

1. See ListResourceSetResourcesRequestRequestTypeDef

list_resource_sets

Returns an array of ResourceSetSummary objects.

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

# list_resource_sets method definition

def list_resource_sets(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceSetsResponseTypeDef:  # (1)
    ...

1. See ListResourceSetsResponseTypeDef

# list_resource_sets method usage example with argument unpacking

kwargs: ListResourceSetsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_resource_sets(**kwargs)

1. See ListResourceSetsRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

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

# list_third_party_firewall_firewall_policies method usage example with argument unpacking

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

parent.list_third_party_firewall_firewall_policies(**kwargs)

1. See ListThirdPartyFirewallFirewallPoliciesRequestRequestTypeDef

put_admin_account

Creates or updates an Firewall Manager administrator account.

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

# put_admin_account method definition

def put_admin_account(
    self,
    *,
    AdminAccount: str,
    AdminScope: AdminScopeTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See AdminScopeTypeDef
2. See EmptyResponseMetadataTypeDef

# put_admin_account method usage example with argument unpacking

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

parent.put_admin_account(**kwargs)

1. See PutAdminAccountRequestRequestTypeDef

put_apps_list

Creates an Firewall Manager applications list.

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

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

# put_apps_list method usage example with argument unpacking

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

# put_notification_channel method definition

def put_notification_channel(
    self,
    *,
    SnsTopicArn: str,
    SnsRoleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# put_notification_channel method usage example with argument unpacking

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

# put_policy method definition

def put_policy(
    self,
    *,
    Policy: PolicyTypeDef,  # (1)
    TagList: Sequence[TagTypeDef] = ...,  # (2)
) -> PutPolicyResponseTypeDef:  # (3)
    ...

1. See PolicyTypeDef
2. See TagTypeDef
3. See PutPolicyResponseTypeDef

# put_policy method usage example with argument unpacking

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

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

# put_protocols_list method usage example with argument unpacking

kwargs: PutProtocolsListRequestRequestTypeDef = {  # (1)
    "ProtocolsList": ...,
}

parent.put_protocols_list(**kwargs)

1. See PutProtocolsListRequestRequestTypeDef

put_resource_set

Creates the resource set.

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

# put_resource_set method definition

def put_resource_set(
    self,
    *,
    ResourceSet: ResourceSetTypeDef,  # (1)
    TagList: Sequence[TagTypeDef] = ...,  # (2)
) -> PutResourceSetResponseTypeDef:  # (3)
    ...

1. See ResourceSetTypeDef
2. See TagTypeDef
3. See PutResourceSetResponseTypeDef

# put_resource_set method usage example with argument unpacking

kwargs: PutResourceSetRequestRequestTypeDef = {  # (1)
    "ResourceSet": ...,
}

parent.put_resource_set(**kwargs)

1. See PutResourceSetRequestRequestTypeDef

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    TagList: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

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.

• client.get_paginator("list_admin_accounts_for_organization") -> ListAdminAccountsForOrganizationPaginator
• client.get_paginator("list_admins_managing_account") -> ListAdminsManagingAccountPaginator
• client.get_paginator("list_apps_lists") -> ListAppsListsPaginator
• client.get_paginator("list_compliance_status") -> ListComplianceStatusPaginator
• client.get_paginator("list_member_accounts") -> ListMemberAccountsPaginator
• client.get_paginator("list_policies") -> ListPoliciesPaginator
• client.get_paginator("list_protocols_lists") -> ListProtocolsListsPaginator
• client.get_paginator("list_third_party_firewall_firewall_policies") -> ListThirdPartyFirewallFirewallPoliciesPaginator