Class: Aws::NetworkFirewall::Types::DescribeFlowOperationResponse

Inherits:

Struct

• Object
• Struct
• Aws::NetworkFirewall::Types::DescribeFlowOperationResponse

Defined in:

gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone ⇒ String

  The ID of the Availability Zone where the firewall is located.

• #firewall_arn ⇒ String

  The Amazon Resource Name (ARN) of the firewall.

• #flow_operation ⇒ Types::FlowOperation

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

• #flow_operation_id ⇒ String

  A unique identifier for the flow operation.

• #flow_operation_status ⇒ String

  Returns the status of the flow operation.

• #flow_operation_type ⇒ String

  Defines the type of FlowOperation.

• #flow_request_timestamp ⇒ Time

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

• #status_message ⇒ String

  If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure.

• #vpc_endpoint_association_arn ⇒ String

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

• #vpc_endpoint_id ⇒ String

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

Instance Attribute Details

#availability_zone ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#firewall_arn ⇒ String

The Amazon Resource Name (ARN) of the firewall.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#flow_operation ⇒ Types::FlowOperation

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

Returns:

• (Types::FlowOperation)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#flow_operation_id ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#flow_operation_status ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#flow_operation_type ⇒ String

Defines the type of FlowOperation.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#flow_request_timestamp ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_association_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2911

class DescribeFlowOperationResponse < Struct.new(
  :firewall_arn,
  :availability_zone,
  :vpc_endpoint_association_arn,
  :vpc_endpoint_id,
  :flow_operation_id,
  :flow_operation_type,
  :flow_operation_status,
  :status_message,
  :flow_request_timestamp,
  :flow_operation)
  SENSITIVE = []
  include Aws::Structure
end