amazonka-kms-1.0.0: Amazon Key Management Service SDK.

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

Network.AWS.KMS.Types

Contents

Description

 

Synopsis

Service

data KMS Source

Version 2014-11-01 of the Amazon Key Management Service SDK.

Instances

AWSService KMS 
type Sg KMS = V4 

Errors

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

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

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

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

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

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

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

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

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

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

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

The request was rejected because the key was disabled, not found, or otherwise not available.

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

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

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

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

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

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

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

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

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

The system timed out while trying to fulfill the request.

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

A grant token provided as part of the request is invalid.

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

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

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

The request was rejected because a quota was exceeded.

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

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

DataKeySpec

data DataKeySpec Source

Constructors

AES128 
AES256 

Instances

GrantOperation

data GrantOperation Source

Constructors

CreateGrant 
Decrypt 
Encrypt 
GenerateDataKey 
GenerateDataKeyWithoutPlaintext 
ReEncryptFrom 
ReEncryptTo 
RetireGrant 

Instances

KeyUsageType

data KeyUsageType Source

Constructors

EncryptDecrypt 

Instances

AliasListEntry

data AliasListEntry Source

Contains information about an alias.

See: aliasListEntry smart constructor.

Instances

aliasListEntry :: AliasListEntry Source

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 :: Lens' AliasListEntry (Maybe Text) Source

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

aleAliasName :: Lens' AliasListEntry (Maybe Text) Source

String that contains the alias.

aleAliasARN :: Lens' AliasListEntry (Maybe Text) Source

String that contains the key ARN.

GrantConstraints

data GrantConstraints Source

Contains constraints on the grant.

See: grantConstraints smart constructor.

Instances

grantConstraints :: GrantConstraints Source

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

The constraint contains additional key/value pairs that serve to further limit the grant.

gcEncryptionContextSubset :: Lens' GrantConstraints (HashMap Text Text) Source

The constraint equals the full encryption context.

GrantListEntry

data GrantListEntry Source

Contains information about each entry in the grant list.

See: grantListEntry smart constructor.

Instances

grantListEntry :: GrantListEntry Source

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:

gleRetiringPrincipal :: Lens' GrantListEntry (Maybe Text) Source

The principal that can retire the account.

gleIssuingAccount :: Lens' GrantListEntry (Maybe Text) Source

The account under which the grant was issued.

gleGrantId :: Lens' GrantListEntry (Maybe Text) Source

Unique grant identifier.

gleConstraints :: Lens' GrantListEntry (Maybe GrantConstraints) Source

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

gleGranteePrincipal :: Lens' GrantListEntry (Maybe Text) Source

The principal that receives the grant permission.

gleOperations :: Lens' GrantListEntry [GrantOperation] Source

List of operations permitted by the grant. This can be any combination of one or more of the following values:

  1. Decrypt
  2. Encrypt
  3. GenerateDataKey
  4. GenerateDataKeyWithoutPlaintext
  5. ReEncryptFrom
  6. ReEncryptTo
  7. CreateGrant

KeyListEntry

data KeyListEntry Source

Contains information about each entry in the key list.

See: keyListEntry smart constructor.

Instances

keyListEntry :: KeyListEntry Source

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:

kleKeyARN :: Lens' KeyListEntry (Maybe Text) Source

ARN of the key.

kleKeyId :: Lens' KeyListEntry (Maybe Text) Source

Unique identifier of the key.

KeyMetadata

data KeyMetadata Source

Contains metadata associated with a specific key.

See: keyMetadata smart constructor.

Instances

keyMetadata Source

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:

kmARN :: Lens' KeyMetadata (Maybe Text) Source

Key ARN (Amazon Resource Name).

kmEnabled :: Lens' KeyMetadata (Maybe Bool) Source

Value that specifies whether the key is enabled.

kmAWSAccountId :: Lens' KeyMetadata (Maybe Text) Source

Account ID number.

kmKeyUsage :: Lens' KeyMetadata (Maybe KeyUsageType) Source

A value that specifies what operation(s) the key can perform.

kmCreationDate :: Lens' KeyMetadata (Maybe UTCTime) Source

Date the key was created.

kmDescription :: Lens' KeyMetadata (Maybe Text) Source

The description of the key.

kmKeyId :: Lens' KeyMetadata Text Source

Unique identifier for the key.