Skip to content

Describe Fpga Images

ec2_describe_fpga_images R Documentation

Describes the Amazon FPGA Images (AFIs) available to you

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.

Usage

ec2_describe_fpga_images(DryRun, FpgaImageIds, Owners, Filters,
  NextToken, MaxResults)

Arguments

DryRun

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

The AFI IDs.

Owners

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

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:\<key\> - 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.

  • update-time - The time of the most recent update.

NextToken

The token to retrieve the next page of results.

MaxResults

The maximum number of results to return in a single call.

Value

A list with the following syntax: 

list(
  FpgaImages = list(
    list(
      FpgaImageId = "string",
      FpgaImageGlobalId = "string",
      Name = "string",
      Description = "string",
      ShellVersion = "string",
      PciId = list(
        DeviceId = "string",
        VendorId = "string",
        SubsystemId = "string",
        SubsystemVendorId = "string"
      ),
      State = list(
        Code = "pending"|"failed"|"available"|"unavailable",
        Message = "string"
      ),
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      UpdateTime = as.POSIXct(
        "2015-01-01"
      ),
      OwnerId = "string",
      OwnerAlias = "string",
      ProductCodes = list(
        list(
          ProductCodeId = "string",
          ProductCodeType = "devpay"|"marketplace"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Public = TRUE|FALSE,
      DataRetentionSupport = TRUE|FALSE,
      InstanceTypes = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_fpga_images(
  DryRun = TRUE|FALSE,
  FpgaImageIds = list(
    "string"
  ),
  Owners = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)