Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes one or more available Amazon FPGA Images (AFIs). These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.
- describeFpgaImages :: DescribeFpgaImages
- data DescribeFpgaImages
- dfisOwners :: Lens' DescribeFpgaImages [Text]
- dfisFilters :: Lens' DescribeFpgaImages [Filter]
- dfisNextToken :: Lens' DescribeFpgaImages (Maybe Text)
- dfisDryRun :: Lens' DescribeFpgaImages (Maybe Bool)
- dfisMaxResults :: Lens' DescribeFpgaImages (Maybe Natural)
- dfisFpgaImageIds :: Lens' DescribeFpgaImages [Text]
- describeFpgaImagesResponse :: Int -> DescribeFpgaImagesResponse
- data DescribeFpgaImagesResponse
- dfirsFpgaImages :: Lens' DescribeFpgaImagesResponse [FpgaImage]
- dfirsNextToken :: Lens' DescribeFpgaImagesResponse (Maybe Text)
- dfirsResponseStatus :: Lens' DescribeFpgaImagesResponse Int
Creating a Request
describeFpgaImages :: DescribeFpgaImages Source #
Creates a value of DescribeFpgaImages
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfisOwners
- 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 areamazon
|aws-marketplace
).dfisFilters
- 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 keyvalue 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, specifytag:Purpose
for the filter name andX
for the filter value. *tag-key
- The key of a tag assigned to the resource. This filter is independent of thetag-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 thetag
:key =value/ filter. *tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. *update-time
- The time of the most recent update.dfisNextToken
- The token to retrieve the next page of results.dfisDryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.dfisMaxResults
- The maximum number of results to return in a single call.dfisFpgaImageIds
- One or more AFI IDs.
data DescribeFpgaImages Source #
See: describeFpgaImages
smart constructor.
Request Lenses
dfisOwners :: Lens' DescribeFpgaImages [Text] Source #
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
).
dfisFilters :: Lens' DescribeFpgaImages [Filter] Source #
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 keyvalue 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.
dfisNextToken :: Lens' DescribeFpgaImages (Maybe Text) Source #
The token to retrieve the next page of results.
dfisDryRun :: 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
.
dfisMaxResults :: Lens' DescribeFpgaImages (Maybe Natural) Source #
The maximum number of results to return in a single call.
dfisFpgaImageIds :: Lens' DescribeFpgaImages [Text] Source #
One or more AFI IDs.
Destructuring the Response
describeFpgaImagesResponse Source #
Creates a value of DescribeFpgaImagesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dfirsFpgaImages
- Information about one or more FPGA images.dfirsNextToken
- The token to use to retrieve the next page of results. This value isnull
when there are no more results to return.dfirsResponseStatus
- -- | The response status code.
data DescribeFpgaImagesResponse Source #
See: describeFpgaImagesResponse
smart constructor.
Response Lenses
dfirsFpgaImages :: Lens' DescribeFpgaImagesResponse [FpgaImage] Source #
Information about one or more FPGA images.
dfirsNextToken :: 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.
dfirsResponseStatus :: Lens' DescribeFpgaImagesResponse Int Source #
- - | The response status code.