Class: Aws::EC2::Types::DescribeFpgaImagesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeFpgaImagesRequest data as a hash:

{
  dry_run: false,
  fpga_image_ids: ["FpgaImageId"],
  owners: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14466

class DescribeFpgaImagesRequest < Struct.new(
  :dry_run,
  :fpga_image_ids,
  :owners,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

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 AWS account ID of the AFI owner.

  • product-code - The product code.

  • shell-version - The version of the AWS 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.

Returns:



14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14466

class DescribeFpgaImagesRequest < Struct.new(
  :dry_run,
  :fpga_image_ids,
  :owners,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#fpga_image_idsArray<String>

The AFI IDs.

Returns:

  • (Array<String>)


14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14466

class DescribeFpgaImagesRequest < Struct.new(
  :dry_run,
  :fpga_image_ids,
  :owners,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14466

class DescribeFpgaImagesRequest < Struct.new(
  :dry_run,
  :fpga_image_ids,
  :owners,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14466

class DescribeFpgaImagesRequest < Struct.new(
  :dry_run,
  :fpga_image_ids,
  :owners,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#ownersArray<String>

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Returns:

  • (Array<String>)


14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 14466

class DescribeFpgaImagesRequest < Struct.new(
  :dry_run,
  :fpga_image_ids,
  :owners,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end