Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeFlowOperation

Returns key information about a specific flow operation.

Request Syntax


{
   "AvailabilityZone": "string",
   "AvailabilityZoneId": "string",
   "FirewallArn": "string",
   "FlowOperationId": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AvailabilityZone

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.

Type: String

Required: No

AvailabilityZoneId

The ID of the Availability Zone where the firewall is located. For example, use2-az1. Availability Zone IDs are the same in every AWS 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.

Type: String

Required: No

FirewallArn

The Amazon Resource Name (ARN) of the firewall.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

Required: Yes

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.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Required: Yes

VpcEndpointAssociationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

Required: No

VpcEndpointId

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

Type: String

Length Constraints: Minimum length of 5. Maximum length of 256.

Pattern: ^vpce-[a-zA-Z0-9]*$

Required: No

Response Syntax


{
   "AvailabilityZone": "string",
   "AvailabilityZoneId": "string",
   "FirewallArn": "string",
   "FlowOperation": { 
      "FlowFilters": [ 
         { 
            "DestinationAddress": { 
               "AddressDefinition": "string"
            },
            "DestinationPort": "string",
            "Protocols": [ "string" ],
            "SourceAddress": { 
               "AddressDefinition": "string"
            },
            "SourcePort": "string"
         }
      ],
      "MinimumFlowAgeInSeconds": number
   },
   "FlowOperationId": "string",
   "FlowOperationStatus": "string",
   "FlowOperationType": "string",
   "FlowRequestTimestamp": number,
   "StatusMessage": "string",
   "VpcEndpointAssociationArn": "string",
   "VpcEndpointId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AvailabilityZone

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.

Type: String

AvailabilityZoneId

The ID of the Availability Zone where the firewall is located. For example, use2-az1.

Type: String

FirewallArn

The Amazon Resource Name (ARN) of the firewall.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

FlowOperation

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

Type: FlowOperation object

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.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

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.

Type: String

Valid Values: COMPLETED | IN_PROGRESS | FAILED | COMPLETED_WITH_ERRORS

FlowOperationType

Defines the type of FlowOperation.

Type: String

Valid Values: FLOW_FLUSH | FLOW_CAPTURE

FlowRequestTimestamp

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

Type: Timestamp

StatusMessage

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9- ]+$

VpcEndpointAssociationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

VpcEndpointId

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

Type: String

Length Constraints: Minimum length of 5. Maximum length of 256.

Pattern: ^vpce-[a-zA-Z0-9]*$

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerError

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The operation failed because of a problem with your request. Examples include:

You specified an unsupported parameter name or value.
You tried to update a property with a value that isn't among the available types.
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

HTTP Status Code: 400

ResourceNotFoundException

Unable to locate a resource using the parameters that you provided.

HTTP Status Code: 400

ThrottlingException

Unable to process the request due to throttling limitations.

HTTP Status Code: 400