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

Amazonka.EC2.CreateFpgaImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.

Synopsis

data CreateFpgaImage = CreateFpgaImage' {
- clientToken :: Maybe Text
- description :: Maybe Text
- dryRun :: Maybe Bool
- logsStorageLocation :: Maybe StorageLocation
- name :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
- inputStorageLocation :: StorageLocation
}
newCreateFpgaImage :: StorageLocation -> CreateFpgaImage
createFpgaImage_clientToken :: Lens' CreateFpgaImage (Maybe Text)
createFpgaImage_description :: Lens' CreateFpgaImage (Maybe Text)
createFpgaImage_dryRun :: Lens' CreateFpgaImage (Maybe Bool)
createFpgaImage_logsStorageLocation :: Lens' CreateFpgaImage (Maybe StorageLocation)
createFpgaImage_name :: Lens' CreateFpgaImage (Maybe Text)
createFpgaImage_tagSpecifications :: Lens' CreateFpgaImage (Maybe [TagSpecification])
createFpgaImage_inputStorageLocation :: Lens' CreateFpgaImage StorageLocation
data CreateFpgaImageResponse = CreateFpgaImageResponse' {
- fpgaImageGlobalId :: Maybe Text
- fpgaImageId :: Maybe Text
- httpStatus :: Int
}
newCreateFpgaImageResponse :: Int -> CreateFpgaImageResponse
createFpgaImageResponse_fpgaImageGlobalId :: Lens' CreateFpgaImageResponse (Maybe Text)
createFpgaImageResponse_fpgaImageId :: Lens' CreateFpgaImageResponse (Maybe Text)
createFpgaImageResponse_httpStatus :: Lens' CreateFpgaImageResponse Int

Creating a Request

data CreateFpgaImage Source #

See: newCreateFpgaImage smart constructor.

Constructors

CreateFpgaImage'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
description :: Maybe Text
A description for the AFI.
dryRun :: Maybe Bool
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.
logsStorageLocation :: Maybe StorageLocation
The location in Amazon S3 for the output logs.
name :: Maybe Text
A name for the AFI.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the FPGA image during creation.
inputStorageLocation :: StorageLocation
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

Instances

Instances details

ToHeaders CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods toHeaders :: CreateFpgaImage -> [Header] #
ToPath CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods toPath :: CreateFpgaImage -> ByteString #
ToQuery CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods toQuery :: CreateFpgaImage -> QueryString #
AWSRequest CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Associated Types type AWSResponse CreateFpgaImage # Methods request :: (Service -> Service) -> CreateFpgaImage -> Request CreateFpgaImage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFpgaImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFpgaImage))) #
Generic CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Associated Types type Rep CreateFpgaImage :: Type -> Type # Methods from :: CreateFpgaImage -> Rep CreateFpgaImage x # to :: Rep CreateFpgaImage x -> CreateFpgaImage #
Read CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods readsPrec :: Int -> ReadS CreateFpgaImage # readList :: ReadS [CreateFpgaImage] # readPrec :: ReadPrec CreateFpgaImage # readListPrec :: ReadPrec [CreateFpgaImage] #
Show CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods showsPrec :: Int -> CreateFpgaImage -> ShowS # show :: CreateFpgaImage -> String # showList :: [CreateFpgaImage] -> ShowS #
NFData CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods rnf :: CreateFpgaImage -> () #
Eq CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods (==) :: CreateFpgaImage -> CreateFpgaImage -> Bool # (/=) :: CreateFpgaImage -> CreateFpgaImage -> Bool #
Hashable CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods hashWithSalt :: Int -> CreateFpgaImage -> Int # hash :: CreateFpgaImage -> Int #
type AWSResponse CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage type AWSResponse CreateFpgaImage = CreateFpgaImageResponse
type Rep CreateFpgaImage Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage type Rep CreateFpgaImage = D1 ('MetaData "CreateFpgaImage" "Amazonka.EC2.CreateFpgaImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateFpgaImage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "logsStorageLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageLocation)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :: S1 ('MetaSel ('Just "inputStorageLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StorageLocation)))))

newCreateFpgaImage Source #

Arguments

:: StorageLocation	`$sel:inputStorageLocation:CreateFpgaImage'`
-> CreateFpgaImage

Create a value of CreateFpgaImage 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:

CreateFpgaImage, createFpgaImage_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

CreateFpgaImage, createFpgaImage_description - A description for the AFI.

$sel:dryRun:CreateFpgaImage', createFpgaImage_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:logsStorageLocation:CreateFpgaImage', createFpgaImage_logsStorageLocation - The location in Amazon S3 for the output logs.

CreateFpgaImage, createFpgaImage_name - A name for the AFI.

CreateFpgaImage, createFpgaImage_tagSpecifications - The tags to apply to the FPGA image during creation.

$sel:inputStorageLocation:CreateFpgaImage', createFpgaImage_inputStorageLocation - The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

Request Lenses

createFpgaImage_clientToken :: Lens' CreateFpgaImage (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

createFpgaImage_description :: Lens' CreateFpgaImage (Maybe Text) Source #

A description for the AFI.

createFpgaImage_dryRun :: Lens' CreateFpgaImage (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.

createFpgaImage_logsStorageLocation :: Lens' CreateFpgaImage (Maybe StorageLocation) Source #

The location in Amazon S3 for the output logs.

createFpgaImage_name :: Lens' CreateFpgaImage (Maybe Text) Source #

A name for the AFI.

createFpgaImage_tagSpecifications :: Lens' CreateFpgaImage (Maybe [TagSpecification]) Source #

The tags to apply to the FPGA image during creation.

createFpgaImage_inputStorageLocation :: Lens' CreateFpgaImage StorageLocation Source #

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

Destructuring the Response

data CreateFpgaImageResponse Source #

See: newCreateFpgaImageResponse smart constructor.

Constructors

CreateFpgaImageResponse'
Fields fpgaImageGlobalId :: Maybe Text The global FPGA image identifier (AGFI ID). fpgaImageId :: Maybe Text The FPGA image identifier (AFI ID). httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateFpgaImageResponse Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Associated Types type Rep CreateFpgaImageResponse :: Type -> Type # Methods from :: CreateFpgaImageResponse -> Rep CreateFpgaImageResponse x # to :: Rep CreateFpgaImageResponse x -> CreateFpgaImageResponse #
Read CreateFpgaImageResponse Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods readsPrec :: Int -> ReadS CreateFpgaImageResponse # readList :: ReadS [CreateFpgaImageResponse] # readPrec :: ReadPrec CreateFpgaImageResponse # readListPrec :: ReadPrec [CreateFpgaImageResponse] #
Show CreateFpgaImageResponse Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods showsPrec :: Int -> CreateFpgaImageResponse -> ShowS # show :: CreateFpgaImageResponse -> String # showList :: [CreateFpgaImageResponse] -> ShowS #
NFData CreateFpgaImageResponse Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods rnf :: CreateFpgaImageResponse -> () #
Eq CreateFpgaImageResponse Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage Methods (==) :: CreateFpgaImageResponse -> CreateFpgaImageResponse -> Bool # (/=) :: CreateFpgaImageResponse -> CreateFpgaImageResponse -> Bool #
type Rep CreateFpgaImageResponse Source #
Instance details Defined in Amazonka.EC2.CreateFpgaImage type Rep CreateFpgaImageResponse = D1 ('MetaData "CreateFpgaImageResponse" "Amazonka.EC2.CreateFpgaImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateFpgaImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fpgaImageGlobalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fpgaImageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFpgaImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFpgaImageResponse'`
-> CreateFpgaImageResponse

Create a value of CreateFpgaImageResponse 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:

CreateFpgaImageResponse, createFpgaImageResponse_fpgaImageGlobalId - The global FPGA image identifier (AGFI ID).

CreateFpgaImageResponse, createFpgaImageResponse_fpgaImageId - The FPGA image identifier (AFI ID).

$sel:httpStatus:CreateFpgaImageResponse', createFpgaImageResponse_httpStatus - The response's http status code.

Response Lenses

createFpgaImageResponse_fpgaImageGlobalId :: Lens' CreateFpgaImageResponse (Maybe Text) Source #

The global FPGA image identifier (AGFI ID).

createFpgaImageResponse_fpgaImageId :: Lens' CreateFpgaImageResponse (Maybe Text) Source #

The FPGA image identifier (AFI ID).

createFpgaImageResponse_httpStatus :: Lens' CreateFpgaImageResponse Int Source #

The response's http status code.