Amazonka.KMS

Derived from API version 2014-11-01 of the AWS service descriptions, licensed under Apache 2.0.

Key Management Service

Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services 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 Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

If you need to use FIPS 140-2 validated cryptographic modules when communicating with Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the available FIPS endpoints, see Service endpoints in the Key Management Service topic of the /Amazon Web Services General Reference/.

All KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). KMS recommends you always use the latest supported TLS version. 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 Amazon Web Services account (root) access key ID and secret access key for everyday work with KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary security credentials that you can use to sign requests.

All KMS operations require Signature Version 4.

Logging API Requests

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services 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 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 CloudTrail User Guide.

Additional Resources

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

• Amazon Web Services Security Credentials
• This topic provides general information about the types of credentials used to access Amazon Web Services.
• Temporary Security Credentials
• This section of the IAM User Guide describes how to create and use temporary security credentials.
• 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 API Operations

Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.

• Encrypt
• Decrypt
• GenerateDataKey
• GenerateDataKeyWithoutPlaintext

Service Configuration

defaultService :: 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.

AlreadyExistsException

_AlreadyExistsException :: AsError a => Fold a ServiceError

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

CloudHsmClusterInUseException

_CloudHsmClusterInUseException :: AsError a => Fold a ServiceError

The request was rejected because the specified CloudHSM cluster is already associated with an CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the account. Each CloudHSM key store in the account must be associated with a different CloudHSM cluster.

CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.

CloudHsmClusterInvalidConfigurationException

_CloudHsmClusterInvalidConfigurationException :: AsError a => Fold a ServiceError

The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.

• The CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region.
• The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.

• The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM CreateHsm operation.

  For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the CloudHSM must contain at least one active HSM.

For information about the requirements for an CloudHSM cluster that is associated with an CloudHSM key store, see Assemble the Prerequisites in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, see Create a Private Subnet in the CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the /CloudHSM User Guide/ .

CloudHsmClusterNotActiveException

_CloudHsmClusterNotActiveException :: AsError a => Fold a ServiceError

The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the CloudHSM User Guide.

CloudHsmClusterNotFoundException

_CloudHsmClusterNotFoundException :: AsError a => Fold a ServiceError

The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.

CloudHsmClusterNotRelatedException

_CloudHsmClusterNotRelatedException :: AsError a => Fold a ServiceError

The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster for an CloudHSM key store.

Specify an CloudHSM cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.

CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.

CustomKeyStoreHasCMKsException

_CustomKeyStoreHasCMKsException :: AsError a => Fold a ServiceError

The request was rejected because the custom key store contains KMS keys. After verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletion operation to delete the KMS keys. After they are deleted, you can delete the custom key store.

CustomKeyStoreInvalidStateException

_CustomKeyStoreInvalidStateException :: AsError a => Fold a ServiceError

The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.

This exception is thrown under the following conditions:

• You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values. To reconnect a custom key store in a FAILED state, disconnect it (DisconnectCustomKeyStore), then connect it (ConnectCustomKeyStore).
• You requested the CreateKey operation in a custom key store that is not connected. This operations is valid only when the custom key store ConnectionState is CONNECTED.
• You requested the DisconnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or DISCONNECTED. This operation is valid for all other ConnectionState values.
• You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.
• You requested the GenerateRandom operation in an CloudHSM key store that is not connected. This operation is valid only when the CloudHSM key store ConnectionState is CONNECTED.

CustomKeyStoreNameInUseException

_CustomKeyStoreNameInUseException :: AsError a => Fold a ServiceError

The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.

CustomKeyStoreNotFoundException

_CustomKeyStoreNotFoundException :: AsError a => Fold a ServiceError

The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.

DependencyTimeoutException

_DependencyTimeoutException :: AsError a => Fold a ServiceError

The system timed out while trying to fulfill the request. You can retry the request.

DisabledException

_DisabledException :: AsError a => Fold a ServiceError

The request was rejected because the specified KMS key is not enabled.

ExpiredImportTokenException

_ExpiredImportTokenException :: AsError a => Fold a ServiceError

The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.

IncorrectKeyException

_IncorrectKeyException :: AsError a => Fold a ServiceError

The request was rejected because the specified KMS key cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same KMS key that was used to encrypt the ciphertext.

IncorrectKeyMaterialException

_IncorrectKeyMaterialException :: AsError a => Fold a ServiceError

The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this KMS key.

IncorrectTrustAnchorException

_IncorrectTrustAnchorException :: AsError a => Fold a ServiceError

The request was rejected because the trust anchor certificate in the request to create an CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.

When you initialize the CloudHSM cluster, you create the trust anchor certificate and save it in the customerCA.crt file.

InvalidAliasNameException

_InvalidAliasNameException :: AsError a => Fold a ServiceError

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

InvalidArnException

_InvalidArnException :: AsError a => Fold a ServiceError

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

InvalidCiphertextException

_InvalidCiphertextException :: AsError a => Fold a ServiceError

From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.

From the ImportKeyMaterial operation, the request was rejected because KMS could not decrypt the encrypted (wrapped) key material.

InvalidGrantIdException

_InvalidGrantIdException :: AsError a => Fold a ServiceError

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

InvalidGrantTokenException

_InvalidGrantTokenException :: AsError a => Fold a ServiceError

The request was rejected because the specified grant token is not valid.

InvalidImportTokenException

_InvalidImportTokenException :: AsError a => Fold a ServiceError

The request was rejected because the provided import token is invalid or is associated with a different KMS key.

InvalidKeyUsageException

_InvalidKeyUsageException :: AsError a => Fold a ServiceError

The request was rejected for one of the following reasons:

• The KeyUsage value of the KMS key is incompatible with the API operation.
• The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying messages, the KeyUsage must be SIGN_VERIFY. For generating and verifying message authentication codes (MACs), the KeyUsage must be GENERATE_VERIFY_MAC. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.

InvalidMarkerException

_InvalidMarkerException :: AsError a => Fold a ServiceError

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

KMSInternalException

_KMSInternalException :: AsError a => Fold a ServiceError

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

KMSInvalidMacException

_KMSInvalidMacException :: AsError a => Fold a ServiceError

The request was rejected because the HMAC verification failed. HMAC verification fails when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does not match the HMAC specified in the request.

KMSInvalidSignatureException

_KMSInvalidSignatureException :: AsError a => Fold a ServiceError

The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified KMS key and signing algorithm.

KMSInvalidStateException

_KMSInvalidStateException :: AsError a => Fold a ServiceError

The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:

• The key state of the KMS key is not compatible with the operation.

  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the /Key Management Service Developer Guide/ .

• For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

KeyUnavailableException

_KeyUnavailableException :: AsError a => Fold a ServiceError

The request was rejected because the specified KMS key was not available. You can retry the request.

LimitExceededException

_LimitExceededException :: AsError a => Fold a ServiceError

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

MalformedPolicyDocumentException

_MalformedPolicyDocumentException :: AsError a => Fold a ServiceError

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

NotFoundException

_NotFoundException :: AsError a => Fold a ServiceError

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

TagException

_TagException :: AsError a => Fold a ServiceError

The request was rejected because one or more tags are not valid.

UnsupportedOperationException

_UnsupportedOperationException :: AsError a => Fold a ServiceError

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

XksKeyAlreadyInUseException

_XksKeyAlreadyInUseException :: AsError a => Fold a ServiceError

The request was rejected because the (XksKeyId) is already associated with a KMS key in this external key store. Each KMS key in an external key store must be associated with a different external key.

XksKeyInvalidConfigurationException

_XksKeyInvalidConfigurationException :: AsError a => Fold a ServiceError

The request was rejected because the external key specified by the XksKeyId parameter did not meet the configuration requirements for an external key store.

The external key must be an AES-256 symmetric key that is enabled and performs encryption and decryption.

XksKeyNotFoundException

_XksKeyNotFoundException :: AsError a => Fold a ServiceError

The request was rejected because the external key store proxy could not find the external key. This exception is thrown when the value of the XksKeyId parameter doesn't identify a key in the external key manager associated with the external key proxy.

Verify that the XksKeyId represents an existing key in the external key manager. Use the key identifier that the external key store proxy uses to identify the key. For details, see the documentation provided with your external key store proxy or key manager.

XksProxyIncorrectAuthenticationCredentialException

_XksProxyIncorrectAuthenticationCredentialException :: AsError a => Fold a ServiceError

The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy. The specified external key store proxy rejected a status request from KMS due to invalid credentials. This can indicate an error in the credentials or in the identification of the external key store proxy.

XksProxyInvalidConfigurationException

_XksProxyInvalidConfigurationException :: AsError a => Fold a ServiceError

The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store proxy. For details, see the exception message.

XksProxyInvalidResponseException

_XksProxyInvalidResponseException :: AsError a => Fold a ServiceError

KMS cannot interpret the response it received from the external key store proxy. The problem might be a poorly constructed response, but it could also be a transient network issue. If you see this error repeatedly, report it to the proxy vendor.

XksProxyUriEndpointInUseException

_XksProxyUriEndpointInUseException :: AsError a => Fold a ServiceError

The request was rejected because the concatenation of the XksProxyUriEndpoint is already associated with an external key store in the Amazon Web Services account and Region. Each external key store in an account and Region must use a unique external key store proxy address.

XksProxyUriInUseException

_XksProxyUriInUseException :: AsError a => Fold a ServiceError

The request was rejected because the concatenation of the XksProxyUriEndpoint and XksProxyUriPath is already associated with an external key store in the Amazon Web Services account and Region. Each external key store in an account and Region must use a unique external key store proxy API address.

XksProxyUriUnreachableException

_XksProxyUriUnreachableException :: AsError a => Fold a ServiceError

KMS was unable to reach the specified XksProxyUriPath. The path must be reachable before you create the external key store or update its settings.

This exception is also thrown when the external key store proxy response to a GetHealthStatus request indicates that all external key manager instances are unavailable.

XksProxyVpcEndpointServiceInUseException

_XksProxyVpcEndpointServiceInUseException :: AsError a => Fold a ServiceError

The request was rejected because the specified Amazon VPC endpoint service is already associated with an external key store in the Amazon Web Services account and Region. Each external key store in an Amazon Web Services account and Region must use a different Amazon VPC endpoint service.

XksProxyVpcEndpointServiceInvalidConfigurationException

_XksProxyVpcEndpointServiceInvalidConfigurationException :: AsError a => Fold a ServiceError

The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store proxy. For details, see the exception message and review the requirements for Amazon VPC endpoint service connectivity for an external key store.

XksProxyVpcEndpointServiceNotFoundException

_XksProxyVpcEndpointServiceNotFoundException :: AsError a => Fold a ServiceError

The request was rejected because KMS could not find the specified VPC endpoint service. Use DescribeCustomKeyStores to verify the VPC endpoint service name for the external key store. Also, confirm that the Allow principals list for the VPC endpoint service includes the KMS service principal for the Region, such as cks.kms.us-east-1.amazonaws.com.

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.

CancelKeyDeletion

data CancelKeyDeletion

See: newCancelKeyDeletion smart constructor.

Constructors

CancelKeyDeletion' Text

Instances

ToJSON CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toJSON :: CancelKeyDeletion -> Value

toEncoding :: CancelKeyDeletion -> Encoding

toJSONList :: [CancelKeyDeletion] -> Value

toEncodingList :: [CancelKeyDeletion] -> Encoding

ToHeaders CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toHeaders :: CancelKeyDeletion -> [Header]

ToPath CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toPath :: CancelKeyDeletion -> ByteString

ToQuery CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

toQuery :: CancelKeyDeletion -> QueryString

AWSRequest CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Associated Types

type AWSResponse CancelKeyDeletion

Methods

request :: (Service -> Service) -> CancelKeyDeletion -> Request CancelKeyDeletion

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelKeyDeletion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelKeyDeletion)))

Generic CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Associated Types

type Rep CancelKeyDeletion :: Type -> Type

Methods

from :: CancelKeyDeletion -> Rep CancelKeyDeletion x

to :: Rep CancelKeyDeletion x -> CancelKeyDeletion

Read CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

readsPrec :: Int -> ReadS CancelKeyDeletion

readList :: ReadS [CancelKeyDeletion]

readPrec :: ReadPrec CancelKeyDeletion

readListPrec :: ReadPrec [CancelKeyDeletion]

Show CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

showsPrec :: Int -> CancelKeyDeletion -> ShowS

show :: CancelKeyDeletion -> String

showList :: [CancelKeyDeletion] -> ShowS

NFData CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

rnf :: CancelKeyDeletion -> ()

Eq CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

(==) :: CancelKeyDeletion -> CancelKeyDeletion -> Bool

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

Hashable CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

hashWithSalt :: Int -> CancelKeyDeletion -> Int

hash :: CancelKeyDeletion -> Int

type AWSResponse CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

type AWSResponse CancelKeyDeletion = CancelKeyDeletionResponse

type Rep CancelKeyDeletion

Defined in Amazonka.KMS.CancelKeyDeletion

type Rep CancelKeyDeletion = D1 ('MetaData "CancelKeyDeletion" "Amazonka.KMS.CancelKeyDeletion" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CancelKeyDeletion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelKeyDeletion

Arguments

:: Text

CancelKeyDeletion

-> CancelKeyDeletion

Create a value of CancelKeyDeletion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelKeyDeletion, cancelKeyDeletion_keyId - Identifies the KMS key whose deletion is being canceled.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data CancelKeyDeletionResponse

See: newCancelKeyDeletionResponse smart constructor.

Constructors

CancelKeyDeletionResponse' (Maybe Text) Int

Instances

Generic CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Associated Types

type Rep CancelKeyDeletionResponse :: Type -> Type

Methods

from :: CancelKeyDeletionResponse -> Rep CancelKeyDeletionResponse x

to :: Rep CancelKeyDeletionResponse x -> CancelKeyDeletionResponse

Read CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

readsPrec :: Int -> ReadS CancelKeyDeletionResponse

readList :: ReadS [CancelKeyDeletionResponse]

readPrec :: ReadPrec CancelKeyDeletionResponse

readListPrec :: ReadPrec [CancelKeyDeletionResponse]

Show CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

showsPrec :: Int -> CancelKeyDeletionResponse -> ShowS

show :: CancelKeyDeletionResponse -> String

showList :: [CancelKeyDeletionResponse] -> ShowS

NFData CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

rnf :: CancelKeyDeletionResponse -> ()

Eq CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

Methods

(==) :: CancelKeyDeletionResponse -> CancelKeyDeletionResponse -> Bool

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

type Rep CancelKeyDeletionResponse

Defined in Amazonka.KMS.CancelKeyDeletion

type Rep CancelKeyDeletionResponse = D1 ('MetaData "CancelKeyDeletionResponse" "Amazonka.KMS.CancelKeyDeletion" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CancelKeyDeletionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelKeyDeletionResponse

Arguments

:: Int

$sel:httpStatus:CancelKeyDeletionResponse'

-> CancelKeyDeletionResponse

Create a value of CancelKeyDeletionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelKeyDeletion, cancelKeyDeletionResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.

$sel:httpStatus:CancelKeyDeletionResponse', cancelKeyDeletionResponse_httpStatus - The response's http status code.

ConnectCustomKeyStore

data ConnectCustomKeyStore

See: newConnectCustomKeyStore smart constructor.

Constructors

ConnectCustomKeyStore' Text

Instances

ToJSON ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

toJSON :: ConnectCustomKeyStore -> Value

toEncoding :: ConnectCustomKeyStore -> Encoding

toJSONList :: [ConnectCustomKeyStore] -> Value

toEncodingList :: [ConnectCustomKeyStore] -> Encoding

ToHeaders ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

toHeaders :: ConnectCustomKeyStore -> [Header]

ToPath ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

toPath :: ConnectCustomKeyStore -> ByteString

ToQuery ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

toQuery :: ConnectCustomKeyStore -> QueryString

AWSRequest ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Associated Types

type AWSResponse ConnectCustomKeyStore

Methods

request :: (Service -> Service) -> ConnectCustomKeyStore -> Request ConnectCustomKeyStore

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ConnectCustomKeyStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ConnectCustomKeyStore)))

Generic ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Associated Types

type Rep ConnectCustomKeyStore :: Type -> Type

Methods

from :: ConnectCustomKeyStore -> Rep ConnectCustomKeyStore x

to :: Rep ConnectCustomKeyStore x -> ConnectCustomKeyStore

Read ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

readsPrec :: Int -> ReadS ConnectCustomKeyStore

readList :: ReadS [ConnectCustomKeyStore]

readPrec :: ReadPrec ConnectCustomKeyStore

readListPrec :: ReadPrec [ConnectCustomKeyStore]

Show ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

showsPrec :: Int -> ConnectCustomKeyStore -> ShowS

show :: ConnectCustomKeyStore -> String

showList :: [ConnectCustomKeyStore] -> ShowS

NFData ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

rnf :: ConnectCustomKeyStore -> ()

Eq ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

(==) :: ConnectCustomKeyStore -> ConnectCustomKeyStore -> Bool

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

Hashable ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

hashWithSalt :: Int -> ConnectCustomKeyStore -> Int

hash :: ConnectCustomKeyStore -> Int

type AWSResponse ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

type AWSResponse ConnectCustomKeyStore = ConnectCustomKeyStoreResponse

type Rep ConnectCustomKeyStore

Defined in Amazonka.KMS.ConnectCustomKeyStore

type Rep ConnectCustomKeyStore = D1 ('MetaData "ConnectCustomKeyStore" "Amazonka.KMS.ConnectCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ConnectCustomKeyStore'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newConnectCustomKeyStore

Arguments

:: Text

ConnectCustomKeyStore

-> ConnectCustomKeyStore

Create a value of ConnectCustomKeyStore with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ConnectCustomKeyStore, connectCustomKeyStore_customKeyStoreId - Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

data ConnectCustomKeyStoreResponse

See: newConnectCustomKeyStoreResponse smart constructor.

Constructors

ConnectCustomKeyStoreResponse' Int

Instances

Generic ConnectCustomKeyStoreResponse

Defined in Amazonka.KMS.ConnectCustomKeyStore

Associated Types

type Rep ConnectCustomKeyStoreResponse :: Type -> Type

Methods

from :: ConnectCustomKeyStoreResponse -> Rep ConnectCustomKeyStoreResponse x

to :: Rep ConnectCustomKeyStoreResponse x -> ConnectCustomKeyStoreResponse

Read ConnectCustomKeyStoreResponse

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

readsPrec :: Int -> ReadS ConnectCustomKeyStoreResponse

readList :: ReadS [ConnectCustomKeyStoreResponse]

readPrec :: ReadPrec ConnectCustomKeyStoreResponse

readListPrec :: ReadPrec [ConnectCustomKeyStoreResponse]

Show ConnectCustomKeyStoreResponse

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

showsPrec :: Int -> ConnectCustomKeyStoreResponse -> ShowS

show :: ConnectCustomKeyStoreResponse -> String

showList :: [ConnectCustomKeyStoreResponse] -> ShowS

NFData ConnectCustomKeyStoreResponse

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

rnf :: ConnectCustomKeyStoreResponse -> ()

Eq ConnectCustomKeyStoreResponse

Defined in Amazonka.KMS.ConnectCustomKeyStore

Methods

(==) :: ConnectCustomKeyStoreResponse -> ConnectCustomKeyStoreResponse -> Bool

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

type Rep ConnectCustomKeyStoreResponse

Defined in Amazonka.KMS.ConnectCustomKeyStore

type Rep ConnectCustomKeyStoreResponse = D1 ('MetaData "ConnectCustomKeyStoreResponse" "Amazonka.KMS.ConnectCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ConnectCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newConnectCustomKeyStoreResponse

Arguments

:: Int

$sel:httpStatus:ConnectCustomKeyStoreResponse'

-> ConnectCustomKeyStoreResponse

Create a value of ConnectCustomKeyStoreResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ConnectCustomKeyStoreResponse', connectCustomKeyStoreResponse_httpStatus - The response's http status code.

CreateAlias

data CreateAlias

See: newCreateAlias smart constructor.

Constructors

CreateAlias' Text Text

Instances

ToJSON CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

toJSON :: CreateAlias -> Value

toEncoding :: CreateAlias -> Encoding

toJSONList :: [CreateAlias] -> Value

toEncodingList :: [CreateAlias] -> Encoding

ToHeaders CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

toHeaders :: CreateAlias -> [Header]

ToPath CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

toPath :: CreateAlias -> ByteString

ToQuery CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

toQuery :: CreateAlias -> QueryString

AWSRequest CreateAlias

Defined in Amazonka.KMS.CreateAlias

Associated Types

type AWSResponse CreateAlias

Methods

request :: (Service -> Service) -> CreateAlias -> Request CreateAlias

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAlias)))

Generic CreateAlias

Defined in Amazonka.KMS.CreateAlias

Associated Types

type Rep CreateAlias :: Type -> Type

Methods

from :: CreateAlias -> Rep CreateAlias x

to :: Rep CreateAlias x -> CreateAlias

Read CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAlias

readList :: ReadS [CreateAlias]

readPrec :: ReadPrec CreateAlias

readListPrec :: ReadPrec [CreateAlias]

Show CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

showsPrec :: Int -> CreateAlias -> ShowS

show :: CreateAlias -> String

showList :: [CreateAlias] -> ShowS

NFData CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

rnf :: CreateAlias -> ()

Eq CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

(==) :: CreateAlias -> CreateAlias -> Bool

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

Hashable CreateAlias

Defined in Amazonka.KMS.CreateAlias

Methods

hashWithSalt :: Int -> CreateAlias -> Int

hash :: CreateAlias -> Int

type AWSResponse CreateAlias

Defined in Amazonka.KMS.CreateAlias

type AWSResponse CreateAlias = CreateAliasResponse

type Rep CreateAlias

Defined in Amazonka.KMS.CreateAlias

type Rep CreateAlias = D1 ('MetaData "CreateAlias" "Amazonka.KMS.CreateAlias" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAlias

Arguments

:: Text

CreateAlias

-> Text

CreateAlias

-> CreateAlias

Create a value of CreateAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAlias, createAlias_aliasName - Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

CreateAlias, createAlias_targetKeyId - Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the /Key Management Service Developer Guide/ .

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data CreateAliasResponse

See: newCreateAliasResponse smart constructor.

Constructors

CreateAliasResponse'

Instances

Generic CreateAliasResponse

Defined in Amazonka.KMS.CreateAlias

Associated Types

type Rep CreateAliasResponse :: Type -> Type

Methods

from :: CreateAliasResponse -> Rep CreateAliasResponse x

to :: Rep CreateAliasResponse x -> CreateAliasResponse

Read CreateAliasResponse

Defined in Amazonka.KMS.CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAliasResponse

readList :: ReadS [CreateAliasResponse]

readPrec :: ReadPrec CreateAliasResponse

readListPrec :: ReadPrec [CreateAliasResponse]

Show CreateAliasResponse

Defined in Amazonka.KMS.CreateAlias

Methods

showsPrec :: Int -> CreateAliasResponse -> ShowS

show :: CreateAliasResponse -> String

showList :: [CreateAliasResponse] -> ShowS

NFData CreateAliasResponse

Defined in Amazonka.KMS.CreateAlias

Methods

rnf :: CreateAliasResponse -> ()

Eq CreateAliasResponse

Defined in Amazonka.KMS.CreateAlias

Methods

(==) :: CreateAliasResponse -> CreateAliasResponse -> Bool

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

type Rep CreateAliasResponse

Defined in Amazonka.KMS.CreateAlias

type Rep CreateAliasResponse = D1 ('MetaData "CreateAliasResponse" "Amazonka.KMS.CreateAlias" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateAliasResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCreateAliasResponse :: CreateAliasResponse

Create a value of CreateAliasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

CreateCustomKeyStore

data CreateCustomKeyStore

See: newCreateCustomKeyStore smart constructor.

Constructors

CreateCustomKeyStore' (Maybe Text) (Maybe CustomKeyStoreType) (Maybe (Sensitive Text)) (Maybe Text) (Maybe XksProxyAuthenticationCredentialType) (Maybe XksProxyConnectivityType) (Maybe Text) (Maybe Text) (Maybe Text) Text

Instances

ToJSON CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

toJSON :: CreateCustomKeyStore -> Value

toEncoding :: CreateCustomKeyStore -> Encoding

toJSONList :: [CreateCustomKeyStore] -> Value

toEncodingList :: [CreateCustomKeyStore] -> Encoding

ToHeaders CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

toHeaders :: CreateCustomKeyStore -> [Header]

ToPath CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

toPath :: CreateCustomKeyStore -> ByteString

ToQuery CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

toQuery :: CreateCustomKeyStore -> QueryString

AWSRequest CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Associated Types

type AWSResponse CreateCustomKeyStore

Methods

request :: (Service -> Service) -> CreateCustomKeyStore -> Request CreateCustomKeyStore

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCustomKeyStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCustomKeyStore)))

Generic CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Associated Types

type Rep CreateCustomKeyStore :: Type -> Type

Methods

from :: CreateCustomKeyStore -> Rep CreateCustomKeyStore x

to :: Rep CreateCustomKeyStore x -> CreateCustomKeyStore

Show CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

showsPrec :: Int -> CreateCustomKeyStore -> ShowS

show :: CreateCustomKeyStore -> String

showList :: [CreateCustomKeyStore] -> ShowS

NFData CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

rnf :: CreateCustomKeyStore -> ()

Eq CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

(==) :: CreateCustomKeyStore -> CreateCustomKeyStore -> Bool

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

Hashable CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

hashWithSalt :: Int -> CreateCustomKeyStore -> Int

hash :: CreateCustomKeyStore -> Int

type AWSResponse CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

type AWSResponse CreateCustomKeyStore = CreateCustomKeyStoreResponse

type Rep CreateCustomKeyStore

Defined in Amazonka.KMS.CreateCustomKeyStore

type Rep CreateCustomKeyStore = D1 ('MetaData "CreateCustomKeyStore" "Amazonka.KMS.CreateCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateCustomKeyStore'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudHsmClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomKeyStoreType))) :*: (S1 ('MetaSel ('Just "keyStorePassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "trustAnchorCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "xksProxyAuthenticationCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyAuthenticationCredentialType))))) :*: ((S1 ('MetaSel ('Just "xksProxyConnectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyConnectivityType)) :*: S1 ('MetaSel ('Just "xksProxyUriEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "xksProxyUriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "xksProxyVpcEndpointServiceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateCustomKeyStore

Arguments

:: Text

CreateCustomKeyStore

-> CreateCustomKeyStore

Create a value of CreateCustomKeyStore with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCustomKeyStore, createCustomKeyStore_cloudHsmClusterId - Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM.

Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

CreateCustomKeyStore, createCustomKeyStore_customKeyStoreType - Specifies the type of custom key store. The default value is AWS_CLOUDHSM.

For a custom key store backed by an CloudHSM cluster, omit the parameter or enter AWS_CLOUDHSM. For a custom key store backed by an external key manager outside of Amazon Web Services, enter EXTERNAL_KEY_STORE. You cannot change this property after the key store is created.

$sel:keyStorePassword:CreateCustomKeyStore', createCustomKeyStore_keyStorePassword - Specifies the kmsuser password for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells KMS the kmsuser account password; it does not change the password in the CloudHSM cluster.

CreateCustomKeyStore, createCustomKeyStore_trustAnchorCertificate - Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

$sel:xksProxyAuthenticationCredential:CreateCustomKeyStore', createCustomKeyStore_xksProxyAuthenticationCredential - Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is required for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The XksProxyAuthenticationCredential has two required elements: RawSecretAccessKey, a secret key, and AccessKeyId, a unique identifier for the RawSecretAccessKey. For character requirements, see XksProxyAuthenticationCredentialType.

KMS uses this authentication credential to sign requests to the external key store proxy on your behalf. This credential is unrelated to Identity and Access Management (IAM) and Amazon Web Services credentials.

This parameter doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS the credential that you established on your external key store proxy. If you rotate your proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new credential to KMS.

$sel:xksProxyConnectivity:CreateCustomKeyStore', createCustomKeyStore_xksProxyConnectivity - Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

If the external key store proxy uses a public endpoint, specify PUBLIC_ENDPOINT. If the external key store proxy uses a Amazon VPC endpoint service for communication with KMS, specify VPC_ENDPOINT_SERVICE. For help making this choice, see Choosing a connectivity option in the Key Management Service Developer Guide.

An Amazon VPC endpoint service keeps your communication with KMS in a private address space entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a verified private DNS name. A public endpoint is simpler to set up, but it might be slower and might not fulfill your security requirements. You might consider testing with a public endpoint, and then establishing a VPC endpoint service for production tasks. Note that this choice does not determine the location of the external key store proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in your corporate data center.

$sel:xksProxyUriEndpoint:CreateCustomKeyStore', createCustomKeyStore_xksProxyUriEndpoint - Specifies the endpoint that KMS uses to send requests to the external key store proxy (XKS proxy). This parameter is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the XksProxyUriEndpoint value.

For external key stores with XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https:// followed by the private DNS name of the VPC endpoint service.

For external key stores with PUBLIC_ENDPOINT connectivity, this endpoint must be reachable before you create the custom key store. KMS connects to the external key store proxy while creating the custom key store. For external key stores with VPC_ENDPOINT_SERVICE connectivity, KMS connects when you call the ConnectCustomKeyStore operation.

The value of this parameter must begin with https://. The remainder can contain upper and lower case letters (A-Z and a-z), numbers (0-9), dots (.), and hyphens (-). Additional slashes (/ and \) are not permitted.

Uniqueness requirements:

• The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.
• An external key store with PUBLIC_ENDPOINT connectivity cannot use the same XksProxyUriEndpoint value as an external key store with VPC_ENDPOINT_SERVICE connectivity in the same Amazon Web Services Region.
• Each external key store with VPC_ENDPOINT_SERVICE connectivity must have its own private DNS name. The XksProxyUriEndpoint value for external key stores with VPC_ENDPOINT_SERVICE connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.

$sel:xksProxyUriPath:CreateCustomKeyStore', createCustomKeyStore_xksProxyUriPath - Specifies the base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. This parameter is required for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The value must start with / and must end with /kms/xks/v1 where v1 represents the version of the KMS external key store proxy API. This path can include an optional prefix between the required elements such as /prefix/kms/xks/v1.

Uniqueness requirements:

• The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

$sel:xksProxyVpcEndpointServiceName:CreateCustomKeyStore', createCustomKeyStore_xksProxyVpcEndpointServiceName - Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). This parameter is required when the value of CustomKeyStoreType is EXTERNAL_KEY_STORE and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE.

The Amazon VPC endpoint service must fulfill all requirements for use with an external key store.

Uniqueness requirements:

• External key stores with VPC_ENDPOINT_SERVICE connectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.

CreateCustomKeyStore, createCustomKeyStore_customKeyStoreName - Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.

data CreateCustomKeyStoreResponse

See: newCreateCustomKeyStoreResponse smart constructor.

Constructors

CreateCustomKeyStoreResponse' (Maybe Text) Int

Instances

Generic CreateCustomKeyStoreResponse

Defined in Amazonka.KMS.CreateCustomKeyStore

Associated Types

type Rep CreateCustomKeyStoreResponse :: Type -> Type

Methods

from :: CreateCustomKeyStoreResponse -> Rep CreateCustomKeyStoreResponse x

to :: Rep CreateCustomKeyStoreResponse x -> CreateCustomKeyStoreResponse

Read CreateCustomKeyStoreResponse

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

readsPrec :: Int -> ReadS CreateCustomKeyStoreResponse

readList :: ReadS [CreateCustomKeyStoreResponse]

readPrec :: ReadPrec CreateCustomKeyStoreResponse

readListPrec :: ReadPrec [CreateCustomKeyStoreResponse]

Show CreateCustomKeyStoreResponse

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

showsPrec :: Int -> CreateCustomKeyStoreResponse -> ShowS

show :: CreateCustomKeyStoreResponse -> String

showList :: [CreateCustomKeyStoreResponse] -> ShowS

NFData CreateCustomKeyStoreResponse

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

rnf :: CreateCustomKeyStoreResponse -> ()

Eq CreateCustomKeyStoreResponse

Defined in Amazonka.KMS.CreateCustomKeyStore

Methods

(==) :: CreateCustomKeyStoreResponse -> CreateCustomKeyStoreResponse -> Bool

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

type Rep CreateCustomKeyStoreResponse

Defined in Amazonka.KMS.CreateCustomKeyStore

type Rep CreateCustomKeyStoreResponse = D1 ('MetaData "CreateCustomKeyStoreResponse" "Amazonka.KMS.CreateCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCustomKeyStoreResponse

Arguments

:: Int

$sel:httpStatus:CreateCustomKeyStoreResponse'

-> CreateCustomKeyStoreResponse

Create a value of CreateCustomKeyStoreResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCustomKeyStoreResponse, createCustomKeyStoreResponse_customKeyStoreId - A unique identifier for the new custom key store.

$sel:httpStatus:CreateCustomKeyStoreResponse', createCustomKeyStoreResponse_httpStatus - The response's http status code.

CreateGrant

data CreateGrant

See: newCreateGrant smart constructor.

Constructors

CreateGrant' (Maybe GrantConstraints) (Maybe [Text]) (Maybe Text) (Maybe Text) Text Text [GrantOperation]

Instances

ToJSON CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

toJSON :: CreateGrant -> Value

toEncoding :: CreateGrant -> Encoding

toJSONList :: [CreateGrant] -> Value

toEncodingList :: [CreateGrant] -> Encoding

ToHeaders CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

toHeaders :: CreateGrant -> [Header]

ToPath CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

toPath :: CreateGrant -> ByteString

ToQuery CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

toQuery :: CreateGrant -> QueryString

AWSRequest CreateGrant

Defined in Amazonka.KMS.CreateGrant

Associated Types

type AWSResponse CreateGrant

Methods

request :: (Service -> Service) -> CreateGrant -> Request CreateGrant

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGrant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGrant)))

Generic CreateGrant

Defined in Amazonka.KMS.CreateGrant

Associated Types

type Rep CreateGrant :: Type -> Type

Methods

from :: CreateGrant -> Rep CreateGrant x

to :: Rep CreateGrant x -> CreateGrant

Read CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

readsPrec :: Int -> ReadS CreateGrant

readList :: ReadS [CreateGrant]

readPrec :: ReadPrec CreateGrant

readListPrec :: ReadPrec [CreateGrant]

Show CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

showsPrec :: Int -> CreateGrant -> ShowS

show :: CreateGrant -> String

showList :: [CreateGrant] -> ShowS

NFData CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

rnf :: CreateGrant -> ()

Eq CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

(==) :: CreateGrant -> CreateGrant -> Bool

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

Hashable CreateGrant

Defined in Amazonka.KMS.CreateGrant

Methods

hashWithSalt :: Int -> CreateGrant -> Int

hash :: CreateGrant -> Int

type AWSResponse CreateGrant

Defined in Amazonka.KMS.CreateGrant

type AWSResponse CreateGrant = CreateGrantResponse

type Rep CreateGrant

Defined in Amazonka.KMS.CreateGrant

type Rep CreateGrant = D1 ('MetaData "CreateGrant" "Amazonka.KMS.CreateGrant" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateGrant'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "constraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrantConstraints)) :*: (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "retiringPrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "granteePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GrantOperation])))))

newCreateGrant

Arguments

:: Text

CreateGrant

-> Text

CreateGrant

-> CreateGrant

Create a value of CreateGrant with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateGrant, createGrant_constraints - Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption context in the /Key Management Service Developer Guide/ .

The encryption context grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure.

The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint.

You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption context.

$sel:grantTokens:CreateGrant', createGrant_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

CreateGrant, createGrant_name - A friendly name for the grant. Use this value to prevent the 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 for the same grant ID can be used interchangeably.

CreateGrant, createGrant_retiringPrincipal - The principal that has permission to use the RetireGrant operation to retire the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

CreateGrant, createGrant_keyId - Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

CreateGrant, createGrant_granteePrincipal - The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

CreateGrant, createGrant_operations - A list of operations that the grant permits.

This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

data CreateGrantResponse

See: newCreateGrantResponse smart constructor.

Constructors

CreateGrantResponse' (Maybe Text) (Maybe Text) Int

Instances

Generic CreateGrantResponse

Defined in Amazonka.KMS.CreateGrant

Associated Types

type Rep CreateGrantResponse :: Type -> Type

Methods

from :: CreateGrantResponse -> Rep CreateGrantResponse x

to :: Rep CreateGrantResponse x -> CreateGrantResponse

Read CreateGrantResponse

Defined in Amazonka.KMS.CreateGrant

Methods

readsPrec :: Int -> ReadS CreateGrantResponse

readList :: ReadS [CreateGrantResponse]

readPrec :: ReadPrec CreateGrantResponse

readListPrec :: ReadPrec [CreateGrantResponse]

Show CreateGrantResponse

Defined in Amazonka.KMS.CreateGrant

Methods

showsPrec :: Int -> CreateGrantResponse -> ShowS

show :: CreateGrantResponse -> String

showList :: [CreateGrantResponse] -> ShowS

NFData CreateGrantResponse

Defined in Amazonka.KMS.CreateGrant

Methods

rnf :: CreateGrantResponse -> ()

Eq CreateGrantResponse

Defined in Amazonka.KMS.CreateGrant

Methods

(==) :: CreateGrantResponse -> CreateGrantResponse -> Bool

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

type Rep CreateGrantResponse

Defined in Amazonka.KMS.CreateGrant

type Rep CreateGrantResponse = D1 ('MetaData "CreateGrantResponse" "Amazonka.KMS.CreateGrant" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateGrantResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "grantToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateGrantResponse

Arguments

:: Int

$sel:httpStatus:CreateGrantResponse'

-> CreateGrantResponse

Create a value of CreateGrantResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateGrantResponse, createGrantResponse_grantId - The unique identifier for the grant.

You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.

$sel:grantToken:CreateGrantResponse', createGrantResponse_grantToken - The grant token.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:httpStatus:CreateGrantResponse', createGrantResponse_httpStatus - The response's http status code.

CreateKey

data CreateKey

See: newCreateKey smart constructor.

Constructors

CreateKey' (Maybe Bool) (Maybe Text) (Maybe CustomerMasterKeySpec) (Maybe Text) (Maybe KeySpec) (Maybe KeyUsageType) (Maybe Bool) (Maybe OriginType) (Maybe Text) (Maybe [Tag]) (Maybe Text)

Instances

ToJSON CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

toJSON :: CreateKey -> Value

toEncoding :: CreateKey -> Encoding

toJSONList :: [CreateKey] -> Value

toEncodingList :: [CreateKey] -> Encoding

ToHeaders CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

toHeaders :: CreateKey -> [Header]

ToPath CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

toPath :: CreateKey -> ByteString

ToQuery CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

toQuery :: CreateKey -> QueryString

AWSRequest CreateKey

Defined in Amazonka.KMS.CreateKey

Associated Types

type AWSResponse CreateKey

Methods

request :: (Service -> Service) -> CreateKey -> Request CreateKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateKey)))

Generic CreateKey

Defined in Amazonka.KMS.CreateKey

Associated Types

type Rep CreateKey :: Type -> Type

Methods

from :: CreateKey -> Rep CreateKey x

to :: Rep CreateKey x -> CreateKey

Read CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

readsPrec :: Int -> ReadS CreateKey

readList :: ReadS [CreateKey]

readPrec :: ReadPrec CreateKey

readListPrec :: ReadPrec [CreateKey]

Show CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

showsPrec :: Int -> CreateKey -> ShowS

show :: CreateKey -> String

showList :: [CreateKey] -> ShowS

NFData CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

rnf :: CreateKey -> ()

Eq CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

(==) :: CreateKey -> CreateKey -> Bool

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

Hashable CreateKey

Defined in Amazonka.KMS.CreateKey

Methods

hashWithSalt :: Int -> CreateKey -> Int

hash :: CreateKey -> Int

type AWSResponse CreateKey

Defined in Amazonka.KMS.CreateKey

type AWSResponse CreateKey = CreateKeyResponse

type Rep CreateKey

Defined in Amazonka.KMS.CreateKey

type Rep CreateKey = D1 ('MetaData "CreateKey" "Amazonka.KMS.CreateKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bypassPolicyLockoutSafetyCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "customerMasterKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerMasterKeySpec)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeySpec))))) :*: ((S1 ('MetaSel ('Just "keyUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyUsageType)) :*: (S1 ('MetaSel ('Just "multiRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OriginType)))) :*: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "xksKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newCreateKey :: CreateKey

Create a value of CreateKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bypassPolicyLockoutSafetyCheck:CreateKey', createKey_bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the /Key Management Service Developer Guide/ .

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

CreateKey, createKey_customKeyStoreId - Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.

This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.

When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.

CreateKey, createKey_customerMasterKeySpec - Instead, use the KeySpec parameter.

The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS supports both parameters.

CreateKey, createKey_description - A description of the KMS key.

Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).

To set or change the description after the key is created, use UpdateKeyDescription.

CreateKey, createKey_keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the /Key Management Service Developer Guide/ .

The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the /Key Management Service Developer Guide/ .

Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.

KMS supports the following key specs for KMS keys:

• Symmetric encryption key (default)

  • SYMMETRIC_DEFAULT

• HMAC keys (symmetric)

  • HMAC_224

  • HMAC_256

  • HMAC_384

  • HMAC_512

• Asymmetric RSA key pairs

  • RSA_2048

  • RSA_3072

  • RSA_4096

• Asymmetric NIST-recommended elliptic curve key pairs

  • ECC_NIST_P256 (secp256r1)
  • ECC_NIST_P384 (secp384r1)
  • ECC_NIST_P521 (secp521r1)

• Other asymmetric elliptic curve key pairs

  • ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

• SM2 key pairs (China Regions only)

  • SM2

CreateKey, createKey_keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.

Select only one valid value.

• For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
• For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
• For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
• For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
• For asymmetric KMS keys with SM2 key material (China Regions only), specify ENCRYPT_DECRYPT or SIGN_VERIFY.

CreateKey, createKey_multiRegion - Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.

For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False.

This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

This value creates a primary key, not a replica. To create a /replica key/, use the ReplicateKey operation.

You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.

CreateKey, createKey_origin - The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key material.

To create a KMS key with no key material (for imported key material), set this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.

To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.

To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.

$sel:policy:CreateKey', createKey_policy - The key policy to attach to the KMS key.

If you provide a key policy, it must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ .
• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the /Amazon Web Services Identity and Access Management User Guide/.

If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default Key Policy in the Key Management Service Developer Guide.

The key policy size quota is 32 kilobytes (32768 bytes).

For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the /Identity and Access Management User Guide/ .

$sel:tags:CreateKey', createKey_tags - Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

$sel:xksKeyId:CreateKey', createKey_xksKeyId - Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.

This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.

The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.

Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as /double encryption/. For details, see Double encryption in the Key Management Service Developer Guide.

data CreateKeyResponse

See: newCreateKeyResponse smart constructor.

Constructors

CreateKeyResponse' (Maybe KeyMetadata) Int

Instances

Generic CreateKeyResponse

Defined in Amazonka.KMS.CreateKey

Associated Types

type Rep CreateKeyResponse :: Type -> Type

Methods

from :: CreateKeyResponse -> Rep CreateKeyResponse x

to :: Rep CreateKeyResponse x -> CreateKeyResponse

Read CreateKeyResponse

Defined in Amazonka.KMS.CreateKey

Methods

readsPrec :: Int -> ReadS CreateKeyResponse

readList :: ReadS [CreateKeyResponse]

readPrec :: ReadPrec CreateKeyResponse

readListPrec :: ReadPrec [CreateKeyResponse]

Show CreateKeyResponse

Defined in Amazonka.KMS.CreateKey

Methods

showsPrec :: Int -> CreateKeyResponse -> ShowS

show :: CreateKeyResponse -> String

showList :: [CreateKeyResponse] -> ShowS

NFData CreateKeyResponse

Defined in Amazonka.KMS.CreateKey

Methods

rnf :: CreateKeyResponse -> ()

Eq CreateKeyResponse

Defined in Amazonka.KMS.CreateKey

Methods

(==) :: CreateKeyResponse -> CreateKeyResponse -> Bool

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

type Rep CreateKeyResponse

Defined in Amazonka.KMS.CreateKey

type Rep CreateKeyResponse = D1 ('MetaData "CreateKeyResponse" "Amazonka.KMS.CreateKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CreateKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyMetadata)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateKeyResponse

Arguments

:: Int

$sel:httpStatus:CreateKeyResponse'

-> CreateKeyResponse

Create a value of CreateKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyMetadata:CreateKeyResponse', createKeyResponse_keyMetadata - Metadata associated with the KMS key.

$sel:httpStatus:CreateKeyResponse', createKeyResponse_httpStatus - The response's http status code.

Decrypt

data Decrypt

See: newDecrypt smart constructor.

Constructors

Decrypt' (Maybe EncryptionAlgorithmSpec) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) Base64

Instances

ToJSON Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toJSON :: Decrypt -> Value

toEncoding :: Decrypt -> Encoding

toJSONList :: [Decrypt] -> Value

toEncodingList :: [Decrypt] -> Encoding

ToHeaders Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toHeaders :: Decrypt -> [Header]

ToPath Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toPath :: Decrypt -> ByteString

ToQuery Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

toQuery :: Decrypt -> QueryString

AWSRequest Decrypt

Defined in Amazonka.KMS.Decrypt

Associated Types

type AWSResponse Decrypt

Methods

request :: (Service -> Service) -> Decrypt -> Request Decrypt

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Decrypt -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Decrypt)))

Generic Decrypt

Defined in Amazonka.KMS.Decrypt

Associated Types

type Rep Decrypt :: Type -> Type

Methods

from :: Decrypt -> Rep Decrypt x

to :: Rep Decrypt x -> Decrypt

Read Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

readsPrec :: Int -> ReadS Decrypt

readList :: ReadS [Decrypt]

readPrec :: ReadPrec Decrypt

readListPrec :: ReadPrec [Decrypt]

Show Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

showsPrec :: Int -> Decrypt -> ShowS

show :: Decrypt -> String

showList :: [Decrypt] -> ShowS

NFData Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

rnf :: Decrypt -> ()

Eq Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

(==) :: Decrypt -> Decrypt -> Bool

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

Hashable Decrypt

Defined in Amazonka.KMS.Decrypt

Methods

hashWithSalt :: Int -> Decrypt -> Int

hash :: Decrypt -> Int

type AWSResponse Decrypt

Defined in Amazonka.KMS.Decrypt

type AWSResponse Decrypt = DecryptResponse

type Rep Decrypt

Defined in Amazonka.KMS.Decrypt

type Rep Decrypt = D1 ('MetaData "Decrypt" "Amazonka.KMS.Decrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Decrypt'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)))))

newDecrypt

Arguments

:: ByteString

$sel:ciphertextBlob:Decrypt'

-> Decrypt

Create a value of Decrypt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Decrypt, decrypt_encryptionAlgorithm - Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

$sel:encryptionContext:Decrypt', decrypt_encryptionContext - Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:Decrypt', decrypt_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Decrypt, decrypt_keyId - Specifies the KMS key that KMS uses to decrypt the ciphertext.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

$sel:ciphertextBlob:Decrypt', decrypt_ciphertextBlob - 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.

data DecryptResponse

See: newDecryptResponse smart constructor.

Constructors

DecryptResponse' (Maybe EncryptionAlgorithmSpec) (Maybe Text) (Maybe (Sensitive Base64)) Int

Instances

Generic DecryptResponse

Defined in Amazonka.KMS.Decrypt

Associated Types

type Rep DecryptResponse :: Type -> Type

Methods

from :: DecryptResponse -> Rep DecryptResponse x

to :: Rep DecryptResponse x -> DecryptResponse

Show DecryptResponse

Defined in Amazonka.KMS.Decrypt

Methods

showsPrec :: Int -> DecryptResponse -> ShowS

show :: DecryptResponse -> String

showList :: [DecryptResponse] -> ShowS

NFData DecryptResponse

Defined in Amazonka.KMS.Decrypt

Methods

rnf :: DecryptResponse -> ()

Eq DecryptResponse

Defined in Amazonka.KMS.Decrypt

Methods

(==) :: DecryptResponse -> DecryptResponse -> Bool

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

type Rep DecryptResponse

Defined in Amazonka.KMS.Decrypt

type Rep DecryptResponse = D1 ('MetaData "DecryptResponse" "Amazonka.KMS.Decrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DecryptResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "plaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDecryptResponse

Arguments

:: Int

$sel:httpStatus:DecryptResponse'

-> DecryptResponse

Create a value of DecryptResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Decrypt, decryptResponse_encryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext.

Decrypt, decryptResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

$sel:plaintext:DecryptResponse', decryptResponse_plaintext - Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:httpStatus:DecryptResponse', decryptResponse_httpStatus - The response's http status code.

DeleteAlias

data DeleteAlias

See: newDeleteAlias smart constructor.

Constructors

DeleteAlias' Text

Instances

ToJSON DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

toJSON :: DeleteAlias -> Value

toEncoding :: DeleteAlias -> Encoding

toJSONList :: [DeleteAlias] -> Value

toEncodingList :: [DeleteAlias] -> Encoding

ToHeaders DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

toHeaders :: DeleteAlias -> [Header]

ToPath DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

toPath :: DeleteAlias -> ByteString

ToQuery DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

toQuery :: DeleteAlias -> QueryString

AWSRequest DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Associated Types

type AWSResponse DeleteAlias

Methods

request :: (Service -> Service) -> DeleteAlias -> Request DeleteAlias

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAlias)))

Generic DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Associated Types

type Rep DeleteAlias :: Type -> Type

Methods

from :: DeleteAlias -> Rep DeleteAlias x

to :: Rep DeleteAlias x -> DeleteAlias

Read DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

readsPrec :: Int -> ReadS DeleteAlias

readList :: ReadS [DeleteAlias]

readPrec :: ReadPrec DeleteAlias

readListPrec :: ReadPrec [DeleteAlias]

Show DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

showsPrec :: Int -> DeleteAlias -> ShowS

show :: DeleteAlias -> String

showList :: [DeleteAlias] -> ShowS

NFData DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

rnf :: DeleteAlias -> ()

Eq DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

(==) :: DeleteAlias -> DeleteAlias -> Bool

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

Hashable DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

Methods

hashWithSalt :: Int -> DeleteAlias -> Int

hash :: DeleteAlias -> Int

type AWSResponse DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

type AWSResponse DeleteAlias = DeleteAliasResponse

type Rep DeleteAlias

Defined in Amazonka.KMS.DeleteAlias

type Rep DeleteAlias = D1 ('MetaData "DeleteAlias" "Amazonka.KMS.DeleteAlias" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAlias

Arguments

:: Text

DeleteAlias

-> DeleteAlias

Create a value of DeleteAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteAlias, deleteAlias_aliasName - The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

data DeleteAliasResponse

See: newDeleteAliasResponse smart constructor.

Constructors

DeleteAliasResponse'

Instances

Generic DeleteAliasResponse

Defined in Amazonka.KMS.DeleteAlias

Associated Types

type Rep DeleteAliasResponse :: Type -> Type

Methods

from :: DeleteAliasResponse -> Rep DeleteAliasResponse x

to :: Rep DeleteAliasResponse x -> DeleteAliasResponse

Read DeleteAliasResponse

Defined in Amazonka.KMS.DeleteAlias

Methods

readsPrec :: Int -> ReadS DeleteAliasResponse

readList :: ReadS [DeleteAliasResponse]

readPrec :: ReadPrec DeleteAliasResponse

readListPrec :: ReadPrec [DeleteAliasResponse]

Show DeleteAliasResponse

Defined in Amazonka.KMS.DeleteAlias

Methods

showsPrec :: Int -> DeleteAliasResponse -> ShowS

show :: DeleteAliasResponse -> String

showList :: [DeleteAliasResponse] -> ShowS

NFData DeleteAliasResponse

Defined in Amazonka.KMS.DeleteAlias

Methods

rnf :: DeleteAliasResponse -> ()

Eq DeleteAliasResponse

Defined in Amazonka.KMS.DeleteAlias

Methods

(==) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool

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

type Rep DeleteAliasResponse

Defined in Amazonka.KMS.DeleteAlias

type Rep DeleteAliasResponse = D1 ('MetaData "DeleteAliasResponse" "Amazonka.KMS.DeleteAlias" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteAliasResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAliasResponse :: DeleteAliasResponse

Create a value of DeleteAliasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteCustomKeyStore

data DeleteCustomKeyStore

See: newDeleteCustomKeyStore smart constructor.

Constructors

DeleteCustomKeyStore' Text

Instances

ToJSON DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

toJSON :: DeleteCustomKeyStore -> Value

toEncoding :: DeleteCustomKeyStore -> Encoding

toJSONList :: [DeleteCustomKeyStore] -> Value

toEncodingList :: [DeleteCustomKeyStore] -> Encoding

ToHeaders DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

toHeaders :: DeleteCustomKeyStore -> [Header]

ToPath DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

toPath :: DeleteCustomKeyStore -> ByteString

ToQuery DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

toQuery :: DeleteCustomKeyStore -> QueryString

AWSRequest DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Associated Types

type AWSResponse DeleteCustomKeyStore

Methods

request :: (Service -> Service) -> DeleteCustomKeyStore -> Request DeleteCustomKeyStore

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteCustomKeyStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteCustomKeyStore)))

Generic DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Associated Types

type Rep DeleteCustomKeyStore :: Type -> Type

Methods

from :: DeleteCustomKeyStore -> Rep DeleteCustomKeyStore x

to :: Rep DeleteCustomKeyStore x -> DeleteCustomKeyStore

Read DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

readsPrec :: Int -> ReadS DeleteCustomKeyStore

readList :: ReadS [DeleteCustomKeyStore]

readPrec :: ReadPrec DeleteCustomKeyStore

readListPrec :: ReadPrec [DeleteCustomKeyStore]

Show DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

showsPrec :: Int -> DeleteCustomKeyStore -> ShowS

show :: DeleteCustomKeyStore -> String

showList :: [DeleteCustomKeyStore] -> ShowS

NFData DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

rnf :: DeleteCustomKeyStore -> ()

Eq DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

(==) :: DeleteCustomKeyStore -> DeleteCustomKeyStore -> Bool

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

Hashable DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

hashWithSalt :: Int -> DeleteCustomKeyStore -> Int

hash :: DeleteCustomKeyStore -> Int

type AWSResponse DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

type AWSResponse DeleteCustomKeyStore = DeleteCustomKeyStoreResponse

type Rep DeleteCustomKeyStore

Defined in Amazonka.KMS.DeleteCustomKeyStore

type Rep DeleteCustomKeyStore = D1 ('MetaData "DeleteCustomKeyStore" "Amazonka.KMS.DeleteCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteCustomKeyStore'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteCustomKeyStore

Arguments

:: Text

DeleteCustomKeyStore

-> DeleteCustomKeyStore

Create a value of DeleteCustomKeyStore with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteCustomKeyStore, deleteCustomKeyStore_customKeyStoreId - Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

data DeleteCustomKeyStoreResponse

See: newDeleteCustomKeyStoreResponse smart constructor.

Constructors

DeleteCustomKeyStoreResponse' Int

Instances

Generic DeleteCustomKeyStoreResponse

Defined in Amazonka.KMS.DeleteCustomKeyStore

Associated Types

type Rep DeleteCustomKeyStoreResponse :: Type -> Type

Methods

from :: DeleteCustomKeyStoreResponse -> Rep DeleteCustomKeyStoreResponse x

to :: Rep DeleteCustomKeyStoreResponse x -> DeleteCustomKeyStoreResponse

Read DeleteCustomKeyStoreResponse

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

readsPrec :: Int -> ReadS DeleteCustomKeyStoreResponse

readList :: ReadS [DeleteCustomKeyStoreResponse]

readPrec :: ReadPrec DeleteCustomKeyStoreResponse

readListPrec :: ReadPrec [DeleteCustomKeyStoreResponse]

Show DeleteCustomKeyStoreResponse

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

showsPrec :: Int -> DeleteCustomKeyStoreResponse -> ShowS

show :: DeleteCustomKeyStoreResponse -> String

showList :: [DeleteCustomKeyStoreResponse] -> ShowS

NFData DeleteCustomKeyStoreResponse

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

rnf :: DeleteCustomKeyStoreResponse -> ()

Eq DeleteCustomKeyStoreResponse

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

(==) :: DeleteCustomKeyStoreResponse -> DeleteCustomKeyStoreResponse -> Bool

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

type Rep DeleteCustomKeyStoreResponse

Defined in Amazonka.KMS.DeleteCustomKeyStore

type Rep DeleteCustomKeyStoreResponse = D1 ('MetaData "DeleteCustomKeyStoreResponse" "Amazonka.KMS.DeleteCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteCustomKeyStoreResponse

Arguments

:: Int

$sel:httpStatus:DeleteCustomKeyStoreResponse'

-> DeleteCustomKeyStoreResponse

Create a value of DeleteCustomKeyStoreResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteCustomKeyStoreResponse', deleteCustomKeyStoreResponse_httpStatus - The response's http status code.

DeleteImportedKeyMaterial

data DeleteImportedKeyMaterial

See: newDeleteImportedKeyMaterial smart constructor.

Constructors

DeleteImportedKeyMaterial' Text

Instances

ToJSON DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

toJSON :: DeleteImportedKeyMaterial -> Value

toEncoding :: DeleteImportedKeyMaterial -> Encoding

toJSONList :: [DeleteImportedKeyMaterial] -> Value

toEncodingList :: [DeleteImportedKeyMaterial] -> Encoding

ToHeaders DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

toHeaders :: DeleteImportedKeyMaterial -> [Header]

ToPath DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

toPath :: DeleteImportedKeyMaterial -> ByteString

ToQuery DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

toQuery :: DeleteImportedKeyMaterial -> QueryString

AWSRequest DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Associated Types

type AWSResponse DeleteImportedKeyMaterial

Methods

request :: (Service -> Service) -> DeleteImportedKeyMaterial -> Request DeleteImportedKeyMaterial

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteImportedKeyMaterial -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteImportedKeyMaterial)))

Generic DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Associated Types

type Rep DeleteImportedKeyMaterial :: Type -> Type

Methods

from :: DeleteImportedKeyMaterial -> Rep DeleteImportedKeyMaterial x

to :: Rep DeleteImportedKeyMaterial x -> DeleteImportedKeyMaterial

Read DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

readsPrec :: Int -> ReadS DeleteImportedKeyMaterial

readList :: ReadS [DeleteImportedKeyMaterial]

readPrec :: ReadPrec DeleteImportedKeyMaterial

readListPrec :: ReadPrec [DeleteImportedKeyMaterial]

Show DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

showsPrec :: Int -> DeleteImportedKeyMaterial -> ShowS

show :: DeleteImportedKeyMaterial -> String

showList :: [DeleteImportedKeyMaterial] -> ShowS

NFData DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

rnf :: DeleteImportedKeyMaterial -> ()

Eq DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

(==) :: DeleteImportedKeyMaterial -> DeleteImportedKeyMaterial -> Bool

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

Hashable DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

hashWithSalt :: Int -> DeleteImportedKeyMaterial -> Int

hash :: DeleteImportedKeyMaterial -> Int

type AWSResponse DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

type AWSResponse DeleteImportedKeyMaterial = DeleteImportedKeyMaterialResponse

type Rep DeleteImportedKeyMaterial

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

type Rep DeleteImportedKeyMaterial = D1 ('MetaData "DeleteImportedKeyMaterial" "Amazonka.KMS.DeleteImportedKeyMaterial" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteImportedKeyMaterial'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteImportedKeyMaterial

Arguments

:: Text

DeleteImportedKeyMaterial

-> DeleteImportedKeyMaterial

Create a value of DeleteImportedKeyMaterial with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteImportedKeyMaterial, deleteImportedKeyMaterial_keyId - Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data DeleteImportedKeyMaterialResponse

See: newDeleteImportedKeyMaterialResponse smart constructor.

Constructors

DeleteImportedKeyMaterialResponse'

Instances

Generic DeleteImportedKeyMaterialResponse

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Associated Types

type Rep DeleteImportedKeyMaterialResponse :: Type -> Type

Methods

from :: DeleteImportedKeyMaterialResponse -> Rep DeleteImportedKeyMaterialResponse x

to :: Rep DeleteImportedKeyMaterialResponse x -> DeleteImportedKeyMaterialResponse

Read DeleteImportedKeyMaterialResponse

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

readsPrec :: Int -> ReadS DeleteImportedKeyMaterialResponse

readList :: ReadS [DeleteImportedKeyMaterialResponse]

readPrec :: ReadPrec DeleteImportedKeyMaterialResponse

readListPrec :: ReadPrec [DeleteImportedKeyMaterialResponse]

Show DeleteImportedKeyMaterialResponse

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

showsPrec :: Int -> DeleteImportedKeyMaterialResponse -> ShowS

show :: DeleteImportedKeyMaterialResponse -> String

showList :: [DeleteImportedKeyMaterialResponse] -> ShowS

NFData DeleteImportedKeyMaterialResponse

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

rnf :: DeleteImportedKeyMaterialResponse -> ()

Eq DeleteImportedKeyMaterialResponse

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

Methods

(==) :: DeleteImportedKeyMaterialResponse -> DeleteImportedKeyMaterialResponse -> Bool

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

type Rep DeleteImportedKeyMaterialResponse

Defined in Amazonka.KMS.DeleteImportedKeyMaterial

type Rep DeleteImportedKeyMaterialResponse = D1 ('MetaData "DeleteImportedKeyMaterialResponse" "Amazonka.KMS.DeleteImportedKeyMaterial" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteImportedKeyMaterialResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteImportedKeyMaterialResponse :: DeleteImportedKeyMaterialResponse

Create a value of DeleteImportedKeyMaterialResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DescribeCustomKeyStores (Paginated)

data DescribeCustomKeyStores

See: newDescribeCustomKeyStores smart constructor.

Constructors

DescribeCustomKeyStores' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)

Instances

ToJSON DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toJSON :: DescribeCustomKeyStores -> Value

toEncoding :: DescribeCustomKeyStores -> Encoding

toJSONList :: [DescribeCustomKeyStores] -> Value

toEncodingList :: [DescribeCustomKeyStores] -> Encoding

ToHeaders DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toHeaders :: DescribeCustomKeyStores -> [Header]

ToPath DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toPath :: DescribeCustomKeyStores -> ByteString

ToQuery DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

toQuery :: DescribeCustomKeyStores -> QueryString

AWSPager DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

page :: DescribeCustomKeyStores -> AWSResponse DescribeCustomKeyStores -> Maybe DescribeCustomKeyStores

AWSRequest DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Associated Types

type AWSResponse DescribeCustomKeyStores

Methods

request :: (Service -> Service) -> DescribeCustomKeyStores -> Request DescribeCustomKeyStores

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCustomKeyStores -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCustomKeyStores)))

Generic DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Associated Types

type Rep DescribeCustomKeyStores :: Type -> Type

Methods

from :: DescribeCustomKeyStores -> Rep DescribeCustomKeyStores x

to :: Rep DescribeCustomKeyStores x -> DescribeCustomKeyStores

Read DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

readsPrec :: Int -> ReadS DescribeCustomKeyStores

readList :: ReadS [DescribeCustomKeyStores]

readPrec :: ReadPrec DescribeCustomKeyStores

readListPrec :: ReadPrec [DescribeCustomKeyStores]

Show DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

showsPrec :: Int -> DescribeCustomKeyStores -> ShowS

show :: DescribeCustomKeyStores -> String

showList :: [DescribeCustomKeyStores] -> ShowS

NFData DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

rnf :: DescribeCustomKeyStores -> ()

Eq DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

(==) :: DescribeCustomKeyStores -> DescribeCustomKeyStores -> Bool

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

Hashable DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

hashWithSalt :: Int -> DescribeCustomKeyStores -> Int

hash :: DescribeCustomKeyStores -> Int

type AWSResponse DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

type AWSResponse DescribeCustomKeyStores = DescribeCustomKeyStoresResponse

type Rep DescribeCustomKeyStores

Defined in Amazonka.KMS.DescribeCustomKeyStores

type Rep DescribeCustomKeyStores = D1 ('MetaData "DescribeCustomKeyStores" "Amazonka.KMS.DescribeCustomKeyStores" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DescribeCustomKeyStores'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeCustomKeyStores :: DescribeCustomKeyStores

Create a value of DescribeCustomKeyStores with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeCustomKeyStores, describeCustomKeyStores_customKeyStoreId - Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

DescribeCustomKeyStores, describeCustomKeyStores_customKeyStoreName - Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

$sel:limit:DescribeCustomKeyStores', describeCustomKeyStores_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

$sel:marker:DescribeCustomKeyStores', describeCustomKeyStores_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

data DescribeCustomKeyStoresResponse

See: newDescribeCustomKeyStoresResponse smart constructor.

Constructors

DescribeCustomKeyStoresResponse' (Maybe [CustomKeyStoresListEntry]) (Maybe Text) (Maybe Bool) Int

Instances

Generic DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Associated Types

type Rep DescribeCustomKeyStoresResponse :: Type -> Type

Methods

from :: DescribeCustomKeyStoresResponse -> Rep DescribeCustomKeyStoresResponse x

to :: Rep DescribeCustomKeyStoresResponse x -> DescribeCustomKeyStoresResponse

Show DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

showsPrec :: Int -> DescribeCustomKeyStoresResponse -> ShowS

show :: DescribeCustomKeyStoresResponse -> String

showList :: [DescribeCustomKeyStoresResponse] -> ShowS

NFData DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

rnf :: DescribeCustomKeyStoresResponse -> ()

Eq DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

Methods

(==) :: DescribeCustomKeyStoresResponse -> DescribeCustomKeyStoresResponse -> Bool

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

type Rep DescribeCustomKeyStoresResponse

Defined in Amazonka.KMS.DescribeCustomKeyStores

type Rep DescribeCustomKeyStoresResponse = D1 ('MetaData "DescribeCustomKeyStoresResponse" "Amazonka.KMS.DescribeCustomKeyStores" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DescribeCustomKeyStoresResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customKeyStores") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CustomKeyStoresListEntry])) :*: S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCustomKeyStoresResponse

Arguments

:: Int

$sel:httpStatus:DescribeCustomKeyStoresResponse'

-> DescribeCustomKeyStoresResponse

Create a value of DescribeCustomKeyStoresResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customKeyStores:DescribeCustomKeyStoresResponse', describeCustomKeyStoresResponse_customKeyStores - Contains metadata about each custom key store.

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

DescribeCustomKeyStoresResponse, describeCustomKeyStoresResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

$sel:httpStatus:DescribeCustomKeyStoresResponse', describeCustomKeyStoresResponse_httpStatus - The response's http status code.

DescribeKey

data DescribeKey

See: newDescribeKey smart constructor.

Constructors

DescribeKey' (Maybe [Text]) Text

Instances

ToJSON DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

toJSON :: DescribeKey -> Value

toEncoding :: DescribeKey -> Encoding

toJSONList :: [DescribeKey] -> Value

toEncodingList :: [DescribeKey] -> Encoding

ToHeaders DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

toHeaders :: DescribeKey -> [Header]

ToPath DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

toPath :: DescribeKey -> ByteString

ToQuery DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

toQuery :: DescribeKey -> QueryString

AWSRequest DescribeKey

Defined in Amazonka.KMS.DescribeKey

Associated Types

type AWSResponse DescribeKey

Methods

request :: (Service -> Service) -> DescribeKey -> Request DescribeKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeKey)))

Generic DescribeKey

Defined in Amazonka.KMS.DescribeKey

Associated Types

type Rep DescribeKey :: Type -> Type

Methods

from :: DescribeKey -> Rep DescribeKey x

to :: Rep DescribeKey x -> DescribeKey

Read DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

readsPrec :: Int -> ReadS DescribeKey

readList :: ReadS [DescribeKey]

readPrec :: ReadPrec DescribeKey

readListPrec :: ReadPrec [DescribeKey]

Show DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

showsPrec :: Int -> DescribeKey -> ShowS

show :: DescribeKey -> String

showList :: [DescribeKey] -> ShowS

NFData DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

rnf :: DescribeKey -> ()

Eq DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

(==) :: DescribeKey -> DescribeKey -> Bool

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

Hashable DescribeKey

Defined in Amazonka.KMS.DescribeKey

Methods

hashWithSalt :: Int -> DescribeKey -> Int

hash :: DescribeKey -> Int

type AWSResponse DescribeKey

Defined in Amazonka.KMS.DescribeKey

type AWSResponse DescribeKey = DescribeKeyResponse

type Rep DescribeKey

Defined in Amazonka.KMS.DescribeKey

type Rep DescribeKey = D1 ('MetaData "DescribeKey" "Amazonka.KMS.DescribeKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DescribeKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeKey

Arguments

:: Text

DescribeKey

-> DescribeKey

Create a value of DescribeKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grantTokens:DescribeKey', describeKey_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

DescribeKey, describeKey_keyId - Describes the specified KMS key.

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

data DescribeKeyResponse

See: newDescribeKeyResponse smart constructor.

Constructors

DescribeKeyResponse' (Maybe KeyMetadata) Int

Instances

Generic DescribeKeyResponse

Defined in Amazonka.KMS.DescribeKey

Associated Types

type Rep DescribeKeyResponse :: Type -> Type

Methods

from :: DescribeKeyResponse -> Rep DescribeKeyResponse x

to :: Rep DescribeKeyResponse x -> DescribeKeyResponse

Read DescribeKeyResponse

Defined in Amazonka.KMS.DescribeKey

Methods

readsPrec :: Int -> ReadS DescribeKeyResponse

readList :: ReadS [DescribeKeyResponse]

readPrec :: ReadPrec DescribeKeyResponse

readListPrec :: ReadPrec [DescribeKeyResponse]

Show DescribeKeyResponse

Defined in Amazonka.KMS.DescribeKey

Methods

showsPrec :: Int -> DescribeKeyResponse -> ShowS

show :: DescribeKeyResponse -> String

showList :: [DescribeKeyResponse] -> ShowS

NFData DescribeKeyResponse

Defined in Amazonka.KMS.DescribeKey

Methods

rnf :: DescribeKeyResponse -> ()

Eq DescribeKeyResponse

Defined in Amazonka.KMS.DescribeKey

Methods

(==) :: DescribeKeyResponse -> DescribeKeyResponse -> Bool

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

type Rep DescribeKeyResponse

Defined in Amazonka.KMS.DescribeKey

type Rep DescribeKeyResponse = D1 ('MetaData "DescribeKeyResponse" "Amazonka.KMS.DescribeKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DescribeKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyMetadata)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeKeyResponse

Arguments

:: Int

$sel:httpStatus:DescribeKeyResponse'

-> DescribeKeyResponse

Create a value of DescribeKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyMetadata:DescribeKeyResponse', describeKeyResponse_keyMetadata - Metadata associated with the key.

$sel:httpStatus:DescribeKeyResponse', describeKeyResponse_httpStatus - The response's http status code.

DisableKey

data DisableKey

See: newDisableKey smart constructor.

Constructors

DisableKey' Text

Instances

ToJSON DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toJSON :: DisableKey -> Value

toEncoding :: DisableKey -> Encoding

toJSONList :: [DisableKey] -> Value

toEncodingList :: [DisableKey] -> Encoding

ToHeaders DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toHeaders :: DisableKey -> [Header]

ToPath DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toPath :: DisableKey -> ByteString

ToQuery DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

toQuery :: DisableKey -> QueryString

AWSRequest DisableKey

Defined in Amazonka.KMS.DisableKey

Associated Types

type AWSResponse DisableKey

Methods

request :: (Service -> Service) -> DisableKey -> Request DisableKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisableKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisableKey)))

Generic DisableKey

Defined in Amazonka.KMS.DisableKey

Associated Types

type Rep DisableKey :: Type -> Type

Methods

from :: DisableKey -> Rep DisableKey x

to :: Rep DisableKey x -> DisableKey

Read DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

readsPrec :: Int -> ReadS DisableKey

readList :: ReadS [DisableKey]

readPrec :: ReadPrec DisableKey

readListPrec :: ReadPrec [DisableKey]

Show DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

showsPrec :: Int -> DisableKey -> ShowS

show :: DisableKey -> String

showList :: [DisableKey] -> ShowS

NFData DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

rnf :: DisableKey -> ()

Eq DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

(==) :: DisableKey -> DisableKey -> Bool

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

Hashable DisableKey

Defined in Amazonka.KMS.DisableKey

Methods

hashWithSalt :: Int -> DisableKey -> Int

hash :: DisableKey -> Int

type AWSResponse DisableKey

Defined in Amazonka.KMS.DisableKey

type AWSResponse DisableKey = DisableKeyResponse

type Rep DisableKey

Defined in Amazonka.KMS.DisableKey

type Rep DisableKey = D1 ('MetaData "DisableKey" "Amazonka.KMS.DisableKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisableKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDisableKey

Arguments

:: Text

DisableKey

-> DisableKey

Create a value of DisableKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DisableKey, disableKey_keyId - Identifies the KMS key to disable.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data DisableKeyResponse

See: newDisableKeyResponse smart constructor.

Constructors

DisableKeyResponse'

Instances

Generic DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Associated Types

type Rep DisableKeyResponse :: Type -> Type

Methods

from :: DisableKeyResponse -> Rep DisableKeyResponse x

to :: Rep DisableKeyResponse x -> DisableKeyResponse

Read DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

readsPrec :: Int -> ReadS DisableKeyResponse

readList :: ReadS [DisableKeyResponse]

readPrec :: ReadPrec DisableKeyResponse

readListPrec :: ReadPrec [DisableKeyResponse]

Show DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

showsPrec :: Int -> DisableKeyResponse -> ShowS

show :: DisableKeyResponse -> String

showList :: [DisableKeyResponse] -> ShowS

NFData DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

rnf :: DisableKeyResponse -> ()

Eq DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

Methods

(==) :: DisableKeyResponse -> DisableKeyResponse -> Bool

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

type Rep DisableKeyResponse

Defined in Amazonka.KMS.DisableKey

type Rep DisableKeyResponse = D1 ('MetaData "DisableKeyResponse" "Amazonka.KMS.DisableKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisableKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableKeyResponse :: DisableKeyResponse

Create a value of DisableKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DisableKeyRotation

data DisableKeyRotation

See: newDisableKeyRotation smart constructor.

Constructors

DisableKeyRotation' Text

Instances

ToJSON DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

toJSON :: DisableKeyRotation -> Value

toEncoding :: DisableKeyRotation -> Encoding

toJSONList :: [DisableKeyRotation] -> Value

toEncodingList :: [DisableKeyRotation] -> Encoding

ToHeaders DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

toHeaders :: DisableKeyRotation -> [Header]

ToPath DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

toPath :: DisableKeyRotation -> ByteString

ToQuery DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

toQuery :: DisableKeyRotation -> QueryString

AWSRequest DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Associated Types

type AWSResponse DisableKeyRotation

Methods

request :: (Service -> Service) -> DisableKeyRotation -> Request DisableKeyRotation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisableKeyRotation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisableKeyRotation)))

Generic DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Associated Types

type Rep DisableKeyRotation :: Type -> Type

Methods

from :: DisableKeyRotation -> Rep DisableKeyRotation x

to :: Rep DisableKeyRotation x -> DisableKeyRotation

Read DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

readsPrec :: Int -> ReadS DisableKeyRotation

readList :: ReadS [DisableKeyRotation]

readPrec :: ReadPrec DisableKeyRotation

readListPrec :: ReadPrec [DisableKeyRotation]

Show DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

showsPrec :: Int -> DisableKeyRotation -> ShowS

show :: DisableKeyRotation -> String

showList :: [DisableKeyRotation] -> ShowS

NFData DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

rnf :: DisableKeyRotation -> ()

Eq DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

(==) :: DisableKeyRotation -> DisableKeyRotation -> Bool

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

Hashable DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

Methods

hashWithSalt :: Int -> DisableKeyRotation -> Int

hash :: DisableKeyRotation -> Int

type AWSResponse DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

type AWSResponse DisableKeyRotation = DisableKeyRotationResponse

type Rep DisableKeyRotation

Defined in Amazonka.KMS.DisableKeyRotation

type Rep DisableKeyRotation = D1 ('MetaData "DisableKeyRotation" "Amazonka.KMS.DisableKeyRotation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisableKeyRotation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDisableKeyRotation

Arguments

:: Text

DisableKeyRotation

-> DisableKeyRotation

Create a value of DisableKeyRotation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DisableKeyRotation, disableKeyRotation_keyId - Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data DisableKeyRotationResponse

See: newDisableKeyRotationResponse smart constructor.

Constructors

DisableKeyRotationResponse'

Instances

Generic DisableKeyRotationResponse

Defined in Amazonka.KMS.DisableKeyRotation

Associated Types

type Rep DisableKeyRotationResponse :: Type -> Type

Methods

from :: DisableKeyRotationResponse -> Rep DisableKeyRotationResponse x

to :: Rep DisableKeyRotationResponse x -> DisableKeyRotationResponse

Read DisableKeyRotationResponse

Defined in Amazonka.KMS.DisableKeyRotation

Methods

readsPrec :: Int -> ReadS DisableKeyRotationResponse

readList :: ReadS [DisableKeyRotationResponse]

readPrec :: ReadPrec DisableKeyRotationResponse

readListPrec :: ReadPrec [DisableKeyRotationResponse]

Show DisableKeyRotationResponse

Defined in Amazonka.KMS.DisableKeyRotation

Methods

showsPrec :: Int -> DisableKeyRotationResponse -> ShowS

show :: DisableKeyRotationResponse -> String

showList :: [DisableKeyRotationResponse] -> ShowS

NFData DisableKeyRotationResponse

Defined in Amazonka.KMS.DisableKeyRotation

Methods

rnf :: DisableKeyRotationResponse -> ()

Eq DisableKeyRotationResponse

Defined in Amazonka.KMS.DisableKeyRotation

Methods

(==) :: DisableKeyRotationResponse -> DisableKeyRotationResponse -> Bool

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

type Rep DisableKeyRotationResponse

Defined in Amazonka.KMS.DisableKeyRotation

type Rep DisableKeyRotationResponse = D1 ('MetaData "DisableKeyRotationResponse" "Amazonka.KMS.DisableKeyRotation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisableKeyRotationResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableKeyRotationResponse :: DisableKeyRotationResponse

Create a value of DisableKeyRotationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DisconnectCustomKeyStore

data DisconnectCustomKeyStore

See: newDisconnectCustomKeyStore smart constructor.

Constructors

DisconnectCustomKeyStore' Text

Instances

ToJSON DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

toJSON :: DisconnectCustomKeyStore -> Value

toEncoding :: DisconnectCustomKeyStore -> Encoding

toJSONList :: [DisconnectCustomKeyStore] -> Value

toEncodingList :: [DisconnectCustomKeyStore] -> Encoding

ToHeaders DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

toHeaders :: DisconnectCustomKeyStore -> [Header]

ToPath DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

toPath :: DisconnectCustomKeyStore -> ByteString

ToQuery DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

toQuery :: DisconnectCustomKeyStore -> QueryString

AWSRequest DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Associated Types

type AWSResponse DisconnectCustomKeyStore

Methods

request :: (Service -> Service) -> DisconnectCustomKeyStore -> Request DisconnectCustomKeyStore

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisconnectCustomKeyStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisconnectCustomKeyStore)))

Generic DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Associated Types

type Rep DisconnectCustomKeyStore :: Type -> Type

Methods

from :: DisconnectCustomKeyStore -> Rep DisconnectCustomKeyStore x

to :: Rep DisconnectCustomKeyStore x -> DisconnectCustomKeyStore

Read DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

readsPrec :: Int -> ReadS DisconnectCustomKeyStore

readList :: ReadS [DisconnectCustomKeyStore]

readPrec :: ReadPrec DisconnectCustomKeyStore

readListPrec :: ReadPrec [DisconnectCustomKeyStore]

Show DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

showsPrec :: Int -> DisconnectCustomKeyStore -> ShowS

show :: DisconnectCustomKeyStore -> String

showList :: [DisconnectCustomKeyStore] -> ShowS

NFData DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

rnf :: DisconnectCustomKeyStore -> ()

Eq DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

(==) :: DisconnectCustomKeyStore -> DisconnectCustomKeyStore -> Bool

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

Hashable DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

hashWithSalt :: Int -> DisconnectCustomKeyStore -> Int

hash :: DisconnectCustomKeyStore -> Int

type AWSResponse DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type AWSResponse DisconnectCustomKeyStore = DisconnectCustomKeyStoreResponse

type Rep DisconnectCustomKeyStore

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type Rep DisconnectCustomKeyStore = D1 ('MetaData "DisconnectCustomKeyStore" "Amazonka.KMS.DisconnectCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisconnectCustomKeyStore'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDisconnectCustomKeyStore

Arguments

:: Text

DisconnectCustomKeyStore

-> DisconnectCustomKeyStore

Create a value of DisconnectCustomKeyStore with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DisconnectCustomKeyStore, disconnectCustomKeyStore_customKeyStoreId - Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

data DisconnectCustomKeyStoreResponse

See: newDisconnectCustomKeyStoreResponse smart constructor.

Constructors

DisconnectCustomKeyStoreResponse' Int

Instances

Generic DisconnectCustomKeyStoreResponse

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Associated Types

type Rep DisconnectCustomKeyStoreResponse :: Type -> Type

Methods

from :: DisconnectCustomKeyStoreResponse -> Rep DisconnectCustomKeyStoreResponse x

to :: Rep DisconnectCustomKeyStoreResponse x -> DisconnectCustomKeyStoreResponse

Read DisconnectCustomKeyStoreResponse

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

readsPrec :: Int -> ReadS DisconnectCustomKeyStoreResponse

readList :: ReadS [DisconnectCustomKeyStoreResponse]

readPrec :: ReadPrec DisconnectCustomKeyStoreResponse

readListPrec :: ReadPrec [DisconnectCustomKeyStoreResponse]

Show DisconnectCustomKeyStoreResponse

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

showsPrec :: Int -> DisconnectCustomKeyStoreResponse -> ShowS

show :: DisconnectCustomKeyStoreResponse -> String

showList :: [DisconnectCustomKeyStoreResponse] -> ShowS

NFData DisconnectCustomKeyStoreResponse

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

rnf :: DisconnectCustomKeyStoreResponse -> ()

Eq DisconnectCustomKeyStoreResponse

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Methods

(==) :: DisconnectCustomKeyStoreResponse -> DisconnectCustomKeyStoreResponse -> Bool

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

type Rep DisconnectCustomKeyStoreResponse

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type Rep DisconnectCustomKeyStoreResponse = D1 ('MetaData "DisconnectCustomKeyStoreResponse" "Amazonka.KMS.DisconnectCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisconnectCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisconnectCustomKeyStoreResponse

Arguments

:: Int

$sel:httpStatus:DisconnectCustomKeyStoreResponse'

-> DisconnectCustomKeyStoreResponse

Create a value of DisconnectCustomKeyStoreResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DisconnectCustomKeyStoreResponse', disconnectCustomKeyStoreResponse_httpStatus - The response's http status code.

EnableKey

data EnableKey

See: newEnableKey smart constructor.

Constructors

EnableKey' Text

Instances

ToJSON EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

toJSON :: EnableKey -> Value

toEncoding :: EnableKey -> Encoding

toJSONList :: [EnableKey] -> Value

toEncodingList :: [EnableKey] -> Encoding

ToHeaders EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

toHeaders :: EnableKey -> [Header]

ToPath EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

toPath :: EnableKey -> ByteString

ToQuery EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

toQuery :: EnableKey -> QueryString

AWSRequest EnableKey

Defined in Amazonka.KMS.EnableKey

Associated Types

type AWSResponse EnableKey

Methods

request :: (Service -> Service) -> EnableKey -> Request EnableKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableKey)))

Generic EnableKey

Defined in Amazonka.KMS.EnableKey

Associated Types

type Rep EnableKey :: Type -> Type

Methods

from :: EnableKey -> Rep EnableKey x

to :: Rep EnableKey x -> EnableKey

Read EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

readsPrec :: Int -> ReadS EnableKey

readList :: ReadS [EnableKey]

readPrec :: ReadPrec EnableKey

readListPrec :: ReadPrec [EnableKey]

Show EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

showsPrec :: Int -> EnableKey -> ShowS

show :: EnableKey -> String

showList :: [EnableKey] -> ShowS

NFData EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

rnf :: EnableKey -> ()

Eq EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

(==) :: EnableKey -> EnableKey -> Bool

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

Hashable EnableKey

Defined in Amazonka.KMS.EnableKey

Methods

hashWithSalt :: Int -> EnableKey -> Int

hash :: EnableKey -> Int

type AWSResponse EnableKey

Defined in Amazonka.KMS.EnableKey

type AWSResponse EnableKey = EnableKeyResponse

type Rep EnableKey

Defined in Amazonka.KMS.EnableKey

type Rep EnableKey = D1 ('MetaData "EnableKey" "Amazonka.KMS.EnableKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "EnableKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEnableKey

Arguments

:: Text

EnableKey

-> EnableKey

Create a value of EnableKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

EnableKey, enableKey_keyId - Identifies the KMS key to enable.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data EnableKeyResponse

See: newEnableKeyResponse smart constructor.

Constructors

EnableKeyResponse'

Instances

Generic EnableKeyResponse

Defined in Amazonka.KMS.EnableKey

Associated Types

type Rep EnableKeyResponse :: Type -> Type

Methods

from :: EnableKeyResponse -> Rep EnableKeyResponse x

to :: Rep EnableKeyResponse x -> EnableKeyResponse

Read EnableKeyResponse

Defined in Amazonka.KMS.EnableKey

Methods

readsPrec :: Int -> ReadS EnableKeyResponse

readList :: ReadS [EnableKeyResponse]

readPrec :: ReadPrec EnableKeyResponse

readListPrec :: ReadPrec [EnableKeyResponse]

Show EnableKeyResponse

Defined in Amazonka.KMS.EnableKey

Methods

showsPrec :: Int -> EnableKeyResponse -> ShowS

show :: EnableKeyResponse -> String

showList :: [EnableKeyResponse] -> ShowS

NFData EnableKeyResponse

Defined in Amazonka.KMS.EnableKey

Methods

rnf :: EnableKeyResponse -> ()

Eq EnableKeyResponse

Defined in Amazonka.KMS.EnableKey

Methods

(==) :: EnableKeyResponse -> EnableKeyResponse -> Bool

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

type Rep EnableKeyResponse

Defined in Amazonka.KMS.EnableKey

type Rep EnableKeyResponse = D1 ('MetaData "EnableKeyResponse" "Amazonka.KMS.EnableKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "EnableKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newEnableKeyResponse :: EnableKeyResponse

Create a value of EnableKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

EnableKeyRotation

data EnableKeyRotation

See: newEnableKeyRotation smart constructor.

Constructors

EnableKeyRotation' Text

Instances

ToJSON EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toJSON :: EnableKeyRotation -> Value

toEncoding :: EnableKeyRotation -> Encoding

toJSONList :: [EnableKeyRotation] -> Value

toEncodingList :: [EnableKeyRotation] -> Encoding

ToHeaders EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toHeaders :: EnableKeyRotation -> [Header]

ToPath EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toPath :: EnableKeyRotation -> ByteString

ToQuery EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

toQuery :: EnableKeyRotation -> QueryString

AWSRequest EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Associated Types

type AWSResponse EnableKeyRotation

Methods

request :: (Service -> Service) -> EnableKeyRotation -> Request EnableKeyRotation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableKeyRotation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableKeyRotation)))

Generic EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Associated Types

type Rep EnableKeyRotation :: Type -> Type

Methods

from :: EnableKeyRotation -> Rep EnableKeyRotation x

to :: Rep EnableKeyRotation x -> EnableKeyRotation

Read EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

readsPrec :: Int -> ReadS EnableKeyRotation

readList :: ReadS [EnableKeyRotation]

readPrec :: ReadPrec EnableKeyRotation

readListPrec :: ReadPrec [EnableKeyRotation]

Show EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

showsPrec :: Int -> EnableKeyRotation -> ShowS

show :: EnableKeyRotation -> String

showList :: [EnableKeyRotation] -> ShowS

NFData EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

rnf :: EnableKeyRotation -> ()

Eq EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

(==) :: EnableKeyRotation -> EnableKeyRotation -> Bool

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

Hashable EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

Methods

hashWithSalt :: Int -> EnableKeyRotation -> Int

hash :: EnableKeyRotation -> Int

type AWSResponse EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

type AWSResponse EnableKeyRotation = EnableKeyRotationResponse

type Rep EnableKeyRotation

Defined in Amazonka.KMS.EnableKeyRotation

type Rep EnableKeyRotation = D1 ('MetaData "EnableKeyRotation" "Amazonka.KMS.EnableKeyRotation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "EnableKeyRotation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEnableKeyRotation

Arguments

:: Text

EnableKeyRotation

-> EnableKeyRotation

Create a value of EnableKeyRotation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

EnableKeyRotation, enableKeyRotation_keyId - Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data EnableKeyRotationResponse

See: newEnableKeyRotationResponse smart constructor.

Constructors

EnableKeyRotationResponse'

Instances

Generic EnableKeyRotationResponse

Defined in Amazonka.KMS.EnableKeyRotation

Associated Types

type Rep EnableKeyRotationResponse :: Type -> Type

Methods

from :: EnableKeyRotationResponse -> Rep EnableKeyRotationResponse x

to :: Rep EnableKeyRotationResponse x -> EnableKeyRotationResponse

Read EnableKeyRotationResponse

Defined in Amazonka.KMS.EnableKeyRotation

Methods

readsPrec :: Int -> ReadS EnableKeyRotationResponse

readList :: ReadS [EnableKeyRotationResponse]

readPrec :: ReadPrec EnableKeyRotationResponse

readListPrec :: ReadPrec [EnableKeyRotationResponse]

Show EnableKeyRotationResponse

Defined in Amazonka.KMS.EnableKeyRotation

Methods

showsPrec :: Int -> EnableKeyRotationResponse -> ShowS

show :: EnableKeyRotationResponse -> String

showList :: [EnableKeyRotationResponse] -> ShowS

NFData EnableKeyRotationResponse

Defined in Amazonka.KMS.EnableKeyRotation

Methods

rnf :: EnableKeyRotationResponse -> ()

Eq EnableKeyRotationResponse

Defined in Amazonka.KMS.EnableKeyRotation

Methods

(==) :: EnableKeyRotationResponse -> EnableKeyRotationResponse -> Bool

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

type Rep EnableKeyRotationResponse

Defined in Amazonka.KMS.EnableKeyRotation

type Rep EnableKeyRotationResponse = D1 ('MetaData "EnableKeyRotationResponse" "Amazonka.KMS.EnableKeyRotation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "EnableKeyRotationResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newEnableKeyRotationResponse :: EnableKeyRotationResponse

Create a value of EnableKeyRotationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Encrypt

data Encrypt

See: newEncrypt smart constructor.

Constructors

Encrypt' (Maybe EncryptionAlgorithmSpec) (Maybe (HashMap Text Text)) (Maybe [Text]) Text (Sensitive Base64)

Instances

ToJSON Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

toJSON :: Encrypt -> Value

toEncoding :: Encrypt -> Encoding

toJSONList :: [Encrypt] -> Value

toEncodingList :: [Encrypt] -> Encoding

ToHeaders Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

toHeaders :: Encrypt -> [Header]

ToPath Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

toPath :: Encrypt -> ByteString

ToQuery Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

toQuery :: Encrypt -> QueryString

AWSRequest Encrypt

Defined in Amazonka.KMS.Encrypt

Associated Types

type AWSResponse Encrypt

Methods

request :: (Service -> Service) -> Encrypt -> Request Encrypt

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Encrypt -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Encrypt)))

Generic Encrypt

Defined in Amazonka.KMS.Encrypt

Associated Types

type Rep Encrypt :: Type -> Type

Methods

from :: Encrypt -> Rep Encrypt x

to :: Rep Encrypt x -> Encrypt

Show Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

showsPrec :: Int -> Encrypt -> ShowS

show :: Encrypt -> String

showList :: [Encrypt] -> ShowS

NFData Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

rnf :: Encrypt -> ()

Eq Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

(==) :: Encrypt -> Encrypt -> Bool

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

Hashable Encrypt

Defined in Amazonka.KMS.Encrypt

Methods

hashWithSalt :: Int -> Encrypt -> Int

hash :: Encrypt -> Int

type AWSResponse Encrypt

Defined in Amazonka.KMS.Encrypt

type AWSResponse Encrypt = EncryptResponse

type Rep Encrypt

Defined in Amazonka.KMS.Encrypt

type Rep Encrypt = D1 ('MetaData "Encrypt" "Amazonka.KMS.Encrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Encrypt'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "plaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64))))))

newEncrypt

Arguments

:: Text

Encrypt

-> ByteString

$sel:plaintext:Encrypt'

-> Encrypt

Create a value of Encrypt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Encrypt, encrypt_encryptionAlgorithm - Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

The SM2PKE algorithm is only available in China Regions.

$sel:encryptionContext:Encrypt', encrypt_encryptionContext - Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:Encrypt', encrypt_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Encrypt, encrypt_keyId - Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

$sel:plaintext:Encrypt', encrypt_plaintext - 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.

data EncryptResponse

See: newEncryptResponse smart constructor.

Constructors

EncryptResponse' (Maybe Base64) (Maybe EncryptionAlgorithmSpec) (Maybe Text) Int

Instances

Generic EncryptResponse

Defined in Amazonka.KMS.Encrypt

Associated Types

type Rep EncryptResponse :: Type -> Type

Methods

from :: EncryptResponse -> Rep EncryptResponse x

to :: Rep EncryptResponse x -> EncryptResponse

Read EncryptResponse

Defined in Amazonka.KMS.Encrypt

Methods

readsPrec :: Int -> ReadS EncryptResponse

readList :: ReadS [EncryptResponse]

readPrec :: ReadPrec EncryptResponse

readListPrec :: ReadPrec [EncryptResponse]

Show EncryptResponse

Defined in Amazonka.KMS.Encrypt

Methods

showsPrec :: Int -> EncryptResponse -> ShowS

show :: EncryptResponse -> String

showList :: [EncryptResponse] -> ShowS

NFData EncryptResponse

Defined in Amazonka.KMS.Encrypt

Methods

rnf :: EncryptResponse -> ()

Eq EncryptResponse

Defined in Amazonka.KMS.Encrypt

Methods

(==) :: EncryptResponse -> EncryptResponse -> Bool

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

type Rep EncryptResponse

Defined in Amazonka.KMS.Encrypt

type Rep EncryptResponse = D1 ('MetaData "EncryptResponse" "Amazonka.KMS.Encrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "EncryptResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "encryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newEncryptResponse

Arguments

:: Int

$sel:httpStatus:EncryptResponse'

-> EncryptResponse

Create a value of EncryptResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ciphertextBlob:EncryptResponse', encryptResponse_ciphertextBlob - The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

Encrypt, encryptResponse_encryptionAlgorithm - The encryption algorithm that was used to encrypt the plaintext.

Encrypt, encryptResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

$sel:httpStatus:EncryptResponse', encryptResponse_httpStatus - The response's http status code.

GenerateDataKey

data GenerateDataKey

See: newGenerateDataKey smart constructor.

Constructors

GenerateDataKey' (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe DataKeySpec) (Maybe Natural) Text

Instances

ToJSON GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

toJSON :: GenerateDataKey -> Value

toEncoding :: GenerateDataKey -> Encoding

toJSONList :: [GenerateDataKey] -> Value

toEncodingList :: [GenerateDataKey] -> Encoding

ToHeaders GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

toHeaders :: GenerateDataKey -> [Header]

ToPath GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

toPath :: GenerateDataKey -> ByteString

ToQuery GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

toQuery :: GenerateDataKey -> QueryString

AWSRequest GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Associated Types

type AWSResponse GenerateDataKey

Methods

request :: (Service -> Service) -> GenerateDataKey -> Request GenerateDataKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateDataKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateDataKey)))

Generic GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Associated Types

type Rep GenerateDataKey :: Type -> Type

Methods

from :: GenerateDataKey -> Rep GenerateDataKey x

to :: Rep GenerateDataKey x -> GenerateDataKey

Read GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

readsPrec :: Int -> ReadS GenerateDataKey

readList :: ReadS [GenerateDataKey]

readPrec :: ReadPrec GenerateDataKey

readListPrec :: ReadPrec [GenerateDataKey]

Show GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

showsPrec :: Int -> GenerateDataKey -> ShowS

show :: GenerateDataKey -> String

showList :: [GenerateDataKey] -> ShowS

NFData GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

rnf :: GenerateDataKey -> ()

Eq GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

(==) :: GenerateDataKey -> GenerateDataKey -> Bool

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

Hashable GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

Methods

hashWithSalt :: Int -> GenerateDataKey -> Int

hash :: GenerateDataKey -> Int

type AWSResponse GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

type AWSResponse GenerateDataKey = GenerateDataKeyResponse

type Rep GenerateDataKey

Defined in Amazonka.KMS.GenerateDataKey

type Rep GenerateDataKey = D1 ('MetaData "GenerateDataKey" "Amazonka.KMS.GenerateDataKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "keySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataKeySpec)) :*: (S1 ('MetaSel ('Just "numberOfBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGenerateDataKey

Arguments

:: Text

GenerateDataKey

-> GenerateDataKey

Create a value of GenerateDataKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionContext:GenerateDataKey', generateDataKey_encryptionContext - Specifies the encryption context that will be used when encrypting the data key.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:GenerateDataKey', generateDataKey_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

GenerateDataKey, generateDataKey_keySpec - Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

$sel:numberOfBytes:GenerateDataKey', generateDataKey_numberOfBytes - Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

GenerateDataKey, generateDataKey_keyId - Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

data GenerateDataKeyResponse

See: newGenerateDataKeyResponse smart constructor.

Constructors

GenerateDataKeyResponse' Int Text (Sensitive Base64) Base64

Instances

Generic GenerateDataKeyResponse

Defined in Amazonka.KMS.GenerateDataKey

Associated Types

type Rep GenerateDataKeyResponse :: Type -> Type

Methods

from :: GenerateDataKeyResponse -> Rep GenerateDataKeyResponse x

to :: Rep GenerateDataKeyResponse x -> GenerateDataKeyResponse

Show GenerateDataKeyResponse

Defined in Amazonka.KMS.GenerateDataKey

Methods

showsPrec :: Int -> GenerateDataKeyResponse -> ShowS

show :: GenerateDataKeyResponse -> String

showList :: [GenerateDataKeyResponse] -> ShowS

NFData GenerateDataKeyResponse

Defined in Amazonka.KMS.GenerateDataKey

Methods

rnf :: GenerateDataKeyResponse -> ()

Eq GenerateDataKeyResponse

Defined in Amazonka.KMS.GenerateDataKey

Methods

(==) :: GenerateDataKeyResponse -> GenerateDataKeyResponse -> Bool

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

type Rep GenerateDataKeyResponse

Defined in Amazonka.KMS.GenerateDataKey

type Rep GenerateDataKeyResponse = D1 ('MetaData "GenerateDataKeyResponse" "Amazonka.KMS.GenerateDataKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "plaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64)) :*: S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64))))

newGenerateDataKeyResponse

Arguments

:: Int

$sel:httpStatus:GenerateDataKeyResponse'

-> Text

GenerateDataKey

-> ByteString

$sel:plaintext:GenerateDataKeyResponse'

-> ByteString

$sel:ciphertextBlob:GenerateDataKeyResponse'

-> GenerateDataKeyResponse

Create a value of GenerateDataKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GenerateDataKeyResponse', generateDataKeyResponse_httpStatus - The response's http status code.

GenerateDataKey, generateDataKeyResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

$sel:plaintext:GenerateDataKeyResponse', generateDataKeyResponse_plaintext - The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. 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.

$sel:ciphertextBlob:GenerateDataKeyResponse', generateDataKeyResponse_ciphertextBlob - The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

GenerateDataKeyPair

data GenerateDataKeyPair

See: newGenerateDataKeyPair smart constructor.

Constructors

GenerateDataKeyPair' (Maybe (HashMap Text Text)) (Maybe [Text]) Text DataKeyPairSpec

Instances

ToJSON GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

toJSON :: GenerateDataKeyPair -> Value

toEncoding :: GenerateDataKeyPair -> Encoding

toJSONList :: [GenerateDataKeyPair] -> Value

toEncodingList :: [GenerateDataKeyPair] -> Encoding

ToHeaders GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

toHeaders :: GenerateDataKeyPair -> [Header]

ToPath GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

toPath :: GenerateDataKeyPair -> ByteString

ToQuery GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

toQuery :: GenerateDataKeyPair -> QueryString

AWSRequest GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Associated Types

type AWSResponse GenerateDataKeyPair

Methods

request :: (Service -> Service) -> GenerateDataKeyPair -> Request GenerateDataKeyPair

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateDataKeyPair -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateDataKeyPair)))

Generic GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Associated Types

type Rep GenerateDataKeyPair :: Type -> Type

Methods

from :: GenerateDataKeyPair -> Rep GenerateDataKeyPair x

to :: Rep GenerateDataKeyPair x -> GenerateDataKeyPair

Read GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

readsPrec :: Int -> ReadS GenerateDataKeyPair

readList :: ReadS [GenerateDataKeyPair]

readPrec :: ReadPrec GenerateDataKeyPair

readListPrec :: ReadPrec [GenerateDataKeyPair]

Show GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

showsPrec :: Int -> GenerateDataKeyPair -> ShowS

show :: GenerateDataKeyPair -> String

showList :: [GenerateDataKeyPair] -> ShowS

NFData GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

rnf :: GenerateDataKeyPair -> ()

Eq GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

(==) :: GenerateDataKeyPair -> GenerateDataKeyPair -> Bool

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

Hashable GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

hashWithSalt :: Int -> GenerateDataKeyPair -> Int

hash :: GenerateDataKeyPair -> Int

type AWSResponse GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

type AWSResponse GenerateDataKeyPair = GenerateDataKeyPairResponse

type Rep GenerateDataKeyPair

Defined in Amazonka.KMS.GenerateDataKeyPair

type Rep GenerateDataKeyPair = D1 ('MetaData "GenerateDataKeyPair" "Amazonka.KMS.GenerateDataKeyPair" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyPair'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyPairSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataKeyPairSpec))))

newGenerateDataKeyPair

Arguments

:: Text

GenerateDataKeyPair

-> DataKeyPairSpec

GenerateDataKeyPair

-> GenerateDataKeyPair

Create a value of GenerateDataKeyPair with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionContext:GenerateDataKeyPair', generateDataKeyPair_encryptionContext - Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:GenerateDataKeyPair', generateDataKeyPair_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

GenerateDataKeyPair, generateDataKeyPair_keyId - Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

GenerateDataKeyPair, generateDataKeyPair_keyPairSpec - Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

data GenerateDataKeyPairResponse

See: newGenerateDataKeyPairResponse smart constructor.

Constructors

GenerateDataKeyPairResponse' (Maybe Text) (Maybe DataKeyPairSpec) (Maybe Base64) (Maybe (Sensitive Base64)) (Maybe Base64) Int

Instances

Generic GenerateDataKeyPairResponse

Defined in Amazonka.KMS.GenerateDataKeyPair

Associated Types

type Rep GenerateDataKeyPairResponse :: Type -> Type

Methods

from :: GenerateDataKeyPairResponse -> Rep GenerateDataKeyPairResponse x

to :: Rep GenerateDataKeyPairResponse x -> GenerateDataKeyPairResponse

Show GenerateDataKeyPairResponse

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

showsPrec :: Int -> GenerateDataKeyPairResponse -> ShowS

show :: GenerateDataKeyPairResponse -> String

showList :: [GenerateDataKeyPairResponse] -> ShowS

NFData GenerateDataKeyPairResponse

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

rnf :: GenerateDataKeyPairResponse -> ()

Eq GenerateDataKeyPairResponse

Defined in Amazonka.KMS.GenerateDataKeyPair

Methods

(==) :: GenerateDataKeyPairResponse -> GenerateDataKeyPairResponse -> Bool

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

type Rep GenerateDataKeyPairResponse

Defined in Amazonka.KMS.GenerateDataKeyPair

type Rep GenerateDataKeyPairResponse = D1 ('MetaData "GenerateDataKeyPairResponse" "Amazonka.KMS.GenerateDataKeyPair" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyPairResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "keyPairSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataKeyPairSpec)) :*: S1 ('MetaSel ('Just "privateKeyCiphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) :*: (S1 ('MetaSel ('Just "privateKeyPlaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: (S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGenerateDataKeyPairResponse

Arguments

:: Int

$sel:httpStatus:GenerateDataKeyPairResponse'

-> GenerateDataKeyPairResponse

Create a value of GenerateDataKeyPairResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GenerateDataKeyPair, generateDataKeyPairResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

GenerateDataKeyPair, generateDataKeyPairResponse_keyPairSpec - The type of data key pair that was generated.

$sel:privateKeyCiphertextBlob:GenerateDataKeyPairResponse', generateDataKeyPairResponse_privateKeyCiphertextBlob - The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:privateKeyPlaintext:GenerateDataKeyPairResponse', generateDataKeyPairResponse_privateKeyPlaintext - The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:publicKey:GenerateDataKeyPairResponse', generateDataKeyPairResponse_publicKey - The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:httpStatus:GenerateDataKeyPairResponse', generateDataKeyPairResponse_httpStatus - The response's http status code.

GenerateDataKeyPairWithoutPlaintext

data GenerateDataKeyPairWithoutPlaintext

See: newGenerateDataKeyPairWithoutPlaintext smart constructor.

Constructors

GenerateDataKeyPairWithoutPlaintext' (Maybe (HashMap Text Text)) (Maybe [Text]) Text DataKeyPairSpec

Instances

ToJSON GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

toJSON :: GenerateDataKeyPairWithoutPlaintext -> Value

toEncoding :: GenerateDataKeyPairWithoutPlaintext -> Encoding

toJSONList :: [GenerateDataKeyPairWithoutPlaintext] -> Value

toEncodingList :: [GenerateDataKeyPairWithoutPlaintext] -> Encoding

ToHeaders GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

toHeaders :: GenerateDataKeyPairWithoutPlaintext -> [Header]

ToPath GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

toPath :: GenerateDataKeyPairWithoutPlaintext -> ByteString

ToQuery GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

toQuery :: GenerateDataKeyPairWithoutPlaintext -> QueryString

AWSRequest GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Associated Types

type AWSResponse GenerateDataKeyPairWithoutPlaintext

Methods

request :: (Service -> Service) -> GenerateDataKeyPairWithoutPlaintext -> Request GenerateDataKeyPairWithoutPlaintext

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateDataKeyPairWithoutPlaintext -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateDataKeyPairWithoutPlaintext)))

Generic GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Associated Types

type Rep GenerateDataKeyPairWithoutPlaintext :: Type -> Type

Methods

from :: GenerateDataKeyPairWithoutPlaintext -> Rep GenerateDataKeyPairWithoutPlaintext x

to :: Rep GenerateDataKeyPairWithoutPlaintext x -> GenerateDataKeyPairWithoutPlaintext

Read GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

readsPrec :: Int -> ReadS GenerateDataKeyPairWithoutPlaintext

readList :: ReadS [GenerateDataKeyPairWithoutPlaintext]

readPrec :: ReadPrec GenerateDataKeyPairWithoutPlaintext

readListPrec :: ReadPrec [GenerateDataKeyPairWithoutPlaintext]

Show GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

showsPrec :: Int -> GenerateDataKeyPairWithoutPlaintext -> ShowS

show :: GenerateDataKeyPairWithoutPlaintext -> String

showList :: [GenerateDataKeyPairWithoutPlaintext] -> ShowS

NFData GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

rnf :: GenerateDataKeyPairWithoutPlaintext -> ()

Eq GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

(==) :: GenerateDataKeyPairWithoutPlaintext -> GenerateDataKeyPairWithoutPlaintext -> Bool

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

Hashable GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

hashWithSalt :: Int -> GenerateDataKeyPairWithoutPlaintext -> Int

hash :: GenerateDataKeyPairWithoutPlaintext -> Int

type AWSResponse GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

type AWSResponse GenerateDataKeyPairWithoutPlaintext = GenerateDataKeyPairWithoutPlaintextResponse

type Rep GenerateDataKeyPairWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

type Rep GenerateDataKeyPairWithoutPlaintext = D1 ('MetaData "GenerateDataKeyPairWithoutPlaintext" "Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyPairWithoutPlaintext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyPairSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataKeyPairSpec))))

newGenerateDataKeyPairWithoutPlaintext

Arguments

:: Text

GenerateDataKeyPairWithoutPlaintext

-> DataKeyPairSpec

GenerateDataKeyPairWithoutPlaintext

-> GenerateDataKeyPairWithoutPlaintext

Create a value of GenerateDataKeyPairWithoutPlaintext with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionContext:GenerateDataKeyPairWithoutPlaintext', generateDataKeyPairWithoutPlaintext_encryptionContext - Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:GenerateDataKeyPairWithoutPlaintext', generateDataKeyPairWithoutPlaintext_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

GenerateDataKeyPairWithoutPlaintext, generateDataKeyPairWithoutPlaintext_keyId - Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

GenerateDataKeyPairWithoutPlaintext, generateDataKeyPairWithoutPlaintext_keyPairSpec - Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

data GenerateDataKeyPairWithoutPlaintextResponse

See: newGenerateDataKeyPairWithoutPlaintextResponse smart constructor.

Constructors

GenerateDataKeyPairWithoutPlaintextResponse' (Maybe Text) (Maybe DataKeyPairSpec) (Maybe Base64) (Maybe Base64) Int

Instances

Generic GenerateDataKeyPairWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Associated Types

type Rep GenerateDataKeyPairWithoutPlaintextResponse :: Type -> Type

Methods

from :: GenerateDataKeyPairWithoutPlaintextResponse -> Rep GenerateDataKeyPairWithoutPlaintextResponse x

to :: Rep GenerateDataKeyPairWithoutPlaintextResponse x -> GenerateDataKeyPairWithoutPlaintextResponse

Read GenerateDataKeyPairWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

readsPrec :: Int -> ReadS GenerateDataKeyPairWithoutPlaintextResponse

readList :: ReadS [GenerateDataKeyPairWithoutPlaintextResponse]

readPrec :: ReadPrec GenerateDataKeyPairWithoutPlaintextResponse

readListPrec :: ReadPrec [GenerateDataKeyPairWithoutPlaintextResponse]

Show GenerateDataKeyPairWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

showsPrec :: Int -> GenerateDataKeyPairWithoutPlaintextResponse -> ShowS

show :: GenerateDataKeyPairWithoutPlaintextResponse -> String

showList :: [GenerateDataKeyPairWithoutPlaintextResponse] -> ShowS

NFData GenerateDataKeyPairWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

rnf :: GenerateDataKeyPairWithoutPlaintextResponse -> ()

Eq GenerateDataKeyPairWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

Methods

(==) :: GenerateDataKeyPairWithoutPlaintextResponse -> GenerateDataKeyPairWithoutPlaintextResponse -> Bool

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

type Rep GenerateDataKeyPairWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext

type Rep GenerateDataKeyPairWithoutPlaintextResponse = D1 ('MetaData "GenerateDataKeyPairWithoutPlaintextResponse" "Amazonka.KMS.GenerateDataKeyPairWithoutPlaintext" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyPairWithoutPlaintextResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyPairSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataKeyPairSpec))) :*: (S1 ('MetaSel ('Just "privateKeyCiphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: (S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGenerateDataKeyPairWithoutPlaintextResponse

Arguments

:: Int

$sel:httpStatus:GenerateDataKeyPairWithoutPlaintextResponse'

-> GenerateDataKeyPairWithoutPlaintextResponse

Create a value of GenerateDataKeyPairWithoutPlaintextResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GenerateDataKeyPairWithoutPlaintext, generateDataKeyPairWithoutPlaintextResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

GenerateDataKeyPairWithoutPlaintext, generateDataKeyPairWithoutPlaintextResponse_keyPairSpec - The type of data key pair that was generated.

$sel:privateKeyCiphertextBlob:GenerateDataKeyPairWithoutPlaintextResponse', generateDataKeyPairWithoutPlaintextResponse_privateKeyCiphertextBlob - The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:publicKey:GenerateDataKeyPairWithoutPlaintextResponse', generateDataKeyPairWithoutPlaintextResponse_publicKey - The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:httpStatus:GenerateDataKeyPairWithoutPlaintextResponse', generateDataKeyPairWithoutPlaintextResponse_httpStatus - The response's http status code.

GenerateDataKeyWithoutPlaintext

data GenerateDataKeyWithoutPlaintext

See: newGenerateDataKeyWithoutPlaintext smart constructor.

Constructors

GenerateDataKeyWithoutPlaintext' (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe DataKeySpec) (Maybe Natural) Text

Instances

ToJSON GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

toJSON :: GenerateDataKeyWithoutPlaintext -> Value

toEncoding :: GenerateDataKeyWithoutPlaintext -> Encoding

toJSONList :: [GenerateDataKeyWithoutPlaintext] -> Value

toEncodingList :: [GenerateDataKeyWithoutPlaintext] -> Encoding

ToHeaders GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

toHeaders :: GenerateDataKeyWithoutPlaintext -> [Header]

ToPath GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

toPath :: GenerateDataKeyWithoutPlaintext -> ByteString

ToQuery GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

toQuery :: GenerateDataKeyWithoutPlaintext -> QueryString

AWSRequest GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Associated Types

type AWSResponse GenerateDataKeyWithoutPlaintext

Methods

request :: (Service -> Service) -> GenerateDataKeyWithoutPlaintext -> Request GenerateDataKeyWithoutPlaintext

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateDataKeyWithoutPlaintext -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateDataKeyWithoutPlaintext)))

Generic GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Associated Types

type Rep GenerateDataKeyWithoutPlaintext :: Type -> Type

Methods

from :: GenerateDataKeyWithoutPlaintext -> Rep GenerateDataKeyWithoutPlaintext x

to :: Rep GenerateDataKeyWithoutPlaintext x -> GenerateDataKeyWithoutPlaintext

Read GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

readsPrec :: Int -> ReadS GenerateDataKeyWithoutPlaintext

readList :: ReadS [GenerateDataKeyWithoutPlaintext]

readPrec :: ReadPrec GenerateDataKeyWithoutPlaintext

readListPrec :: ReadPrec [GenerateDataKeyWithoutPlaintext]

Show GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

showsPrec :: Int -> GenerateDataKeyWithoutPlaintext -> ShowS

show :: GenerateDataKeyWithoutPlaintext -> String

showList :: [GenerateDataKeyWithoutPlaintext] -> ShowS

NFData GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

rnf :: GenerateDataKeyWithoutPlaintext -> ()

Eq GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

(==) :: GenerateDataKeyWithoutPlaintext -> GenerateDataKeyWithoutPlaintext -> Bool

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

Hashable GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

hashWithSalt :: Int -> GenerateDataKeyWithoutPlaintext -> Int

hash :: GenerateDataKeyWithoutPlaintext -> Int

type AWSResponse GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

type AWSResponse GenerateDataKeyWithoutPlaintext = GenerateDataKeyWithoutPlaintextResponse

type Rep GenerateDataKeyWithoutPlaintext

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

type Rep GenerateDataKeyWithoutPlaintext = D1 ('MetaData "GenerateDataKeyWithoutPlaintext" "Amazonka.KMS.GenerateDataKeyWithoutPlaintext" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyWithoutPlaintext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "keySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataKeySpec)) :*: (S1 ('MetaSel ('Just "numberOfBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGenerateDataKeyWithoutPlaintext

Arguments

:: Text

GenerateDataKeyWithoutPlaintext

-> GenerateDataKeyWithoutPlaintext

Create a value of GenerateDataKeyWithoutPlaintext with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionContext:GenerateDataKeyWithoutPlaintext', generateDataKeyWithoutPlaintext_encryptionContext - Specifies the encryption context that will be used when encrypting the data key.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:GenerateDataKeyWithoutPlaintext', generateDataKeyWithoutPlaintext_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

GenerateDataKeyWithoutPlaintext, generateDataKeyWithoutPlaintext_keySpec - The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext', generateDataKeyWithoutPlaintext_numberOfBytes - The length of the data 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.

GenerateDataKeyWithoutPlaintext, generateDataKeyWithoutPlaintext_keyId - Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

data GenerateDataKeyWithoutPlaintextResponse

See: newGenerateDataKeyWithoutPlaintextResponse smart constructor.

Constructors

GenerateDataKeyWithoutPlaintextResponse' (Maybe Base64) (Maybe Text) Int

Instances

Generic GenerateDataKeyWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Associated Types

type Rep GenerateDataKeyWithoutPlaintextResponse :: Type -> Type

Methods

from :: GenerateDataKeyWithoutPlaintextResponse -> Rep GenerateDataKeyWithoutPlaintextResponse x

to :: Rep GenerateDataKeyWithoutPlaintextResponse x -> GenerateDataKeyWithoutPlaintextResponse

Read GenerateDataKeyWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

readsPrec :: Int -> ReadS GenerateDataKeyWithoutPlaintextResponse

readList :: ReadS [GenerateDataKeyWithoutPlaintextResponse]

readPrec :: ReadPrec GenerateDataKeyWithoutPlaintextResponse

readListPrec :: ReadPrec [GenerateDataKeyWithoutPlaintextResponse]

Show GenerateDataKeyWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

showsPrec :: Int -> GenerateDataKeyWithoutPlaintextResponse -> ShowS

show :: GenerateDataKeyWithoutPlaintextResponse -> String

showList :: [GenerateDataKeyWithoutPlaintextResponse] -> ShowS

NFData GenerateDataKeyWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

rnf :: GenerateDataKeyWithoutPlaintextResponse -> ()

Eq GenerateDataKeyWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

Methods

(==) :: GenerateDataKeyWithoutPlaintextResponse -> GenerateDataKeyWithoutPlaintextResponse -> Bool

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

type Rep GenerateDataKeyWithoutPlaintextResponse

Defined in Amazonka.KMS.GenerateDataKeyWithoutPlaintext

type Rep GenerateDataKeyWithoutPlaintextResponse = D1 ('MetaData "GenerateDataKeyWithoutPlaintextResponse" "Amazonka.KMS.GenerateDataKeyWithoutPlaintext" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateDataKeyWithoutPlaintextResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGenerateDataKeyWithoutPlaintextResponse

Arguments

:: Int

$sel:httpStatus:GenerateDataKeyWithoutPlaintextResponse'

-> GenerateDataKeyWithoutPlaintextResponse

Create a value of GenerateDataKeyWithoutPlaintextResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ciphertextBlob:GenerateDataKeyWithoutPlaintextResponse', generateDataKeyWithoutPlaintextResponse_ciphertextBlob - The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

GenerateDataKeyWithoutPlaintext, generateDataKeyWithoutPlaintextResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

$sel:httpStatus:GenerateDataKeyWithoutPlaintextResponse', generateDataKeyWithoutPlaintextResponse_httpStatus - The response's http status code.

GenerateMac

data GenerateMac

See: newGenerateMac smart constructor.

Constructors

GenerateMac' (Maybe [Text]) (Sensitive Base64) Text MacAlgorithmSpec

Instances

ToJSON GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

toJSON :: GenerateMac -> Value

toEncoding :: GenerateMac -> Encoding

toJSONList :: [GenerateMac] -> Value

toEncodingList :: [GenerateMac] -> Encoding

ToHeaders GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

toHeaders :: GenerateMac -> [Header]

ToPath GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

toPath :: GenerateMac -> ByteString

ToQuery GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

toQuery :: GenerateMac -> QueryString

AWSRequest GenerateMac

Defined in Amazonka.KMS.GenerateMac

Associated Types

type AWSResponse GenerateMac

Methods

request :: (Service -> Service) -> GenerateMac -> Request GenerateMac

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateMac -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateMac)))

Generic GenerateMac

Defined in Amazonka.KMS.GenerateMac

Associated Types

type Rep GenerateMac :: Type -> Type

Methods

from :: GenerateMac -> Rep GenerateMac x

to :: Rep GenerateMac x -> GenerateMac

Show GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

showsPrec :: Int -> GenerateMac -> ShowS

show :: GenerateMac -> String

showList :: [GenerateMac] -> ShowS

NFData GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

rnf :: GenerateMac -> ()

Eq GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

(==) :: GenerateMac -> GenerateMac -> Bool

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

Hashable GenerateMac

Defined in Amazonka.KMS.GenerateMac

Methods

hashWithSalt :: Int -> GenerateMac -> Int

hash :: GenerateMac -> Int

type AWSResponse GenerateMac

Defined in Amazonka.KMS.GenerateMac

type AWSResponse GenerateMac = GenerateMacResponse

type Rep GenerateMac

Defined in Amazonka.KMS.GenerateMac

type Rep GenerateMac = D1 ('MetaData "GenerateMac" "Amazonka.KMS.GenerateMac" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateMac'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "macAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MacAlgorithmSpec))))

newGenerateMac

Arguments

:: ByteString

$sel:message:GenerateMac'

-> Text

GenerateMac

-> MacAlgorithmSpec

GenerateMac

-> GenerateMac

Create a value of GenerateMac with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grantTokens:GenerateMac', generateMac_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:message:GenerateMac', generateMac_message - The message to be hashed. Specify a message of up to 4,096 bytes.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.-- -- 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.

GenerateMac, generateMac_keyId - The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

GenerateMac, generateMac_macAlgorithm - The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

data GenerateMacResponse

See: newGenerateMacResponse smart constructor.

Constructors

GenerateMacResponse' (Maybe Text) (Maybe Base64) (Maybe MacAlgorithmSpec) Int

Instances

Generic GenerateMacResponse

Defined in Amazonka.KMS.GenerateMac

Associated Types

type Rep GenerateMacResponse :: Type -> Type

Methods

from :: GenerateMacResponse -> Rep GenerateMacResponse x

to :: Rep GenerateMacResponse x -> GenerateMacResponse

Read GenerateMacResponse

Defined in Amazonka.KMS.GenerateMac

Methods

readsPrec :: Int -> ReadS GenerateMacResponse

readList :: ReadS [GenerateMacResponse]

readPrec :: ReadPrec GenerateMacResponse

readListPrec :: ReadPrec [GenerateMacResponse]

Show GenerateMacResponse

Defined in Amazonka.KMS.GenerateMac

Methods

showsPrec :: Int -> GenerateMacResponse -> ShowS

show :: GenerateMacResponse -> String

showList :: [GenerateMacResponse] -> ShowS

NFData GenerateMacResponse

Defined in Amazonka.KMS.GenerateMac

Methods

rnf :: GenerateMacResponse -> ()

Eq GenerateMacResponse

Defined in Amazonka.KMS.GenerateMac

Methods

(==) :: GenerateMacResponse -> GenerateMacResponse -> Bool

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

type Rep GenerateMacResponse

Defined in Amazonka.KMS.GenerateMac

type Rep GenerateMacResponse = D1 ('MetaData "GenerateMacResponse" "Amazonka.KMS.GenerateMac" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateMacResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mac") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 ('MetaSel ('Just "macAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MacAlgorithmSpec)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGenerateMacResponse

Arguments

:: Int

$sel:httpStatus:GenerateMacResponse'

-> GenerateMacResponse

Create a value of GenerateMacResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GenerateMac, generateMacResponse_keyId - The HMAC KMS key used in the operation.

$sel:mac:GenerateMacResponse', generateMacResponse_mac - The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.-- -- 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.

GenerateMac, generateMacResponse_macAlgorithm - The MAC algorithm that was used to generate the HMAC.

$sel:httpStatus:GenerateMacResponse', generateMacResponse_httpStatus - The response's http status code.

GenerateRandom

data GenerateRandom

See: newGenerateRandom smart constructor.

Constructors

GenerateRandom' (Maybe Text) (Maybe Natural)

Instances

ToJSON GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

toJSON :: GenerateRandom -> Value

toEncoding :: GenerateRandom -> Encoding

toJSONList :: [GenerateRandom] -> Value

toEncodingList :: [GenerateRandom] -> Encoding

ToHeaders GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

toHeaders :: GenerateRandom -> [Header]

ToPath GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

toPath :: GenerateRandom -> ByteString

ToQuery GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

toQuery :: GenerateRandom -> QueryString

AWSRequest GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Associated Types

type AWSResponse GenerateRandom

Methods

request :: (Service -> Service) -> GenerateRandom -> Request GenerateRandom

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateRandom -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateRandom)))

Generic GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Associated Types

type Rep GenerateRandom :: Type -> Type

Methods

from :: GenerateRandom -> Rep GenerateRandom x

to :: Rep GenerateRandom x -> GenerateRandom

Read GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

readsPrec :: Int -> ReadS GenerateRandom

readList :: ReadS [GenerateRandom]

readPrec :: ReadPrec GenerateRandom

readListPrec :: ReadPrec [GenerateRandom]

Show GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

showsPrec :: Int -> GenerateRandom -> ShowS

show :: GenerateRandom -> String

showList :: [GenerateRandom] -> ShowS

NFData GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

rnf :: GenerateRandom -> ()

Eq GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

(==) :: GenerateRandom -> GenerateRandom -> Bool

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

Hashable GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

Methods

hashWithSalt :: Int -> GenerateRandom -> Int

hash :: GenerateRandom -> Int

type AWSResponse GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

type AWSResponse GenerateRandom = GenerateRandomResponse

type Rep GenerateRandom

Defined in Amazonka.KMS.GenerateRandom

type Rep GenerateRandom = D1 ('MetaData "GenerateRandom" "Amazonka.KMS.GenerateRandom" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateRandom'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberOfBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newGenerateRandom :: GenerateRandom

Create a value of GenerateRandom with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GenerateRandom, generateRandom_customKeyStoreId - Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

External key store IDs are not valid for this parameter. If you specify the ID of an external key store, GenerateRandom throws an UnsupportedOperationException.

$sel:numberOfBytes:GenerateRandom', generateRandom_numberOfBytes - The length of the random byte string. This parameter is required.

data GenerateRandomResponse

See: newGenerateRandomResponse smart constructor.

Constructors

GenerateRandomResponse' (Maybe (Sensitive Base64)) Int

Instances

Generic GenerateRandomResponse

Defined in Amazonka.KMS.GenerateRandom

Associated Types

type Rep GenerateRandomResponse :: Type -> Type

Methods

from :: GenerateRandomResponse -> Rep GenerateRandomResponse x

to :: Rep GenerateRandomResponse x -> GenerateRandomResponse

Show GenerateRandomResponse

Defined in Amazonka.KMS.GenerateRandom

Methods

showsPrec :: Int -> GenerateRandomResponse -> ShowS

show :: GenerateRandomResponse -> String

showList :: [GenerateRandomResponse] -> ShowS

NFData GenerateRandomResponse

Defined in Amazonka.KMS.GenerateRandom

Methods

rnf :: GenerateRandomResponse -> ()

Eq GenerateRandomResponse

Defined in Amazonka.KMS.GenerateRandom

Methods

(==) :: GenerateRandomResponse -> GenerateRandomResponse -> Bool

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

type Rep GenerateRandomResponse

Defined in Amazonka.KMS.GenerateRandom

type Rep GenerateRandomResponse = D1 ('MetaData "GenerateRandomResponse" "Amazonka.KMS.GenerateRandom" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GenerateRandomResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "plaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGenerateRandomResponse

Arguments

:: Int

$sel:httpStatus:GenerateRandomResponse'

-> GenerateRandomResponse

Create a value of GenerateRandomResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:plaintext:GenerateRandomResponse', generateRandomResponse_plaintext - The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

$sel:httpStatus:GenerateRandomResponse', generateRandomResponse_httpStatus - The response's http status code.

GetKeyPolicy

data GetKeyPolicy

See: newGetKeyPolicy smart constructor.

Constructors

GetKeyPolicy' Text Text

Instances

ToJSON GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toJSON :: GetKeyPolicy -> Value

toEncoding :: GetKeyPolicy -> Encoding

toJSONList :: [GetKeyPolicy] -> Value

toEncodingList :: [GetKeyPolicy] -> Encoding

ToHeaders GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toHeaders :: GetKeyPolicy -> [Header]

ToPath GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toPath :: GetKeyPolicy -> ByteString

ToQuery GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toQuery :: GetKeyPolicy -> QueryString

AWSRequest GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Associated Types

type AWSResponse GetKeyPolicy

Methods

request :: (Service -> Service) -> GetKeyPolicy -> Request GetKeyPolicy

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetKeyPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetKeyPolicy)))

Generic GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Associated Types

type Rep GetKeyPolicy :: Type -> Type

Methods

from :: GetKeyPolicy -> Rep GetKeyPolicy x

to :: Rep GetKeyPolicy x -> GetKeyPolicy

Read GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

readsPrec :: Int -> ReadS GetKeyPolicy

readList :: ReadS [GetKeyPolicy]

readPrec :: ReadPrec GetKeyPolicy

readListPrec :: ReadPrec [GetKeyPolicy]

Show GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

showsPrec :: Int -> GetKeyPolicy -> ShowS

show :: GetKeyPolicy -> String

showList :: [GetKeyPolicy] -> ShowS

NFData GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

rnf :: GetKeyPolicy -> ()

Eq GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

(==) :: GetKeyPolicy -> GetKeyPolicy -> Bool

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

Hashable GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

hashWithSalt :: Int -> GetKeyPolicy -> Int

hash :: GetKeyPolicy -> Int

type AWSResponse GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

type AWSResponse GetKeyPolicy = GetKeyPolicyResponse

type Rep GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

type Rep GetKeyPolicy = D1 ('MetaData "GetKeyPolicy" "Amazonka.KMS.GetKeyPolicy" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetKeyPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetKeyPolicy

Arguments

:: Text

GetKeyPolicy

-> Text

$sel:policyName:GetKeyPolicy'

-> GetKeyPolicy

Create a value of GetKeyPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetKeyPolicy, getKeyPolicy_keyId - Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:policyName:GetKeyPolicy', getKeyPolicy_policyName - Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

data GetKeyPolicyResponse

See: newGetKeyPolicyResponse smart constructor.

Constructors

GetKeyPolicyResponse' (Maybe Text) Int

Instances

Generic GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Associated Types

type Rep GetKeyPolicyResponse :: Type -> Type

Methods

from :: GetKeyPolicyResponse -> Rep GetKeyPolicyResponse x

to :: Rep GetKeyPolicyResponse x -> GetKeyPolicyResponse

Read GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

readsPrec :: Int -> ReadS GetKeyPolicyResponse

readList :: ReadS [GetKeyPolicyResponse]

readPrec :: ReadPrec GetKeyPolicyResponse

readListPrec :: ReadPrec [GetKeyPolicyResponse]

Show GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

showsPrec :: Int -> GetKeyPolicyResponse -> ShowS

show :: GetKeyPolicyResponse -> String

showList :: [GetKeyPolicyResponse] -> ShowS

NFData GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

rnf :: GetKeyPolicyResponse -> ()

Eq GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

(==) :: GetKeyPolicyResponse -> GetKeyPolicyResponse -> Bool

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

type Rep GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

type Rep GetKeyPolicyResponse = D1 ('MetaData "GetKeyPolicyResponse" "Amazonka.KMS.GetKeyPolicy" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetKeyPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetKeyPolicyResponse

Arguments

:: Int

$sel:httpStatus:GetKeyPolicyResponse'

-> GetKeyPolicyResponse

Create a value of GetKeyPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:policy:GetKeyPolicyResponse', getKeyPolicyResponse_policy - A key policy document in JSON format.

$sel:httpStatus:GetKeyPolicyResponse', getKeyPolicyResponse_httpStatus - The response's http status code.

GetKeyRotationStatus

data GetKeyRotationStatus

See: newGetKeyRotationStatus smart constructor.

Constructors

GetKeyRotationStatus' Text

Instances

ToJSON GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toJSON :: GetKeyRotationStatus -> Value

toEncoding :: GetKeyRotationStatus -> Encoding

toJSONList :: [GetKeyRotationStatus] -> Value

toEncodingList :: [GetKeyRotationStatus] -> Encoding

ToHeaders GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toHeaders :: GetKeyRotationStatus -> [Header]

ToPath GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toPath :: GetKeyRotationStatus -> ByteString

ToQuery GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toQuery :: GetKeyRotationStatus -> QueryString

AWSRequest GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type AWSResponse GetKeyRotationStatus

Methods

request :: (Service -> Service) -> GetKeyRotationStatus -> Request GetKeyRotationStatus

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetKeyRotationStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetKeyRotationStatus)))

Generic GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type Rep GetKeyRotationStatus :: Type -> Type

Methods

from :: GetKeyRotationStatus -> Rep GetKeyRotationStatus x

to :: Rep GetKeyRotationStatus x -> GetKeyRotationStatus

Read GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

readsPrec :: Int -> ReadS GetKeyRotationStatus

readList :: ReadS [GetKeyRotationStatus]

readPrec :: ReadPrec GetKeyRotationStatus

readListPrec :: ReadPrec [GetKeyRotationStatus]

Show GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

showsPrec :: Int -> GetKeyRotationStatus -> ShowS

show :: GetKeyRotationStatus -> String

showList :: [GetKeyRotationStatus] -> ShowS

NFData GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

rnf :: GetKeyRotationStatus -> ()

Eq GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

(==) :: GetKeyRotationStatus -> GetKeyRotationStatus -> Bool

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

Hashable GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

hashWithSalt :: Int -> GetKeyRotationStatus -> Int

hash :: GetKeyRotationStatus -> Int

type AWSResponse GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

type AWSResponse GetKeyRotationStatus = GetKeyRotationStatusResponse

type Rep GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

type Rep GetKeyRotationStatus = D1 ('MetaData "GetKeyRotationStatus" "Amazonka.KMS.GetKeyRotationStatus" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetKeyRotationStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetKeyRotationStatus

Arguments

:: Text

GetKeyRotationStatus

-> GetKeyRotationStatus

Create a value of GetKeyRotationStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetKeyRotationStatus, getKeyRotationStatus_keyId - Gets the rotation status for the specified KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data GetKeyRotationStatusResponse

See: newGetKeyRotationStatusResponse smart constructor.

Constructors

GetKeyRotationStatusResponse' (Maybe Bool) Int

Instances

Generic GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type Rep GetKeyRotationStatusResponse :: Type -> Type

Methods

from :: GetKeyRotationStatusResponse -> Rep GetKeyRotationStatusResponse x

to :: Rep GetKeyRotationStatusResponse x -> GetKeyRotationStatusResponse

Read GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

readsPrec :: Int -> ReadS GetKeyRotationStatusResponse

readList :: ReadS [GetKeyRotationStatusResponse]

readPrec :: ReadPrec GetKeyRotationStatusResponse

readListPrec :: ReadPrec [GetKeyRotationStatusResponse]

Show GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

showsPrec :: Int -> GetKeyRotationStatusResponse -> ShowS

show :: GetKeyRotationStatusResponse -> String

showList :: [GetKeyRotationStatusResponse] -> ShowS

NFData GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

rnf :: GetKeyRotationStatusResponse -> ()

Eq GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

(==) :: GetKeyRotationStatusResponse -> GetKeyRotationStatusResponse -> Bool

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

type Rep GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

type Rep GetKeyRotationStatusResponse = D1 ('MetaData "GetKeyRotationStatusResponse" "Amazonka.KMS.GetKeyRotationStatus" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetKeyRotationStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyRotationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetKeyRotationStatusResponse

Arguments

:: Int

$sel:httpStatus:GetKeyRotationStatusResponse'

-> GetKeyRotationStatusResponse

Create a value of GetKeyRotationStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyRotationEnabled:GetKeyRotationStatusResponse', getKeyRotationStatusResponse_keyRotationEnabled - A Boolean value that specifies whether key rotation is enabled.

$sel:httpStatus:GetKeyRotationStatusResponse', getKeyRotationStatusResponse_httpStatus - The response's http status code.

GetParametersForImport

data GetParametersForImport

See: newGetParametersForImport smart constructor.

Constructors

GetParametersForImport' Text AlgorithmSpec WrappingKeySpec

Instances

ToJSON GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

toJSON :: GetParametersForImport -> Value

toEncoding :: GetParametersForImport -> Encoding

toJSONList :: [GetParametersForImport] -> Value

toEncodingList :: [GetParametersForImport] -> Encoding

ToHeaders GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

toHeaders :: GetParametersForImport -> [Header]

ToPath GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

toPath :: GetParametersForImport -> ByteString

ToQuery GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

toQuery :: GetParametersForImport -> QueryString

AWSRequest GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Associated Types

type AWSResponse GetParametersForImport

Methods

request :: (Service -> Service) -> GetParametersForImport -> Request GetParametersForImport

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetParametersForImport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetParametersForImport)))

Generic GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Associated Types

type Rep GetParametersForImport :: Type -> Type

Methods

from :: GetParametersForImport -> Rep GetParametersForImport x

to :: Rep GetParametersForImport x -> GetParametersForImport

Read GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

readsPrec :: Int -> ReadS GetParametersForImport

readList :: ReadS [GetParametersForImport]

readPrec :: ReadPrec GetParametersForImport

readListPrec :: ReadPrec [GetParametersForImport]

Show GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

showsPrec :: Int -> GetParametersForImport -> ShowS

show :: GetParametersForImport -> String

showList :: [GetParametersForImport] -> ShowS

NFData GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

rnf :: GetParametersForImport -> ()

Eq GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

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

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

Hashable GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

Methods

hashWithSalt :: Int -> GetParametersForImport -> Int

hash :: GetParametersForImport -> Int

type AWSResponse GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

type AWSResponse GetParametersForImport = GetParametersForImportResponse

type Rep GetParametersForImport

Defined in Amazonka.KMS.GetParametersForImport

type Rep GetParametersForImport = D1 ('MetaData "GetParametersForImport" "Amazonka.KMS.GetParametersForImport" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetParametersForImport'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "wrappingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlgorithmSpec) :*: S1 ('MetaSel ('Just "wrappingKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WrappingKeySpec))))

newGetParametersForImport

Arguments

:: Text

GetParametersForImport

-> AlgorithmSpec

$sel:wrappingAlgorithm:GetParametersForImport'

-> WrappingKeySpec

$sel:wrappingKeySpec:GetParametersForImport'

-> GetParametersForImport

Create a value of GetParametersForImport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetParametersForImport, getParametersForImport_keyId - The identifier of the symmetric encryption KMS key into which you will import key material. The Origin of the KMS key must be EXTERNAL.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:wrappingAlgorithm:GetParametersForImport', getParametersForImport_wrappingAlgorithm - The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.

$sel:wrappingKeySpec:GetParametersForImport', getParametersForImport_wrappingKeySpec - The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

data GetParametersForImportResponse

See: newGetParametersForImportResponse smart constructor.

Constructors

GetParametersForImportResponse' (Maybe Base64) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Base64)) Int

Instances

Generic GetParametersForImportResponse

Defined in Amazonka.KMS.GetParametersForImport

Associated Types

type Rep GetParametersForImportResponse :: Type -> Type

Methods

from :: GetParametersForImportResponse -> Rep GetParametersForImportResponse x

to :: Rep GetParametersForImportResponse x -> GetParametersForImportResponse

Show GetParametersForImportResponse

Defined in Amazonka.KMS.GetParametersForImport

Methods

showsPrec :: Int -> GetParametersForImportResponse -> ShowS

show :: GetParametersForImportResponse -> String

showList :: [GetParametersForImportResponse] -> ShowS

NFData GetParametersForImportResponse

Defined in Amazonka.KMS.GetParametersForImport

Methods

rnf :: GetParametersForImportResponse -> ()

Eq GetParametersForImportResponse

Defined in Amazonka.KMS.GetParametersForImport

Methods

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

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

type Rep GetParametersForImportResponse

Defined in Amazonka.KMS.GetParametersForImport

type Rep GetParametersForImportResponse = D1 ('MetaData "GetParametersForImportResponse" "Amazonka.KMS.GetParametersForImport" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetParametersForImportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "importToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "parametersValidTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetParametersForImportResponse

Arguments

:: Int

$sel:httpStatus:GetParametersForImportResponse'

-> GetParametersForImportResponse

Create a value of GetParametersForImportResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:importToken:GetParametersForImportResponse', getParametersForImportResponse_importToken - 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.

GetParametersForImport, getParametersForImportResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the GetParametersForImport request.

$sel:parametersValidTo:GetParametersForImportResponse', getParametersForImportResponse_parametersValidTo - 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 get new ones.

$sel:publicKey:GetParametersForImportResponse', getParametersForImportResponse_publicKey - 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.

$sel:httpStatus:GetParametersForImportResponse', getParametersForImportResponse_httpStatus - The response's http status code.

GetPublicKey

data GetPublicKey

See: newGetPublicKey smart constructor.

Constructors

GetPublicKey' (Maybe [Text]) Text

Instances

ToJSON GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

toJSON :: GetPublicKey -> Value

toEncoding :: GetPublicKey -> Encoding

toJSONList :: [GetPublicKey] -> Value

toEncodingList :: [GetPublicKey] -> Encoding

ToHeaders GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

toHeaders :: GetPublicKey -> [Header]

ToPath GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

toPath :: GetPublicKey -> ByteString

ToQuery GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

toQuery :: GetPublicKey -> QueryString

AWSRequest GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Associated Types

type AWSResponse GetPublicKey

Methods

request :: (Service -> Service) -> GetPublicKey -> Request GetPublicKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPublicKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPublicKey)))

Generic GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Associated Types

type Rep GetPublicKey :: Type -> Type

Methods

from :: GetPublicKey -> Rep GetPublicKey x

to :: Rep GetPublicKey x -> GetPublicKey

Read GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

readsPrec :: Int -> ReadS GetPublicKey

readList :: ReadS [GetPublicKey]

readPrec :: ReadPrec GetPublicKey

readListPrec :: ReadPrec [GetPublicKey]

Show GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

showsPrec :: Int -> GetPublicKey -> ShowS

show :: GetPublicKey -> String

showList :: [GetPublicKey] -> ShowS

NFData GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

rnf :: GetPublicKey -> ()

Eq GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

(==) :: GetPublicKey -> GetPublicKey -> Bool

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

Hashable GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

Methods

hashWithSalt :: Int -> GetPublicKey -> Int

hash :: GetPublicKey -> Int

type AWSResponse GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

type AWSResponse GetPublicKey = GetPublicKeyResponse

type Rep GetPublicKey

Defined in Amazonka.KMS.GetPublicKey

type Rep GetPublicKey = D1 ('MetaData "GetPublicKey" "Amazonka.KMS.GetPublicKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetPublicKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetPublicKey

Arguments

:: Text

GetPublicKey

-> GetPublicKey

Create a value of GetPublicKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grantTokens:GetPublicKey', getPublicKey_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

GetPublicKey, getPublicKey_keyId - Identifies the asymmetric KMS key that includes the public key.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

data GetPublicKeyResponse

See: newGetPublicKeyResponse smart constructor.

Constructors

GetPublicKeyResponse' (Maybe CustomerMasterKeySpec) (Maybe [EncryptionAlgorithmSpec]) (Maybe Text) (Maybe KeySpec) (Maybe KeyUsageType) (Maybe Base64) (Maybe [SigningAlgorithmSpec]) Int

Instances

Generic GetPublicKeyResponse

Defined in Amazonka.KMS.GetPublicKey

Associated Types

type Rep GetPublicKeyResponse :: Type -> Type

Methods

from :: GetPublicKeyResponse -> Rep GetPublicKeyResponse x

to :: Rep GetPublicKeyResponse x -> GetPublicKeyResponse

Read GetPublicKeyResponse

Defined in Amazonka.KMS.GetPublicKey

Methods

readsPrec :: Int -> ReadS GetPublicKeyResponse

readList :: ReadS [GetPublicKeyResponse]

readPrec :: ReadPrec GetPublicKeyResponse

readListPrec :: ReadPrec [GetPublicKeyResponse]

Show GetPublicKeyResponse

Defined in Amazonka.KMS.GetPublicKey

Methods

showsPrec :: Int -> GetPublicKeyResponse -> ShowS

show :: GetPublicKeyResponse -> String

showList :: [GetPublicKeyResponse] -> ShowS

NFData GetPublicKeyResponse

Defined in Amazonka.KMS.GetPublicKey

Methods

rnf :: GetPublicKeyResponse -> ()

Eq GetPublicKeyResponse

Defined in Amazonka.KMS.GetPublicKey

Methods

(==) :: GetPublicKeyResponse -> GetPublicKeyResponse -> Bool

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

type Rep GetPublicKeyResponse

Defined in Amazonka.KMS.GetPublicKey

type Rep GetPublicKeyResponse = D1 ('MetaData "GetPublicKeyResponse" "Amazonka.KMS.GetPublicKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetPublicKeyResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customerMasterKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerMasterKeySpec)) :*: S1 ('MetaSel ('Just "encryptionAlgorithms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EncryptionAlgorithmSpec]))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeySpec)))) :*: ((S1 ('MetaSel ('Just "keyUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyUsageType)) :*: S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 ('MetaSel ('Just "signingAlgorithms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SigningAlgorithmSpec])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetPublicKeyResponse

Arguments

:: Int

$sel:httpStatus:GetPublicKeyResponse'

-> GetPublicKeyResponse

Create a value of GetPublicKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetPublicKeyResponse, getPublicKeyResponse_customerMasterKeySpec - Instead, use the KeySpec field in the GetPublicKey response.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

GetPublicKeyResponse, getPublicKeyResponse_encryptionAlgorithms - The encryption algorithms that KMS supports for this key.

This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

GetPublicKey, getPublicKeyResponse_keyId - The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.

GetPublicKeyResponse, getPublicKeyResponse_keySpec - The type of the of the public key that was downloaded.

GetPublicKeyResponse, getPublicKeyResponse_keyUsage - The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

$sel:publicKey:GetPublicKeyResponse', getPublicKeyResponse_publicKey - The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

GetPublicKeyResponse, getPublicKeyResponse_signingAlgorithms - The signing algorithms that KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

$sel:httpStatus:GetPublicKeyResponse', getPublicKeyResponse_httpStatus - The response's http status code.

ImportKeyMaterial

data ImportKeyMaterial

See: newImportKeyMaterial smart constructor.

Constructors

ImportKeyMaterial' (Maybe ExpirationModelType) (Maybe POSIX) Text Base64 Base64

Instances

ToJSON ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

toJSON :: ImportKeyMaterial -> Value

toEncoding :: ImportKeyMaterial -> Encoding

toJSONList :: [ImportKeyMaterial] -> Value

toEncodingList :: [ImportKeyMaterial] -> Encoding

ToHeaders ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

toHeaders :: ImportKeyMaterial -> [Header]

ToPath ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

toPath :: ImportKeyMaterial -> ByteString

ToQuery ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

toQuery :: ImportKeyMaterial -> QueryString

AWSRequest ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Associated Types

type AWSResponse ImportKeyMaterial

Methods

request :: (Service -> Service) -> ImportKeyMaterial -> Request ImportKeyMaterial

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportKeyMaterial -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportKeyMaterial)))

Generic ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Associated Types

type Rep ImportKeyMaterial :: Type -> Type

Methods

from :: ImportKeyMaterial -> Rep ImportKeyMaterial x

to :: Rep ImportKeyMaterial x -> ImportKeyMaterial

Read ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

readsPrec :: Int -> ReadS ImportKeyMaterial

readList :: ReadS [ImportKeyMaterial]

readPrec :: ReadPrec ImportKeyMaterial

readListPrec :: ReadPrec [ImportKeyMaterial]

Show ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

showsPrec :: Int -> ImportKeyMaterial -> ShowS

show :: ImportKeyMaterial -> String

showList :: [ImportKeyMaterial] -> ShowS

NFData ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

rnf :: ImportKeyMaterial -> ()

Eq ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

(==) :: ImportKeyMaterial -> ImportKeyMaterial -> Bool

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

Hashable ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

hashWithSalt :: Int -> ImportKeyMaterial -> Int

hash :: ImportKeyMaterial -> Int

type AWSResponse ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

type AWSResponse ImportKeyMaterial = ImportKeyMaterialResponse

type Rep ImportKeyMaterial

Defined in Amazonka.KMS.ImportKeyMaterial

type Rep ImportKeyMaterial = D1 ('MetaData "ImportKeyMaterial" "Amazonka.KMS.ImportKeyMaterial" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ImportKeyMaterial'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expirationModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExpirationModelType)) :*: S1 ('MetaSel ('Just "validTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "importToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "encryptedKeyMaterial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)))))

newImportKeyMaterial

Arguments

:: Text

ImportKeyMaterial

-> ByteString

$sel:importToken:ImportKeyMaterial'

-> ByteString

$sel:encryptedKeyMaterial:ImportKeyMaterial'

-> ImportKeyMaterial

Create a value of ImportKeyMaterial with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ImportKeyMaterial, importKeyMaterial_expirationModel - Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES.

When the value of ExpirationModel is KEY_MATERIAL_EXPIRES, you must specify a value for the ValidTo parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

You cannot change the ExpirationModel or ValidTo values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.

ImportKeyMaterial, importKeyMaterial_validTo - The date and time when the imported key material expires. This parameter is required when the value of the ExpirationModel parameter is KEY_MATERIAL_EXPIRES. Otherwise it is not valid.

The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.

When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.

You cannot change the ExpirationModel or ValidTo values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.

ImportKeyMaterial, importKeyMaterial_keyId - The identifier of the symmetric encryption KMS key that receives the imported key material. This must be the same KMS key specified in the KeyID parameter of the corresponding GetParametersForImport request. The Origin of the KMS key must be EXTERNAL. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:importToken:ImportKeyMaterial', importKeyMaterial_importToken - 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.

$sel:encryptedKeyMaterial:ImportKeyMaterial', importKeyMaterial_encryptedKeyMaterial - The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport 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.

data ImportKeyMaterialResponse

See: newImportKeyMaterialResponse smart constructor.

Constructors

ImportKeyMaterialResponse' Int

Instances

Generic ImportKeyMaterialResponse

Defined in Amazonka.KMS.ImportKeyMaterial

Associated Types

type Rep ImportKeyMaterialResponse :: Type -> Type

Methods

from :: ImportKeyMaterialResponse -> Rep ImportKeyMaterialResponse x

to :: Rep ImportKeyMaterialResponse x -> ImportKeyMaterialResponse

Read ImportKeyMaterialResponse

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

readsPrec :: Int -> ReadS ImportKeyMaterialResponse

readList :: ReadS [ImportKeyMaterialResponse]

readPrec :: ReadPrec ImportKeyMaterialResponse

readListPrec :: ReadPrec [ImportKeyMaterialResponse]

Show ImportKeyMaterialResponse

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

showsPrec :: Int -> ImportKeyMaterialResponse -> ShowS

show :: ImportKeyMaterialResponse -> String

showList :: [ImportKeyMaterialResponse] -> ShowS

NFData ImportKeyMaterialResponse

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

rnf :: ImportKeyMaterialResponse -> ()

Eq ImportKeyMaterialResponse

Defined in Amazonka.KMS.ImportKeyMaterial

Methods

(==) :: ImportKeyMaterialResponse -> ImportKeyMaterialResponse -> Bool

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

type Rep ImportKeyMaterialResponse

Defined in Amazonka.KMS.ImportKeyMaterial

type Rep ImportKeyMaterialResponse = D1 ('MetaData "ImportKeyMaterialResponse" "Amazonka.KMS.ImportKeyMaterial" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ImportKeyMaterialResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newImportKeyMaterialResponse

Arguments

:: Int

$sel:httpStatus:ImportKeyMaterialResponse'

-> ImportKeyMaterialResponse

Create a value of ImportKeyMaterialResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ImportKeyMaterialResponse', importKeyMaterialResponse_httpStatus - The response's http status code.

ListAliases (Paginated)

data ListAliases

See: newListAliases smart constructor.

Constructors

ListAliases' (Maybe Text) (Maybe Natural) (Maybe Text)

Instances

ToJSON ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

toJSON :: ListAliases -> Value

toEncoding :: ListAliases -> Encoding

toJSONList :: [ListAliases] -> Value

toEncodingList :: [ListAliases] -> Encoding

ToHeaders ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

toHeaders :: ListAliases -> [Header]

ToPath ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

toPath :: ListAliases -> ByteString

ToQuery ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

toQuery :: ListAliases -> QueryString

AWSPager ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

page :: ListAliases -> AWSResponse ListAliases -> Maybe ListAliases

AWSRequest ListAliases

Defined in Amazonka.KMS.ListAliases

Associated Types

type AWSResponse ListAliases

Methods

request :: (Service -> Service) -> ListAliases -> Request ListAliases

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAliases)))

Generic ListAliases

Defined in Amazonka.KMS.ListAliases

Associated Types

type Rep ListAliases :: Type -> Type

Methods

from :: ListAliases -> Rep ListAliases x

to :: Rep ListAliases x -> ListAliases

Read ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliases

readList :: ReadS [ListAliases]

readPrec :: ReadPrec ListAliases

readListPrec :: ReadPrec [ListAliases]

Show ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

showsPrec :: Int -> ListAliases -> ShowS

show :: ListAliases -> String

showList :: [ListAliases] -> ShowS

NFData ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

rnf :: ListAliases -> ()

Eq ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

(==) :: ListAliases -> ListAliases -> Bool

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

Hashable ListAliases

Defined in Amazonka.KMS.ListAliases

Methods

hashWithSalt :: Int -> ListAliases -> Int

hash :: ListAliases -> Int

type AWSResponse ListAliases

Defined in Amazonka.KMS.ListAliases

type AWSResponse ListAliases = ListAliasesResponse

type Rep ListAliases

Defined in Amazonka.KMS.ListAliases

type Rep ListAliases = D1 ('MetaData "ListAliases" "Amazonka.KMS.ListAliases" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListAliases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListAliases :: ListAliases

Create a value of ListAliases with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListAliases, listAliases_keyId - Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and Region.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:limit:ListAliases', listAliases_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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.

$sel:marker:ListAliases', listAliases_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

data ListAliasesResponse

See: newListAliasesResponse smart constructor.

Constructors

ListAliasesResponse' (Maybe [AliasListEntry]) (Maybe Text) (Maybe Bool) Int

Instances

Generic ListAliasesResponse

Defined in Amazonka.KMS.ListAliases

Associated Types

type Rep ListAliasesResponse :: Type -> Type

Methods

from :: ListAliasesResponse -> Rep ListAliasesResponse x

to :: Rep ListAliasesResponse x -> ListAliasesResponse

Read ListAliasesResponse

Defined in Amazonka.KMS.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliasesResponse

readList :: ReadS [ListAliasesResponse]

readPrec :: ReadPrec ListAliasesResponse

readListPrec :: ReadPrec [ListAliasesResponse]

Show ListAliasesResponse

Defined in Amazonka.KMS.ListAliases

Methods

showsPrec :: Int -> ListAliasesResponse -> ShowS

show :: ListAliasesResponse -> String

showList :: [ListAliasesResponse] -> ShowS

NFData ListAliasesResponse

Defined in Amazonka.KMS.ListAliases

Methods

rnf :: ListAliasesResponse -> ()

Eq ListAliasesResponse

Defined in Amazonka.KMS.ListAliases

Methods

(==) :: ListAliasesResponse -> ListAliasesResponse -> Bool

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

type Rep ListAliasesResponse

Defined in Amazonka.KMS.ListAliases

type Rep ListAliasesResponse = D1 ('MetaData "ListAliasesResponse" "Amazonka.KMS.ListAliases" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListAliasesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AliasListEntry])) :*: S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAliasesResponse

Arguments

:: Int

$sel:httpStatus:ListAliasesResponse'

-> ListAliasesResponse

Create a value of ListAliasesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aliases:ListAliasesResponse', listAliasesResponse_aliases - A list of aliases.

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

ListAliasesResponse, listAliasesResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

$sel:httpStatus:ListAliasesResponse', listAliasesResponse_httpStatus - The response's http status code.

ListGrants (Paginated)

data ListGrants

See: newListGrants smart constructor.

Constructors

ListGrants' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) Text

Instances

ToJSON ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

toJSON :: ListGrants -> Value

toEncoding :: ListGrants -> Encoding

toJSONList :: [ListGrants] -> Value

toEncodingList :: [ListGrants] -> Encoding

ToHeaders ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

toHeaders :: ListGrants -> [Header]

ToPath ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

toPath :: ListGrants -> ByteString

ToQuery ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

toQuery :: ListGrants -> QueryString

AWSPager ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

page :: ListGrants -> AWSResponse ListGrants -> Maybe ListGrants

AWSRequest ListGrants

Defined in Amazonka.KMS.ListGrants

Associated Types

type AWSResponse ListGrants

Methods

request :: (Service -> Service) -> ListGrants -> Request ListGrants

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGrants -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGrants)))

Generic ListGrants

Defined in Amazonka.KMS.ListGrants

Associated Types

type Rep ListGrants :: Type -> Type

Methods

from :: ListGrants -> Rep ListGrants x

to :: Rep ListGrants x -> ListGrants

Read ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

readsPrec :: Int -> ReadS ListGrants

readList :: ReadS [ListGrants]

readPrec :: ReadPrec ListGrants

readListPrec :: ReadPrec [ListGrants]

Show ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

showsPrec :: Int -> ListGrants -> ShowS

show :: ListGrants -> String

showList :: [ListGrants] -> ShowS

NFData ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

rnf :: ListGrants -> ()

Eq ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

(==) :: ListGrants -> ListGrants -> Bool

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

Hashable ListGrants

Defined in Amazonka.KMS.ListGrants

Methods

hashWithSalt :: Int -> ListGrants -> Int

hash :: ListGrants -> Int

type AWSResponse ListGrants

Defined in Amazonka.KMS.ListGrants

type AWSResponse ListGrants = ListGrantsResponse

type Rep ListGrants

Defined in Amazonka.KMS.ListGrants

type Rep ListGrants = D1 ('MetaData "ListGrants" "Amazonka.KMS.ListGrants" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListGrants'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "grantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "granteePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListGrants

Arguments

:: Text

ListGrants

-> ListGrants

Create a value of ListGrants with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListGrants, listGrants_grantId - Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

ListGrants, listGrants_granteePrincipal - Returns only grants where the specified principal is the grantee principal for the grant.

$sel:limit:ListGrants', listGrants_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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.

$sel:marker:ListGrants', listGrants_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

ListGrants, listGrants_keyId - Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data ListGrantsResponse

See: newListGrantsResponse smart constructor.

Constructors

ListGrantsResponse' (Maybe [GrantListEntry]) (Maybe Text) (Maybe Bool)

Instances

FromJSON ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

parseJSON :: Value -> Parser ListGrantsResponse

parseJSONList :: Value -> Parser [ListGrantsResponse]

Generic ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Associated Types

type Rep ListGrantsResponse :: Type -> Type

Methods

from :: ListGrantsResponse -> Rep ListGrantsResponse x

to :: Rep ListGrantsResponse x -> ListGrantsResponse

Read ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

readsPrec :: Int -> ReadS ListGrantsResponse

readList :: ReadS [ListGrantsResponse]

readPrec :: ReadPrec ListGrantsResponse

readListPrec :: ReadPrec [ListGrantsResponse]

Show ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

showsPrec :: Int -> ListGrantsResponse -> ShowS

show :: ListGrantsResponse -> String

showList :: [ListGrantsResponse] -> ShowS

NFData ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

rnf :: ListGrantsResponse -> ()

Eq ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

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

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

Hashable ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

hashWithSalt :: Int -> ListGrantsResponse -> Int

hash :: ListGrantsResponse -> Int

type Rep ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

type Rep ListGrantsResponse = D1 ('MetaData "ListGrantsResponse" "Amazonka.KMS.Types.ListGrantsResponse" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListGrantsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GrantListEntry])) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newListGrantsResponse :: ListGrantsResponse

Create a value of ListGrantsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grants:ListGrantsResponse', listGrantsResponse_grants - A list of grants.

$sel:nextMarker:ListGrantsResponse', listGrantsResponse_nextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

$sel:truncated:ListGrantsResponse', listGrantsResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

ListKeyPolicies (Paginated)

data ListKeyPolicies

See: newListKeyPolicies smart constructor.

Constructors

ListKeyPolicies' (Maybe Natural) (Maybe Text) Text

Instances

ToJSON ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

toJSON :: ListKeyPolicies -> Value

toEncoding :: ListKeyPolicies -> Encoding

toJSONList :: [ListKeyPolicies] -> Value

toEncodingList :: [ListKeyPolicies] -> Encoding

ToHeaders ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

toHeaders :: ListKeyPolicies -> [Header]

ToPath ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

toPath :: ListKeyPolicies -> ByteString

ToQuery ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

toQuery :: ListKeyPolicies -> QueryString

AWSPager ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

page :: ListKeyPolicies -> AWSResponse ListKeyPolicies -> Maybe ListKeyPolicies

AWSRequest ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Associated Types

type AWSResponse ListKeyPolicies

Methods

request :: (Service -> Service) -> ListKeyPolicies -> Request ListKeyPolicies

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListKeyPolicies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListKeyPolicies)))

Generic ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Associated Types

type Rep ListKeyPolicies :: Type -> Type

Methods

from :: ListKeyPolicies -> Rep ListKeyPolicies x

to :: Rep ListKeyPolicies x -> ListKeyPolicies

Read ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

readsPrec :: Int -> ReadS ListKeyPolicies

readList :: ReadS [ListKeyPolicies]

readPrec :: ReadPrec ListKeyPolicies

readListPrec :: ReadPrec [ListKeyPolicies]

Show ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

showsPrec :: Int -> ListKeyPolicies -> ShowS

show :: ListKeyPolicies -> String

showList :: [ListKeyPolicies] -> ShowS

NFData ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

rnf :: ListKeyPolicies -> ()

Eq ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

(==) :: ListKeyPolicies -> ListKeyPolicies -> Bool

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

Hashable ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

Methods

hashWithSalt :: Int -> ListKeyPolicies -> Int

hash :: ListKeyPolicies -> Int

type AWSResponse ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

type AWSResponse ListKeyPolicies = ListKeyPoliciesResponse

type Rep ListKeyPolicies

Defined in Amazonka.KMS.ListKeyPolicies

type Rep ListKeyPolicies = D1 ('MetaData "ListKeyPolicies" "Amazonka.KMS.ListKeyPolicies" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListKeyPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListKeyPolicies

Arguments

:: Text

ListKeyPolicies

-> ListKeyPolicies

Create a value of ListKeyPolicies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListKeyPolicies', listKeyPolicies_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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.

Only one policy can be attached to a key.

$sel:marker:ListKeyPolicies', listKeyPolicies_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

ListKeyPolicies, listKeyPolicies_keyId - Gets the names of key policies for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data ListKeyPoliciesResponse

See: newListKeyPoliciesResponse smart constructor.

Constructors

ListKeyPoliciesResponse' (Maybe Text) (Maybe [Text]) (Maybe Bool) Int

Instances

Generic ListKeyPoliciesResponse

Defined in Amazonka.KMS.ListKeyPolicies

Associated Types

type Rep ListKeyPoliciesResponse :: Type -> Type

Methods

from :: ListKeyPoliciesResponse -> Rep ListKeyPoliciesResponse x

to :: Rep ListKeyPoliciesResponse x -> ListKeyPoliciesResponse

Read ListKeyPoliciesResponse

Defined in Amazonka.KMS.ListKeyPolicies

Methods

readsPrec :: Int -> ReadS ListKeyPoliciesResponse

readList :: ReadS [ListKeyPoliciesResponse]

readPrec :: ReadPrec ListKeyPoliciesResponse

readListPrec :: ReadPrec [ListKeyPoliciesResponse]

Show ListKeyPoliciesResponse

Defined in Amazonka.KMS.ListKeyPolicies

Methods

showsPrec :: Int -> ListKeyPoliciesResponse -> ShowS

show :: ListKeyPoliciesResponse -> String

showList :: [ListKeyPoliciesResponse] -> ShowS

NFData ListKeyPoliciesResponse

Defined in Amazonka.KMS.ListKeyPolicies

Methods

rnf :: ListKeyPoliciesResponse -> ()

Eq ListKeyPoliciesResponse

Defined in Amazonka.KMS.ListKeyPolicies

Methods

(==) :: ListKeyPoliciesResponse -> ListKeyPoliciesResponse -> Bool

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

type Rep ListKeyPoliciesResponse

Defined in Amazonka.KMS.ListKeyPolicies

type Rep ListKeyPoliciesResponse = D1 ('MetaData "ListKeyPoliciesResponse" "Amazonka.KMS.ListKeyPolicies" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListKeyPoliciesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListKeyPoliciesResponse

Arguments

:: Int

$sel:httpStatus:ListKeyPoliciesResponse'

-> ListKeyPoliciesResponse

Create a value of ListKeyPoliciesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:policyNames:ListKeyPoliciesResponse', listKeyPoliciesResponse_policyNames - A list of key policy names. The only valid value is default.

ListKeyPoliciesResponse, listKeyPoliciesResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

$sel:httpStatus:ListKeyPoliciesResponse', listKeyPoliciesResponse_httpStatus - The response's http status code.

ListKeys (Paginated)

data ListKeys

See: newListKeys smart constructor.

Constructors

ListKeys' (Maybe Natural) (Maybe Text)

Instances

ToJSON ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

toJSON :: ListKeys -> Value

toEncoding :: ListKeys -> Encoding

toJSONList :: [ListKeys] -> Value

toEncodingList :: [ListKeys] -> Encoding

ToHeaders ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

toHeaders :: ListKeys -> [Header]

ToPath ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

toPath :: ListKeys -> ByteString

ToQuery ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

toQuery :: ListKeys -> QueryString

AWSPager ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

page :: ListKeys -> AWSResponse ListKeys -> Maybe ListKeys

AWSRequest ListKeys

Defined in Amazonka.KMS.ListKeys

Associated Types

type AWSResponse ListKeys

Methods

request :: (Service -> Service) -> ListKeys -> Request ListKeys

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListKeys)))

Generic ListKeys

Defined in Amazonka.KMS.ListKeys

Associated Types

type Rep ListKeys :: Type -> Type

Methods

from :: ListKeys -> Rep ListKeys x

to :: Rep ListKeys x -> ListKeys

Read ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

readsPrec :: Int -> ReadS ListKeys

readList :: ReadS [ListKeys]

readPrec :: ReadPrec ListKeys

readListPrec :: ReadPrec [ListKeys]

Show ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

showsPrec :: Int -> ListKeys -> ShowS

show :: ListKeys -> String

showList :: [ListKeys] -> ShowS

NFData ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

rnf :: ListKeys -> ()

Eq ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

(==) :: ListKeys -> ListKeys -> Bool

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

Hashable ListKeys

Defined in Amazonka.KMS.ListKeys

Methods

hashWithSalt :: Int -> ListKeys -> Int

hash :: ListKeys -> Int

type AWSResponse ListKeys

Defined in Amazonka.KMS.ListKeys

type AWSResponse ListKeys = ListKeysResponse

type Rep ListKeys

Defined in Amazonka.KMS.ListKeys

type Rep ListKeys = D1 ('MetaData "ListKeys" "Amazonka.KMS.ListKeys" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListKeys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListKeys :: ListKeys

Create a value of ListKeys with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListKeys', listKeys_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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.

$sel:marker:ListKeys', listKeys_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

data ListKeysResponse

See: newListKeysResponse smart constructor.

Constructors

ListKeysResponse' (Maybe [KeyListEntry]) (Maybe Text) (Maybe Bool) Int

Instances

Generic ListKeysResponse

Defined in Amazonka.KMS.ListKeys

Associated Types

type Rep ListKeysResponse :: Type -> Type

Methods

from :: ListKeysResponse -> Rep ListKeysResponse x

to :: Rep ListKeysResponse x -> ListKeysResponse

Read ListKeysResponse

Defined in Amazonka.KMS.ListKeys

Methods

readsPrec :: Int -> ReadS ListKeysResponse

readList :: ReadS [ListKeysResponse]

readPrec :: ReadPrec ListKeysResponse

readListPrec :: ReadPrec [ListKeysResponse]

Show ListKeysResponse

Defined in Amazonka.KMS.ListKeys

Methods

showsPrec :: Int -> ListKeysResponse -> ShowS

show :: ListKeysResponse -> String

showList :: [ListKeysResponse] -> ShowS

NFData ListKeysResponse

Defined in Amazonka.KMS.ListKeys

Methods

rnf :: ListKeysResponse -> ()

Eq ListKeysResponse

Defined in Amazonka.KMS.ListKeys

Methods

(==) :: ListKeysResponse -> ListKeysResponse -> Bool

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

type Rep ListKeysResponse

Defined in Amazonka.KMS.ListKeys

type Rep ListKeysResponse = D1 ('MetaData "ListKeysResponse" "Amazonka.KMS.ListKeys" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListKeysResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyListEntry])) :*: S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListKeysResponse

Arguments

:: Int

$sel:httpStatus:ListKeysResponse'

-> ListKeysResponse

Create a value of ListKeysResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keys:ListKeysResponse', listKeysResponse_keys - A list of KMS keys.

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

ListKeysResponse, listKeysResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

$sel:httpStatus:ListKeysResponse', listKeysResponse_httpStatus - The response's http status code.

ListResourceTags (Paginated)

data ListResourceTags

See: newListResourceTags smart constructor.

Constructors

ListResourceTags' (Maybe Natural) (Maybe Text) Text

Instances

ToJSON ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

toJSON :: ListResourceTags -> Value

toEncoding :: ListResourceTags -> Encoding

toJSONList :: [ListResourceTags] -> Value

toEncodingList :: [ListResourceTags] -> Encoding

ToHeaders ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

toHeaders :: ListResourceTags -> [Header]

ToPath ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

toPath :: ListResourceTags -> ByteString

ToQuery ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

toQuery :: ListResourceTags -> QueryString

AWSPager ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

page :: ListResourceTags -> AWSResponse ListResourceTags -> Maybe ListResourceTags

AWSRequest ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Associated Types

type AWSResponse ListResourceTags

Methods

request :: (Service -> Service) -> ListResourceTags -> Request ListResourceTags

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListResourceTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListResourceTags)))

Generic ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Associated Types

type Rep ListResourceTags :: Type -> Type

Methods

from :: ListResourceTags -> Rep ListResourceTags x

to :: Rep ListResourceTags x -> ListResourceTags

Read ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

readsPrec :: Int -> ReadS ListResourceTags

readList :: ReadS [ListResourceTags]

readPrec :: ReadPrec ListResourceTags

readListPrec :: ReadPrec [ListResourceTags]

Show ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

showsPrec :: Int -> ListResourceTags -> ShowS

show :: ListResourceTags -> String

showList :: [ListResourceTags] -> ShowS

NFData ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

rnf :: ListResourceTags -> ()

Eq ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

(==) :: ListResourceTags -> ListResourceTags -> Bool

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

Hashable ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

Methods

hashWithSalt :: Int -> ListResourceTags -> Int

hash :: ListResourceTags -> Int

type AWSResponse ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

type AWSResponse ListResourceTags = ListResourceTagsResponse

type Rep ListResourceTags

Defined in Amazonka.KMS.ListResourceTags

type Rep ListResourceTags = D1 ('MetaData "ListResourceTags" "Amazonka.KMS.ListResourceTags" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListResourceTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListResourceTags

Arguments

:: Text

ListResourceTags

-> ListResourceTags

Create a value of ListResourceTags with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListResourceTags', listResourceTags_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

$sel:marker:ListResourceTags', listResourceTags_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

ListResourceTags, listResourceTags_keyId - Gets tags on the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data ListResourceTagsResponse

See: newListResourceTagsResponse smart constructor.

Constructors

ListResourceTagsResponse' (Maybe Text) (Maybe [Tag]) (Maybe Bool) Int

Instances

Generic ListResourceTagsResponse

Defined in Amazonka.KMS.ListResourceTags

Associated Types

type Rep ListResourceTagsResponse :: Type -> Type

Methods

from :: ListResourceTagsResponse -> Rep ListResourceTagsResponse x

to :: Rep ListResourceTagsResponse x -> ListResourceTagsResponse

Read ListResourceTagsResponse

Defined in Amazonka.KMS.ListResourceTags

Methods

readsPrec :: Int -> ReadS ListResourceTagsResponse

readList :: ReadS [ListResourceTagsResponse]

readPrec :: ReadPrec ListResourceTagsResponse

readListPrec :: ReadPrec [ListResourceTagsResponse]

Show ListResourceTagsResponse

Defined in Amazonka.KMS.ListResourceTags

Methods

showsPrec :: Int -> ListResourceTagsResponse -> ShowS

show :: ListResourceTagsResponse -> String

showList :: [ListResourceTagsResponse] -> ShowS

NFData ListResourceTagsResponse

Defined in Amazonka.KMS.ListResourceTags

Methods

rnf :: ListResourceTagsResponse -> ()

Eq ListResourceTagsResponse

Defined in Amazonka.KMS.ListResourceTags

Methods

(==) :: ListResourceTagsResponse -> ListResourceTagsResponse -> Bool

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

type Rep ListResourceTagsResponse

Defined in Amazonka.KMS.ListResourceTags

type Rep ListResourceTagsResponse = D1 ('MetaData "ListResourceTagsResponse" "Amazonka.KMS.ListResourceTags" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListResourceTagsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListResourceTagsResponse

Arguments

:: Int

$sel:httpStatus:ListResourceTagsResponse'

-> ListResourceTagsResponse

Create a value of ListResourceTagsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

Do not assume or infer any information from this value.

$sel:tags:ListResourceTagsResponse', listResourceTagsResponse_tags - A list of tags. Each tag consists of a tag key and a tag value.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

ListResourceTagsResponse, listResourceTagsResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

$sel:httpStatus:ListResourceTagsResponse', listResourceTagsResponse_httpStatus - The response's http status code.

ListRetirableGrants (Paginated)

data ListRetirableGrants

See: newListRetirableGrants smart constructor.

Constructors

ListRetirableGrants' (Maybe Natural) (Maybe Text) Text

Instances

ToJSON ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

toJSON :: ListRetirableGrants -> Value

toEncoding :: ListRetirableGrants -> Encoding

toJSONList :: [ListRetirableGrants] -> Value

toEncodingList :: [ListRetirableGrants] -> Encoding

ToHeaders ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

toHeaders :: ListRetirableGrants -> [Header]

ToPath ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

toPath :: ListRetirableGrants -> ByteString

ToQuery ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

toQuery :: ListRetirableGrants -> QueryString

AWSPager ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

page :: ListRetirableGrants -> AWSResponse ListRetirableGrants -> Maybe ListRetirableGrants

AWSRequest ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Associated Types

type AWSResponse ListRetirableGrants

Methods

request :: (Service -> Service) -> ListRetirableGrants -> Request ListRetirableGrants

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRetirableGrants -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRetirableGrants)))

Generic ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Associated Types

type Rep ListRetirableGrants :: Type -> Type

Methods

from :: ListRetirableGrants -> Rep ListRetirableGrants x

to :: Rep ListRetirableGrants x -> ListRetirableGrants

Read ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

readsPrec :: Int -> ReadS ListRetirableGrants

readList :: ReadS [ListRetirableGrants]

readPrec :: ReadPrec ListRetirableGrants

readListPrec :: ReadPrec [ListRetirableGrants]

Show ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

showsPrec :: Int -> ListRetirableGrants -> ShowS

show :: ListRetirableGrants -> String

showList :: [ListRetirableGrants] -> ShowS

NFData ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

rnf :: ListRetirableGrants -> ()

Eq ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

(==) :: ListRetirableGrants -> ListRetirableGrants -> Bool

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

Hashable ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

Methods

hashWithSalt :: Int -> ListRetirableGrants -> Int

hash :: ListRetirableGrants -> Int

type AWSResponse ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

type AWSResponse ListRetirableGrants = ListGrantsResponse

type Rep ListRetirableGrants

Defined in Amazonka.KMS.ListRetirableGrants

type Rep ListRetirableGrants = D1 ('MetaData "ListRetirableGrants" "Amazonka.KMS.ListRetirableGrants" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListRetirableGrants'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "retiringPrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRetirableGrants

Arguments

:: Text

ListRetirableGrants

-> ListRetirableGrants

Create a value of ListRetirableGrants with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:ListRetirableGrants', listRetirableGrants_limit - Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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.

$sel:marker:ListRetirableGrants', listRetirableGrants_marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

ListRetirableGrants, listRetirableGrants_retiringPrincipal - The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.

data ListGrantsResponse

See: newListGrantsResponse smart constructor.

Constructors

ListGrantsResponse' (Maybe [GrantListEntry]) (Maybe Text) (Maybe Bool)

Instances

FromJSON ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

parseJSON :: Value -> Parser ListGrantsResponse

parseJSONList :: Value -> Parser [ListGrantsResponse]

Generic ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Associated Types

type Rep ListGrantsResponse :: Type -> Type

Methods

from :: ListGrantsResponse -> Rep ListGrantsResponse x

to :: Rep ListGrantsResponse x -> ListGrantsResponse

Read ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

readsPrec :: Int -> ReadS ListGrantsResponse

readList :: ReadS [ListGrantsResponse]

readPrec :: ReadPrec ListGrantsResponse

readListPrec :: ReadPrec [ListGrantsResponse]

Show ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

showsPrec :: Int -> ListGrantsResponse -> ShowS

show :: ListGrantsResponse -> String

showList :: [ListGrantsResponse] -> ShowS

NFData ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

rnf :: ListGrantsResponse -> ()

Eq ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

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

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

Hashable ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

hashWithSalt :: Int -> ListGrantsResponse -> Int

hash :: ListGrantsResponse -> Int

type Rep ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

type Rep ListGrantsResponse = D1 ('MetaData "ListGrantsResponse" "Amazonka.KMS.Types.ListGrantsResponse" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListGrantsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GrantListEntry])) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newListGrantsResponse :: ListGrantsResponse

Create a value of ListGrantsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grants:ListGrantsResponse', listGrantsResponse_grants - A list of grants.

$sel:nextMarker:ListGrantsResponse', listGrantsResponse_nextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

$sel:truncated:ListGrantsResponse', listGrantsResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

PutKeyPolicy

data PutKeyPolicy

See: newPutKeyPolicy smart constructor.

Constructors

PutKeyPolicy' (Maybe Bool) Text Text Text

Instances

ToJSON PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

toJSON :: PutKeyPolicy -> Value

toEncoding :: PutKeyPolicy -> Encoding

toJSONList :: [PutKeyPolicy] -> Value

toEncodingList :: [PutKeyPolicy] -> Encoding

ToHeaders PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

toHeaders :: PutKeyPolicy -> [Header]

ToPath PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

toPath :: PutKeyPolicy -> ByteString

ToQuery PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

toQuery :: PutKeyPolicy -> QueryString

AWSRequest PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Associated Types

type AWSResponse PutKeyPolicy

Methods

request :: (Service -> Service) -> PutKeyPolicy -> Request PutKeyPolicy

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutKeyPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutKeyPolicy)))

Generic PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Associated Types

type Rep PutKeyPolicy :: Type -> Type

Methods

from :: PutKeyPolicy -> Rep PutKeyPolicy x

to :: Rep PutKeyPolicy x -> PutKeyPolicy

Read PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

readsPrec :: Int -> ReadS PutKeyPolicy

readList :: ReadS [PutKeyPolicy]

readPrec :: ReadPrec PutKeyPolicy

readListPrec :: ReadPrec [PutKeyPolicy]

Show PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

showsPrec :: Int -> PutKeyPolicy -> ShowS

show :: PutKeyPolicy -> String

showList :: [PutKeyPolicy] -> ShowS

NFData PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

rnf :: PutKeyPolicy -> ()

Eq PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

(==) :: PutKeyPolicy -> PutKeyPolicy -> Bool

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

Hashable PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

Methods

hashWithSalt :: Int -> PutKeyPolicy -> Int

hash :: PutKeyPolicy -> Int

type AWSResponse PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

type AWSResponse PutKeyPolicy = PutKeyPolicyResponse

type Rep PutKeyPolicy

Defined in Amazonka.KMS.PutKeyPolicy

type Rep PutKeyPolicy = D1 ('MetaData "PutKeyPolicy" "Amazonka.KMS.PutKeyPolicy" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "PutKeyPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bypassPolicyLockoutSafetyCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutKeyPolicy

Arguments

:: Text

PutKeyPolicy

-> Text

$sel:policyName:PutKeyPolicy'

-> Text

$sel:policy:PutKeyPolicy'

-> PutKeyPolicy

Create a value of PutKeyPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bypassPolicyLockoutSafetyCheck:PutKeyPolicy', putKeyPolicy_bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

PutKeyPolicy, putKeyPolicy_keyId - Sets the key policy on the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:policyName:PutKeyPolicy', putKeyPolicy_policyName - The name of the key policy. The only valid value is default.

$sel:policy:PutKeyPolicy', putKeyPolicy_policy - The key policy to attach to the KMS key.

The key policy must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide.
• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the /Amazon Web Services Identity and Access Management User Guide/.

A key policy document can include only the following characters:

• Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.
• Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).
• The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the /Identity and Access Management User Guide/ .

data PutKeyPolicyResponse

See: newPutKeyPolicyResponse smart constructor.

Constructors

PutKeyPolicyResponse'

Instances

Generic PutKeyPolicyResponse

Defined in Amazonka.KMS.PutKeyPolicy

Associated Types

type Rep PutKeyPolicyResponse :: Type -> Type

Methods

from :: PutKeyPolicyResponse -> Rep PutKeyPolicyResponse x

to :: Rep PutKeyPolicyResponse x -> PutKeyPolicyResponse

Read PutKeyPolicyResponse

Defined in Amazonka.KMS.PutKeyPolicy

Methods

readsPrec :: Int -> ReadS PutKeyPolicyResponse

readList :: ReadS [PutKeyPolicyResponse]

readPrec :: ReadPrec PutKeyPolicyResponse

readListPrec :: ReadPrec [PutKeyPolicyResponse]

Show PutKeyPolicyResponse

Defined in Amazonka.KMS.PutKeyPolicy

Methods

showsPrec :: Int -> PutKeyPolicyResponse -> ShowS

show :: PutKeyPolicyResponse -> String

showList :: [PutKeyPolicyResponse] -> ShowS

NFData PutKeyPolicyResponse

Defined in Amazonka.KMS.PutKeyPolicy

Methods

rnf :: PutKeyPolicyResponse -> ()

Eq PutKeyPolicyResponse

Defined in Amazonka.KMS.PutKeyPolicy

Methods

(==) :: PutKeyPolicyResponse -> PutKeyPolicyResponse -> Bool

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

type Rep PutKeyPolicyResponse

Defined in Amazonka.KMS.PutKeyPolicy

type Rep PutKeyPolicyResponse = D1 ('MetaData "PutKeyPolicyResponse" "Amazonka.KMS.PutKeyPolicy" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "PutKeyPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutKeyPolicyResponse :: PutKeyPolicyResponse

Create a value of PutKeyPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

ReEncrypt

data ReEncrypt

See: newReEncrypt smart constructor.

Constructors

ReEncrypt' (Maybe EncryptionAlgorithmSpec) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) (Maybe (HashMap Text Text)) (Maybe Text) Base64 Text

Instances

ToJSON ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

toJSON :: ReEncrypt -> Value

toEncoding :: ReEncrypt -> Encoding

toJSONList :: [ReEncrypt] -> Value

toEncodingList :: [ReEncrypt] -> Encoding

ToHeaders ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

toHeaders :: ReEncrypt -> [Header]

ToPath ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

toPath :: ReEncrypt -> ByteString

ToQuery ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

toQuery :: ReEncrypt -> QueryString

AWSRequest ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Associated Types

type AWSResponse ReEncrypt

Methods

request :: (Service -> Service) -> ReEncrypt -> Request ReEncrypt

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ReEncrypt -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReEncrypt)))

Generic ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Associated Types

type Rep ReEncrypt :: Type -> Type

Methods

from :: ReEncrypt -> Rep ReEncrypt x

to :: Rep ReEncrypt x -> ReEncrypt

Read ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

readsPrec :: Int -> ReadS ReEncrypt

readList :: ReadS [ReEncrypt]

readPrec :: ReadPrec ReEncrypt

readListPrec :: ReadPrec [ReEncrypt]

Show ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

showsPrec :: Int -> ReEncrypt -> ShowS

show :: ReEncrypt -> String

showList :: [ReEncrypt] -> ShowS

NFData ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

rnf :: ReEncrypt -> ()

Eq ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

(==) :: ReEncrypt -> ReEncrypt -> Bool

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

Hashable ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

Methods

hashWithSalt :: Int -> ReEncrypt -> Int

hash :: ReEncrypt -> Int

type AWSResponse ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

type AWSResponse ReEncrypt = ReEncryptResponse

type Rep ReEncrypt

Defined in Amazonka.KMS.ReEncrypt

type Rep ReEncrypt = D1 ('MetaData "ReEncrypt" "Amazonka.KMS.ReEncrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ReEncrypt'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "destinationEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "destinationEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sourceEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)))) :*: ((S1 ('MetaSel ('Just "sourceEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "sourceKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "destinationKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newReEncrypt

Arguments

:: ByteString

ReEncrypt

-> Text

$sel:destinationKeyId:ReEncrypt'

-> ReEncrypt

Create a value of ReEncrypt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ReEncrypt, reEncrypt_destinationEncryptionAlgorithm - Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric encryption KMS keys.

This parameter is required only when the destination KMS key is an asymmetric KMS key.

$sel:destinationEncryptionContext:ReEncrypt', reEncrypt_destinationEncryptionContext - Specifies that encryption context to use when the reencrypting the data.

A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

$sel:grantTokens:ReEncrypt', reEncrypt_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

ReEncrypt, reEncrypt_sourceEncryptionAlgorithm - Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric encryption KMS keys.

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

$sel:sourceEncryptionContext:ReEncrypt', reEncrypt_sourceEncryptionContext - Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

ReEncrypt, reEncrypt_sourceKeyId - Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

ReEncrypt, reEncrypt_ciphertextBlob - Ciphertext of the data to reencrypt.-- -- 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.

$sel:destinationKeyId:ReEncrypt', reEncrypt_destinationKeyId - A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

data ReEncryptResponse

See: newReEncryptResponse smart constructor.

Constructors

ReEncryptResponse' (Maybe Base64) (Maybe EncryptionAlgorithmSpec) (Maybe Text) (Maybe EncryptionAlgorithmSpec) (Maybe Text) Int

Instances

Generic ReEncryptResponse

Defined in Amazonka.KMS.ReEncrypt

Associated Types

type Rep ReEncryptResponse :: Type -> Type

Methods

from :: ReEncryptResponse -> Rep ReEncryptResponse x

to :: Rep ReEncryptResponse x -> ReEncryptResponse

Read ReEncryptResponse

Defined in Amazonka.KMS.ReEncrypt

Methods

readsPrec :: Int -> ReadS ReEncryptResponse

readList :: ReadS [ReEncryptResponse]

readPrec :: ReadPrec ReEncryptResponse

readListPrec :: ReadPrec [ReEncryptResponse]

Show ReEncryptResponse

Defined in Amazonka.KMS.ReEncrypt

Methods

showsPrec :: Int -> ReEncryptResponse -> ShowS

show :: ReEncryptResponse -> String

showList :: [ReEncryptResponse] -> ShowS

NFData ReEncryptResponse

Defined in Amazonka.KMS.ReEncrypt

Methods

rnf :: ReEncryptResponse -> ()

Eq ReEncryptResponse

Defined in Amazonka.KMS.ReEncrypt

Methods

(==) :: ReEncryptResponse -> ReEncryptResponse -> Bool

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

type Rep ReEncryptResponse

Defined in Amazonka.KMS.ReEncrypt

type Rep ReEncryptResponse = D1 ('MetaData "ReEncryptResponse" "Amazonka.KMS.ReEncrypt" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ReEncryptResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: (S1 ('MetaSel ('Just "destinationEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sourceEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :*: (S1 ('MetaSel ('Just "sourceKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newReEncryptResponse

Arguments

:: Int

$sel:httpStatus:ReEncryptResponse'

-> ReEncryptResponse

Create a value of ReEncryptResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ReEncrypt, reEncryptResponse_ciphertextBlob - The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

ReEncrypt, reEncryptResponse_destinationEncryptionAlgorithm - The encryption algorithm that was used to reencrypt the data.

ReEncryptResponse, reEncryptResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.

ReEncrypt, reEncryptResponse_sourceEncryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.

ReEncrypt, reEncryptResponse_sourceKeyId - Unique identifier of the KMS key used to originally encrypt the data.

$sel:httpStatus:ReEncryptResponse', reEncryptResponse_httpStatus - The response's http status code.

ReplicateKey

data ReplicateKey

See: newReplicateKey smart constructor.

Constructors

ReplicateKey' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text

Instances

ToJSON ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

toJSON :: ReplicateKey -> Value

toEncoding :: ReplicateKey -> Encoding

toJSONList :: [ReplicateKey] -> Value

toEncodingList :: [ReplicateKey] -> Encoding

ToHeaders ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

toHeaders :: ReplicateKey -> [Header]

ToPath ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

toPath :: ReplicateKey -> ByteString

ToQuery ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

toQuery :: ReplicateKey -> QueryString

AWSRequest ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Associated Types

type AWSResponse ReplicateKey

Methods

request :: (Service -> Service) -> ReplicateKey -> Request ReplicateKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ReplicateKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReplicateKey)))

Generic ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Associated Types

type Rep ReplicateKey :: Type -> Type

Methods

from :: ReplicateKey -> Rep ReplicateKey x

to :: Rep ReplicateKey x -> ReplicateKey

Read ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

readsPrec :: Int -> ReadS ReplicateKey

readList :: ReadS [ReplicateKey]

readPrec :: ReadPrec ReplicateKey

readListPrec :: ReadPrec [ReplicateKey]

Show ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

showsPrec :: Int -> ReplicateKey -> ShowS

show :: ReplicateKey -> String

showList :: [ReplicateKey] -> ShowS

NFData ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

rnf :: ReplicateKey -> ()

Eq ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

(==) :: ReplicateKey -> ReplicateKey -> Bool

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

Hashable ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

Methods

hashWithSalt :: Int -> ReplicateKey -> Int

hash :: ReplicateKey -> Int

type AWSResponse ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

type AWSResponse ReplicateKey = ReplicateKeyResponse

type Rep ReplicateKey

Defined in Amazonka.KMS.ReplicateKey

type Rep ReplicateKey = D1 ('MetaData "ReplicateKey" "Amazonka.KMS.ReplicateKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ReplicateKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bypassPolicyLockoutSafetyCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "replicaRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newReplicateKey

Arguments

:: Text

ReplicateKey

-> Text

$sel:replicaRegion:ReplicateKey'

-> ReplicateKey

Create a value of ReplicateKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bypassPolicyLockoutSafetyCheck:ReplicateKey', replicateKey_bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

The default value is false.

ReplicateKey, replicateKey_description - A description of the KMS key. The default value is an empty string (no description).

The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

$sel:policy:ReplicateKey', replicateKey_policy - The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.

The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.

If you provide a key policy, it must meet the following criteria:

• If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ .
• Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the /Identity and Access Management User Guide/ .

A key policy document can include only the following characters:

• Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.
• Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).
• The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the /Identity and Access Management User Guide/ .

$sel:tags:ReplicateKey', replicateKey_tags - Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

ReplicateKey, replicateKey_keyId - Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

• Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:replicaRegion:ReplicateKey', replicateKey_replicaRegion - The Region ID of the Amazon Web Services Region for this replica key.

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the ReplicateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.

data ReplicateKeyResponse

See: newReplicateKeyResponse smart constructor.

Constructors

ReplicateKeyResponse' (Maybe KeyMetadata) (Maybe Text) (Maybe [Tag]) Int

Instances

Generic ReplicateKeyResponse

Defined in Amazonka.KMS.ReplicateKey

Associated Types

type Rep ReplicateKeyResponse :: Type -> Type

Methods

from :: ReplicateKeyResponse -> Rep ReplicateKeyResponse x

to :: Rep ReplicateKeyResponse x -> ReplicateKeyResponse

Read ReplicateKeyResponse

Defined in Amazonka.KMS.ReplicateKey

Methods

readsPrec :: Int -> ReadS ReplicateKeyResponse

readList :: ReadS [ReplicateKeyResponse]

readPrec :: ReadPrec ReplicateKeyResponse

readListPrec :: ReadPrec [ReplicateKeyResponse]

Show ReplicateKeyResponse

Defined in Amazonka.KMS.ReplicateKey

Methods

showsPrec :: Int -> ReplicateKeyResponse -> ShowS

show :: ReplicateKeyResponse -> String

showList :: [ReplicateKeyResponse] -> ShowS

NFData ReplicateKeyResponse

Defined in Amazonka.KMS.ReplicateKey

Methods

rnf :: ReplicateKeyResponse -> ()

Eq ReplicateKeyResponse

Defined in Amazonka.KMS.ReplicateKey

Methods

(==) :: ReplicateKeyResponse -> ReplicateKeyResponse -> Bool

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

type Rep ReplicateKeyResponse

Defined in Amazonka.KMS.ReplicateKey

type Rep ReplicateKeyResponse = D1 ('MetaData "ReplicateKeyResponse" "Amazonka.KMS.ReplicateKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ReplicateKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "replicaKeyMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyMetadata)) :*: S1 ('MetaSel ('Just "replicaPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "replicaTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newReplicateKeyResponse

Arguments

:: Int

$sel:httpStatus:ReplicateKeyResponse'

-> ReplicateKeyResponse

Create a value of ReplicateKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:replicaKeyMetadata:ReplicateKeyResponse', replicateKeyResponse_replicaKeyMetadata - Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

$sel:replicaPolicy:ReplicateKeyResponse', replicateKeyResponse_replicaPolicy - The key policy of the new replica key. The value is a key policy document in JSON format.

$sel:replicaTags:ReplicateKeyResponse', replicateKeyResponse_replicaTags - The tags on the new replica key. The value is a list of tag key and tag value pairs.

$sel:httpStatus:ReplicateKeyResponse', replicateKeyResponse_httpStatus - The response's http status code.

RetireGrant

data RetireGrant

See: newRetireGrant smart constructor.

Constructors

RetireGrant' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

ToJSON RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

toJSON :: RetireGrant -> Value

toEncoding :: RetireGrant -> Encoding

toJSONList :: [RetireGrant] -> Value

toEncodingList :: [RetireGrant] -> Encoding

ToHeaders RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

toHeaders :: RetireGrant -> [Header]

ToPath RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

toPath :: RetireGrant -> ByteString

ToQuery RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

toQuery :: RetireGrant -> QueryString

AWSRequest RetireGrant

Defined in Amazonka.KMS.RetireGrant

Associated Types

type AWSResponse RetireGrant

Methods

request :: (Service -> Service) -> RetireGrant -> Request RetireGrant

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RetireGrant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RetireGrant)))

Generic RetireGrant

Defined in Amazonka.KMS.RetireGrant

Associated Types

type Rep RetireGrant :: Type -> Type

Methods

from :: RetireGrant -> Rep RetireGrant x

to :: Rep RetireGrant x -> RetireGrant

Read RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

readsPrec :: Int -> ReadS RetireGrant

readList :: ReadS [RetireGrant]

readPrec :: ReadPrec RetireGrant

readListPrec :: ReadPrec [RetireGrant]

Show RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

showsPrec :: Int -> RetireGrant -> ShowS

show :: RetireGrant -> String

showList :: [RetireGrant] -> ShowS

NFData RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

rnf :: RetireGrant -> ()

Eq RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

(==) :: RetireGrant -> RetireGrant -> Bool

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

Hashable RetireGrant

Defined in Amazonka.KMS.RetireGrant

Methods

hashWithSalt :: Int -> RetireGrant -> Int

hash :: RetireGrant -> Int

type AWSResponse RetireGrant

Defined in Amazonka.KMS.RetireGrant

type AWSResponse RetireGrant = RetireGrantResponse

type Rep RetireGrant

Defined in Amazonka.KMS.RetireGrant

type Rep RetireGrant = D1 ('MetaData "RetireGrant" "Amazonka.KMS.RetireGrant" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "RetireGrant'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "grantToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newRetireGrant :: RetireGrant

Create a value of RetireGrant with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RetireGrant, retireGrant_grantId - Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

$sel:grantToken:RetireGrant', retireGrant_grantToken - Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

RetireGrant, retireGrant_keyId - The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

data RetireGrantResponse

See: newRetireGrantResponse smart constructor.

Constructors

RetireGrantResponse'

Instances

Generic RetireGrantResponse

Defined in Amazonka.KMS.RetireGrant

Associated Types

type Rep RetireGrantResponse :: Type -> Type

Methods

from :: RetireGrantResponse -> Rep RetireGrantResponse x

to :: Rep RetireGrantResponse x -> RetireGrantResponse

Read RetireGrantResponse

Defined in Amazonka.KMS.RetireGrant

Methods

readsPrec :: Int -> ReadS RetireGrantResponse

readList :: ReadS [RetireGrantResponse]

readPrec :: ReadPrec RetireGrantResponse

readListPrec :: ReadPrec [RetireGrantResponse]

Show RetireGrantResponse

Defined in Amazonka.KMS.RetireGrant

Methods

showsPrec :: Int -> RetireGrantResponse -> ShowS

show :: RetireGrantResponse -> String

showList :: [RetireGrantResponse] -> ShowS

NFData RetireGrantResponse

Defined in Amazonka.KMS.RetireGrant

Methods

rnf :: RetireGrantResponse -> ()

Eq RetireGrantResponse

Defined in Amazonka.KMS.RetireGrant

Methods

(==) :: RetireGrantResponse -> RetireGrantResponse -> Bool

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

type Rep RetireGrantResponse

Defined in Amazonka.KMS.RetireGrant

type Rep RetireGrantResponse = D1 ('MetaData "RetireGrantResponse" "Amazonka.KMS.RetireGrant" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "RetireGrantResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRetireGrantResponse :: RetireGrantResponse

Create a value of RetireGrantResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

RevokeGrant

data RevokeGrant

See: newRevokeGrant smart constructor.

Constructors

RevokeGrant' Text Text

Instances

ToJSON RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

toJSON :: RevokeGrant -> Value

toEncoding :: RevokeGrant -> Encoding

toJSONList :: [RevokeGrant] -> Value

toEncodingList :: [RevokeGrant] -> Encoding

ToHeaders RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

toHeaders :: RevokeGrant -> [Header]

ToPath RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

toPath :: RevokeGrant -> ByteString

ToQuery RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

toQuery :: RevokeGrant -> QueryString

AWSRequest RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Associated Types

type AWSResponse RevokeGrant

Methods

request :: (Service -> Service) -> RevokeGrant -> Request RevokeGrant

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RevokeGrant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RevokeGrant)))

Generic RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Associated Types

type Rep RevokeGrant :: Type -> Type

Methods

from :: RevokeGrant -> Rep RevokeGrant x

to :: Rep RevokeGrant x -> RevokeGrant

Read RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

readsPrec :: Int -> ReadS RevokeGrant

readList :: ReadS [RevokeGrant]

readPrec :: ReadPrec RevokeGrant

readListPrec :: ReadPrec [RevokeGrant]

Show RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

showsPrec :: Int -> RevokeGrant -> ShowS

show :: RevokeGrant -> String

showList :: [RevokeGrant] -> ShowS

NFData RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

rnf :: RevokeGrant -> ()

Eq RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

(==) :: RevokeGrant -> RevokeGrant -> Bool

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

Hashable RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

Methods

hashWithSalt :: Int -> RevokeGrant -> Int

hash :: RevokeGrant -> Int

type AWSResponse RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

type AWSResponse RevokeGrant = RevokeGrantResponse

type Rep RevokeGrant

Defined in Amazonka.KMS.RevokeGrant

type Rep RevokeGrant = D1 ('MetaData "RevokeGrant" "Amazonka.KMS.RevokeGrant" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "RevokeGrant'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "grantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRevokeGrant

Arguments

:: Text

RevokeGrant

-> Text

RevokeGrant

-> RevokeGrant

Create a value of RevokeGrant with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RevokeGrant, revokeGrant_keyId - A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

RevokeGrant, revokeGrant_grantId - Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

data RevokeGrantResponse

See: newRevokeGrantResponse smart constructor.

Constructors

RevokeGrantResponse'

Instances

Generic RevokeGrantResponse

Defined in Amazonka.KMS.RevokeGrant

Associated Types

type Rep RevokeGrantResponse :: Type -> Type

Methods

from :: RevokeGrantResponse -> Rep RevokeGrantResponse x

to :: Rep RevokeGrantResponse x -> RevokeGrantResponse

Read RevokeGrantResponse

Defined in Amazonka.KMS.RevokeGrant

Methods

readsPrec :: Int -> ReadS RevokeGrantResponse

readList :: ReadS [RevokeGrantResponse]

readPrec :: ReadPrec RevokeGrantResponse

readListPrec :: ReadPrec [RevokeGrantResponse]

Show RevokeGrantResponse

Defined in Amazonka.KMS.RevokeGrant

Methods

showsPrec :: Int -> RevokeGrantResponse -> ShowS

show :: RevokeGrantResponse -> String

showList :: [RevokeGrantResponse] -> ShowS

NFData RevokeGrantResponse

Defined in Amazonka.KMS.RevokeGrant

Methods

rnf :: RevokeGrantResponse -> ()

Eq RevokeGrantResponse

Defined in Amazonka.KMS.RevokeGrant

Methods

(==) :: RevokeGrantResponse -> RevokeGrantResponse -> Bool

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

type Rep RevokeGrantResponse

Defined in Amazonka.KMS.RevokeGrant

type Rep RevokeGrantResponse = D1 ('MetaData "RevokeGrantResponse" "Amazonka.KMS.RevokeGrant" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "RevokeGrantResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRevokeGrantResponse :: RevokeGrantResponse

Create a value of RevokeGrantResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

ScheduleKeyDeletion

data ScheduleKeyDeletion

See: newScheduleKeyDeletion smart constructor.

Constructors

ScheduleKeyDeletion' (Maybe Natural) Text

Instances

ToJSON ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

toJSON :: ScheduleKeyDeletion -> Value

toEncoding :: ScheduleKeyDeletion -> Encoding

toJSONList :: [ScheduleKeyDeletion] -> Value

toEncodingList :: [ScheduleKeyDeletion] -> Encoding

ToHeaders ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

toHeaders :: ScheduleKeyDeletion -> [Header]

ToPath ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

toPath :: ScheduleKeyDeletion -> ByteString

ToQuery ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

toQuery :: ScheduleKeyDeletion -> QueryString

AWSRequest ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Associated Types

type AWSResponse ScheduleKeyDeletion

Methods

request :: (Service -> Service) -> ScheduleKeyDeletion -> Request ScheduleKeyDeletion

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ScheduleKeyDeletion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ScheduleKeyDeletion)))

Generic ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Associated Types

type Rep ScheduleKeyDeletion :: Type -> Type

Methods

from :: ScheduleKeyDeletion -> Rep ScheduleKeyDeletion x

to :: Rep ScheduleKeyDeletion x -> ScheduleKeyDeletion

Read ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

readsPrec :: Int -> ReadS ScheduleKeyDeletion

readList :: ReadS [ScheduleKeyDeletion]

readPrec :: ReadPrec ScheduleKeyDeletion

readListPrec :: ReadPrec [ScheduleKeyDeletion]

Show ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

showsPrec :: Int -> ScheduleKeyDeletion -> ShowS

show :: ScheduleKeyDeletion -> String

showList :: [ScheduleKeyDeletion] -> ShowS

NFData ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

rnf :: ScheduleKeyDeletion -> ()

Eq ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

(==) :: ScheduleKeyDeletion -> ScheduleKeyDeletion -> Bool

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

Hashable ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

hashWithSalt :: Int -> ScheduleKeyDeletion -> Int

hash :: ScheduleKeyDeletion -> Int

type AWSResponse ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

type AWSResponse ScheduleKeyDeletion = ScheduleKeyDeletionResponse

type Rep ScheduleKeyDeletion

Defined in Amazonka.KMS.ScheduleKeyDeletion

type Rep ScheduleKeyDeletion = D1 ('MetaData "ScheduleKeyDeletion" "Amazonka.KMS.ScheduleKeyDeletion" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ScheduleKeyDeletion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pendingWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newScheduleKeyDeletion

Arguments

:: Text

ScheduleKeyDeletion

-> ScheduleKeyDeletion

Create a value of ScheduleKeyDeletion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ScheduleKeyDeletion, scheduleKeyDeletion_pendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

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.

ScheduleKeyDeletion, scheduleKeyDeletion_keyId - The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

data ScheduleKeyDeletionResponse

See: newScheduleKeyDeletionResponse smart constructor.

Constructors

ScheduleKeyDeletionResponse' (Maybe POSIX) (Maybe Text) (Maybe KeyState) (Maybe Natural) Int

Instances

Generic ScheduleKeyDeletionResponse

Defined in Amazonka.KMS.ScheduleKeyDeletion

Associated Types

type Rep ScheduleKeyDeletionResponse :: Type -> Type

Methods

from :: ScheduleKeyDeletionResponse -> Rep ScheduleKeyDeletionResponse x

to :: Rep ScheduleKeyDeletionResponse x -> ScheduleKeyDeletionResponse

Read ScheduleKeyDeletionResponse

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

readsPrec :: Int -> ReadS ScheduleKeyDeletionResponse

readList :: ReadS [ScheduleKeyDeletionResponse]

readPrec :: ReadPrec ScheduleKeyDeletionResponse

readListPrec :: ReadPrec [ScheduleKeyDeletionResponse]

Show ScheduleKeyDeletionResponse

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

showsPrec :: Int -> ScheduleKeyDeletionResponse -> ShowS

show :: ScheduleKeyDeletionResponse -> String

showList :: [ScheduleKeyDeletionResponse] -> ShowS

NFData ScheduleKeyDeletionResponse

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

rnf :: ScheduleKeyDeletionResponse -> ()

Eq ScheduleKeyDeletionResponse

Defined in Amazonka.KMS.ScheduleKeyDeletion

Methods

(==) :: ScheduleKeyDeletionResponse -> ScheduleKeyDeletionResponse -> Bool

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

type Rep ScheduleKeyDeletionResponse

Defined in Amazonka.KMS.ScheduleKeyDeletion

type Rep ScheduleKeyDeletionResponse = D1 ('MetaData "ScheduleKeyDeletionResponse" "Amazonka.KMS.ScheduleKeyDeletion" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ScheduleKeyDeletionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "keyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyState)) :*: (S1 ('MetaSel ('Just "pendingWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newScheduleKeyDeletionResponse

Arguments

:: Int

$sel:httpStatus:ScheduleKeyDeletionResponse'

-> ScheduleKeyDeletionResponse

Create a value of ScheduleKeyDeletionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ScheduleKeyDeletionResponse, scheduleKeyDeletionResponse_deletionDate - The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

ScheduleKeyDeletion, scheduleKeyDeletionResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

ScheduleKeyDeletionResponse, scheduleKeyDeletionResponse_keyState - The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

ScheduleKeyDeletion, scheduleKeyDeletionResponse_pendingWindowInDays - The waiting period before the KMS key is deleted.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

$sel:httpStatus:ScheduleKeyDeletionResponse', scheduleKeyDeletionResponse_httpStatus - The response's http status code.

Sign

data Sign

See: newSign smart constructor.

Constructors

Sign' (Maybe [Text]) (Maybe MessageType) Text (Sensitive Base64) SigningAlgorithmSpec

Instances

ToJSON Sign

Defined in Amazonka.KMS.Sign

Methods

toJSON :: Sign -> Value

toEncoding :: Sign -> Encoding

toJSONList :: [Sign] -> Value

toEncodingList :: [Sign] -> Encoding

ToHeaders Sign

Defined in Amazonka.KMS.Sign

Methods

toHeaders :: Sign -> [Header]

ToPath Sign

Defined in Amazonka.KMS.Sign

Methods

toPath :: Sign -> ByteString

ToQuery Sign

Defined in Amazonka.KMS.Sign

Methods

toQuery :: Sign -> QueryString

AWSRequest Sign

Defined in Amazonka.KMS.Sign

Associated Types

type AWSResponse Sign

Methods

request :: (Service -> Service) -> Sign -> Request Sign

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Sign -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Sign)))

Generic Sign

Defined in Amazonka.KMS.Sign

Associated Types

type Rep Sign :: Type -> Type

Methods

from :: Sign -> Rep Sign x

to :: Rep Sign x -> Sign

Show Sign

Defined in Amazonka.KMS.Sign

Methods

showsPrec :: Int -> Sign -> ShowS

show :: Sign -> String

showList :: [Sign] -> ShowS

NFData Sign

Defined in Amazonka.KMS.Sign

Methods

rnf :: Sign -> ()

Eq Sign

Defined in Amazonka.KMS.Sign

Methods

(==) :: Sign -> Sign -> Bool

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

Hashable Sign

Defined in Amazonka.KMS.Sign

Methods

hashWithSalt :: Int -> Sign -> Int

hash :: Sign -> Int

type AWSResponse Sign

Defined in Amazonka.KMS.Sign

type AWSResponse Sign = SignResponse

type Rep Sign

Defined in Amazonka.KMS.Sign

type Rep Sign = D1 ('MetaData "Sign" "Amazonka.KMS.Sign" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Sign'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64)) :*: S1 ('MetaSel ('Just "signingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SigningAlgorithmSpec)))))

newSign

Arguments

:: Text

Sign

-> ByteString

$sel:message:Sign'

-> SigningAlgorithmSpec

Sign

-> Sign

Create a value of Sign with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grantTokens:Sign', sign_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:messageType:Sign', sign_messageType - Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Sign, sign_keyId - Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

$sel:message:Sign', sign_message - Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.

If you provide a message, KMS generates a hash digest of the message and then signs 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.

Sign, sign_signingAlgorithm - Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.

data SignResponse

See: newSignResponse smart constructor.

Constructors

SignResponse' (Maybe Text) (Maybe Base64) (Maybe SigningAlgorithmSpec) Int

Instances

Generic SignResponse

Defined in Amazonka.KMS.Sign

Associated Types

type Rep SignResponse :: Type -> Type

Methods

from :: SignResponse -> Rep SignResponse x

to :: Rep SignResponse x -> SignResponse

Read SignResponse

Defined in Amazonka.KMS.Sign

Methods

readsPrec :: Int -> ReadS SignResponse

readList :: ReadS [SignResponse]

readPrec :: ReadPrec SignResponse

readListPrec :: ReadPrec [SignResponse]

Show SignResponse

Defined in Amazonka.KMS.Sign

Methods

showsPrec :: Int -> SignResponse -> ShowS

show :: SignResponse -> String

showList :: [SignResponse] -> ShowS

NFData SignResponse

Defined in Amazonka.KMS.Sign

Methods

rnf :: SignResponse -> ()

Eq SignResponse

Defined in Amazonka.KMS.Sign

Methods

(==) :: SignResponse -> SignResponse -> Bool

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

type Rep SignResponse

Defined in Amazonka.KMS.Sign

type Rep SignResponse = D1 ('MetaData "SignResponse" "Amazonka.KMS.Sign" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "SignResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :*: (S1 ('MetaSel ('Just "signingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SigningAlgorithmSpec)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSignResponse

Arguments

:: Int

$sel:httpStatus:SignResponse'

-> SignResponse

Create a value of SignResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Sign, signResponse_keyId - The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

$sel:signature:SignResponse', signResponse_signature - The cryptographic signature that was generated for the message.

• When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
• When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-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.

Sign, signResponse_signingAlgorithm - The signing algorithm that was used to sign the message.

$sel:httpStatus:SignResponse', signResponse_httpStatus - The response's http status code.

TagResource

data TagResource

See: newTagResource smart constructor.

Constructors

TagResource' Text [Tag]

Instances

ToJSON TagResource

Defined in Amazonka.KMS.TagResource

Methods

toJSON :: TagResource -> Value

toEncoding :: TagResource -> Encoding

toJSONList :: [TagResource] -> Value

toEncodingList :: [TagResource] -> Encoding

ToHeaders TagResource

Defined in Amazonka.KMS.TagResource

Methods

toHeaders :: TagResource -> [Header]

ToPath TagResource

Defined in Amazonka.KMS.TagResource

Methods

toPath :: TagResource -> ByteString

ToQuery TagResource

Defined in Amazonka.KMS.TagResource

Methods

toQuery :: TagResource -> QueryString

AWSRequest TagResource

Defined in Amazonka.KMS.TagResource

Associated Types

type AWSResponse TagResource

Methods

request :: (Service -> Service) -> TagResource -> Request TagResource

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource)))

Generic TagResource

Defined in Amazonka.KMS.TagResource

Associated Types

type Rep TagResource :: Type -> Type

Methods

from :: TagResource -> Rep TagResource x

to :: Rep TagResource x -> TagResource

Read TagResource

Defined in Amazonka.KMS.TagResource

Methods

readsPrec :: Int -> ReadS TagResource

readList :: ReadS [TagResource]

readPrec :: ReadPrec TagResource

readListPrec :: ReadPrec [TagResource]

Show TagResource

Defined in Amazonka.KMS.TagResource

Methods

showsPrec :: Int -> TagResource -> ShowS

show :: TagResource -> String

showList :: [TagResource] -> ShowS

NFData TagResource

Defined in Amazonka.KMS.TagResource

Methods

rnf :: TagResource -> ()

Eq TagResource

Defined in Amazonka.KMS.TagResource

Methods

(==) :: TagResource -> TagResource -> Bool

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

Hashable TagResource

Defined in Amazonka.KMS.TagResource

Methods

hashWithSalt :: Int -> TagResource -> Int

hash :: TagResource -> Int

type AWSResponse TagResource

Defined in Amazonka.KMS.TagResource

type AWSResponse TagResource = TagResourceResponse

type Rep TagResource

Defined in Amazonka.KMS.TagResource

type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.KMS.TagResource" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag])))

newTagResource

Arguments

:: Text

TagResource

-> TagResource

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TagResource, tagResource_keyId - Identifies a customer managed key in the account and Region.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:tags:TagResource', tagResource_tags - One or more tags.

Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

data TagResourceResponse

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Generic TagResourceResponse

Defined in Amazonka.KMS.TagResource

Associated Types

type Rep TagResourceResponse :: Type -> Type

Methods

from :: TagResourceResponse -> Rep TagResourceResponse x

to :: Rep TagResourceResponse x -> TagResourceResponse

Read TagResourceResponse

Defined in Amazonka.KMS.TagResource

Methods

readsPrec :: Int -> ReadS TagResourceResponse

readList :: ReadS [TagResourceResponse]

readPrec :: ReadPrec TagResourceResponse

readListPrec :: ReadPrec [TagResourceResponse]

Show TagResourceResponse

Defined in Amazonka.KMS.TagResource

Methods

showsPrec :: Int -> TagResourceResponse -> ShowS

show :: TagResourceResponse -> String

showList :: [TagResourceResponse] -> ShowS

NFData TagResourceResponse

Defined in Amazonka.KMS.TagResource

Methods

rnf :: TagResourceResponse -> ()

Eq TagResourceResponse

Defined in Amazonka.KMS.TagResource

Methods

(==) :: TagResourceResponse -> TagResourceResponse -> Bool

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

type Rep TagResourceResponse

Defined in Amazonka.KMS.TagResource

type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.KMS.TagResource" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UntagResource

data UntagResource

See: newUntagResource smart constructor.

Constructors

UntagResource' Text [Text]

Instances

ToJSON UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

toJSON :: UntagResource -> Value

toEncoding :: UntagResource -> Encoding

toJSONList :: [UntagResource] -> Value

toEncodingList :: [UntagResource] -> Encoding

ToHeaders UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

toHeaders :: UntagResource -> [Header]

ToPath UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

toPath :: UntagResource -> ByteString

ToQuery UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

toQuery :: UntagResource -> QueryString

AWSRequest UntagResource

Defined in Amazonka.KMS.UntagResource

Associated Types

type AWSResponse UntagResource

Methods

request :: (Service -> Service) -> UntagResource -> Request UntagResource

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UntagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UntagResource)))

Generic UntagResource

Defined in Amazonka.KMS.UntagResource

Associated Types

type Rep UntagResource :: Type -> Type

Methods

from :: UntagResource -> Rep UntagResource x

to :: Rep UntagResource x -> UntagResource

Read UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

readsPrec :: Int -> ReadS UntagResource

readList :: ReadS [UntagResource]

readPrec :: ReadPrec UntagResource

readListPrec :: ReadPrec [UntagResource]

Show UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

showsPrec :: Int -> UntagResource -> ShowS

show :: UntagResource -> String

showList :: [UntagResource] -> ShowS

NFData UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

rnf :: UntagResource -> ()

Eq UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

(==) :: UntagResource -> UntagResource -> Bool

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

Hashable UntagResource

Defined in Amazonka.KMS.UntagResource

Methods

hashWithSalt :: Int -> UntagResource -> Int

hash :: UntagResource -> Int

type AWSResponse UntagResource

Defined in Amazonka.KMS.UntagResource

type AWSResponse UntagResource = UntagResourceResponse

type Rep UntagResource

Defined in Amazonka.KMS.UntagResource

type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.KMS.UntagResource" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newUntagResource

Arguments

:: Text

UntagResource

-> UntagResource

Create a value of UntagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UntagResource, untagResource_keyId - Identifies the KMS key from which you are removing tags.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:tagKeys:UntagResource', untagResource_tagKeys - One or more tag keys. Specify only the tag keys, not the tag values.

data UntagResourceResponse

See: newUntagResourceResponse smart constructor.

Constructors

UntagResourceResponse'

Instances

Generic UntagResourceResponse

Defined in Amazonka.KMS.UntagResource

Associated Types

type Rep UntagResourceResponse :: Type -> Type

Methods

from :: UntagResourceResponse -> Rep UntagResourceResponse x

to :: Rep UntagResourceResponse x -> UntagResourceResponse

Read UntagResourceResponse

Defined in Amazonka.KMS.UntagResource

Methods

readsPrec :: Int -> ReadS UntagResourceResponse

readList :: ReadS [UntagResourceResponse]

readPrec :: ReadPrec UntagResourceResponse

readListPrec :: ReadPrec [UntagResourceResponse]

Show UntagResourceResponse

Defined in Amazonka.KMS.UntagResource

Methods

showsPrec :: Int -> UntagResourceResponse -> ShowS

show :: UntagResourceResponse -> String

showList :: [UntagResourceResponse] -> ShowS

NFData UntagResourceResponse

Defined in Amazonka.KMS.UntagResource

Methods

rnf :: UntagResourceResponse -> ()

Eq UntagResourceResponse

Defined in Amazonka.KMS.UntagResource

Methods

(==) :: UntagResourceResponse -> UntagResourceResponse -> Bool

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

type Rep UntagResourceResponse

Defined in Amazonka.KMS.UntagResource

type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.KMS.UntagResource" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUntagResourceResponse :: UntagResourceResponse

Create a value of UntagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateAlias

data UpdateAlias

See: newUpdateAlias smart constructor.

Constructors

UpdateAlias' Text Text

Instances

ToJSON UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

toJSON :: UpdateAlias -> Value

toEncoding :: UpdateAlias -> Encoding

toJSONList :: [UpdateAlias] -> Value

toEncodingList :: [UpdateAlias] -> Encoding

ToHeaders UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

toHeaders :: UpdateAlias -> [Header]

ToPath UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

toPath :: UpdateAlias -> ByteString

ToQuery UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

toQuery :: UpdateAlias -> QueryString

AWSRequest UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Associated Types

type AWSResponse UpdateAlias

Methods

request :: (Service -> Service) -> UpdateAlias -> Request UpdateAlias

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAlias)))

Generic UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Associated Types

type Rep UpdateAlias :: Type -> Type

Methods

from :: UpdateAlias -> Rep UpdateAlias x

to :: Rep UpdateAlias x -> UpdateAlias

Read UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

readsPrec :: Int -> ReadS UpdateAlias

readList :: ReadS [UpdateAlias]

readPrec :: ReadPrec UpdateAlias

readListPrec :: ReadPrec [UpdateAlias]

Show UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

showsPrec :: Int -> UpdateAlias -> ShowS

show :: UpdateAlias -> String

showList :: [UpdateAlias] -> ShowS

NFData UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

rnf :: UpdateAlias -> ()

Eq UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

(==) :: UpdateAlias -> UpdateAlias -> Bool

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

Hashable UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

Methods

hashWithSalt :: Int -> UpdateAlias -> Int

hash :: UpdateAlias -> Int

type AWSResponse UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

type AWSResponse UpdateAlias = UpdateAliasResponse

type Rep UpdateAlias

Defined in Amazonka.KMS.UpdateAlias

type Rep UpdateAlias = D1 ('MetaData "UpdateAlias" "Amazonka.KMS.UpdateAlias" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdateAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateAlias

Arguments

:: Text

UpdateAlias

-> Text

UpdateAlias

-> UpdateAlias

Create a value of UpdateAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateAlias, updateAlias_aliasName - Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

UpdateAlias, updateAlias_targetKeyId - Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

To verify that the alias is mapped to the correct KMS key, use ListAliases.

data UpdateAliasResponse

See: newUpdateAliasResponse smart constructor.

Constructors

UpdateAliasResponse'

Instances

Generic UpdateAliasResponse

Defined in Amazonka.KMS.UpdateAlias

Associated Types

type Rep UpdateAliasResponse :: Type -> Type

Methods

from :: UpdateAliasResponse -> Rep UpdateAliasResponse x

to :: Rep UpdateAliasResponse x -> UpdateAliasResponse

Read UpdateAliasResponse

Defined in Amazonka.KMS.UpdateAlias

Methods

readsPrec :: Int -> ReadS UpdateAliasResponse

readList :: ReadS [UpdateAliasResponse]

readPrec :: ReadPrec UpdateAliasResponse

readListPrec :: ReadPrec [UpdateAliasResponse]

Show UpdateAliasResponse

Defined in Amazonka.KMS.UpdateAlias

Methods

showsPrec :: Int -> UpdateAliasResponse -> ShowS

show :: UpdateAliasResponse -> String

showList :: [UpdateAliasResponse] -> ShowS

NFData UpdateAliasResponse

Defined in Amazonka.KMS.UpdateAlias

Methods

rnf :: UpdateAliasResponse -> ()

Eq UpdateAliasResponse

Defined in Amazonka.KMS.UpdateAlias

Methods

(==) :: UpdateAliasResponse -> UpdateAliasResponse -> Bool

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

type Rep UpdateAliasResponse

Defined in Amazonka.KMS.UpdateAlias

type Rep UpdateAliasResponse = D1 ('MetaData "UpdateAliasResponse" "Amazonka.KMS.UpdateAlias" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdateAliasResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateAliasResponse :: UpdateAliasResponse

Create a value of UpdateAliasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateCustomKeyStore

data UpdateCustomKeyStore

See: newUpdateCustomKeyStore smart constructor.

Constructors

UpdateCustomKeyStore' (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe XksProxyAuthenticationCredentialType) (Maybe XksProxyConnectivityType) (Maybe Text) (Maybe Text) (Maybe Text) Text

Instances

ToJSON UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toJSON :: UpdateCustomKeyStore -> Value

toEncoding :: UpdateCustomKeyStore -> Encoding

toJSONList :: [UpdateCustomKeyStore] -> Value

toEncodingList :: [UpdateCustomKeyStore] -> Encoding

ToHeaders UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toHeaders :: UpdateCustomKeyStore -> [Header]

ToPath UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toPath :: UpdateCustomKeyStore -> ByteString

ToQuery UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

toQuery :: UpdateCustomKeyStore -> QueryString

AWSRequest UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Associated Types

type AWSResponse UpdateCustomKeyStore

Methods

request :: (Service -> Service) -> UpdateCustomKeyStore -> Request UpdateCustomKeyStore

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateCustomKeyStore -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCustomKeyStore)))

Generic UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Associated Types

type Rep UpdateCustomKeyStore :: Type -> Type

Methods

from :: UpdateCustomKeyStore -> Rep UpdateCustomKeyStore x

to :: Rep UpdateCustomKeyStore x -> UpdateCustomKeyStore

Show UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

showsPrec :: Int -> UpdateCustomKeyStore -> ShowS

show :: UpdateCustomKeyStore -> String

showList :: [UpdateCustomKeyStore] -> ShowS

NFData UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

rnf :: UpdateCustomKeyStore -> ()

Eq UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

(==) :: UpdateCustomKeyStore -> UpdateCustomKeyStore -> Bool

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

Hashable UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

hashWithSalt :: Int -> UpdateCustomKeyStore -> Int

hash :: UpdateCustomKeyStore -> Int

type AWSResponse UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

type AWSResponse UpdateCustomKeyStore = UpdateCustomKeyStoreResponse

type Rep UpdateCustomKeyStore

Defined in Amazonka.KMS.UpdateCustomKeyStore

type Rep UpdateCustomKeyStore = D1 ('MetaData "UpdateCustomKeyStore" "Amazonka.KMS.UpdateCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdateCustomKeyStore'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudHsmClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyStorePassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "newCustomKeyStoreName'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "xksProxyAuthenticationCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyAuthenticationCredentialType)))) :*: ((S1 ('MetaSel ('Just "xksProxyConnectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyConnectivityType)) :*: S1 ('MetaSel ('Just "xksProxyUriEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "xksProxyUriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "xksProxyVpcEndpointServiceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateCustomKeyStore

Arguments

:: Text

UpdateCustomKeyStore

-> UpdateCustomKeyStore

Create a value of UpdateCustomKeyStore with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateCustomKeyStore, updateCustomKeyStore_cloudHsmClusterId - Associates the custom key store with a related CloudHSM cluster. This parameter is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

To change this value, the CloudHSM key store must be disconnected.

$sel:keyStorePassword:UpdateCustomKeyStore', updateCustomKeyStore_keyStorePassword - Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store. This parameter is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the CloudHSM cluster.

To change this value, the CloudHSM key store must be disconnected.

$sel:newCustomKeyStoreName':UpdateCustomKeyStore', updateCustomKeyStore_newCustomKeyStoreName - Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.

To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.

$sel:xksProxyAuthenticationCredential:UpdateCustomKeyStore', updateCustomKeyStore_xksProxyAuthenticationCredential - Changes the credentials that KMS uses to sign requests to the external key store proxy (XKS proxy). This parameter is valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

You must specify both the AccessKeyId and SecretAccessKey value in the authentication credential, even if you are only updating one value.

This parameter doesn't establish or change your authentication credentials on the proxy. It just tells KMS the credential that you established with your external key store proxy. For example, if you rotate the credential on your external key store proxy, you can use this parameter to update the credential in KMS.

You can change this value when the external key store is connected or disconnected.

$sel:xksProxyConnectivity:UpdateCustomKeyStore', updateCustomKeyStore_xksProxyConnectivity - Changes the connectivity setting for the external key store. To indicate that the external key store proxy uses a Amazon VPC endpoint service to communicate with KMS, specify VPC_ENDPOINT_SERVICE. Otherwise, specify PUBLIC_ENDPOINT.

If you change the XksProxyConnectivity to VPC_ENDPOINT_SERVICE, you must also change the XksProxyUriEndpoint and add an XksProxyVpcEndpointServiceName value.

If you change the XksProxyConnectivity to PUBLIC_ENDPOINT, you must also change the XksProxyUriEndpoint and specify a null or empty string for the XksProxyVpcEndpointServiceName value.

To change this value, the external key store must be disconnected.

$sel:xksProxyUriEndpoint:UpdateCustomKeyStore', updateCustomKeyStore_xksProxyUriEndpoint - Changes the URI endpoint that KMS uses to connect to your external key store proxy (XKS proxy). This parameter is valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

For external key stores with an XksProxyConnectivity value of PUBLIC_ENDPOINT, the protocol must be HTTPS.

For external key stores with an XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https:// followed by the private DNS name associated with the VPC endpoint service. Each external key store must use a different private DNS name.

The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

To change this value, the external key store must be disconnected.

$sel:xksProxyUriPath:UpdateCustomKeyStore', updateCustomKeyStore_xksProxyUriPath - Changes the base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key manager and external key store proxy (XKS proxy). This parameter is valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The value must start with / and must end with /kms/xks/v1, where v1 represents the version of the KMS external key store proxy API. You can include an optional prefix between the required elements such as /example/kms/xks/v1.

The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

You can change this value when the external key store is connected or disconnected.

$sel:xksProxyVpcEndpointServiceName:UpdateCustomKeyStore', updateCustomKeyStore_xksProxyVpcEndpointServiceName - Changes the name that KMS uses to identify the Amazon VPC endpoint service for your external key store proxy (XKS proxy). This parameter is valid when the CustomKeyStoreType is EXTERNAL_KEY_STORE and the XksProxyConnectivity is VPC_ENDPOINT_SERVICE.

To change this value, the external key store must be disconnected.

UpdateCustomKeyStore, updateCustomKeyStore_customKeyStoreId - Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

data UpdateCustomKeyStoreResponse

See: newUpdateCustomKeyStoreResponse smart constructor.

Constructors

UpdateCustomKeyStoreResponse' Int

Instances

Generic UpdateCustomKeyStoreResponse

Defined in Amazonka.KMS.UpdateCustomKeyStore

Associated Types

type Rep UpdateCustomKeyStoreResponse :: Type -> Type

Methods

from :: UpdateCustomKeyStoreResponse -> Rep UpdateCustomKeyStoreResponse x

to :: Rep UpdateCustomKeyStoreResponse x -> UpdateCustomKeyStoreResponse

Read UpdateCustomKeyStoreResponse

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

readsPrec :: Int -> ReadS UpdateCustomKeyStoreResponse

readList :: ReadS [UpdateCustomKeyStoreResponse]

readPrec :: ReadPrec UpdateCustomKeyStoreResponse

readListPrec :: ReadPrec [UpdateCustomKeyStoreResponse]

Show UpdateCustomKeyStoreResponse

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

showsPrec :: Int -> UpdateCustomKeyStoreResponse -> ShowS

show :: UpdateCustomKeyStoreResponse -> String

showList :: [UpdateCustomKeyStoreResponse] -> ShowS

NFData UpdateCustomKeyStoreResponse

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

rnf :: UpdateCustomKeyStoreResponse -> ()

Eq UpdateCustomKeyStoreResponse

Defined in Amazonka.KMS.UpdateCustomKeyStore

Methods

(==) :: UpdateCustomKeyStoreResponse -> UpdateCustomKeyStoreResponse -> Bool

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

type Rep UpdateCustomKeyStoreResponse

Defined in Amazonka.KMS.UpdateCustomKeyStore

type Rep UpdateCustomKeyStoreResponse = D1 ('MetaData "UpdateCustomKeyStoreResponse" "Amazonka.KMS.UpdateCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdateCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateCustomKeyStoreResponse

Arguments

:: Int

$sel:httpStatus:UpdateCustomKeyStoreResponse'

-> UpdateCustomKeyStoreResponse

Create a value of UpdateCustomKeyStoreResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateCustomKeyStoreResponse', updateCustomKeyStoreResponse_httpStatus - The response's http status code.

UpdateKeyDescription

data UpdateKeyDescription

See: newUpdateKeyDescription smart constructor.

Constructors

UpdateKeyDescription' Text Text

Instances

ToJSON UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toJSON :: UpdateKeyDescription -> Value

toEncoding :: UpdateKeyDescription -> Encoding

toJSONList :: [UpdateKeyDescription] -> Value

toEncodingList :: [UpdateKeyDescription] -> Encoding

ToHeaders UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toHeaders :: UpdateKeyDescription -> [Header]

ToPath UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toPath :: UpdateKeyDescription -> ByteString

ToQuery UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

toQuery :: UpdateKeyDescription -> QueryString

AWSRequest UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Associated Types

type AWSResponse UpdateKeyDescription

Methods

request :: (Service -> Service) -> UpdateKeyDescription -> Request UpdateKeyDescription

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateKeyDescription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateKeyDescription)))

Generic UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Associated Types

type Rep UpdateKeyDescription :: Type -> Type

Methods

from :: UpdateKeyDescription -> Rep UpdateKeyDescription x

to :: Rep UpdateKeyDescription x -> UpdateKeyDescription

Read UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

readsPrec :: Int -> ReadS UpdateKeyDescription

readList :: ReadS [UpdateKeyDescription]

readPrec :: ReadPrec UpdateKeyDescription

readListPrec :: ReadPrec [UpdateKeyDescription]

Show UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

showsPrec :: Int -> UpdateKeyDescription -> ShowS

show :: UpdateKeyDescription -> String

showList :: [UpdateKeyDescription] -> ShowS

NFData UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

rnf :: UpdateKeyDescription -> ()

Eq UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

(==) :: UpdateKeyDescription -> UpdateKeyDescription -> Bool

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

Hashable UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

hashWithSalt :: Int -> UpdateKeyDescription -> Int

hash :: UpdateKeyDescription -> Int

type AWSResponse UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

type AWSResponse UpdateKeyDescription = UpdateKeyDescriptionResponse

type Rep UpdateKeyDescription

Defined in Amazonka.KMS.UpdateKeyDescription

type Rep UpdateKeyDescription = D1 ('MetaData "UpdateKeyDescription" "Amazonka.KMS.UpdateKeyDescription" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdateKeyDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateKeyDescription

Arguments

:: Text

UpdateKeyDescription

-> Text

UpdateKeyDescription

-> UpdateKeyDescription

Create a value of UpdateKeyDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateKeyDescription, updateKeyDescription_keyId - Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

UpdateKeyDescription, updateKeyDescription_description - New description for the KMS key.

data UpdateKeyDescriptionResponse

See: newUpdateKeyDescriptionResponse smart constructor.

Constructors

UpdateKeyDescriptionResponse'

Instances

Generic UpdateKeyDescriptionResponse

Defined in Amazonka.KMS.UpdateKeyDescription

Associated Types

type Rep UpdateKeyDescriptionResponse :: Type -> Type

Methods

from :: UpdateKeyDescriptionResponse -> Rep UpdateKeyDescriptionResponse x

to :: Rep UpdateKeyDescriptionResponse x -> UpdateKeyDescriptionResponse

Read UpdateKeyDescriptionResponse

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

readsPrec :: Int -> ReadS UpdateKeyDescriptionResponse

readList :: ReadS [UpdateKeyDescriptionResponse]

readPrec :: ReadPrec UpdateKeyDescriptionResponse

readListPrec :: ReadPrec [UpdateKeyDescriptionResponse]

Show UpdateKeyDescriptionResponse

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

showsPrec :: Int -> UpdateKeyDescriptionResponse -> ShowS

show :: UpdateKeyDescriptionResponse -> String

showList :: [UpdateKeyDescriptionResponse] -> ShowS

NFData UpdateKeyDescriptionResponse

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

rnf :: UpdateKeyDescriptionResponse -> ()

Eq UpdateKeyDescriptionResponse

Defined in Amazonka.KMS.UpdateKeyDescription

Methods

(==) :: UpdateKeyDescriptionResponse -> UpdateKeyDescriptionResponse -> Bool

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

type Rep UpdateKeyDescriptionResponse

Defined in Amazonka.KMS.UpdateKeyDescription

type Rep UpdateKeyDescriptionResponse = D1 ('MetaData "UpdateKeyDescriptionResponse" "Amazonka.KMS.UpdateKeyDescription" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdateKeyDescriptionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateKeyDescriptionResponse :: UpdateKeyDescriptionResponse

Create a value of UpdateKeyDescriptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdatePrimaryRegion

data UpdatePrimaryRegion

See: newUpdatePrimaryRegion smart constructor.

Constructors

UpdatePrimaryRegion' Text Text

Instances

ToJSON UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

toJSON :: UpdatePrimaryRegion -> Value

toEncoding :: UpdatePrimaryRegion -> Encoding

toJSONList :: [UpdatePrimaryRegion] -> Value

toEncodingList :: [UpdatePrimaryRegion] -> Encoding

ToHeaders UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

toHeaders :: UpdatePrimaryRegion -> [Header]

ToPath UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

toPath :: UpdatePrimaryRegion -> ByteString

ToQuery UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

toQuery :: UpdatePrimaryRegion -> QueryString

AWSRequest UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Associated Types

type AWSResponse UpdatePrimaryRegion

Methods

request :: (Service -> Service) -> UpdatePrimaryRegion -> Request UpdatePrimaryRegion

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePrimaryRegion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePrimaryRegion)))

Generic UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Associated Types

type Rep UpdatePrimaryRegion :: Type -> Type

Methods

from :: UpdatePrimaryRegion -> Rep UpdatePrimaryRegion x

to :: Rep UpdatePrimaryRegion x -> UpdatePrimaryRegion

Read UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

readsPrec :: Int -> ReadS UpdatePrimaryRegion

readList :: ReadS [UpdatePrimaryRegion]

readPrec :: ReadPrec UpdatePrimaryRegion

readListPrec :: ReadPrec [UpdatePrimaryRegion]

Show UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

showsPrec :: Int -> UpdatePrimaryRegion -> ShowS

show :: UpdatePrimaryRegion -> String

showList :: [UpdatePrimaryRegion] -> ShowS

NFData UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

rnf :: UpdatePrimaryRegion -> ()

Eq UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

(==) :: UpdatePrimaryRegion -> UpdatePrimaryRegion -> Bool

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

Hashable UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

hashWithSalt :: Int -> UpdatePrimaryRegion -> Int

hash :: UpdatePrimaryRegion -> Int

type AWSResponse UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

type AWSResponse UpdatePrimaryRegion = UpdatePrimaryRegionResponse

type Rep UpdatePrimaryRegion

Defined in Amazonka.KMS.UpdatePrimaryRegion

type Rep UpdatePrimaryRegion = D1 ('MetaData "UpdatePrimaryRegion" "Amazonka.KMS.UpdatePrimaryRegion" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdatePrimaryRegion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "primaryRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdatePrimaryRegion

Arguments

:: Text

UpdatePrimaryRegion

-> Text

$sel:primaryRegion:UpdatePrimaryRegion'

-> UpdatePrimaryRegion

Create a value of UpdatePrimaryRegion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdatePrimaryRegion, updatePrimaryRegion_keyId - Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

• Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

$sel:primaryRegion:UpdatePrimaryRegion', updatePrimaryRegion_primaryRegion - The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

data UpdatePrimaryRegionResponse

See: newUpdatePrimaryRegionResponse smart constructor.

Constructors

UpdatePrimaryRegionResponse'

Instances

Generic UpdatePrimaryRegionResponse

Defined in Amazonka.KMS.UpdatePrimaryRegion

Associated Types

type Rep UpdatePrimaryRegionResponse :: Type -> Type

Methods

from :: UpdatePrimaryRegionResponse -> Rep UpdatePrimaryRegionResponse x

to :: Rep UpdatePrimaryRegionResponse x -> UpdatePrimaryRegionResponse

Read UpdatePrimaryRegionResponse

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

readsPrec :: Int -> ReadS UpdatePrimaryRegionResponse

readList :: ReadS [UpdatePrimaryRegionResponse]

readPrec :: ReadPrec UpdatePrimaryRegionResponse

readListPrec :: ReadPrec [UpdatePrimaryRegionResponse]

Show UpdatePrimaryRegionResponse

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

showsPrec :: Int -> UpdatePrimaryRegionResponse -> ShowS

show :: UpdatePrimaryRegionResponse -> String

showList :: [UpdatePrimaryRegionResponse] -> ShowS

NFData UpdatePrimaryRegionResponse

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

rnf :: UpdatePrimaryRegionResponse -> ()

Eq UpdatePrimaryRegionResponse

Defined in Amazonka.KMS.UpdatePrimaryRegion

Methods

(==) :: UpdatePrimaryRegionResponse -> UpdatePrimaryRegionResponse -> Bool

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

type Rep UpdatePrimaryRegionResponse

Defined in Amazonka.KMS.UpdatePrimaryRegion

type Rep UpdatePrimaryRegionResponse = D1 ('MetaData "UpdatePrimaryRegionResponse" "Amazonka.KMS.UpdatePrimaryRegion" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "UpdatePrimaryRegionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdatePrimaryRegionResponse :: UpdatePrimaryRegionResponse

Create a value of UpdatePrimaryRegionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Verify

data Verify

See: newVerify smart constructor.

Constructors

Verify' (Maybe [Text]) (Maybe MessageType) Text (Sensitive Base64) Base64 SigningAlgorithmSpec

Instances

ToJSON Verify

Defined in Amazonka.KMS.Verify

Methods

toJSON :: Verify -> Value

toEncoding :: Verify -> Encoding

toJSONList :: [Verify] -> Value

toEncodingList :: [Verify] -> Encoding

ToHeaders Verify

Defined in Amazonka.KMS.Verify

Methods

toHeaders :: Verify -> [Header]

ToPath Verify

Defined in Amazonka.KMS.Verify

Methods

toPath :: Verify -> ByteString

ToQuery Verify

Defined in Amazonka.KMS.Verify

Methods

toQuery :: Verify -> QueryString

AWSRequest Verify

Defined in Amazonka.KMS.Verify

Associated Types

type AWSResponse Verify

Methods

request :: (Service -> Service) -> Verify -> Request Verify

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Verify -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Verify)))

Generic Verify

Defined in Amazonka.KMS.Verify

Associated Types

type Rep Verify :: Type -> Type

Methods

from :: Verify -> Rep Verify x

to :: Rep Verify x -> Verify

Show Verify

Defined in Amazonka.KMS.Verify

Methods

showsPrec :: Int -> Verify -> ShowS

show :: Verify -> String

showList :: [Verify] -> ShowS

NFData Verify

Defined in Amazonka.KMS.Verify

Methods

rnf :: Verify -> ()

Eq Verify

Defined in Amazonka.KMS.Verify

Methods

(==) :: Verify -> Verify -> Bool

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

Hashable Verify

Defined in Amazonka.KMS.Verify

Methods

hashWithSalt :: Int -> Verify -> Int

hash :: Verify -> Int

type AWSResponse Verify

Defined in Amazonka.KMS.Verify

type AWSResponse Verify = VerifyResponse

type Rep Verify

Defined in Amazonka.KMS.Verify

type Rep Verify = D1 ('MetaData "Verify" "Amazonka.KMS.Verify" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Verify'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64)) :*: (S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "signingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SigningAlgorithmSpec)))))

newVerify

Arguments

:: Text

Verify

-> ByteString

$sel:message:Verify'

-> ByteString

$sel:signature:Verify'

-> SigningAlgorithmSpec

Verify

-> Verify

Create a value of Verify with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grantTokens:Verify', verify_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:messageType:Verify', verify_messageType - Tells KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.

Verify, verify_keyId - Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

$sel:message:Verify', verify_message - Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.

If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.-- -- 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.

$sel:signature:Verify', verify_signature - The signature that the Sign operation generated.-- -- 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.

Verify, verify_signingAlgorithm - The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

data VerifyResponse

See: newVerifyResponse smart constructor.

Constructors

VerifyResponse' (Maybe Text) (Maybe Bool) (Maybe SigningAlgorithmSpec) Int

Instances

Generic VerifyResponse

Defined in Amazonka.KMS.Verify

Associated Types

type Rep VerifyResponse :: Type -> Type

Methods

from :: VerifyResponse -> Rep VerifyResponse x

to :: Rep VerifyResponse x -> VerifyResponse

Read VerifyResponse

Defined in Amazonka.KMS.Verify

Methods

readsPrec :: Int -> ReadS VerifyResponse

readList :: ReadS [VerifyResponse]

readPrec :: ReadPrec VerifyResponse

readListPrec :: ReadPrec [VerifyResponse]

Show VerifyResponse

Defined in Amazonka.KMS.Verify

Methods

showsPrec :: Int -> VerifyResponse -> ShowS

show :: VerifyResponse -> String

showList :: [VerifyResponse] -> ShowS

NFData VerifyResponse

Defined in Amazonka.KMS.Verify

Methods

rnf :: VerifyResponse -> ()

Eq VerifyResponse

Defined in Amazonka.KMS.Verify

Methods

(==) :: VerifyResponse -> VerifyResponse -> Bool

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

type Rep VerifyResponse

Defined in Amazonka.KMS.Verify

type Rep VerifyResponse = D1 ('MetaData "VerifyResponse" "Amazonka.KMS.Verify" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "VerifyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signatureValid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "signingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SigningAlgorithmSpec)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newVerifyResponse

Arguments

:: Int

$sel:httpStatus:VerifyResponse'

-> VerifyResponse

Create a value of VerifyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Verify, verifyResponse_keyId - The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

$sel:signatureValid:VerifyResponse', verifyResponse_signatureValid - A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Verify, verifyResponse_signingAlgorithm - The signing algorithm that was used to verify the signature.

$sel:httpStatus:VerifyResponse', verifyResponse_httpStatus - The response's http status code.

VerifyMac

data VerifyMac

See: newVerifyMac smart constructor.

Constructors

VerifyMac' (Maybe [Text]) (Sensitive Base64) Text MacAlgorithmSpec Base64

Instances

ToJSON VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

toJSON :: VerifyMac -> Value

toEncoding :: VerifyMac -> Encoding

toJSONList :: [VerifyMac] -> Value

toEncodingList :: [VerifyMac] -> Encoding

ToHeaders VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

toHeaders :: VerifyMac -> [Header]

ToPath VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

toPath :: VerifyMac -> ByteString

ToQuery VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

toQuery :: VerifyMac -> QueryString

AWSRequest VerifyMac

Defined in Amazonka.KMS.VerifyMac

Associated Types

type AWSResponse VerifyMac

Methods

request :: (Service -> Service) -> VerifyMac -> Request VerifyMac

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy VerifyMac -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse VerifyMac)))

Generic VerifyMac

Defined in Amazonka.KMS.VerifyMac

Associated Types

type Rep VerifyMac :: Type -> Type

Methods

from :: VerifyMac -> Rep VerifyMac x

to :: Rep VerifyMac x -> VerifyMac

Show VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

showsPrec :: Int -> VerifyMac -> ShowS

show :: VerifyMac -> String

showList :: [VerifyMac] -> ShowS

NFData VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

rnf :: VerifyMac -> ()

Eq VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

(==) :: VerifyMac -> VerifyMac -> Bool

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

Hashable VerifyMac

Defined in Amazonka.KMS.VerifyMac

Methods

hashWithSalt :: Int -> VerifyMac -> Int

hash :: VerifyMac -> Int

type AWSResponse VerifyMac

Defined in Amazonka.KMS.VerifyMac

type AWSResponse VerifyMac = VerifyMacResponse

type Rep VerifyMac

Defined in Amazonka.KMS.VerifyMac

type Rep VerifyMac = D1 ('MetaData "VerifyMac" "Amazonka.KMS.VerifyMac" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "VerifyMac'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64))) :*: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "macAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MacAlgorithmSpec) :*: S1 ('MetaSel ('Just "mac") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64)))))

newVerifyMac

Arguments

:: ByteString

$sel:message:VerifyMac'

-> Text

VerifyMac

-> MacAlgorithmSpec

VerifyMac

-> ByteString

$sel:mac:VerifyMac'

-> VerifyMac

Create a value of VerifyMac with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grantTokens:VerifyMac', verifyMac_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:message:VerifyMac', verifyMac_message - The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.-- -- 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.

VerifyMac, verifyMac_keyId - The KMS key that will be used in the verification.

Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

VerifyMac, verifyMac_macAlgorithm - The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

$sel:mac:VerifyMac', verifyMac_mac - The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this 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.

data VerifyMacResponse

See: newVerifyMacResponse smart constructor.

Constructors

VerifyMacResponse' (Maybe Text) (Maybe MacAlgorithmSpec) (Maybe Bool) Int

Instances

Generic VerifyMacResponse

Defined in Amazonka.KMS.VerifyMac

Associated Types

type Rep VerifyMacResponse :: Type -> Type

Methods

from :: VerifyMacResponse -> Rep VerifyMacResponse x

to :: Rep VerifyMacResponse x -> VerifyMacResponse

Read VerifyMacResponse

Defined in Amazonka.KMS.VerifyMac

Methods

readsPrec :: Int -> ReadS VerifyMacResponse

readList :: ReadS [VerifyMacResponse]

readPrec :: ReadPrec VerifyMacResponse

readListPrec :: ReadPrec [VerifyMacResponse]

Show VerifyMacResponse

Defined in Amazonka.KMS.VerifyMac

Methods

showsPrec :: Int -> VerifyMacResponse -> ShowS

show :: VerifyMacResponse -> String

showList :: [VerifyMacResponse] -> ShowS

NFData VerifyMacResponse

Defined in Amazonka.KMS.VerifyMac

Methods

rnf :: VerifyMacResponse -> ()

Eq VerifyMacResponse

Defined in Amazonka.KMS.VerifyMac

Methods

(==) :: VerifyMacResponse -> VerifyMacResponse -> Bool

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

type Rep VerifyMacResponse

Defined in Amazonka.KMS.VerifyMac

type Rep VerifyMacResponse = D1 ('MetaData "VerifyMacResponse" "Amazonka.KMS.VerifyMac" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "VerifyMacResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "macAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MacAlgorithmSpec))) :*: (S1 ('MetaSel ('Just "macValid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newVerifyMacResponse

Arguments

:: Int

$sel:httpStatus:VerifyMacResponse'

-> VerifyMacResponse

Create a value of VerifyMacResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

VerifyMac, verifyMacResponse_keyId - The HMAC KMS key used in the verification.

VerifyMac, verifyMacResponse_macAlgorithm - The MAC algorithm used in the verification.

$sel:macValid:VerifyMacResponse', verifyMacResponse_macValid - A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

$sel:httpStatus:VerifyMacResponse', verifyMacResponse_httpStatus - The response's http status code.

Types

AlgorithmSpec

newtype AlgorithmSpec

Constructors

AlgorithmSpec'

Fields

• fromAlgorithmSpec :: Text

Bundled Patterns

pattern AlgorithmSpec_RSAES_OAEP_SHA_1 :: AlgorithmSpec

pattern AlgorithmSpec_RSAES_OAEP_SHA_256 :: AlgorithmSpec

pattern AlgorithmSpec_RSAES_PKCS1_V1_5 :: AlgorithmSpec

Instances

FromJSON AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

parseJSON :: Value -> Parser AlgorithmSpec

parseJSONList :: Value -> Parser [AlgorithmSpec]

FromJSONKey AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

fromJSONKey :: FromJSONKeyFunction AlgorithmSpec

fromJSONKeyList :: FromJSONKeyFunction [AlgorithmSpec]

ToJSON AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

toJSON :: AlgorithmSpec -> Value

toEncoding :: AlgorithmSpec -> Encoding

toJSONList :: [AlgorithmSpec] -> Value

toEncodingList :: [AlgorithmSpec] -> Encoding

ToJSONKey AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

toJSONKey :: ToJSONKeyFunction AlgorithmSpec

toJSONKeyList :: ToJSONKeyFunction [AlgorithmSpec]

ToByteString AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

toBS :: AlgorithmSpec -> ByteString

ToHeader AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

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

ToLog AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

build :: AlgorithmSpec -> ByteStringBuilder

ToQuery AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

toQuery :: AlgorithmSpec -> QueryString

FromText AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

fromText :: Text -> Either String AlgorithmSpec

ToText AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

toText :: AlgorithmSpec -> Text

FromXML AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

parseXML :: [Node] -> Either String AlgorithmSpec

ToXML AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

toXML :: AlgorithmSpec -> XML

Generic AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Associated Types

type Rep AlgorithmSpec :: Type -> Type

Methods

from :: AlgorithmSpec -> Rep AlgorithmSpec x

to :: Rep AlgorithmSpec x -> AlgorithmSpec

Read AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

readsPrec :: Int -> ReadS AlgorithmSpec

readList :: ReadS [AlgorithmSpec]

readPrec :: ReadPrec AlgorithmSpec

readListPrec :: ReadPrec [AlgorithmSpec]

Show AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

showsPrec :: Int -> AlgorithmSpec -> ShowS

show :: AlgorithmSpec -> String

showList :: [AlgorithmSpec] -> ShowS

NFData AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

rnf :: AlgorithmSpec -> ()

Eq AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

(==) :: AlgorithmSpec -> AlgorithmSpec -> Bool

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

Ord AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

compare :: AlgorithmSpec -> AlgorithmSpec -> Ordering

(<) :: AlgorithmSpec -> AlgorithmSpec -> Bool

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

(>) :: AlgorithmSpec -> AlgorithmSpec -> Bool

(>=) :: AlgorithmSpec -> AlgorithmSpec -> Bool

max :: AlgorithmSpec -> AlgorithmSpec -> AlgorithmSpec

min :: AlgorithmSpec -> AlgorithmSpec -> AlgorithmSpec

Hashable AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

Methods

hashWithSalt :: Int -> AlgorithmSpec -> Int

hash :: AlgorithmSpec -> Int

type Rep AlgorithmSpec

Defined in Amazonka.KMS.Types.AlgorithmSpec

type Rep AlgorithmSpec = D1 ('MetaData "AlgorithmSpec" "Amazonka.KMS.Types.AlgorithmSpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "AlgorithmSpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAlgorithmSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConnectionErrorCodeType

newtype ConnectionErrorCodeType

Constructors

ConnectionErrorCodeType'

Fields

• fromConnectionErrorCodeType :: Text

Bundled Patterns

pattern ConnectionErrorCodeType_CLUSTER_NOT_FOUND :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_INSUFFICIENT_CLOUDHSM_HSMS :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_INTERNAL_ERROR :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_INVALID_CREDENTIALS :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_NETWORK_ERRORS :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_SUBNET_NOT_FOUND :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_USER_LOCKED_OUT :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_USER_LOGGED_IN :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_USER_NOT_FOUND :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_PROXY_ACCESS_DENIED :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_PROXY_INVALID_CONFIGURATION :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_PROXY_INVALID_RESPONSE :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_PROXY_INVALID_TLS_CONFIGURATION :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_PROXY_NOT_REACHABLE :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_PROXY_TIMED_OUT :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION :: ConnectionErrorCodeType

pattern ConnectionErrorCodeType_XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND :: ConnectionErrorCodeType

Instances

FromJSON ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

parseJSON :: Value -> Parser ConnectionErrorCodeType

parseJSONList :: Value -> Parser [ConnectionErrorCodeType]

FromJSONKey ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

fromJSONKey :: FromJSONKeyFunction ConnectionErrorCodeType

fromJSONKeyList :: FromJSONKeyFunction [ConnectionErrorCodeType]

ToJSON ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

toJSON :: ConnectionErrorCodeType -> Value

toEncoding :: ConnectionErrorCodeType -> Encoding

toJSONList :: [ConnectionErrorCodeType] -> Value

toEncodingList :: [ConnectionErrorCodeType] -> Encoding

ToJSONKey ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

toJSONKey :: ToJSONKeyFunction ConnectionErrorCodeType

toJSONKeyList :: ToJSONKeyFunction [ConnectionErrorCodeType]

ToByteString ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

toBS :: ConnectionErrorCodeType -> ByteString

ToHeader ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

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

ToLog ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

build :: ConnectionErrorCodeType -> ByteStringBuilder

ToQuery ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

toQuery :: ConnectionErrorCodeType -> QueryString

FromText ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

fromText :: Text -> Either String ConnectionErrorCodeType

ToText ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

toText :: ConnectionErrorCodeType -> Text

FromXML ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

parseXML :: [Node] -> Either String ConnectionErrorCodeType

ToXML ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

toXML :: ConnectionErrorCodeType -> XML

Generic ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Associated Types

type Rep ConnectionErrorCodeType :: Type -> Type

Methods

from :: ConnectionErrorCodeType -> Rep ConnectionErrorCodeType x

to :: Rep ConnectionErrorCodeType x -> ConnectionErrorCodeType

Read ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

readsPrec :: Int -> ReadS ConnectionErrorCodeType

readList :: ReadS [ConnectionErrorCodeType]

readPrec :: ReadPrec ConnectionErrorCodeType

readListPrec :: ReadPrec [ConnectionErrorCodeType]

Show ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

showsPrec :: Int -> ConnectionErrorCodeType -> ShowS

show :: ConnectionErrorCodeType -> String

showList :: [ConnectionErrorCodeType] -> ShowS

NFData ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

rnf :: ConnectionErrorCodeType -> ()

Eq ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

(==) :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> Bool

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

Ord ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

compare :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> Ordering

(<) :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> Bool

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

(>) :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> Bool

(>=) :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> Bool

max :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> ConnectionErrorCodeType

min :: ConnectionErrorCodeType -> ConnectionErrorCodeType -> ConnectionErrorCodeType

Hashable ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

Methods

hashWithSalt :: Int -> ConnectionErrorCodeType -> Int

hash :: ConnectionErrorCodeType -> Int

type Rep ConnectionErrorCodeType

Defined in Amazonka.KMS.Types.ConnectionErrorCodeType

type Rep ConnectionErrorCodeType = D1 ('MetaData "ConnectionErrorCodeType" "Amazonka.KMS.Types.ConnectionErrorCodeType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "ConnectionErrorCodeType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectionErrorCodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConnectionStateType

newtype ConnectionStateType

Constructors

ConnectionStateType'

Fields

• fromConnectionStateType :: Text

Bundled Patterns

pattern ConnectionStateType_CONNECTED :: ConnectionStateType

pattern ConnectionStateType_CONNECTING :: ConnectionStateType

pattern ConnectionStateType_DISCONNECTED :: ConnectionStateType

pattern ConnectionStateType_DISCONNECTING :: ConnectionStateType

pattern ConnectionStateType_FAILED :: ConnectionStateType

Instances

FromJSON ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

parseJSON :: Value -> Parser ConnectionStateType

parseJSONList :: Value -> Parser [ConnectionStateType]

FromJSONKey ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

fromJSONKey :: FromJSONKeyFunction ConnectionStateType

fromJSONKeyList :: FromJSONKeyFunction [ConnectionStateType]

ToJSON ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

toJSON :: ConnectionStateType -> Value

toEncoding :: ConnectionStateType -> Encoding

toJSONList :: [ConnectionStateType] -> Value

toEncodingList :: [ConnectionStateType] -> Encoding

ToJSONKey ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

toJSONKey :: ToJSONKeyFunction ConnectionStateType

toJSONKeyList :: ToJSONKeyFunction [ConnectionStateType]

ToByteString ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

toBS :: ConnectionStateType -> ByteString

ToHeader ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

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

ToLog ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

build :: ConnectionStateType -> ByteStringBuilder

ToQuery ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

toQuery :: ConnectionStateType -> QueryString

FromText ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

fromText :: Text -> Either String ConnectionStateType

ToText ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

toText :: ConnectionStateType -> Text

FromXML ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

parseXML :: [Node] -> Either String ConnectionStateType

ToXML ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

toXML :: ConnectionStateType -> XML

Generic ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Associated Types

type Rep ConnectionStateType :: Type -> Type

Methods

from :: ConnectionStateType -> Rep ConnectionStateType x

to :: Rep ConnectionStateType x -> ConnectionStateType

Read ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

readsPrec :: Int -> ReadS ConnectionStateType

readList :: ReadS [ConnectionStateType]

readPrec :: ReadPrec ConnectionStateType

readListPrec :: ReadPrec [ConnectionStateType]

Show ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

showsPrec :: Int -> ConnectionStateType -> ShowS

show :: ConnectionStateType -> String

showList :: [ConnectionStateType] -> ShowS

NFData ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

rnf :: ConnectionStateType -> ()

Eq ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

(==) :: ConnectionStateType -> ConnectionStateType -> Bool

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

Ord ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

compare :: ConnectionStateType -> ConnectionStateType -> Ordering

(<) :: ConnectionStateType -> ConnectionStateType -> Bool

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

(>) :: ConnectionStateType -> ConnectionStateType -> Bool

(>=) :: ConnectionStateType -> ConnectionStateType -> Bool

max :: ConnectionStateType -> ConnectionStateType -> ConnectionStateType

min :: ConnectionStateType -> ConnectionStateType -> ConnectionStateType

Hashable ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

Methods

hashWithSalt :: Int -> ConnectionStateType -> Int

hash :: ConnectionStateType -> Int

type Rep ConnectionStateType

Defined in Amazonka.KMS.Types.ConnectionStateType

type Rep ConnectionStateType = D1 ('MetaData "ConnectionStateType" "Amazonka.KMS.Types.ConnectionStateType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "ConnectionStateType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectionStateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CustomKeyStoreType

newtype CustomKeyStoreType

Constructors

CustomKeyStoreType'

Fields

• fromCustomKeyStoreType :: Text

Bundled Patterns

pattern CustomKeyStoreType_AWS_CLOUDHSM :: CustomKeyStoreType

pattern CustomKeyStoreType_EXTERNAL_KEY_STORE :: CustomKeyStoreType

Instances

FromJSON CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

parseJSON :: Value -> Parser CustomKeyStoreType

parseJSONList :: Value -> Parser [CustomKeyStoreType]

FromJSONKey CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

fromJSONKey :: FromJSONKeyFunction CustomKeyStoreType

fromJSONKeyList :: FromJSONKeyFunction [CustomKeyStoreType]

ToJSON CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

toJSON :: CustomKeyStoreType -> Value

toEncoding :: CustomKeyStoreType -> Encoding

toJSONList :: [CustomKeyStoreType] -> Value

toEncodingList :: [CustomKeyStoreType] -> Encoding

ToJSONKey CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

toJSONKey :: ToJSONKeyFunction CustomKeyStoreType

toJSONKeyList :: ToJSONKeyFunction [CustomKeyStoreType]

ToByteString CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

toBS :: CustomKeyStoreType -> ByteString

ToHeader CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

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

ToLog CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

build :: CustomKeyStoreType -> ByteStringBuilder

ToQuery CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

toQuery :: CustomKeyStoreType -> QueryString

FromText CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

fromText :: Text -> Either String CustomKeyStoreType

ToText CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

toText :: CustomKeyStoreType -> Text

FromXML CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

parseXML :: [Node] -> Either String CustomKeyStoreType

ToXML CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

toXML :: CustomKeyStoreType -> XML

Generic CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Associated Types

type Rep CustomKeyStoreType :: Type -> Type

Methods

from :: CustomKeyStoreType -> Rep CustomKeyStoreType x

to :: Rep CustomKeyStoreType x -> CustomKeyStoreType

Read CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

readsPrec :: Int -> ReadS CustomKeyStoreType

readList :: ReadS [CustomKeyStoreType]

readPrec :: ReadPrec CustomKeyStoreType

readListPrec :: ReadPrec [CustomKeyStoreType]

Show CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

showsPrec :: Int -> CustomKeyStoreType -> ShowS

show :: CustomKeyStoreType -> String

showList :: [CustomKeyStoreType] -> ShowS

NFData CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

rnf :: CustomKeyStoreType -> ()

Eq CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

(==) :: CustomKeyStoreType -> CustomKeyStoreType -> Bool

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

Ord CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

compare :: CustomKeyStoreType -> CustomKeyStoreType -> Ordering

(<) :: CustomKeyStoreType -> CustomKeyStoreType -> Bool

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

(>) :: CustomKeyStoreType -> CustomKeyStoreType -> Bool

(>=) :: CustomKeyStoreType -> CustomKeyStoreType -> Bool

max :: CustomKeyStoreType -> CustomKeyStoreType -> CustomKeyStoreType

min :: CustomKeyStoreType -> CustomKeyStoreType -> CustomKeyStoreType

Hashable CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

Methods

hashWithSalt :: Int -> CustomKeyStoreType -> Int

hash :: CustomKeyStoreType -> Int

type Rep CustomKeyStoreType

Defined in Amazonka.KMS.Types.CustomKeyStoreType

type Rep CustomKeyStoreType = D1 ('MetaData "CustomKeyStoreType" "Amazonka.KMS.Types.CustomKeyStoreType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "CustomKeyStoreType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCustomKeyStoreType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CustomerMasterKeySpec

newtype CustomerMasterKeySpec

Constructors

CustomerMasterKeySpec'

Fields

• fromCustomerMasterKeySpec :: Text

Bundled Patterns

pattern CustomerMasterKeySpec_ECC_NIST_P256 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_ECC_NIST_P384 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_ECC_NIST_P521 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_ECC_SECG_P256K1 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_HMAC_224 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_HMAC_256 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_HMAC_384 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_HMAC_512 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_RSA_2048 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_RSA_3072 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_RSA_4096 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_SM2 :: CustomerMasterKeySpec

pattern CustomerMasterKeySpec_SYMMETRIC_DEFAULT :: CustomerMasterKeySpec

Instances

FromJSON CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

parseJSON :: Value -> Parser CustomerMasterKeySpec

parseJSONList :: Value -> Parser [CustomerMasterKeySpec]

FromJSONKey CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

fromJSONKey :: FromJSONKeyFunction CustomerMasterKeySpec

fromJSONKeyList :: FromJSONKeyFunction [CustomerMasterKeySpec]

ToJSON CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

toJSON :: CustomerMasterKeySpec -> Value

toEncoding :: CustomerMasterKeySpec -> Encoding

toJSONList :: [CustomerMasterKeySpec] -> Value

toEncodingList :: [CustomerMasterKeySpec] -> Encoding

ToJSONKey CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

toJSONKey :: ToJSONKeyFunction CustomerMasterKeySpec

toJSONKeyList :: ToJSONKeyFunction [CustomerMasterKeySpec]

ToByteString CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

toBS :: CustomerMasterKeySpec -> ByteString

ToHeader CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

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

ToLog CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

build :: CustomerMasterKeySpec -> ByteStringBuilder

ToQuery CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

toQuery :: CustomerMasterKeySpec -> QueryString

FromText CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

fromText :: Text -> Either String CustomerMasterKeySpec

ToText CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

toText :: CustomerMasterKeySpec -> Text

FromXML CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

parseXML :: [Node] -> Either String CustomerMasterKeySpec

ToXML CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

toXML :: CustomerMasterKeySpec -> XML

Generic CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Associated Types

type Rep CustomerMasterKeySpec :: Type -> Type

Methods

from :: CustomerMasterKeySpec -> Rep CustomerMasterKeySpec x

to :: Rep CustomerMasterKeySpec x -> CustomerMasterKeySpec

Read CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

readsPrec :: Int -> ReadS CustomerMasterKeySpec

readList :: ReadS [CustomerMasterKeySpec]

readPrec :: ReadPrec CustomerMasterKeySpec

readListPrec :: ReadPrec [CustomerMasterKeySpec]

Show CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

showsPrec :: Int -> CustomerMasterKeySpec -> ShowS

show :: CustomerMasterKeySpec -> String

showList :: [CustomerMasterKeySpec] -> ShowS

NFData CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

rnf :: CustomerMasterKeySpec -> ()

Eq CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

(==) :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> Bool

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

Ord CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

compare :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> Ordering

(<) :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> Bool

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

(>) :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> Bool

(>=) :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> Bool

max :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> CustomerMasterKeySpec

min :: CustomerMasterKeySpec -> CustomerMasterKeySpec -> CustomerMasterKeySpec

Hashable CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

Methods

hashWithSalt :: Int -> CustomerMasterKeySpec -> Int

hash :: CustomerMasterKeySpec -> Int

type Rep CustomerMasterKeySpec

Defined in Amazonka.KMS.Types.CustomerMasterKeySpec

type Rep CustomerMasterKeySpec = D1 ('MetaData "CustomerMasterKeySpec" "Amazonka.KMS.Types.CustomerMasterKeySpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "CustomerMasterKeySpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCustomerMasterKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataKeyPairSpec

newtype DataKeyPairSpec

Constructors

DataKeyPairSpec'

Fields

• fromDataKeyPairSpec :: Text

Bundled Patterns

pattern DataKeyPairSpec_ECC_NIST_P256 :: DataKeyPairSpec

pattern DataKeyPairSpec_ECC_NIST_P384 :: DataKeyPairSpec

pattern DataKeyPairSpec_ECC_NIST_P521 :: DataKeyPairSpec

pattern DataKeyPairSpec_ECC_SECG_P256K1 :: DataKeyPairSpec

pattern DataKeyPairSpec_RSA_2048 :: DataKeyPairSpec

pattern DataKeyPairSpec_RSA_3072 :: DataKeyPairSpec

pattern DataKeyPairSpec_RSA_4096 :: DataKeyPairSpec

pattern DataKeyPairSpec_SM2 :: DataKeyPairSpec

Instances

FromJSON DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

parseJSON :: Value -> Parser DataKeyPairSpec

parseJSONList :: Value -> Parser [DataKeyPairSpec]

FromJSONKey DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

fromJSONKey :: FromJSONKeyFunction DataKeyPairSpec

fromJSONKeyList :: FromJSONKeyFunction [DataKeyPairSpec]

ToJSON DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

toJSON :: DataKeyPairSpec -> Value

toEncoding :: DataKeyPairSpec -> Encoding

toJSONList :: [DataKeyPairSpec] -> Value

toEncodingList :: [DataKeyPairSpec] -> Encoding

ToJSONKey DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

toJSONKey :: ToJSONKeyFunction DataKeyPairSpec

toJSONKeyList :: ToJSONKeyFunction [DataKeyPairSpec]

ToByteString DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

toBS :: DataKeyPairSpec -> ByteString

ToHeader DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

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

ToLog DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

build :: DataKeyPairSpec -> ByteStringBuilder

ToQuery DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

toQuery :: DataKeyPairSpec -> QueryString

FromText DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

fromText :: Text -> Either String DataKeyPairSpec

ToText DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

toText :: DataKeyPairSpec -> Text

FromXML DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

parseXML :: [Node] -> Either String DataKeyPairSpec

ToXML DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

toXML :: DataKeyPairSpec -> XML

Generic DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Associated Types

type Rep DataKeyPairSpec :: Type -> Type

Methods

from :: DataKeyPairSpec -> Rep DataKeyPairSpec x

to :: Rep DataKeyPairSpec x -> DataKeyPairSpec

Read DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

readsPrec :: Int -> ReadS DataKeyPairSpec

readList :: ReadS [DataKeyPairSpec]

readPrec :: ReadPrec DataKeyPairSpec

readListPrec :: ReadPrec [DataKeyPairSpec]

Show DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

showsPrec :: Int -> DataKeyPairSpec -> ShowS

show :: DataKeyPairSpec -> String

showList :: [DataKeyPairSpec] -> ShowS

NFData DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

rnf :: DataKeyPairSpec -> ()

Eq DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

(==) :: DataKeyPairSpec -> DataKeyPairSpec -> Bool

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

Ord DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

compare :: DataKeyPairSpec -> DataKeyPairSpec -> Ordering

(<) :: DataKeyPairSpec -> DataKeyPairSpec -> Bool

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

(>) :: DataKeyPairSpec -> DataKeyPairSpec -> Bool

(>=) :: DataKeyPairSpec -> DataKeyPairSpec -> Bool

max :: DataKeyPairSpec -> DataKeyPairSpec -> DataKeyPairSpec

min :: DataKeyPairSpec -> DataKeyPairSpec -> DataKeyPairSpec

Hashable DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

Methods

hashWithSalt :: Int -> DataKeyPairSpec -> Int

hash :: DataKeyPairSpec -> Int

type Rep DataKeyPairSpec

Defined in Amazonka.KMS.Types.DataKeyPairSpec

type Rep DataKeyPairSpec = D1 ('MetaData "DataKeyPairSpec" "Amazonka.KMS.Types.DataKeyPairSpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "DataKeyPairSpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataKeyPairSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DataKeySpec

newtype DataKeySpec

Constructors

DataKeySpec'

Fields

• fromDataKeySpec :: Text

Bundled Patterns

pattern DataKeySpec_AES_128 :: DataKeySpec

pattern DataKeySpec_AES_256 :: DataKeySpec

Instances

FromJSON DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

parseJSON :: Value -> Parser DataKeySpec

parseJSONList :: Value -> Parser [DataKeySpec]

FromJSONKey DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

fromJSONKey :: FromJSONKeyFunction DataKeySpec

fromJSONKeyList :: FromJSONKeyFunction [DataKeySpec]

ToJSON DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

toJSON :: DataKeySpec -> Value

toEncoding :: DataKeySpec -> Encoding

toJSONList :: [DataKeySpec] -> Value

toEncodingList :: [DataKeySpec] -> Encoding

ToJSONKey DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

toJSONKey :: ToJSONKeyFunction DataKeySpec

toJSONKeyList :: ToJSONKeyFunction [DataKeySpec]

ToByteString DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

toBS :: DataKeySpec -> ByteString

ToHeader DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

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

ToLog DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

build :: DataKeySpec -> ByteStringBuilder

ToQuery DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

toQuery :: DataKeySpec -> QueryString

FromText DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

fromText :: Text -> Either String DataKeySpec

ToText DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

toText :: DataKeySpec -> Text

FromXML DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

parseXML :: [Node] -> Either String DataKeySpec

ToXML DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

toXML :: DataKeySpec -> XML

Generic DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Associated Types

type Rep DataKeySpec :: Type -> Type

Methods

from :: DataKeySpec -> Rep DataKeySpec x

to :: Rep DataKeySpec x -> DataKeySpec

Read DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

readsPrec :: Int -> ReadS DataKeySpec

readList :: ReadS [DataKeySpec]

readPrec :: ReadPrec DataKeySpec

readListPrec :: ReadPrec [DataKeySpec]

Show DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

showsPrec :: Int -> DataKeySpec -> ShowS

show :: DataKeySpec -> String

showList :: [DataKeySpec] -> ShowS

NFData DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

rnf :: DataKeySpec -> ()

Eq DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

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

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

Ord DataKeySpec

Defined in Amazonka.KMS.Types.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

Hashable DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

Methods

hashWithSalt :: Int -> DataKeySpec -> Int

hash :: DataKeySpec -> Int

type Rep DataKeySpec

Defined in Amazonka.KMS.Types.DataKeySpec

type Rep DataKeySpec = D1 ('MetaData "DataKeySpec" "Amazonka.KMS.Types.DataKeySpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "DataKeySpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EncryptionAlgorithmSpec

newtype EncryptionAlgorithmSpec

Constructors

EncryptionAlgorithmSpec'

Fields

• fromEncryptionAlgorithmSpec :: Text

Bundled Patterns

pattern EncryptionAlgorithmSpec_RSAES_OAEP_SHA_1 :: EncryptionAlgorithmSpec

pattern EncryptionAlgorithmSpec_RSAES_OAEP_SHA_256 :: EncryptionAlgorithmSpec

pattern EncryptionAlgorithmSpec_SM2PKE :: EncryptionAlgorithmSpec

pattern EncryptionAlgorithmSpec_SYMMETRIC_DEFAULT :: EncryptionAlgorithmSpec

Instances

FromJSON EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

parseJSON :: Value -> Parser EncryptionAlgorithmSpec

parseJSONList :: Value -> Parser [EncryptionAlgorithmSpec]

FromJSONKey EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

fromJSONKey :: FromJSONKeyFunction EncryptionAlgorithmSpec

fromJSONKeyList :: FromJSONKeyFunction [EncryptionAlgorithmSpec]

ToJSON EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

toJSON :: EncryptionAlgorithmSpec -> Value

toEncoding :: EncryptionAlgorithmSpec -> Encoding

toJSONList :: [EncryptionAlgorithmSpec] -> Value

toEncodingList :: [EncryptionAlgorithmSpec] -> Encoding

ToJSONKey EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

toJSONKey :: ToJSONKeyFunction EncryptionAlgorithmSpec

toJSONKeyList :: ToJSONKeyFunction [EncryptionAlgorithmSpec]

ToByteString EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

toBS :: EncryptionAlgorithmSpec -> ByteString

ToHeader EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

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

ToLog EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

build :: EncryptionAlgorithmSpec -> ByteStringBuilder

ToQuery EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

toQuery :: EncryptionAlgorithmSpec -> QueryString

FromText EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

fromText :: Text -> Either String EncryptionAlgorithmSpec

ToText EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

toText :: EncryptionAlgorithmSpec -> Text

FromXML EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

parseXML :: [Node] -> Either String EncryptionAlgorithmSpec

ToXML EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

toXML :: EncryptionAlgorithmSpec -> XML

Generic EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Associated Types

type Rep EncryptionAlgorithmSpec :: Type -> Type

Methods

from :: EncryptionAlgorithmSpec -> Rep EncryptionAlgorithmSpec x

to :: Rep EncryptionAlgorithmSpec x -> EncryptionAlgorithmSpec

Read EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

readsPrec :: Int -> ReadS EncryptionAlgorithmSpec

readList :: ReadS [EncryptionAlgorithmSpec]

readPrec :: ReadPrec EncryptionAlgorithmSpec

readListPrec :: ReadPrec [EncryptionAlgorithmSpec]

Show EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

showsPrec :: Int -> EncryptionAlgorithmSpec -> ShowS

show :: EncryptionAlgorithmSpec -> String

showList :: [EncryptionAlgorithmSpec] -> ShowS

NFData EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

rnf :: EncryptionAlgorithmSpec -> ()

Eq EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

(==) :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> Bool

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

Ord EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

compare :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> Ordering

(<) :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> Bool

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

(>) :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> Bool

(>=) :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> Bool

max :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec

min :: EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec -> EncryptionAlgorithmSpec

Hashable EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

Methods

hashWithSalt :: Int -> EncryptionAlgorithmSpec -> Int

hash :: EncryptionAlgorithmSpec -> Int

type Rep EncryptionAlgorithmSpec

Defined in Amazonka.KMS.Types.EncryptionAlgorithmSpec

type Rep EncryptionAlgorithmSpec = D1 ('MetaData "EncryptionAlgorithmSpec" "Amazonka.KMS.Types.EncryptionAlgorithmSpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "EncryptionAlgorithmSpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEncryptionAlgorithmSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ExpirationModelType

newtype ExpirationModelType

Constructors

ExpirationModelType'

Fields

• fromExpirationModelType :: Text

Bundled Patterns

pattern ExpirationModelType_KEY_MATERIAL_DOES_NOT_EXPIRE :: ExpirationModelType

pattern ExpirationModelType_KEY_MATERIAL_EXPIRES :: ExpirationModelType

Instances

FromJSON ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

parseJSON :: Value -> Parser ExpirationModelType

parseJSONList :: Value -> Parser [ExpirationModelType]

FromJSONKey ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

fromJSONKey :: FromJSONKeyFunction ExpirationModelType

fromJSONKeyList :: FromJSONKeyFunction [ExpirationModelType]

ToJSON ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

toJSON :: ExpirationModelType -> Value

toEncoding :: ExpirationModelType -> Encoding

toJSONList :: [ExpirationModelType] -> Value

toEncodingList :: [ExpirationModelType] -> Encoding

ToJSONKey ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

toJSONKey :: ToJSONKeyFunction ExpirationModelType

toJSONKeyList :: ToJSONKeyFunction [ExpirationModelType]

ToByteString ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

toBS :: ExpirationModelType -> ByteString

ToHeader ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

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

ToLog ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

build :: ExpirationModelType -> ByteStringBuilder

ToQuery ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

toQuery :: ExpirationModelType -> QueryString

FromText ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

fromText :: Text -> Either String ExpirationModelType

ToText ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

toText :: ExpirationModelType -> Text

FromXML ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

parseXML :: [Node] -> Either String ExpirationModelType

ToXML ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

toXML :: ExpirationModelType -> XML

Generic ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Associated Types

type Rep ExpirationModelType :: Type -> Type

Methods

from :: ExpirationModelType -> Rep ExpirationModelType x

to :: Rep ExpirationModelType x -> ExpirationModelType

Read ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

readsPrec :: Int -> ReadS ExpirationModelType

readList :: ReadS [ExpirationModelType]

readPrec :: ReadPrec ExpirationModelType

readListPrec :: ReadPrec [ExpirationModelType]

Show ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

showsPrec :: Int -> ExpirationModelType -> ShowS

show :: ExpirationModelType -> String

showList :: [ExpirationModelType] -> ShowS

NFData ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

rnf :: ExpirationModelType -> ()

Eq ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

(==) :: ExpirationModelType -> ExpirationModelType -> Bool

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

Ord ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

compare :: ExpirationModelType -> ExpirationModelType -> Ordering

(<) :: ExpirationModelType -> ExpirationModelType -> Bool

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

(>) :: ExpirationModelType -> ExpirationModelType -> Bool

(>=) :: ExpirationModelType -> ExpirationModelType -> Bool

max :: ExpirationModelType -> ExpirationModelType -> ExpirationModelType

min :: ExpirationModelType -> ExpirationModelType -> ExpirationModelType

Hashable ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

Methods

hashWithSalt :: Int -> ExpirationModelType -> Int

hash :: ExpirationModelType -> Int

type Rep ExpirationModelType

Defined in Amazonka.KMS.Types.ExpirationModelType

type Rep ExpirationModelType = D1 ('MetaData "ExpirationModelType" "Amazonka.KMS.Types.ExpirationModelType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "ExpirationModelType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromExpirationModelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

GrantOperation

newtype GrantOperation

Constructors

GrantOperation'

Fields

• fromGrantOperation :: Text

Bundled Patterns

pattern GrantOperation_CreateGrant :: GrantOperation

pattern GrantOperation_Decrypt :: GrantOperation

pattern GrantOperation_DescribeKey :: GrantOperation

pattern GrantOperation_Encrypt :: GrantOperation

pattern GrantOperation_GenerateDataKey :: GrantOperation

pattern GrantOperation_GenerateDataKeyPair :: GrantOperation

pattern GrantOperation_GenerateDataKeyPairWithoutPlaintext :: GrantOperation

pattern GrantOperation_GenerateDataKeyWithoutPlaintext :: GrantOperation

pattern GrantOperation_GenerateMac :: GrantOperation

pattern GrantOperation_GetPublicKey :: GrantOperation

pattern GrantOperation_ReEncryptFrom :: GrantOperation

pattern GrantOperation_ReEncryptTo :: GrantOperation

pattern GrantOperation_RetireGrant :: GrantOperation

pattern GrantOperation_Sign :: GrantOperation

pattern GrantOperation_Verify :: GrantOperation

pattern GrantOperation_VerifyMac :: GrantOperation

Instances

FromJSON GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

parseJSON :: Value -> Parser GrantOperation

parseJSONList :: Value -> Parser [GrantOperation]

FromJSONKey GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

fromJSONKey :: FromJSONKeyFunction GrantOperation

fromJSONKeyList :: FromJSONKeyFunction [GrantOperation]

ToJSON GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

toJSON :: GrantOperation -> Value

toEncoding :: GrantOperation -> Encoding

toJSONList :: [GrantOperation] -> Value

toEncodingList :: [GrantOperation] -> Encoding

ToJSONKey GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

toJSONKey :: ToJSONKeyFunction GrantOperation

toJSONKeyList :: ToJSONKeyFunction [GrantOperation]

ToByteString GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

toBS :: GrantOperation -> ByteString

ToHeader GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

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

ToLog GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

build :: GrantOperation -> ByteStringBuilder

ToQuery GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

toQuery :: GrantOperation -> QueryString

FromText GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

fromText :: Text -> Either String GrantOperation

ToText GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

toText :: GrantOperation -> Text

FromXML GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

parseXML :: [Node] -> Either String GrantOperation

ToXML GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

toXML :: GrantOperation -> XML

Generic GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Associated Types

type Rep GrantOperation :: Type -> Type

Methods

from :: GrantOperation -> Rep GrantOperation x

to :: Rep GrantOperation x -> GrantOperation

Read GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

readsPrec :: Int -> ReadS GrantOperation

readList :: ReadS [GrantOperation]

readPrec :: ReadPrec GrantOperation

readListPrec :: ReadPrec [GrantOperation]

Show GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

showsPrec :: Int -> GrantOperation -> ShowS

show :: GrantOperation -> String

showList :: [GrantOperation] -> ShowS

NFData GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

rnf :: GrantOperation -> ()

Eq GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

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

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

Ord GrantOperation

Defined in Amazonka.KMS.Types.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

Hashable GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

Methods

hashWithSalt :: Int -> GrantOperation -> Int

hash :: GrantOperation -> Int

type Rep GrantOperation

Defined in Amazonka.KMS.Types.GrantOperation

type Rep GrantOperation = D1 ('MetaData "GrantOperation" "Amazonka.KMS.Types.GrantOperation" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "GrantOperation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromGrantOperation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeyManagerType

newtype KeyManagerType

Constructors

KeyManagerType'

Fields

• fromKeyManagerType :: Text

Bundled Patterns

pattern KeyManagerType_AWS :: KeyManagerType

pattern KeyManagerType_CUSTOMER :: KeyManagerType

Instances

FromJSON KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

parseJSON :: Value -> Parser KeyManagerType

parseJSONList :: Value -> Parser [KeyManagerType]

FromJSONKey KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

fromJSONKey :: FromJSONKeyFunction KeyManagerType

fromJSONKeyList :: FromJSONKeyFunction [KeyManagerType]

ToJSON KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

toJSON :: KeyManagerType -> Value

toEncoding :: KeyManagerType -> Encoding

toJSONList :: [KeyManagerType] -> Value

toEncodingList :: [KeyManagerType] -> Encoding

ToJSONKey KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

toJSONKey :: ToJSONKeyFunction KeyManagerType

toJSONKeyList :: ToJSONKeyFunction [KeyManagerType]

ToByteString KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

toBS :: KeyManagerType -> ByteString

ToHeader KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

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

ToLog KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

build :: KeyManagerType -> ByteStringBuilder

ToQuery KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

toQuery :: KeyManagerType -> QueryString

FromText KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

fromText :: Text -> Either String KeyManagerType

ToText KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

toText :: KeyManagerType -> Text

FromXML KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

parseXML :: [Node] -> Either String KeyManagerType

ToXML KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

toXML :: KeyManagerType -> XML

Generic KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Associated Types

type Rep KeyManagerType :: Type -> Type

Methods

from :: KeyManagerType -> Rep KeyManagerType x

to :: Rep KeyManagerType x -> KeyManagerType

Read KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

readsPrec :: Int -> ReadS KeyManagerType

readList :: ReadS [KeyManagerType]

readPrec :: ReadPrec KeyManagerType

readListPrec :: ReadPrec [KeyManagerType]

Show KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

showsPrec :: Int -> KeyManagerType -> ShowS

show :: KeyManagerType -> String

showList :: [KeyManagerType] -> ShowS

NFData KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

rnf :: KeyManagerType -> ()

Eq KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

(==) :: KeyManagerType -> KeyManagerType -> Bool

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

Ord KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

compare :: KeyManagerType -> KeyManagerType -> Ordering

(<) :: KeyManagerType -> KeyManagerType -> Bool

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

(>) :: KeyManagerType -> KeyManagerType -> Bool

(>=) :: KeyManagerType -> KeyManagerType -> Bool

max :: KeyManagerType -> KeyManagerType -> KeyManagerType

min :: KeyManagerType -> KeyManagerType -> KeyManagerType

Hashable KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

Methods

hashWithSalt :: Int -> KeyManagerType -> Int

hash :: KeyManagerType -> Int

type Rep KeyManagerType

Defined in Amazonka.KMS.Types.KeyManagerType

type Rep KeyManagerType = D1 ('MetaData "KeyManagerType" "Amazonka.KMS.Types.KeyManagerType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "KeyManagerType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeyManagerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeySpec

newtype KeySpec

Constructors

KeySpec'

Fields

• fromKeySpec :: Text

Bundled Patterns

pattern KeySpec_ECC_NIST_P256 :: KeySpec

pattern KeySpec_ECC_NIST_P384 :: KeySpec

pattern KeySpec_ECC_NIST_P521 :: KeySpec

pattern KeySpec_ECC_SECG_P256K1 :: KeySpec

pattern KeySpec_HMAC_224 :: KeySpec

pattern KeySpec_HMAC_256 :: KeySpec

pattern KeySpec_HMAC_384 :: KeySpec

pattern KeySpec_HMAC_512 :: KeySpec

pattern KeySpec_RSA_2048 :: KeySpec

pattern KeySpec_RSA_3072 :: KeySpec

pattern KeySpec_RSA_4096 :: KeySpec

pattern KeySpec_SM2 :: KeySpec

pattern KeySpec_SYMMETRIC_DEFAULT :: KeySpec

Instances

FromJSON KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

parseJSON :: Value -> Parser KeySpec

parseJSONList :: Value -> Parser [KeySpec]

FromJSONKey KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

fromJSONKey :: FromJSONKeyFunction KeySpec

fromJSONKeyList :: FromJSONKeyFunction [KeySpec]

ToJSON KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

toJSON :: KeySpec -> Value

toEncoding :: KeySpec -> Encoding

toJSONList :: [KeySpec] -> Value

toEncodingList :: [KeySpec] -> Encoding

ToJSONKey KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

toJSONKey :: ToJSONKeyFunction KeySpec

toJSONKeyList :: ToJSONKeyFunction [KeySpec]

ToByteString KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

toBS :: KeySpec -> ByteString

ToHeader KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

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

ToLog KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

build :: KeySpec -> ByteStringBuilder

ToQuery KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

toQuery :: KeySpec -> QueryString

FromText KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

fromText :: Text -> Either String KeySpec

ToText KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

toText :: KeySpec -> Text

FromXML KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

parseXML :: [Node] -> Either String KeySpec

ToXML KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

toXML :: KeySpec -> XML

Generic KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Associated Types

type Rep KeySpec :: Type -> Type

Methods

from :: KeySpec -> Rep KeySpec x

to :: Rep KeySpec x -> KeySpec

Read KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

readsPrec :: Int -> ReadS KeySpec

readList :: ReadS [KeySpec]

readPrec :: ReadPrec KeySpec

readListPrec :: ReadPrec [KeySpec]

Show KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

showsPrec :: Int -> KeySpec -> ShowS

show :: KeySpec -> String

showList :: [KeySpec] -> ShowS

NFData KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

rnf :: KeySpec -> ()

Eq KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

(==) :: KeySpec -> KeySpec -> Bool

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

Ord KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

compare :: KeySpec -> KeySpec -> Ordering

(<) :: KeySpec -> KeySpec -> Bool

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

(>) :: KeySpec -> KeySpec -> Bool

(>=) :: KeySpec -> KeySpec -> Bool

max :: KeySpec -> KeySpec -> KeySpec

min :: KeySpec -> KeySpec -> KeySpec

Hashable KeySpec

Defined in Amazonka.KMS.Types.KeySpec

Methods

hashWithSalt :: Int -> KeySpec -> Int

hash :: KeySpec -> Int

type Rep KeySpec

Defined in Amazonka.KMS.Types.KeySpec

type Rep KeySpec = D1 ('MetaData "KeySpec" "Amazonka.KMS.Types.KeySpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "KeySpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeyState

newtype KeyState

Constructors

KeyState'

Fields

• fromKeyState :: Text

Bundled Patterns

pattern KeyState_Creating :: KeyState

pattern KeyState_Disabled :: KeyState

pattern KeyState_Enabled :: KeyState

pattern KeyState_PendingDeletion :: KeyState

pattern KeyState_PendingImport :: KeyState

pattern KeyState_PendingReplicaDeletion :: KeyState

pattern KeyState_Unavailable :: KeyState

pattern KeyState_Updating :: KeyState

Instances

FromJSON KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

parseJSON :: Value -> Parser KeyState

parseJSONList :: Value -> Parser [KeyState]

FromJSONKey KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

fromJSONKey :: FromJSONKeyFunction KeyState

fromJSONKeyList :: FromJSONKeyFunction [KeyState]

ToJSON KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

toJSON :: KeyState -> Value

toEncoding :: KeyState -> Encoding

toJSONList :: [KeyState] -> Value

toEncodingList :: [KeyState] -> Encoding

ToJSONKey KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

toJSONKey :: ToJSONKeyFunction KeyState

toJSONKeyList :: ToJSONKeyFunction [KeyState]

ToByteString KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

toBS :: KeyState -> ByteString

ToHeader KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

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

ToLog KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

build :: KeyState -> ByteStringBuilder

ToQuery KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

toQuery :: KeyState -> QueryString

FromText KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

fromText :: Text -> Either String KeyState

ToText KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

toText :: KeyState -> Text

FromXML KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

parseXML :: [Node] -> Either String KeyState

ToXML KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

toXML :: KeyState -> XML

Generic KeyState

Defined in Amazonka.KMS.Types.KeyState

Associated Types

type Rep KeyState :: Type -> Type

Methods

from :: KeyState -> Rep KeyState x

to :: Rep KeyState x -> KeyState

Read KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

readsPrec :: Int -> ReadS KeyState

readList :: ReadS [KeyState]

readPrec :: ReadPrec KeyState

readListPrec :: ReadPrec [KeyState]

Show KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

showsPrec :: Int -> KeyState -> ShowS

show :: KeyState -> String

showList :: [KeyState] -> ShowS

NFData KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

rnf :: KeyState -> ()

Eq KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

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

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

Ord KeyState

Defined in Amazonka.KMS.Types.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

Hashable KeyState

Defined in Amazonka.KMS.Types.KeyState

Methods

hashWithSalt :: Int -> KeyState -> Int

hash :: KeyState -> Int

type Rep KeyState

Defined in Amazonka.KMS.Types.KeyState

type Rep KeyState = D1 ('MetaData "KeyState" "Amazonka.KMS.Types.KeyState" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "KeyState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

KeyUsageType

newtype KeyUsageType

Constructors

KeyUsageType'

Fields

• fromKeyUsageType :: Text

Bundled Patterns

pattern KeyUsageType_ENCRYPT_DECRYPT :: KeyUsageType

pattern KeyUsageType_GENERATE_VERIFY_MAC :: KeyUsageType

pattern KeyUsageType_SIGN_VERIFY :: KeyUsageType

Instances

FromJSON KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

parseJSON :: Value -> Parser KeyUsageType

parseJSONList :: Value -> Parser [KeyUsageType]

FromJSONKey KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

fromJSONKey :: FromJSONKeyFunction KeyUsageType

fromJSONKeyList :: FromJSONKeyFunction [KeyUsageType]

ToJSON KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

toJSON :: KeyUsageType -> Value

toEncoding :: KeyUsageType -> Encoding

toJSONList :: [KeyUsageType] -> Value

toEncodingList :: [KeyUsageType] -> Encoding

ToJSONKey KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

toJSONKey :: ToJSONKeyFunction KeyUsageType

toJSONKeyList :: ToJSONKeyFunction [KeyUsageType]

ToByteString KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

toBS :: KeyUsageType -> ByteString

ToHeader KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

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

ToLog KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

build :: KeyUsageType -> ByteStringBuilder

ToQuery KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

toQuery :: KeyUsageType -> QueryString

FromText KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

fromText :: Text -> Either String KeyUsageType

ToText KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

toText :: KeyUsageType -> Text

FromXML KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

parseXML :: [Node] -> Either String KeyUsageType

ToXML KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

toXML :: KeyUsageType -> XML

Generic KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Associated Types

type Rep KeyUsageType :: Type -> Type

Methods

from :: KeyUsageType -> Rep KeyUsageType x

to :: Rep KeyUsageType x -> KeyUsageType

Read KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

readsPrec :: Int -> ReadS KeyUsageType

readList :: ReadS [KeyUsageType]

readPrec :: ReadPrec KeyUsageType

readListPrec :: ReadPrec [KeyUsageType]

Show KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

showsPrec :: Int -> KeyUsageType -> ShowS

show :: KeyUsageType -> String

showList :: [KeyUsageType] -> ShowS

NFData KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

rnf :: KeyUsageType -> ()

Eq KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

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

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

Ord KeyUsageType

Defined in Amazonka.KMS.Types.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

Hashable KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

Methods

hashWithSalt :: Int -> KeyUsageType -> Int

hash :: KeyUsageType -> Int

type Rep KeyUsageType

Defined in Amazonka.KMS.Types.KeyUsageType

type Rep KeyUsageType = D1 ('MetaData "KeyUsageType" "Amazonka.KMS.Types.KeyUsageType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "KeyUsageType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromKeyUsageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MacAlgorithmSpec

newtype MacAlgorithmSpec

Constructors

MacAlgorithmSpec'

Fields

• fromMacAlgorithmSpec :: Text

Bundled Patterns

pattern MacAlgorithmSpec_HMAC_SHA_224 :: MacAlgorithmSpec

pattern MacAlgorithmSpec_HMAC_SHA_256 :: MacAlgorithmSpec

pattern MacAlgorithmSpec_HMAC_SHA_384 :: MacAlgorithmSpec

pattern MacAlgorithmSpec_HMAC_SHA_512 :: MacAlgorithmSpec

Instances

FromJSON MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

parseJSON :: Value -> Parser MacAlgorithmSpec

parseJSONList :: Value -> Parser [MacAlgorithmSpec]

FromJSONKey MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

fromJSONKey :: FromJSONKeyFunction MacAlgorithmSpec

fromJSONKeyList :: FromJSONKeyFunction [MacAlgorithmSpec]

ToJSON MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

toJSON :: MacAlgorithmSpec -> Value

toEncoding :: MacAlgorithmSpec -> Encoding

toJSONList :: [MacAlgorithmSpec] -> Value

toEncodingList :: [MacAlgorithmSpec] -> Encoding

ToJSONKey MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

toJSONKey :: ToJSONKeyFunction MacAlgorithmSpec

toJSONKeyList :: ToJSONKeyFunction [MacAlgorithmSpec]

ToByteString MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

toBS :: MacAlgorithmSpec -> ByteString

ToHeader MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

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

ToLog MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

build :: MacAlgorithmSpec -> ByteStringBuilder

ToQuery MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

toQuery :: MacAlgorithmSpec -> QueryString

FromText MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

fromText :: Text -> Either String MacAlgorithmSpec

ToText MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

toText :: MacAlgorithmSpec -> Text

FromXML MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

parseXML :: [Node] -> Either String MacAlgorithmSpec

ToXML MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

toXML :: MacAlgorithmSpec -> XML

Generic MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Associated Types

type Rep MacAlgorithmSpec :: Type -> Type

Methods

from :: MacAlgorithmSpec -> Rep MacAlgorithmSpec x

to :: Rep MacAlgorithmSpec x -> MacAlgorithmSpec

Read MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

readsPrec :: Int -> ReadS MacAlgorithmSpec

readList :: ReadS [MacAlgorithmSpec]

readPrec :: ReadPrec MacAlgorithmSpec

readListPrec :: ReadPrec [MacAlgorithmSpec]

Show MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

showsPrec :: Int -> MacAlgorithmSpec -> ShowS

show :: MacAlgorithmSpec -> String

showList :: [MacAlgorithmSpec] -> ShowS

NFData MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

rnf :: MacAlgorithmSpec -> ()

Eq MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

(==) :: MacAlgorithmSpec -> MacAlgorithmSpec -> Bool

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

Ord MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

compare :: MacAlgorithmSpec -> MacAlgorithmSpec -> Ordering

(<) :: MacAlgorithmSpec -> MacAlgorithmSpec -> Bool

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

(>) :: MacAlgorithmSpec -> MacAlgorithmSpec -> Bool

(>=) :: MacAlgorithmSpec -> MacAlgorithmSpec -> Bool

max :: MacAlgorithmSpec -> MacAlgorithmSpec -> MacAlgorithmSpec

min :: MacAlgorithmSpec -> MacAlgorithmSpec -> MacAlgorithmSpec

Hashable MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

Methods

hashWithSalt :: Int -> MacAlgorithmSpec -> Int

hash :: MacAlgorithmSpec -> Int

type Rep MacAlgorithmSpec

Defined in Amazonka.KMS.Types.MacAlgorithmSpec

type Rep MacAlgorithmSpec = D1 ('MetaData "MacAlgorithmSpec" "Amazonka.KMS.Types.MacAlgorithmSpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "MacAlgorithmSpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMacAlgorithmSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MessageType

newtype MessageType

Constructors

MessageType'

Fields

• fromMessageType :: Text

Bundled Patterns

pattern MessageType_DIGEST :: MessageType

pattern MessageType_RAW :: MessageType

Instances

FromJSON MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

parseJSON :: Value -> Parser MessageType

parseJSONList :: Value -> Parser [MessageType]

FromJSONKey MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

fromJSONKey :: FromJSONKeyFunction MessageType

fromJSONKeyList :: FromJSONKeyFunction [MessageType]

ToJSON MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

toJSON :: MessageType -> Value

toEncoding :: MessageType -> Encoding

toJSONList :: [MessageType] -> Value

toEncodingList :: [MessageType] -> Encoding

ToJSONKey MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

toJSONKey :: ToJSONKeyFunction MessageType

toJSONKeyList :: ToJSONKeyFunction [MessageType]

ToByteString MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

toBS :: MessageType -> ByteString

ToHeader MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

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

ToLog MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

build :: MessageType -> ByteStringBuilder

ToQuery MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

toQuery :: MessageType -> QueryString

FromText MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

fromText :: Text -> Either String MessageType

ToText MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

toText :: MessageType -> Text

FromXML MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

parseXML :: [Node] -> Either String MessageType

ToXML MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

toXML :: MessageType -> XML

Generic MessageType

Defined in Amazonka.KMS.Types.MessageType

Associated Types

type Rep MessageType :: Type -> Type

Methods

from :: MessageType -> Rep MessageType x

to :: Rep MessageType x -> MessageType

Read MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

readsPrec :: Int -> ReadS MessageType

readList :: ReadS [MessageType]

readPrec :: ReadPrec MessageType

readListPrec :: ReadPrec [MessageType]

Show MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

showsPrec :: Int -> MessageType -> ShowS

show :: MessageType -> String

showList :: [MessageType] -> ShowS

NFData MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

rnf :: MessageType -> ()

Eq MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

(==) :: MessageType -> MessageType -> Bool

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

Ord MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

compare :: MessageType -> MessageType -> Ordering

(<) :: MessageType -> MessageType -> Bool

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

(>) :: MessageType -> MessageType -> Bool

(>=) :: MessageType -> MessageType -> Bool

max :: MessageType -> MessageType -> MessageType

min :: MessageType -> MessageType -> MessageType

Hashable MessageType

Defined in Amazonka.KMS.Types.MessageType

Methods

hashWithSalt :: Int -> MessageType -> Int

hash :: MessageType -> Int

type Rep MessageType

Defined in Amazonka.KMS.Types.MessageType

type Rep MessageType = D1 ('MetaData "MessageType" "Amazonka.KMS.Types.MessageType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "MessageType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMessageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MultiRegionKeyType

newtype MultiRegionKeyType

Constructors

MultiRegionKeyType'

Fields

• fromMultiRegionKeyType :: Text

Bundled Patterns

pattern MultiRegionKeyType_PRIMARY :: MultiRegionKeyType

pattern MultiRegionKeyType_REPLICA :: MultiRegionKeyType

Instances

FromJSON MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

parseJSON :: Value -> Parser MultiRegionKeyType

parseJSONList :: Value -> Parser [MultiRegionKeyType]

FromJSONKey MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

fromJSONKey :: FromJSONKeyFunction MultiRegionKeyType

fromJSONKeyList :: FromJSONKeyFunction [MultiRegionKeyType]

ToJSON MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

toJSON :: MultiRegionKeyType -> Value

toEncoding :: MultiRegionKeyType -> Encoding

toJSONList :: [MultiRegionKeyType] -> Value

toEncodingList :: [MultiRegionKeyType] -> Encoding

ToJSONKey MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

toJSONKey :: ToJSONKeyFunction MultiRegionKeyType

toJSONKeyList :: ToJSONKeyFunction [MultiRegionKeyType]

ToByteString MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

toBS :: MultiRegionKeyType -> ByteString

ToHeader MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

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

ToLog MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

build :: MultiRegionKeyType -> ByteStringBuilder

ToQuery MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

toQuery :: MultiRegionKeyType -> QueryString

FromText MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

fromText :: Text -> Either String MultiRegionKeyType

ToText MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

toText :: MultiRegionKeyType -> Text

FromXML MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

parseXML :: [Node] -> Either String MultiRegionKeyType

ToXML MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

toXML :: MultiRegionKeyType -> XML

Generic MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Associated Types

type Rep MultiRegionKeyType :: Type -> Type

Methods

from :: MultiRegionKeyType -> Rep MultiRegionKeyType x

to :: Rep MultiRegionKeyType x -> MultiRegionKeyType

Read MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

readsPrec :: Int -> ReadS MultiRegionKeyType

readList :: ReadS [MultiRegionKeyType]

readPrec :: ReadPrec MultiRegionKeyType

readListPrec :: ReadPrec [MultiRegionKeyType]

Show MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

showsPrec :: Int -> MultiRegionKeyType -> ShowS

show :: MultiRegionKeyType -> String

showList :: [MultiRegionKeyType] -> ShowS

NFData MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

rnf :: MultiRegionKeyType -> ()

Eq MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

(==) :: MultiRegionKeyType -> MultiRegionKeyType -> Bool

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

Ord MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

compare :: MultiRegionKeyType -> MultiRegionKeyType -> Ordering

(<) :: MultiRegionKeyType -> MultiRegionKeyType -> Bool

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

(>) :: MultiRegionKeyType -> MultiRegionKeyType -> Bool

(>=) :: MultiRegionKeyType -> MultiRegionKeyType -> Bool

max :: MultiRegionKeyType -> MultiRegionKeyType -> MultiRegionKeyType

min :: MultiRegionKeyType -> MultiRegionKeyType -> MultiRegionKeyType

Hashable MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

Methods

hashWithSalt :: Int -> MultiRegionKeyType -> Int

hash :: MultiRegionKeyType -> Int

type Rep MultiRegionKeyType

Defined in Amazonka.KMS.Types.MultiRegionKeyType

type Rep MultiRegionKeyType = D1 ('MetaData "MultiRegionKeyType" "Amazonka.KMS.Types.MultiRegionKeyType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "MultiRegionKeyType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMultiRegionKeyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

OriginType

newtype OriginType

Constructors

OriginType'

Fields

• fromOriginType :: Text

Bundled Patterns

pattern OriginType_AWS_CLOUDHSM :: OriginType

pattern OriginType_AWS_KMS :: OriginType

pattern OriginType_EXTERNAL :: OriginType

pattern OriginType_EXTERNAL_KEY_STORE :: OriginType

Instances

FromJSON OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

parseJSON :: Value -> Parser OriginType

parseJSONList :: Value -> Parser [OriginType]

FromJSONKey OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

fromJSONKey :: FromJSONKeyFunction OriginType

fromJSONKeyList :: FromJSONKeyFunction [OriginType]

ToJSON OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

toJSON :: OriginType -> Value

toEncoding :: OriginType -> Encoding

toJSONList :: [OriginType] -> Value

toEncodingList :: [OriginType] -> Encoding

ToJSONKey OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

toJSONKey :: ToJSONKeyFunction OriginType

toJSONKeyList :: ToJSONKeyFunction [OriginType]

ToByteString OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

toBS :: OriginType -> ByteString

ToHeader OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

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

ToLog OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

build :: OriginType -> ByteStringBuilder

ToQuery OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

toQuery :: OriginType -> QueryString

FromText OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

fromText :: Text -> Either String OriginType

ToText OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

toText :: OriginType -> Text

FromXML OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

parseXML :: [Node] -> Either String OriginType

ToXML OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

toXML :: OriginType -> XML

Generic OriginType

Defined in Amazonka.KMS.Types.OriginType

Associated Types

type Rep OriginType :: Type -> Type

Methods

from :: OriginType -> Rep OriginType x

to :: Rep OriginType x -> OriginType

Read OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

readsPrec :: Int -> ReadS OriginType

readList :: ReadS [OriginType]

readPrec :: ReadPrec OriginType

readListPrec :: ReadPrec [OriginType]

Show OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

showsPrec :: Int -> OriginType -> ShowS

show :: OriginType -> String

showList :: [OriginType] -> ShowS

NFData OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

rnf :: OriginType -> ()

Eq OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

(==) :: OriginType -> OriginType -> Bool

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

Ord OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

compare :: OriginType -> OriginType -> Ordering

(<) :: OriginType -> OriginType -> Bool

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

(>) :: OriginType -> OriginType -> Bool

(>=) :: OriginType -> OriginType -> Bool

max :: OriginType -> OriginType -> OriginType

min :: OriginType -> OriginType -> OriginType

Hashable OriginType

Defined in Amazonka.KMS.Types.OriginType

Methods

hashWithSalt :: Int -> OriginType -> Int

hash :: OriginType -> Int

type Rep OriginType

Defined in Amazonka.KMS.Types.OriginType

type Rep OriginType = D1 ('MetaData "OriginType" "Amazonka.KMS.Types.OriginType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "OriginType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOriginType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SigningAlgorithmSpec

newtype SigningAlgorithmSpec

Constructors

SigningAlgorithmSpec'

Fields

• fromSigningAlgorithmSpec :: Text

Bundled Patterns

pattern SigningAlgorithmSpec_ECDSA_SHA_256 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_ECDSA_SHA_384 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_ECDSA_SHA_512 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_256 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_384 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_512 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_256 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_384 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_512 :: SigningAlgorithmSpec

pattern SigningAlgorithmSpec_SM2DSA :: SigningAlgorithmSpec

Instances

FromJSON SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

parseJSON :: Value -> Parser SigningAlgorithmSpec

parseJSONList :: Value -> Parser [SigningAlgorithmSpec]

FromJSONKey SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

fromJSONKey :: FromJSONKeyFunction SigningAlgorithmSpec

fromJSONKeyList :: FromJSONKeyFunction [SigningAlgorithmSpec]

ToJSON SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

toJSON :: SigningAlgorithmSpec -> Value

toEncoding :: SigningAlgorithmSpec -> Encoding

toJSONList :: [SigningAlgorithmSpec] -> Value

toEncodingList :: [SigningAlgorithmSpec] -> Encoding

ToJSONKey SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

toJSONKey :: ToJSONKeyFunction SigningAlgorithmSpec

toJSONKeyList :: ToJSONKeyFunction [SigningAlgorithmSpec]

ToByteString SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

toBS :: SigningAlgorithmSpec -> ByteString

ToHeader SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

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

ToLog SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

build :: SigningAlgorithmSpec -> ByteStringBuilder

ToQuery SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

toQuery :: SigningAlgorithmSpec -> QueryString

FromText SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

fromText :: Text -> Either String SigningAlgorithmSpec

ToText SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

toText :: SigningAlgorithmSpec -> Text

FromXML SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

parseXML :: [Node] -> Either String SigningAlgorithmSpec

ToXML SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

toXML :: SigningAlgorithmSpec -> XML

Generic SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Associated Types

type Rep SigningAlgorithmSpec :: Type -> Type

Methods

from :: SigningAlgorithmSpec -> Rep SigningAlgorithmSpec x

to :: Rep SigningAlgorithmSpec x -> SigningAlgorithmSpec

Read SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

readsPrec :: Int -> ReadS SigningAlgorithmSpec

readList :: ReadS [SigningAlgorithmSpec]

readPrec :: ReadPrec SigningAlgorithmSpec

readListPrec :: ReadPrec [SigningAlgorithmSpec]

Show SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

showsPrec :: Int -> SigningAlgorithmSpec -> ShowS

show :: SigningAlgorithmSpec -> String

showList :: [SigningAlgorithmSpec] -> ShowS

NFData SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

rnf :: SigningAlgorithmSpec -> ()

Eq SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

(==) :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> Bool

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

Ord SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

compare :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> Ordering

(<) :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> Bool

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

(>) :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> Bool

(>=) :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> Bool

max :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> SigningAlgorithmSpec

min :: SigningAlgorithmSpec -> SigningAlgorithmSpec -> SigningAlgorithmSpec

Hashable SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

Methods

hashWithSalt :: Int -> SigningAlgorithmSpec -> Int

hash :: SigningAlgorithmSpec -> Int

type Rep SigningAlgorithmSpec

Defined in Amazonka.KMS.Types.SigningAlgorithmSpec

type Rep SigningAlgorithmSpec = D1 ('MetaData "SigningAlgorithmSpec" "Amazonka.KMS.Types.SigningAlgorithmSpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "SigningAlgorithmSpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSigningAlgorithmSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

WrappingKeySpec

newtype WrappingKeySpec

Constructors

WrappingKeySpec'

Fields

• fromWrappingKeySpec :: Text

Bundled Patterns

pattern WrappingKeySpec_RSA_2048 :: WrappingKeySpec

Instances

FromJSON WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

parseJSON :: Value -> Parser WrappingKeySpec

parseJSONList :: Value -> Parser [WrappingKeySpec]

FromJSONKey WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

fromJSONKey :: FromJSONKeyFunction WrappingKeySpec

fromJSONKeyList :: FromJSONKeyFunction [WrappingKeySpec]

ToJSON WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

toJSON :: WrappingKeySpec -> Value

toEncoding :: WrappingKeySpec -> Encoding

toJSONList :: [WrappingKeySpec] -> Value

toEncodingList :: [WrappingKeySpec] -> Encoding

ToJSONKey WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

toJSONKey :: ToJSONKeyFunction WrappingKeySpec

toJSONKeyList :: ToJSONKeyFunction [WrappingKeySpec]

ToByteString WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

toBS :: WrappingKeySpec -> ByteString

ToHeader WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

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

ToLog WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

build :: WrappingKeySpec -> ByteStringBuilder

ToQuery WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

toQuery :: WrappingKeySpec -> QueryString

FromText WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

fromText :: Text -> Either String WrappingKeySpec

ToText WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

toText :: WrappingKeySpec -> Text

FromXML WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

parseXML :: [Node] -> Either String WrappingKeySpec

ToXML WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

toXML :: WrappingKeySpec -> XML

Generic WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Associated Types

type Rep WrappingKeySpec :: Type -> Type

Methods

from :: WrappingKeySpec -> Rep WrappingKeySpec x

to :: Rep WrappingKeySpec x -> WrappingKeySpec

Read WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

readsPrec :: Int -> ReadS WrappingKeySpec

readList :: ReadS [WrappingKeySpec]

readPrec :: ReadPrec WrappingKeySpec

readListPrec :: ReadPrec [WrappingKeySpec]

Show WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

showsPrec :: Int -> WrappingKeySpec -> ShowS

show :: WrappingKeySpec -> String

showList :: [WrappingKeySpec] -> ShowS

NFData WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

rnf :: WrappingKeySpec -> ()

Eq WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

(==) :: WrappingKeySpec -> WrappingKeySpec -> Bool

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

Ord WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

compare :: WrappingKeySpec -> WrappingKeySpec -> Ordering

(<) :: WrappingKeySpec -> WrappingKeySpec -> Bool

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

(>) :: WrappingKeySpec -> WrappingKeySpec -> Bool

(>=) :: WrappingKeySpec -> WrappingKeySpec -> Bool

max :: WrappingKeySpec -> WrappingKeySpec -> WrappingKeySpec

min :: WrappingKeySpec -> WrappingKeySpec -> WrappingKeySpec

Hashable WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

Methods

hashWithSalt :: Int -> WrappingKeySpec -> Int

hash :: WrappingKeySpec -> Int

type Rep WrappingKeySpec

Defined in Amazonka.KMS.Types.WrappingKeySpec

type Rep WrappingKeySpec = D1 ('MetaData "WrappingKeySpec" "Amazonka.KMS.Types.WrappingKeySpec" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "WrappingKeySpec'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromWrappingKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

XksProxyConnectivityType

newtype XksProxyConnectivityType

Constructors

XksProxyConnectivityType'

Fields

• fromXksProxyConnectivityType :: Text

Bundled Patterns

pattern XksProxyConnectivityType_PUBLIC_ENDPOINT :: XksProxyConnectivityType

pattern XksProxyConnectivityType_VPC_ENDPOINT_SERVICE :: XksProxyConnectivityType

Instances

FromJSON XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

parseJSON :: Value -> Parser XksProxyConnectivityType

parseJSONList :: Value -> Parser [XksProxyConnectivityType]

FromJSONKey XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

fromJSONKey :: FromJSONKeyFunction XksProxyConnectivityType

fromJSONKeyList :: FromJSONKeyFunction [XksProxyConnectivityType]

ToJSON XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

toJSON :: XksProxyConnectivityType -> Value

toEncoding :: XksProxyConnectivityType -> Encoding

toJSONList :: [XksProxyConnectivityType] -> Value

toEncodingList :: [XksProxyConnectivityType] -> Encoding

ToJSONKey XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

toJSONKey :: ToJSONKeyFunction XksProxyConnectivityType

toJSONKeyList :: ToJSONKeyFunction [XksProxyConnectivityType]

ToByteString XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

toBS :: XksProxyConnectivityType -> ByteString

ToHeader XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

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

ToLog XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

build :: XksProxyConnectivityType -> ByteStringBuilder

ToQuery XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

toQuery :: XksProxyConnectivityType -> QueryString

FromText XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

fromText :: Text -> Either String XksProxyConnectivityType

ToText XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

toText :: XksProxyConnectivityType -> Text

FromXML XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

parseXML :: [Node] -> Either String XksProxyConnectivityType

ToXML XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

toXML :: XksProxyConnectivityType -> XML

Generic XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Associated Types

type Rep XksProxyConnectivityType :: Type -> Type

Methods

from :: XksProxyConnectivityType -> Rep XksProxyConnectivityType x

to :: Rep XksProxyConnectivityType x -> XksProxyConnectivityType

Read XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

readsPrec :: Int -> ReadS XksProxyConnectivityType

readList :: ReadS [XksProxyConnectivityType]

readPrec :: ReadPrec XksProxyConnectivityType

readListPrec :: ReadPrec [XksProxyConnectivityType]

Show XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

showsPrec :: Int -> XksProxyConnectivityType -> ShowS

show :: XksProxyConnectivityType -> String

showList :: [XksProxyConnectivityType] -> ShowS

NFData XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

rnf :: XksProxyConnectivityType -> ()

Eq XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

(==) :: XksProxyConnectivityType -> XksProxyConnectivityType -> Bool

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

Ord XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

compare :: XksProxyConnectivityType -> XksProxyConnectivityType -> Ordering

(<) :: XksProxyConnectivityType -> XksProxyConnectivityType -> Bool

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

(>) :: XksProxyConnectivityType -> XksProxyConnectivityType -> Bool

(>=) :: XksProxyConnectivityType -> XksProxyConnectivityType -> Bool

max :: XksProxyConnectivityType -> XksProxyConnectivityType -> XksProxyConnectivityType

min :: XksProxyConnectivityType -> XksProxyConnectivityType -> XksProxyConnectivityType

Hashable XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

Methods

hashWithSalt :: Int -> XksProxyConnectivityType -> Int

hash :: XksProxyConnectivityType -> Int

type Rep XksProxyConnectivityType

Defined in Amazonka.KMS.Types.XksProxyConnectivityType

type Rep XksProxyConnectivityType = D1 ('MetaData "XksProxyConnectivityType" "Amazonka.KMS.Types.XksProxyConnectivityType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'True) (C1 ('MetaCons "XksProxyConnectivityType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromXksProxyConnectivityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AliasListEntry

data AliasListEntry

Contains information about an alias.

See: newAliasListEntry smart constructor.

Constructors

AliasListEntry' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text)

Instances

FromJSON AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Methods

parseJSON :: Value -> Parser AliasListEntry

parseJSONList :: Value -> Parser [AliasListEntry]

Generic AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Associated Types

type Rep AliasListEntry :: Type -> Type

Methods

from :: AliasListEntry -> Rep AliasListEntry x

to :: Rep AliasListEntry x -> AliasListEntry

Read AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Methods

readsPrec :: Int -> ReadS AliasListEntry

readList :: ReadS [AliasListEntry]

readPrec :: ReadPrec AliasListEntry

readListPrec :: ReadPrec [AliasListEntry]

Show AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Methods

showsPrec :: Int -> AliasListEntry -> ShowS

show :: AliasListEntry -> String

showList :: [AliasListEntry] -> ShowS

NFData AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Methods

rnf :: AliasListEntry -> ()

Eq AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Methods

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

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

Hashable AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

Methods

hashWithSalt :: Int -> AliasListEntry -> Int

hash :: AliasListEntry -> Int

type Rep AliasListEntry

Defined in Amazonka.KMS.Types.AliasListEntry

type Rep AliasListEntry = D1 ('MetaData "AliasListEntry" "Amazonka.KMS.Types.AliasListEntry" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "AliasListEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliasArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "aliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "targetKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAliasListEntry :: AliasListEntry

Create a value of AliasListEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aliasArn:AliasListEntry', aliasListEntry_aliasArn - String that contains the key ARN.

$sel:aliasName:AliasListEntry', aliasListEntry_aliasName - String that contains the alias. This value begins with alias/.

$sel:creationDate:AliasListEntry', aliasListEntry_creationDate - Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

$sel:lastUpdatedDate:AliasListEntry', aliasListEntry_lastUpdatedDate - Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.

$sel:targetKeyId:AliasListEntry', aliasListEntry_targetKeyId - String that contains the key identifier of the KMS key associated with the alias.

CustomKeyStoresListEntry

data CustomKeyStoresListEntry

Contains information about each custom key store in the custom key store list.

See: newCustomKeyStoresListEntry smart constructor.

Constructors

CustomKeyStoresListEntry' (Maybe Text) (Maybe ConnectionErrorCodeType) (Maybe ConnectionStateType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe CustomKeyStoreType) (Maybe Text) (Maybe XksProxyConfigurationType)

Instances

FromJSON CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

Methods

parseJSON :: Value -> Parser CustomKeyStoresListEntry

parseJSONList :: Value -> Parser [CustomKeyStoresListEntry]

Generic CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

Associated Types

type Rep CustomKeyStoresListEntry :: Type -> Type

Methods

from :: CustomKeyStoresListEntry -> Rep CustomKeyStoresListEntry x

to :: Rep CustomKeyStoresListEntry x -> CustomKeyStoresListEntry

Show CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

Methods

showsPrec :: Int -> CustomKeyStoresListEntry -> ShowS

show :: CustomKeyStoresListEntry -> String

showList :: [CustomKeyStoresListEntry] -> ShowS

NFData CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

Methods

rnf :: CustomKeyStoresListEntry -> ()

Eq CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

Methods

(==) :: CustomKeyStoresListEntry -> CustomKeyStoresListEntry -> Bool

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

Hashable CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

Methods

hashWithSalt :: Int -> CustomKeyStoresListEntry -> Int

hash :: CustomKeyStoresListEntry -> Int

type Rep CustomKeyStoresListEntry

Defined in Amazonka.KMS.Types.CustomKeyStoresListEntry

type Rep CustomKeyStoresListEntry = D1 ('MetaData "CustomKeyStoresListEntry" "Amazonka.KMS.Types.CustomKeyStoresListEntry" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "CustomKeyStoresListEntry'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudHsmClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectionErrorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionErrorCodeType))) :*: (S1 ('MetaSel ('Just "connectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionStateType)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customKeyStoreName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "customKeyStoreType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomKeyStoreType)) :*: (S1 ('MetaSel ('Just "trustAnchorCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "xksProxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyConfigurationType)))))))

newCustomKeyStoresListEntry :: CustomKeyStoresListEntry

Create a value of CustomKeyStoresListEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cloudHsmClusterId:CustomKeyStoresListEntry', customKeyStoresListEntry_cloudHsmClusterId - A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.

$sel:connectionErrorCode:CustomKeyStoresListEntry', customKeyStoresListEntry_connectionErrorCode - Describes the connection error. This field appears in the response only when the ConnectionState is FAILED.

Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.

All custom key stores:

• INTERNAL_ERROR — KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
• NETWORK_ERRORS — Network errors are preventing KMS from connecting the custom key store to its backing key store.

CloudHSM key stores:

• CLUSTER_NOT_FOUND — KMS cannot find the CloudHSM cluster with the specified cluster ID.
• INSUFFICIENT_CLOUDHSM_HSMS — The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
• INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET — At least one private subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in each of the associated private subnets, although two are preferable. For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
• INVALID_CREDENTIALS — The KeyStorePassword for the custom key store doesn't match the current password of the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the KeyStorePassword value for the custom key store.
• SUBNET_NOT_FOUND — A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
• USER_LOCKED_OUT — The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
• USER_LOGGED_IN — The kmsuser CU account is logged into the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
• USER_NOT_FOUND — KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.

External key stores:

• INVALID_CREDENTIALS — One or both of the XksProxyAuthenticationCredential values is not valid on the specified external key store proxy.
• XKS_PROXY_ACCESS_DENIED — KMS requests are denied access to the external key store proxy. If the external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on your behalf.
• XKS_PROXY_INVALID_CONFIGURATION — A configuration error is preventing the external key store from connecting to its proxy. Verify the value of the XksProxyUriPath.
• XKS_PROXY_INVALID_RESPONSE — KMS cannot interpret the response from the external key store proxy. If you see this connection error code repeatedly, notify your external key store proxy vendor.
• XKS_PROXY_INVALID_TLS_CONFIGURATION — KMS cannot connect to the external key store proxy because the TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and that it matches the hostname in the XksProxyUriEndpoint value, and that it is signed by a certificate authority included in the Trusted Certificate Authorities list.
• XKS_PROXY_NOT_REACHABLE — KMS can't communicate with your external key store proxy. Verify that the XksProxyUriEndpoint and XksProxyUriPath are correct. Use the tools for your external key store proxy to verify that the proxy is active and available on its network. Also, verify that your external key manager instances are operating properly. Connection attempts fail with this connection error code if the proxy reports that all external key manager instances are unavailable.
• XKS_PROXY_TIMED_OUT — KMS can connect to the external key store proxy, but the proxy does not respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key store proxy vendor.

• XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION — The Amazon VPC endpoint service configuration doesn't conform to the requirements for an KMS external key store.

  • The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.
  • It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.
  • The Allow principals list must include the KMS service principal for the Region, cks.kms.<region>.amazonaws.com, such as cks.kms.us-east-1.amazonaws.com.
  • It must not require acceptance of connection requests.
  • It must have a private DNS name. The private DNS name for an external key store with VPC_ENDPOINT_SERVICE connectivity must be unique in its Amazon Web Services Region.
  • The domain of the private DNS name must have a verification status of verified.
  • The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.
• XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND — KMS can't find the VPC endpoint service that it uses to communicate with the external key store proxy. Verify that the XksProxyVpcEndpointServiceName is correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.

$sel:connectionState:CustomKeyStoresListEntry', customKeyStoresListEntry_connectionState - Indicates whether the custom key store is connected to its backing key store. For an CloudHSM key store, the ConnectionState indicates whether it is connected to its CloudHSM cluster. For an external key store, the ConnectionState indicates whether it is connected to the external key store proxy that communicates with your external key manager.

You can create and use KMS keys in your custom key stores only when its ConnectionState is CONNECTED.

The ConnectionState value is DISCONNECTED only if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that the backing key store is reachable and active. For an CloudHSM key store, verify that its associated CloudHSM cluster is active and contains at least one active HSM. For an external key store, verify that the external key store proxy and external key manager are connected and enabled.

A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a custom key store in the Key Management Service Developer Guide.

$sel:creationDate:CustomKeyStoresListEntry', customKeyStoresListEntry_creationDate - The date and time when the custom key store was created.

$sel:customKeyStoreId:CustomKeyStoresListEntry', customKeyStoresListEntry_customKeyStoreId - A unique identifier for the custom key store.

$sel:customKeyStoreName:CustomKeyStoresListEntry', customKeyStoresListEntry_customKeyStoreName - The user-specified friendly name for the custom key store.

$sel:customKeyStoreType:CustomKeyStoresListEntry', customKeyStoresListEntry_customKeyStoreType - Indicates the type of the custom key store. AWS_CLOUDHSM indicates a custom key store backed by an CloudHSM cluster. EXTERNAL_KEY_STORE indicates a custom key store backed by an external key store proxy and external key manager outside of Amazon Web Services.

$sel:trustAnchorCertificate:CustomKeyStoresListEntry', customKeyStoresListEntry_trustAnchorCertificate - The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.

$sel:xksProxyConfiguration:CustomKeyStoresListEntry', customKeyStoresListEntry_xksProxyConfiguration - Configuration settings for the external key store proxy (XKS proxy). The external key store proxy translates KMS requests into a format that your external key manager can understand. The proxy configuration includes connection information that KMS requires.

This field appears only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

GrantConstraints

data GrantConstraints

Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.

KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.

In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.

However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.

To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext: in the /Key Management Service Developer Guide/ .

See: newGrantConstraints smart constructor.

Constructors

GrantConstraints' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text))

Instances

FromJSON GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

parseJSON :: Value -> Parser GrantConstraints

parseJSONList :: Value -> Parser [GrantConstraints]

ToJSON GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

toJSON :: GrantConstraints -> Value

toEncoding :: GrantConstraints -> Encoding

toJSONList :: [GrantConstraints] -> Value

toEncodingList :: [GrantConstraints] -> Encoding

Generic GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Associated Types

type Rep GrantConstraints :: Type -> Type

Methods

from :: GrantConstraints -> Rep GrantConstraints x

to :: Rep GrantConstraints x -> GrantConstraints

Read GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

readsPrec :: Int -> ReadS GrantConstraints

readList :: ReadS [GrantConstraints]

readPrec :: ReadPrec GrantConstraints

readListPrec :: ReadPrec [GrantConstraints]

Show GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

showsPrec :: Int -> GrantConstraints -> ShowS

show :: GrantConstraints -> String

showList :: [GrantConstraints] -> ShowS

NFData GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

rnf :: GrantConstraints -> ()

Eq GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

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

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

Hashable GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

Methods

hashWithSalt :: Int -> GrantConstraints -> Int

hash :: GrantConstraints -> Int

type Rep GrantConstraints

Defined in Amazonka.KMS.Types.GrantConstraints

type Rep GrantConstraints = D1 ('MetaData "GrantConstraints" "Amazonka.KMS.Types.GrantConstraints" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GrantConstraints'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryptionContextEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "encryptionContextSubset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))

newGrantConstraints :: GrantConstraints

Create a value of GrantConstraints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionContextEquals:GrantConstraints', grantConstraints_encryptionContextEquals - A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

$sel:encryptionContextSubset:GrantConstraints', grantConstraints_encryptionContextSubset - A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

GrantListEntry

data GrantListEntry

Contains information about a grant.

See: newGrantListEntry smart constructor.

Constructors

GrantListEntry' (Maybe GrantConstraints) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [GrantOperation]) (Maybe Text)

Instances

FromJSON GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Methods

parseJSON :: Value -> Parser GrantListEntry

parseJSONList :: Value -> Parser [GrantListEntry]

Generic GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Associated Types

type Rep GrantListEntry :: Type -> Type

Methods

from :: GrantListEntry -> Rep GrantListEntry x

to :: Rep GrantListEntry x -> GrantListEntry

Read GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Methods

readsPrec :: Int -> ReadS GrantListEntry

readList :: ReadS [GrantListEntry]

readPrec :: ReadPrec GrantListEntry

readListPrec :: ReadPrec [GrantListEntry]

Show GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Methods

showsPrec :: Int -> GrantListEntry -> ShowS

show :: GrantListEntry -> String

showList :: [GrantListEntry] -> ShowS

NFData GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Methods

rnf :: GrantListEntry -> ()

Eq GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Methods

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

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

Hashable GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

Methods

hashWithSalt :: Int -> GrantListEntry -> Int

hash :: GrantListEntry -> Int

type Rep GrantListEntry

Defined in Amazonka.KMS.Types.GrantListEntry

type Rep GrantListEntry = D1 ('MetaData "GrantListEntry" "Amazonka.KMS.Types.GrantListEntry" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GrantListEntry'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "constraints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrantConstraints)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "grantId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "granteePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "issuingAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GrantOperation])) :*: S1 ('MetaSel ('Just "retiringPrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newGrantListEntry :: GrantListEntry

Create a value of GrantListEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:constraints:GrantListEntry', grantListEntry_constraints - A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

$sel:creationDate:GrantListEntry', grantListEntry_creationDate - The date and time when the grant was created.

$sel:grantId:GrantListEntry', grantListEntry_grantId - The unique identifier for the grant.

$sel:granteePrincipal:GrantListEntry', grantListEntry_granteePrincipal - The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

$sel:issuingAccount:GrantListEntry', grantListEntry_issuingAccount - The Amazon Web Services account under which the grant was issued.

$sel:keyId:GrantListEntry', grantListEntry_keyId - The unique identifier for the KMS key to which the grant applies.

$sel:name:GrantListEntry', grantListEntry_name - 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.

$sel:operations:GrantListEntry', grantListEntry_operations - The list of operations permitted by the grant.

$sel:retiringPrincipal:GrantListEntry', grantListEntry_retiringPrincipal - The principal that can retire the grant.

KeyListEntry

data KeyListEntry

Contains information about each entry in the key list.

See: newKeyListEntry smart constructor.

Constructors

KeyListEntry' (Maybe Text) (Maybe Text)

Instances

FromJSON KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Methods

parseJSON :: Value -> Parser KeyListEntry

parseJSONList :: Value -> Parser [KeyListEntry]

Generic KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Associated Types

type Rep KeyListEntry :: Type -> Type

Methods

from :: KeyListEntry -> Rep KeyListEntry x

to :: Rep KeyListEntry x -> KeyListEntry

Read KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Methods

readsPrec :: Int -> ReadS KeyListEntry

readList :: ReadS [KeyListEntry]

readPrec :: ReadPrec KeyListEntry

readListPrec :: ReadPrec [KeyListEntry]

Show KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Methods

showsPrec :: Int -> KeyListEntry -> ShowS

show :: KeyListEntry -> String

showList :: [KeyListEntry] -> ShowS

NFData KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Methods

rnf :: KeyListEntry -> ()

Eq KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Methods

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

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

Hashable KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

Methods

hashWithSalt :: Int -> KeyListEntry -> Int

hash :: KeyListEntry -> Int

type Rep KeyListEntry

Defined in Amazonka.KMS.Types.KeyListEntry

type Rep KeyListEntry = D1 ('MetaData "KeyListEntry" "Amazonka.KMS.Types.KeyListEntry" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "KeyListEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newKeyListEntry :: KeyListEntry

Create a value of KeyListEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyArn:KeyListEntry', keyListEntry_keyArn - ARN of the key.

$sel:keyId:KeyListEntry', keyListEntry_keyId - Unique identifier of the key.

KeyMetadata

data KeyMetadata

Contains metadata about a KMS key.

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

See: newKeyMetadata smart constructor.

Constructors

KeyMetadata' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe CustomerMasterKeySpec) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe [EncryptionAlgorithmSpec]) (Maybe ExpirationModelType) (Maybe KeyManagerType) (Maybe KeySpec) (Maybe KeyState) (Maybe KeyUsageType) (Maybe [MacAlgorithmSpec]) (Maybe Bool) (Maybe MultiRegionConfiguration) (Maybe OriginType) (Maybe Natural) (Maybe [SigningAlgorithmSpec]) (Maybe POSIX) (Maybe XksKeyConfigurationType) Text

Instances

FromJSON KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Methods

parseJSON :: Value -> Parser KeyMetadata

parseJSONList :: Value -> Parser [KeyMetadata]

Generic KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Associated Types

type Rep KeyMetadata :: Type -> Type

Methods

from :: KeyMetadata -> Rep KeyMetadata x

to :: Rep KeyMetadata x -> KeyMetadata

Read KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Methods

readsPrec :: Int -> ReadS KeyMetadata

readList :: ReadS [KeyMetadata]

readPrec :: ReadPrec KeyMetadata

readListPrec :: ReadPrec [KeyMetadata]

Show KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Methods

showsPrec :: Int -> KeyMetadata -> ShowS

show :: KeyMetadata -> String

showList :: [KeyMetadata] -> ShowS

NFData KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Methods

rnf :: KeyMetadata -> ()

Eq KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Methods

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

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

Hashable KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

Methods

hashWithSalt :: Int -> KeyMetadata -> Int

hash :: KeyMetadata -> Int

type Rep KeyMetadata

Defined in Amazonka.KMS.Types.KeyMetadata

type Rep KeyMetadata = D1 ('MetaData "KeyMetadata" "Amazonka.KMS.Types.KeyMetadata" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "KeyMetadata'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "aWSAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cloudHsmClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customerMasterKeySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerMasterKeySpec))))) :*: ((S1 ('MetaSel ('Just "deletionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "encryptionAlgorithms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EncryptionAlgorithmSpec])) :*: (S1 ('MetaSel ('Just "expirationModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExpirationModelType)) :*: S1 ('MetaSel ('Just "keyManager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyManagerType)))))) :*: (((S1 ('MetaSel ('Just "keySpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeySpec)) :*: (S1 ('MetaSel ('Just "keyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyState)) :*: S1 ('MetaSel ('Just "keyUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyUsageType)))) :*: (S1 ('MetaSel ('Just "macAlgorithms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MacAlgorithmSpec])) :*: (S1 ('MetaSel ('Just "multiRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "multiRegionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiRegionConfiguration))))) :*: ((S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OriginType)) :*: (S1 ('MetaSel ('Just "pendingDeletionWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "signingAlgorithms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SigningAlgorithmSpec])))) :*: (S1 ('MetaSel ('Just "validTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "xksKeyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksKeyConfigurationType)) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newKeyMetadata

Arguments

:: Text

$sel:keyId:KeyMetadata'

-> KeyMetadata

Create a value of KeyMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aWSAccountId:KeyMetadata', keyMetadata_aWSAccountId - The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

$sel:arn:KeyMetadata', keyMetadata_arn - The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the /Amazon Web Services General Reference/.

$sel:cloudHsmClusterId:KeyMetadata', keyMetadata_cloudHsmClusterId - The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.

$sel:creationDate:KeyMetadata', keyMetadata_creationDate - The date and time when the KMS key was created.

$sel:customKeyStoreId:KeyMetadata', keyMetadata_customKeyStoreId - A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.

$sel:customerMasterKeySpec:KeyMetadata', keyMetadata_customerMasterKeySpec - Instead, use the KeySpec field.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

$sel:deletionDate:KeyMetadata', keyMetadata_deletionDate - The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

$sel:description:KeyMetadata', keyMetadata_description - The description of the KMS key.

$sel:enabled:KeyMetadata', keyMetadata_enabled - Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

$sel:encryptionAlgorithms:KeyMetadata', keyMetadata_encryptionAlgorithms - The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.

$sel:expirationModel:KeyMetadata', keyMetadata_expirationModel - Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

$sel:keyManager:KeyMetadata', keyMetadata_keyManager - The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.

$sel:keySpec:KeyMetadata', keyMetadata_keySpec - Describes the type of key material in the KMS key.

$sel:keyState:KeyMetadata', keyMetadata_keyState - The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

$sel:keyUsage:KeyMetadata', keyMetadata_keyUsage - The cryptographic operations for which you can use the KMS key.

$sel:macAlgorithms:KeyMetadata', keyMetadata_macAlgorithms - The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.

$sel:multiRegion:KeyMetadata', keyMetadata_multiRegion - Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

$sel:multiRegionConfiguration:KeyMetadata', keyMetadata_multiRegionConfiguration - Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

For more information about any listed KMS key, use the DescribeKey operation.

• MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.
• PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.
• ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

$sel:origin:KeyMetadata', keyMetadata_origin - The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

$sel:pendingDeletionWindowInDays:KeyMetadata', keyMetadata_pendingDeletionWindowInDays - The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

$sel:signingAlgorithms:KeyMetadata', keyMetadata_signingAlgorithms - The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.

$sel:validTo:KeyMetadata', keyMetadata_validTo - The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

$sel:xksKeyConfiguration:KeyMetadata', keyMetadata_xksKeyConfiguration - Information about the external key that is associated with a KMS key in an external key store.

For more information, see External key in the Key Management Service Developer Guide.

$sel:keyId:KeyMetadata', keyMetadata_keyId - The globally unique identifier for the KMS key.

ListGrantsResponse

data ListGrantsResponse

See: newListGrantsResponse smart constructor.

Constructors

ListGrantsResponse' (Maybe [GrantListEntry]) (Maybe Text) (Maybe Bool)

Instances

FromJSON ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

parseJSON :: Value -> Parser ListGrantsResponse

parseJSONList :: Value -> Parser [ListGrantsResponse]

Generic ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Associated Types

type Rep ListGrantsResponse :: Type -> Type

Methods

from :: ListGrantsResponse -> Rep ListGrantsResponse x

to :: Rep ListGrantsResponse x -> ListGrantsResponse

Read ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

readsPrec :: Int -> ReadS ListGrantsResponse

readList :: ReadS [ListGrantsResponse]

readPrec :: ReadPrec ListGrantsResponse

readListPrec :: ReadPrec [ListGrantsResponse]

Show ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

showsPrec :: Int -> ListGrantsResponse -> ShowS

show :: ListGrantsResponse -> String

showList :: [ListGrantsResponse] -> ShowS

NFData ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

rnf :: ListGrantsResponse -> ()

Eq ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

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

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

Hashable ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

Methods

hashWithSalt :: Int -> ListGrantsResponse -> Int

hash :: ListGrantsResponse -> Int

type Rep ListGrantsResponse

Defined in Amazonka.KMS.Types.ListGrantsResponse

type Rep ListGrantsResponse = D1 ('MetaData "ListGrantsResponse" "Amazonka.KMS.Types.ListGrantsResponse" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "ListGrantsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GrantListEntry])) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newListGrantsResponse :: ListGrantsResponse

Create a value of ListGrantsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:grants:ListGrantsResponse', listGrantsResponse_grants - A list of grants.

$sel:nextMarker:ListGrantsResponse', listGrantsResponse_nextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

$sel:truncated:ListGrantsResponse', listGrantsResponse_truncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

MultiRegionConfiguration

data MultiRegionConfiguration

Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.

For more information about any listed KMS key, use the DescribeKey operation.

See: newMultiRegionConfiguration smart constructor.

Constructors

MultiRegionConfiguration' (Maybe MultiRegionKeyType) (Maybe MultiRegionKey) (Maybe [MultiRegionKey])

Instances

FromJSON MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Methods

parseJSON :: Value -> Parser MultiRegionConfiguration

parseJSONList :: Value -> Parser [MultiRegionConfiguration]

Generic MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Associated Types

type Rep MultiRegionConfiguration :: Type -> Type

Methods

from :: MultiRegionConfiguration -> Rep MultiRegionConfiguration x

to :: Rep MultiRegionConfiguration x -> MultiRegionConfiguration

Read MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Methods

readsPrec :: Int -> ReadS MultiRegionConfiguration

readList :: ReadS [MultiRegionConfiguration]

readPrec :: ReadPrec MultiRegionConfiguration

readListPrec :: ReadPrec [MultiRegionConfiguration]

Show MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Methods

showsPrec :: Int -> MultiRegionConfiguration -> ShowS

show :: MultiRegionConfiguration -> String

showList :: [MultiRegionConfiguration] -> ShowS

NFData MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Methods

rnf :: MultiRegionConfiguration -> ()

Eq MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Methods

(==) :: MultiRegionConfiguration -> MultiRegionConfiguration -> Bool

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

Hashable MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

Methods

hashWithSalt :: Int -> MultiRegionConfiguration -> Int

hash :: MultiRegionConfiguration -> Int

type Rep MultiRegionConfiguration

Defined in Amazonka.KMS.Types.MultiRegionConfiguration

type Rep MultiRegionConfiguration = D1 ('MetaData "MultiRegionConfiguration" "Amazonka.KMS.Types.MultiRegionConfiguration" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "MultiRegionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "multiRegionKeyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiRegionKeyType)) :*: (S1 ('MetaSel ('Just "primaryKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiRegionKey)) :*: S1 ('MetaSel ('Just "replicaKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MultiRegionKey])))))

newMultiRegionConfiguration :: MultiRegionConfiguration

Create a value of MultiRegionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:multiRegionKeyType:MultiRegionConfiguration', multiRegionConfiguration_multiRegionKeyType - Indicates whether the KMS key is a PRIMARY or REPLICA key.

$sel:primaryKey:MultiRegionConfiguration', multiRegionConfiguration_primaryKey - Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

$sel:replicaKeys:MultiRegionConfiguration', multiRegionConfiguration_replicaKeys - displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

MultiRegionKey

data MultiRegionKey

Describes the primary or replica key in a multi-Region key.

See: newMultiRegionKey smart constructor.

Constructors

MultiRegionKey' (Maybe Text) (Maybe Text)

Instances

FromJSON MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Methods

parseJSON :: Value -> Parser MultiRegionKey

parseJSONList :: Value -> Parser [MultiRegionKey]

Generic MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Associated Types

type Rep MultiRegionKey :: Type -> Type

Methods

from :: MultiRegionKey -> Rep MultiRegionKey x

to :: Rep MultiRegionKey x -> MultiRegionKey

Read MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Methods

readsPrec :: Int -> ReadS MultiRegionKey

readList :: ReadS [MultiRegionKey]

readPrec :: ReadPrec MultiRegionKey

readListPrec :: ReadPrec [MultiRegionKey]

Show MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Methods

showsPrec :: Int -> MultiRegionKey -> ShowS

show :: MultiRegionKey -> String

showList :: [MultiRegionKey] -> ShowS

NFData MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Methods

rnf :: MultiRegionKey -> ()

Eq MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Methods

(==) :: MultiRegionKey -> MultiRegionKey -> Bool

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

Hashable MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

Methods

hashWithSalt :: Int -> MultiRegionKey -> Int

hash :: MultiRegionKey -> Int

type Rep MultiRegionKey

Defined in Amazonka.KMS.Types.MultiRegionKey

type Rep MultiRegionKey = D1 ('MetaData "MultiRegionKey" "Amazonka.KMS.Types.MultiRegionKey" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "MultiRegionKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMultiRegionKey :: MultiRegionKey

Create a value of MultiRegionKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:MultiRegionKey', multiRegionKey_arn - Displays the key ARN of a primary or replica key of a multi-Region key.

$sel:region:MultiRegionKey', multiRegionKey_region - Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

Tag

data Tag

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User Guide.

See: newTag smart constructor.

Constructors

Tag' Text Text

Instances

FromJSON Tag

Defined in Amazonka.KMS.Types.Tag

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

ToJSON Tag

Defined in Amazonka.KMS.Types.Tag

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

Generic Tag

Defined in Amazonka.KMS.Types.Tag

Associated Types

type Rep Tag :: Type -> Type

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

Read Tag

Defined in Amazonka.KMS.Types.Tag

Methods

readsPrec :: Int -> ReadS Tag

readList :: ReadS [Tag]

readPrec :: ReadPrec Tag

readListPrec :: ReadPrec [Tag]

Show Tag

Defined in Amazonka.KMS.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

NFData Tag

Defined in Amazonka.KMS.Types.Tag

Methods

rnf :: Tag -> ()

Eq Tag

Defined in Amazonka.KMS.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool

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

Hashable Tag

Defined in Amazonka.KMS.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int

hash :: Tag -> Int

type Rep Tag

Defined in Amazonka.KMS.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KMS.Types.Tag" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag

Arguments

:: Text

$sel:tagKey:Tag'

-> Text

$sel:tagValue:Tag'

-> Tag

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tagKey:Tag', tag_tagKey - The key of the tag.

$sel:tagValue:Tag', tag_tagValue - The value of the tag.

XksKeyConfigurationType

data XksKeyConfigurationType

Information about the external key that is associated with a KMS key in an external key store.

This element appears in a CreateKey or DescribeKey response only for a KMS key in an external key store.

The external key is a symmetric encryption key that is hosted by an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store in a cryptographic operation, the cryptographic operation is performed in the external key manager using the specified external key. For more information, see External key in the Key Management Service Developer Guide.

See: newXksKeyConfigurationType smart constructor.

Constructors

XksKeyConfigurationType' (Maybe Text)

Instances

FromJSON XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Methods

parseJSON :: Value -> Parser XksKeyConfigurationType

parseJSONList :: Value -> Parser [XksKeyConfigurationType]

Generic XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Associated Types

type Rep XksKeyConfigurationType :: Type -> Type

Methods

from :: XksKeyConfigurationType -> Rep XksKeyConfigurationType x

to :: Rep XksKeyConfigurationType x -> XksKeyConfigurationType

Read XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Methods

readsPrec :: Int -> ReadS XksKeyConfigurationType

readList :: ReadS [XksKeyConfigurationType]

readPrec :: ReadPrec XksKeyConfigurationType

readListPrec :: ReadPrec [XksKeyConfigurationType]

Show XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Methods

showsPrec :: Int -> XksKeyConfigurationType -> ShowS

show :: XksKeyConfigurationType -> String

showList :: [XksKeyConfigurationType] -> ShowS

NFData XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Methods

rnf :: XksKeyConfigurationType -> ()

Eq XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Methods

(==) :: XksKeyConfigurationType -> XksKeyConfigurationType -> Bool

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

Hashable XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

Methods

hashWithSalt :: Int -> XksKeyConfigurationType -> Int

hash :: XksKeyConfigurationType -> Int

type Rep XksKeyConfigurationType

Defined in Amazonka.KMS.Types.XksKeyConfigurationType

type Rep XksKeyConfigurationType = D1 ('MetaData "XksKeyConfigurationType" "Amazonka.KMS.Types.XksKeyConfigurationType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "XksKeyConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newXksKeyConfigurationType :: XksKeyConfigurationType

Create a value of XksKeyConfigurationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:XksKeyConfigurationType', xksKeyConfigurationType_id - The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

XksProxyAuthenticationCredentialType

data XksProxyAuthenticationCredentialType

KMS uses the authentication credential to sign requests that it sends to the external key store proxy (XKS proxy) on your behalf. You establish these credentials on your external key store proxy and report them to KMS.

The XksProxyAuthenticationCredential includes two required elements.

See: newXksProxyAuthenticationCredentialType smart constructor.

Constructors

XksProxyAuthenticationCredentialType' (Sensitive Text) (Sensitive Text)

Instances

ToJSON XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

Methods

toJSON :: XksProxyAuthenticationCredentialType -> Value

toEncoding :: XksProxyAuthenticationCredentialType -> Encoding

toJSONList :: [XksProxyAuthenticationCredentialType] -> Value

toEncodingList :: [XksProxyAuthenticationCredentialType] -> Encoding

Generic XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

Associated Types

type Rep XksProxyAuthenticationCredentialType :: Type -> Type

Methods

from :: XksProxyAuthenticationCredentialType -> Rep XksProxyAuthenticationCredentialType x

to :: Rep XksProxyAuthenticationCredentialType x -> XksProxyAuthenticationCredentialType

Show XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

Methods

showsPrec :: Int -> XksProxyAuthenticationCredentialType -> ShowS

show :: XksProxyAuthenticationCredentialType -> String

showList :: [XksProxyAuthenticationCredentialType] -> ShowS

NFData XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

Methods

rnf :: XksProxyAuthenticationCredentialType -> ()

Eq XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

Methods

(==) :: XksProxyAuthenticationCredentialType -> XksProxyAuthenticationCredentialType -> Bool

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

Hashable XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

Methods

hashWithSalt :: Int -> XksProxyAuthenticationCredentialType -> Int

hash :: XksProxyAuthenticationCredentialType -> Int

type Rep XksProxyAuthenticationCredentialType

Defined in Amazonka.KMS.Types.XksProxyAuthenticationCredentialType

type Rep XksProxyAuthenticationCredentialType = D1 ('MetaData "XksProxyAuthenticationCredentialType" "Amazonka.KMS.Types.XksProxyAuthenticationCredentialType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "XksProxyAuthenticationCredentialType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "rawSecretAccessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newXksProxyAuthenticationCredentialType

Arguments

:: Text

$sel:accessKeyId:XksProxyAuthenticationCredentialType'

-> Text

$sel:rawSecretAccessKey:XksProxyAuthenticationCredentialType'

-> XksProxyAuthenticationCredentialType

Create a value of XksProxyAuthenticationCredentialType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessKeyId:XksProxyAuthenticationCredentialType', xksProxyAuthenticationCredentialType_accessKeyId - A unique identifier for the raw secret access key.

$sel:rawSecretAccessKey:XksProxyAuthenticationCredentialType', xksProxyAuthenticationCredentialType_rawSecretAccessKey - A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and =.

XksProxyConfigurationType

data XksProxyConfigurationType

Detailed information about the external key store proxy (XKS proxy). Your external key store proxy translates KMS requests into a format that your external key manager can understand. These fields appear in a DescribeCustomKeyStores response only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

See: newXksProxyConfigurationType smart constructor.

Constructors

XksProxyConfigurationType' (Maybe (Sensitive Text)) (Maybe XksProxyConnectivityType) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

FromJSON XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

Methods

parseJSON :: Value -> Parser XksProxyConfigurationType

parseJSONList :: Value -> Parser [XksProxyConfigurationType]

Generic XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

Associated Types

type Rep XksProxyConfigurationType :: Type -> Type

Methods

from :: XksProxyConfigurationType -> Rep XksProxyConfigurationType x

to :: Rep XksProxyConfigurationType x -> XksProxyConfigurationType

Show XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

Methods

showsPrec :: Int -> XksProxyConfigurationType -> ShowS

show :: XksProxyConfigurationType -> String

showList :: [XksProxyConfigurationType] -> ShowS

NFData XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

Methods

rnf :: XksProxyConfigurationType -> ()

Eq XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

Methods

(==) :: XksProxyConfigurationType -> XksProxyConfigurationType -> Bool

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

Hashable XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

Methods

hashWithSalt :: Int -> XksProxyConfigurationType -> Int

hash :: XksProxyConfigurationType -> Int

type Rep XksProxyConfigurationType

Defined in Amazonka.KMS.Types.XksProxyConfigurationType

type Rep XksProxyConfigurationType = D1 ('MetaData "XksProxyConfigurationType" "Amazonka.KMS.Types.XksProxyConfigurationType" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "XksProxyConfigurationType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "connectivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XksProxyConnectivityType))) :*: (S1 ('MetaSel ('Just "uriEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "uriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcEndpointServiceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newXksProxyConfigurationType :: XksProxyConfigurationType

Create a value of XksProxyConfigurationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessKeyId:XksProxyConfigurationType', xksProxyConfigurationType_accessKeyId - The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

$sel:connectivity:XksProxyConfigurationType', xksProxyConfigurationType_connectivity - Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

$sel:uriEndpoint:XksProxyConfigurationType', xksProxyConfigurationType_uriEndpoint - The URI endpoint for the external key store proxy.

If the external key store proxy has a public endpoint, it is displayed here.

If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

$sel:uriPath:XksProxyConfigurationType', xksProxyConfigurationType_uriPath - The path to the external key store proxy APIs.

$sel:vpcEndpointServiceName:XksProxyConfigurationType', xksProxyConfigurationType_vpcEndpointServiceName - The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.