aws_sdk_networkfirewall/client/

list_flow_operations.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListFlowOperations`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`firewall_arn(impl Into<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::firewall_arn) / [`set_firewall_arn(Option<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_firewall_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the firewall.</p><br>
    ///   - [`availability_zone(impl Into<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::availability_zone) / [`set_availability_zone(Option<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_availability_zone):<br>required: **false**<br><p>The ID of the Availability Zone where the firewall is located. For example, <code>us-east-2a</code>.</p> <p>Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.</p><br>
    ///   - [`vpc_endpoint_association_arn(impl Into<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::vpc_endpoint_association_arn) / [`set_vpc_endpoint_association_arn(Option<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_vpc_endpoint_association_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a VPC endpoint association.</p><br>
    ///   - [`vpc_endpoint_id(impl Into<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::vpc_endpoint_id) / [`set_vpc_endpoint_id(Option<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_vpc_endpoint_id):<br>required: **false**<br><p>A unique identifier for the primary endpoint associated with a firewall.</p><br>
    ///   - [`flow_operation_type(FlowOperationType)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::flow_operation_type) / [`set_flow_operation_type(Option<FlowOperationType>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_flow_operation_type):<br>required: **false**<br><p>An optional string that defines whether any or all operation types are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_next_token):<br>required: **false**<br><p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p><br>
    /// - On success, responds with [`ListFlowOperationsOutput`](crate::operation::list_flow_operations::ListFlowOperationsOutput) with field(s):
    ///   - [`flow_operations(Option<Vec::<FlowOperationMetadata>>)`](crate::operation::list_flow_operations::ListFlowOperationsOutput::flow_operations): <p>Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.</p> <p>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.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_flow_operations::ListFlowOperationsOutput::next_token): <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
    /// - On failure, responds with [`SdkError<ListFlowOperationsError>`](crate::operation::list_flow_operations::ListFlowOperationsError)
    pub fn list_flow_operations(&self) -> crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder {
        crate::operation::list_flow_operations::builders::ListFlowOperationsFluentBuilder::new(self.handle.clone())
    }
}