Amazon EC2 Ec2 Network Interface Attribute API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Network Interface Attribute 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: Network Interface Attribute
paths:
  /?Action=DescribeNetworkInterfaceAttribute:
    post:
      operationId: DescribeNetworkInterfaceAttribute
      summary: Describe Network Interface Attribute
      description: Describes a network interface attribute. You can specify only one attribute at a time.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
              example:
                NetworkInterfaceId: eni-686ea200
                Attachment:
                  Status: attached
                  DeviceIndex: 0
                  AttachTime: '2015-05-21T20:02:20.000Z'
                  InstanceId: i-1234567890abcdef0
                  DeleteOnTermination: true
                  AttachmentId: eni-attach-43348162
                  InstanceOwnerId: '123456789012'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeNetworkInterfaceAttribute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeRequest'
            example:
              NetworkInterfaceId: eni-686ea200
              Attribute: attachment
      tags:
      - Network Interface Attribute
  /?Action=ModifyNetworkInterfaceAttribute:
    post:
      operationId: ModifyNetworkInterfaceAttribute
      summary: Modify Network Interface Attribute
      description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyNetworkInterfaceAttribute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyNetworkInterfaceAttributeRequest'
            example:
              NetworkInterfaceId: eni-686ea200
              Attachment:
                AttachmentId: eni-attach-43348162
                DeleteOnTermination: false
      tags:
      - Network Interface Attribute
  /?Action=ResetNetworkInterfaceAttribute:
    post:
      operationId: ResetNetworkInterfaceAttribute
      summary: Reset Network Interface Attribute
      description: Resets a network interface attribute. You can specify only one attribute at a time.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ResetNetworkInterfaceAttribute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ResetNetworkInterfaceAttributeRequest'
      tags:
      - Network Interface Attribute
components:
  schemas:
    ResetNetworkInterfaceAttributeRequest:
      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.
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface.
        SourceDestCheck:
          type: string
          description: The source/destination checking attribute. Resets the value to true.
      required:
      - NetworkInterfaceId
    NetworkInterfaceAttachmentChanges:
      type: object
      properties:
        DefaultEnaQueueCount:
          type: boolean
          description: The default number of the ENA queues.
        EnaQueueCount:
          type: integer
          description: The number of ENA queues to be created with the instance.
        AttachmentId:
          type: string
          description: The ID of the network interface attachment.
        DeleteOnTermination:
          type: boolean
          description: Indicates whether the network interface is deleted when the instance is terminated.
    EnaSrdSpecification:
      type: object
      properties:
        EnaSrdEnabled:
          type: boolean
          description: Indicates whether ENA Express is enabled for the network interface.
        EnaSrdUdpSpecification:
          $ref: '#/components/schemas/EnaSrdUdpSpecification'
    AttachmentEnaSrdUdpSpecification:
      type: object
      properties:
        EnaSrdUdpEnabled:
          type: boolean
          description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
    AttributeValue:
      type: object
      properties:
        Value:
          type: string
          description: The attribute value. The value is case-sensitive.
    ModifyNetworkInterfaceAttributeRequest:
      type: object
      properties:
        EnaSrdSpecification:
          $ref: '#/components/schemas/EnaSrdSpecification'
        EnablePrimaryIpv6:
          type: boolean
          description: If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you ena
        ConnectionTrackingSpecification:
          $ref: '#/components/schemas/ConnectionTrackingSpecificationRequest'
        AssociatePublicIpAddress:
          type: boolean
          description: Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
        AssociatedSubnetIds:
          type: array
          items:
            type: string
          description: A list of subnet IDs to associate with the network interface.
        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.
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface.
        Description:
          $ref: '#/components/schemas/AttributeValue'
        SourceDestCheck:
          $ref: '#/components/schemas/AttributeBooleanValue'
        Groups:
          type: array
          items:
            type: string
          description: Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
        Attachment:
          $ref: '#/components/schemas/NetworkInterfaceAttachmentChanges'
      required:
      - NetworkInterfaceId
    DescribeNetworkInterfaceAttributeResult:
      type: object
      properties:
        Attachment:
          $ref: '#/components/schemas/NetworkInterfaceAttachment'
        Description:
          $ref: '#/components/schemas/AttributeValue'
        Groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupIdentifier'
          description: The security groups associated with the network interface.
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface.
        SourceDestCheck:
          $ref: '#/components/schemas/AttributeBooleanValue'
        AssociatePublicIpAddress:
          type: boolean
          description: Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
    NetworkInterfaceAttachment:
      type: object
      properties:
        AttachTime:
          type: string
          format: date-time
          description: The timestamp indicating when the attachment initiated.
        AttachmentId:
          type: string
          description: The ID of the network interface attachment.
        DeleteOnTermination:
          type: boolean
          description: Indicates whether the network interface is deleted when the instance is terminated.
        DeviceIndex:
          type: integer
          description: The device index of the network interface attachment on the instance.
        NetworkCardIndex:
          type: integer
          description: The index of the network card.
        InstanceId:
          type: string
          description: The ID of the instance.
        InstanceOwnerId:
          type: string
          description: The Amazon Web Services account ID of the owner of the instance.
        Status:
          type: string
          enum:
          - attaching
          - attached
          - detaching
          - detached
          description: The attachment state.
        EnaSrdSpecification:
          $ref: '#/components/schemas/AttachmentEnaSrdSpecification'
        EnaQueueCount:
          type: integer
          description: The number of ENA queues created with the instance.
    EnaSrdUdpSpecification:
      type: object
      properties:
        EnaSrdUdpEnabled:
          type: boolean
          description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
    GroupIdentifier:
      type: object
      properties:
        GroupId:
          type: string
          description: The ID of the security group.
        GroupName:
          type: string
          description: The name of the security group.
    DescribeNetworkInterfaceAttributeRequest:
      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.
        NetworkInterfaceId:
          type: string
          description: The ID of the network interface.
        Attribute:
          type: string
          enum:
          - description
          - groupSet
          - sourceDestCheck
          - attachment
          - associatePublicIpAddress
          description: The attribute of the network interface. This parameter is required.
      required:
      - NetworkInterfaceId
    AttachmentEnaSrdSpecification:
      type: object
      properties:
        EnaSrdEnabled:
          type: boolean
          description: Indicates whether ENA Express is enabled for the network interface.
        EnaSrdUdpSpecification:
          $ref: '#/components/schemas/AttachmentEnaSrdUdpSpecification'
    ConnectionTrackingSpecificationRequest:
      type: object
      properties:
        TcpEstablishedTimeout:
          type: integer
          description: 'Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 350 seconds for Nitro v6 instance types (excluding P6e-GB200); 432000 seconds for all other instance types (including P6e-GB200). Recommended: Less than 432000 seconds.'
        UdpStreamTimeout:
          type: integer
          description: 'Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.'
        UdpTimeout:
          type: integer
          description: 'Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.'
    AttributeBooleanValue:
      type: object
      properties:
        Value:
          type: boolean
          description: The attribute value. The valid values are true or false.
  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)