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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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>

  One or more filters.

• #fpga_image_ids ⇒ Array<String>

  One or more 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 'lib/aws-sdk-ec2/types.rb', line 6191

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

#filters ⇒ Array<Types::Filter>

One or more 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=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify `tag:Purpose` for the filter name and `X` for the filter value.

• ‘tag-key` - The key of a tag assigned to the resource. This filter is independent of the `tag-value` filter. For example, if you use both the filter “tag-key=Purpose” and the filter “tag-value=X”, you get any resources assigned both the tag key Purpose (regardless of what the tag’s value is), and the tag value X (regardless of what the tag’s key is). If you want to list only resources where Purpose is X, see the ‘tag`:key=value filter.

• ‘tag-value` - The value of a tag assigned to the resource. This filter is independent of the `tag-key` filter.

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

Returns:

• (Array<Types::Filter>)

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

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

#fpga_image_ids ⇒ Array<String>

One or more AFI IDs.

Returns:

• (Array<String>)

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

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 'lib/aws-sdk-ec2/types.rb', line 6191

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 'lib/aws-sdk-ec2/types.rb', line 6191

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 'lib/aws-sdk-ec2/types.rb', line 6191

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