AWS CLI Command Reference

[ aws . ec2 ]

describe-traffic-mirror-filter-rules

Description

Describe traffic mirror filters that determine the traffic that is mirrored.

See also: AWS API Documentation

Synopsis

  describe-traffic-mirror-filter-rules
[--traffic-mirror-filter-rule-ids <value>]
[--traffic-mirror-filter-id <value>]
[--dry-run | --no-dry-run]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--traffic-mirror-filter-rule-ids (list)

Traffic filter rule IDs.

(string)

Syntax:

"string" "string" ...

--traffic-mirror-filter-id (string)

Traffic filter ID.

--dry-run | --no-dry-run (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 is UnauthorizedOperation .

--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 are accept and reject .
  • traffic-direction : The traffic direction. Possible directions are ingress and egress .
  • 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.

(structure)

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)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--max-results (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.

--next-token (string)

The token for the next page of results.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

TrafficMirrorFilterRules -> (list)

Traffic mirror rules.

(structure)

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 -> (structure)

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 -> (structure)

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.

(structure)

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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.