Amazon EC2 Ec2 Traffic Mirror Filter API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Traffic Mirror Filter API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 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
paths:
  /?Action=CreateTrafficMirrorFilter:
    post:
      operationId: CreateTrafficMirrorFilter
      summary: Create Traffic Mirror Filter
      description: Creates a Traffic Mirror filter. A Traffic Mirror filter is a set of rules that defines the traffic to mirror. By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTrafficMirrorFilterResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTrafficMirrorFilter
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTrafficMirrorFilterRequest'
      tags:
      - Traffic Mirror Filter
  /?Action=DeleteTrafficMirrorFilter:
    post:
      operationId: DeleteTrafficMirrorFilter
      summary: Delete Traffic Mirror Filter
      description: Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTrafficMirrorFilter
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRequest'
      tags:
      - Traffic Mirror Filter
  /?Action=DescribeTrafficMirrorFilters:
    post:
      operationId: DescribeTrafficMirrorFilters
      summary: Describe Traffic Mirror Filters
      description: Describes one or more Traffic Mirror filters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTrafficMirrorFilters
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTrafficMirrorFiltersRequest'
      tags:
      - Traffic Mirror Filter
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.
    DescribeTrafficMirrorFiltersRequest:
      type: object
      properties:
        TrafficMirrorFilterIds:
          type: array
          items:
            type: string
          description: The ID of the Traffic Mirror filter.
        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: '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.'
        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.
    DeleteTrafficMirrorFilterResult:
      type: object
      properties:
        TrafficMirrorFilterId:
          type: string
          description: The ID of the Traffic Mirror filter.
    DescribeTrafficMirrorFiltersResult:
      type: object
      properties:
        TrafficMirrorFilters:
          type: array
          items:
            $ref: '#/components/schemas/TrafficMirrorFilter'
          description: Information about one or more Traffic Mirror filters.
        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.
    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.'
    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.
    CreateTrafficMirrorFilterResult:
      type: object
      properties:
        TrafficMirrorFilter:
          $ref: '#/components/schemas/TrafficMirrorFilter'
        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.
    TrafficMirrorFilter:
      type: object
      properties:
        TrafficMirrorFilterId:
          type: string
          description: The ID of the Traffic Mirror filter.
        IngressFilterRules:
          type: array
          items:
            $ref: '#/components/schemas/TrafficMirrorFilterRule'
          description: Information about the ingress rules that are associated with the Traffic Mirror filter.
        EgressFilterRules:
          type: array
          items:
            $ref: '#/components/schemas/TrafficMirrorFilterRule'
          description: Information about the egress rules that are associated with the Traffic Mirror filter.
        NetworkServices:
          type: array
          items:
            type: string
            enum:
            - amazon-dns
          description: The network service traffic that is associated with the Traffic Mirror filter.
        Description:
          type: string
          description: The description of the Traffic Mirror filter.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the Traffic Mirror filter.
    DeleteTrafficMirrorFilterRequest:
      type: object
      properties:
        TrafficMirrorFilterId:
          type: string
          description: The ID of the Traffic Mirror filter.
        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:
      - TrafficMirrorFilterId
    CreateTrafficMirrorFilterRequest:
      type: object
      properties:
        Description:
          type: string
          description: The description of the Traffic Mirror filter.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to a Traffic Mirror filter.
        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.
    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.
    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)