FMS / Client / get_third_party_firewall_association_status

get_third_party_firewall_association_status#

FMS.Client.get_third_party_firewall_association_status(**kwargs)#

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

See also: AWS API Documentation

Request Syntax

response = client.get_third_party_firewall_association_status(
    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',
    'MarketplaceOnboardingStatus': 'NO_SUBSCRIPTION'|'NOT_COMPLETE'|'COMPLETE'
}

Response Structure

  • (dict) –

    • ThirdPartyFirewallStatus (string) –

      The current status for setting a Firewall Manager policy administrators 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.

    • MarketplaceOnboardingStatus (string) –

      The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.

      • NO_SUBSCRIPTION - The Firewall Manager policy administrator isn’t subscribed to the third-party firewall service in the Amazon Web Services Marketplace.

      • NOT_COMPLETE - The Firewall Manager policy administrator is in the process of subscribing to the third-party firewall service in the Amazon Web Services Marketplace, but doesn’t yet have an active subscription.

      • COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.

Exceptions

  • FMS.Client.exceptions.InvalidOperationException

  • FMS.Client.exceptions.InvalidInputException

  • FMS.Client.exceptions.ResourceNotFoundException

  • FMS.Client.exceptions.InternalErrorException