/AWS1/CL_NWFDESCRFLOWOPRSP¶
DescribeFlowOperationResponse
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_firewallarn
TYPE /AWS1/NWFRESOURCEARN
/AWS1/NWFRESOURCEARN
¶
The Amazon Resource Name (ARN) of the firewall.
iv_availabilityzone
TYPE /AWS1/NWFAVAILABILITYZONE
/AWS1/NWFAVAILABILITYZONE
¶
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.
iv_vpcendpointassociationarn
TYPE /AWS1/NWFRESOURCEARN
/AWS1/NWFRESOURCEARN
¶
The Amazon Resource Name (ARN) of a VPC endpoint association.
iv_vpcendpointid
TYPE /AWS1/NWFVPCENDPOINTID
/AWS1/NWFVPCENDPOINTID
¶
A unique identifier for the primary endpoint associated with a firewall.
iv_flowoperationid
TYPE /AWS1/NWFFLOWOPERATIONID
/AWS1/NWFFLOWOPERATIONID
¶
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
iv_flowoperationtype
TYPE /AWS1/NWFFLOWOPERATIONTYPE
/AWS1/NWFFLOWOPERATIONTYPE
¶
Defines the type of
FlowOperation
.
iv_flowoperationstatus
TYPE /AWS1/NWFFLOWOPERATIONSTATUS
/AWS1/NWFFLOWOPERATIONSTATUS
¶
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 ofFlows
missing from the response. If the status isFAILED
,Flows
returned will be empty.
iv_statusmessage
TYPE /AWS1/NWFSTATUSREASON
/AWS1/NWFSTATUSREASON
¶
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include
Flow operation error
andFlow timeout
.
iv_flowrequesttimestamp
TYPE /AWS1/NWFFLOWREQUESTTIMESTAMP
/AWS1/NWFFLOWREQUESTTIMESTAMP
¶
A timestamp indicating when the Suricata engine identified flows impacted by an operation.
io_flowoperation
TYPE REF TO /AWS1/CL_NWFFLOWOPERATION
/AWS1/CL_NWFFLOWOPERATION
¶
Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.
Queryable Attributes¶
FirewallArn¶
The Amazon Resource Name (ARN) of the firewall.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FIREWALLARN() |
Getter for FIREWALLARN, with configurable default |
ASK_FIREWALLARN() |
Getter for FIREWALLARN w/ exceptions if field has no value |
HAS_FIREWALLARN() |
Determine if FIREWALLARN has a value |
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE, with configurable default |
ASK_AVAILABILITYZONE() |
Getter for AVAILABILITYZONE w/ exceptions if field has no va |
HAS_AVAILABILITYZONE() |
Determine if AVAILABILITYZONE has a value |
VpcEndpointAssociationArn¶
The Amazon Resource Name (ARN) of a VPC endpoint association.
Accessible with the following methods¶
Method | Description |
---|---|
GET_VPCENDPTASSOCIATIONARN() |
Getter for VPCENDPOINTASSOCIATIONARN, with configurable defa |
ASK_VPCENDPTASSOCIATIONARN() |
Getter for VPCENDPOINTASSOCIATIONARN w/ exceptions if field |
HAS_VPCENDPTASSOCIATIONARN() |
Determine if VPCENDPOINTASSOCIATIONARN has a value |
VpcEndpointId¶
A unique identifier for the primary endpoint associated with a firewall.
Accessible with the following methods¶
Method | Description |
---|---|
GET_VPCENDPOINTID() |
Getter for VPCENDPOINTID, with configurable default |
ASK_VPCENDPOINTID() |
Getter for VPCENDPOINTID w/ exceptions if field has no value |
HAS_VPCENDPOINTID() |
Determine if VPCENDPOINTID has a value |
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FLOWOPERATIONID() |
Getter for FLOWOPERATIONID, with configurable default |
ASK_FLOWOPERATIONID() |
Getter for FLOWOPERATIONID w/ exceptions if field has no val |
HAS_FLOWOPERATIONID() |
Determine if FLOWOPERATIONID has a value |
FlowOperationType¶
Defines the type of
FlowOperation
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FLOWOPERATIONTYPE() |
Getter for FLOWOPERATIONTYPE, with configurable default |
ASK_FLOWOPERATIONTYPE() |
Getter for FLOWOPERATIONTYPE w/ exceptions if field has no v |
HAS_FLOWOPERATIONTYPE() |
Determine if FLOWOPERATIONTYPE has a value |
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 ofFlows
missing from the response. If the status isFAILED
,Flows
returned will be empty.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FLOWOPERATIONSTATUS() |
Getter for FLOWOPERATIONSTATUS, with configurable default |
ASK_FLOWOPERATIONSTATUS() |
Getter for FLOWOPERATIONSTATUS w/ exceptions if field has no |
HAS_FLOWOPERATIONSTATUS() |
Determine if FLOWOPERATIONSTATUS has a value |
StatusMessage¶
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include
Flow operation error
andFlow timeout
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATUSMESSAGE() |
Getter for STATUSMESSAGE, with configurable default |
ASK_STATUSMESSAGE() |
Getter for STATUSMESSAGE w/ exceptions if field has no value |
HAS_STATUSMESSAGE() |
Determine if STATUSMESSAGE has a value |
FlowRequestTimestamp¶
A timestamp indicating when the Suricata engine identified flows impacted by an operation.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FLOWREQUESTTIMESTAMP() |
Getter for FLOWREQUESTTIMESTAMP, with configurable default |
ASK_FLOWREQUESTTIMESTAMP() |
Getter for FLOWREQUESTTIMESTAMP w/ exceptions if field has n |
HAS_FLOWREQUESTTIMESTAMP() |
Determine if FLOWREQUESTTIMESTAMP has a value |
FlowOperation¶
Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FLOWOPERATION() |
Getter for FLOWOPERATION |