FMS / Client / associate_third_party_firewall

associate_third_party_firewall#

FMS.Client.associate_third_party_firewall(**kwargs)#

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that’s associated with your Amazon Web Services customer account.

See also: AWS API Documentation

Request Syntax

response = client.associate_third_party_firewall(
    ThirdPartyFirewall='PALO_ALTO_NETWORKS_CLOUD_NGFW'|'FORTIGATE_CLOUD_NATIVE_FIREWALL'
)
Parameters:

ThirdPartyFirewall (string) –

[REQUIRED]

The name of the third-party firewall vendor.

Return type:

dict

Returns:

Response Syntax

{
    'ThirdPartyFirewallStatus': 'ONBOARDING'|'ONBOARD_COMPLETE'|'OFFBOARDING'|'OFFBOARD_COMPLETE'|'NOT_EXIST'
}

Response Structure

  • (dict) –

    • ThirdPartyFirewallStatus (string) –

      The current status for setting a Firewall Manager policy administrator’s account as an administrator of the third-party firewall tenant.

      • ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator.

      • ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator.

      • OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.

      • OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator.

      • NOT_EXIST - The Firewall Manager policy administrator doesn’t exist as a tenant administrator.

Exceptions

  • FMS.Client.exceptions.InvalidOperationException

  • FMS.Client.exceptions.InvalidInputException

  • FMS.Client.exceptions.ResourceNotFoundException

  • FMS.Client.exceptions.InternalErrorException