Amazon EC2 Ec2 Local Gateway Virtual Interface API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Local Gateway Virtual…
  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: Local Gateway Virtual Interface
paths:
  /?Action=CreateLocalGatewayVirtualInterface:
    post:
      operationId: CreateLocalGatewayVirtualInterface
      summary: Create Local Gateway Virtual Interface
      description: Create a virtual interface for a local gateway.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateLocalGatewayVirtualInterfaceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateLocalGatewayVirtualInterface
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateLocalGatewayVirtualInterfaceRequest'
      tags:
      - Local Gateway Virtual Interface
  /?Action=DeleteLocalGatewayVirtualInterface:
    post:
      operationId: DeleteLocalGatewayVirtualInterface
      summary: Delete Local Gateway Virtual Interface
      description: Deletes the specified local gateway virtual interface.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteLocalGatewayVirtualInterfaceResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteLocalGatewayVirtualInterface
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteLocalGatewayVirtualInterfaceRequest'
      tags:
      - Local Gateway Virtual Interface
  /?Action=DescribeLocalGatewayVirtualInterfaces:
    post:
      operationId: DescribeLocalGatewayVirtualInterfaces
      summary: Describe Local Gateway Virtual Interfaces
      description: Describes the specified local gateway virtual interfaces.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeLocalGatewayVirtualInterfaces
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesRequest'
      tags:
      - Local Gateway Virtual Interface
components:
  schemas:
    DeleteLocalGatewayVirtualInterfaceRequest:
      type: object
      properties:
        LocalGatewayVirtualInterfaceId:
          type: string
          description: The ID of the local virtual interface to delete.
        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:
      - LocalGatewayVirtualInterfaceId
    CreateLocalGatewayVirtualInterfaceResult:
      type: object
      properties:
        LocalGatewayVirtualInterface:
          $ref: '#/components/schemas/LocalGatewayVirtualInterface'
    DeleteLocalGatewayVirtualInterfaceResult:
      type: object
      properties:
        LocalGatewayVirtualInterface:
          $ref: '#/components/schemas/LocalGatewayVirtualInterface'
    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.'
    DescribeLocalGatewayVirtualInterfacesResult:
      type: object
      properties:
        LocalGatewayVirtualInterfaces:
          type: array
          items:
            $ref: '#/components/schemas/LocalGatewayVirtualInterface'
          description: Information about the virtual interfaces.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    CreateLocalGatewayVirtualInterfaceRequest:
      type: object
      properties:
        LocalGatewayVirtualInterfaceGroupId:
          type: string
          description: The ID of the local gateway virtual interface group.
        OutpostLagId:
          type: string
          description: References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
        Vlan:
          type: integer
          description: The virtual local area network (VLAN) used for the local gateway virtual interface.
        LocalAddress:
          type: string
          description: The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.
        PeerAddress:
          type: string
          description: The peer IP address for the local gateway virtual interface. Only IPv4 is supported.
        PeerBgpAsn:
          type: integer
          description: The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to a resource when the local gateway virtual interface is being created.
        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.
        PeerBgpAsnExtended:
          type: integer
          description: The extended 32-bit ASN of the BGP peer for use with larger ASN values.
      required:
      - LocalGatewayVirtualInterfaceGroupId
      - OutpostLagId
      - Vlan
      - LocalAddress
      - PeerAddress
    DescribeLocalGatewayVirtualInterfacesRequest:
      type: object
      properties:
        LocalGatewayVirtualInterfaceIds:
          type: array
          items:
            type: string
          description: The IDs of the virtual interfaces.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. local-address - The local address. local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. local-gateway-id - The ID of the local gateway. local-gateway-virtual-interface-id - The ID of the virtual interface. owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface. peer-address - The peer address. peer-bgp-asn - The peer BGP ASN. vlan - The ID of the VLAN.
        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.
        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.
    LocalGatewayVirtualInterface:
      type: object
      properties:
        LocalGatewayVirtualInterfaceId:
          type: string
          description: The ID of the virtual interface.
        LocalGatewayId:
          type: string
          description: The ID of the local gateway.
        LocalGatewayVirtualInterfaceGroupId:
          type: string
          description: The ID of the local gateway virtual interface group.
        LocalGatewayVirtualInterfaceArn:
          type: string
          description: The Amazon Resource Number (ARN) of the local gateway virtual interface.
        OutpostLagId:
          type: string
          description: The Outpost LAG ID.
        Vlan:
          type: integer
          description: The ID of the VLAN.
        LocalAddress:
          type: string
          description: The local address.
        PeerAddress:
          type: string
          description: The peer address.
        LocalBgpAsn:
          type: integer
          description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
        PeerBgpAsn:
          type: integer
          description: The peer BGP ASN.
        PeerBgpAsnExtended:
          type: integer
          description: The extended 32-bit ASN of the BGP peer for use with larger ASN values.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the local gateway virtual interface.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the virtual interface.
        ConfigurationState:
          type: string
          enum:
          - pending
          - available
          - deleting
          - deleted
          description: The current state of the local gateway virtual interface.
    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.
    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.
  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)