FMS / Client / put_apps_list

put_apps_list#

FMS.Client.put_apps_list(**kwargs)#

Creates an Firewall Manager applications list.

Request Syntax

response = client.put_apps_list(
    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
                },
            ]
        }
    },
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

AppsList (dict) –
[REQUIRED]

The details of the Firewall Manager applications list to be created.
- ListId (string) –
  
  The ID of the Firewall Manager applications list.
- ListName (string) – [REQUIRED]
  
  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) – [REQUIRED]
  
  An array of applications in the Firewall Manager applications list.
  - (dict) –
    
    An individual Firewall Manager application.
    - AppName (string) – [REQUIRED]
      
      The application’s name.
    - Protocol (string) – [REQUIRED]
      
      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) – [REQUIRED]
      
      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) – [REQUIRED]
        
        The application’s name.
        
        Protocol (string) – [REQUIRED]
        
        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) – [REQUIRED]
        
        The application’s port number, for example 80.
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

{
    '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) –
  
  The details of the 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

FMS.Client.exceptions.ResourceNotFoundException
FMS.Client.exceptions.InvalidOperationException
FMS.Client.exceptions.InvalidInputException
FMS.Client.exceptions.LimitExceededException
FMS.Client.exceptions.InternalErrorException