Skip to content

describe_fpga_images

Operation

describe_fpga_images

describe_fpga_images(request: DescribeFpgaImagesInput | DescribeFpgaImagesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeFpgaImagesInputDict]) -> DescribeFpgaImagesOutput

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.

Parameters:

Name Type Description Default
request DescribeFpgaImagesInput | DescribeFpgaImagesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeFpgaImagesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeFpgaImagesOutput

An instance of DescribeFpgaImagesOutput.

describe_fpga_images async

describe_fpga_images(request: DescribeFpgaImagesInput | DescribeFpgaImagesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeFpgaImagesInputDict]) -> DescribeFpgaImagesOutput

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.

Parameters:

Name Type Description Default
request DescribeFpgaImagesInput | DescribeFpgaImagesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeFpgaImagesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeFpgaImagesOutput

An instance of DescribeFpgaImagesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeFpgaImagesInputDict

Bases: TypedDict

Dictionary form of DescribeFpgaImagesInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

fpga_image_ids instance-attribute
fpga_image_ids: Sequence[str] | None

The AFI IDs.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

The token to retrieve the next page of results.

owners instance-attribute
owners: Sequence[str] | None

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

DescribeFpgaImagesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeFpgaImagesInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

fpga_image_ids class-attribute instance-attribute
fpga_image_ids: list[str] | None = ...

The AFI IDs.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to retrieve the next page of results.

owners class-attribute instance-attribute
owners: list[str] | None = ...

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

Output

DescribeFpgaImagesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeFpgaImagesOutput structure.

Attributes

fpga_images class-attribute instance-attribute
fpga_images: list[FpgaImage] | None = ...

Information about the FPGA images.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.