FMS / Client / get_protocols_list

get_protocols_list#

FMS.Client.get_protocols_list(**kwargs)#

Returns information about the specified Firewall Manager protocols list.

See also: AWS API Documentation

Request Syntax

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

  • ListId (string) –

    [REQUIRED]

    The ID of the Firewall Manager protocols 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

{
    'ProtocolsList': {
        'ListId': 'string',
        'ListName': 'string',
        'ListUpdateToken': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'LastUpdateTime': datetime(2015, 1, 1),
        'ProtocolsList': [
            'string',
        ],
        'PreviousProtocolsList': {
            'string': [
                'string',
            ]
        }
    },
    'ProtocolsListArn': 'string'
}

Response Structure

  • (dict) –

    • ProtocolsList (dict) –

      Information about the specified Firewall Manager protocols list.

      • ListId (string) –

        The ID of the Firewall Manager protocols list.

      • ListName (string) –

        The name of the Firewall Manager protocols 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 protocols list was created.

      • LastUpdateTime (datetime) –

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

      • ProtocolsList (list) –

        An array of protocols in the Firewall Manager protocols list.

        • (string) –

      • PreviousProtocolsList (dict) –

        A map of previous version numbers to their corresponding protocol arrays.

        • (string) –

          • (list) –

            • (string) –

    • ProtocolsListArn (string) –

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

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException

  • FMS.Client.exceptions.InvalidOperationException

  • FMS.Client.exceptions.InternalErrorException