AssociateThirdPartyFirewall - AWS Firewall Manager

AssociateThirdPartyFirewall

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 AWS customer account.

Request Syntax

{ "ThirdPartyFirewall": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ThirdPartyFirewall

The name of the third-party firewall vendor.

Type: String

Valid Values: PALO_ALTO_NETWORKS_CLOUD_NGFW

Required: Yes

Response Syntax

{ "ThirdPartyFirewallStatus": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ThirdPartyFirewallStatus

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.

Type: String

Valid Values: ONBOARDING | ONBOARD_COMPLETE | OFFBOARDING | OFFBOARD_COMPLETE | NOT_EXIST

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

The operation failed because of a system problem, even though the request was valid. Retry your request.

HTTP Status Code: 400

InvalidInputException

The parameters of the request were invalid.

HTTP Status Code: 400

InvalidOperationException

The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for AWS Organizations before you can access it.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: