FMS / Client / put_protocols_list

put_protocols_list#

FMS.Client.put_protocols_list(**kwargs)#

Creates an Firewall Manager protocols list.

See also: AWS API Documentation

Request Syntax

response = client.put_protocols_list(
    ProtocolsList={
        'ListId': 'string',
        'ListName': 'string',
        'ListUpdateToken': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'LastUpdateTime': datetime(2015, 1, 1),
        'ProtocolsList': [
            'string',
        ],
        'PreviousProtocolsList': {
            'string': [
                'string',
            ]
        }
    },
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:
  • ProtocolsList (dict) –

    [REQUIRED]

    The details of the Firewall Manager protocols list to be created.

    • ListId (string) –

      The ID of the Firewall Manager protocols list.

    • ListName (string) – [REQUIRED]

      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) – [REQUIRED]

      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) –

  • TagList (list) –

    The tags associated with the resource.

    • (dict) –

      A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.

      • Key (string) – [REQUIRED]

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

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) –

      The details of the 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 protocols list.

Exceptions

  • FMS.Client.exceptions.ResourceNotFoundException

  • FMS.Client.exceptions.InvalidOperationException

  • FMS.Client.exceptions.InvalidInputException

  • FMS.Client.exceptions.LimitExceededException

  • FMS.Client.exceptions.InternalErrorException