Network.AWS.KMS

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 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 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 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 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 AWS CloudTrail User Guide.

Additional Resources

For more information about credentials and request signing, see the following:

• AWS Security Credentials
• This topic provides general information about the types of credentials used for accessing AWS.
• AWS Security Token Service
• This guide describes how to create and use temporary security credentials.
• Signing AWS API Requests
• 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

Service Configuration

kms :: Service

API version '2014-11-01' of the Amazon Key Management Service SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by KMS.

InvalidMarkerException

_InvalidMarkerException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the marker that specifies where pagination should next begin is not valid.

KMSInvalidStateException

_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError

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), go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

InvalidKeyUsageException

_InvalidKeyUsageException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT.

MalformedPolicyDocumentException

_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified policy is not syntactically or semantically correct.

UnsupportedOperationException

_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because a specified parameter is not supported.

DisabledException

_DisabledException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified key was marked as disabled.

KeyUnavailableException

_KeyUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the key was not available. The request can be retried.

KMSInternalException

_KMSInternalException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because an internal exception occurred. The request can be retried.

NotFoundException

_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified entity or resource could not be found.

InvalidAliasNameException

_InvalidAliasNameException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified alias name is not valid.

InvalidGrantIdException

_InvalidGrantIdException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified GrantId is not valid.

InvalidGrantTokenException

_InvalidGrantTokenException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because a grant token provided as part of the request is invalid.

InvalidARNException

_InvalidARNException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because a specified ARN was not valid.

DependencyTimeoutException

_DependencyTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError

The system timed out while trying to fulfill the request. The request can be retried.

InvalidCiphertextException

_InvalidCiphertextException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.

AlreadyExistsException

_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because it attempted to create a resource that already exists.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

Encrypt

module Network.AWS.KMS.Encrypt

ListGrants (Paginated)

module Network.AWS.KMS.ListGrants

DisableKeyRotation

module Network.AWS.KMS.DisableKeyRotation

GenerateDataKeyWithoutPlaintext

module Network.AWS.KMS.GenerateDataKeyWithoutPlaintext

EnableKeyRotation

module Network.AWS.KMS.EnableKeyRotation

CreateAlias

module Network.AWS.KMS.CreateAlias

CreateGrant

module Network.AWS.KMS.CreateGrant

ListAliases (Paginated)

module Network.AWS.KMS.ListAliases

ListRetirableGrants

module Network.AWS.KMS.ListRetirableGrants

GenerateRandom

module Network.AWS.KMS.GenerateRandom

CreateKey

module Network.AWS.KMS.CreateKey

DisableKey

module Network.AWS.KMS.DisableKey

RetireGrant

module Network.AWS.KMS.RetireGrant

ListKeys (Paginated)

module Network.AWS.KMS.ListKeys

GetKeyRotationStatus

module Network.AWS.KMS.GetKeyRotationStatus

GenerateDataKey

module Network.AWS.KMS.GenerateDataKey

DeleteAlias

module Network.AWS.KMS.DeleteAlias

UpdateAlias

module Network.AWS.KMS.UpdateAlias

DescribeKey

module Network.AWS.KMS.DescribeKey

CancelKeyDeletion

module Network.AWS.KMS.CancelKeyDeletion

Decrypt

module Network.AWS.KMS.Decrypt

UpdateKeyDescription

module Network.AWS.KMS.UpdateKeyDescription

ReEncrypt

module Network.AWS.KMS.ReEncrypt

ListKeyPolicies (Paginated)

module Network.AWS.KMS.ListKeyPolicies

ScheduleKeyDeletion

module Network.AWS.KMS.ScheduleKeyDeletion

PutKeyPolicy

module Network.AWS.KMS.PutKeyPolicy

EnableKey

module Network.AWS.KMS.EnableKey

RevokeGrant

module Network.AWS.KMS.RevokeGrant

GetKeyPolicy

module Network.AWS.KMS.GetKeyPolicy

Types

DataKeySpec

data DataKeySpec

Constructors

AES128

AES256

Instances

Bounded DataKeySpec

Methods

minBound :: DataKeySpec

maxBound :: DataKeySpec

Enum DataKeySpec

Methods

succ :: DataKeySpec -> DataKeySpec

pred :: DataKeySpec -> DataKeySpec

toEnum :: Int -> DataKeySpec

fromEnum :: DataKeySpec -> Int

enumFrom :: DataKeySpec -> [DataKeySpec]

enumFromThen :: DataKeySpec -> DataKeySpec -> [DataKeySpec]

enumFromTo :: DataKeySpec -> DataKeySpec -> [DataKeySpec]

enumFromThenTo :: DataKeySpec -> DataKeySpec -> DataKeySpec -> [DataKeySpec]

Eq DataKeySpec

Methods

(==) :: DataKeySpec -> DataKeySpec -> Bool

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

Data DataKeySpec

Methods

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

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

toConstr :: DataKeySpec -> Constr

dataTypeOf :: DataKeySpec -> DataType

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

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

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

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

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

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

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

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

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

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

Ord DataKeySpec

Methods

compare :: DataKeySpec -> DataKeySpec -> Ordering

(<) :: DataKeySpec -> DataKeySpec -> Bool

(<=) :: DataKeySpec -> DataKeySpec -> Bool

(>) :: DataKeySpec -> DataKeySpec -> Bool

(>=) :: DataKeySpec -> DataKeySpec -> Bool

max :: DataKeySpec -> DataKeySpec -> DataKeySpec

min :: DataKeySpec -> DataKeySpec -> DataKeySpec

Read DataKeySpec

Methods

readsPrec :: Int -> ReadS DataKeySpec

readList :: ReadS [DataKeySpec]

readPrec :: ReadPrec DataKeySpec

readListPrec :: ReadPrec [DataKeySpec]

Show DataKeySpec

Methods

showsPrec :: Int -> DataKeySpec -> ShowS

show :: DataKeySpec -> String

showList :: [DataKeySpec] -> ShowS

Generic DataKeySpec

Associated Types

type Rep DataKeySpec :: * -> *

Methods

from :: DataKeySpec -> Rep DataKeySpec x

to :: Rep DataKeySpec x -> DataKeySpec

Hashable DataKeySpec

Methods

hashWithSalt :: Int -> DataKeySpec -> Int

hash :: DataKeySpec -> Int

ToJSON DataKeySpec

Methods

toJSON :: DataKeySpec -> Value

toEncoding :: DataKeySpec -> Encoding

toJSONList :: [DataKeySpec] -> Value

toEncodingList :: [DataKeySpec] -> Encoding

NFData DataKeySpec

Methods

rnf :: DataKeySpec -> ()

ToQuery DataKeySpec

Methods

toQuery :: DataKeySpec -> QueryString

ToHeader DataKeySpec

Methods

toHeader :: HeaderName -> DataKeySpec -> [Header]

ToByteString DataKeySpec

Methods

toBS :: DataKeySpec -> ByteString

FromText DataKeySpec

Methods

parser :: Parser DataKeySpec

ToText DataKeySpec

Methods

toText :: DataKeySpec -> Text

type Rep DataKeySpec

type Rep DataKeySpec = D1 (MetaData "DataKeySpec" "Network.AWS.KMS.Types.Sum" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) ((:+:) (C1 (MetaCons "AES128" PrefixI False) U1) (C1 (MetaCons "AES256" PrefixI False) U1))

GrantOperation

data GrantOperation

Constructors

CreateGrant

Decrypt

DescribeKey

Encrypt

GenerateDataKey

GenerateDataKeyWithoutPlaintext

ReEncryptFrom

ReEncryptTo

RetireGrant

Instances

Bounded GrantOperation

Methods

minBound :: GrantOperation

maxBound :: GrantOperation

Enum GrantOperation

Methods

succ :: GrantOperation -> GrantOperation

pred :: GrantOperation -> GrantOperation

toEnum :: Int -> GrantOperation

fromEnum :: GrantOperation -> Int

enumFrom :: GrantOperation -> [GrantOperation]

enumFromThen :: GrantOperation -> GrantOperation -> [GrantOperation]

enumFromTo :: GrantOperation -> GrantOperation -> [GrantOperation]

enumFromThenTo :: GrantOperation -> GrantOperation -> GrantOperation -> [GrantOperation]

Eq GrantOperation

Methods

(==) :: GrantOperation -> GrantOperation -> Bool

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

Data GrantOperation

Methods

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

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

toConstr :: GrantOperation -> Constr

dataTypeOf :: GrantOperation -> DataType

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

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

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

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

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

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

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

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

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

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

Ord GrantOperation

Methods

compare :: GrantOperation -> GrantOperation -> Ordering

(<) :: GrantOperation -> GrantOperation -> Bool

(<=) :: GrantOperation -> GrantOperation -> Bool

(>) :: GrantOperation -> GrantOperation -> Bool

(>=) :: GrantOperation -> GrantOperation -> Bool

max :: GrantOperation -> GrantOperation -> GrantOperation

min :: GrantOperation -> GrantOperation -> GrantOperation

Read GrantOperation

Methods

readsPrec :: Int -> ReadS GrantOperation

readList :: ReadS [GrantOperation]

readPrec :: ReadPrec GrantOperation

readListPrec :: ReadPrec [GrantOperation]

Show GrantOperation

Methods

showsPrec :: Int -> GrantOperation -> ShowS

show :: GrantOperation -> String

showList :: [GrantOperation] -> ShowS

Generic GrantOperation

Associated Types

type Rep GrantOperation :: * -> *

Methods

from :: GrantOperation -> Rep GrantOperation x

to :: Rep GrantOperation x -> GrantOperation

Hashable GrantOperation

Methods

hashWithSalt :: Int -> GrantOperation -> Int

hash :: GrantOperation -> Int

ToJSON GrantOperation

Methods

toJSON :: GrantOperation -> Value

toEncoding :: GrantOperation -> Encoding

toJSONList :: [GrantOperation] -> Value

toEncodingList :: [GrantOperation] -> Encoding

FromJSON GrantOperation

Methods

parseJSON :: Value -> Parser GrantOperation

parseJSONList :: Value -> Parser [GrantOperation]

NFData GrantOperation

Methods

rnf :: GrantOperation -> ()

ToQuery GrantOperation

Methods

toQuery :: GrantOperation -> QueryString

ToHeader GrantOperation

Methods

toHeader :: HeaderName -> GrantOperation -> [Header]

ToByteString GrantOperation

Methods

toBS :: GrantOperation -> ByteString

FromText GrantOperation

Methods

parser :: Parser GrantOperation

ToText GrantOperation

Methods

toText :: GrantOperation -> Text

type Rep GrantOperation

type Rep GrantOperation = D1 (MetaData "GrantOperation" "Network.AWS.KMS.Types.Sum" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "CreateGrant" PrefixI False) U1) (C1 (MetaCons "Decrypt" PrefixI False) U1)) ((:+:) (C1 (MetaCons "DescribeKey" PrefixI False) U1) (C1 (MetaCons "Encrypt" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "GenerateDataKey" PrefixI False) U1) (C1 (MetaCons "GenerateDataKeyWithoutPlaintext" PrefixI False) U1)) ((:+:) (C1 (MetaCons "ReEncryptFrom" PrefixI False) U1) ((:+:) (C1 (MetaCons "ReEncryptTo" PrefixI False) U1) (C1 (MetaCons "RetireGrant" PrefixI False) U1)))))

KeyState

data KeyState

Constructors

Disabled

Enabled

PendingDeletion

Instances

Bounded KeyState

Methods

minBound :: KeyState

maxBound :: KeyState

Enum KeyState

Methods

succ :: KeyState -> KeyState

pred :: KeyState -> KeyState

toEnum :: Int -> KeyState

fromEnum :: KeyState -> Int

enumFrom :: KeyState -> [KeyState]

enumFromThen :: KeyState -> KeyState -> [KeyState]

enumFromTo :: KeyState -> KeyState -> [KeyState]

enumFromThenTo :: KeyState -> KeyState -> KeyState -> [KeyState]

Eq KeyState

Methods

(==) :: KeyState -> KeyState -> Bool

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

Data KeyState

Methods

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

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

toConstr :: KeyState -> Constr

dataTypeOf :: KeyState -> DataType

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

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

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

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

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

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

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

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

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

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

Ord KeyState

Methods

compare :: KeyState -> KeyState -> Ordering

(<) :: KeyState -> KeyState -> Bool

(<=) :: KeyState -> KeyState -> Bool

(>) :: KeyState -> KeyState -> Bool

(>=) :: KeyState -> KeyState -> Bool

max :: KeyState -> KeyState -> KeyState

min :: KeyState -> KeyState -> KeyState

Read KeyState

Methods

readsPrec :: Int -> ReadS KeyState

readList :: ReadS [KeyState]

readPrec :: ReadPrec KeyState

readListPrec :: ReadPrec [KeyState]

Show KeyState

Methods

showsPrec :: Int -> KeyState -> ShowS

show :: KeyState -> String

showList :: [KeyState] -> ShowS

Generic KeyState

Associated Types

type Rep KeyState :: * -> *

Methods

from :: KeyState -> Rep KeyState x

to :: Rep KeyState x -> KeyState

Hashable KeyState

Methods

hashWithSalt :: Int -> KeyState -> Int

hash :: KeyState -> Int

FromJSON KeyState

Methods

parseJSON :: Value -> Parser KeyState

parseJSONList :: Value -> Parser [KeyState]

NFData KeyState

Methods

rnf :: KeyState -> ()

ToQuery KeyState

Methods

toQuery :: KeyState -> QueryString

ToHeader KeyState

Methods

toHeader :: HeaderName -> KeyState -> [Header]

ToByteString KeyState

Methods

toBS :: KeyState -> ByteString

FromText KeyState

Methods

parser :: Parser KeyState

ToText KeyState

Methods

toText :: KeyState -> Text

type Rep KeyState

type Rep KeyState = D1 (MetaData "KeyState" "Network.AWS.KMS.Types.Sum" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) ((:+:) (C1 (MetaCons "Disabled" PrefixI False) U1) ((:+:) (C1 (MetaCons "Enabled" PrefixI False) U1) (C1 (MetaCons "PendingDeletion" PrefixI False) U1)))

KeyUsageType

data KeyUsageType

Constructors

EncryptDecrypt

Instances

Bounded KeyUsageType

Methods

minBound :: KeyUsageType

maxBound :: KeyUsageType

Enum KeyUsageType

Methods

succ :: KeyUsageType -> KeyUsageType

pred :: KeyUsageType -> KeyUsageType

toEnum :: Int -> KeyUsageType

fromEnum :: KeyUsageType -> Int

enumFrom :: KeyUsageType -> [KeyUsageType]

enumFromThen :: KeyUsageType -> KeyUsageType -> [KeyUsageType]

enumFromTo :: KeyUsageType -> KeyUsageType -> [KeyUsageType]

enumFromThenTo :: KeyUsageType -> KeyUsageType -> KeyUsageType -> [KeyUsageType]

Eq KeyUsageType

Methods

(==) :: KeyUsageType -> KeyUsageType -> Bool

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

Data KeyUsageType

Methods

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

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

toConstr :: KeyUsageType -> Constr

dataTypeOf :: KeyUsageType -> DataType

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

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

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

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

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

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

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

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

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

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

Ord KeyUsageType

Methods

compare :: KeyUsageType -> KeyUsageType -> Ordering

(<) :: KeyUsageType -> KeyUsageType -> Bool

(<=) :: KeyUsageType -> KeyUsageType -> Bool

(>) :: KeyUsageType -> KeyUsageType -> Bool

(>=) :: KeyUsageType -> KeyUsageType -> Bool

max :: KeyUsageType -> KeyUsageType -> KeyUsageType

min :: KeyUsageType -> KeyUsageType -> KeyUsageType

Read KeyUsageType

Methods

readsPrec :: Int -> ReadS KeyUsageType

readList :: ReadS [KeyUsageType]

readPrec :: ReadPrec KeyUsageType

readListPrec :: ReadPrec [KeyUsageType]

Show KeyUsageType

Methods

showsPrec :: Int -> KeyUsageType -> ShowS

show :: KeyUsageType -> String

showList :: [KeyUsageType] -> ShowS

Generic KeyUsageType

Associated Types

type Rep KeyUsageType :: * -> *

Methods

from :: KeyUsageType -> Rep KeyUsageType x

to :: Rep KeyUsageType x -> KeyUsageType

Hashable KeyUsageType

Methods

hashWithSalt :: Int -> KeyUsageType -> Int

hash :: KeyUsageType -> Int

ToJSON KeyUsageType

Methods

toJSON :: KeyUsageType -> Value

toEncoding :: KeyUsageType -> Encoding

toJSONList :: [KeyUsageType] -> Value

toEncodingList :: [KeyUsageType] -> Encoding

FromJSON KeyUsageType

Methods

parseJSON :: Value -> Parser KeyUsageType

parseJSONList :: Value -> Parser [KeyUsageType]

NFData KeyUsageType

Methods

rnf :: KeyUsageType -> ()

ToQuery KeyUsageType

Methods

toQuery :: KeyUsageType -> QueryString

ToHeader KeyUsageType

Methods

toHeader :: HeaderName -> KeyUsageType -> [Header]

ToByteString KeyUsageType

Methods

toBS :: KeyUsageType -> ByteString

FromText KeyUsageType

Methods

parser :: Parser KeyUsageType

ToText KeyUsageType

Methods

toText :: KeyUsageType -> Text

type Rep KeyUsageType

type Rep KeyUsageType = D1 (MetaData "KeyUsageType" "Network.AWS.KMS.Types.Sum" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "EncryptDecrypt" PrefixI False) U1)

AliasListEntry

data AliasListEntry

Contains information about an alias.

See: aliasListEntry smart constructor.

Instances

Eq AliasListEntry

Methods

(==) :: AliasListEntry -> AliasListEntry -> Bool

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

Data AliasListEntry

Methods

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

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

toConstr :: AliasListEntry -> Constr

dataTypeOf :: AliasListEntry -> DataType

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

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

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

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

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

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

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

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

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

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

Read AliasListEntry

Methods

readsPrec :: Int -> ReadS AliasListEntry

readList :: ReadS [AliasListEntry]

readPrec :: ReadPrec AliasListEntry

readListPrec :: ReadPrec [AliasListEntry]

Show AliasListEntry

Methods

showsPrec :: Int -> AliasListEntry -> ShowS

show :: AliasListEntry -> String

showList :: [AliasListEntry] -> ShowS

Generic AliasListEntry

Associated Types

type Rep AliasListEntry :: * -> *

Methods

from :: AliasListEntry -> Rep AliasListEntry x

to :: Rep AliasListEntry x -> AliasListEntry

Hashable AliasListEntry

Methods

hashWithSalt :: Int -> AliasListEntry -> Int

hash :: AliasListEntry -> Int

FromJSON AliasListEntry

Methods

parseJSON :: Value -> Parser AliasListEntry

parseJSONList :: Value -> Parser [AliasListEntry]

NFData AliasListEntry

Methods

rnf :: AliasListEntry -> ()

type Rep AliasListEntry

type Rep AliasListEntry = D1 (MetaData "AliasListEntry" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "AliasListEntry'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_aleTargetKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_aleAliasName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aleAliasARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

aliasListEntry :: AliasListEntry

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

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

• aleTargetKeyId
• aleAliasName
• aleAliasARN

aleTargetKeyId :: Lens' AliasListEntry (Maybe Text)

String that contains the key identifier pointed to by the alias.

aleAliasName :: Lens' AliasListEntry (Maybe Text)

String that contains the alias.

aleAliasARN :: Lens' AliasListEntry (Maybe Text)

String that contains the key ARN.

GrantConstraints

data GrantConstraints

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 Encryption Context in the AWS Key Management Service Developer Guide.

See: grantConstraints smart constructor.

Instances

Eq GrantConstraints

Methods

(==) :: GrantConstraints -> GrantConstraints -> Bool

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

Data GrantConstraints

Methods

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

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

toConstr :: GrantConstraints -> Constr

dataTypeOf :: GrantConstraints -> DataType

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

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

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

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

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

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

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

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

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

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

Read GrantConstraints

Methods

readsPrec :: Int -> ReadS GrantConstraints

readList :: ReadS [GrantConstraints]

readPrec :: ReadPrec GrantConstraints

readListPrec :: ReadPrec [GrantConstraints]

Show GrantConstraints

Methods

showsPrec :: Int -> GrantConstraints -> ShowS

show :: GrantConstraints -> String

showList :: [GrantConstraints] -> ShowS

Generic GrantConstraints

Associated Types

type Rep GrantConstraints :: * -> *

Methods

from :: GrantConstraints -> Rep GrantConstraints x

to :: Rep GrantConstraints x -> GrantConstraints

Hashable GrantConstraints

Methods

hashWithSalt :: Int -> GrantConstraints -> Int

hash :: GrantConstraints -> Int

ToJSON GrantConstraints

Methods

toJSON :: GrantConstraints -> Value

toEncoding :: GrantConstraints -> Encoding

toJSONList :: [GrantConstraints] -> Value

toEncodingList :: [GrantConstraints] -> Encoding

FromJSON GrantConstraints

Methods

parseJSON :: Value -> Parser GrantConstraints

parseJSONList :: Value -> Parser [GrantConstraints]

NFData GrantConstraints

Methods

rnf :: GrantConstraints -> ()

type Rep GrantConstraints

type Rep GrantConstraints = D1 (MetaData "GrantConstraints" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "GrantConstraints'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gcEncryptionContextEquals") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_gcEncryptionContextSubset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))))

grantConstraints :: GrantConstraints

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

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

• gcEncryptionContextEquals
• gcEncryptionContextSubset

gcEncryptionContextEquals :: Lens' GrantConstraints (HashMap Text Text)

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 :: Lens' GrantConstraints (HashMap Text Text)

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.

GrantListEntry

data GrantListEntry

Contains information about an entry in a list of grants.

See: grantListEntry smart constructor.

Instances

Eq GrantListEntry

Methods

(==) :: GrantListEntry -> GrantListEntry -> Bool

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

Data GrantListEntry

Methods

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

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

toConstr :: GrantListEntry -> Constr

dataTypeOf :: GrantListEntry -> DataType

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

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

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

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

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

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

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

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

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

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

Read GrantListEntry

Methods

readsPrec :: Int -> ReadS GrantListEntry

readList :: ReadS [GrantListEntry]

readPrec :: ReadPrec GrantListEntry

readListPrec :: ReadPrec [GrantListEntry]

Show GrantListEntry

Methods

showsPrec :: Int -> GrantListEntry -> ShowS

show :: GrantListEntry -> String

showList :: [GrantListEntry] -> ShowS

Generic GrantListEntry

Associated Types

type Rep GrantListEntry :: * -> *

Methods

from :: GrantListEntry -> Rep GrantListEntry x

to :: Rep GrantListEntry x -> GrantListEntry

Hashable GrantListEntry

Methods

hashWithSalt :: Int -> GrantListEntry -> Int

hash :: GrantListEntry -> Int

FromJSON GrantListEntry

Methods

parseJSON :: Value -> Parser GrantListEntry

parseJSONList :: Value -> Parser [GrantListEntry]

NFData GrantListEntry

Methods

rnf :: GrantListEntry -> ()

type Rep GrantListEntry

type Rep GrantListEntry = D1 (MetaData "GrantListEntry" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "GrantListEntry'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gleKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gleRetiringPrincipal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gleIssuingAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gleGrantId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gleConstraints") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GrantConstraints))) (S1 (MetaSel (Just Symbol "_gleGranteePrincipal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gleName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gleCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_gleOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GrantOperation]))))))))

grantListEntry :: GrantListEntry

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

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

• gleKeyId
• gleRetiringPrincipal
• gleIssuingAccount
• gleGrantId
• gleConstraints
• gleGranteePrincipal
• gleName
• gleCreationDate
• gleOperations

gleKeyId :: Lens' GrantListEntry (Maybe Text)

The unique identifier for the customer master key (CMK) to which the grant applies.

gleRetiringPrincipal :: Lens' GrantListEntry (Maybe Text)

The principal that can retire the grant.

gleIssuingAccount :: Lens' GrantListEntry (Maybe Text)

The AWS account under which the grant was issued.

gleGrantId :: Lens' GrantListEntry (Maybe Text)

The unique identifier for the grant.

gleConstraints :: Lens' GrantListEntry (Maybe GrantConstraints)

The conditions under which the grant's operations are allowed.

gleGranteePrincipal :: Lens' GrantListEntry (Maybe Text)

The principal that receives the grant's permissions.

gleName :: Lens' GrantListEntry (Maybe Text)

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 :: Lens' GrantListEntry (Maybe UTCTime)

The date and time when the grant was created.

gleOperations :: Lens' GrantListEntry [GrantOperation]

The list of operations permitted by the grant.

KeyListEntry

data KeyListEntry

Contains information about each entry in the key list.

See: keyListEntry smart constructor.

Instances

Eq KeyListEntry

Methods

(==) :: KeyListEntry -> KeyListEntry -> Bool

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

Data KeyListEntry

Methods

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

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

toConstr :: KeyListEntry -> Constr

dataTypeOf :: KeyListEntry -> DataType

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

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

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

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

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

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

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

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

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

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

Read KeyListEntry

Methods

readsPrec :: Int -> ReadS KeyListEntry

readList :: ReadS [KeyListEntry]

readPrec :: ReadPrec KeyListEntry

readListPrec :: ReadPrec [KeyListEntry]

Show KeyListEntry

Methods

showsPrec :: Int -> KeyListEntry -> ShowS

show :: KeyListEntry -> String

showList :: [KeyListEntry] -> ShowS

Generic KeyListEntry

Associated Types

type Rep KeyListEntry :: * -> *

Methods

from :: KeyListEntry -> Rep KeyListEntry x

to :: Rep KeyListEntry x -> KeyListEntry

Hashable KeyListEntry

Methods

hashWithSalt :: Int -> KeyListEntry -> Int

hash :: KeyListEntry -> Int

FromJSON KeyListEntry

Methods

parseJSON :: Value -> Parser KeyListEntry

parseJSONList :: Value -> Parser [KeyListEntry]

NFData KeyListEntry

Methods

rnf :: KeyListEntry -> ()

type Rep KeyListEntry

type Rep KeyListEntry = D1 (MetaData "KeyListEntry" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "KeyListEntry'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_kleKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_kleKeyARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

keyListEntry :: KeyListEntry

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

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

• kleKeyId
• kleKeyARN

kleKeyId :: Lens' KeyListEntry (Maybe Text)

Unique identifier of the key.

kleKeyARN :: Lens' KeyListEntry (Maybe Text)

ARN of the key.

KeyMetadata

data KeyMetadata

Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

See: keyMetadata smart constructor.

Instances

Eq KeyMetadata

Methods

(==) :: KeyMetadata -> KeyMetadata -> Bool

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

Data KeyMetadata

Methods

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

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

toConstr :: KeyMetadata -> Constr

dataTypeOf :: KeyMetadata -> DataType

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

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

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

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

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

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

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

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

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

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

Read KeyMetadata

Methods

readsPrec :: Int -> ReadS KeyMetadata

readList :: ReadS [KeyMetadata]

readPrec :: ReadPrec KeyMetadata

readListPrec :: ReadPrec [KeyMetadata]

Show KeyMetadata

Methods

showsPrec :: Int -> KeyMetadata -> ShowS

show :: KeyMetadata -> String

showList :: [KeyMetadata] -> ShowS

Generic KeyMetadata

Associated Types

type Rep KeyMetadata :: * -> *

Methods

from :: KeyMetadata -> Rep KeyMetadata x

to :: Rep KeyMetadata x -> KeyMetadata

Hashable KeyMetadata

Methods

hashWithSalt :: Int -> KeyMetadata -> Int

hash :: KeyMetadata -> Int

FromJSON KeyMetadata

Methods

parseJSON :: Value -> Parser KeyMetadata

parseJSONList :: Value -> Parser [KeyMetadata]

NFData KeyMetadata

Methods

rnf :: KeyMetadata -> ()

type Rep KeyMetadata

type Rep KeyMetadata = D1 (MetaData "KeyMetadata" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "KeyMetadata'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_kmEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_kmARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_kmKeyState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KeyState))) (S1 (MetaSel (Just Symbol "_kmAWSAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_kmKeyUsage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KeyUsageType))) (S1 (MetaSel (Just Symbol "_kmCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_kmDeletionDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_kmDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_kmKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

keyMetadata

Arguments

:: Text

kmKeyId

-> KeyMetadata

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

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

• kmEnabled
• kmARN
• kmKeyState
• kmAWSAccountId
• kmKeyUsage
• kmCreationDate
• kmDeletionDate
• kmDescription
• kmKeyId

kmEnabled :: Lens' KeyMetadata (Maybe Bool)

Specifies whether the key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

kmARN :: Lens' KeyMetadata (Maybe Text)

The Amazon Resource Name (ARN) of the key. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

kmKeyState :: Lens' KeyMetadata (Maybe KeyState)

The state of the customer master key (CMK).

For more information about how key state affects the use of a CMK, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

kmAWSAccountId :: Lens' KeyMetadata (Maybe Text)

The twelve-digit account ID of the AWS account that owns the key.

kmKeyUsage :: Lens' KeyMetadata (Maybe KeyUsageType)

The cryptographic operations for which you can use the key. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the key for the Encrypt and Decrypt operations.

kmCreationDate :: Lens' KeyMetadata (Maybe UTCTime)

The date and time when the key was created.

kmDeletionDate :: Lens' KeyMetadata (Maybe UTCTime)

The date and time after which AWS KMS deletes the customer master key (CMK). This value is present only when KeyState is PendingDeletion, otherwise this value is null.

kmDescription :: Lens' KeyMetadata (Maybe Text)

The friendly description of the key.

kmKeyId :: Lens' KeyMetadata Text

The globally unique identifier for the key.

ListGrantsResponse

data ListGrantsResponse

See: listGrantsResponse smart constructor.

Instances

Eq ListGrantsResponse

Methods

(==) :: ListGrantsResponse -> ListGrantsResponse -> Bool

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

Data ListGrantsResponse

Methods

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

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

toConstr :: ListGrantsResponse -> Constr

dataTypeOf :: ListGrantsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListGrantsResponse

Methods

readsPrec :: Int -> ReadS ListGrantsResponse

readList :: ReadS [ListGrantsResponse]

readPrec :: ReadPrec ListGrantsResponse

readListPrec :: ReadPrec [ListGrantsResponse]

Show ListGrantsResponse

Methods

showsPrec :: Int -> ListGrantsResponse -> ShowS

show :: ListGrantsResponse -> String

showList :: [ListGrantsResponse] -> ShowS

Generic ListGrantsResponse

Associated Types

type Rep ListGrantsResponse :: * -> *

Methods

from :: ListGrantsResponse -> Rep ListGrantsResponse x

to :: Rep ListGrantsResponse x -> ListGrantsResponse

Hashable ListGrantsResponse

Methods

hashWithSalt :: Int -> ListGrantsResponse -> Int

hash :: ListGrantsResponse -> Int

FromJSON ListGrantsResponse

Methods

parseJSON :: Value -> Parser ListGrantsResponse

parseJSONList :: Value -> Parser [ListGrantsResponse]

NFData ListGrantsResponse

Methods

rnf :: ListGrantsResponse -> ()

type Rep ListGrantsResponse

type Rep ListGrantsResponse = D1 (MetaData "ListGrantsResponse" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "ListGrantsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lgTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_lgGrants") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GrantListEntry]))) (S1 (MetaSel (Just Symbol "_lgNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

listGrantsResponse :: ListGrantsResponse

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

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

• lgTruncated
• lgGrants
• lgNextMarker

lgTruncated :: Lens' ListGrantsResponse (Maybe Bool)

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 :: Lens' ListGrantsResponse [GrantListEntry]

A list of grants.

lgNextMarker :: Lens' ListGrantsResponse (Maybe Text)

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.