You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeFpgaImagesRequest

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: ["String"],
  owners: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  The filters.

• #fpga_image_ids ⇒ Array<String>

  The AFI IDs.

• #max_results ⇒ Integer

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

• #next_token ⇒ String

  The token to retrieve the next page of results.

• #owners ⇒ Array<String>

  Filters the AFI by owner.

Instance Attribute Details

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11149

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

#filters ⇒ Array<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:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11149

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

#fpga_image_ids ⇒ Array<String>

The AFI IDs.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11149

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11149

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

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11149

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

#owners ⇒ Array<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>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11149

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