:doc:`NetworkFirewall <../../network-firewall>` / Paginator / ListFlowOperations

******************
ListFlowOperations
******************



.. py:class:: NetworkFirewall.Paginator.ListFlowOperations

  ::

    
    paginator = client.get_paginator('list_flow_operations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`NetworkFirewall.Client.list_flow_operations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListFlowOperations>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          FirewallArn='string',
          AvailabilityZone='string',
          VpcEndpointAssociationArn='string',
          VpcEndpointId='string',
          FlowOperationType='FLOW_FLUSH'|'FLOW_CAPTURE',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type FirewallArn: string
    :param FirewallArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the firewall.

      

    
    :type AvailabilityZone: string
    :param AvailabilityZone: 

      The ID of the Availability Zone where the firewall is located. For example, ``us-east-2a``.

       

      Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

      

    
    :type VpcEndpointAssociationArn: string
    :param VpcEndpointAssociationArn: 

      The Amazon Resource Name (ARN) of a VPC endpoint association.

      

    
    :type VpcEndpointId: string
    :param VpcEndpointId: 

      A unique identifier for the primary endpoint associated with a firewall.

      

    
    :type FlowOperationType: string
    :param FlowOperationType: 

      An optional string that defines whether any or all operation types are returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'FlowOperations': [
                {
                    'FlowOperationId': 'string',
                    'FlowOperationType': 'FLOW_FLUSH'|'FLOW_CAPTURE',
                    'FlowRequestTimestamp': datetime(2015, 1, 1),
                    'FlowOperationStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED'|'COMPLETED_WITH_ERRORS'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **FlowOperations** *(list) --* 

          Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

           

          A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.

          
          

          - *(dict) --* 

            An array of objects with metadata about the requested ``FlowOperation``.

            
            

            - **FlowOperationId** *(string) --* 

              A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

              
            

            - **FlowOperationType** *(string) --* 

              Defines the type of ``FlowOperation``.

              
            

            - **FlowRequestTimestamp** *(datetime) --* 

              A timestamp indicating when the Suricata engine identified flows impacted by an operation.

              
            

            - **FlowOperationStatus** *(string) --* 

              Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

               

              If the status is ``COMPLETED_WITH_ERRORS``, results may be returned with any number of ``Flows`` missing from the response. If the status is ``FAILED``, ``Flows`` returned will be empty.

              
        
      
    