Network.AWS.KMS.GetParametersForImport

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide .

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL . You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

Creating a Request

getParametersForImport

Arguments

:: Text

gpfiKeyId

-> AlgorithmSpec

gpfiWrappingAlgorithm

-> WrappingKeySpec

gpfiWrappingKeySpec

-> GetParametersForImport

Creates a value of GetParametersForImport with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gpfiKeyId - The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL . A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• gpfiWrappingAlgorithm - The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial . For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide .
• gpfiWrappingKeySpec - The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

data GetParametersForImport

See: getParametersForImport smart constructor.

Instances

Eq GetParametersForImport

Methods

(==) :: GetParametersForImport -> GetParametersForImport -> Bool

(/=) :: GetParametersForImport -> GetParametersForImport -> Bool

Data GetParametersForImport

Methods

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

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

toConstr :: GetParametersForImport -> Constr

dataTypeOf :: GetParametersForImport -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetParametersForImport -> GetParametersForImport

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

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

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

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

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

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

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

Read GetParametersForImport

Methods

readsPrec :: Int -> ReadS GetParametersForImport

readList :: ReadS [GetParametersForImport]

readPrec :: ReadPrec GetParametersForImport

readListPrec :: ReadPrec [GetParametersForImport]

Show GetParametersForImport

Methods

showsPrec :: Int -> GetParametersForImport -> ShowS

show :: GetParametersForImport -> String

showList :: [GetParametersForImport] -> ShowS

Generic GetParametersForImport

Associated Types

type Rep GetParametersForImport :: * -> *

Methods

from :: GetParametersForImport -> Rep GetParametersForImport x

to :: Rep GetParametersForImport x -> GetParametersForImport

Hashable GetParametersForImport

Methods

hashWithSalt :: Int -> GetParametersForImport -> Int

hash :: GetParametersForImport -> Int

ToJSON GetParametersForImport

Methods

toJSON :: GetParametersForImport -> Value

toEncoding :: GetParametersForImport -> Encoding

toJSONList :: [GetParametersForImport] -> Value

toEncodingList :: [GetParametersForImport] -> Encoding

NFData GetParametersForImport

Methods

rnf :: GetParametersForImport -> ()

AWSRequest GetParametersForImport

Associated Types

type Rs GetParametersForImport :: *

Methods

request :: GetParametersForImport -> Request GetParametersForImport

response :: MonadResource m => Logger -> Service -> Proxy * GetParametersForImport -> ClientResponse -> m (Response GetParametersForImport)

ToPath GetParametersForImport

Methods

toPath :: GetParametersForImport -> ByteString

ToHeaders GetParametersForImport

Methods

toHeaders :: GetParametersForImport -> [Header]

ToQuery GetParametersForImport

Methods

toQuery :: GetParametersForImport -> QueryString

type Rep GetParametersForImport

type Rep GetParametersForImport = D1 (MetaData "GetParametersForImport" "Network.AWS.KMS.GetParametersForImport" "amazonka-kms-1.4.5-2CcuwPQYK1JBjEgZ8528Xg" False) (C1 (MetaCons "GetParametersForImport'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gpfiKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_gpfiWrappingAlgorithm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AlgorithmSpec)) (S1 (MetaSel (Just Symbol "_gpfiWrappingKeySpec") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 WrappingKeySpec)))))

type Rs GetParametersForImport

type Rs GetParametersForImport = GetParametersForImportResponse

Request Lenses

gpfiKeyId :: Lens' GetParametersForImport Text

The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL . A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

gpfiWrappingAlgorithm :: Lens' GetParametersForImport AlgorithmSpec

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial . For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide .

gpfiWrappingKeySpec :: Lens' GetParametersForImport WrappingKeySpec

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

Destructuring the Response

getParametersForImportResponse

Arguments

:: Int

gpfirsResponseStatus

-> GetParametersForImportResponse

Creates a value of GetParametersForImportResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gpfirsKeyId - The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.
• gpfirsPublicKey - The public key to use to encrypt the key material before importing it with ImportKeyMaterial .-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
• gpfirsParametersValidTo - The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to retrieve new ones.
• gpfirsImportToken - The import token to send in a subsequent ImportKeyMaterial request.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
• gpfirsResponseStatus - -- | The response status code.

data GetParametersForImportResponse

See: getParametersForImportResponse smart constructor.

Instances

Eq GetParametersForImportResponse

Methods

(==) :: GetParametersForImportResponse -> GetParametersForImportResponse -> Bool

(/=) :: GetParametersForImportResponse -> GetParametersForImportResponse -> Bool

Data GetParametersForImportResponse

Methods

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

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

toConstr :: GetParametersForImportResponse -> Constr

dataTypeOf :: GetParametersForImportResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetParametersForImportResponse -> GetParametersForImportResponse

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

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

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

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

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

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

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

Read GetParametersForImportResponse

Methods

readsPrec :: Int -> ReadS GetParametersForImportResponse

readList :: ReadS [GetParametersForImportResponse]

readPrec :: ReadPrec GetParametersForImportResponse

readListPrec :: ReadPrec [GetParametersForImportResponse]

Show GetParametersForImportResponse

Methods

showsPrec :: Int -> GetParametersForImportResponse -> ShowS

show :: GetParametersForImportResponse -> String

showList :: [GetParametersForImportResponse] -> ShowS

Generic GetParametersForImportResponse

Associated Types

type Rep GetParametersForImportResponse :: * -> *

Methods

from :: GetParametersForImportResponse -> Rep GetParametersForImportResponse x

to :: Rep GetParametersForImportResponse x -> GetParametersForImportResponse

NFData GetParametersForImportResponse

Methods

rnf :: GetParametersForImportResponse -> ()

type Rep GetParametersForImportResponse

type Rep GetParametersForImportResponse = D1 (MetaData "GetParametersForImportResponse" "Network.AWS.KMS.GetParametersForImport" "amazonka-kms-1.4.5-2CcuwPQYK1JBjEgZ8528Xg" False) (C1 (MetaCons "GetParametersForImportResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gpfirsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gpfirsPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Base64))))) ((:*:) (S1 (MetaSel (Just Symbol "_gpfirsParametersValidTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_gpfirsImportToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Base64))) (S1 (MetaSel (Just Symbol "_gpfirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))))

Response Lenses

gpfirsKeyId :: Lens' GetParametersForImportResponse (Maybe Text)

The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.

gpfirsPublicKey :: Lens' GetParametersForImportResponse (Maybe ByteString)

The public key to use to encrypt the key material before importing it with ImportKeyMaterial .-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

gpfirsParametersValidTo :: Lens' GetParametersForImportResponse (Maybe UTCTime)

The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to retrieve new ones.

gpfirsImportToken :: Lens' GetParametersForImportResponse (Maybe ByteString)

The import token to send in a subsequent ImportKeyMaterial request.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

gpfirsResponseStatus :: Lens' GetParametersForImportResponse Int

• - | The response status code.