FMS / Paginator / ListAppsLists

ListAppsLists

class FMS.Paginator.ListAppsLists

paginator = client.get_paginator('list_apps_lists')

paginate(**kwargs)

Creates an iterator that will paginate through responses from FMS.Client.list_apps_lists().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DefaultLists=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AppsLists': [
        {
            'ListArn': 'string',
            'ListId': 'string',
            'ListName': 'string',
            'AppsList': [
                {
                    'AppName': 'string',
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • AppsLists (list) –

    An array of AppsListDataSummary objects.

    • (dict) –

      Details of the Firewall Manager applications list.

      • ListArn (string) –

        The Amazon Resource Name (ARN) of the applications list.

      • ListId (string) –

        The ID of the applications list.

      • ListName (string) –

        The name of the applications list.

      • AppsList (list) –

        An array of App objects in the Firewall Manager applications list.

        • (dict) –

          An individual Firewall Manager application.

          • AppName (string) –

            The application’s name.

          • Protocol (string) –

            The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

          • Port (integer) –

            The application’s port number, for example 80.