EC2 / Client / describe_traffic_mirror_filter_rules
describe_traffic_mirror_filter_rules#
- EC2.Client.describe_traffic_mirror_filter_rules(**kwargs)#
Describe traffic mirror filters that determine the traffic that is mirrored.
See also: AWS API Documentation
Request Syntax
response = client.describe_traffic_mirror_filter_rules( TrafficMirrorFilterRuleIds=[ 'string', ], TrafficMirrorFilterId='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' )
- Parameters:
TrafficMirrorFilterRuleIds (list) –
Traffic filter rule IDs.
(string) –
TrafficMirrorFilterId (string) – Traffic filter ID.
DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.Filters (list) –
Traffic mirror filters.
traffic-mirror-filter-rule-id
: The ID of the Traffic Mirror rule.traffic-mirror-filter-id
: The ID of the filter that this rule is associated with.rule-number
: The number of the Traffic Mirror rule.rule-action
: The action taken on the filtered traffic. Possible actions areaccept
andreject
.traffic-direction
: The traffic direction. Possible directions areingress
andegress
.protocol
: The protocol, for example UDP, assigned to the Traffic Mirror rule.source-cidr-block
: The source CIDR block assigned to the Traffic Mirror rule.destination-cidr-block
: The destination CIDR block assigned to the Traffic Mirror rule.description
: The description of the Traffic Mirror rule.
(dict) –
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an
AND
, and the request returns only results that match all of the specified filters.Name (string) –
The name of the filter. Filter names are case-sensitive.
Values (list) –
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an
OR
, and the request returns all results that match any of the specified values.(string) –
MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.NextToken (string) – The token for the next page of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'TrafficMirrorFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' }
Response Structure
(dict) –
TrafficMirrorFilterRules (list) –
Traffic mirror rules.
(dict) –
Describes the Traffic Mirror rule.
TrafficMirrorFilterRuleId (string) –
The ID of the Traffic Mirror rule.
TrafficMirrorFilterId (string) –
The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection (string) –
The traffic direction assigned to the Traffic Mirror rule.
RuleNumber (integer) –
The rule number of the Traffic Mirror rule.
RuleAction (string) –
The action assigned to the Traffic Mirror rule.
Protocol (integer) –
The protocol assigned to the Traffic Mirror rule.
DestinationPortRange (dict) –
The destination port range assigned to the Traffic Mirror rule.
FromPort (integer) –
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) –
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
SourcePortRange (dict) –
The source port range assigned to the Traffic Mirror rule.
FromPort (integer) –
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort (integer) –
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
DestinationCidrBlock (string) –
The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock (string) –
The source CIDR block assigned to the Traffic Mirror rule.
Description (string) –
The description of the Traffic Mirror rule.
Tags (list) –
Tags on Traffic Mirroring filter rules.
(dict) –
Describes a tag.
Key (string) –
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:
.Value (string) –
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
NextToken (string) –
The token to use to retrieve the next page of results. The value is
null
when there are no more results to return.