NetworkFirewall / Paginator / ListFlowOperations

ListFlowOperations

class NetworkFirewall.Paginator.ListFlowOperations
paginator = client.get_paginator('list_flow_operations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkFirewall.Client.list_flow_operations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FirewallArn='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    VpcEndpointAssociationArn='string',
    VpcEndpointId='string',
    FlowOperationType='FLOW_FLUSH'|'FLOW_CAPTURE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • FirewallArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the firewall.

  • AvailabilityZone (string) –

    The name 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.

  • AvailabilityZoneId (string) – The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every Amazon Web Services account, so use this parameter when you coordinate resources across accounts. Specify either AvailabilityZone or AvailabilityZoneId, not both. If you specify both, the request fails.

  • VpcEndpointAssociationArn (string) – The Amazon Resource Name (ARN) of a VPC endpoint association.

  • VpcEndpointId (string) – A unique identifier for the primary endpoint associated with a firewall.

  • FlowOperationType (string) – An optional string that defines whether any or all operation types are returned.

  • PaginationConfig (dict) –

    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.

Return type:

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.