FMS / Client / list_protocols_lists

list_protocols_lists#

FMS.Client.list_protocols_lists(**kwargs)#

Returns an array of ProtocolsListDataSummary objects.

See also: AWS API Documentation

Request Syntax

response = client.list_protocols_lists(
    DefaultLists=True|False,
    NextToken='string',
    MaxResults=123
)
Parameters:

  • DefaultLists (boolean) – Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

  • NextToken (string) – If you specify a value for MaxResults in your list request, and you have more objects than the maximum, 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.

  • MaxResults (integer) –

    [REQUIRED]

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, 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, Firewall Manager returns all available objects.

Return type:

dict

Returns:

Response Syntax

{
    'ProtocolsLists': [
        {
            'ListArn': 'string',
            'ListId': 'string',
            'ListName': 'string',
            'ProtocolsList': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ProtocolsLists (list) –

      An array of ProtocolsListDataSummary objects.

      • (dict) –

        Details of the Firewall Manager protocols list.

        • ListArn (string) –

          The Amazon Resource Name (ARN) of the specified protocols list.

        • ListId (string) –

          The ID of the specified protocols list.

        • ListName (string) –

          The name of the specified protocols list.

        • ProtocolsList (list) –

          An array of protocols in the Firewall Manager protocols list.

          • (string) –

    • NextToken (string) –

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

Exceptions