ListThirdPartyFirewallFirewallPolicies
Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"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.
- MaxResults
-
The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than
MaxResults
firewall policies, the response includes aNextToken
element.NextToken
contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: Yes
- NextToken
-
If the previous response included a
NextToken
element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit anotherListThirdPartyFirewallFirewallPoliciesRequest
request.For the value of
NextToken
, specify the value ofNextToken
from the previous response. If the previous response didn't include aNextToken
element, there are no more third-party firewall policies to get.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: No
- ThirdPartyFirewall
-
The name of the third-party firewall vendor.
Type: String
Valid Values:
PALO_ALTO_NETWORKS_CLOUD_NGFW | FORTIGATE_CLOUD_NATIVE_FIREWALL
Required: Yes
Response Syntax
{
"NextToken": "string",
"ThirdPartyFirewallFirewallPolicies": [
{
"FirewallPolicyId": "string",
"FirewallPolicyName": "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.
- NextToken
-
The value that you will use for
NextToken
in the nextListThirdPartyFirewallFirewallPolicies
request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
- ThirdPartyFirewallFirewallPolicies
-
A list that contains one
ThirdPartyFirewallFirewallPolicies
element for each third-party firewall policies that the specified third-party firewall vendor is associated with. EachThirdPartyFirewallFirewallPolicies
element contains the firewall policy name and ID.Type: Array of ThirdPartyFirewallFirewallPolicy objects
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: