packages feed

amazonka-kms 1.4.4 → 1.4.5

raw patch · 37 files changed

+535/−838 lines, 37 filesdep ~amazonka-coredep ~amazonka-kmsdep ~amazonka-testPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

Dependency ranges changed: amazonka-core, amazonka-kms, amazonka-test

API changes (from Hackage documentation)

- Network.AWS.KMS.CancelKeyDeletion: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.CancelKeyDeletion.CancelKeyDeletion
- Network.AWS.KMS.CreateAlias: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.CreateAlias.CreateAlias
- Network.AWS.KMS.CreateGrant: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.CreateGrant.CreateGrant
- Network.AWS.KMS.CreateKey: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.CreateKey.CreateKey
- Network.AWS.KMS.Decrypt: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.Decrypt.Decrypt
- Network.AWS.KMS.DeleteAlias: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.DeleteAlias.DeleteAlias
- Network.AWS.KMS.DeleteImportedKeyMaterial: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.DeleteImportedKeyMaterial.DeleteImportedKeyMaterial
- Network.AWS.KMS.DescribeKey: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.DescribeKey.DescribeKey
- Network.AWS.KMS.DisableKey: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.DisableKey.DisableKey
- Network.AWS.KMS.DisableKeyRotation: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.DisableKeyRotation.DisableKeyRotation
- Network.AWS.KMS.EnableKey: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.EnableKey.EnableKey
- Network.AWS.KMS.EnableKeyRotation: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.EnableKeyRotation.EnableKeyRotation
- Network.AWS.KMS.Encrypt: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.Encrypt.Encrypt
- Network.AWS.KMS.GenerateDataKey: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.GenerateDataKey.GenerateDataKey
- Network.AWS.KMS.GenerateDataKeyWithoutPlaintext: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.GenerateDataKeyWithoutPlaintext.GenerateDataKeyWithoutPlaintext
- Network.AWS.KMS.GenerateRandom: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.GenerateRandom.GenerateRandom
- Network.AWS.KMS.GetKeyPolicy: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.GetKeyPolicy.GetKeyPolicy
- Network.AWS.KMS.GetKeyRotationStatus: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.GetKeyRotationStatus.GetKeyRotationStatus
- Network.AWS.KMS.GetParametersForImport: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.GetParametersForImport.GetParametersForImport
- Network.AWS.KMS.ImportKeyMaterial: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ImportKeyMaterial.ImportKeyMaterial
- Network.AWS.KMS.ListAliases: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ListAliases.ListAliases
- Network.AWS.KMS.ListGrants: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ListGrants.ListGrants
- Network.AWS.KMS.ListKeyPolicies: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ListKeyPolicies.ListKeyPolicies
- Network.AWS.KMS.ListKeys: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ListKeys.ListKeys
- Network.AWS.KMS.ListRetirableGrants: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ListRetirableGrants.ListRetirableGrants
- Network.AWS.KMS.PutKeyPolicy: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.PutKeyPolicy.PutKeyPolicy
- Network.AWS.KMS.ReEncrypt: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ReEncrypt.ReEncrypt
- Network.AWS.KMS.RetireGrant: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.RetireGrant.RetireGrant
- Network.AWS.KMS.RevokeGrant: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.RevokeGrant.RevokeGrant
- Network.AWS.KMS.ScheduleKeyDeletion: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.ScheduleKeyDeletion.ScheduleKeyDeletion
- Network.AWS.KMS.UpdateAlias: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.UpdateAlias.UpdateAlias
- Network.AWS.KMS.UpdateKeyDescription: instance Data.Aeson.Types.Class.ToJSON Network.AWS.KMS.UpdateKeyDescription.UpdateKeyDescription
+ Network.AWS.KMS.CancelKeyDeletion: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.CancelKeyDeletion.CancelKeyDeletion
+ Network.AWS.KMS.CreateAlias: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.CreateAlias.CreateAlias
+ Network.AWS.KMS.CreateGrant: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.CreateGrant.CreateGrant
+ Network.AWS.KMS.CreateKey: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.CreateKey.CreateKey
+ Network.AWS.KMS.Decrypt: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.Decrypt.Decrypt
+ Network.AWS.KMS.DeleteAlias: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.DeleteAlias.DeleteAlias
+ Network.AWS.KMS.DeleteImportedKeyMaterial: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.DeleteImportedKeyMaterial.DeleteImportedKeyMaterial
+ Network.AWS.KMS.DescribeKey: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.DescribeKey.DescribeKey
+ Network.AWS.KMS.DisableKey: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.DisableKey.DisableKey
+ Network.AWS.KMS.DisableKeyRotation: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.DisableKeyRotation.DisableKeyRotation
+ Network.AWS.KMS.EnableKey: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.EnableKey.EnableKey
+ Network.AWS.KMS.EnableKeyRotation: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.EnableKeyRotation.EnableKeyRotation
+ Network.AWS.KMS.Encrypt: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.Encrypt.Encrypt
+ Network.AWS.KMS.GenerateDataKey: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.GenerateDataKey.GenerateDataKey
+ Network.AWS.KMS.GenerateDataKeyWithoutPlaintext: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.GenerateDataKeyWithoutPlaintext.GenerateDataKeyWithoutPlaintext
+ Network.AWS.KMS.GenerateRandom: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.GenerateRandom.GenerateRandom
+ Network.AWS.KMS.GetKeyPolicy: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.GetKeyPolicy.GetKeyPolicy
+ Network.AWS.KMS.GetKeyRotationStatus: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.GetKeyRotationStatus.GetKeyRotationStatus
+ Network.AWS.KMS.GetParametersForImport: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.GetParametersForImport.GetParametersForImport
+ Network.AWS.KMS.ImportKeyMaterial: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ImportKeyMaterial.ImportKeyMaterial
+ Network.AWS.KMS.ListAliases: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ListAliases.ListAliases
+ Network.AWS.KMS.ListGrants: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ListGrants.ListGrants
+ Network.AWS.KMS.ListKeyPolicies: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ListKeyPolicies.ListKeyPolicies
+ Network.AWS.KMS.ListKeys: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ListKeys.ListKeys
+ Network.AWS.KMS.ListRetirableGrants: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ListRetirableGrants.ListRetirableGrants
+ Network.AWS.KMS.PutKeyPolicy: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.PutKeyPolicy.PutKeyPolicy
+ Network.AWS.KMS.ReEncrypt: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ReEncrypt.ReEncrypt
+ Network.AWS.KMS.RetireGrant: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.RetireGrant.RetireGrant
+ Network.AWS.KMS.RevokeGrant: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.RevokeGrant.RevokeGrant
+ Network.AWS.KMS.ScheduleKeyDeletion: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.ScheduleKeyDeletion.ScheduleKeyDeletion
+ Network.AWS.KMS.UpdateAlias: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.UpdateAlias.UpdateAlias
+ Network.AWS.KMS.UpdateKeyDescription: instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.KMS.UpdateKeyDescription.UpdateKeyDescription

Files

README.md view
@@ -8,64 +8,27 @@  ## Version -`1.4.4`+`1.4.5`   ## Description -AWS Key Management Service--AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <http://docs.aws.amazon.com/kms/latest/developerguide/ AWS Key Management Service Developer Guide>.--AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <http://aws.amazon.com/tools/ Tools for Amazon Web Services>.--We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.--Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.--__Signing Requests__--Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you /do not/ use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.--All AWS KMS operations require <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4>.--__Logging API Requests__--AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/ AWS CloudTrail User Guide>.--__Additional Resources__--For more information about credentials and request signing, see the following:---   <http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html AWS Security Credentials> - This topic provides general information about the types of credentials used for accessing AWS.---   <http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html Temporary Security Credentials> - This section of the /IAM User Guide/ describes how to create and use temporary security credentials.---   <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.--__Commonly Used APIs__--Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.---   < Encrypt>---   < Decrypt>---   < GenerateDataKey>---   < GenerateDataKeyWithoutPlaintext>- Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-kms) and the [AWS API Reference](https://aws.amazon.com/documentation/).  The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka),-which provides mechanisms for specifying AuthN/AuthZ information and sending requests.+which provides mechanisms for specifying AuthN/AuthZ information, sending requests,+and receiving responses. -Use of lenses is required for constructing and manipulating types.-This is due to the amount of nesting of AWS types and transparency regarding+Lenses are used for constructing and manipulating types,+due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries [lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core).++See [Network.AWS.KMS](http://hackage.haskell.org/package/amazonka-kms/docs/Network-AWS-KMS.html)+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.+  ## Contribute 
amazonka-kms.cabal view
@@ -1,5 +1,5 @@ name:                  amazonka-kms-version:               1.4.4+version:               1.4.5 synopsis:              Amazon Key Management Service SDK. homepage:              https://github.com/brendanhay/amazonka bug-reports:           https://github.com/brendanhay/amazonka/issues@@ -13,60 +13,19 @@ cabal-version:         >= 1.10 extra-source-files:    README.md fixture/*.yaml fixture/*.proto src/.gitkeep description:-    AWS Key Management Service--    AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <http://docs.aws.amazon.com/kms/latest/developerguide/ AWS Key Management Service Developer Guide>.--    AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <http://aws.amazon.com/tools/ Tools for Amazon Web Services>.--    We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.--    Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.--    __Signing Requests__--    Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you /do not/ use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.--    All AWS KMS operations require <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4>.--    __Logging API Requests__--    AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/ AWS CloudTrail User Guide>.--    __Additional Resources__--    For more information about credentials and request signing, see the following:--    -   <http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html AWS Security Credentials> - This topic provides general information about the types of credentials used for accessing AWS.--    -   <http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html Temporary Security Credentials> - This section of the /IAM User Guide/ describes how to create and use temporary security credentials.--    -   <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.--    __Commonly Used APIs__--    Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.--    -   < Encrypt>--    -   < Decrypt>--    -   < GenerateDataKey>--    -   < GenerateDataKeyWithoutPlaintext>-    .     The types from this library are intended to be used with     <http://hackage.haskell.org/package/amazonka amazonka>, which provides-    mechanisms for specifying AuthN/AuthZ information and sending requests.+    mechanisms for specifying AuthN/AuthZ information, sending requests,+    and receiving responses.     .-    Use of lenses is required for constructing and manipulating types.-    This is due to the amount of nesting of AWS types and transparency regarding+    Lenses are used for constructing and manipulating types,+    due to the depth of nesting of AWS types and transparency regarding     de/serialisation into more palatable Haskell values.     The provided lenses should be compatible with any of the major lens libraries     such as <http://hackage.haskell.org/package/lens lens> or     <http://hackage.haskell.org/package/lens-family-core lens-family-core>.     .-    See "Network.AWS.KMS" or <https://aws.amazon.com/documentation/ the AWS Documentation>+    See "Network.AWS.KMS" or <https://aws.amazon.com/documentation/ the AWS documentation>     to get started.  source-repository head@@ -121,7 +80,7 @@         , Network.AWS.KMS.Types.Sum      build-depends:-          amazonka-core == 1.4.4.*+          amazonka-core == 1.4.5.*         , base          >= 4.7     && < 5  test-suite amazonka-kms-test@@ -141,9 +100,9 @@         , Test.AWS.KMS.Internal      build-depends:-          amazonka-core == 1.4.4.*-        , amazonka-test == 1.4.4.*-        , amazonka-kms == 1.4.4.*+          amazonka-core == 1.4.5.*+        , amazonka-test == 1.4.5.*+        , amazonka-kms == 1.4.5.*         , base         , bytestring         , tasty
gen/Network/AWS/KMS.hs view
@@ -11,11 +11,9 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- AWS Key Management Service------ AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <http://docs.aws.amazon.com/kms/latest/developerguide/ AWS Key Management Service Developer Guide>.+-- __AWS Key Management Service__ ----- AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <http://aws.amazon.com/tools/ Tools for Amazon Web Services>.+-- AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <http://docs.aws.amazon.com/kms/latest/developerguide/ AWS Key Management Service Developer Guide> . -- -- We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS. --@@ -25,33 +23,37 @@ -- -- Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you /do not/ use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests. ----- All AWS KMS operations require <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4>.+-- All AWS KMS operations require <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4> . -- -- __Logging API Requests__ ----- AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/ AWS CloudTrail User Guide>.+-- AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/ AWS CloudTrail User Guide> . -- -- __Additional Resources__ -- -- For more information about credentials and request signing, see the following: ----- -   <http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html AWS Security Credentials> - This topic provides general information about the types of credentials used for accessing AWS.+--     * <http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html AWS Security Credentials> - This topic provides general information about the types of credentials used for accessing AWS. ----- -   <http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html Temporary Security Credentials> - This section of the /IAM User Guide/ describes how to create and use temporary security credentials.+--     * <http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html Temporary Security Credentials> - This section of the /IAM User Guide/ describes how to create and use temporary security credentials. ----- -   <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.+--     * <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key. --+--+-- -- __Commonly Used APIs__ -- -- Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console. ----- -   < Encrypt>+--     * 'Encrypt' ----- -   < Decrypt>+--     * 'Decrypt' ----- -   < GenerateDataKey>+--     * 'GenerateDataKey' ----- -   < GenerateDataKeyWithoutPlaintext>+--     * 'GenerateDataKeyWithoutPlaintext'+--+-- -- module Network.AWS.KMS     (
gen/Network/AWS/KMS/CancelKeyDeletion.hs view
@@ -18,9 +18,11 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the 'Disabled' state. To enable a CMK, use < EnableKey>.+-- Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the @Disabled@ state. To enable a CMK, use 'EnableKey' . ----- For more information about scheduling and canceling deletion of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html Deleting Customer Master Keys> in the /AWS Key Management Service Developer Guide/.+--+-- For more information about scheduling and canceling deletion of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html Deleting Customer Master Keys> in the /AWS Key Management Service Developer Guide/ .+-- module Network.AWS.KMS.CancelKeyDeletion     (     -- * Creating a Request@@ -53,7 +55,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ckdKeyId'+-- * 'ckdKeyId' - The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use 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 To obtain the unique key ID and key ARN for a given CMK, use 'ListKeys' or 'DescribeKey' . cancelKeyDeletion     :: Text -- ^ 'ckdKeyId'     -> CancelKeyDeletion@@ -62,15 +64,7 @@     { _ckdKeyId = pKeyId_     } --- | The unique identifier for the customer master key (CMK) for which to cancel deletion.------ To specify this value, use 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------ To obtain the unique key ID and key ARN for a given CMK, use < ListKeys> or < DescribeKey>.+-- | The unique identifier for the customer master key (CMK) for which to cancel deletion. To specify this value, use 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 To obtain the unique key ID and key ARN for a given CMK, use 'ListKeys' or 'DescribeKey' . ckdKeyId :: Lens' CancelKeyDeletion Text ckdKeyId = lens _ckdKeyId (\ s a -> s{_ckdKeyId = a}); @@ -116,9 +110,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ckdrsKeyId'+-- * 'ckdrsKeyId' - The unique identifier of the master key for which deletion is canceled. ----- * 'ckdrsResponseStatus'+-- * 'ckdrsResponseStatus' - -- | The response status code. cancelKeyDeletionResponse     :: Int -- ^ 'ckdrsResponseStatus'     -> CancelKeyDeletionResponse@@ -132,7 +126,7 @@ ckdrsKeyId :: Lens' CancelKeyDeletionResponse (Maybe Text) ckdrsKeyId = lens _ckdrsKeyId (\ s a -> s{_ckdrsKeyId = a}); --- | The response status code.+-- | -- | The response status code. ckdrsResponseStatus :: Lens' CancelKeyDeletionResponse Int ckdrsResponseStatus = lens _ckdrsResponseStatus (\ s a -> s{_ckdrsResponseStatus = a}); 
gen/Network/AWS/KMS/CreateAlias.hs view
@@ -18,11 +18,13 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (\/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias\/). An alias that begins with \"aws\" after the forward slash (alias\/aws...) is reserved by Amazon Web Services (AWS).+-- Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). --+-- -- The alias and the key it is mapped to must be in the same AWS account and the same region. ----- To map an alias to a different key, call < UpdateAlias>.+-- To map an alias to a different key, call 'UpdateAlias' .+-- module Network.AWS.KMS.CreateAlias     (     -- * Creating a Request@@ -54,9 +56,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'caAliasName'+-- * 'caAliasName' - String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. ----- * 'caTargetKeyId'+-- * 'caTargetKeyId' - An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 createAlias     :: Text -- ^ 'caAliasName'     -> Text -- ^ 'caTargetKeyId'@@ -67,16 +69,11 @@     , _caTargetKeyId = pTargetKeyId_     } --- | String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias\/). Aliases that begin with \"alias\/AWS\" are reserved.+-- | String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. caAliasName :: Lens' CreateAlias Text caAliasName = lens _caAliasName (\ s a -> s{_caAliasName = a}); --- | An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 caTargetKeyId :: Lens' CreateAlias Text caTargetKeyId = lens _caTargetKeyId (\ s a -> s{_caTargetKeyId = a}); 
gen/Network/AWS/KMS/CreateGrant.hs view
@@ -20,7 +20,9 @@ -- -- Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies. ----- For more information about grants, see <http://docs.aws.amazon.com/kms/latest/developerguide/grants.html Grants> in the /AWS Key Management Service Developer Guide/.+--+-- For more information about grants, see <http://docs.aws.amazon.com/kms/latest/developerguide/grants.html Grants> in the /AWS Key Management Service Developer Guide/ .+-- module Network.AWS.KMS.CreateGrant     (     -- * Creating a Request@@ -66,19 +68,19 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cgRetiringPrincipal'+-- * 'cgRetiringPrincipal' - The principal that is given permission to retire the grant by using 'RetireGrant' operation. To specify the principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /AWS General Reference/ . ----- * 'cgGrantTokens'+-- * 'cgGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'cgConstraints'+-- * 'cgConstraints' - The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ . ----- * 'cgName'+-- * 'cgName' - A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request. When this value is absent, all @CreateGrant@ requests result in a new grant with a unique @GrantId@ even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the @CreateGrant@ request. When this value is present, you can retry a @CreateGrant@ request with identical parameters; if the grant already exists, the original @GrantId@ is returned without creating a new grant. Note that the returned grant token is unique with every @CreateGrant@ request, even when a duplicate @GrantId@ is returned. All grant tokens obtained in this way can be used interchangeably. ----- * 'cgOperations'+-- * 'cgOperations' - A list of operations that the grant permits. The list can contain any combination of one or more of the following values:     * 'Decrypt'      * 'Encrypt'      * 'GenerateDataKey'      * 'GenerateDataKeyWithoutPlaintext'      * <http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html ReEncryptFrom>      * <http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html ReEncryptTo>      * 'CreateGrant'      * 'RetireGrant'      * 'DescribeKey' ----- * 'cgKeyId'+-- * 'cgKeyId' - The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:     * Globally unique key ID: 12345678-1234-1234-1234-123456789012     * Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012 ----- * 'cgGranteePrincipal'+-- * 'cgGranteePrincipal' - The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /AWS General Reference/ . createGrant     :: Text -- ^ 'cgKeyId'     -> Text -- ^ 'cgGranteePrincipal'@@ -94,69 +96,31 @@     , _cgGranteePrincipal = pGranteePrincipal_     } --- | The principal that is given permission to retire the grant by using < RetireGrant> operation.------ To specify the principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /AWS General Reference/.+-- | The principal that is given permission to retire the grant by using 'RetireGrant' operation. To specify the principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /AWS General Reference/ . cgRetiringPrincipal :: Lens' CreateGrant (Maybe Text) cgRetiringPrincipal = lens _cgRetiringPrincipal (\ s a -> s{_cgRetiringPrincipal = a}); --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . cgGrantTokens :: Lens' CreateGrant [Text] cgGrantTokens = lens _cgGrantTokens (\ s a -> s{_cgGrantTokens = a}) . _Default . _Coerce; --- | The conditions under which the operations permitted by the grant are allowed.------ You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/.+-- | The conditions under which the operations permitted by the grant are allowed. You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ . cgConstraints :: Lens' CreateGrant (Maybe GrantConstraints) cgConstraints = lens _cgConstraints (\ s a -> s{_cgConstraints = a}); --- | A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.------ When this value is absent, all 'CreateGrant' requests result in a new grant with a unique 'GrantId' even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the 'CreateGrant' request.------ When this value is present, you can retry a 'CreateGrant' request with identical parameters; if the grant already exists, the original 'GrantId' is returned without creating a new grant. Note that the returned grant token is unique with every 'CreateGrant' request, even when a duplicate 'GrantId' is returned. All grant tokens obtained in this way can be used interchangeably.+-- | A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request. When this value is absent, all @CreateGrant@ requests result in a new grant with a unique @GrantId@ even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the @CreateGrant@ request. When this value is present, you can retry a @CreateGrant@ request with identical parameters; if the grant already exists, the original @GrantId@ is returned without creating a new grant. Note that the returned grant token is unique with every @CreateGrant@ request, even when a duplicate @GrantId@ is returned. All grant tokens obtained in this way can be used interchangeably. cgName :: Lens' CreateGrant (Maybe Text) cgName = lens _cgName (\ s a -> s{_cgName = a}); --- | A list of operations that the grant permits. The list can contain any combination of one or more of the following values:------ -   < Decrypt>------ -   < Encrypt>------ -   < GenerateDataKey>------ -   < GenerateDataKeyWithoutPlaintext>------ -   <http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html ReEncryptFrom>------ -   <http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html ReEncryptTo>------ -   < CreateGrant>------ -   < RetireGrant>------ -   < DescribeKey>---+-- | A list of operations that the grant permits. The list can contain any combination of one or more of the following values:     * 'Decrypt'      * 'Encrypt'      * 'GenerateDataKey'      * 'GenerateDataKeyWithoutPlaintext'      * <http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html ReEncryptFrom>      * <http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html ReEncryptTo>      * 'CreateGrant'      * 'RetireGrant'      * 'DescribeKey' cgOperations :: Lens' CreateGrant [GrantOperation] cgOperations = lens _cgOperations (\ s a -> s{_cgOperations = a}) . _Default . _Coerce; --- | The unique identifier for the customer master key (CMK) that the grant applies to.------ To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:------ -   Globally unique key ID: 12345678-1234-1234-1234-123456789012------ -   Key ARN: arn:aws:kms:us-west-2:123456789012:key\/12345678-1234-1234-1234-123456789012---+-- | The unique identifier for the customer master key (CMK) that the grant applies to. To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:     * Globally unique key ID: 12345678-1234-1234-1234-123456789012     * Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012 cgKeyId :: Lens' CreateGrant Text cgKeyId = lens _cgKeyId (\ s a -> s{_cgKeyId = a}); --- | The principal that is given permission to perform the operations that the grant permits.------ To specify the principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /AWS General Reference/.+-- | The principal that is given permission to perform the operations that the grant permits. To specify the principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /AWS General Reference/ . cgGranteePrincipal :: Lens' CreateGrant Text cgGranteePrincipal = lens _cgGranteePrincipal (\ s a -> s{_cgGranteePrincipal = a}); @@ -212,11 +176,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'cgrsGrantId'+-- * 'cgrsGrantId' - The unique identifier for the grant. You can use the @GrantId@ in a subsequent 'RetireGrant' or 'RevokeGrant' operation. ----- * 'cgrsGrantToken'+-- * 'cgrsGrantToken' - The grant token. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'cgrsResponseStatus'+-- * 'cgrsResponseStatus' - -- | The response status code. createGrantResponse     :: Int -- ^ 'cgrsResponseStatus'     -> CreateGrantResponse@@ -227,19 +191,15 @@     , _cgrsResponseStatus = pResponseStatus_     } --- | The unique identifier for the grant.------ You can use the 'GrantId' in a subsequent < RetireGrant> or < RevokeGrant> operation.+-- | The unique identifier for the grant. You can use the @GrantId@ in a subsequent 'RetireGrant' or 'RevokeGrant' operation. cgrsGrantId :: Lens' CreateGrantResponse (Maybe Text) cgrsGrantId = lens _cgrsGrantId (\ s a -> s{_cgrsGrantId = a}); --- | The grant token.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | The grant token. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . cgrsGrantToken :: Lens' CreateGrantResponse (Maybe Text) cgrsGrantToken = lens _cgrsGrantToken (\ s a -> s{_cgrsGrantToken = a}); --- | The response status code.+-- | -- | The response status code. cgrsResponseStatus :: Lens' CreateGrantResponse Int cgrsResponseStatus = lens _cgrsResponseStatus (\ s a -> s{_cgrsResponseStatus = a}); 
gen/Network/AWS/KMS/CreateKey.hs view
@@ -20,12 +20,15 @@ -- -- Creates a customer master key (CMK). --+-- -- You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following: ----- -   The < GenerateDataKey> operation+--     * The 'GenerateDataKey' operation ----- -   <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html AWS Key Management Service Concepts> in the /AWS Key Management Service Developer Guide/+--     * <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html AWS Key Management Service Concepts> in the /AWS Key Management Service Developer Guide/ --+--+-- module Network.AWS.KMS.CreateKey     (     -- * Creating a Request@@ -66,15 +69,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ckOrigin'+-- * 'ckOrigin' - The source of the CMK's key material. The default is @AWS_KMS@ , which means AWS KMS creates the key material. When this parameter is set to @EXTERNAL@ , the request creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/ . The CMK's @Origin@ is immutable and is set when the CMK is created. ----- * 'ckKeyUsage'+-- * 'ckKeyUsage' - The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption. ----- * 'ckBypassPolicyLockoutSafetyCheck'+-- * 'ckBypassPolicyLockoutSafetyCheck' - A flag to indicate whether to bypass the key policy lockout safety check. /Important:/ Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ . Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent 'PutKeyPolicy' request on the CMK. The default value is false. ----- * 'ckPolicy'+-- * 'ckPolicy' - The key policy to attach to the CMK. If you specify a policy and do not set @BypassPolicyLockoutSafetyCheck@ to true, the policy must meet the following criteria:     * It must allow the principal making the @CreateKey@ request to make a subsequent 'PutKeyPolicy' request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ .     * The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see <http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency Changes that I make are not always immediately visible> in the /IAM User Guide/ . If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default Default Key Policy> in the /AWS Key Management Service Developer Guide/ . The policy size limit is 32 KiB (32768 bytes). ----- * 'ckDescription'+-- * 'ckDescription' - A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task. createKey     :: CreateKey createKey =@@ -86,49 +89,23 @@     , _ckDescription = Nothing     } --- | The source of the CMK\'s key material.------ The default is 'AWS_KMS', which means AWS KMS creates the key material. When this parameter is set to 'EXTERNAL', the request creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/.------ The CMK\'s 'Origin' is immutable and is set when the CMK is created.+-- | The source of the CMK's key material. The default is @AWS_KMS@ , which means AWS KMS creates the key material. When this parameter is set to @EXTERNAL@ , the request creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/ . The CMK's @Origin@ is immutable and is set when the CMK is created. ckOrigin :: Lens' CreateKey (Maybe OriginType) ckOrigin = lens _ckOrigin (\ s a -> s{_ckOrigin = a}); --- | The intended use of the CMK.------ You can use CMKs only for symmetric encryption and decryption.+-- | The intended use of the CMK. You can use CMKs only for symmetric encryption and decryption. ckKeyUsage :: Lens' CreateKey (Maybe KeyUsageType) ckKeyUsage = lens _ckKeyUsage (\ s a -> s{_ckKeyUsage = a}); --- | A flag to indicate whether to bypass the key policy lockout safety check.------ Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.------ For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/.------ Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent < PutKeyPolicy> request on the CMK.------ The default value is false.+-- | A flag to indicate whether to bypass the key policy lockout safety check. /Important:/ Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ . Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent 'PutKeyPolicy' request on the CMK. The default value is false. ckBypassPolicyLockoutSafetyCheck :: Lens' CreateKey (Maybe Bool) ckBypassPolicyLockoutSafetyCheck = lens _ckBypassPolicyLockoutSafetyCheck (\ s a -> s{_ckBypassPolicyLockoutSafetyCheck = a}); --- | The key policy to attach to the CMK.------ If you specify a policy and do not set 'BypassPolicyLockoutSafetyCheck' to true, the policy must meet the following criteria:------ -   It must allow the principal making the 'CreateKey' request to make a subsequent < PutKeyPolicy> request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/.------ -   The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see <http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency Changes that I make are not always immediately visible> in the /IAM User Guide/.------ If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default Default Key Policy> in the /AWS Key Management Service Developer Guide/.------ The policy size limit is 32 KiB (32768 bytes).+-- | The key policy to attach to the CMK. If you specify a policy and do not set @BypassPolicyLockoutSafetyCheck@ to true, the policy must meet the following criteria:     * It must allow the principal making the @CreateKey@ request to make a subsequent 'PutKeyPolicy' request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ .     * The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see <http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency Changes that I make are not always immediately visible> in the /IAM User Guide/ . If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default Default Key Policy> in the /AWS Key Management Service Developer Guide/ . The policy size limit is 32 KiB (32768 bytes). ckPolicy :: Lens' CreateKey (Maybe Text) ckPolicy = lens _ckPolicy (\ s a -> s{_ckPolicy = a}); --- | A description of the CMK.------ Use a description that helps you decide whether the CMK is appropriate for a task.+-- | A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task. ckDescription :: Lens' CreateKey (Maybe Text) ckDescription = lens _ckDescription (\ s a -> s{_ckDescription = a}); @@ -181,9 +158,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ckrsKeyMetadata'+-- * 'ckrsKeyMetadata' - Metadata associated with the CMK. ----- * 'ckrsResponseStatus'+-- * 'ckrsResponseStatus' - -- | The response status code. createKeyResponse     :: Int -- ^ 'ckrsResponseStatus'     -> CreateKeyResponse@@ -197,7 +174,7 @@ ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata) ckrsKeyMetadata = lens _ckrsKeyMetadata (\ s a -> s{_ckrsKeyMetadata = a}); --- | The response status code.+-- | -- | The response status code. ckrsResponseStatus :: Lens' CreateKeyResponse Int ckrsResponseStatus = lens _ckrsResponseStatus (\ s a -> s{_ckrsResponseStatus = a}); 
gen/Network/AWS/KMS/Decrypt.hs view
@@ -20,13 +20,17 @@ -- -- Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions: ----- -   < GenerateDataKey> ----- -   < GenerateDataKeyWithoutPlaintext>+--     * 'GenerateDataKey' ----- -   < Encrypt>+--     * 'GenerateDataKeyWithoutPlaintext' ----- Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant 'Decrypt' permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant 'Decrypt' access in an IAM user policy. Instead grant 'Decrypt' access only in key policies. If you must grant 'Decrypt' access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.+--     * 'Encrypt'+--+--+--+-- Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant @Decrypt@ permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant @Decrypt@ access in an IAM user policy. Instead grant @Decrypt@ access only in key policies. If you must grant @Decrypt@ access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.+-- module Network.AWS.KMS.Decrypt     (     -- * Creating a Request@@ -64,11 +68,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'decEncryptionContext'+-- * 'decEncryptionContext' - The encryption context. If this was specified in the 'Encrypt' function, it must be specified here or the decryption operation will fail. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> . ----- * 'decGrantTokens'+-- * 'decGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'decCiphertextBlob'+-- * 'decCiphertextBlob' - Ciphertext to be decrypted. The blob includes metadata.-- /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. decrypt     :: ByteString -- ^ 'decCiphertextBlob'     -> Decrypt@@ -79,23 +83,15 @@     , _decCiphertextBlob = _Base64 # pCiphertextBlob_     } --- | The encryption context. If this was specified in the < Encrypt> function, it must be specified here or the decryption operation will fail. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html Encryption Context>.+-- | The encryption context. If this was specified in the 'Encrypt' function, it must be specified here or the decryption operation will fail. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> . decEncryptionContext :: Lens' Decrypt (HashMap Text Text) decEncryptionContext = lens _decEncryptionContext (\ s a -> s{_decEncryptionContext = a}) . _Default . _Map; --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . decGrantTokens :: Lens' Decrypt [Text] decGrantTokens = lens _decGrantTokens (\ s a -> s{_decGrantTokens = a}) . _Default . _Coerce; --- | Ciphertext to be decrypted. The blob includes metadata.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | Ciphertext to be decrypted. The blob includes metadata.-- /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. decCiphertextBlob :: Lens' Decrypt ByteString decCiphertextBlob = lens _decCiphertextBlob (\ s a -> s{_decCiphertextBlob = a}) . _Base64; @@ -147,11 +143,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'drsKeyId'+-- * 'drsKeyId' - ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation. ----- * 'drsPlaintext'+-- * 'drsPlaintext' - Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.-- /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. ----- * 'drsResponseStatus'+-- * 'drsResponseStatus' - -- | The response status code. decryptResponse     :: Int -- ^ 'drsResponseStatus'     -> DecryptResponse@@ -166,17 +162,11 @@ drsKeyId :: Lens' DecryptResponse (Maybe Text) drsKeyId = lens _drsKeyId (\ s a -> s{_drsKeyId = a}); --- | Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn\'t have permission to use it.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.-- /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. drsPlaintext :: Lens' DecryptResponse (Maybe ByteString) drsPlaintext = lens _drsPlaintext (\ s a -> s{_drsPlaintext = a}) . mapping (_Sensitive . _Base64); --- | The response status code.+-- | -- | The response status code. drsResponseStatus :: Lens' DecryptResponse Int drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a}); 
gen/Network/AWS/KMS/DeleteAlias.hs view
@@ -18,7 +18,9 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Deletes the specified alias. To map an alias to a different key, call < UpdateAlias>.+-- Deletes the specified alias. To map an alias to a different key, call 'UpdateAlias' .+--+-- module Network.AWS.KMS.DeleteAlias     (     -- * Creating a Request@@ -48,7 +50,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'daAliasName'+-- * 'daAliasName' - The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. deleteAlias     :: Text -- ^ 'daAliasName'     -> DeleteAlias@@ -57,7 +59,7 @@     { _daAliasName = pAliasName_     } --- | The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias\/). Aliases that begin with \"alias\/AWS\" are reserved.+-- | The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved. daAliasName :: Lens' DeleteAlias Text daAliasName = lens _daAliasName (\ s a -> s{_daAliasName = a}); 
gen/Network/AWS/KMS/DeleteImportedKeyMaterial.hs view
@@ -18,11 +18,13 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/.+-- Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/ . ----- When the specified CMK is in the 'PendingDeletion' state, this operation does not change the CMK\'s state. Otherwise, it changes the CMK\'s state to 'PendingImport'. ----- After you delete key material, you can use < ImportKeyMaterial> to reimport the same key material into the CMK.+-- When the specified CMK is in the @PendingDeletion@ state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to @PendingImport@ .+--+-- After you delete key material, you can use 'ImportKeyMaterial' to reimport the same key material into the CMK.+-- module Network.AWS.KMS.DeleteImportedKeyMaterial     (     -- * Creating a Request@@ -52,7 +54,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dikmKeyId'+-- * 'dikmKeyId' - The identifier of the CMK whose key material to delete. 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@ deleteImportedKeyMaterial     :: Text -- ^ 'dikmKeyId'     -> DeleteImportedKeyMaterial@@ -61,14 +63,7 @@     { _dikmKeyId = pKeyId_     } --- | The identifier of the CMK whose key material to delete. 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'---+-- | The identifier of the CMK whose key material to delete. 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@ dikmKeyId :: Lens' DeleteImportedKeyMaterial Text dikmKeyId = lens _dikmKeyId (\ s a -> s{_dikmKeyId = a}); 
gen/Network/AWS/KMS/DescribeKey.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Provides detailed information about the specified customer master key.+--+-- module Network.AWS.KMS.DescribeKey     (     -- * Creating a Request@@ -53,9 +55,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dGrantTokens'+-- * 'dGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'dKeyId'+-- * 'dKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName describeKey     :: Text -- ^ 'dKeyId'     -> DescribeKey@@ -65,22 +67,11 @@     , _dKeyId = pKeyId_     } --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . dGrantTokens :: Lens' DescribeKey [Text] dGrantTokens = lens _dGrantTokens (\ s a -> s{_dGrantTokens = a}) . _Default . _Coerce; --- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias\/\".------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias\/MyAliasName------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ -   Alias Name Example - alias\/MyAliasName---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName dKeyId :: Lens' DescribeKey Text dKeyId = lens _dKeyId (\ s a -> s{_dKeyId = a}); @@ -129,9 +120,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dkrsKeyMetadata'+-- * 'dkrsKeyMetadata' - Metadata associated with the key. ----- * 'dkrsResponseStatus'+-- * 'dkrsResponseStatus' - -- | The response status code. describeKeyResponse     :: Int -- ^ 'dkrsResponseStatus'     -> DescribeKeyResponse@@ -145,7 +136,7 @@ dkrsKeyMetadata :: Lens' DescribeKeyResponse (Maybe KeyMetadata) dkrsKeyMetadata = lens _dkrsKeyMetadata (\ s a -> s{_dkrsKeyMetadata = a}); --- | The response status code.+-- | -- | The response status code. dkrsResponseStatus :: Lens' DescribeKeyResponse Int dkrsResponseStatus = lens _dkrsResponseStatus (\ s a -> s{_dkrsResponseStatus = a}); 
gen/Network/AWS/KMS/DisableKey.hs view
@@ -18,7 +18,9 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects the Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/.+-- Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects the Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/ .+--+-- module Network.AWS.KMS.DisableKey     (     -- * Creating a Request@@ -48,7 +50,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dkKeyId'+-- * 'dkKeyId' - A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:     * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab     * ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab disableKey     :: Text -- ^ 'dkKeyId'     -> DisableKey@@ -57,14 +59,7 @@     { _dkKeyId = pKeyId_     } --- | A unique identifier for the CMK.------ Use the CMK\'s unique identifier or its Amazon Resource Name (ARN). For example:------ -   Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab------ -   ARN: arn:aws:kms:us-west-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab---+-- | A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:     * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab     * ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab dkKeyId :: Lens' DisableKey Text dkKeyId = lens _dkKeyId (\ s a -> s{_dkKeyId = a}); 
gen/Network/AWS/KMS/DisableKeyRotation.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Disables rotation of the specified key.+--+-- module Network.AWS.KMS.DisableKeyRotation     (     -- * Creating a Request@@ -48,7 +50,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'dkrKeyId'+-- * 'dkrKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 disableKeyRotation     :: Text -- ^ 'dkrKeyId'     -> DisableKeyRotation@@ -57,12 +59,7 @@     { _dkrKeyId = pKeyId_     } --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 dkrKeyId :: Lens' DisableKeyRotation Text dkrKeyId = lens _dkrKeyId (\ s a -> s{_dkrKeyId = a}); 
gen/Network/AWS/KMS/EnableKey.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Marks a key as enabled, thereby permitting its use.+--+-- module Network.AWS.KMS.EnableKey     (     -- * Creating a Request@@ -48,7 +50,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ekKeyId'+-- * 'ekKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 enableKey     :: Text -- ^ 'ekKeyId'     -> EnableKey@@ -57,12 +59,7 @@     { _ekKeyId = pKeyId_     } --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ekKeyId :: Lens' EnableKey Text ekKeyId = lens _ekKeyId (\ s a -> s{_ekKeyId = a}); 
gen/Network/AWS/KMS/EnableKeyRotation.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Enables rotation of the specified customer master key.+--+-- module Network.AWS.KMS.EnableKeyRotation     (     -- * Creating a Request@@ -48,7 +50,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ekrKeyId'+-- * 'ekrKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 enableKeyRotation     :: Text -- ^ 'ekrKeyId'     -> EnableKeyRotation@@ -57,12 +59,7 @@     { _ekrKeyId = pKeyId_     } --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ekrKeyId :: Lens' EnableKeyRotation Text ekrKeyId = lens _ekrKeyId (\ s a -> s{_ekrKeyId = a}); 
gen/Network/AWS/KMS/Encrypt.hs view
@@ -18,15 +18,19 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Encrypts plaintext into ciphertext by using a customer master key. The 'Encrypt' function has two primary use cases:+-- Encrypts plaintext into ciphertext by using a customer master key. The @Encrypt@ function has two primary use cases: ----- -   You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information. ----- -   If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.+--     * You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information. ----- Unless you are moving encrypted data from one region to another, you don\'t use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the < GenerateDataKey> or < GenerateDataKeyWithoutPlaintext> function. Data keys don\'t need to be encrypted again by calling 'Encrypt'.+--     * If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data. ----- If you want to encrypt data locally in your application, you can use the 'GenerateDataKey' function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.+--+--+-- Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the 'GenerateDataKey' or 'GenerateDataKeyWithoutPlaintext' function. Data keys don't need to be encrypted again by calling @Encrypt@ .+--+-- If you want to encrypt data locally in your application, you can use the @GenerateDataKey@ function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.+-- module Network.AWS.KMS.Encrypt     (     -- * Creating a Request@@ -66,13 +70,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'eEncryptionContext'+-- * 'eEncryptionContext' - Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the @Decrypt@ API or decryption will fail. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> . ----- * 'eGrantTokens'+-- * 'eGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'eKeyId'+-- * 'eKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName ----- * 'ePlaintext'+-- * 'ePlaintext' - Data to be encrypted.-- /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. encrypt     :: Text -- ^ 'eKeyId'     -> ByteString -- ^ 'ePlaintext'@@ -85,36 +89,19 @@     , _ePlaintext = _Sensitive . _Base64 # pPlaintext_     } --- | Name\/value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the 'Decrypt' API or decryption will fail. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html Encryption Context>.+-- | Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the @Decrypt@ API or decryption will fail. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> . eEncryptionContext :: Lens' Encrypt (HashMap Text Text) eEncryptionContext = lens _eEncryptionContext (\ s a -> s{_eEncryptionContext = a}) . _Default . _Map; --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . eGrantTokens :: Lens' Encrypt [Text] eGrantTokens = lens _eGrantTokens (\ s a -> s{_eGrantTokens = a}) . _Default . _Coerce; --- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias\/\".------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias\/MyAliasName------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ -   Alias Name Example - alias\/MyAliasName---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName eKeyId :: Lens' Encrypt Text eKeyId = lens _eKeyId (\ s a -> s{_eKeyId = a}); --- | Data to be encrypted.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | Data to be encrypted.-- /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. ePlaintext :: Lens' Encrypt ByteString ePlaintext = lens _ePlaintext (\ s a -> s{_ePlaintext = a}) . _Sensitive . _Base64; @@ -167,11 +154,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ersKeyId'+-- * 'ersKeyId' - The ID of the key used during encryption. ----- * 'ersCiphertextBlob'+-- * 'ersCiphertextBlob' - The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.-- /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. ----- * 'ersResponseStatus'+-- * 'ersResponseStatus' - -- | The response status code. encryptResponse     :: Int -- ^ 'ersResponseStatus'     -> EncryptResponse@@ -186,17 +173,11 @@ ersKeyId :: Lens' EncryptResponse (Maybe Text) ersKeyId = lens _ersKeyId (\ s a -> s{_ersKeyId = a}); --- | The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.-- /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. ersCiphertextBlob :: Lens' EncryptResponse (Maybe ByteString) ersCiphertextBlob = lens _ersCiphertextBlob (\ s a -> s{_ersCiphertextBlob = a}) . mapping _Base64; --- | The response status code.+-- | -- | The response status code. ersResponseStatus :: Lens' EncryptResponse Int ersResponseStatus = lens _ersResponseStatus (\ s a -> s{_ersResponseStatus = a}); 
gen/Network/AWS/KMS/GenerateDataKey.hs view
@@ -18,15 +18,35 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the 'Plaintext' field of the response object and an encrypted copy of the key in the 'CiphertextBlob' field. The key is encrypted by using the master key specified by the 'KeyId' field. To decrypt the encrypted key, pass it to the 'Decrypt' API.+-- Returns a data encryption key that you can use in your application to encrypt data locally. ----- We recommend that you use the following pattern to locally encrypt data: call the 'GenerateDataKey' API, use the key returned in the 'Plaintext' response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the 'CiphertextBlob' field) alongside of the locally encrypted data. ----- You should not call the 'Encrypt' function to re-encrypt your data keys within a region. 'GenerateDataKey' always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.+-- You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the @KeySpec@ or @NumberOfBytes@ field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use @KeySpec@ . ----- If you decide to use the optional 'EncryptionContext' parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the 'Decrypt' API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see <http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html Encryption Context>.+-- This operation returns a plaintext copy of the data key in the @Plaintext@ field of the response, and an encrypted copy of the data key in the @CiphertextBlob@ field. The data key is encrypted under the CMK specified in the @KeyId@ field of the request. ----- To decrypt data, pass the encrypted data key to the 'Decrypt' API. 'Decrypt' uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.+-- We recommend that you use the following pattern to encrypt data locally in your application:+--+--     * Use this operation (@GenerateDataKey@ ) to retrieve a data encryption key.+--+--     * Use the plaintext data encryption key (returned in the @Plaintext@ field of the response) to encrypt data locally, then erase the plaintext data key from memory.+--+--     * Store the encrypted data key (returned in the @CiphertextBlob@ field of the response) alongside the locally encrypted data.+--+--+--+-- To decrypt data locally:+--+--     * Use the 'Decrypt' operation to decrypt the encrypted data key into a plaintext copy of the data key.+--+--     * Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.+--+--+--+-- To return only an encrypted copy of the data key, use 'GenerateDataKeyWithoutPlaintext' . To return an arbitrary unpredictable byte string, use 'GenerateRandom' .+--+-- If you use the optional @EncryptionContext@ field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the 'Decrypt' operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ .+-- module Network.AWS.KMS.GenerateDataKey     (     -- * Creating a Request@@ -69,15 +89,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gdkKeySpec'+-- * 'gdkKeySpec' - The length of the data encryption key. Use @AES_128@ to generate a 128-bit symmetric key, or @AES_256@ to generate a 256-bit symmetric key. ----- * 'gdkEncryptionContext'+-- * 'gdkEncryptionContext' - A set of key-value pairs that represents additional authenticated data. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ . ----- * 'gdkNumberOfBytes'+-- * 'gdkNumberOfBytes' - The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the @KeySpec@ field instead of this one. ----- * 'gdkGrantTokens'+-- * 'gdkGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'gdkKeyId'+-- * 'gdkKeyId' - The identifier of the CMK under which to generate and encrypt the data encryption key. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that points to the CMK. Examples:     * Unique key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@      * CMK ARN: @arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab@      * Alias name: @alias/ExampleAlias@      * Alias ARN: @arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias@ generateDataKey     :: Text -- ^ 'gdkKeyId'     -> GenerateDataKey@@ -90,34 +110,23 @@     , _gdkKeyId = pKeyId_     } --- | Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256.+-- | The length of the data encryption key. Use @AES_128@ to generate a 128-bit symmetric key, or @AES_256@ to generate a 256-bit symmetric key. gdkKeySpec :: Lens' GenerateDataKey (Maybe DataKeySpec) gdkKeySpec = lens _gdkKeySpec (\ s a -> s{_gdkKeySpec = a}); --- | Name\/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.+-- | A set of key-value pairs that represents additional authenticated data. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ . gdkEncryptionContext :: Lens' GenerateDataKey (HashMap Text Text) gdkEncryptionContext = lens _gdkEncryptionContext (\ s a -> s{_gdkEncryptionContext = a}) . _Default . _Map; --- | Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the 'KeySpec' parameter instead.+-- | The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the @KeySpec@ field instead of this one. gdkNumberOfBytes :: Lens' GenerateDataKey (Maybe Natural) gdkNumberOfBytes = lens _gdkNumberOfBytes (\ s a -> s{_gdkNumberOfBytes = a}) . mapping _Nat; --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . gdkGrantTokens :: Lens' GenerateDataKey [Text] gdkGrantTokens = lens _gdkGrantTokens (\ s a -> s{_gdkGrantTokens = a}) . _Default . _Coerce; --- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias\/\".------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias\/MyAliasName------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ -   Alias Name Example - alias\/MyAliasName---+-- | The identifier of the CMK under which to generate and encrypt the data encryption key. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that points to the CMK. Examples:     * Unique key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@      * CMK ARN: @arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab@      * Alias name: @alias/ExampleAlias@      * Alias ARN: @arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias@ gdkKeyId :: Lens' GenerateDataKey Text gdkKeyId = lens _gdkKeyId (\ s a -> s{_gdkKeyId = a}); @@ -173,13 +182,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gdkrsResponseStatus'+-- * 'gdkrsResponseStatus' - -- | The response status code. ----- * 'gdkrsKeyId'+-- * 'gdkrsKeyId' - The identifier of the CMK under which the data encryption key was generated and encrypted. ----- * 'gdkrsPlaintext'+-- * 'gdkrsPlaintext' - The data encryption key. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.-- /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. ----- * 'gdkrsCiphertextBlob'+-- * 'gdkrsCiphertextBlob' - The encrypted data encryption key.-- /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. generateDataKeyResponse     :: Int -- ^ 'gdkrsResponseStatus'     -> Text -- ^ 'gdkrsKeyId'@@ -194,33 +203,19 @@     , _gdkrsCiphertextBlob = _Base64 # pCiphertextBlob_     } --- | The response status code.+-- | -- | The response status code. gdkrsResponseStatus :: Lens' GenerateDataKeyResponse Int gdkrsResponseStatus = lens _gdkrsResponseStatus (\ s a -> s{_gdkrsResponseStatus = a}); --- | System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.+-- | The identifier of the CMK under which the data encryption key was generated and encrypted. gdkrsKeyId :: Lens' GenerateDataKeyResponse Text gdkrsKeyId = lens _gdkrsKeyId (\ s a -> s{_gdkrsKeyId = a}); --- | Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The data encryption key. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.-- /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. gdkrsPlaintext :: Lens' GenerateDataKeyResponse ByteString gdkrsPlaintext = lens _gdkrsPlaintext (\ s a -> s{_gdkrsPlaintext = a}) . _Sensitive . _Base64; --- | Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the < Decrypt> API to recover the plaintext data key and decrypt the object.------ If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The encrypted data encryption key.-- /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. gdkrsCiphertextBlob :: Lens' GenerateDataKeyResponse ByteString gdkrsCiphertextBlob = lens _gdkrsCiphertextBlob (\ s a -> s{_gdkrsCiphertextBlob = a}) . _Base64; 
gen/Network/AWS/KMS/GenerateDataKeyWithoutPlaintext.hs view
@@ -18,7 +18,11 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like < GenerateDataKey>. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.+-- Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to 'GenerateDataKey' but returns only the encrypted copy of the data key.+--+--+-- This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the /control plane/ , creates new containers. When it creates a new container, it uses this operation (@GenerateDataKeyWithoutPlaintext@ ) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the /data plane/ , puts encrypted data into the containers. To do this, it passes the encrypted data key to the 'Decrypt' operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.+-- module Network.AWS.KMS.GenerateDataKeyWithoutPlaintext     (     -- * Creating a Request@@ -60,15 +64,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gdkwpKeySpec'+-- * 'gdkwpKeySpec' - The length of the data encryption key. Use @AES_128@ to generate a 128-bit symmetric key, or @AES_256@ to generate a 256-bit symmetric key. ----- * 'gdkwpEncryptionContext'+-- * 'gdkwpEncryptionContext' - A set of key-value pairs that represents additional authenticated data. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ . ----- * 'gdkwpNumberOfBytes'+-- * 'gdkwpNumberOfBytes' - The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the @KeySpec@ field instead of this one. ----- * 'gdkwpGrantTokens'+-- * 'gdkwpGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'gdkwpKeyId'+-- * 'gdkwpKeyId' - The identifier of the CMK under which to generate and encrypt the data encryption key. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that points to the CMK. Examples:     * Unique key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@      * CMK ARN: @arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab@      * Alias name: @alias/ExampleAlias@      * Alias ARN: @arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias@ generateDataKeyWithoutPlaintext     :: Text -- ^ 'gdkwpKeyId'     -> GenerateDataKeyWithoutPlaintext@@ -81,34 +85,23 @@     , _gdkwpKeyId = pKeyId_     } --- | Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256.+-- | The length of the data encryption key. Use @AES_128@ to generate a 128-bit symmetric key, or @AES_256@ to generate a 256-bit symmetric key. gdkwpKeySpec :: Lens' GenerateDataKeyWithoutPlaintext (Maybe DataKeySpec) gdkwpKeySpec = lens _gdkwpKeySpec (\ s a -> s{_gdkwpKeySpec = a}); --- | Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.+-- | A set of key-value pairs that represents additional authenticated data. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ . gdkwpEncryptionContext :: Lens' GenerateDataKeyWithoutPlaintext (HashMap Text Text) gdkwpEncryptionContext = lens _gdkwpEncryptionContext (\ s a -> s{_gdkwpEncryptionContext = a}) . _Default . _Map; --- | Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the 'KeySpec' parameter instead.+-- | The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the @KeySpec@ field instead of this one. gdkwpNumberOfBytes :: Lens' GenerateDataKeyWithoutPlaintext (Maybe Natural) gdkwpNumberOfBytes = lens _gdkwpNumberOfBytes (\ s a -> s{_gdkwpNumberOfBytes = a}) . mapping _Nat; --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . gdkwpGrantTokens :: Lens' GenerateDataKeyWithoutPlaintext [Text] gdkwpGrantTokens = lens _gdkwpGrantTokens (\ s a -> s{_gdkwpGrantTokens = a}) . _Default . _Coerce; --- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias\/\".------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias\/MyAliasName------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ -   Alias Name Example - alias\/MyAliasName---+-- | The identifier of the CMK under which to generate and encrypt the data encryption key. A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that points to the CMK. Examples:     * Unique key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@      * CMK ARN: @arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab@      * Alias name: @alias/ExampleAlias@      * Alias ARN: @arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias@ gdkwpKeyId :: Lens' GenerateDataKeyWithoutPlaintext Text gdkwpKeyId = lens _gdkwpKeyId (\ s a -> s{_gdkwpKeyId = a}); @@ -167,11 +160,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gdkwprsKeyId'+-- * 'gdkwprsKeyId' - The identifier of the CMK under which the data encryption key was generated and encrypted. ----- * 'gdkwprsCiphertextBlob'+-- * 'gdkwprsCiphertextBlob' - The encrypted data encryption key.-- /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. ----- * 'gdkwprsResponseStatus'+-- * 'gdkwprsResponseStatus' - -- | The response status code. generateDataKeyWithoutPlaintextResponse     :: Int -- ^ 'gdkwprsResponseStatus'     -> GenerateDataKeyWithoutPlaintextResponse@@ -182,23 +175,15 @@     , _gdkwprsResponseStatus = pResponseStatus_     } --- | System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.+-- | The identifier of the CMK under which the data encryption key was generated and encrypted. gdkwprsKeyId :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe Text) gdkwprsKeyId = lens _gdkwprsKeyId (\ s a -> s{_gdkwprsKeyId = a}); --- | Ciphertext that contains the wrapped data key. You must store the blob and encryption context so that the key can be used in a future decrypt operation.------ If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The encrypted data encryption key.-- /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. gdkwprsCiphertextBlob :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe ByteString) gdkwprsCiphertextBlob = lens _gdkwprsCiphertextBlob (\ s a -> s{_gdkwprsCiphertextBlob = a}) . mapping _Base64; --- | The response status code.+-- | -- | The response status code. gdkwprsResponseStatus :: Lens' GenerateDataKeyWithoutPlaintextResponse Int gdkwprsResponseStatus = lens _gdkwprsResponseStatus (\ s a -> s{_gdkwprsResponseStatus = a}); 
gen/Network/AWS/KMS/GenerateRandom.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Generates an unpredictable byte string.+--+-- module Network.AWS.KMS.GenerateRandom     (     -- * Creating a Request@@ -51,7 +53,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'grNumberOfBytes'+-- * 'grNumberOfBytes' - The length of the byte string. generateRandom     :: GenerateRandom generateRandom =@@ -59,7 +61,7 @@     { _grNumberOfBytes = Nothing     } --- | Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes.+-- | The length of the byte string. grNumberOfBytes :: Lens' GenerateRandom (Maybe Natural) grNumberOfBytes = lens _grNumberOfBytes (\ s a -> s{_grNumberOfBytes = a}) . mapping _Nat; @@ -107,9 +109,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'grrsPlaintext'+-- * 'grrsPlaintext' - The unpredictable byte string.-- /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. ----- * 'grrsResponseStatus'+-- * 'grrsResponseStatus' - -- | The response status code. generateRandomResponse     :: Int -- ^ 'grrsResponseStatus'     -> GenerateRandomResponse@@ -119,17 +121,11 @@     , _grrsResponseStatus = pResponseStatus_     } --- | Plaintext that contains the unpredictable byte string.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The unpredictable byte string.-- /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. grrsPlaintext :: Lens' GenerateRandomResponse (Maybe ByteString) grrsPlaintext = lens _grrsPlaintext (\ s a -> s{_grrsPlaintext = a}) . mapping (_Sensitive . _Base64); --- | The response status code.+-- | -- | The response status code. grrsResponseStatus :: Lens' GenerateRandomResponse Int grrsResponseStatus = lens _grrsResponseStatus (\ s a -> s{_grrsResponseStatus = a}); 
gen/Network/AWS/KMS/GetKeyPolicy.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Retrieves a policy attached to the specified key.+--+-- module Network.AWS.KMS.GetKeyPolicy     (     -- * Creating a Request@@ -53,9 +55,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gkpKeyId'+-- * 'gkpKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ----- * 'gkpPolicyName'+-- * 'gkpPolicyName' - String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling 'ListKeyPolicies' . getKeyPolicy     :: Text -- ^ 'gkpKeyId'     -> Text -- ^ 'gkpPolicyName'@@ -66,16 +68,11 @@     , _gkpPolicyName = pPolicyName_     } --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 gkpKeyId :: Lens' GetKeyPolicy Text gkpKeyId = lens _gkpKeyId (\ s a -> s{_gkpKeyId = a}); --- | String that contains the name of the policy. Currently, this must be \"default\". Policy names can be discovered by calling < ListKeyPolicies>.+-- | String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling 'ListKeyPolicies' . gkpPolicyName :: Lens' GetKeyPolicy Text gkpPolicyName = lens _gkpPolicyName (\ s a -> s{_gkpPolicyName = a}); @@ -124,9 +121,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gkprsPolicy'+-- * 'gkprsPolicy' - A policy document in JSON format. ----- * 'gkprsResponseStatus'+-- * 'gkprsResponseStatus' - -- | The response status code. getKeyPolicyResponse     :: Int -- ^ 'gkprsResponseStatus'     -> GetKeyPolicyResponse@@ -140,7 +137,7 @@ gkprsPolicy :: Lens' GetKeyPolicyResponse (Maybe Text) gkprsPolicy = lens _gkprsPolicy (\ s a -> s{_gkprsPolicy = a}); --- | The response status code.+-- | -- | The response status code. gkprsResponseStatus :: Lens' GetKeyPolicyResponse Int gkprsResponseStatus = lens _gkprsResponseStatus (\ s a -> s{_gkprsResponseStatus = a}); 
gen/Network/AWS/KMS/GetKeyRotationStatus.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.+--+-- module Network.AWS.KMS.GetKeyRotationStatus     (     -- * Creating a Request@@ -51,7 +53,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gkrsKeyId'+-- * 'gkrsKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 getKeyRotationStatus     :: Text -- ^ 'gkrsKeyId'     -> GetKeyRotationStatus@@ -60,12 +62,7 @@     { _gkrsKeyId = pKeyId_     } --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 gkrsKeyId :: Lens' GetKeyRotationStatus Text gkrsKeyId = lens _gkrsKeyId (\ s a -> s{_gkrsKeyId = a}); @@ -112,9 +109,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gkrsrsKeyRotationEnabled'+-- * 'gkrsrsKeyRotationEnabled' - A Boolean value that specifies whether key rotation is enabled. ----- * 'gkrsrsResponseStatus'+-- * 'gkrsrsResponseStatus' - -- | The response status code. getKeyRotationStatusResponse     :: Int -- ^ 'gkrsrsResponseStatus'     -> GetKeyRotationStatusResponse@@ -128,7 +125,7 @@ gkrsrsKeyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool) gkrsrsKeyRotationEnabled = lens _gkrsrsKeyRotationEnabled (\ s a -> s{_gkrsrsKeyRotationEnabled = a}); --- | The response status code.+-- | -- | The response status code. gkrsrsResponseStatus :: Lens' GetKeyRotationStatusResponse Int gkrsrsResponseStatus = lens _gkrsrsResponseStatus (\ s a -> s{_gkrsrsResponseStatus = a}); 
gen/Network/AWS/KMS/GetParametersForImport.hs view
@@ -18,11 +18,13 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- 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 <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/.+-- 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 <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html 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.+-- 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.+-- module Network.AWS.KMS.GetParametersForImport     (     -- * Creating a Request@@ -62,11 +64,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gpfiKeyId'+-- * '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'+-- * 'gpfiWrappingAlgorithm' - The algorithm you will use to encrypt the key material before importing it with 'ImportKeyMaterial' . For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html Encrypt the Key Material> in the /AWS Key Management Service Developer Guide/ . ----- * 'gpfiWrappingKeySpec'+-- * 'gpfiWrappingKeySpec' - The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported. getParametersForImport     :: Text -- ^ 'gpfiKeyId'     -> AlgorithmSpec -- ^ 'gpfiWrappingAlgorithm'@@ -79,18 +81,11 @@     , _gpfiWrappingKeySpec = pWrappingKeySpec_     } --- | 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'---+-- | 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@ gpfiKeyId :: Lens' GetParametersForImport Text gpfiKeyId = lens _gpfiKeyId (\ s a -> s{_gpfiKeyId = a}); --- | The algorithm you will use to encrypt the key material before importing it with < ImportKeyMaterial>. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html Encrypt the Key Material> in the /AWS Key Management Service Developer Guide/.+-- | The algorithm you will use to encrypt the key material before importing it with 'ImportKeyMaterial' . For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html Encrypt the Key Material> in the /AWS Key Management Service Developer Guide/ . gpfiWrappingAlgorithm :: Lens' GetParametersForImport AlgorithmSpec gpfiWrappingAlgorithm = lens _gpfiWrappingAlgorithm (\ s a -> s{_gpfiWrappingAlgorithm = a}); @@ -152,15 +147,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gpfirsKeyId'+-- * 'gpfirsKeyId' - The identifier of the CMK to use in a subsequent 'ImportKeyMaterial' request. This is the same CMK specified in the @GetParametersForImport@ request. ----- * 'gpfirsPublicKey'+-- * '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'+-- * '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'+-- * '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'+-- * 'gpfirsResponseStatus' - -- | The response status code. getParametersForImportResponse     :: Int -- ^ 'gpfirsResponseStatus'     -> GetParametersForImportResponse@@ -173,35 +168,23 @@     , _gpfirsResponseStatus = pResponseStatus_     } --- | The identifier of the CMK to use in a subsequent < ImportKeyMaterial> request. This is the same CMK specified in the 'GetParametersForImport' request.+-- | The identifier of the CMK to use in a subsequent 'ImportKeyMaterial' request. This is the same CMK specified in the @GetParametersForImport@ request. gpfirsKeyId :: Lens' GetParametersForImportResponse (Maybe Text) gpfirsKeyId = lens _gpfirsKeyId (\ s a -> s{_gpfirsKeyId = a}); --- | The public key to use to encrypt the key material before importing it with < ImportKeyMaterial>.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | 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. gpfirsPublicKey :: Lens' GetParametersForImportResponse (Maybe ByteString) gpfirsPublicKey = lens _gpfirsPublicKey (\ s a -> s{_gpfirsPublicKey = a}) . mapping (_Sensitive . _Base64); --- | 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.+-- | 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. gpfirsParametersValidTo :: Lens' GetParametersForImportResponse (Maybe UTCTime) gpfirsParametersValidTo = lens _gpfirsParametersValidTo (\ s a -> s{_gpfirsParametersValidTo = a}) . mapping _Time; --- | The import token to send in a subsequent < ImportKeyMaterial> request.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | 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. gpfirsImportToken :: Lens' GetParametersForImportResponse (Maybe ByteString) gpfirsImportToken = lens _gpfirsImportToken (\ s a -> s{_gpfirsImportToken = a}) . mapping _Base64; --- | The response status code.+-- | -- | The response status code. gpfirsResponseStatus :: Lens' GetParametersForImportResponse Int gpfirsResponseStatus = lens _gpfirsResponseStatus (\ s a -> s{_gpfirsResponseStatus = a}); 
gen/Network/AWS/KMS/ImportKeyMaterial.hs view
@@ -18,13 +18,15 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/.+-- Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html Importing Key Material> in the /AWS Key Management Service Developer Guide/ . ----- You must specify the key ID of the CMK to import the key material into. This CMK\'s 'Origin' must be 'EXTERNAL'. You must also send an import token and the encrypted key material. Send the import token that you received in the same < GetParametersForImport> response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. ----- When this operation is successful, the specified CMK\'s key state changes to 'Enabled', and you can use the CMK.+-- You must specify the key ID of the CMK to import the key material into. This CMK's @Origin@ must be @EXTERNAL@ . You must also send an import token and the encrypted key material. Send the import token that you received in the same 'GetParametersForImport' response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. --+-- When this operation is successful, the specified CMK's key state changes to @Enabled@ , and you can use the CMK.+-- -- After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.+-- module Network.AWS.KMS.ImportKeyMaterial     (     -- * Creating a Request@@ -64,15 +66,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ikmExpirationModel'+-- * 'ikmExpirationModel' - Specifies whether the key material expires. The default is @KEY_MATERIAL_EXPIRES@ , in which case you must include the @ValidTo@ parameter. When this parameter is set to @KEY_MATERIAL_DOES_NOT_EXPIRE@ , you must omit the @ValidTo@ parameter. ----- * 'ikmValidTo'+-- * 'ikmValidTo' - The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the @ExpirationModel@ parameter is set to @KEY_MATERIAL_DOES_NOT_EXPIRE@ . Otherwise it is required. ----- * 'ikmKeyId'+-- * 'ikmKeyId' - The identifier of the CMK to import the key material into. 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@ ----- * 'ikmImportToken'+-- * 'ikmImportToken' - The import token that you received in the response to a previous 'GetParametersForImport' request. It must be from the same response that contained the public key that you used to encrypt the key material.-- /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. ----- * 'ikmEncryptedKeyMaterial'+-- * 'ikmEncryptedKeyMaterial' - The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous 'GetParametersForImport' request, using the wrapping algorithm that you specified in that 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. importKeyMaterial     :: Text -- ^ 'ikmKeyId'     -> ByteString -- ^ 'ikmImportToken'@@ -87,42 +89,23 @@     , _ikmEncryptedKeyMaterial = _Base64 # pEncryptedKeyMaterial_     } --- | Specifies whether the key material expires. The default is 'KEY_MATERIAL_EXPIRES', in which case you must include the 'ValidTo' parameter. When this parameter is set to 'KEY_MATERIAL_DOES_NOT_EXPIRE', you must omit the 'ValidTo' parameter.+-- | Specifies whether the key material expires. The default is @KEY_MATERIAL_EXPIRES@ , in which case you must include the @ValidTo@ parameter. When this parameter is set to @KEY_MATERIAL_DOES_NOT_EXPIRE@ , you must omit the @ValidTo@ parameter. ikmExpirationModel :: Lens' ImportKeyMaterial (Maybe ExpirationModelType) ikmExpirationModel = lens _ikmExpirationModel (\ s a -> s{_ikmExpirationModel = a}); --- | The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the 'ExpirationModel' parameter is set to 'KEY_MATERIAL_DOES_NOT_EXPIRE'. Otherwise it is required.+-- | The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the @ExpirationModel@ parameter is set to @KEY_MATERIAL_DOES_NOT_EXPIRE@ . Otherwise it is required. ikmValidTo :: Lens' ImportKeyMaterial (Maybe UTCTime) ikmValidTo = lens _ikmValidTo (\ s a -> s{_ikmValidTo = a}) . mapping _Time; --- | The identifier of the CMK to import the key material into. 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'---+-- | The identifier of the CMK to import the key material into. 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@ ikmKeyId :: Lens' ImportKeyMaterial Text ikmKeyId = lens _ikmKeyId (\ s a -> s{_ikmKeyId = a}); --- | The import token that you received in the response to a previous < GetParametersForImport> request. It must be from the same response that contained the public key that you used to encrypt the key material.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The import token that you received in the response to a previous 'GetParametersForImport' request. It must be from the same response that contained the public key that you used to encrypt the key material.-- /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. ikmImportToken :: Lens' ImportKeyMaterial ByteString ikmImportToken = lens _ikmImportToken (\ s a -> s{_ikmImportToken = a}) . _Base64; --- | The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous < GetParametersForImport> request, using the wrapping algorithm that you specified in that request.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous 'GetParametersForImport' request, using the wrapping algorithm that you specified in that 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. ikmEncryptedKeyMaterial :: Lens' ImportKeyMaterial ByteString ikmEncryptedKeyMaterial = lens _ikmEncryptedKeyMaterial (\ s a -> s{_ikmEncryptedKeyMaterial = a}) . _Base64; @@ -174,7 +157,7 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ikmrsResponseStatus'+-- * 'ikmrsResponseStatus' - -- | The response status code. importKeyMaterialResponse     :: Int -- ^ 'ikmrsResponseStatus'     -> ImportKeyMaterialResponse@@ -183,7 +166,7 @@     { _ikmrsResponseStatus = pResponseStatus_     } --- | The response status code.+-- | -- | The response status code. ikmrsResponseStatus :: Lens' ImportKeyMaterialResponse Int ikmrsResponseStatus = lens _ikmrsResponseStatus (\ s a -> s{_ikmrsResponseStatus = a}); 
gen/Network/AWS/KMS/ListAliases.hs view
@@ -20,6 +20,8 @@ -- -- Lists all of the key aliases in the account. --+--+-- -- This operation returns paginated results. module Network.AWS.KMS.ListAliases     (@@ -58,9 +60,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'laMarker'+-- * 'laMarker' - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. ----- * 'laLimit'+-- * 'laLimit' - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. listAliases     :: ListAliases listAliases =@@ -69,13 +71,11 @@     , _laLimit = Nothing     } --- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of 'NextMarker' from the response you just received.+-- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. laMarker :: Lens' ListAliases (Maybe Text) laMarker = lens _laMarker (\ s a -> s{_laMarker = a}); --- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the 'Truncated' element in the response is set to true.------ This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.+-- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. laLimit :: Lens' ListAliases (Maybe Natural) laLimit = lens _laLimit (\ s a -> s{_laLimit = a}) . mapping _Nat; @@ -135,13 +135,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'larsTruncated'+-- * 'larsTruncated' - A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. ----- * 'larsAliases'+-- * 'larsAliases' - A list of key aliases in the user's account. ----- * 'larsNextMarker'+-- * 'larsNextMarker' - When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. ----- * 'larsResponseStatus'+-- * 'larsResponseStatus' - -- | The response status code. listAliasesResponse     :: Int -- ^ 'larsResponseStatus'     -> ListAliasesResponse@@ -153,19 +153,19 @@     , _larsResponseStatus = pResponseStatus_     } --- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the 'Marker' parameter to make a subsequent pagination request to retrieve more items in the list.+-- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. larsTruncated :: Lens' ListAliasesResponse (Maybe Bool) larsTruncated = lens _larsTruncated (\ s a -> s{_larsTruncated = a}); --- | A list of key aliases in the user\'s account.+-- | A list of key aliases in the user's account. larsAliases :: Lens' ListAliasesResponse [AliasListEntry] larsAliases = lens _larsAliases (\ s a -> s{_larsAliases = a}) . _Default . _Coerce; --- | When 'Truncated' is true, this value is present and contains the value to use for the 'Marker' parameter in a subsequent pagination request.+-- | When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. larsNextMarker :: Lens' ListAliasesResponse (Maybe Text) larsNextMarker = lens _larsNextMarker (\ s a -> s{_larsNextMarker = a}); --- | The response status code.+-- | -- | The response status code. larsResponseStatus :: Lens' ListAliasesResponse Int larsResponseStatus = lens _larsResponseStatus (\ s a -> s{_larsResponseStatus = a}); 
gen/Network/AWS/KMS/ListGrants.hs view
@@ -20,6 +20,8 @@ -- -- List the grants for a specified key. --+--+-- -- This operation returns paginated results. module Network.AWS.KMS.ListGrants     (@@ -59,11 +61,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lgMarker'+-- * 'lgMarker' - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. ----- * 'lgLimit'+-- * 'lgLimit' - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. ----- * 'lgKeyId'+-- * 'lgKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 listGrants     :: Text -- ^ 'lgKeyId'     -> ListGrants@@ -74,22 +76,15 @@     , _lgKeyId = pKeyId_     } --- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of 'NextMarker' from the response you just received.+-- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. lgMarker :: Lens' ListGrants (Maybe Text) lgMarker = lens _lgMarker (\ s a -> s{_lgMarker = a}); --- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the 'Truncated' element in the response is set to true.------ This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.+-- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. lgLimit :: Lens' ListGrants (Maybe Natural) lgLimit = lens _lgLimit (\ s a -> s{_lgLimit = a}) . mapping _Nat; --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 lgKeyId :: Lens' ListGrants Text lgKeyId = lens _lgKeyId (\ s a -> s{_lgKeyId = a}); 
gen/Network/AWS/KMS/ListKeyPolicies.hs view
@@ -20,6 +20,8 @@ -- -- Retrieves a list of policies attached to a key. --+--+-- -- This operation returns paginated results. module Network.AWS.KMS.ListKeyPolicies     (@@ -60,11 +62,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lkpMarker'+-- * 'lkpMarker' - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. ----- * 'lkpLimit'+-- * 'lkpLimit' - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100. Currently only 1 policy can be attached to a key. ----- * 'lkpKeyId'+-- * 'lkpKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName listKeyPolicies     :: Text -- ^ 'lkpKeyId'     -> ListKeyPolicies@@ -75,28 +77,15 @@     , _lkpKeyId = pKeyId_     } --- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of 'NextMarker' from the response you just received.+-- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. lkpMarker :: Lens' ListKeyPolicies (Maybe Text) lkpMarker = lens _lkpMarker (\ s a -> s{_lkpMarker = a}); --- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the 'Truncated' element in the response is set to true.------ This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.------ Currently only 1 policy can be attached to a key.+-- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100. Currently only 1 policy can be attached to a key. lkpLimit :: Lens' ListKeyPolicies (Maybe Natural) lkpLimit = lens _lkpLimit (\ s a -> s{_lkpLimit = a}) . mapping _Nat; --- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias\/\".------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias\/MyAliasName------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ -   Alias Name Example - alias\/MyAliasName---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName lkpKeyId :: Lens' ListKeyPolicies Text lkpKeyId = lens _lkpKeyId (\ s a -> s{_lkpKeyId = a}); @@ -158,13 +147,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lkprsPolicyNames'+-- * 'lkprsPolicyNames' - A list of policy names. Currently, there is only one policy and it is named "Default". ----- * 'lkprsTruncated'+-- * 'lkprsTruncated' - A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. ----- * 'lkprsNextMarker'+-- * 'lkprsNextMarker' - When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. ----- * 'lkprsResponseStatus'+-- * 'lkprsResponseStatus' - -- | The response status code. listKeyPoliciesResponse     :: Int -- ^ 'lkprsResponseStatus'     -> ListKeyPoliciesResponse@@ -176,19 +165,19 @@     , _lkprsResponseStatus = pResponseStatus_     } --- | A list of policy names. Currently, there is only one policy and it is named \"Default\".+-- | A list of policy names. Currently, there is only one policy and it is named "Default". lkprsPolicyNames :: Lens' ListKeyPoliciesResponse [Text] lkprsPolicyNames = lens _lkprsPolicyNames (\ s a -> s{_lkprsPolicyNames = a}) . _Default . _Coerce; --- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the 'Marker' parameter to make a subsequent pagination request to retrieve more items in the list.+-- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. lkprsTruncated :: Lens' ListKeyPoliciesResponse (Maybe Bool) lkprsTruncated = lens _lkprsTruncated (\ s a -> s{_lkprsTruncated = a}); --- | When 'Truncated' is true, this value is present and contains the value to use for the 'Marker' parameter in a subsequent pagination request.+-- | When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. lkprsNextMarker :: Lens' ListKeyPoliciesResponse (Maybe Text) lkprsNextMarker = lens _lkprsNextMarker (\ s a -> s{_lkprsNextMarker = a}); --- | The response status code.+-- | -- | The response status code. lkprsResponseStatus :: Lens' ListKeyPoliciesResponse Int lkprsResponseStatus = lens _lkprsResponseStatus (\ s a -> s{_lkprsResponseStatus = a}); 
gen/Network/AWS/KMS/ListKeys.hs view
@@ -20,6 +20,8 @@ -- -- Lists the customer master keys. --+--+-- -- This operation returns paginated results. module Network.AWS.KMS.ListKeys     (@@ -58,9 +60,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lkMarker'+-- * 'lkMarker' - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. ----- * 'lkLimit'+-- * 'lkLimit' - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100. listKeys     :: ListKeys listKeys =@@ -69,13 +71,11 @@     , _lkLimit = Nothing     } --- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of 'NextMarker' from the response you just received.+-- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. lkMarker :: Lens' ListKeys (Maybe Text) lkMarker = lens _lkMarker (\ s a -> s{_lkMarker = a}); --- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the 'Truncated' element in the response is set to true.------ This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.+-- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100. lkLimit :: Lens' ListKeys (Maybe Natural) lkLimit = lens _lkLimit (\ s a -> s{_lkLimit = a}) . mapping _Nat; @@ -135,13 +135,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lkrsTruncated'+-- * 'lkrsTruncated' - A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. ----- * 'lkrsKeys'+-- * 'lkrsKeys' - A list of keys. ----- * 'lkrsNextMarker'+-- * 'lkrsNextMarker' - When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. ----- * 'lkrsResponseStatus'+-- * 'lkrsResponseStatus' - -- | The response status code. listKeysResponse     :: Int -- ^ 'lkrsResponseStatus'     -> ListKeysResponse@@ -153,7 +153,7 @@     , _lkrsResponseStatus = pResponseStatus_     } --- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the 'Marker' parameter to make a subsequent pagination request to retrieve more items in the list.+-- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. lkrsTruncated :: Lens' ListKeysResponse (Maybe Bool) lkrsTruncated = lens _lkrsTruncated (\ s a -> s{_lkrsTruncated = a}); @@ -161,11 +161,11 @@ lkrsKeys :: Lens' ListKeysResponse [KeyListEntry] lkrsKeys = lens _lkrsKeys (\ s a -> s{_lkrsKeys = a}) . _Default . _Coerce; --- | When 'Truncated' is true, this value is present and contains the value to use for the 'Marker' parameter in a subsequent pagination request.+-- | When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. lkrsNextMarker :: Lens' ListKeysResponse (Maybe Text) lkrsNextMarker = lens _lkrsNextMarker (\ s a -> s{_lkrsNextMarker = a}); --- | The response status code.+-- | -- | The response status code. lkrsResponseStatus :: Lens' ListKeysResponse Int lkrsResponseStatus = lens _lkrsResponseStatus (\ s a -> s{_lkrsResponseStatus = a}); 
gen/Network/AWS/KMS/ListRetirableGrants.hs view
@@ -18,9 +18,11 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Returns a list of all grants for which the grant\'s 'RetiringPrincipal' matches the one specified.+-- Returns a list of all grants for which the grant's @RetiringPrincipal@ matches the one specified. ----- A typical use is to list all grants that you are able to retire. To retire a grant, use < RetireGrant>.+--+-- A typical use is to list all grants that you are able to retire. To retire a grant, use 'RetireGrant' .+-- module Network.AWS.KMS.ListRetirableGrants     (     -- * Creating a Request@@ -58,11 +60,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lrgMarker'+-- * 'lrgMarker' - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. ----- * 'lrgLimit'+-- * 'lrgLimit' - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. ----- * 'lrgRetiringPrincipal'+-- * 'lrgRetiringPrincipal' - The retiring principal for which to list grants. To specify the retiring principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /Amazon Web Services General Reference/ . listRetirableGrants     :: Text -- ^ 'lrgRetiringPrincipal'     -> ListRetirableGrants@@ -73,19 +75,15 @@     , _lrgRetiringPrincipal = pRetiringPrincipal_     } --- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of 'NextMarker' from the response you just received.+-- | Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of @NextMarker@ from the response you just received. lrgMarker :: Lens' ListRetirableGrants (Maybe Text) lrgMarker = lens _lrgMarker (\ s a -> s{_lrgMarker = a}); --- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the 'Truncated' element in the response is set to true.------ This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.+-- | When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the @Truncated@ element in the response is set to true. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50. lrgLimit :: Lens' ListRetirableGrants (Maybe Natural) lrgLimit = lens _lrgLimit (\ s a -> s{_lrgLimit = a}) . mapping _Nat; --- | The retiring principal for which to list grants.------ To specify the retiring principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /Amazon Web Services General Reference/.+-- | The retiring principal for which to list grants. To specify the retiring principal, use the <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Amazon Resource Name (ARN)> of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam AWS Identity and Access Management (IAM)> in the Example ARNs section of the /Amazon Web Services General Reference/ . lrgRetiringPrincipal :: Lens' ListRetirableGrants Text lrgRetiringPrincipal = lens _lrgRetiringPrincipal (\ s a -> s{_lrgRetiringPrincipal = a}); 
gen/Network/AWS/KMS/PutKeyPolicy.hs view
@@ -20,7 +20,9 @@ -- -- Attaches a key policy to the specified customer master key (CMK). ----- For more information about key policies, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html Key Policies> in the /AWS Key Management Service Developer Guide/.+--+-- For more information about key policies, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html Key Policies> in the /AWS Key Management Service Developer Guide/ .+-- module Network.AWS.KMS.PutKeyPolicy     (     -- * Creating a Request@@ -56,13 +58,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'pkpBypassPolicyLockoutSafetyCheck'+-- * 'pkpBypassPolicyLockoutSafetyCheck' - A flag to indicate whether to bypass the key policy lockout safety check. /Important:/ Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ . Use this parameter only when you intend to prevent the principal making the request from making a subsequent @PutKeyPolicy@ request on the CMK. The default value is false. ----- * 'pkpKeyId'+-- * 'pkpKeyId' - A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:     * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab     * ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ----- * 'pkpPolicyName'+-- * 'pkpPolicyName' - The name of the key policy. This value must be @default@ . ----- * 'pkpPolicy'+-- * 'pkpPolicy' - The key policy to attach to the CMK. If you do not set @BypassPolicyLockoutSafetyCheck@ to true, the policy must meet the following criteria:     * It must allow the principal making the @PutKeyPolicy@ request to make a subsequent @PutKeyPolicy@ request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ .     * The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see <http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency Changes that I make are not always immediately visible> in the /IAM User Guide/ . The policy size limit is 32 KiB (32768 bytes). putKeyPolicy     :: Text -- ^ 'pkpKeyId'     -> Text -- ^ 'pkpPolicyName'@@ -76,44 +78,19 @@     , _pkpPolicy = pPolicy_     } --- | A flag to indicate whether to bypass the key policy lockout safety check.------ Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.------ For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/.------ Use this parameter only when you intend to prevent the principal making the request from making a subsequent 'PutKeyPolicy' request on the CMK.------ The default value is false.+-- | A flag to indicate whether to bypass the key policy lockout safety check. /Important:/ Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ . Use this parameter only when you intend to prevent the principal making the request from making a subsequent @PutKeyPolicy@ request on the CMK. The default value is false. pkpBypassPolicyLockoutSafetyCheck :: Lens' PutKeyPolicy (Maybe Bool) pkpBypassPolicyLockoutSafetyCheck = lens _pkpBypassPolicyLockoutSafetyCheck (\ s a -> s{_pkpBypassPolicyLockoutSafetyCheck = a}); --- | A unique identifier for the CMK.------ Use the CMK\'s unique identifier or its Amazon Resource Name (ARN). For example:------ -   Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab------ -   ARN: arn:aws:kms:us-west-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab---+-- | A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:     * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab     * ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab pkpKeyId :: Lens' PutKeyPolicy Text pkpKeyId = lens _pkpKeyId (\ s a -> s{_pkpKeyId = a}); --- | The name of the key policy.------ This value must be 'default'.+-- | The name of the key policy. This value must be @default@ . pkpPolicyName :: Lens' PutKeyPolicy Text pkpPolicyName = lens _pkpPolicyName (\ s a -> s{_pkpPolicyName = a}); --- | The key policy to attach to the CMK.------ If you do not set 'BypassPolicyLockoutSafetyCheck' to true, the policy must meet the following criteria:------ -   It must allow the principal making the 'PutKeyPolicy' request to make a subsequent 'PutKeyPolicy' request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/.------ -   The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see <http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency Changes that I make are not always immediately visible> in the /IAM User Guide/.------ The policy size limit is 32 KiB (32768 bytes).+-- | The key policy to attach to the CMK. If you do not set @BypassPolicyLockoutSafetyCheck@ to true, the policy must meet the following criteria:     * It must allow the principal making the @PutKeyPolicy@ request to make a subsequent @PutKeyPolicy@ request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the <http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam Default Key Policy> section in the /AWS Key Management Service Developer Guide/ .     * The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see <http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency Changes that I make are not always immediately visible> in the /IAM User Guide/ . The policy size limit is 32 KiB (32768 bytes). pkpPolicy :: Lens' PutKeyPolicy Text pkpPolicy = lens _pkpPolicy (\ s a -> s{_pkpPolicy = a}); 
gen/Network/AWS/KMS/ReEncrypt.hs view
@@ -20,7 +20,9 @@ -- -- Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext. ----- Unlike other actions, 'ReEncrypt' is authorized twice - once as 'ReEncryptFrom' on the source key and once as 'ReEncryptTo' on the destination key. We therefore recommend that you include the '\"action\":\"kms:ReEncrypt*\"' statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the < PutKeyPolicy> function.+--+-- Unlike other actions, @ReEncrypt@ is authorized twice - once as @ReEncryptFrom@ on the source key and once as @ReEncryptTo@ on the destination key. We therefore recommend that you include the @"action":"kms:ReEncrypt*"@ statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the 'PutKeyPolicy' function.+-- module Network.AWS.KMS.ReEncrypt     (     -- * Creating a Request@@ -63,15 +65,15 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'reDestinationEncryptionContext'+-- * 'reDestinationEncryptionContext' - Encryption context to be used when the data is re-encrypted. ----- * 'reSourceEncryptionContext'+-- * 'reSourceEncryptionContext' - Encryption context used to encrypt and decrypt the data specified in the @CiphertextBlob@ parameter. ----- * 'reGrantTokens'+-- * 'reGrantTokens' - A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . ----- * 'reCiphertextBlob'+-- * 'reCiphertextBlob' - Ciphertext of the data to re-encrypt.-- /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. ----- * 'reDestinationKeyId'+-- * 'reDestinationKeyId' - A unique identifier for the customer master key used to re-encrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName reEncrypt     :: ByteString -- ^ 'reCiphertextBlob'     -> Text -- ^ 'reDestinationKeyId'@@ -89,36 +91,19 @@ reDestinationEncryptionContext :: Lens' ReEncrypt (HashMap Text Text) reDestinationEncryptionContext = lens _reDestinationEncryptionContext (\ s a -> s{_reDestinationEncryptionContext = a}) . _Default . _Map; --- | Encryption context used to encrypt and decrypt the data specified in the 'CiphertextBlob' parameter.+-- | Encryption context used to encrypt and decrypt the data specified in the @CiphertextBlob@ parameter. reSourceEncryptionContext :: Lens' ReEncrypt (HashMap Text Text) reSourceEncryptionContext = lens _reSourceEncryptionContext (\ s a -> s{_reSourceEncryptionContext = a}) . _Default . _Map; --- | A list of grant tokens.------ For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/.+-- | A list of grant tokens. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token Grant Tokens> in the /AWS Key Management Service Developer Guide/ . reGrantTokens :: Lens' ReEncrypt [Text] reGrantTokens = lens _reGrantTokens (\ s a -> s{_reGrantTokens = a}) . _Default . _Coerce; --- | Ciphertext of the data to re-encrypt.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | Ciphertext of the data to re-encrypt.-- /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. reCiphertextBlob :: Lens' ReEncrypt ByteString reCiphertextBlob = lens _reCiphertextBlob (\ s a -> s{_reCiphertextBlob = a}) . _Base64; --- | A unique identifier for the customer master key used to re-encrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias\/\".------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias\/MyAliasName------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ -   Alias Name Example - alias\/MyAliasName---+-- | A unique identifier for the customer master key used to re-encrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012     * Alias Name Example - alias/MyAliasName reDestinationKeyId :: Lens' ReEncrypt Text reDestinationKeyId = lens _reDestinationKeyId (\ s a -> s{_reDestinationKeyId = a}); @@ -176,13 +161,13 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rersSourceKeyId'+-- * 'rersSourceKeyId' - Unique identifier of the key used to originally encrypt the data. ----- * 'rersKeyId'+-- * 'rersKeyId' - Unique identifier of the key used to re-encrypt the data. ----- * 'rersCiphertextBlob'+-- * 'rersCiphertextBlob' - The re-encrypted data. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.-- /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. ----- * 'rersResponseStatus'+-- * 'rersResponseStatus' - -- | The response status code. reEncryptResponse     :: Int -- ^ 'rersResponseStatus'     -> ReEncryptResponse@@ -202,17 +187,11 @@ rersKeyId :: Lens' ReEncryptResponse (Maybe Text) rersKeyId = lens _rersKeyId (\ s a -> s{_rersKeyId = a}); --- | The re-encrypted data. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.------ /Note:/ This 'Lens' automatically encodes and decodes Base64 data,--- despite what the AWS documentation might say.--- 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.+-- | The re-encrypted data. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.-- /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. rersCiphertextBlob :: Lens' ReEncryptResponse (Maybe ByteString) rersCiphertextBlob = lens _rersCiphertextBlob (\ s a -> s{_rersCiphertextBlob = a}) . mapping _Base64; --- | The response status code.+-- | -- | The response status code. rersResponseStatus :: Lens' ReEncryptResponse Int rersResponseStatus = lens _rersResponseStatus (\ s a -> s{_rersResponseStatus = a}); 
gen/Network/AWS/KMS/RetireGrant.hs view
@@ -18,15 +18,19 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Retires a grant. You can retire a grant when you\'re done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:+-- Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API: ----- -   The account that created the grant ----- -   The 'RetiringPrincipal', if present+--     * The account that created the grant ----- -   The 'GranteePrincipal', if 'RetireGrant' is a grantee operation+--     * The @RetiringPrincipal@ , if present ----- The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the 'CreateGrant' function.+--     * The @GranteePrincipal@ , if @RetireGrant@ is a grantee operation+--+--+--+-- The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the @CreateGrant@ function.+-- module Network.AWS.KMS.RetireGrant     (     -- * Creating a Request@@ -60,11 +64,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rgKeyId'+-- * 'rgKeyId' - A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ----- * 'rgGrantId'+-- * 'rgGrantId' - Unique identifier of the grant to be retired. The grant ID is returned by the @CreateGrant@ function.     * Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 ----- * 'rgGrantToken'+-- * 'rgGrantToken' - Token that identifies the grant to be retired. retireGrant     :: RetireGrant retireGrant =@@ -74,19 +78,11 @@     , _rgGrantToken = Nothing     } --- | A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 rgKeyId :: Lens' RetireGrant (Maybe Text) rgKeyId = lens _rgKeyId (\ s a -> s{_rgKeyId = a}); --- | Unique identifier of the grant to be retired. The grant ID is returned by the 'CreateGrant' function.------ -   Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123---+-- | Unique identifier of the grant to be retired. The grant ID is returned by the @CreateGrant@ function.     * Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 rgGrantId :: Lens' RetireGrant (Maybe Text) rgGrantId = lens _rgGrantId (\ s a -> s{_rgGrantId = a}); 
gen/Network/AWS/KMS/RevokeGrant.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Revokes a grant. You can revoke a grant to actively deny operations that depend on it.+--+-- module Network.AWS.KMS.RevokeGrant     (     -- * Creating a Request@@ -50,9 +52,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'rKeyId'+-- * 'rKeyId' - A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ----- * 'rGrantId'+-- * 'rGrantId' - Identifier of the grant to be revoked. revokeGrant     :: Text -- ^ 'rKeyId'     -> Text -- ^ 'rGrantId'@@ -63,12 +65,7 @@     , _rGrantId = pGrantId_     } --- | A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 rKeyId :: Lens' RevokeGrant Text rKeyId = lens _rKeyId (\ s a -> s{_rKeyId = a}); 
gen/Network/AWS/KMS/ScheduleKeyDeletion.hs view
@@ -18,11 +18,13 @@ -- Stability   : auto-generated -- Portability : non-portable (GHC extensions) ----- Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to 'PendingDeletion'. Before the waiting period ends, you can use < CancelKeyDeletion> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it.+-- Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to @PendingDeletion@ . Before the waiting period ends, you can use 'CancelKeyDeletion' to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it. ----- Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use < DisableKey>. ----- For more information about scheduling a CMK for deletion, see <http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html Deleting Customer Master Keys> in the /AWS Key Management Service Developer Guide/.+-- /Important:/ Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use 'DisableKey' .+--+-- For more information about scheduling a CMK for deletion, see <http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html Deleting Customer Master Keys> in the /AWS Key Management Service Developer Guide/ .+-- module Network.AWS.KMS.ScheduleKeyDeletion     (     -- * Creating a Request@@ -58,9 +60,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'skdPendingWindowInDays'+-- * 'skdPendingWindowInDays' - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. ----- * 'skdKeyId'+-- * 'skdKeyId' - The unique identifier for the customer master key (CMK) to delete. To specify this value, use 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 To obtain the unique key ID and key ARN for a given CMK, use 'ListKeys' or 'DescribeKey' . scheduleKeyDeletion     :: Text -- ^ 'skdKeyId'     -> ScheduleKeyDeletion@@ -70,21 +72,11 @@     , _skdKeyId = pKeyId_     } --- | The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).------ This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.+-- | The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. skdPendingWindowInDays :: Lens' ScheduleKeyDeletion (Maybe Natural) skdPendingWindowInDays = lens _skdPendingWindowInDays (\ s a -> s{_skdPendingWindowInDays = a}) . mapping _Nat; --- | The unique identifier for the customer master key (CMK) to delete.------ To specify this value, use 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------ To obtain the unique key ID and key ARN for a given CMK, use < ListKeys> or < DescribeKey>.+-- | The unique identifier for the customer master key (CMK) to delete. To specify this value, use 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 To obtain the unique key ID and key ARN for a given CMK, use 'ListKeys' or 'DescribeKey' . skdKeyId :: Lens' ScheduleKeyDeletion Text skdKeyId = lens _skdKeyId (\ s a -> s{_skdKeyId = a}); @@ -137,11 +129,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'skdrsKeyId'+-- * 'skdrsKeyId' - The unique identifier of the customer master key (CMK) for which deletion is scheduled. ----- * 'skdrsDeletionDate'+-- * 'skdrsDeletionDate' - The date and time after which AWS KMS deletes the customer master key (CMK). ----- * 'skdrsResponseStatus'+-- * 'skdrsResponseStatus' - -- | The response status code. scheduleKeyDeletionResponse     :: Int -- ^ 'skdrsResponseStatus'     -> ScheduleKeyDeletionResponse@@ -160,7 +152,7 @@ skdrsDeletionDate :: Lens' ScheduleKeyDeletionResponse (Maybe UTCTime) skdrsDeletionDate = lens _skdrsDeletionDate (\ s a -> s{_skdrsDeletionDate = a}) . mapping _Time; --- | The response status code.+-- | -- | The response status code. skdrsResponseStatus :: Lens' ScheduleKeyDeletionResponse Int skdrsResponseStatus = lens _skdrsResponseStatus (\ s a -> s{_skdrsResponseStatus = a}); 
gen/Network/AWS/KMS/Types.hs view
@@ -123,7 +123,7 @@ import           Network.AWS.Prelude import           Network.AWS.Sign.V4 --- | API version '2014-11-01' of the Amazon Key Management Service SDK configuration.+-- | API version @2014-11-01@ of the Amazon Key Management Service SDK configuration. kms :: Service kms =     Service@@ -158,92 +158,132 @@       | otherwise = Nothing  -- | The request was rejected because the marker that specifies where pagination should next begin is not valid.+--+-- _InvalidMarkerException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidMarkerException = _ServiceError . hasCode "InvalidMarkerException"  -- | The request was rejected because the state of the specified resource is not valid for this request. ----- For more information about how key state affects the use of a customer master key (CMK), see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects the Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/.+--+-- For more information about how key state affects the use of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/ .+-- _KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError _KMSInvalidStateException = _ServiceError . hasCode "KMSInvalidStateException" --- | The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT\/DECRYPT.+-- | The request was rejected because the specified @KeySpec@ value is not valid.+--+-- _InvalidKeyUsageException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidKeyUsageException = _ServiceError . hasCode "InvalidKeyUsageException"  -- | The request was rejected because the specified policy is not syntactically or semantically correct.+--+-- _MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError _MalformedPolicyDocumentException =     _ServiceError . hasCode "MalformedPolicyDocumentException"  -- | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.+--+-- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError _UnsupportedOperationException =     _ServiceError . hasCode "UnsupportedOperationException" --- | The request was rejected because the specified key was marked as disabled.+-- | The request was rejected because the specified CMK is not enabled.+--+-- _DisabledException :: AsError a => Getting (First ServiceError) a ServiceError _DisabledException = _ServiceError . hasCode "DisabledException" --- | The request was rejected because the key was not available. The request can be retried.+-- | The request was rejected because the specified CMK was not available. The request can be retried.+--+-- _KeyUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError _KeyUnavailableException = _ServiceError . hasCode "KeyUnavailableException"  -- | The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).+--+-- _IncorrectKeyMaterialException :: AsError a => Getting (First ServiceError) a ServiceError _IncorrectKeyMaterialException =     _ServiceError . hasCode "IncorrectKeyMaterialException"  -- | The request was rejected because an internal exception occurred. The request can be retried.+--+-- _KMSInternalException :: AsError a => Getting (First ServiceError) a ServiceError _KMSInternalException = _ServiceError . hasCode "KMSInternalException"  -- | The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).+--+-- _InvalidImportTokenException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidImportTokenException =     _ServiceError . hasCode "InvalidImportTokenException"  -- | The request was rejected because the specified entity or resource could not be found.+--+-- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _NotFoundException = _ServiceError . hasCode "NotFoundException"  -- | The request was rejected because the specified alias name is not valid.+--+-- _InvalidAliasNameException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidAliasNameException =     _ServiceError . hasCode "InvalidAliasNameException" --- | The request was rejected because the specified 'GrantId' is not valid.+-- | The request was rejected because the specified @GrantId@ is not valid.+--+-- _InvalidGrantIdException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidGrantIdException = _ServiceError . hasCode "InvalidGrantIdException" --- | The request was rejected because a grant token provided as part of the request is invalid.+-- | The request was rejected because the specified grant token is not valid.+--+-- _InvalidGrantTokenException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidGrantTokenException =     _ServiceError . hasCode "InvalidGrantTokenException"  -- | The request was rejected because a specified ARN was not valid.+--+-- _InvalidARNException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidARNException = _ServiceError . hasCode "InvalidArnException"  -- | The system timed out while trying to fulfill the request. The request can be retried.+--+-- _DependencyTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError _DependencyTimeoutException =     _ServiceError . hasCode "DependencyTimeoutException" --- | The request was rejected because the provided import token is expired. Use < GetParametersForImport> to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.+-- | The request was rejected because the provided import token is expired. Use 'GetParametersForImport' to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.+--+-- _ExpiredImportTokenException :: AsError a => Getting (First ServiceError) a ServiceError _ExpiredImportTokenException =     _ServiceError . hasCode "ExpiredImportTokenException"  -- | The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.+--+-- _InvalidCiphertextException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidCiphertextException =     _ServiceError . hasCode "InvalidCiphertextException"  -- | The request was rejected because it attempted to create a resource that already exists.+--+-- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError _AlreadyExistsException = _ServiceError . hasCode "AlreadyExistsException" --- | The request was rejected because a limit was exceeded. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/limits.html Limits> in the /AWS Key Management Service Developer Guide/.+-- | The request was rejected because a limit was exceeded. For more information, see <http://docs.aws.amazon.com/kms/latest/developerguide/limits.html Limits> in the /AWS Key Management Service Developer Guide/ .+--+-- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _LimitExceededException = _ServiceError . hasCode "LimitExceededException"
gen/Network/AWS/KMS/Types/Product.hs view
@@ -23,6 +23,8 @@  -- | Contains information about an alias. --+--+-- -- /See:/ 'aliasListEntry' smart constructor. data AliasListEntry = AliasListEntry'     { _aleTargetKeyId :: !(Maybe Text)@@ -34,11 +36,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'aleTargetKeyId'+-- * 'aleTargetKeyId' - String that contains the key identifier pointed to by the alias. ----- * 'aleAliasName'+-- * 'aleAliasName' - String that contains the alias. ----- * 'aleAliasARN'+-- * 'aleAliasARN' - String that contains the key ARN. aliasListEntry     :: AliasListEntry aliasListEntry =@@ -74,8 +76,10 @@  -- | A structure for specifying the conditions under which the operations permitted by the grant are allowed. ----- You can use this structure to allow the operations permitted by the grant only when a specified encryption context is present. For more information about encryption context, see <http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/. --+-- You can use this structure to allow the operations permitted by the grant only when a specified encryption context is present. For more information about encryption context, see <http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html Encryption Context> in the /AWS Key Management Service Developer Guide/ .+--+-- -- /See:/ 'grantConstraints' smart constructor. data GrantConstraints = GrantConstraints'     { _gcEncryptionContextEquals :: !(Maybe (Map Text Text))@@ -86,9 +90,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gcEncryptionContextEquals'+-- * 'gcEncryptionContextEquals' - Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed. ----- * 'gcEncryptionContextSubset'+-- * 'gcEncryptionContextSubset' - Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed. grantConstraints     :: GrantConstraints grantConstraints =@@ -128,6 +132,8 @@  -- | Contains information about an entry in a list of grants. --+--+-- -- /See:/ 'grantListEntry' smart constructor. data GrantListEntry = GrantListEntry'     { _gleKeyId             :: !(Maybe Text)@@ -145,23 +151,23 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'gleKeyId'+-- * 'gleKeyId' - The unique identifier for the customer master key (CMK) to which the grant applies. ----- * 'gleRetiringPrincipal'+-- * 'gleRetiringPrincipal' - The principal that can retire the grant. ----- * 'gleIssuingAccount'+-- * 'gleIssuingAccount' - The AWS account under which the grant was issued. ----- * 'gleGrantId'+-- * 'gleGrantId' - The unique identifier for the grant. ----- * 'gleConstraints'+-- * 'gleConstraints' - The conditions under which the grant's operations are allowed. ----- * 'gleGranteePrincipal'+-- * 'gleGranteePrincipal' - The principal that receives the grant's permissions. ----- * 'gleName'+-- * 'gleName' - The friendly name that identifies the grant. If a name was provided in the 'CreateGrant' request, that name is returned. Otherwise this value is null. ----- * 'gleCreationDate'+-- * 'gleCreationDate' - The date and time when the grant was created. ----- * 'gleOperations'+-- * 'gleOperations' - The list of operations permitted by the grant. grantListEntry     :: GrantListEntry grantListEntry =@@ -193,15 +199,15 @@ gleGrantId :: Lens' GrantListEntry (Maybe Text) gleGrantId = lens _gleGrantId (\ s a -> s{_gleGrantId = a}); --- | The conditions under which the grant\'s operations are allowed.+-- | The conditions under which the grant's operations are allowed. gleConstraints :: Lens' GrantListEntry (Maybe GrantConstraints) gleConstraints = lens _gleConstraints (\ s a -> s{_gleConstraints = a}); --- | The principal that receives the grant\'s permissions.+-- | The principal that receives the grant's permissions. gleGranteePrincipal :: Lens' GrantListEntry (Maybe Text) gleGranteePrincipal = lens _gleGranteePrincipal (\ s a -> s{_gleGranteePrincipal = a}); --- | The friendly name that identifies the grant. If a name was provided in the < CreateGrant> request, that name is returned. Otherwise this value is null.+-- | The friendly name that identifies the grant. If a name was provided in the 'CreateGrant' request, that name is returned. Otherwise this value is null. gleName :: Lens' GrantListEntry (Maybe Text) gleName = lens _gleName (\ s a -> s{_gleName = a}); @@ -233,6 +239,8 @@  -- | Contains information about each entry in the key list. --+--+-- -- /See:/ 'keyListEntry' smart constructor. data KeyListEntry = KeyListEntry'     { _kleKeyId  :: !(Maybe Text)@@ -243,9 +251,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'kleKeyId'+-- * 'kleKeyId' - Unique identifier of the key. ----- * 'kleKeyARN'+-- * 'kleKeyARN' - ARN of the key. keyListEntry     :: KeyListEntry keyListEntry =@@ -275,8 +283,10 @@  -- | Contains metadata about a customer master key (CMK). ----- This data type is used as a response element for the < CreateKey> and < DescribeKey> operations. --+-- This data type is used as a response element for the 'CreateKey' and 'DescribeKey' operations.+--+-- -- /See:/ 'keyMetadata' smart constructor. data KeyMetadata = KeyMetadata'     { _kmOrigin          :: !(Maybe OriginType)@@ -297,29 +307,29 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'kmOrigin'+-- * 'kmOrigin' - The source of the CMK's key material. When this value is @AWS_KMS@ , AWS KMS created the key material. When this value is @EXTERNAL@ , the key material was imported from your existing key management infrastructure or the CMK lacks key material. ----- * 'kmExpirationModel'+-- * 'kmExpirationModel' - Specifies whether the CMK's key material expires. This value is present only when @Origin@ is @EXTERNAL@ , otherwise this value is omitted. ----- * 'kmEnabled'+-- * 'kmEnabled' - Specifies whether the CMK is enabled. When @KeyState@ is @Enabled@ this value is true, otherwise it is false. ----- * 'kmValidTo'+-- * 'kmValidTo' - The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose @Origin@ is @EXTERNAL@ and whose @ExpirationModel@ is @KEY_MATERIAL_EXPIRES@ , otherwise this value is omitted. ----- * 'kmARN'+-- * 'kmARN' - The Amazon Resource Name (ARN) of the CMK. For examples, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms AWS Key Management Service (AWS KMS)> in the Example ARNs section of the /AWS General Reference/ . ----- * 'kmKeyState'+-- * 'kmKeyState' - The state of the CMK. For more information about how key state affects the use of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects the Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/ . ----- * 'kmAWSAccountId'+-- * 'kmAWSAccountId' - The twelve-digit account ID of the AWS account that owns the CMK. ----- * 'kmKeyUsage'+-- * 'kmKeyUsage' - The cryptographic operations for which you can use the CMK. Currently the only allowed value is @ENCRYPT_DECRYPT@ , which means you can use the CMK for the 'Encrypt' and 'Decrypt' operations. ----- * 'kmCreationDate'+-- * 'kmCreationDate' - The date and time when the CMK was created. ----- * 'kmDeletionDate'+-- * 'kmDeletionDate' - The date and time after which AWS KMS deletes the CMK. This value is present only when @KeyState@ is @PendingDeletion@ , otherwise this value is omitted. ----- * 'kmDescription'+-- * 'kmDescription' - The description of the CMK. ----- * 'kmKeyId'+-- * 'kmKeyId' - The globally unique identifier for the CMK. keyMetadata     :: Text -- ^ 'kmKeyId'     -> KeyMetadata@@ -339,29 +349,27 @@     , _kmKeyId = pKeyId_     } --- | The source of the CMK\'s key material. When this value is 'AWS_KMS', AWS KMS created the key material. When this value is 'EXTERNAL', the key material was imported from your existing key management infrastructure or the CMK lacks key material.+-- | The source of the CMK's key material. When this value is @AWS_KMS@ , AWS KMS created the key material. When this value is @EXTERNAL@ , the key material was imported from your existing key management infrastructure or the CMK lacks key material. kmOrigin :: Lens' KeyMetadata (Maybe OriginType) kmOrigin = lens _kmOrigin (\ s a -> s{_kmOrigin = a}); --- | Specifies whether the CMK\'s key material expires. This value is present only when 'Origin' is 'EXTERNAL', otherwise this value is omitted.+-- | Specifies whether the CMK's key material expires. This value is present only when @Origin@ is @EXTERNAL@ , otherwise this value is omitted. kmExpirationModel :: Lens' KeyMetadata (Maybe ExpirationModelType) kmExpirationModel = lens _kmExpirationModel (\ s a -> s{_kmExpirationModel = a}); --- | Specifies whether the CMK is enabled. When 'KeyState' is 'Enabled' this value is true, otherwise it is false.+-- | Specifies whether the CMK is enabled. When @KeyState@ is @Enabled@ this value is true, otherwise it is false. kmEnabled :: Lens' KeyMetadata (Maybe Bool) kmEnabled = lens _kmEnabled (\ s a -> s{_kmEnabled = a}); --- | The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose 'Origin' is 'EXTERNAL' and whose 'ExpirationModel' is 'KEY_MATERIAL_EXPIRES', otherwise this value is omitted.+-- | The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose @Origin@ is @EXTERNAL@ and whose @ExpirationModel@ is @KEY_MATERIAL_EXPIRES@ , otherwise this value is omitted. kmValidTo :: Lens' KeyMetadata (Maybe UTCTime) kmValidTo = lens _kmValidTo (\ s a -> s{_kmValidTo = a}) . mapping _Time; --- | The Amazon Resource Name (ARN) of the CMK. For examples, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms AWS Key Management Service (AWS KMS)> in the Example ARNs section of the /AWS General Reference/.+-- | The Amazon Resource Name (ARN) of the CMK. For examples, see <http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms AWS Key Management Service (AWS KMS)> in the Example ARNs section of the /AWS General Reference/ . kmARN :: Lens' KeyMetadata (Maybe Text) kmARN = lens _kmARN (\ s a -> s{_kmARN = a}); --- | The state of the CMK.------ For more information about how key state affects the use of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects the Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/.+-- | The state of the CMK. For more information about how key state affects the use of a CMK, see <http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html How Key State Affects the Use of a Customer Master Key> in the /AWS Key Management Service Developer Guide/ . kmKeyState :: Lens' KeyMetadata (Maybe KeyState) kmKeyState = lens _kmKeyState (\ s a -> s{_kmKeyState = a}); @@ -369,7 +377,7 @@ kmAWSAccountId :: Lens' KeyMetadata (Maybe Text) kmAWSAccountId = lens _kmAWSAccountId (\ s a -> s{_kmAWSAccountId = a}); --- | The cryptographic operations for which you can use the CMK. Currently the only allowed value is 'ENCRYPT_DECRYPT', which means you can use the CMK for the < Encrypt> and < Decrypt> operations.+-- | The cryptographic operations for which you can use the CMK. Currently the only allowed value is @ENCRYPT_DECRYPT@ , which means you can use the CMK for the 'Encrypt' and 'Decrypt' operations. kmKeyUsage :: Lens' KeyMetadata (Maybe KeyUsageType) kmKeyUsage = lens _kmKeyUsage (\ s a -> s{_kmKeyUsage = a}); @@ -377,7 +385,7 @@ kmCreationDate :: Lens' KeyMetadata (Maybe UTCTime) kmCreationDate = lens _kmCreationDate (\ s a -> s{_kmCreationDate = a}) . mapping _Time; --- | The date and time after which AWS KMS deletes the CMK. This value is present only when 'KeyState' is 'PendingDeletion', otherwise this value is omitted.+-- | The date and time after which AWS KMS deletes the CMK. This value is present only when @KeyState@ is @PendingDeletion@ , otherwise this value is omitted. kmDeletionDate :: Lens' KeyMetadata (Maybe UTCTime) kmDeletionDate = lens _kmDeletionDate (\ s a -> s{_kmDeletionDate = a}) . mapping _Time; @@ -421,11 +429,11 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'lgTruncated'+-- * 'lgTruncated' - A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. ----- * 'lgGrants'+-- * 'lgGrants' - A list of grants. ----- * 'lgNextMarker'+-- * 'lgNextMarker' - When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. listGrantsResponse     :: ListGrantsResponse listGrantsResponse =@@ -435,7 +443,7 @@     , _lgNextMarker = Nothing     } --- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the 'Marker' parameter to make a subsequent pagination request to retrieve more items in the list.+-- | A flag that indicates whether there are more items in the list. If your results were truncated, you can use the @Marker@ parameter to make a subsequent pagination request to retrieve more items in the list. lgTruncated :: Lens' ListGrantsResponse (Maybe Bool) lgTruncated = lens _lgTruncated (\ s a -> s{_lgTruncated = a}); @@ -443,7 +451,7 @@ lgGrants :: Lens' ListGrantsResponse [GrantListEntry] lgGrants = lens _lgGrants (\ s a -> s{_lgGrants = a}) . _Default . _Coerce; --- | When 'Truncated' is true, this value is present and contains the value to use for the 'Marker' parameter in a subsequent pagination request.+-- | When @Truncated@ is true, this value is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. lgNextMarker :: Lens' ListGrantsResponse (Maybe Text) lgNextMarker = lens _lgNextMarker (\ s a -> s{_lgNextMarker = a}); 
gen/Network/AWS/KMS/UpdateAlias.hs view
@@ -20,11 +20,13 @@ -- -- Updates an alias to map it to a different key. --+-- -- An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key. ----- An alias name can contain only alphanumeric characters, forward slashes (\/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias\/). An alias that begins with \"aws\" after the forward slash (alias\/aws...) is reserved by Amazon Web Services (AWS).+-- An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS). -- -- The alias and the key it is mapped to must be in the same AWS account and the same region.+-- module Network.AWS.KMS.UpdateAlias     (     -- * Creating a Request@@ -56,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'uaAliasName'+-- * 'uaAliasName' - String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved. ----- * 'uaTargetKeyId'+-- * 'uaTargetKeyId' - Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 You can call 'ListAliases' to verify that the alias is mapped to the correct @TargetKeyId@ . updateAlias     :: Text -- ^ 'uaAliasName'     -> Text -- ^ 'uaTargetKeyId'@@ -69,17 +71,11 @@     , _uaTargetKeyId = pTargetKeyId_     } --- | String that contains the name of the alias to be modified. The name must start with the word \"alias\" followed by a forward slash (alias\/). Aliases that begin with \"alias\/aws\" are reserved.+-- | String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved. uaAliasName :: Lens' UpdateAlias Text uaAliasName = lens _uaAliasName (\ s a -> s{_uaAliasName = a}); --- | Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012------ You can call < ListAliases> to verify that the alias is mapped to the correct 'TargetKeyId'.+-- | Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 You can call 'ListAliases' to verify that the alias is mapped to the correct @TargetKeyId@ . uaTargetKeyId :: Lens' UpdateAlias Text uaTargetKeyId = lens _uaTargetKeyId (\ s a -> s{_uaTargetKeyId = a}); 
gen/Network/AWS/KMS/UpdateKeyDescription.hs view
@@ -19,6 +19,8 @@ -- Portability : non-portable (GHC extensions) -- -- Updates the description of a key.+--+-- module Network.AWS.KMS.UpdateKeyDescription     (     -- * Creating a Request@@ -50,9 +52,9 @@ -- -- Use one of the following lenses to modify other fields as desired: ----- * 'ukdKeyId'+-- * 'ukdKeyId' - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ----- * 'ukdDescription'+-- * 'ukdDescription' - New description for the key. updateKeyDescription     :: Text -- ^ 'ukdKeyId'     -> Text -- ^ 'ukdDescription'@@ -63,12 +65,7 @@     , _ukdDescription = pDescription_     } --- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.------ -   Key ARN Example - arn:aws:kms:us-east-1:123456789012:key\/12345678-1234-1234-1234-123456789012------ -   Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012---+-- | A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.     * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 ukdKeyId :: Lens' UpdateKeyDescription Text ukdKeyId = lens _ukdKeyId (\ s a -> s{_ukdKeyId = a});