Amazon EC2 Ec2 Traffic Mirror Filter Rule API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Traffic Mirror Filter Rule API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Traffic Mirror Filter Rule
paths:
  /?Action=CreateTrafficMirrorFilterRule:
    post:
      operationId: CreateTrafficMirrorFilterRule
      summary: Create Traffic Mirror Filter Rule
      description: Creates a Traffic Mirror filter rule. A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror. You need the Traffic Mirror filter ID when you create the rule.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTrafficMirrorFilterRule
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleRequest'
      tags:
      - Traffic Mirror Filter Rule
  /?Action=DeleteTrafficMirrorFilterRule:
    post:
      operationId: DeleteTrafficMirrorFilterRule
      summary: Delete Traffic Mirror Filter Rule
      description: Deletes the specified Traffic Mirror rule.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTrafficMirrorFilterRule
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleRequest'
      tags:
      - Traffic Mirror Filter Rule
  /?Action=DescribeTrafficMirrorFilterRules:
    post:
      operationId: DescribeTrafficMirrorFilterRules
      summary: Describe Traffic Mirror Filter Rules
      description: Describe traffic mirror filters that determine the traffic that is mirrored.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTrafficMirrorFilterRulesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTrafficMirrorFilterRules
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTrafficMirrorFilterRulesRequest'
      tags:
      - Traffic Mirror Filter Rule
  /?Action=ModifyTrafficMirrorFilterRule:
    post:
      operationId: ModifyTrafficMirrorFilterRule
      summary: Modify Traffic Mirror Filter Rule
      description: Modifies the specified Traffic Mirror rule. DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyTrafficMirrorFilterRuleResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyTrafficMirrorFilterRule
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyTrafficMirrorFilterRuleRequest'
      tags:
      - Traffic Mirror Filter Rule
components:
  schemas:
    TrafficMirrorFilterRule:
      type: object
      properties:
        TrafficMirrorFilterRuleId:
          type: string
          description: The ID of the Traffic Mirror rule.
        TrafficMirrorFilterId:
          type: string
          description: The ID of the Traffic Mirror filter that the rule is associated with.
        TrafficDirection:
          type: string
          enum:
          - ingress
          - egress
          description: The traffic direction assigned to the Traffic Mirror rule.
        RuleNumber:
          type: integer
          description: The rule number of the Traffic Mirror rule.
        RuleAction:
          type: string
          enum:
          - accept
          - reject
          description: The action assigned to the Traffic Mirror rule.
        Protocol:
          type: integer
          description: The protocol assigned to the Traffic Mirror rule.
        DestinationPortRange:
          $ref: '#/components/schemas/TrafficMirrorPortRange'
        SourcePortRange:
          $ref: '#/components/schemas/TrafficMirrorPortRange'
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block assigned to the Traffic Mirror rule.
        SourceCidrBlock:
          type: string
          description: The source CIDR block assigned to the Traffic Mirror rule.
        Description:
          type: string
          description: The description of the Traffic Mirror rule.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags on Traffic Mirroring filter rules.
    CreateTrafficMirrorFilterRuleRequest:
      type: object
      properties:
        TrafficMirrorFilterId:
          type: string
          description: The ID of the filter that this rule is associated with.
        TrafficDirection:
          type: string
          enum:
          - ingress
          - egress
          description: The type of traffic.
        RuleNumber:
          type: integer
          description: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
        RuleAction:
          type: string
          enum:
          - accept
          - reject
          description: The action to take on the filtered traffic.
        DestinationPortRange:
          $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
        SourcePortRange:
          $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
        Protocol:
          type: integer
          description: The protocol, for example UDP, to assign to the Traffic Mirror rule. For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block to assign to the Traffic Mirror rule.
        SourceCidrBlock:
          type: string
          description: The source CIDR block to assign to the Traffic Mirror rule.
        Description:
          type: string
          description: The description of the Traffic Mirror rule.
        DryRun:
          type: boolean
          description: 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.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: Traffic Mirroring tags specifications.
      required:
      - TrafficMirrorFilterId
      - TrafficDirection
      - RuleNumber
      - RuleAction
      - DestinationCidrBlock
      - SourceCidrBlock
    DeleteTrafficMirrorFilterRuleRequest:
      type: object
      properties:
        TrafficMirrorFilterRuleId:
          type: string
          description: The ID of the Traffic Mirror rule.
        DryRun:
          type: boolean
          description: 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.
      required:
      - TrafficMirrorFilterRuleId
    DeleteTrafficMirrorFilterRuleResult:
      type: object
      properties:
        TrafficMirrorFilterRuleId:
          type: string
          description: The ID of the deleted Traffic Mirror rule.
    ModifyTrafficMirrorFilterRuleRequest:
      type: object
      properties:
        TrafficMirrorFilterRuleId:
          type: string
          description: The ID of the Traffic Mirror rule.
        TrafficDirection:
          type: string
          enum:
          - ingress
          - egress
          description: The type of traffic to assign to the rule.
        RuleNumber:
          type: integer
          description: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
        RuleAction:
          type: string
          enum:
          - accept
          - reject
          description: The action to assign to the rule.
        DestinationPortRange:
          $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
        SourcePortRange:
          $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
        Protocol:
          type: integer
          description: The protocol, for example TCP, to assign to the Traffic Mirror rule.
        DestinationCidrBlock:
          type: string
          description: The destination CIDR block to assign to the Traffic Mirror rule.
        SourceCidrBlock:
          type: string
          description: The source CIDR block to assign to the Traffic Mirror rule.
        Description:
          type: string
          description: The description to assign to the Traffic Mirror rule.
        RemoveFields:
          type: array
          items:
            type: string
            enum:
            - destination-port-range
            - source-port-range
            - protocol
            - description
          description: The properties that you want to remove from the Traffic Mirror filter rule. When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
        DryRun:
          type: boolean
          description: 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.
      required:
      - TrafficMirrorFilterRuleId
    TrafficMirrorPortRange:
      type: object
      properties:
        FromPort:
          type: integer
          description: The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
        ToPort:
          type: integer
          description: The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: '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:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    CreateTrafficMirrorFilterRuleResult:
      type: object
      properties:
        TrafficMirrorFilterRule:
          $ref: '#/components/schemas/TrafficMirrorFilterRule'
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
    ModifyTrafficMirrorFilterRuleResult:
      type: object
      properties:
        TrafficMirrorFilterRule:
          $ref: '#/components/schemas/TrafficMirrorFilterRule'
    TrafficMirrorPortRangeRequest:
      type: object
      properties:
        FromPort:
          type: integer
          description: The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
        ToPort:
          type: integer
          description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
    DescribeTrafficMirrorFilterRulesRequest:
      type: object
      properties:
        TrafficMirrorFilterRuleIds:
          type: array
          items:
            type: string
          description: Traffic filter rule IDs.
        TrafficMirrorFilterId:
          type: string
          description: Traffic filter ID.
        DryRun:
          type: boolean
          description: 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:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: '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'
        MaxResults:
          type: integer
          description: 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:
          type: string
          description: The token for the next page of results.
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    DescribeTrafficMirrorFilterRulesResult:
      type: object
      properties:
        TrafficMirrorFilterRules:
          type: array
          items:
            $ref: '#/components/schemas/TrafficMirrorFilterRule'
          description: Traffic mirror rules.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: 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.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)