Amazon EC2 Ec2 Flow Log API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Flow Log 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: Flow Log
paths:
  /?Action=CreateFlowLogs:
    post:
      operationId: CreateFlowLogs
      summary: Create Flow Logs
      description: Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon VPC User Guide. When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket. For more information, see VPC Flow Logs in the Amazon VPC User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateFlowLogsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateFlowLogs
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateFlowLogsRequest'
      tags:
      - Flow Log
  /?Action=DeleteFlowLogs:
    post:
      operationId: DeleteFlowLogs
      summary: Delete Flow Logs
      description: Deletes one or more flow logs.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteFlowLogsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteFlowLogs
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteFlowLogsRequest'
      tags:
      - Flow Log
  /?Action=DescribeFlowLogs:
    post:
      operationId: DescribeFlowLogs
      summary: Describe Flow Logs
      description: Describes one or more flow logs. To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeFlowLogsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeFlowLogs
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeFlowLogsRequest'
      tags:
      - Flow Log
components:
  schemas:
    DeleteFlowLogsResult:
      type: object
      properties:
        Unsuccessful:
          type: array
          items:
            $ref: '#/components/schemas/UnsuccessfulItem'
          description: Information about the flow logs that could not be deleted successfully.
    DestinationOptionsResponse:
      type: object
      properties:
        FileFormat:
          type: string
          enum:
          - plain-text
          - parquet
          description: The format for the flow log.
        HiveCompatiblePartitions:
          type: boolean
          description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
        PerHourPartition:
          type: boolean
          description: Indicates whether to partition the flow log per hour.
    TagFieldSpecificationResponse:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - network-interface
          - instance
          - auto-scaling-group
          description: The resource type for the tag keys associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format.
        TagKeys:
          type: array
          items:
            type: string
          description: The tag keys on your tagged resources to be displayed by the Flow Logs Amazon EC2 Tags feature fields in your custom log format.
    FlowLog:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: The date and time the flow log was created.
        DeliverLogsErrorMessage:
          type: string
          description: Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.
        DeliverLogsPermissionArn:
          type: string
          description: The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
        DeliverCrossAccountRole:
          type: string
          description: The ARN of the IAM role that allows the service to publish flow logs across accounts.
        DeliverLogsStatus:
          type: string
          description: The status of the logs delivery (SUCCESS | FAILED).
        FlowLogId:
          type: string
          description: The ID of the flow log.
        FlowLogStatus:
          type: string
          description: The status of the flow log (ACTIVE).
        LogGroupName:
          type: string
          description: The name of the flow log group.
        ResourceId:
          type: string
          description: The ID of the resource being monitored.
        TrafficType:
          type: string
          enum:
          - ACCEPT
          - REJECT
          - ALL
          description: The type of traffic captured for the flow log.
        LogDestinationType:
          type: string
          enum:
          - cloud-watch-logs
          - s3
          - kinesis-data-firehose
          description: The type of destination for the flow log data.
        LogDestination:
          type: string
          description: The Amazon Resource Name (ARN) of the destination for the flow log data.
        LogFormat:
          type: string
          description: The format of the flow log record.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the flow log.
        MaxAggregationInterval:
          type: integer
          description: 'The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value. Valid Values: 60 | 600'
        DestinationOptions:
          $ref: '#/components/schemas/DestinationOptionsResponse'
        TagFieldSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagFieldSpecificationResponse'
          description: The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format.
    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.'
    UnsuccessfulItemError:
      type: object
      properties:
        Code:
          type: string
          description: The error code.
        Message:
          type: string
          description: The error message accompanying the error code.
    DescribeFlowLogsResult:
      type: object
      properties:
        FlowLogs:
          type: array
          items:
            $ref: '#/components/schemas/FlowLog'
          description: Information about the flow logs.
        NextToken:
          type: string
          description: The token to request the next page of items. This value is null when there are no more items to return.
    DescribeFlowLogsRequest:
      type: object
      properties:
        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.
        Filter:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. deliver-log-status - The status of the logs delivery (SUCCESS | FAILED). log-destination-type - The type of destination for the flow log data (cloud-watch-logs | s3 | kinesis-data-firehose). flow-log-id - The ID of the flow log. log-group-name - The name of the log group. resource-id - The ID of the VPC, subnet, or network interface. traffic-type - The type of traffic (ACCEPT | REJECT | ALL). tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that h'
        FlowLogIds:
          type: array
          items:
            type: string
          description: 'One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs.'
        MaxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
        NextToken:
          type: string
          description: The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.
    DeleteFlowLogsRequest:
      type: object
      properties:
        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.
        FlowLogIds:
          type: array
          items:
            type: string
          description: 'One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs.'
      required:
      - FlowLogIds
    CreateFlowLogsResult:
      type: object
      properties:
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        FlowLogIds:
          type: array
          items:
            type: string
          description: The IDs of the flow logs.
        Unsuccessful:
          type: array
          items:
            $ref: '#/components/schemas/UnsuccessfulItem'
          description: Information about the flow logs that could not be created successfully.
    UnsuccessfulItem:
      type: object
      properties:
        Error:
          $ref: '#/components/schemas/UnsuccessfulItemError'
        ResourceId:
          type: string
          description: The ID of the resource.
    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.
    TagFieldSpecificationRequest:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - network-interface
          - instance
          - auto-scaling-group
          description: The resource type for the tag keys associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format.
        TagKeys:
          type: array
          items:
            type: string
          description: The tag keys on your tagged resources to be displayed by the Flow Logs Amazon EC2 Tags feature fields in your custom log format.
    CreateFlowLogsRequest:
      type: object
      properties:
        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.
        DeliverLogsPermissionArn:
          type: string
          description: The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required if the destination type is cloud-watch-logs, or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.
        DeliverCrossAccountRole:
          type: string
          description: The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.
        LogGroupName:
          type: string
          description: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is valid only if the destination type is cloud-watch-logs.
        ResourceIds:
          type: array
          items:
            type: string
          description: 'The IDs of the resources to monitor. For example, if the resource type is VPC, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 300 for the other resource types.'
        ResourceType:
          type: string
          enum:
          - VPC
          - Subnet
          - NetworkInterface
          - TransitGateway
          - TransitGatewayAttachment
          - RegionalNatGateway
          description: The type of resource to monitor.
        TrafficType:
          type: string
          enum:
          - ACCEPT
          - REJECT
          - ALL
          description: The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types.
        LogDestinationType:
          type: string
          enum:
          - cloud-watch-logs
          - s3
          - kinesis-data-firehose
          description: 'The type of destination for the flow log data. Default: cloud-watch-logs'
        LogDestination:
          type: string
          description: 'The destination for the flow log data. The meaning of this parameter depends on the destination type. If the destination type is cloud-watch-logs, specify the ARN of a CloudWatch Logs log group. For example: arn:aws:logs:region:account_id:log-group:my_group Alternatively, use the LogGroupName parameter. If the destination type is s3, specify the ARN of an S3 bucket. For example: arn:aws:s3:::my_bucket/my_subfolder/ The subfolder is optional. Note that you can''t use AWSLogs as a subfolder name. If the destination type is kinesis-data-firehose, specify the ARN of a Kinesis Data Firehose delivery'
        LogFormat:
          type: string
          description: The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the Amazon Web Services Transit Gateway Guide. Specify the fields using the ${field-id} format, separated by spaces.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the flow logs.
        MaxAggregationInterval:
          type: integer
          description: 'The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types. When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify. Default: 600'
        DestinationOptions:
          $ref: '#/components/schemas/DestinationOptionsRequest'
        TagFieldSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagFieldSpecificationRequest'
          description: The tag configuration associated with the Flow Logs Amazon EC2 Tags feature fields in your custom log format.
      required:
      - ResourceIds
      - ResourceType
    DestinationOptionsRequest:
      type: object
      properties:
        FileFormat:
          type: string
          enum:
          - plain-text
          - parquet
          description: The format for the flow log. The default is plain-text.
        HiveCompatiblePartitions:
          type: boolean
          description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is false.
        PerHourPartition:
          type: boolean
          description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false.
    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)