Amazon EC2 Ec2 Egress Only Internet Gateway API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Egress Only Internet Gateway…
  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: Egress Only Internet Gateway
paths:
  /?Action=CreateEgressOnlyInternetGateway:
    post:
      operationId: CreateEgressOnlyInternetGateway
      summary: Create Egress Only Internet Gateway
      description: '[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateEgressOnlyInternetGateway
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayRequest'
      tags:
      - Egress Only Internet Gateway
  /?Action=DeleteEgressOnlyInternetGateway:
    post:
      operationId: DeleteEgressOnlyInternetGateway
      summary: Delete Egress Only Internet Gateway
      description: Deletes an egress-only internet gateway.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteEgressOnlyInternetGateway
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayRequest'
      tags:
      - Egress Only Internet Gateway
  /?Action=DescribeEgressOnlyInternetGateways:
    post:
      operationId: DescribeEgressOnlyInternetGateways
      summary: Describe Egress Only Internet Gateways
      description: Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeEgressOnlyInternetGateways
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysRequest'
      tags:
      - Egress Only Internet Gateway
components:
  schemas:
    DescribeEgressOnlyInternetGatewaysRequest:
      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.
        EgressOnlyInternetGatewayIds:
          type: array
          items:
            type: string
          description: The IDs of the egress-only internet gateways.
        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 returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: The filters. 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 have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    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.'
    DescribeEgressOnlyInternetGatewaysResult:
      type: object
      properties:
        EgressOnlyInternetGateways:
          type: array
          items:
            $ref: '#/components/schemas/EgressOnlyInternetGateway'
          description: Information about the egress-only internet gateways.
        NextToken:
          type: string
          description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
    DeleteEgressOnlyInternetGatewayRequest:
      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.
        EgressOnlyInternetGatewayId:
          type: string
          description: The ID of the egress-only internet gateway.
      required:
      - EgressOnlyInternetGatewayId
    DeleteEgressOnlyInternetGatewayResult:
      type: object
      properties:
        ReturnCode:
          type: boolean
          description: Returns true if the request succeeds; otherwise, it returns an error.
    CreateEgressOnlyInternetGatewayResult:
      type: object
      properties:
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        EgressOnlyInternetGateway:
          $ref: '#/components/schemas/EgressOnlyInternetGateway'
    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.
    EgressOnlyInternetGateway:
      type: object
      properties:
        Attachments:
          type: array
          items:
            $ref: '#/components/schemas/InternetGatewayAttachment'
          description: Information about the attachment of the egress-only internet gateway.
        EgressOnlyInternetGatewayId:
          type: string
          description: The ID of the egress-only internet gateway.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags assigned to the egress-only internet gateway.
    CreateEgressOnlyInternetGatewayRequest:
      type: object
      properties:
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
        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.
        VpcId:
          type: string
          description: The ID of the VPC for which to create the egress-only internet gateway.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to assign to the egress-only internet gateway.
      required:
      - VpcId
    InternetGatewayAttachment:
      type: object
      properties:
        State:
          type: string
          enum:
          - attaching
          - attached
          - detaching
          - detached
          description: The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.
        VpcId:
          type: string
          description: The ID of the VPC.
  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)