EC2 / Client / describe_traffic_mirror_filters

describe_traffic_mirror_filters#

EC2.Client.describe_traffic_mirror_filters(**kwargs)#

Describes one or more Traffic Mirror filters.

See also: AWS API Documentation

Request Syntax

response = client.describe_traffic_mirror_filters(
    TrafficMirrorFilterIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • TrafficMirrorFilterIds (list) –

    The ID of the Traffic Mirror filter.

    • (string) –

  • 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 is UnauthorizedOperation.

  • Filters (list) –

    One or more filters. The possible values are:

    • description: The Traffic Mirror filter description.

    • traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

    • (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

{
    'TrafficMirrorFilters': [
        {
            'TrafficMirrorFilterId': 'string',
            'IngressFilterRules': [
                {
                    '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'
                        },
                    ]
                },
            ],
            'EgressFilterRules': [
                {
                    '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'
                        },
                    ]
                },
            ],
            'NetworkServices': [
                'amazon-dns',
            ],
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TrafficMirrorFilters (list) –

      Information about one or more Traffic Mirror filters.

      • (dict) –

        Describes the Traffic Mirror filter.

        • TrafficMirrorFilterId (string) –

          The ID of the Traffic Mirror filter.

        • IngressFilterRules (list) –

          Information about the ingress rules that are associated with the Traffic Mirror filter.

          • (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.

        • EgressFilterRules (list) –

          Information about the egress rules that are associated with the Traffic Mirror filter.

          • (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.

        • NetworkServices (list) –

          The network service traffic that is associated with the Traffic Mirror filter.

          • (string) –

        • Description (string) –

          The description of the Traffic Mirror filter.

        • Tags (list) –

          The tags assigned to the Traffic Mirror filter.

          • (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.