Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
This operation returns paginated results.
Synopsis
- data DescribeFpgaImages = DescribeFpgaImages' {}
- newDescribeFpgaImages :: DescribeFpgaImages
- describeFpgaImages_dryRun :: Lens' DescribeFpgaImages (Maybe Bool)
- describeFpgaImages_filters :: Lens' DescribeFpgaImages (Maybe [Filter])
- describeFpgaImages_fpgaImageIds :: Lens' DescribeFpgaImages (Maybe [Text])
- describeFpgaImages_maxResults :: Lens' DescribeFpgaImages (Maybe Natural)
- describeFpgaImages_nextToken :: Lens' DescribeFpgaImages (Maybe Text)
- describeFpgaImages_owners :: Lens' DescribeFpgaImages (Maybe [Text])
- data DescribeFpgaImagesResponse = DescribeFpgaImagesResponse' {
- fpgaImages :: Maybe [FpgaImage]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeFpgaImagesResponse :: Int -> DescribeFpgaImagesResponse
- describeFpgaImagesResponse_fpgaImages :: Lens' DescribeFpgaImagesResponse (Maybe [FpgaImage])
- describeFpgaImagesResponse_nextToken :: Lens' DescribeFpgaImagesResponse (Maybe Text)
- describeFpgaImagesResponse_httpStatus :: Lens' DescribeFpgaImagesResponse Int
Creating a Request
data DescribeFpgaImages Source #
See: newDescribeFpgaImages
smart constructor.
DescribeFpgaImages' | |
|
Instances
newDescribeFpgaImages :: DescribeFpgaImages Source #
Create a value of DescribeFpgaImages
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DescribeFpgaImages'
, describeFpgaImages_dryRun
- 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
.
$sel:filters:DescribeFpgaImages'
, describeFpgaImages_filters
- 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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
$sel:fpgaImageIds:DescribeFpgaImages'
, describeFpgaImages_fpgaImageIds
- The AFI IDs.
$sel:maxResults:DescribeFpgaImages'
, describeFpgaImages_maxResults
- The maximum number of results to return in a single call.
DescribeFpgaImages
, describeFpgaImages_nextToken
- The token to retrieve the next page of results.
$sel:owners:DescribeFpgaImages'
, describeFpgaImages_owners
- 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
).
Request Lenses
describeFpgaImages_dryRun :: Lens' DescribeFpgaImages (Maybe Bool) Source #
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
.
describeFpgaImages_filters :: Lens' DescribeFpgaImages (Maybe [Filter]) Source #
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
describeFpgaImages_fpgaImageIds :: Lens' DescribeFpgaImages (Maybe [Text]) Source #
The AFI IDs.
describeFpgaImages_maxResults :: Lens' DescribeFpgaImages (Maybe Natural) Source #
The maximum number of results to return in a single call.
describeFpgaImages_nextToken :: Lens' DescribeFpgaImages (Maybe Text) Source #
The token to retrieve the next page of results.
describeFpgaImages_owners :: Lens' DescribeFpgaImages (Maybe [Text]) Source #
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
).
Destructuring the Response
data DescribeFpgaImagesResponse Source #
See: newDescribeFpgaImagesResponse
smart constructor.
DescribeFpgaImagesResponse' | |
|
Instances
newDescribeFpgaImagesResponse Source #
Create a value of DescribeFpgaImagesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fpgaImages:DescribeFpgaImagesResponse'
, describeFpgaImagesResponse_fpgaImages
- Information about the FPGA images.
DescribeFpgaImages
, describeFpgaImagesResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeFpgaImagesResponse'
, describeFpgaImagesResponse_httpStatus
- The response's http status code.
Response Lenses
describeFpgaImagesResponse_fpgaImages :: Lens' DescribeFpgaImagesResponse (Maybe [FpgaImage]) Source #
Information about the FPGA images.
describeFpgaImagesResponse_nextToken :: Lens' DescribeFpgaImagesResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeFpgaImagesResponse_httpStatus :: Lens' DescribeFpgaImagesResponse Int Source #
The response's http status code.