amazonka-ec2-1.5.0: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.DescribeFpgaImages

Contents

Description

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.

Synopsis

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 are amazon | 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, 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 - 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 is DryRunOperation . Otherwise, it is UnauthorizedOperation .
  • 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.

Instances

Eq DescribeFpgaImages Source # 
Data DescribeFpgaImages Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFpgaImages -> c DescribeFpgaImages #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFpgaImages #

toConstr :: DescribeFpgaImages -> Constr #

dataTypeOf :: DescribeFpgaImages -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFpgaImages) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFpgaImages) #

gmapT :: (forall b. Data b => b -> b) -> DescribeFpgaImages -> DescribeFpgaImages #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFpgaImages -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFpgaImages -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeFpgaImages -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFpgaImages -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFpgaImages -> m DescribeFpgaImages #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFpgaImages -> m DescribeFpgaImages #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFpgaImages -> m DescribeFpgaImages #

Read DescribeFpgaImages Source # 
Show DescribeFpgaImages Source # 
Generic DescribeFpgaImages Source # 
Hashable DescribeFpgaImages Source # 
NFData DescribeFpgaImages Source # 

Methods

rnf :: DescribeFpgaImages -> () #

AWSRequest DescribeFpgaImages Source # 
ToQuery DescribeFpgaImages Source # 
ToPath DescribeFpgaImages Source # 
ToHeaders DescribeFpgaImages Source # 
type Rep DescribeFpgaImages Source # 
type Rep DescribeFpgaImages = D1 (MetaData "DescribeFpgaImages" "Network.AWS.EC2.DescribeFpgaImages" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "DescribeFpgaImages'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dfisOwners") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dfisFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_dfisNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_dfisDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_dfisMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dfisFpgaImageIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))))
type Rs DescribeFpgaImages Source # 

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.

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 is null when there are no more results to return.
  • dfirsResponseStatus - -- | The response status code.

data DescribeFpgaImagesResponse Source #

See: describeFpgaImagesResponse smart constructor.

Instances

Eq DescribeFpgaImagesResponse Source # 
Data DescribeFpgaImagesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeFpgaImagesResponse -> c DescribeFpgaImagesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeFpgaImagesResponse #

toConstr :: DescribeFpgaImagesResponse -> Constr #

dataTypeOf :: DescribeFpgaImagesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeFpgaImagesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeFpgaImagesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeFpgaImagesResponse -> DescribeFpgaImagesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFpgaImagesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeFpgaImagesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeFpgaImagesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeFpgaImagesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeFpgaImagesResponse -> m DescribeFpgaImagesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFpgaImagesResponse -> m DescribeFpgaImagesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeFpgaImagesResponse -> m DescribeFpgaImagesResponse #

Read DescribeFpgaImagesResponse Source # 
Show DescribeFpgaImagesResponse Source # 
Generic DescribeFpgaImagesResponse Source # 
NFData DescribeFpgaImagesResponse Source # 
type Rep DescribeFpgaImagesResponse Source # 
type Rep DescribeFpgaImagesResponse = D1 (MetaData "DescribeFpgaImagesResponse" "Network.AWS.EC2.DescribeFpgaImages" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "DescribeFpgaImagesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dfirsFpgaImages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FpgaImage]))) ((:*:) (S1 (MetaSel (Just Symbol "_dfirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dfirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

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.