Skip to content

DescribeFlowOperationResponse

Source code in docs_src/capo_network_firewall/types/describe_flow_operation_response.py
class DescribeFlowOperationResponse(TypedDict, closed=True):
    firewall_arn: NotRequired["capo_network_firewall.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the firewall.</p>"""
    availability_zone: NotRequired[
        "capo_network_firewall.types.availability_zone.AvailabilityZone"
    ]
    """<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: NotRequired[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of a VPC endpoint association.</p>"""
    vpc_endpoint_id: NotRequired[
        "capo_network_firewall.types.vpc_endpoint_id.VpcEndpointId"
    ]
    """<p>A unique identifier for the primary endpoint associated with a firewall.</p>"""
    flow_operation_id: NotRequired[
        "capo_network_firewall.types.flow_operation_id.FlowOperationId"
    ]
    """<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_type: NotRequired[
        "capo_network_firewall.types.flow_operation_type.FlowOperationType"
    ]
    """<p>Defines the type of <code>FlowOperation</code>.</p>"""
    flow_operation_status: NotRequired[
        "capo_network_firewall.types.flow_operation_status.FlowOperationStatus"
    ]
    """<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: NotRequired[
        "capo_network_firewall.types.status_reason.StatusReason"
    ]
    """<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: NotRequired[
        "capo_network_firewall.types.flow_request_timestamp.FlowRequestTimestamp"
    ]
    """<p>A timestamp indicating when the Suricata engine identified flows impacted by an operation. </p>"""
    flow_operation: NotRequired[
        "capo_network_firewall.types.flow_operation.FlowOperation"
    ]
    """<p>Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[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.

firewall_arn instance-attribute

firewall_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the firewall.

flow_operation instance-attribute

flow_operation: NotRequired[FlowOperation]

Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.

flow_operation_id instance-attribute

flow_operation_id: NotRequired[FlowOperationId]

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

flow_operation_status instance-attribute

flow_operation_status: NotRequired[FlowOperationStatus]

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.

flow_operation_type instance-attribute

flow_operation_type: NotRequired[FlowOperationType]

Defines the type of FlowOperation.

flow_request_timestamp instance-attribute

flow_request_timestamp: NotRequired[FlowRequestTimestamp]

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

status_message instance-attribute

status_message: NotRequired[StatusReason]

If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.

vpc_endpoint_association_arn instance-attribute

vpc_endpoint_association_arn: NotRequired[ResourceArn]

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

vpc_endpoint_id instance-attribute

vpc_endpoint_id: NotRequired[VpcEndpointId]

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