aws-sdk-networkfirewall 1.111.0

AWS SDK for AWS Network Firewall
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListFlowOperationResults`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`firewall_arn(impl Into<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::firewall_arn) / [`set_firewall_arn(Option<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::set_firewall_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the firewall.</p><br>
    ///   - [`flow_operation_id(impl Into<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::flow_operation_id) / [`set_flow_operation_id(Option<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::set_flow_operation_id):<br>required: **true**<br><p>A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::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_operation_results::builders::ListFlowOperationResultsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::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>
    ///   - [`availability_zone(impl Into<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::availability_zone) / [`set_availability_zone(Option<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::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_id(impl Into<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::vpc_endpoint_id) / [`set_vpc_endpoint_id(Option<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::set_vpc_endpoint_id):<br>required: **false**<br><p>A unique identifier for the primary endpoint associated with a firewall.</p><br>
    ///   - [`vpc_endpoint_association_arn(impl Into<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::vpc_endpoint_association_arn) / [`set_vpc_endpoint_association_arn(Option<String>)`](crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::set_vpc_endpoint_association_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a VPC endpoint association.</p><br>
    /// - On success, responds with [`ListFlowOperationResultsOutput`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput) with field(s):
    ///   - [`firewall_arn(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::firewall_arn): <p>The Amazon Resource Name (ARN) of the firewall.</p>
    ///   - [`availability_zone(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::availability_zone): <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>
    ///   - [`vpc_endpoint_association_arn(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::vpc_endpoint_association_arn): <p></p>
    ///   - [`vpc_endpoint_id(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::vpc_endpoint_id): <p></p>
    ///   - [`flow_operation_id(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::flow_operation_id): <p>A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.</p>
    ///   - [`flow_operation_status(Option<FlowOperationStatus>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::flow_operation_status): <p>Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.</p> <p>If the status is <code>COMPLETED_WITH_ERRORS</code>, results may be returned with any number of <code>Flows</code> missing from the response. If the status is <code>FAILED</code>, <code>Flows</code> returned will be empty.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::status_message): <p>If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include <code>Flow operation error</code> and <code>Flow timeout</code>.</p>
    ///   - [`flow_request_timestamp(Option<DateTime>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::flow_request_timestamp): <p>A timestamp indicating when the Suricata engine identified flows impacted by an operation.</p>
    ///   - [`flows(Option<Vec::<Flow>>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::flows): <p>Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple <code>Flows</code> arrays are returned.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_flow_operation_results::ListFlowOperationResultsOutput::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<ListFlowOperationResultsError>`](crate::operation::list_flow_operation_results::ListFlowOperationResultsError)
    pub fn list_flow_operation_results(&self) -> crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder {
        crate::operation::list_flow_operation_results::builders::ListFlowOperationResultsFluentBuilder::new(self.handle.clone())
    }
}