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.

Synopsis¶

  describe-fpga-images
[--dry-run | --no-dry-run]
[--fpga-image-ids <value>]
[--owners <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--dry-run | --no-dry-run (boolean)

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 .

--fpga-image-ids (list)

The AFI IDs.

(string)

Syntax:

"string" "string" ...

--owners (list)

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 ).

(string)

Syntax:

"string" "string" ...

--filters (list)

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.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

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.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe Amazon FPGA images

This example describes AFIs that are owned by account 123456789012.

Command:

aws ec2 describe-fpga-images --filters Name=owner-id,Values=123456789012

Output:

{
  "FpgaImages": [
      {
          "UpdateTime": "2017-12-22T12:09:14.000Z",
          "Name": "my-afi",
          "PciId": {
              "SubsystemVendorId": "0xfedd",
              "VendorId": "0x1d0f",
              "DeviceId": "0xf000",
              "SubsystemId": "0x1d51"
          },
          "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc",
          "Public": false,
          "State": {
              "Code": "available"
          },
          "ShellVersion": "0x071417d3",
          "OwnerId": "123456789012",
          "FpgaImageId": "afi-0d123e123bfc85abc",
          "CreateTime": "2017-12-22T11:43:33.000Z",
          "Description": "my-afi"
      }
  ]
}

Output¶

FpgaImages -> (list)

Information about the FPGA images.

(structure)

Describes an Amazon FPGA image (AFI).

FpgaImageId -> (string)

The FPGA image identifier (AFI ID).

FpgaImageGlobalId -> (string)

The global FPGA image identifier (AGFI ID).

Name -> (string)

The name of the AFI.

Description -> (string)

The description of the AFI.

ShellVersion -> (string)

The version of the Amazon Web Services Shell that was used to create the bitstream.

PciId -> (structure)

Information about the PCI bus.

DeviceId -> (string)

The ID of the device.

VendorId -> (string)

The ID of the vendor.

SubsystemId -> (string)

The ID of the subsystem.

SubsystemVendorId -> (string)

The ID of the vendor for the subsystem.

State -> (structure)

Information about the state of the AFI.

Code -> (string)

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 -> (string)

If the state is failed , this is the error message.

CreateTime -> (timestamp)

The date and time the AFI was created.

UpdateTime -> (timestamp)

The time of the most recent update to the AFI.

OwnerId -> (string)

The ID of the Amazon Web Services account that owns the AFI.

OwnerAlias -> (string)

The alias of the AFI owner. Possible values include self , amazon , and aws-marketplace .

ProductCodes -> (list)

The product codes for the AFI.

(structure)

Describes a product code.

ProductCodeId -> (string)

The product code.

ProductCodeType -> (string)

The type of product code.

Tags -> (list)

Any tags assigned to the AFI.

(structure)

Describes a tag.

Key -> (string)

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 -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Public -> (boolean)

Indicates whether the AFI is public.

DataRetentionSupport -> (boolean)

Indicates whether data retention support is enabled for the AFI.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide