Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListProtocolsLists

Returns an array of ProtocolsListDataSummary objects.

Request Syntax


{
   "DefaultLists": boolean,
   "MaxResults": number,
   "NextToken": "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.

DefaultLists

Specifies whether the lists to retrieve are default lists owned by Amazon Firewall Manager.

Type: Boolean

Required: No

MaxResults

The maximum number of objects that you want Amazon Firewall Manager to return for this request. If more objects are available, in the response, Amazon Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify this, Amazon Firewall Manager returns all available objects.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: Yes

NextToken

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Amazon Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

Response Syntax


{
   "NextToken": "string",
   "ProtocolsLists": [ 
      { 
         "ListArn": "string",
         "ListId": "string",
         "ListName": "string",
         "ProtocolsList": [ "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

If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Amazon Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

ProtocolsLists

An array of ProtocolsListDataSummary objects.

Type: Array of ProtocolsListDataSummary 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

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 Amazon 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 Amazon Organizations before you can access it.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400