Amazon EC2 Ec2 Fpga Image API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Fpga Image 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: Fpga Image
paths:
  /?Action=CreateFpgaImage:
    post:
      operationId: CreateFpgaImage
      summary: Create Fpga Image
      description: Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateFpgaImageResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateFpgaImage
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateFpgaImageRequest'
      tags:
      - Fpga Image
  /?Action=DeleteFpgaImage:
    post:
      operationId: DeleteFpgaImage
      summary: Delete Fpga Image
      description: Deletes the specified Amazon FPGA Image (AFI).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteFpgaImageResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteFpgaImage
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteFpgaImageRequest'
      tags:
      - Fpga Image
  /?Action=DescribeFpgaImages:
    post:
      operationId: DescribeFpgaImages
      summary: Describe Fpga Images
      description: Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeFpgaImagesResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeFpgaImages
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeFpgaImagesRequest'
      tags:
      - Fpga Image
components:
  schemas:
    CreateFpgaImageRequest:
      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.
        InputStorageLocation:
          $ref: '#/components/schemas/StorageLocation'
        LogsStorageLocation:
          $ref: '#/components/schemas/StorageLocation'
        Description:
          type: string
          description: A description for the AFI.
        Name:
          type: string
          description: A name for the AFI.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the FPGA image during creation.
      required:
      - InputStorageLocation
    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.'
    StorageLocation:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the S3 bucket.
        Key:
          type: string
          description: The key.
    FpgaImage:
      type: object
      properties:
        FpgaImageId:
          type: string
          description: The FPGA image identifier (AFI ID).
        FpgaImageGlobalId:
          type: string
          description: The global FPGA image identifier (AGFI ID).
        Name:
          type: string
          description: The name of the AFI.
        Description:
          type: string
          description: The description of the AFI.
        ShellVersion:
          type: string
          description: The version of the Amazon Web Services Shell that was used to create the bitstream.
        PciId:
          $ref: '#/components/schemas/PciId'
        State:
          $ref: '#/components/schemas/FpgaImageState'
        CreateTime:
          type: string
          format: date-time
          description: The date and time the AFI was created.
        UpdateTime:
          type: string
          format: date-time
          description: The time of the most recent update to the AFI.
        OwnerId:
          type: string
          description: The ID of the Amazon Web Services account that owns the AFI.
        OwnerAlias:
          type: string
          description: The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.
        ProductCodes:
          type: array
          items:
            $ref: '#/components/schemas/ProductCode'
          description: The product codes for the AFI.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags assigned to the AFI.
        Public:
          type: boolean
          description: Indicates whether the AFI is public.
        DataRetentionSupport:
          type: boolean
          description: Indicates whether data retention support is enabled for the AFI.
        InstanceTypes:
          type: array
          items:
            type: string
          description: The instance types supported by the AFI.
    DeleteFpgaImageRequest:
      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.
        FpgaImageId:
          type: string
          description: The ID of the AFI.
      required:
      - FpgaImageId
    CreateFpgaImageResult:
      type: object
      properties:
        FpgaImageId:
          type: string
          description: The FPGA image identifier (AFI ID).
        FpgaImageGlobalId:
          type: string
          description: The global FPGA image identifier (AGFI ID).
    FpgaImageState:
      type: object
      properties:
        Code:
          type: string
          enum:
          - pending
          - failed
          - available
          - unavailable
          description: 'The state. The following are the possible values: pending - AFI bitstream generation is in progress. available - The AFI is available for use. failed - AFI bitstream generation failed. unavailable - The AFI is no longer available for use.'
        Message:
          type: string
          description: If the state is failed, this is the error message.
    ProductCode:
      type: object
      properties:
        ProductCodeId:
          type: string
          description: The product code.
        ProductCodeType:
          type: string
          enum:
          - devpay
          - marketplace
          description: The type of product code.
    DeleteFpgaImageResult:
      type: object
      properties:
        Return:
          type: boolean
          description: Is true if the request succeeds, and an error otherwise.
    PciId:
      type: object
      properties:
        DeviceId:
          type: string
          description: The ID of the device.
        VendorId:
          type: string
          description: The ID of the vendor.
        SubsystemId:
          type: string
          description: The ID of the subsystem.
        SubsystemVendorId:
          type: string
          description: The ID of the vendor for the subsystem.
    DescribeFpgaImagesRequest:
      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.
        FpgaImageIds:
          type: array
          items:
            type: string
          description: The AFI IDs.
        Owners:
          type: array
          items:
            type: string
          description: Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters. create-time - The creation time of the AFI. fpga-image-id - The FPGA image identifier (AFI ID). fpga-image-global-id - The global FPGA image identifier (AGFI ID). name - The name of the AFI. owner-id - The Amazon Web Services account ID of the AFI owner. product-code - The product code. shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream. state - The state of the AFI (pending | failed | available | unavailable). 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 '
        NextToken:
          type: string
          description: The token to retrieve the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call.
    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.
    DescribeFpgaImagesResult:
      type: object
      properties:
        FpgaImages:
          type: array
          items:
            $ref: '#/components/schemas/FpgaImage'
          description: Information about the FPGA images.
        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.
  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)