FMS / Client / get_apps_list

get_apps_list#

FMS.Client.get_apps_list(**kwargs)#

Returns information about the specified Firewall Manager applications list.

See also: AWS API Documentation

Request Syntax

response = client.get_apps_list(
    ListId='string',
    DefaultList=True|False
)
Parameters:

  • ListId (string) –

    [REQUIRED]

    The ID of the Firewall Manager applications list that you want the details for.

  • DefaultList (boolean) – Specifies whether the list to retrieve is a default list owned by Firewall Manager.

Return type:

dict

Returns:

Response Syntax

{
    'AppsList': {
        'ListId': 'string',
        'ListName': 'string',
        'ListUpdateToken': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'LastUpdateTime': datetime(2015, 1, 1),
        'AppsList': [
            {
                'AppName': 'string',
                'Protocol': 'string',
                'Port': 123
            },
        ],
        'PreviousAppsList': {
            'string': [
                {
                    'AppName': 'string',
                    'Protocol': 'string',
                    'Port': 123
                },
            ]
        }
    },
    'AppsListArn': 'string'
}

Response Structure

  • (dict) –

    • AppsList (dict) –

      Information about the specified Firewall Manager applications list.

      • ListId (string) –

        The ID of the Firewall Manager applications list.

      • ListName (string) –

        The name of the Firewall Manager applications list.

      • ListUpdateToken (string) –

        A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

      • CreateTime (datetime) –

        The time that the Firewall Manager applications list was created.

      • LastUpdateTime (datetime) –

        The time that the Firewall Manager applications list was last updated.

      • AppsList (list) –

        An array of applications 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.

      • PreviousAppsList (dict) –

        A map of previous version numbers to their corresponding App object arrays.

        • (string) –

          • (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.

    • AppsListArn (string) –

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

Exceptions