AWS SDK for PHP 3.x

Service ID: kms

Version: 2014-11-01

This page describes the parameters and results for the operations of the AWS Key Management Service (2014-11-01), and shows how to use the Aws\Kms\KmsClient object to call the described operations. This documentation is specific to the 2014-11-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelKeyDeletion ( array $params = [] )
Cancels the deletion of a KMS key.
ConnectCustomKeyStore ( array $params = [] )
Connects or reconnects a custom key store to its backing key store.
CreateAlias ( array $params = [] )
Creates a friendly name for a KMS key.
CreateCustomKeyStore ( array $params = [] )
Creates a custom key store backed by a key store that you own and manage.
CreateGrant ( array $params = [] )
Adds a grant to a KMS key.
CreateKey ( array $params = [] )
Creates a unique customer managed KMS key in your Amazon Web Services account and Region.
Decrypt ( array $params = [] )
Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key.
DeleteAlias ( array $params = [] )
Deletes the specified alias.
DeleteCustomKeyStore ( array $params = [] )
Deletes a custom key store.
DeleteImportedKeyMaterial ( array $params = [] )
Deletes key material that was previously imported.
DescribeCustomKeyStores ( array $params = [] )
Gets information about custom key stores in the account and Region.
DescribeKey ( array $params = [] )
Provides detailed information about a KMS key.
DisableKey ( array $params = [] )
Sets the state of a KMS key to disabled.
DisableKeyRotation ( array $params = [] )
Disables automatic rotation of the key material of the specified symmetric encryption KMS key.
DisconnectCustomKeyStore ( array $params = [] )
Disconnects the custom key store from its backing key store.
EnableKey ( array $params = [] )
Sets the key state of a KMS key to enabled.
EnableKeyRotation ( array $params = [] )
Enables automatic rotation of the key material of the specified symmetric encryption KMS key.
Encrypt ( array $params = [] )
Encrypts plaintext of up to 4,096 bytes using a KMS key.
GenerateDataKey ( array $params = [] )
Returns a unique symmetric data key for use outside of KMS.
GenerateDataKeyPair ( array $params = [] )
Returns a unique asymmetric data key pair for use outside of KMS.
GenerateDataKeyPairWithoutPlaintext ( array $params = [] )
Returns a unique asymmetric data key pair for use outside of KMS.
GenerateDataKeyWithoutPlaintext ( array $params = [] )
Returns a unique symmetric data key for use outside of KMS.
GenerateMac ( array $params = [] )
Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports.
GenerateRandom ( array $params = [] )
Returns a random byte string that is cryptographically secure.
GetKeyPolicy ( array $params = [] )
Gets a key policy attached to the specified KMS key.
GetKeyRotationStatus ( array $params = [] )
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.
GetParametersForImport ( array $params = [] )
Returns the public key and an import token you need to import or reimport key material for a KMS key.
GetPublicKey ( array $params = [] )
Returns the public key of an asymmetric KMS key.
ImportKeyMaterial ( array $params = [] )
Imports or reimports key material into an existing KMS key that was created without key material.
ListAliases ( array $params = [] )
Gets a list of aliases in the caller's Amazon Web Services account and region.
ListGrants ( array $params = [] )
Gets a list of all grants for the specified KMS key.
ListKeyPolicies ( array $params = [] )
Gets the names of the key policies that are attached to a KMS key.
ListKeys ( array $params = [] )
Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.
ListResourceTags ( array $params = [] )
Returns all tags on the specified KMS key.
ListRetirableGrants ( array $params = [] )
Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal.
PutKeyPolicy ( array $params = [] )
Attaches a key policy to the specified KMS key.
ReEncrypt ( array $params = [] )
Decrypts ciphertext and then reencrypts it entirely within KMS.
ReplicateKey ( array $params = [] )
Replicates a multi-Region key into the specified Region.
RetireGrant ( array $params = [] )
Deletes a grant.
RevokeGrant ( array $params = [] )
Deletes the specified grant.
ScheduleKeyDeletion ( array $params = [] )
Schedules the deletion of a KMS key.
Sign ( array $params = [] )
Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key.
TagResource ( array $params = [] )
Adds or edits tags on a customer managed key.
UntagResource ( array $params = [] )
Deletes tags from a customer managed key.
UpdateAlias ( array $params = [] )
Associates an existing KMS alias with a different KMS key.
UpdateCustomKeyStore ( array $params = [] )
Changes the properties of a custom key store.
UpdateKeyDescription ( array $params = [] )
Updates the description of a KMS key.
UpdatePrimaryRegion ( array $params = [] )
Changes the primary key of a multi-Region key.
Verify ( array $params = [] )
Verifies a digital signature that was generated by the Sign operation.
VerifyMac ( array $params = [] )
Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeCustomKeyStores
ListAliases
ListGrants
ListKeyPolicies
ListKeys
ListResourceTags
ListRetirableGrants

Operations

CancelKeyDeletion

$result = $client->cancelKeyDeletion([/* ... */]);
$promise = $client->cancelKeyDeletionAsync([/* ... */]);

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is Disabled. To enable the KMS key, use EnableKey.

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:CancelKeyDeletion (key policy)

Related operations: ScheduleKeyDeletion

Parameter Syntax

$result = $client->cancelKeyDeletion([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[
    'KeyId' => '<string>',
]

Result Details

Members

KeyId

Type: string

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

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To cancel deletion of a KMS key

The following example cancels deletion of the specified KMS key.

$result = $client->cancelKeyDeletion([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key whose deletion you canceled.
]

ConnectCustomKeyStore

$result = $client->connectCustomKeyStore([/* ... */]);
$promise = $client->connectCustomKeyStoreAsync([/* ... */]);

Connects or reconnects a custom key store to its backing key store. For an CloudHSM key store, ConnectCustomKeyStore connects the key store to its associated CloudHSM cluster. For an external key store, ConnectCustomKeyStore connects the key store to the external key store proxy that communicates with your external key manager.

The custom key store must be connected before you can create KMS keys in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key store at any time.

The connection process for a custom key store can take an extended amount of time to complete. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again.

CloudHSM key store

During the connection process for an CloudHSM key store, KMS finds the CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the CloudHSM client as the kmsuser CU, and rotates its password.

To connect an CloudHSM key store, its associated CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the kmsuser crypto user (CU) must not be logged into the cluster. This prevents KMS from using this account to log in.

If you are having trouble connecting or disconnecting a CloudHSM key store, see Troubleshooting an CloudHSM key store in the Key Management Service Developer Guide.

External key store

When you connect an external key store that uses public endpoint connectivity, KMS tests its ability to communicate with your external key manager by sending a request via the external key store proxy.

When you connect to an external key store that uses VPC endpoint service connectivity, KMS establishes the networking elements that it needs to communicate with your external key manager via the external key store proxy. This includes creating an interface endpoint to the VPC endpoint service and a private hosted zone for traffic between KMS and the VPC endpoint service.

To connect an external key store, KMS must be able to connect to the external key store proxy, the external key store proxy must be able to communicate with your external key manager, and the external key manager must be available for cryptographic operations.

If you are having trouble connecting or disconnecting an external key store, see Troubleshooting an external key store in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:ConnectCustomKeyStore (IAM policy)

Related operations

CreateCustomKeyStore
DeleteCustomKeyStore
DescribeCustomKeyStores
DisconnectCustomKeyStore
UpdateCustomKeyStore

Parameter Syntax

$result = $client->connectCustomKeyStore([
    'CustomKeyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CustomKeyStoreId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CloudHsmClusterNotActiveException:
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.
CustomKeyStoreInvalidStateException:
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.
CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
CloudHsmClusterInvalidConfigurationException:
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 .

Examples

Example 1: To connect a custom key store

This example connects an AWS KMS custom key store to its backing key store. For an AWS CloudHSM key store, it connects the key store to its AWS CloudHSM cluster. For an external key store, it connects the key store to the external key store proxy that communicates with your external key manager. This operation does not return any data. To verify that the custom key store is connected, use the DescribeCustomKeyStores operation.

$result = $client->connectCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the AWS KMS custom key store.
]);

Result syntax:

[
]

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Creates a friendly name for a KMS key.

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and GenerateDataKey. You can also change the KMS key that's associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't affect the underlying KMS key.

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.

The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the Key Management Service Developer Guide.

This operation does not return a response. To get the alias that you created, use the ListAliases operation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

Required permissions

kms:CreateAlias on the alias (IAM policy).
kms:CreateAlias on the KMS key (key policy).

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

DeleteAlias
ListAliases
UpdateAlias

Parameter Syntax

$result = $client->createAlias([
    'AliasName' => '<string>', // REQUIRED
    'TargetKeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

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

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

TargetKeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
AlreadyExistsException:
The request was rejected because it attempted to create a resource that already exists.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidAliasNameException:
The request was rejected because the specified alias name is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
KMSInvalidStateException:
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.

Examples

Example 1: To create an alias

The following example creates an alias for the specified KMS key.

$result = $client->createAlias([
    'AliasName' => 'alias/ExampleAlias', // The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.
    'TargetKeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

CreateCustomKeyStore

$result = $client->createCustomKeyStore([/* ... */]);
$promise = $client->createCustomKeyStoreAsync([/* ... */]);

Creates a custom key store backed by a key store that you own and manage. When you use a KMS key in a custom key store for a cryptographic operation, the cryptographic operation is actually performed in your key store using your keys. KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key store proxy and external key manager outside of Amazon Web Services.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

Before you create the custom key store, the required elements must be in place and operational. We recommend that you use the test tools that KMS provides to verify the configuration your external key store proxy. For details about the required elements and verification tests, see Assemble the prerequisites (for CloudHSM key stores) or Assemble the prerequisites (for external key stores) in the Key Management Service Developer Guide.

To create a custom key store, use the following parameters.

To create an CloudHSM key store, specify the CustomKeyStoreName, CloudHsmClusterId, KeyStorePassword, and TrustAnchorCertificate. The CustomKeyStoreType parameter is optional for CloudHSM key stores. If you include it, set it to the default value, AWS_CLOUDHSM. For help with failures, see Troubleshooting an CloudHSM key store in the Key Management Service Developer Guide.
To create an external key store, specify the CustomKeyStoreName and a CustomKeyStoreType of EXTERNAL_KEY_STORE. Also, specify values for XksProxyConnectivity, XksProxyAuthenticationCredential, XksProxyUriEndpoint, and XksProxyUriPath. If your XksProxyConnectivity value is VPC_ENDPOINT_SERVICE, specify the XksProxyVpcEndpointServiceName parameter. For help with failures, see Troubleshooting an external key store in the Key Management Service Developer Guide.

For external key stores:

Some external key managers provide a simpler method for creating an external key store. For details, see your external key manager documentation.

When creating an external key store in the KMS console, you can upload a JSON-based proxy configuration file with the desired values. You cannot use a proxy configuration with the CreateCustomKeyStore operation. However, you can use the values in the file to help you determine the correct values for the CreateCustomKeyStore parameters.

When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect a new CloudHSM key store to its CloudHSM cluster, or to connect a new external key store to the external key store proxy for your external key manager. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.

For help with failures, see Troubleshooting a custom key store in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:CreateCustomKeyStore (IAM policy).

Related operations:

ConnectCustomKeyStore
DeleteCustomKeyStore
DescribeCustomKeyStores
DisconnectCustomKeyStore
UpdateCustomKeyStore

Parameter Syntax

$result = $client->createCustomKeyStore([
    'CloudHsmClusterId' => '<string>',
    'CustomKeyStoreName' => '<string>', // REQUIRED
    'CustomKeyStoreType' => 'AWS_CLOUDHSM|EXTERNAL_KEY_STORE',
    'KeyStorePassword' => '<string>',
    'TrustAnchorCertificate' => '<string>',
    'XksProxyAuthenticationCredential' => [
        'AccessKeyId' => '<string>', // REQUIRED
        'RawSecretAccessKey' => '<string>', // REQUIRED
    ],
    'XksProxyConnectivity' => 'PUBLIC_ENDPOINT|VPC_ENDPOINT_SERVICE',
    'XksProxyUriEndpoint' => '<string>',
    'XksProxyUriPath' => '<string>',
    'XksProxyVpcEndpointServiceName' => '<string>',
]);

Parameter Details

Members

CloudHsmClusterId

Type: string

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.

CustomKeyStoreName

Required: Yes
Type: string

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

CustomKeyStoreType

Type: string

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.

KeyStorePassword

Type: string

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.

TrustAnchorCertificate

Type: string

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.

XksProxyAuthenticationCredential

Type: XksProxyAuthenticationCredentialType structure

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.

XksProxyConnectivity

Type: string

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.

XksProxyUriEndpoint

Type: string

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.

XksProxyUriPath

Type: string

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.

XksProxyVpcEndpointServiceName

Type: string

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.

Result Syntax

[
    'CustomKeyStoreId' => '<string>',
]

Result Details

Members

CustomKeyStoreId

Type: string

A unique identifier for the new custom key store.

Errors

CloudHsmClusterInUseException:
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.
CustomKeyStoreNameInUseException:
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.
CloudHsmClusterNotFoundException:
The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
CloudHsmClusterNotActiveException:
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.
IncorrectTrustAnchorException:
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.
CloudHsmClusterInvalidConfigurationException:
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 .
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
XksProxyUriInUseException:
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.
XksProxyUriEndpointInUseException:
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.
XksProxyUriUnreachableException:
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.
XksProxyIncorrectAuthenticationCredentialException:
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.
XksProxyVpcEndpointServiceInUseException:
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.
XksProxyVpcEndpointServiceNotFoundException:
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.
XksProxyVpcEndpointServiceInvalidConfigurationException:
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.
XksProxyInvalidResponseException:

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

Examples

Example 1: To create an AWS CloudHSM key store

This example creates a custom key store that is associated with an AWS CloudHSM cluster.

$result = $client->createCustomKeyStore([
    'CloudHsmClusterId' => 'cluster-234abcdefABC', // The ID of the CloudHSM cluster.
    'CustomKeyStoreName' => 'ExampleKeyStore', // A friendly name for the custom key store.
    'KeyStorePassword' => 'kmsPswd', // The password for the kmsuser CU account in the specified cluster.
    'TrustAnchorCertificate' => '', // The content of the customerCA.crt file that you created when you initialized the cluster.
]);

Result syntax:

[
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the new custom key store.
]

Example 2: To create an external key store with VPC endpoint service connectivity

This example creates an external key store that uses an Amazon VPC endpoint service to communicate with AWS KMS.

$result = $client->createCustomKeyStore([
    'CustomKeyStoreName' => 'ExampleVPCEndpointKeyStore', // A friendly name for the custom key store
    'CustomKeyStoreType' => 'EXTERNAL_KEY_STORE', // For external key stores, the value must be EXTERNAL_KEY_STORE
    'XksProxyAuthenticationCredential' => [
        'AccessKeyId' => 'ABCDE12345670EXAMPLE',
        'RawSecretAccessKey' => 'DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=',
    ], // The access key ID and secret access key that KMS uses to authenticate to your external key store proxy
    'XksProxyConnectivity' => 'VPC_ENDPOINT_SERVICE', // Indicates how AWS KMS communicates with the external key store proxy
    'XksProxyUriEndpoint' => 'https://myproxy-private.xks.example.com', // The URI that AWS KMS uses to connect to the external key store proxy
    'XksProxyUriPath' => '/example-prefix/kms/xks/v1', // The URI path to the external key store proxy APIs
    'XksProxyVpcEndpointServiceName' => 'com.amazonaws.vpce.us-east-1.vpce-svc-example1', // The VPC endpoint service that KMS uses to communicate with the external key store proxy
]);

Result syntax:

[
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the new custom key store.
]

Example 3: To create an external key store with public endpoint connectivity

This example creates an external key store with public endpoint connectivity.

$result = $client->createCustomKeyStore([
    'CustomKeyStoreName' => 'ExamplePublicEndpointKeyStore', // A friendly name for the custom key store
    'CustomKeyStoreType' => 'EXTERNAL_KEY_STORE', // For external key stores, the value must be EXTERNAL_KEY_STORE
    'XksProxyAuthenticationCredential' => [
        'AccessKeyId' => 'ABCDE12345670EXAMPLE',
        'RawSecretAccessKey' => 'DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=',
    ], // The access key ID and secret access key that KMS uses to authenticate to your external key store proxy
    'XksProxyConnectivity' => 'PUBLIC_ENDPOINT', // Indicates how AWS KMS communicates with the external key store proxy
    'XksProxyUriEndpoint' => 'https://myproxy.xks.example.com', // The URI that AWS KMS uses to connect to the external key store proxy
    'XksProxyUriPath' => '/kms/xks/v1', // The URI path to your external key store proxy API
]);

Result syntax:

[
    'CustomKeyStoreId' => 'cks-987654321abcdef0', // The ID of the new custom key store.
]

CreateGrant

$result = $client->createGrant([/* ... */]);
$promise = $client->createGrantAsync([/* ... */]);

Adds a grant to a KMS key.

A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for temporary permissions because you can create one, use its permissions, and delete it without changing your key policies or IAM policies.

For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants.

The CreateGrant operation returns a GrantToken and a GrantId.

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. Once the grant has achieved eventual consistency, the grantee principal can use the permissions in the grant without identifying the grant.

However, to use the permissions in the grant immediately, use the GrantToken that CreateGrant returns. For details, see Using a grant token in the Key Management Service Developer Guide .
The CreateGrant operation also returns a GrantId. You can use the GrantId and a key identifier to identify the grant in the RetireGrant and RevokeGrant operations. To find the grant ID, use the ListGrants or ListRetirableGrants operations.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:CreateGrant (key policy)

Related operations:

ListGrants
ListRetirableGrants
RetireGrant
RevokeGrant

Parameter Syntax

$result = $client->createGrant([
    'Constraints' => [
        'EncryptionContextEquals' => ['<string>', ...],
        'EncryptionContextSubset' => ['<string>', ...],
    ],
    'DryRun' => true || false,
    'GrantTokens' => ['<string>', ...],
    'GranteePrincipal' => '<string>', // REQUIRED
    'KeyId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'Operations' => ['<string>', ...], // REQUIRED
    'RetiringPrincipal' => '<string>',
]);

Parameter Details

Members

Constraints

Type: GrantConstraints structure

Specifies a grant constraint.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints, which allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in the constraint.

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. Operations with these keys don't support an encryption context.

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 .

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantTokens

Type: Array of strings

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.

GranteePrincipal

Required: Yes
Type: string

The identity that gets the permissions specified in the grant.

To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

KeyId

Required: Yes
Type: string

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.

Name

Type: string

A friendly name for the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

Operations

Required: Yes
Type: Array of strings

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.

RetiringPrincipal

Type: string

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 principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

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.

Result Syntax

[
    'GrantId' => '<string>',
    'GrantToken' => '<string>',
]

Result Details

Members

GrantId

Type: string

The unique identifier for the grant.

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

GrantToken

Type: string

The grant token.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To create a grant

The following example creates a grant that allows the specified IAM role to encrypt data with the specified KMS key.

$result = $client->createGrant([
    'GranteePrincipal' => 'arn:aws:iam::111122223333:role/ExampleRole', // The identity that is given permission to perform the operations specified in the grant.
    'KeyId' => 'arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'Operations' => [
        'Encrypt',
        'Decrypt',
    ], // A list of operations that the grant allows.
]);

Result syntax:

[
    'GrantId' => '0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60', // The unique identifier of the grant.
    'GrantToken' => 'AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA', // The grant token.
]

CreateKey

$result = $client->createKey([/* ... */]);
$promise = $client->createKeyAsync([/* ... */]);

Creates a unique customer managed KMS key in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources.

A KMS key is a logical representation of a cryptographic key. In addition to the key material used in cryptographic operations, a KMS key includes metadata, such as the key ID, key policy, creation date, description, and key state. For details, see Managing keys in the Key Management Service Developer Guide

Use the parameters of CreateKey to specify the type of KMS key, the source of its key material, its key policy, description, tags, and other properties.

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.

To create different types of KMS keys, use the following guidance:

Symmetric encryption KMS key

By default, CreateKey creates a symmetric encryption KMS key with key material that KMS generates. This is the basic and most widely used type of KMS key, and provides the best performance.

To create a symmetric encryption KMS key, you don't need to specify any parameters. The default value for KeySpec, SYMMETRIC_DEFAULT, the default value for KeyUsage, ENCRYPT_DECRYPT, and the default value for Origin, AWS_KMS, create a symmetric encryption KMS key with KMS key material.

If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.

Asymmetric KMS keys

To create an asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created.

Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA or SM2 key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

HMAC KMS key

To create an HMAC KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created.

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.

Multi-Region primary keys

Imported key material

To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion parameter with a value of True. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation.

You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store.

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.

To import your own key material into a KMS key, begin by creating a KMS key with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token. Use the wrapping public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide .

You can import key material into KMS keys of all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't import key material into a KMS key in a custom key store.

To create a multi-Region primary key with imported key material, use the Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material into multi-Region keys. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

Custom key store

A custom key store lets you protect your Amazon Web Services resources using keys in a backing key store that you own and manage. When you request a cryptographic operation with a KMS key in a custom key store, the operation is performed in the backing key store using its cryptographic keys.

KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store, KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you specify an existing encryption key in the external key manager.

Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.

Before you create a KMS key in a custom key store, the ConnectionState of the key store must be CONNECTED. To connect the custom key store, use the ConnectCustomKeyStore operation. To find the ConnectionState, use the DescribeCustomKeyStores operation.

To create a KMS key in a custom key store, use the CustomKeyStoreId. Use the default KeySpec value, SYMMETRIC_DEFAULT, and the default KeyUsage value, ENCRYPT_DECRYPT to create a symmetric encryption key. No other key type is supported in a custom key store.

To create a KMS key in an CloudHSM key store, use the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region.

To create a KMS key in an external key store, use the Origin parameter with a value of EXTERNAL_KEY_STORE and an XksKeyId parameter that identifies an existing external key.

Some external key managers provide a simpler method for creating a KMS key in an external key store. For details, see your external key manager documentation.

Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account.

Required permissions: kms:CreateKey (IAM policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide.

Related operations:

DescribeKey
ListKeys
ScheduleKeyDeletion

Parameter Syntax

$result = $client->createKey([
    'BypassPolicyLockoutSafetyCheck' => true || false,
    'CustomKeyStoreId' => '<string>',
    'CustomerMasterKeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
    'Description' => '<string>',
    'KeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
    'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT|GENERATE_VERIFY_MAC',
    'MultiRegion' => true || false,
    'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM|EXTERNAL_KEY_STORE',
    'Policy' => '<string>',
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'XksKeyId' => '<string>',
]);

Parameter Details

Members

BypassPolicyLockoutSafetyCheck

Type: boolean

Skips ("bypasses") the key policy lockout safety check. The default value is false.

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, see Default key policy 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.

CustomKeyStoreId

Type: string

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.

CustomerMasterKeySpec

Type: string

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.

Description

Type: string

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).

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

KeySpec

Type: string

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

KeyUsage

Type: string

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.

MultiRegion

Type: boolean

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

Origin

Type: string

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.

Policy

Type: string

The key policy to attach to the KMS key.

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

The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
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, 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 .

Tags

Type: Array of Tag structures

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

XksKeyId

Type: string

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.

Result Syntax

[
    'KeyMetadata' => [
        'AWSAccountId' => '<string>',
        'Arn' => '<string>',
        'CloudHsmClusterId' => '<string>',
        'CreationDate' => <DateTime>,
        'CustomKeyStoreId' => '<string>',
        'CustomerMasterKeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'EncryptionAlgorithms' => ['<string>', ...],
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
        'KeyState' => 'Creating|Enabled|Disabled|PendingDeletion|PendingImport|PendingReplicaDeletion|Unavailable|Updating',
        'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT|GENERATE_VERIFY_MAC',
        'MacAlgorithms' => ['<string>', ...],
        'MultiRegion' => true || false,
        'MultiRegionConfiguration' => [
            'MultiRegionKeyType' => 'PRIMARY|REPLICA',
            'PrimaryKey' => [
                'Arn' => '<string>',
                'Region' => '<string>',
            ],
            'ReplicaKeys' => [
                [
                    'Arn' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
        ],
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM|EXTERNAL_KEY_STORE',
        'PendingDeletionWindowInDays' => <integer>,
        'SigningAlgorithms' => ['<string>', ...],
        'ValidTo' => <DateTime>,
        'XksKeyConfiguration' => [
            'Id' => '<string>',
        ],
    ],
]

Result Details

Members

KeyMetadata

Type: KeyMetadata structure

Metadata associated with the KMS key.

Errors

MalformedPolicyDocumentException:
The request was rejected because the specified policy is not syntactically or semantically correct.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
TagException:
The request was rejected because one or more tags are not valid.
CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
CustomKeyStoreInvalidStateException:
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.
CloudHsmClusterInvalidConfigurationException:
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 .
XksKeyInvalidConfigurationException:
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.
XksKeyAlreadyInUseException:
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.
XksKeyNotFoundException:
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.

Examples

Example 1: To create a KMS key

The following example creates a symmetric KMS key for encryption and decryption. No parameters are required for this operation.

$result = $client->createKey([
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
    ], // Detailed information about the KMS key that this operation creates.
]

Example 2: To create an asymmetric RSA KMS key for encryption and decryption

This example creates a KMS key that contains an asymmetric RSA key pair for encryption and decryption. The key spec and key usage can't be changed after the key is created.

$result = $client->createKey([
    'KeySpec' => 'RSA_4096', // Describes the type of key material in the KMS key.
    'KeyUsage' => 'ENCRYPT_DECRYPT', // The cryptographic operations for which you can use the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'RSA_4096',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'RSAES_OAEP_SHA_1',
            'RSAES_OAEP_SHA_256',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'RSA_4096',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
    ], // Detailed information about the KMS key that this operation creates.
]

Example 3: To create an asymmetric elliptic curve KMS key for signing and verification

This example creates a KMS key that contains an asymmetric elliptic curve (ECC) key pair for signing and verification. The key usage is required even though "SIGN_VERIFY" is the only valid value for ECC KMS keys. The key spec and key usage can't be changed after the key is created.

$result = $client->createKey([
    'KeySpec' => 'ECC_NIST_P521', // Describes the type of key material in the KMS key.
    'KeyUsage' => 'SIGN_VERIFY', // The cryptographic operations for which you can use the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'ECC_NIST_P521',
        'Description' => '',
        'Enabled' => 1,
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'ECC_NIST_P521',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'SIGN_VERIFY',
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
        'SigningAlgorithms' => [
            'ECDSA_SHA_512',
        ],
    ], // Detailed information about the KMS key that this operation creates.
]

Example 4: To create an HMAC KMS key

This example creates a 384-bit symmetric HMAC KMS key. The GENERATE_VERIFY_MAC key usage value is required even though it's the only valid value for HMAC KMS keys. The key spec and key usage can't be changed after the key is created.

$result = $client->createKey([
    'KeySpec' => 'HMAC_384', // Describes the type of key material in the KMS key.
    'KeyUsage' => 'GENERATE_VERIFY_MAC', // The cryptographic operations for which you can use the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'HMAC_384',
        'Description' => '',
        'Enabled' => 1,
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'HMAC_384',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'GENERATE_VERIFY_MAC',
        'MacAlgorithms' => [
            'HMAC_SHA_384',
        ],
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
    ], // Detailed information about the KMS key that this operation creates.
]

Example 5: To create a multi-Region primary KMS key

This example creates a multi-Region primary symmetric encryption key. Because the default values for all parameters create a symmetric encryption key, only the MultiRegion parameter is required for this KMS key.

$result = $client->createKey([
    'MultiRegion' => 1, // Indicates whether the KMS key is a multi-Region (True) or regional (False) key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => 'mrk-1234abcd12ab34cd56ef12345678990ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => 1,
        'MultiRegionConfiguration' => [
            'MultiRegionKeyType' => 'PRIMARY',
            'PrimaryKey' => [
                'Arn' => 'arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab',
                'Region' => 'us-west-2',
            ],
            'ReplicaKeys' => [
            ],
        ],
        'Origin' => 'AWS_KMS',
    ], // Detailed information about the KMS key that this operation creates.
]

Example 6: To create a KMS key for imported key material

This example creates a symmetric KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL.

$result = $client->createKey([
    'Origin' => 'EXTERNAL', // The source of the key material for the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => ,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'PendingImport',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'EXTERNAL',
    ], // Detailed information about the KMS key that this operation creates.
]

Example 7: To create a KMS key in an AWS CloudHSM key store

This example creates a KMS key in the specified AWS CloudHSM key store. The operation creates the KMS key and its metadata in AWS KMS and creates the key material in the AWS CloudHSM cluster associated with the custom key store. This example requires the CustomKeyStoreId and Origin parameters.

$result = $client->createKey([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // Identifies the custom key store that hosts the KMS key.
    'Origin' => 'AWS_CLOUDHSM', // Indicates the source of the key material for the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CloudHsmClusterId' => 'cluster-234abcdefABC',
        'CreationDate' => ,
        'CustomKeyStoreId' => 'cks-1234567890abcdef0',
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'AWS_CLOUDHSM',
    ], // Detailed information about the KMS key that this operation creates.
]

Example 8: To create a KMS key in an external key store

This example creates a KMS key in the specified external key store. It uses the XksKeyId parameter to associate the KMS key with an existing symmetric encryption key in your external key manager. This CustomKeyStoreId, Origin, and XksKeyId parameters are required in this operation.

$result = $client->createKey([
    'CustomKeyStoreId' => 'cks-9876543210fedcba9', // Identifies the custom key store that hosts the KMS key.
    'Origin' => 'EXTERNAL_KEY_STORE', // Indicates the source of the key material for the KMS key.
    'XksKeyId' => 'bb8562717f809024', // Identifies the encryption key in your external key manager that is associated with the KMS key
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321',
        'CreationDate' => ,
        'CustomKeyStoreId' => 'cks-9876543210fedcba9',
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '0987dcba-09fe-87dc-65ba-ab0987654321',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'EXTERNAL_KEY_STORE',
        'XksKeyConfiguration' => [
            'Id' => 'bb8562717f809024',
        ],
    ], // Detailed information about the KMS key that this operation creates.
]

Decrypt

$result = $client->decrypt([/* ... */]);
$promise = $client->decryptAsync([/* ... */]);

Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:

Encrypt
GenerateDataKey
GenerateDataKeyPair
GenerateDataKeyWithoutPlaintext
GenerateDataKeyPairWithoutPlaintext

You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.

If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend.

Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using &IAM; policies. Otherwise, you might create an &IAM; policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.

Decrypt also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call Decrypt for a Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the attestation document for the enclave. Instead of the plaintext data, the response includes the plaintext data encrypted with the public key from the attestation document (CiphertextForRecipient).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. If you use the KeyId parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias ARN of the KMS key.

Required permissions: kms:Decrypt (key policy)

Related operations:

Encrypt
GenerateDataKey
GenerateDataKeyPair
ReEncrypt

Parameter Syntax

$result = $client->decrypt([
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'DryRun' => true || false,
    'EncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'EncryptionContext' => ['<string>', ...],
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>',
    'Recipient' => [
        'AttestationDocument' => <string || resource || Psr\Http\Message\StreamInterface>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ],
]);

Parameter Details

Members

CiphertextBlob

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Ciphertext to be decrypted. The blob includes metadata.

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

EncryptionAlgorithm

Type: string

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.

EncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

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.

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Type: string

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.

Recipient

Type: RecipientInfo structure

A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Result Syntax

[
    'CiphertextForRecipient' => <string || resource || Psr\Http\Message\StreamInterface>,
    'EncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'KeyId' => '<string>',
    'Plaintext' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

CiphertextForRecipient

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The plaintext data encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

EncryptionAlgorithm

Type: string

The encryption algorithm that was used to decrypt the ciphertext.

KeyId

Type: string

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

Plaintext

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
InvalidCiphertextException:
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.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
IncorrectKeyException:
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.
InvalidKeyUsageException:
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.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To decrypt data with a symmetric encryption KMS key

The following example decrypts data that was encrypted with a symmetric encryption KMS key. The KeyId is not required when decrypting with a symmetric encryption key, but it is a best practice.

$result = $client->decrypt([
    'CiphertextBlob' => <BLOB>, // The encrypted data (ciphertext).
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // A key identifier for the KMS key to use to decrypt the data.
]);

Result syntax:

[
    'EncryptionAlgorithm' => 'SYMMETRIC_DEFAULT', // The encryption algorithm that was used to decrypt the ciphertext. SYMMETRIC_DEFAULT is the only valid value for symmetric encryption in AWS KMS.
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The Amazon Resource Name (ARN) of the KMS key that was used to decrypt the data.
    'Plaintext' => <BLOB>, // The decrypted (plaintext) data.
]

Example 2: To decrypt data with an asymmetric encryption KMS key

The following example decrypts data that was encrypted with an asymmetric encryption KMS key. When the KMS encryption key is asymmetric, you must specify the KMS key ID and the encryption algorithm that was used to encrypt the data.

$result = $client->decrypt([
    'CiphertextBlob' => <BLOB>, // The encrypted data (ciphertext).
    'EncryptionAlgorithm' => 'RSAES_OAEP_SHA_256', // The encryption algorithm that was used to encrypt the data. This parameter is required to decrypt with an asymmetric KMS key.
    'KeyId' => '0987dcba-09fe-87dc-65ba-ab0987654321', // A key identifier for the KMS key to use to decrypt the data. This parameter is required to decrypt with an asymmetric KMS key.
]);

Result syntax:

[
    'EncryptionAlgorithm' => 'RSAES_OAEP_SHA_256', // The encryption algorithm that was used to decrypt the ciphertext.
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The Amazon Resource Name (ARN) of the KMS key that was used to decrypt the data.
    'Plaintext' => <BLOB>, // The decrypted (plaintext) data.
]

Example 3: To decrypt data for a Nitro enclave

The following Decrypt example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning the decrypted data in plaintext (Plaintext), the operation returns the decrypted data encrypted by the public key from the attestation document (CiphertextForRecipient).

$result = $client->decrypt([
    'CiphertextBlob' => <BLOB>, // The encrypted data. This ciphertext was encrypted with the KMS key
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The KMS key to use to decrypt the ciphertext
    'Recipient' => [
        'AttestationDocument' => <BLOB>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ], // Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
]);

Result syntax:

[
    'CiphertextForRecipient' => <BLOB>, // The decrypted CiphertextBlob encrypted with the public key from the attestation document
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The KMS key that was used to decrypt the encrypted data (CiphertextBlob)
    'Plaintext' => <BLOB>, // This field is null or empty
]

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

Deletes the specified alias.

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

Required permissions

kms:DeleteAlias on the alias (IAM policy).
kms:DeleteAlias on the KMS key (key policy).

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

CreateAlias
ListAliases
UpdateAlias

Parameter Syntax

$result = $client->deleteAlias([
    'AliasName' => '<string>', // REQUIRED
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To delete an alias

The following example deletes the specified alias.

$result = $client->deleteAlias([
    'AliasName' => 'alias/ExampleAlias', // The alias to delete.
]);

DeleteCustomKeyStore

$result = $client->deleteCustomKeyStore([/* ... */]);
$promise = $client->deleteCustomKeyStoreAsync([/* ... */]);

Deletes a custom key store. This operation does not affect any backing elements of the custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key store, or affect any users or keys in the cluster. For an external key store, it does not affect the external key store proxy, external key manager, or any external keys.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

The custom key store that you delete cannot contain any KMS keys. Before deleting the key store, verify that you will never need to use any of the KMS keys in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the KMS keys from the key store. After the required waiting period expires and all KMS keys are deleted from the custom key store, use DisconnectCustomKeyStore to disconnect the key store from KMS. Then, you can delete the custom key store.

For keys in an CloudHSM key store, the ScheduleKeyDeletion operation makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. KMS never creates, manages, or deletes cryptographic keys in the external key manager associated with an external key store. You must manage them using your external key manager tools.

Instead of deleting the custom key store, consider using the DisconnectCustomKeyStore operation to disconnect the custom key store from its backing key store. While the key store is disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to delete KMS keys and you can reconnect a disconnected custom key store at any time.

If the operation succeeds, it returns a JSON object with no properties.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:DeleteCustomKeyStore (IAM policy)

Related operations:

ConnectCustomKeyStore
CreateCustomKeyStore
DescribeCustomKeyStores
DisconnectCustomKeyStore
UpdateCustomKeyStore

Parameter Syntax

$result = $client->deleteCustomKeyStore([
    'CustomKeyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CustomKeyStoreId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CustomKeyStoreHasCMKsException:
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:
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.
CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.

Examples

Example 1: To delete a custom key store from AWS KMS

This example deletes a custom key store from AWS KMS. This operation does not affect the backing key store, such as a CloudHSM cluster, external key store proxy, or your external key manager. This operation doesn't return any data. To verify that the operation was successful, use the DescribeCustomKeyStores operation.

$result = $client->deleteCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the custom key store to be deleted.
]);

Result syntax:

[
]

DeleteImportedKeyMaterial

$result = $client->deleteImportedKeyMaterial([/* ... */]);
$promise = $client->deleteImportedKeyMaterialAsync([/* ... */]);

Deletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.

When the specified KMS key is in the PendingDeletion state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:DeleteImportedKeyMaterial (key policy)

Related operations:

GetParametersForImport
ImportKeyMaterial

Parameter Syntax

$result = $client->deleteImportedKeyMaterial([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To delete imported key material

The following example deletes the imported key material from the specified KMS key.

$result = $client->deleteImportedKeyMaterial([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

DescribeCustomKeyStores

$result = $client->describeCustomKeyStores([/* ... */]);
$promise = $client->describeCustomKeyStoresAsync([/* ... */]);

Gets information about custom key stores in the account and Region.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

By default, this operation returns information about all custom key stores in the account and Region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both).

To determine whether the custom key store is connected to its CloudHSM cluster or external key store proxy, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you used the DisconnectCustomKeyStore operation to disconnect it. Otherwise, the connection state is CONNECTED. If your custom key store connection state is CONNECTED but you are having trouble using it, verify that the backing store is active and available. For an CloudHSM key store, verify that the associated CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any. For an external key store, verify that the external key store proxy and its associated external key manager are reachable and enabled.

For help repairing your CloudHSM key store, see the Troubleshooting CloudHSM key stores. For help repairing your external key store, see the Troubleshooting external key stores. Both topics are in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:DescribeCustomKeyStores (IAM policy)

Related operations:

ConnectCustomKeyStore
CreateCustomKeyStore
DeleteCustomKeyStore
DisconnectCustomKeyStore
UpdateCustomKeyStore

Parameter Syntax

$result = $client->describeCustomKeyStores([
    'CustomKeyStoreId' => '<string>',
    'CustomKeyStoreName' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Members

CustomKeyStoreId

Type: string

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.

CustomKeyStoreName

Type: string

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

Limit

Type: int

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.

Marker

Type: string

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.

Result Syntax

[
    'CustomKeyStores' => [
        [
            'CloudHsmClusterId' => '<string>',
            'ConnectionErrorCode' => 'INVALID_CREDENTIALS|CLUSTER_NOT_FOUND|NETWORK_ERRORS|INTERNAL_ERROR|INSUFFICIENT_CLOUDHSM_HSMS|USER_LOCKED_OUT|USER_NOT_FOUND|USER_LOGGED_IN|SUBNET_NOT_FOUND|INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET|XKS_PROXY_ACCESS_DENIED|XKS_PROXY_NOT_REACHABLE|XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND|XKS_PROXY_INVALID_RESPONSE|XKS_PROXY_INVALID_CONFIGURATION|XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION|XKS_PROXY_TIMED_OUT|XKS_PROXY_INVALID_TLS_CONFIGURATION',
            'ConnectionState' => 'CONNECTED|CONNECTING|FAILED|DISCONNECTED|DISCONNECTING',
            'CreationDate' => <DateTime>,
            'CustomKeyStoreId' => '<string>',
            'CustomKeyStoreName' => '<string>',
            'CustomKeyStoreType' => 'AWS_CLOUDHSM|EXTERNAL_KEY_STORE',
            'TrustAnchorCertificate' => '<string>',
            'XksProxyConfiguration' => [
                'AccessKeyId' => '<string>',
                'Connectivity' => 'PUBLIC_ENDPOINT|VPC_ENDPOINT_SERVICE',
                'UriEndpoint' => '<string>',
                'UriPath' => '<string>',
                'VpcEndpointServiceName' => '<string>',
            ],
        ],
        // ...
    ],
    'NextMarker' => '<string>',
    'Truncated' => true || false,
]

Result Details

Members

CustomKeyStores

Type: Array of CustomKeyStoresListEntry structures

Contains metadata about each custom key store.

NextMarker

Type: string

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

Truncated

Type: boolean

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.

Errors

CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
InvalidMarkerException:
The request was rejected because the marker that specifies where pagination should next begin is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.

Examples

Example 1: To get detailed information about custom key stores in the account and Region

This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID.

$result = $client->describeCustomKeyStores([
]);

Result syntax:

[
    'CustomKeyStores' => [
    ], // Details about each custom key store in the account and Region.
]

Example 2: To get detailed information about an AWS CloudHSM key store by specifying its friendly name

This example gets detailed information about a particular AWS CloudHSM key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID.

$result = $client->describeCustomKeyStores([
    'CustomKeyStoreName' => 'ExampleKeyStore', // The friendly name of the custom key store.
]);

Result syntax:

[
    'CustomKeyStores' => [
        [
            'CloudHsmClusterId' => 'cluster-234abcdefABC',
            'ConnectionState' => 'CONNECTED',
            'CreationDate' => ,
            'CustomKeyStoreId' => 'cks-1234567890abcdef0',
            'CustomKeyStoreName' => 'ExampleKeyStore',
            'CustomKeyStoreType' => 'AWS_CLOUDHSM',
            'TrustAnchorCertificate' => '',
        ],
    ], // Detailed information about the specified custom key store.
]

Example 3: To get detailed information about an external key store by specifying its ID

This example gets detailed information about an external key store by specifying its ID. The example external key store proxy uses public endpoint connectivity.

$result = $client->describeCustomKeyStores([
    'CustomKeyStoreId' => 'cks-9876543210fedcba9', // The ID of the custom key store.
]);

Result syntax:

[
    'CustomKeyStores' => [
        [
            'ConnectionState' => 'CONNECTED',
            'CreationDate' => ,
            'CustomKeyStoreId' => 'cks-9876543210fedcba9',
            'CustomKeyStoreName' => 'ExampleExternalKeyStore',
            'CustomKeyStoreType' => 'EXTERNAL_KEY_STORE',
            'XksProxyConfiguration' => [
                'AccessKeyId' => 'ABCDE12345670EXAMPLE',
                'Connectivity' => 'PUBLIC_ENDPOINT',
                'UriEndpoint' => 'https://myproxy.xks.example.com',
                'UriPath' => '/kms/xks/v1',
            ],
        ],
    ], // Detailed information about the specified custom key store.
]

Example 4: To get detailed information about an external key store VPC endpoint connectivity by specifying its friendly name

This example gets detailed information about a particular external key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. The proxy URI path for this external key store includes an optional prefix. Also, because this example external key store uses VPC endpoint connectivity, the response includes the associated VPC endpoint service name.

$result = $client->describeCustomKeyStores([
    'CustomKeyStoreName' => 'VPCExternalKeystore',
]);

Result syntax:

[
    'CustomKeyStores' => [
        [
            'ConnectionState' => 'CONNECTED',
            'CreationDate' => ,
            'CustomKeyStoreId' => 'cks-876543210fedcba98',
            'CustomKeyStoreName' => 'ExampleVPCExternalKeyStore',
            'CustomKeyStoreType' => 'EXTERNAL_KEY_STORE',
            'XksProxyConfiguration' => [
                'AccessKeyId' => 'ABCDE12345670EXAMPLE',
                'Connectivity' => 'VPC_ENDPOINT_SERVICE',
                'UriEndpoint' => 'https://myproxy-private.xks.example.com',
                'UriPath' => '/example-prefix/kms/xks/v1',
                'VpcEndpointServiceName' => 'com.amazonaws.vpce.us-east-1.vpce-svc-example1',
            ],
        ],
    ], // Detailed information about the specified custom key store.
]

DescribeKey

$result = $client->describeKey([/* ... */]);
$promise = $client->describeKeyAsync([/* ... */]);

Provides detailed information about a KMS key. You can run DescribeKey on a customer managed key or an Amazon Web Services managed key.

This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. It includes fields, like KeySpec, that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports.

For multi-Region keys, DescribeKey displays the primary key and all related replica keys. For KMS keys in CloudHSM key stores, it includes information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in external key stores, it includes the custom key store ID and the ID of the external key.

DescribeKey does not return the following information:

Aliases associated with the KMS key. To get this information, use ListAliases.
Whether automatic key rotation is enabled on the KMS key. To get this information, use GetKeyRotationStatus. Also, some key states prevent a KMS key from being automatically rotated. For details, see How Automatic Key Rotation Works in the Key Management Service Developer Guide.
Tags on the KMS key. To get this information, use ListResourceTags.
Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants.

In general, DescribeKey is a non-mutating operation. It returns data about KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to create Amazon Web Services managed keys from a predefined Amazon Web Services alias with no key ID.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:DescribeKey (key policy)

Related operations:

GetKeyPolicy
GetKeyRotationStatus
ListAliases
ListGrants
ListKeys
ListResourceTags
ListRetirableGrants

Parameter Syntax

$result = $client->describeKey([
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

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.

Result Syntax

[
    'KeyMetadata' => [
        'AWSAccountId' => '<string>',
        'Arn' => '<string>',
        'CloudHsmClusterId' => '<string>',
        'CreationDate' => <DateTime>,
        'CustomKeyStoreId' => '<string>',
        'CustomerMasterKeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'EncryptionAlgorithms' => ['<string>', ...],
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
        'KeyState' => 'Creating|Enabled|Disabled|PendingDeletion|PendingImport|PendingReplicaDeletion|Unavailable|Updating',
        'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT|GENERATE_VERIFY_MAC',
        'MacAlgorithms' => ['<string>', ...],
        'MultiRegion' => true || false,
        'MultiRegionConfiguration' => [
            'MultiRegionKeyType' => 'PRIMARY|REPLICA',
            'PrimaryKey' => [
                'Arn' => '<string>',
                'Region' => '<string>',
            ],
            'ReplicaKeys' => [
                [
                    'Arn' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
        ],
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM|EXTERNAL_KEY_STORE',
        'PendingDeletionWindowInDays' => <integer>,
        'SigningAlgorithms' => ['<string>', ...],
        'ValidTo' => <DateTime>,
        'XksKeyConfiguration' => [
            'Id' => '<string>',
        ],
    ],
]

Result Details

Members

KeyMetadata

Type: KeyMetadata structure

Metadata associated with the key.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.

Examples

Example 1: To get details about a KMS key

The following example gets metadata for a symmetric encryption KMS key.

$result = $client->describeKey([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
    ], // An object that contains information about the specified KMS key.
]

Example 2: To get details about an RSA asymmetric KMS key

The following example gets metadata for an asymmetric RSA KMS key used for signing and verification.

$result = $client->describeKey([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'RSA_2048',
        'Description' => '',
        'Enabled' => ,
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'RSA_2048',
        'KeyState' => 'Disabled',
        'KeyUsage' => 'SIGN_VERIFY',
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
        'SigningAlgorithms' => [
            'RSASSA_PKCS1_V1_5_SHA_256',
            'RSASSA_PKCS1_V1_5_SHA_384',
            'RSASSA_PKCS1_V1_5_SHA_512',
            'RSASSA_PSS_SHA_256',
            'RSASSA_PSS_SHA_384',
            'RSASSA_PSS_SHA_512',
        ],
    ], // An object that contains information about the specified KMS key.
]

Example 3: To get details about a multi-Region key

The following example gets metadata for a multi-Region replica key. This multi-Region key is a symmetric encryption key. DescribeKey returns information about the primary key and all of its replicas.

$result = $client->describeKey([
    'KeyId' => 'arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab', // An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => 'mrk-1234abcd12ab34cd56ef1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => 1,
        'MultiRegionConfiguration' => [
            'MultiRegionKeyType' => 'PRIMARY',
            'PrimaryKey' => [
                'Arn' => 'arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
                'Region' => 'us-west-2',
            ],
            'ReplicaKeys' => [
                [
                    'Arn' => 'arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
                    'Region' => 'eu-west-1',
                ],
                [
                    'Arn' => 'arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
                    'Region' => 'ap-northeast-1',
                ],
                [
                    'Arn' => 'arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
                    'Region' => 'sa-east-1',
                ],
            ],
        ],
        'Origin' => 'AWS_KMS',
    ], // An object that contains information about the specified KMS key.
]

Example 4: To get details about an HMAC KMS key

The following example gets the metadata of an HMAC KMS key.

$result = $client->describeKey([
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '123456789012',
        'Arn' => 'arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'HMAC_256',
        'Description' => 'Development test key',
        'Enabled' => 1,
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'GENERATE_VERIFY_MAC',
        'MacAlgorithms' => [
            'HMAC_SHA_256',
        ],
        'MultiRegion' => ,
        'Origin' => 'AWS_KMS',
    ], // An object that contains information about the specified KMS key.
]

Example 5: To get details about a KMS key in an AWS CloudHSM key store

The following example gets the metadata of a KMS key in an AWS CloudHSM key store.

$result = $client->describeKey([
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '123456789012',
        'Arn' => 'arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CloudHsmClusterId' => 'cluster-234abcdefABC',
        'CreationDate' => ,
        'CustomKeyStoreId' => 'cks-1234567890abcdef0',
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => 'CloudHSM key store test key',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'AWS_CLOUDHSM',
    ], // An object that contains information about the specified KMS key.
]

Example 6: To get details about a KMS key in an external key store

The following example gets the metadata of a KMS key in an external key store.

$result = $client->describeKey([
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
]);

Result syntax:

[
    'KeyMetadata' => [
        'AWSAccountId' => '123456789012',
        'Arn' => 'arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab',
        'CreationDate' => ,
        'CustomKeyStoreId' => 'cks-1234567890abcdef0',
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => 'External key store test key',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeySpec' => 'SYMMETRIC_DEFAULT',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => ,
        'Origin' => 'EXTERNAL_KEY_STORE',
        'XksKeyConfiguration' => [
            'Id' => 'bb8562717f809024',
        ],
    ], // An object that contains information about the specified KMS key.
]

DisableKey

$result = $client->disableKey([/* ... */]);
$promise = $client->disableKeyAsync([/* ... */]);

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for cryptographic operations.

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 .

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:DisableKey (key policy)

Related operations: EnableKey

Parameter Syntax

$result = $client->disableKey([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To disable a KMS key

The following example disables the specified KMS key.

$result = $client->disableKey([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to disable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

DisableKeyRotation

$result = $client->disableKeyRotation([/* ... */]);
$promise = $client->disableKeyRotationAsync([/* ... */]);

Disables automatic rotation of the key material of the specified symmetric encryption KMS key.

Automatic key rotation is supported only on symmetric encryption KMS keys. 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.

You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies.

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:DisableKeyRotation (key policy)

Related operations:

EnableKeyRotation
GetKeyRotationStatus

Parameter Syntax

$result = $client->disableKeyRotation([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Examples

Example 1: To disable automatic rotation of key material

The following example disables automatic annual rotation of the key material for the specified KMS key.

$result = $client->disableKeyRotation([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

DisconnectCustomKeyStore

$result = $client->disconnectCustomKeyStore([/* ... */]);
$promise = $client->disconnectCustomKeyStoreAsync([/* ... */]);

Disconnects the custom key store from its backing key store. This operation disconnects an CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from the external key store proxy that communicates with your external key manager.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

While a custom key store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use its KMS keys. You can reconnect the custom key store at any time.

While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.

When you disconnect a custom key store, its ConnectionState changes to Disconnected. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

If the operation succeeds, it returns a JSON object with no properties.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

Related operations:

ConnectCustomKeyStore
CreateCustomKeyStore
DeleteCustomKeyStore
DescribeCustomKeyStores
UpdateCustomKeyStore

Parameter Syntax

$result = $client->disconnectCustomKeyStore([
    'CustomKeyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CustomKeyStoreId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CustomKeyStoreInvalidStateException:
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.
CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.

Examples

Example 1: To disconnect a custom key store from its CloudHSM cluster

This example disconnects an AWS KMS custom key store from its backing key store. For an AWS CloudHSM key store, it disconnects the key store from its AWS CloudHSM cluster. For an external key store, it disconnects the key store from the external key store proxy that communicates with your external key manager. This operation doesn't return any data. To verify that the custom key store is disconnected, use the DescribeCustomKeyStores operation.

$result = $client->disconnectCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the custom key store.
]);

Result syntax:

[
]

EnableKey

$result = $client->enableKey([/* ... */]);
$promise = $client->enableKeyAsync([/* ... */]);

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:EnableKey (key policy)

Related operations: DisableKey

Parameter Syntax

$result = $client->enableKey([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
KMSInvalidStateException:
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.

Examples

Example 1: To enable a KMS key

The following example enables the specified KMS key.

$result = $client->enableKey([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to enable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

EnableKeyRotation

$result = $client->enableKeyRotation([/* ... */]);
$promise = $client->enableKeyRotationAsync([/* ... */]);

Enables automatic rotation of the key material of the specified symmetric encryption KMS key.

When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation.

You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies.

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days).

New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter.

Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:EnableKeyRotation (key policy)

Related operations:

DisableKeyRotation
GetKeyRotationStatus

Parameter Syntax

$result = $client->enableKeyRotation([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Examples

Example 1: To enable automatic rotation of key material

The following example enables automatic annual rotation of the key material for the specified KMS key.

$result = $client->enableKeyRotation([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Encrypt

$result = $client->encrypt([/* ... */]);
$promise = $client->encryptAsync([/* ... */]);

Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.

You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.

If you use a symmetric encryption KMS key, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The algorithm must be compatible with the KMS key spec.

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

The maximum size of the data that you can encrypt varies with the type of KMS key and the encryption algorithm that you choose.

Symmetric encryption KMS keys
- SYMMETRIC_DEFAULT: 4096 bytes
RSA_2048
- RSAES_OAEP_SHA_1: 214 bytes
- RSAES_OAEP_SHA_256: 190 bytes
RSA_3072
- RSAES_OAEP_SHA_1: 342 bytes
- RSAES_OAEP_SHA_256: 318 bytes
RSA_4096
- RSAES_OAEP_SHA_1: 470 bytes
- RSAES_OAEP_SHA_256: 446 bytes
SM2PKE: 1024 bytes (China Regions only)

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:Encrypt (key policy)

Related operations:

Decrypt
GenerateDataKey
GenerateDataKeyPair

Parameter Syntax

$result = $client->encrypt([
    'DryRun' => true || false,
    'EncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'EncryptionContext' => ['<string>', ...],
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'Plaintext' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

EncryptionAlgorithm

Type: string

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.

EncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

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.

Plaintext

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Data to be encrypted.

Result Syntax

[
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'EncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'KeyId' => '<string>',
]

Result Details

Members

CiphertextBlob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

EncryptionAlgorithm

Type: string

The encryption algorithm that was used to encrypt the plaintext.

KeyId

Type: string

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

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To encrypt data with a symmetric encryption KMS key

The following example encrypts data with the specified symmetric encryption KMS key.

$result = $client->encrypt([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
    'Plaintext' => <BLOB>, // The data to encrypt.
]);

Result syntax:

[
    'CiphertextBlob' => <BLOB>, // The encrypted data (ciphertext).
    'EncryptionAlgorithm' => 'SYMMETRIC_DEFAULT', // The encryption algorithm that was used in the operation. For symmetric encryption keys, the encryption algorithm is always SYMMETRIC_DEFAULT.
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that was used to encrypt the data.
]

Example 2: To encrypt data with an asymmetric encryption KMS key

The following example encrypts data with the specified RSA asymmetric KMS key. When you encrypt with an asymmetric key, you must specify the encryption algorithm.

$result = $client->encrypt([
    'EncryptionAlgorithm' => 'RSAES_OAEP_SHA_256', // The encryption algorithm to use in the operation.
    'KeyId' => '0987dcba-09fe-87dc-65ba-ab0987654321', // The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
    'Plaintext' => <BLOB>, // The data to encrypt.
]);

Result syntax:

[
    'CiphertextBlob' => <BLOB>, // The encrypted data (ciphertext).
    'EncryptionAlgorithm' => 'RSAES_OAEP_SHA_256', // The encryption algorithm that was used in the operation.
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The ARN of the KMS key that was used to encrypt the data.
]

GenerateDataKey

$result = $client->generateDataKey([/* ... */]);
$promise = $client->generateDataKeyAsync([/* ... */]);

Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.

To generate a data key, specify the symmetric encryption KMS key that will be used to encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the type of your KMS key, use the DescribeKey operation.

You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.

To generate a 128-bit SM4 data key (China Regions only), specify a KeySpec value of AES_128 or a NumberOfBytes value of 16. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.

You can use an optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the Key Management Service Developer Guide.

GenerateDataKey also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKey for an Amazon Web Services Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the attestation document for the enclave. GenerateDataKey returns a copy of the data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the data key, the response includes a copy of the data key encrypted under the public key from the attestation document (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

How to use your data key

We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.

To encrypt data outside of KMS:

Use the GenerateDataKey operation to get a data key.
Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.

To decrypt data outside of KMS:

Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext data key from memory.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GenerateDataKey (key policy)

Related operations:

Decrypt
Encrypt
GenerateDataKeyPair
GenerateDataKeyPairWithoutPlaintext
GenerateDataKeyWithoutPlaintext

Parameter Syntax

$result = $client->generateDataKey([
    'DryRun' => true || false,
    'EncryptionContext' => ['<string>', ...],
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'KeySpec' => 'AES_256|AES_128',
    'NumberOfBytes' => <integer>,
    'Recipient' => [
        'AttestationDocument' => <string || resource || Psr\Http\Message\StreamInterface>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ],
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

EncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

Specifies the encryption context that will be used when encrypting the data key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

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.

KeySpec

Type: string

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.

NumberOfBytes

Type: int

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.

Recipient

Type: RecipientInfo structure

A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains a copy of the data key encrypted under the KMS key specified by the KeyId parameter. The Plaintext field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Result Syntax

[
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'CiphertextForRecipient' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KeyId' => '<string>',
    'Plaintext' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

CiphertextBlob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

CiphertextForRecipient

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

KeyId

Type: string

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

Plaintext

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To generate a data key

The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified KMS key.

$result = $client->generateDataKey([
    'KeyId' => 'alias/ExampleAlias', // The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
    'KeySpec' => 'AES_256', // Specifies the type of data key to return.
]);

Result syntax:

[
    'CiphertextBlob' => <BLOB>, // The encrypted data key.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that was used to encrypt the data key.
    'Plaintext' => <BLOB>, // The unencrypted (plaintext) data key.
]

Example 2: To generate a data key pair for a Nitro enclave

The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a copy of the data key encrypted by the KMS key and a plaintext copy of the data key, GenerateDataKey returns one copy of the data key encrypted by the KMS key (CiphertextBlob) and one copy of the data key encrypted by the public key from the attestation document (CiphertextForRecipient). The operation doesn't return a plaintext data key.

$result = $client->generateDataKey([
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // Identifies the KMS key used to encrypt the encrypted data key (CiphertextBlob)
    'KeySpec' => 'AES_256', // Specifies the type of data key to return
    'Recipient' => [
        'AttestationDocument' => <BLOB>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ], // Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
]);

Result syntax:

[
    'CiphertextBlob' => <BLOB>, // The data key encrypted by the specified KMS key
    'CiphertextForRecipient' => <BLOB>, // The plaintext data key encrypted by the public key from the attestation document
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The KMS key used to encrypt the CiphertextBlob (encrypted data key)
    'Plaintext' => <BLOB>, // This field is null or empty
]

GenerateDataKeyPair

$result = $client->generateDataKeyPair([/* ... */]);
$promise = $client->generateDataKeyPairAsync([/* ... */]);

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the private key.

You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt the private key in a data key pair. You cannot use 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.

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.

If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.

GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

GenerateDataKeyPair also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateDataKeyPair for an Amazon Web Services Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the attestation document for the enclave. GenerateDataKeyPair returns the public data key and a copy of the private data key encrypted under the specified KMS key, as usual. But instead of a plaintext copy of the private data key (PrivateKeyPlaintext), the response includes a copy of the private data key encrypted under the public key from the attestation document (CiphertextForRecipient). For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide..

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GenerateDataKeyPair (key policy)

Related operations:

Decrypt
Encrypt
GenerateDataKey
GenerateDataKeyPairWithoutPlaintext
GenerateDataKeyWithoutPlaintext

Parameter Syntax

$result = $client->generateDataKeyPair([
    'DryRun' => true || false,
    'EncryptionContext' => ['<string>', ...],
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'KeyPairSpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SM2', // REQUIRED
    'Recipient' => [
        'AttestationDocument' => <string || resource || Psr\Http\Message\StreamInterface>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ],
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

EncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

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.

KeyPairSpec

Required: Yes
Type: string

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.

Recipient

Type: RecipientInfo structure

A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

When you use this parameter, instead of returning a plaintext copy of the private data key, KMS encrypts the plaintext private data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains a copy of the private data key encrypted under the KMS key specified by the KeyId parameter. The PrivateKeyPlaintext field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Result Syntax

[
    'CiphertextForRecipient' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KeyId' => '<string>',
    'KeyPairSpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SM2',
    'PrivateKeyCiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'PrivateKeyPlaintext' => <string || resource || Psr\Http\Message\StreamInterface>,
    'PublicKey' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

CiphertextForRecipient

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

KeyId

Type: string

The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

KeyPairSpec

Type: string

The type of data key pair that was generated.

PrivateKeyCiphertextBlob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

PrivateKeyPlaintext

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext field is null or empty.

PublicKey

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To generate an RSA key pair for encryption and decryption

This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify.

$result = $client->generateDataKeyPair([
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
    'KeyPairSpec' => 'RSA_3072', // The requested key spec of the RSA data key pair.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the symmetric encryption KMS key that was used to encrypt the private key.
    'KeyPairSpec' => 'RSA_3072', // The actual key spec of the RSA data key pair.
    'PrivateKeyCiphertextBlob' => <BLOB>, // The encrypted private key of the RSA data key pair.
    'PrivateKeyPlaintext' => <BLOB>, // The plaintext private key of the RSA data key pair.
    'PublicKey' => <BLOB>, // The public key (plaintext) of the RSA data key pair.
]

Example 2: To generate a data key pair for a Nitro enclave

The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext copy of the private data key, GenerateDataKeyPair returns a copy of the private data key encrypted by the public key from the attestation document (CiphertextForRecipient). It returns the public data key (PublicKey) and a copy of private data key encrypted under the specified KMS key (PrivateKeyCiphertextBlob), as usual, but plaintext private data key field (PrivateKeyPlaintext) is null or empty.

$result = $client->generateDataKeyPair([
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
    'KeyPairSpec' => 'RSA_3072', // The requested key spec of the RSA data key pair.
    'Recipient' => [
        'AttestationDocument' => <BLOB>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ], // Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document.
]);

Result syntax:

[
    'CiphertextForRecipient' => <BLOB>, // The private key of the RSA data key pair encrypted by the public key from the attestation document
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the symmetric encryption KMS key that was used to encrypt the PrivateKeyCiphertextBlob.
    'KeyPairSpec' => 'RSA_3072', // The actual key spec of the RSA data key pair.
    'PrivateKeyCiphertextBlob' => <BLOB>, // The private key of the RSA data key pair encrypted by the KMS key.
    'PrivateKeyPlaintext' => <BLOB>, // This field is null or empty
    'PublicKey' => <BLOB>, // The public key (plaintext) of the RSA data key pair.
]

GenerateDataKeyPairWithoutPlaintext

$result = $client->generateDataKeyPairWithoutPlaintext([/* ... */]);
$promise = $client->generateDataKeyPairWithoutPlaintextAsync([/* ... */]);

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key.

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)

Related operations:

Decrypt
Encrypt
GenerateDataKey
GenerateDataKeyPair
GenerateDataKeyWithoutPlaintext

Parameter Syntax

$result = $client->generateDataKeyPairWithoutPlaintext([
    'DryRun' => true || false,
    'EncryptionContext' => ['<string>', ...],
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'KeyPairSpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SM2', // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

EncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

KeyPairSpec

Required: Yes
Type: string

Determines the type of data key pair that is generated.

Result Syntax

[
    'KeyId' => '<string>',
    'KeyPairSpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SM2',
    'PrivateKeyCiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'PublicKey' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

KeyId

Type: string

The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

KeyPairSpec

Type: string

The type of data key pair that was generated.

PrivateKeyCiphertextBlob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

PublicKey

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To generate an asymmetric data key pair without a plaintext key

This example returns an asymmetric elliptic curve (ECC) data key pair. The private key is encrypted under the symmetric encryption KMS key that you specify. This operation doesn't return a plaintext (unencrypted) private key.

$result = $client->generateDataKeyPairWithoutPlaintext([
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The symmetric encryption KMS key that encrypts the private key of the ECC data key pair.
    'KeyPairSpec' => 'ECC_NIST_P521', // The requested key spec of the ECC asymmetric data key pair.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the symmetric encryption KMS key that encrypted the private key in the ECC asymmetric data key pair.
    'KeyPairSpec' => 'ECC_NIST_P521', // The actual key spec of the ECC asymmetric data key pair.
    'PrivateKeyCiphertextBlob' => <BLOB>, // The encrypted private key of the asymmetric ECC data key pair.
    'PublicKey' => <BLOB>, // The public key (plaintext).
]

GenerateDataKeyWithoutPlaintext

$result = $client->generateDataKeyWithoutPlaintext([/* ... */]);
$promise = $client->generateDataKeyWithoutPlaintextAsync([/* ... */]);

Returns a unique symmetric data key for use outside of KMS. This operation returns a data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the key are random; they are not related to the caller or to the KMS key.

GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the data key.

This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.

It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.

To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

To generate a data key, you must specify the symmetric encryption KMS key that is used to encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the type of your KMS key, use the DescribeKey operation.

You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.

To generate an SM4 data key (China Regions only), specify a KeySpec value of AES_128 or NumberOfBytes value of 16. The symmetric encryption key used in China Regions to encrypt your data key is an SM4 encryption key.

If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

Related operations:

Decrypt
Encrypt
GenerateDataKey
GenerateDataKeyPair
GenerateDataKeyPairWithoutPlaintext

Parameter Syntax

$result = $client->generateDataKeyWithoutPlaintext([
    'DryRun' => true || false,
    'EncryptionContext' => ['<string>', ...],
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'KeySpec' => 'AES_256|AES_128',
    'NumberOfBytes' => <integer>,
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

EncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

Specifies the encryption context that will be used when encrypting the data key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

KeySpec

Type: string

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.

NumberOfBytes

Type: int

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.

Result Syntax

[
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KeyId' => '<string>',
]

Result Details

Members

CiphertextBlob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

KeyId

Type: string

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To generate an encrypted data key

The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified KMS key.

$result = $client->generateDataKeyWithoutPlaintext([
    'KeyId' => 'alias/ExampleAlias', // The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
    'KeySpec' => 'AES_256', // Specifies the type of data key to return.
]);

Result syntax:

[
    'CiphertextBlob' => <BLOB>, // The encrypted data key.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that was used to encrypt the data key.
]

GenerateMac

$result = $client->generateMac([/* ... */]);
$promise = $client->generateMacAsync([/* ... */]);

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.

You can use value that GenerateMac returns in the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. You can also use the raw result to implement HMAC-based algorithms such as key derivation functions. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide .

Best practices recommend that you limit the time during which any signing mechanism, including an HMAC, is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the token or message to help you detect when its time to refresh the HMAC.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GenerateMac (key policy)

Related operations: VerifyMac

Parameter Syntax

$result = $client->generateMac([
    'DryRun' => true || false,
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'MacAlgorithm' => 'HMAC_SHA_224|HMAC_SHA_256|HMAC_SHA_384|HMAC_SHA_512', // REQUIRED
    'Message' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

MacAlgorithm

Required: Yes
Type: string

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.

Message

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

Result Syntax

[
    'KeyId' => '<string>',
    'Mac' => <string || resource || Psr\Http\Message\StreamInterface>,
    'MacAlgorithm' => 'HMAC_SHA_224|HMAC_SHA_256|HMAC_SHA_384|HMAC_SHA_512',
]

Result Details

Members

KeyId

Type: string

The HMAC KMS key used in the operation.

Mac

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

MacAlgorithm

Type: string

The MAC algorithm that was used to generate the HMAC.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To generate an HMAC for a message

This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by the specified HMAC KMS key.

$result = $client->generateMac([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The HMAC KMS key input to the HMAC algorithm.
    'MacAlgorithm' => 'HMAC_SHA_384', // The HMAC algorithm requested for the operation.
    'Message' => <BLOB>, // The message input to the HMAC algorithm.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the HMAC KMS key used in the operation.
    'Mac' => <BLOB>, // The HMAC tag that results from this operation.
    'MacAlgorithm' => 'HMAC_SHA_384', // The HMAC algorithm used in the operation.
]

GenerateRandom

$result = $client->generateRandom([/* ... */]);
$promise = $client->generateRandomAsync([/* ... */]);

Returns a random byte string that is cryptographically secure.

You must use the NumberOfBytes parameter to specify the length of the random byte string. There is no default value for string length.

By default, the random byte string is generated in KMS. To generate the byte string in the CloudHSM cluster associated with an CloudHSM key store, use the CustomKeyStoreId parameter.

GenerateRandom also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in Amazon EC2. To call GenerateRandom for a Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK. Use the Recipient parameter to provide the attestation document for the enclave. Instead of plaintext bytes, the response includes the plaintext bytes encrypted under the public key from the attestation document (CiphertextForRecipient).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

For more information about entropy and random number generation, see Key Management Service Cryptographic Details.

Cross-account use: Not applicable. GenerateRandom does not use any account-specific resources, such as KMS keys.

Required permissions: kms:GenerateRandom (IAM policy)

Parameter Syntax

$result = $client->generateRandom([
    'CustomKeyStoreId' => '<string>',
    'NumberOfBytes' => <integer>,
    'Recipient' => [
        'AttestationDocument' => <string || resource || Psr\Http\Message\StreamInterface>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ],
]);

Parameter Details

Members

CustomKeyStoreId

Type: string

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.

NumberOfBytes

Type: int

The length of the random byte string. This parameter is required.

Recipient

Type: RecipientInfo structure

A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Result Syntax

[
    'CiphertextForRecipient' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Plaintext' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

CiphertextForRecipient

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The plaintext random bytes encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

Plaintext

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
CustomKeyStoreInvalidStateException:
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.

Examples

Example 1: To generate random data

The following example generates 32 bytes of random data.

$result = $client->generateRandom([
    'NumberOfBytes' => 32, // The length of the random data, specified in number of bytes.
]);

Result syntax:

[
    'Plaintext' => <BLOB>, // The random data.
]

Example 2: To generate random data

The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext (unencrypted) byte string, GenerateRandom returns the byte string encrypted by the public key from the enclave's attestation document.

$result = $client->generateRandom([
    'NumberOfBytes' => 1024, // The length of the random byte string
    'Recipient' => [
        'AttestationDocument' => <BLOB>,
        'KeyEncryptionAlgorithm' => 'RSAES_OAEP_SHA_256',
    ], // Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
]);

Result syntax:

[
    'CiphertextForRecipient' => <BLOB>, // The random data encrypted under the public key from the attestation document
    'Plaintext' => <BLOB>, // This field is null or empty
]

GetKeyPolicy

$result = $client->getKeyPolicy([/* ... */]);
$promise = $client->getKeyPolicyAsync([/* ... */]);

Gets a key policy attached to the specified KMS key.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:GetKeyPolicy (key policy)

Related operations: PutKeyPolicy

Parameter Syntax

$result = $client->getKeyPolicy([
    'KeyId' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

PolicyName

Required: Yes
Type: string

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members

Policy

Type: string

A key policy document in JSON format.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To retrieve a key policy

The following example retrieves the key policy for the specified KMS key.

$result = $client->getKeyPolicy([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'PolicyName' => 'default', // The name of the key policy to retrieve.
]);

Result syntax:

[
    'Policy' => '{ "Version" : "2012-10-17", "Id" : "key-default-1", "Statement" : [ { "Sid" : "Enable IAM User Permissions", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::111122223333:root" }, "Action" : "kms:*", "Resource" : "*" } ]}', // The key policy document.
]

GetKeyRotationStatus

$result = $client->getKeyRotationStatus([/* ... */]);
$promise = $client->getKeyRotationStatusAsync([/* ... */]);

Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.

When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.

You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:GetKeyRotationStatus (key policy)

Related operations:

DisableKeyRotation
EnableKeyRotation

Parameter Syntax

$result = $client->getKeyRotationStatus([
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Result Syntax

[
    'KeyRotationEnabled' => true || false,
]

Result Details

Members

KeyRotationEnabled

Type: boolean

A Boolean value that specifies whether key rotation is enabled.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Examples

Example 1: To retrieve the rotation status for a KMS key

The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key.

$result = $client->getKeyRotationStatus([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Result syntax:

[
    'KeyRotationEnabled' => 1, // A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not.
]

GetParametersForImport

$result = $client->getParametersForImport([/* ... */]);
$promise = $client->getParametersForImportAsync([/* ... */]);

Returns the public key and an import token you need to import or reimport key material for a KMS key.

By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.

Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store. You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.

GetParametersForImport returns the items that you need to import your key material.

The public key (or "wrapping key") of an RSA key pair that KMS generates.

You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.

The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.

GetParametersForImport requires the following information:

The key ID of the KMS key for which you are importing the key material.
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
The wrapping algorithm that you will use with the public key to encrypt your key material.

You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:GetParametersForImport (key policy)

Related operations:

ImportKeyMaterial
DeleteImportedKeyMaterial

Parameter Syntax

$result = $client->getParametersForImport([
    'KeyId' => '<string>', // REQUIRED
    'WrappingAlgorithm' => 'RSAES_PKCS1_V1_5|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|RSA_AES_KEY_WRAP_SHA_1|RSA_AES_KEY_WRAP_SHA_256', // REQUIRED
    'WrappingKeySpec' => 'RSA_2048|RSA_3072|RSA_4096', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

The identifier of the KMS key that will be associated with the imported key material. The Origin of the KMS key must be EXTERNAL.

All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS key 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.

WrappingAlgorithm

Required: Yes
Type: string

The algorithm you will use with the RSA public key (PublicKey) in the response to protect your key material during import. For more information, see Select a wrapping algorithm in the Key Management Service Developer Guide.

For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS.

The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.

RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.
RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.
RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).

You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).

You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.
RSAES_PKCS1_V1_5 (Deprecated) — Supported only for symmetric encryption key material (and only in legacy mode).

WrappingKeySpec

Required: Yes
Type: string

The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import.

Use the longest RSA wrapping key that is practical.

You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key.

Result Syntax

[
    'ImportToken' => <string || resource || Psr\Http\Message\StreamInterface>,
    'KeyId' => '<string>',
    'ParametersValidTo' => <DateTime>,
    'PublicKey' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

ImportToken

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The import token to send in a subsequent ImportKeyMaterial request.

KeyId

Type: string

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.

ParametersValidTo

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

PublicKey

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The public key to use to encrypt the key material before importing it with ImportKeyMaterial.

Errors

InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To download the public key and import token for a symmetric encryption KMS key

The following example downloads a public key and import token to import symmetric encryption key material. It uses the default wrapping key spec and the RSAES_OAEP_SHA_256 wrapping algorithm.

$result = $client->getParametersForImport([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'WrappingAlgorithm' => 'RSAES_OAEP_SHA_1', // The algorithm that you will use to encrypt the key material before importing it.
    'WrappingKeySpec' => 'RSA_2048', // The type of wrapping key (public key) to return in the response.
]);

Result syntax:

[
    'ImportToken' => <BLOB>, // The import token to send with a subsequent ImportKeyMaterial request.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that will be associated with the imported key material.
    'ParametersValidTo' => , // The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
    'PublicKey' => <BLOB>, // The public key to use to encrypt the key material before importing it.
]

Example 2: To download the public key and import token for an RSA asymmetric KMS key

The following example downloads a public key and import token to import an RSA private key. It uses a required RSA_AES wrapping algorithm and the largest supported private key.

$result = $client->getParametersForImport([
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'WrappingAlgorithm' => 'RSA_AES_KEY_WRAP_SHA_256', // The algorithm that you will use to encrypt the key material before importing it.
    'WrappingKeySpec' => 'RSA_4096', // The type of wrapping key (public key) to return in the response.
]);

Result syntax:

[
    'ImportToken' => <BLOB>, // The import token to send with a subsequent ImportKeyMaterial request.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/8888abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that will be associated with the imported key material.
    'ParametersValidTo' => , // The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
    'PublicKey' => <BLOB>, // The public key to use to encrypt the key material before importing it.
]

Example 3: To download the public key and import token for an elliptic curve (ECC) asymmetric KMS key

The following example downloads a public key and import token to import an ECC_NIST_P521 (secp521r1) private key. You cannot directly wrap this ECC key under an RSA_2048 public key, although you can use an RSA_2048 public key with an RSA_AES wrapping algorithm to wrap any supported key material. This example requests an RSA_3072 public key for use with the RSAES_OAEP_SHA_256.

$result = $client->getParametersForImport([
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'WrappingAlgorithm' => 'RSAES_OAEP_SHA_256', // The algorithm that you will use to encrypt the key material before importing it.
    'WrappingKeySpec' => 'RSA_3072', // The type of wrapping key (public key) to return in the response.
]);

Result syntax:

[
    'ImportToken' => <BLOB>, // The import token to send with a subsequent ImportKeyMaterial request.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/9876abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that will be associated with the imported key material.
    'ParametersValidTo' => , // The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
    'PublicKey' => <BLOB>, // The public key to use to encrypt the key material before importing it.
]

Example 4: To download the public key and import token for an HMAC KMS key

The following example downloads a public key and import token to import an HMAC key. It uses the RSAES_OAEP_SHA_256 wrapping algorithm and an RSA_4096 private key.

$result = $client->getParametersForImport([
    'KeyId' => '2468abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key that will be associated with the imported key material. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'WrappingAlgorithm' => 'RSAES_OAEP_SHA_256', // The algorithm that you will use to encrypt the key material before importing it.
    'WrappingKeySpec' => 'RSA_4096', // The type of wrapping key (public key) to return in the response.
]);

Result syntax:

[
    'ImportToken' => <BLOB>, // The import token to send with a subsequent ImportKeyMaterial request.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/2468abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that will be associated with the imported key material.
    'ParametersValidTo' => , // The date and time when the import token and public key expire. After this time, call GetParametersForImport again.
    'PublicKey' => <BLOB>, // The public key to use to encrypt the key material before importing it.
]

GetPublicKey

$result = $client->getPublicKey([/* ... */]);
$promise = $client->getPublicKeyAsync([/* ... */]);

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric KMS key. You can share the public key to allow others to encrypt messages and verify signatures outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

You do not need to download the public key. Instead, you can use the public key within KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the public key within KMS, you benefit from the authentication, authorization, and logging that are part of every KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of KMS.

To help you use the public key safely outside of KMS, GetPublicKey returns important information about the public key in the response, including:

KeySpec: The type of key material in the public key, such as RSA_4096 or ECC_NIST_P521.
KeyUsage: Whether the key is used for encryption or signing.
EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the signing algorithms for the key.

Although KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.

To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:GetPublicKey (key policy)

Related operations: CreateKey

Parameter Syntax

$result = $client->getPublicKey([
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

Identifies the asymmetric KMS key that includes the public 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
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.

Result Syntax

[
    'CustomerMasterKeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
    'EncryptionAlgorithms' => ['<string>', ...],
    'KeyId' => '<string>',
    'KeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
    'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT|GENERATE_VERIFY_MAC',
    'PublicKey' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SigningAlgorithms' => ['<string>', ...],
]

Result Details

Members

CustomerMasterKeySpec

Type: string

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.

EncryptionAlgorithms

Type: Array of strings

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.

KeyId

Type: string

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

KeySpec

Type: string

The type of the of the public key that was downloaded.

KeyUsage

Type: string

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.

PublicKey

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

SigningAlgorithms

Type: Array of strings

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.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
InvalidKeyUsageException:
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.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To download the public key of an asymmetric KMS key

This example gets the public key of an asymmetric RSA KMS key used for encryption and decryption. The operation returns the key spec, key usage, and encryption or signing algorithms to help you use the public key correctly outside of AWS KMS.

$result = $client->getPublicKey([
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The key ARN of the asymmetric KMS key.
]);

Result syntax:

[
    'CustomerMasterKeySpec' => 'RSA_4096', // The key spec of the asymmetric KMS key from which the public key was downloaded.
    'EncryptionAlgorithms' => [
        'RSAES_OAEP_SHA_1',
        'RSAES_OAEP_SHA_256',
    ], // The encryption algorithms supported by the asymmetric KMS key that was downloaded.
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The key ARN of the asymmetric KMS key from which the public key was downloaded.
    'KeyUsage' => 'ENCRYPT_DECRYPT', // The key usage of the asymmetric KMS key from which the public key was downloaded.
    'PublicKey' => <BLOB>, // The public key (plaintext) of the asymmetric KMS key.
]

ImportKeyMaterial

$result = $client->importKeyMaterial([/* ... */]);
$promise = $client->importKeyMaterialAsync([/* ... */]);

Imports or reimports key material into an existing KMS key that was created without key material. ImportKeyMaterial also sets the expiration model and expiration date of the imported key material.

After you successfully import key material into a KMS key, you can reimport the same key material into that KMS key, but you cannot import different key material. You might reimport key material to replace key material that expired or key material that you deleted. You might also reimport key material to change the expiration model or expiration date of the key material. Before reimporting key material, if necessary, call DeleteImportedKeyMaterial to delete the current imported key material.

Each time you import key material into KMS, you can determine whether (ExpirationModel) and when (ValidTo) the key material expires. To change the expiration of your key material, you must import it again, either by calling ImportKeyMaterial or using the import features of the KMS console.

Before calling ImportKeyMaterial:

Create or identify a KMS key with no key material. The KMS key must have an Origin value of EXTERNAL, which indicates that the KMS key is designed for imported key material.

To create an new KMS key for imported key material, call the CreateKey operation with an Origin value of EXTERNAL. You can create a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store.
Use the DescribeKey operation to verify that the KeyState of the KMS key is PendingImport, which indicates that the KMS key has no key material.

If you are reimporting the same key material into an existing KMS key, you might need to call the DeleteImportedKeyMaterial to delete its existing key material.
Call the GetParametersForImport operation to get a public key and import token set for importing key material.
Use the public key in the GetParametersForImport response to encrypt your key material.

Then, in an ImportKeyMaterial request, you submit your encrypted key material and import token. When calling this operation, you must specify the following values:

The key ID or key ARN of the KMS key to associate with the imported key material. Its Origin must be EXTERNAL and its KeyState must be PendingImport. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account. To get the Origin and KeyState of a KMS key, call DescribeKey.
The encrypted key material.
The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport response.
Whether the key material expires (ExpirationModel) and, if so, when (ValidTo). For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.

If you set an expiration date, KMS deletes the key material from the KMS key on the specified date, making the KMS key unusable. To use the KMS key in cryptographic operations again, you must reimport the same key material. However, you can delete and reimport the key material at any time, including before the key material expires. Each time you reimport, you can eliminate or reset the expiration time.

When this operation is successful, the key state of the KMS key changes from PendingImport to Enabled, and you can use the KMS key in cryptographic operations.

If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key and repeat the import procedure. For help, see How To Import Key Material in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ImportKeyMaterial (key policy)

Related operations:

DeleteImportedKeyMaterial
GetParametersForImport

Parameter Syntax

$result = $client->importKeyMaterial([
    'EncryptedKeyMaterial' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
    'ImportToken' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'KeyId' => '<string>', // REQUIRED
    'ValidTo' => <integer || string || DateTime>,
]);

Parameter Details

Members

EncryptedKeyMaterial

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The encrypted key material to import. The key material must be encrypted under the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

ExpirationModel

Type: string

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.

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 reimport the key material.

ImportToken

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

KeyId

Required: Yes
Type: string

The identifier of the KMS key that will be associated with 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 and its KeyState must be PendingImport.

The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. You cannot perform this operation on 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.

ValidTo

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
InvalidCiphertextException:
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.
IncorrectKeyMaterialException:
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.
ExpiredImportTokenException:
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.
InvalidImportTokenException:
The request was rejected because the provided import token is invalid or is associated with a different KMS key.

Examples

Example 1: To import key material into a KMS key

The following example imports key material into the specified KMS key.

$result = $client->importKeyMaterial([
    'EncryptedKeyMaterial' => <BLOB>, // The encrypted key material to import.
    'ExpirationModel' => 'KEY_MATERIAL_DOES_NOT_EXPIRE', // A value that specifies whether the key material expires.
    'ImportToken' => <BLOB>, // The import token that you received in the response to a previous GetParametersForImport request.
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Example 2: To import key material into a KMS key

The following example imports key material that expires in 3 days. It might be part of an application that frequently reimports the same key material to comply with business rules or regulations.

$result = $client->importKeyMaterial([
    'EncryptedKeyMaterial' => <BLOB>, // The encrypted key material to import.
    'ExpirationModel' => 'KEY_MATERIAL_EXPIRES', // A value that specifies whether the key material expires.
    'ImportToken' => <BLOB>, // The import token that you received in the response to a previous GetParametersForImport request.
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'ValidTo' => , // Specifies the date and time when the imported key material expires.
]);

ListAliases

$result = $client->listAliases([/* ... */]);
$promise = $client->listAliasesAsync([/* ... */]);

Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see CreateAlias.

By default, the ListAliases operation returns all aliases in the account and region. To get only the aliases associated with a particular KMS key, use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format aws/<service-name>, such as aws/dynamodb.

The response might also include aliases that have no TargetKeyId field. These are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against your KMS aliases quota.

Cross-account use: No. ListAliases does not return aliases in other Amazon Web Services accounts.

Required permissions: kms:ListAliases (IAM policy)

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

CreateAlias
DeleteAlias
UpdateAlias

Parameter Syntax

$result = $client->listAliases([
    'KeyId' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Members

KeyId

Type: string

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.

Limit

Type: int

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.

Marker

Type: string

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.

Result Syntax

[
    'Aliases' => [
        [
            'AliasArn' => '<string>',
            'AliasName' => '<string>',
            'CreationDate' => <DateTime>,
            'LastUpdatedDate' => <DateTime>,
            'TargetKeyId' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
    'Truncated' => true || false,
]

Result Details

Members

Aliases

Type: Array of AliasListEntry structures

A list of aliases.

NextMarker

Type: string

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

Truncated

Type: boolean

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidMarkerException:
The request was rejected because the marker that specifies where pagination should next begin is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.

Examples

Example 1: To list aliases

The following example lists aliases.

$result = $client->listAliases([
]);

Result syntax:

[
    'Aliases' => [
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/aws/acm',
            'AliasName' => 'alias/aws/acm',
            'TargetKeyId' => 'da03f6f7-d279-427a-9cae-de48d07e5b66',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/aws/ebs',
            'AliasName' => 'alias/aws/ebs',
            'TargetKeyId' => '25a217e7-7170-4b8c-8bf6-045ea5f70e5b',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/aws/rds',
            'AliasName' => 'alias/aws/rds',
            'TargetKeyId' => '7ec3104e-c3f2-4b5c-bf42-bfc4772c6685',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/aws/redshift',
            'AliasName' => 'alias/aws/redshift',
            'TargetKeyId' => '08f7a25a-69e2-4fb5-8f10-393db27326fa',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/aws/s3',
            'AliasName' => 'alias/aws/s3',
            'TargetKeyId' => 'd2b0f1a3-580d-4f79-b836-bc983be8cfa5',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/example1',
            'AliasName' => 'alias/example1',
            'TargetKeyId' => '4da1e216-62d0-46c5-a7c0-5f3a3d2f8046',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/example2',
            'AliasName' => 'alias/example2',
            'TargetKeyId' => 'f32fef59-2cc2-445b-8573-2d73328acbee',
        ],
        [
            'AliasArn' => 'arn:aws:kms:us-east-2:111122223333:alias/example3',
            'AliasName' => 'alias/example3',
            'TargetKeyId' => '1374ef38-d34e-4d5f-b2c9-4e0daee38855',
        ],
    ], // A list of aliases, including the key ID of the KMS key that each alias refers to.
    'Truncated' => , // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
]

ListGrants

$result = $client->listGrants([/* ... */]);
$promise = $client->listGrantsAsync([/* ... */]);

Gets a list of all grants for the specified KMS key.

You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal.

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.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:ListGrants (key policy)

Related operations:

CreateGrant
ListRetirableGrants
RetireGrant
RevokeGrant

Parameter Syntax

$result = $client->listGrants([
    'GrantId' => '<string>',
    'GranteePrincipal' => '<string>',
    'KeyId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Members

GrantId

Type: string

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

GranteePrincipal

Type: string

Returns only grants where the specified principal is the grantee principal for the grant.

KeyId

Required: Yes
Type: string

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.

Limit

Type: int

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.

Marker

Type: string

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.

Result Syntax

[
    'Grants' => [
        [
            'Constraints' => [
                'EncryptionContextEquals' => ['<string>', ...],
                'EncryptionContextSubset' => ['<string>', ...],
            ],
            'CreationDate' => <DateTime>,
            'GrantId' => '<string>',
            'GranteePrincipal' => '<string>',
            'IssuingAccount' => '<string>',
            'KeyId' => '<string>',
            'Name' => '<string>',
            'Operations' => ['<string>', ...],
            'RetiringPrincipal' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
    'Truncated' => true || false,
]

Result Details

Members

Grants

Type: Array of GrantListEntry structures

A list of grants.

NextMarker

Type: string

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

Truncated

Type: boolean

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidMarkerException:
The request was rejected because the marker that specifies where pagination should next begin is not valid.
InvalidGrantIdException:
The request was rejected because the specified GrantId is not valid.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To list grants for a KMS key

The following example lists grants for the specified KMS key.

$result = $client->listGrants([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Result syntax:

[
    'Grants' => [
        [
            'CreationDate' => ,
            'GrantId' => '91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172',
            'GranteePrincipal' => 'acm.us-east-2.amazonaws.com',
            'IssuingAccount' => 'arn:aws:iam::111122223333:root',
            'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
            'Operations' => [
                'Encrypt',
                'ReEncryptFrom',
                'ReEncryptTo',
            ],
            'RetiringPrincipal' => 'acm.us-east-2.amazonaws.com',
        ],
        [
            'CreationDate' => ,
            'GrantId' => 'a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200',
            'GranteePrincipal' => 'acm.us-east-2.amazonaws.com',
            'IssuingAccount' => 'arn:aws:iam::111122223333:root',
            'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
            'Operations' => [
                'ReEncryptFrom',
                'ReEncryptTo',
            ],
            'RetiringPrincipal' => 'acm.us-east-2.amazonaws.com',
        ],
        [
            'CreationDate' => ,
            'GrantId' => 'c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f',
            'GranteePrincipal' => 'acm.us-east-2.amazonaws.com',
            'IssuingAccount' => 'arn:aws:iam::111122223333:root',
            'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
            'Operations' => [
                'Encrypt',
                'ReEncryptFrom',
                'ReEncryptTo',
            ],
            'RetiringPrincipal' => 'acm.us-east-2.amazonaws.com',
        ],
        [
            'CreationDate' => ,
            'GrantId' => 'dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c',
            'GranteePrincipal' => 'acm.us-east-2.amazonaws.com',
            'IssuingAccount' => 'arn:aws:iam::111122223333:root',
            'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
            'Operations' => [
                'Encrypt',
                'ReEncryptFrom',
                'ReEncryptTo',
            ],
            'RetiringPrincipal' => 'acm.us-east-2.amazonaws.com',
        ],
    ], // A list of grants.
    'Truncated' => 1, // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
]

ListKeyPolicies

$result = $client->listKeyPolicies([/* ... */]);
$promise = $client->listKeyPoliciesAsync([/* ... */]);

Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListKeyPolicies (key policy)

Related operations:

GetKeyPolicy
PutKeyPolicy

Parameter Syntax

$result = $client->listKeyPolicies([
    'KeyId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Limit

Type: int

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.

Marker

Type: string

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.

Result Syntax

[
    'NextMarker' => '<string>',
    'PolicyNames' => ['<string>', ...],
    'Truncated' => true || false,
]

Result Details

Members

NextMarker

Type: string

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

PolicyNames

Type: Array of strings

A list of key policy names. The only valid value is default.

Truncated

Type: boolean

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To list key policies for a KMS key

The following example lists key policies for the specified KMS key.

$result = $client->listKeyPolicies([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Result syntax:

[
    'PolicyNames' => [
        'default',
    ], // A list of key policy names.
    'Truncated' => , // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
]

ListKeys

$result = $client->listKeys([/* ... */]);
$promise = $client->listKeysAsync([/* ... */]);

Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListKeys (IAM policy)

Related operations:

CreateKey
DescribeKey
ListAliases
ListResourceTags

Parameter Syntax

$result = $client->listKeys([
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Members

Limit

Type: int

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.

Marker

Type: string

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.

Result Syntax

[
    'Keys' => [
        [
            'KeyArn' => '<string>',
            'KeyId' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
    'Truncated' => true || false,
]

Result Details

Members

Keys

Type: Array of KeyListEntry structures

A list of KMS keys.

NextMarker

Type: string

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

Truncated

Type: boolean

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
InvalidMarkerException:
The request was rejected because the marker that specifies where pagination should next begin is not valid.

Examples

Example 1: To list KMS keys

The following example lists KMS keys.

$result = $client->listKeys([
]);

Result syntax:

[
    'Keys' => [
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e',
            'KeyId' => '0d990263-018e-4e65-a703-eff731de951e',
        ],
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841',
            'KeyId' => '144be297-0ae1-44ac-9c8f-93cd8c82f841',
        ],
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571',
            'KeyId' => '21184251-b765-428e-b852-2c7353e72571',
        ],
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c',
            'KeyId' => '214fe92f-5b03-4ae1-b350-db2a45dbe10c',
        ],
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458',
            'KeyId' => '339963f2-e523-49d3-af24-a0fe752aa458',
        ],
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a',
            'KeyId' => 'b776a44b-df37-4438-9be4-a27494e4271a',
        ],
        [
            'KeyArn' => 'arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb',
            'KeyId' => 'deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb',
        ],
    ], // A list of KMS keys, including the key ID and Amazon Resource Name (ARN) of each one.
    'Truncated' => , // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
]

ListResourceTags

$result = $client->listResourceTags([/* ... */]);
$promise = $client->listResourceTagsAsync([/* ... */]);

Returns all tags on the specified KMS key.

For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. For information about using tags in KMS, see Tagging keys.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListResourceTags (key policy)

Related operations:

CreateKey
ReplicateKey
TagResource
UntagResource

Parameter Syntax

$result = $client->listResourceTags([
    'KeyId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Limit

Type: int

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.

Marker

Type: string

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.

Result Syntax

[
    'NextMarker' => '<string>',
    'Tags' => [
        [
            'TagKey' => '<string>',
            'TagValue' => '<string>',
        ],
        // ...
    ],
    'Truncated' => true || false,
]

Result Details

Members

NextMarker

Type: string

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.

Tags

Type: Array of Tag structures

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.

Truncated

Type: boolean

Errors

KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
InvalidMarkerException:
The request was rejected because the marker that specifies where pagination should next begin is not valid.

Examples

Example 1: To list tags for a KMS key

The following example lists tags for a KMS key.

$result = $client->listResourceTags([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

Result syntax:

[
    'Tags' => [
        [
            'TagKey' => 'CostCenter',
            'TagValue' => '87654',
        ],
        [
            'TagKey' => 'CreatedBy',
            'TagValue' => 'ExampleUser',
        ],
        [
            'TagKey' => 'Purpose',
            'TagValue' => 'Test',
        ],
    ], // A list of tags.
    'Truncated' => , // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
]

ListRetirableGrants

$result = $client->listRetirableGrants([/* ... */]);
$promise = $client->listRetirableGrantsAsync([/* ... */]);

Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal.

You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

Cross-account use: You must specify a principal in your Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need kms:ListRetirableGrants permission (or any other additional permission) in any Amazon Web Services account other than your own.

Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account.

Related operations:

CreateGrant
ListGrants
RetireGrant
RevokeGrant

Parameter Syntax

$result = $client->listRetirableGrants([
    'Limit' => <integer>,
    'Marker' => '<string>',
    'RetiringPrincipal' => '<string>', // REQUIRED
]);

Parameter Details

Members

Limit

Type: int

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.

Marker

Type: string

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.

RetiringPrincipal

Required: Yes
Type: string

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 principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

Result Syntax

[
    'Grants' => [
        [
            'Constraints' => [
                'EncryptionContextEquals' => ['<string>', ...],
                'EncryptionContextSubset' => ['<string>', ...],
            ],
            'CreationDate' => <DateTime>,
            'GrantId' => '<string>',
            'GranteePrincipal' => '<string>',
            'IssuingAccount' => '<string>',
            'KeyId' => '<string>',
            'Name' => '<string>',
            'Operations' => ['<string>', ...],
            'RetiringPrincipal' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
    'Truncated' => true || false,
]

Result Details

Members

Grants

Type: Array of GrantListEntry structures

A list of grants.

NextMarker

Type: string

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

Truncated

Type: boolean

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidMarkerException:
The request was rejected because the marker that specifies where pagination should next begin is not valid.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.

Examples

Example 1: To list grants that the specified principal can retire

The following example lists the grants that the specified principal (identity) can retire.

$result = $client->listRetirableGrants([
    'RetiringPrincipal' => 'arn:aws:iam::111122223333:role/ExampleRole', // The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of a principal such as an AWS account (root), IAM user, federated user, or assumed role user.
]);

Result syntax:

[
    'Grants' => [
        [
            'CreationDate' => ,
            'GrantId' => '0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60',
            'GranteePrincipal' => 'arn:aws:iam::111122223333:role/ExampleRole',
            'IssuingAccount' => 'arn:aws:iam::444455556666:root',
            'KeyId' => 'arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab',
            'Operations' => [
                'Decrypt',
                'Encrypt',
            ],
            'RetiringPrincipal' => 'arn:aws:iam::111122223333:role/ExampleRole',
        ],
    ], // A list of grants that the specified principal can retire.
    'Truncated' => , // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
]

PutKeyPolicy

$result = $client->putKeyPolicy([/* ... */]);
$promise = $client->putKeyPolicyAsync([/* ... */]);

Attaches a key policy to the specified KMS key.

For more information about key policies, see Key Policies 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 . For examples of adding a key policy in multiple programming languages, see Setting a key policy in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:PutKeyPolicy (key policy)

Related operations: GetKeyPolicy

Parameter Syntax

$result = $client->putKeyPolicy([
    'BypassPolicyLockoutSafetyCheck' => true || false,
    'KeyId' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Members

BypassPolicyLockoutSafetyCheck

Type: boolean

Skips ("bypasses") the key policy lockout safety check. The default value is false.

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, see Default key policy 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.

KeyId

Required: Yes
Type: string

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.

Policy

Required: Yes
Type: string

The key policy to attach to the KMS key.

The key policy must meet the following criteria:

The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
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, 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 .

PolicyName

Required: Yes
Type: string

The name of the key policy. The only valid value is default.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
MalformedPolicyDocumentException:
The request was rejected because the specified policy is not syntactically or semantically correct.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
KMSInvalidStateException:
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.

Examples

Example 1: To attach a key policy to a KMS key

The following example attaches a key policy to the specified KMS key.

$result = $client->putKeyPolicy([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'Policy' => '{ "Version": "2012-10-17", "Id": "custom-policy-2016-12-07", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:root" }, "Action": "kms:*", "Resource": "*" }, { "Sid": "Allow access for Key Administrators", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::111122223333:user/ExampleAdminUser", "arn:aws:iam::111122223333:role/ExampleAdminRole" ] }, "Action": [ "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion" ], "Resource": "*" }, { "Sid": "Allow use of the key", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/ExamplePowerUserRole" }, "Action": [ "kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey*", "kms:DescribeKey" ], "Resource": "*" }, { "Sid": "Allow attachment of persistent resources", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:role/ExamplePowerUserRole" }, "Action": [ "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant" ], "Resource": "*", "Condition": { "Bool": { "kms:GrantIsForAWSResource": "true" } } } ]}', // The key policy document.
    'PolicyName' => 'default', // The name of the key policy.
]);

ReEncrypt

$result = $client->reEncrypt([/* ... */]);
$promise = $client->reEncryptAsync([/* ... */]);

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the encryption context of a ciphertext.

The ReEncrypt operation can decrypt ciphertext that was encrypted by using a KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric KMS key outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.

When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.

If your ciphertext was encrypted under an asymmetric KMS key, you must use the SourceKeyId parameter to identify the KMS key that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.
If your ciphertext was encrypted under a symmetric encryption KMS key, the SourceKeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the source KMS key is always recommended as a best practice. When you use the SourceKeyId parameter to specify a KMS key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the ReEncrypt operation fails. This practice ensures that you use the KMS key that you intend.
To reencrypt the data, you must use the DestinationKeyId parameter to specify the KMS key that re-encrypts the data after it is decrypted. If the destination KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the KMS key.

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than the caller. To specify a KMS key in a different account, you must use its key ARN or alias ARN.

Required permissions:

kms:ReEncryptFrom permission on the source KMS key (key policy)
kms:ReEncryptTo permission on the destination KMS key (key policy)

To permit reencryption from or to a KMS key, include the "kms:ReEncrypt*" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a KMS key. But you must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

Related operations:

Decrypt
Encrypt
GenerateDataKey
GenerateDataKeyPair

Parameter Syntax

$result = $client->reEncrypt([
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'DestinationEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'DestinationEncryptionContext' => ['<string>', ...],
    'DestinationKeyId' => '<string>', // REQUIRED
    'DryRun' => true || false,
    'GrantTokens' => ['<string>', ...],
    'SourceEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'SourceEncryptionContext' => ['<string>', ...],
    'SourceKeyId' => '<string>',
]);

Parameter Details

Members

CiphertextBlob

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Ciphertext of the data to reencrypt.

DestinationEncryptionAlgorithm

Type: string

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.

DestinationEncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

Specifies that encryption context to use when the reencrypting the data.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

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

DestinationKeyId

Required: Yes
Type: string

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.

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.

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantTokens

Type: Array of strings

A list of grant tokens.

SourceEncryptionAlgorithm

Type: string

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.

SourceEncryptionContext

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

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

SourceKeyId

Type: string

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.

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.

Result Syntax

[
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'DestinationEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'KeyId' => '<string>',
    'SourceEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256|SM2PKE',
    'SourceKeyId' => '<string>',
]

Result Details

Members

CiphertextBlob

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

DestinationEncryptionAlgorithm

Type: string

The encryption algorithm that was used to reencrypt the data.

KeyId

Type: string

The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.

SourceEncryptionAlgorithm

Type: string

The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.

SourceKeyId

Type: string

Unique identifier of the KMS key used to originally encrypt the data.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
InvalidCiphertextException:
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.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
IncorrectKeyException:
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.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To reencrypt data

The following example reencrypts data with the specified KMS key.

$result = $client->reEncrypt([
    'CiphertextBlob' => <BLOB>, // The data to reencrypt.
    'DestinationKeyId' => '0987dcba-09fe-87dc-65ba-ab0987654321', // The identifier of the KMS key to use to reencrypt the data. You can use any valid key identifier.
]);

Result syntax:

[
    'CiphertextBlob' => <BLOB>, // The reencrypted data.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The ARN of the KMS key that was used to reencrypt the data.
    'SourceKeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that was originally used to encrypt the data.
]

ReplicateKey

$result = $client->replicateKey([/* ... */]);
$promise = $client->replicateKeyAsync([/* ... */]);

Replicates a multi-Region key into the specified Region. This operation creates a multi-Region replica key based on a multi-Region primary key in a different Region of the same Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a different Region. To create a multi-Region primary key, use the CreateKey operation.

A replica key is a fully-functional KMS key that can be used independently of its primary and peer replica keys. A primary key and its replica keys share properties that make them interoperable. They have the same key ID and key material. They also have the same key spec, key usage, key material origin, and automatic key rotation status. KMS automatically synchronizes these shared properties among related multi-Region keys. All other properties of a replica key can differ, including its key policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys apply to each primary key and replica key.

When this operation completes, the new replica key has a transient key state of Creating. This key state changes to Enabled (or PendingImport) after a few seconds when the process of creating the new replica key is complete. While the key state is Creating, you can manage key, but you cannot yet use it in cryptographic operations. If you are creating and using the replica key programmatically, retry on KMSInvalidStateException or call DescribeKey to check its KeyState value before using it. For details about the Creating key state, see Key states of KMS keys in the Key Management Service Developer Guide.

You cannot create more than one replica of a primary key in any Region. If the Region already includes a replica of the key you're trying to replicate, ReplicateKey returns an AlreadyExistsException error. If the key state of the existing replica is PendingDeletion, you can cancel the scheduled key deletion (CancelKeyDeletion) or wait for the key to be deleted. The new replica key you create will have the same shared properties as the original replica key.

The CloudTrail log of a ReplicateKey operation records a ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

If you replicate a multi-Region primary key with imported key material, the replica key is created with no key material. You must import the same key material that you imported into the primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

To convert a replica key to a primary key, use the UpdatePrimaryRegion operation.

ReplicateKey uses different default values for the KeyPolicy and Tags parameters than those used in the KMS console. For details, see the parameter descriptions.

Cross-account use: No. You cannot use this operation to create a replica key in a different Amazon Web Services account.

Required permissions:

kms:ReplicateKey on the primary key (in the primary key's Region). Include this permission in the primary key's key policy.
kms:CreateKey in an IAM policy in the replica Region.
To use the Tags parameter, kms:TagResource in an IAM policy in the replica Region.

Related operations

CreateKey
UpdatePrimaryRegion

Parameter Syntax

$result = $client->replicateKey([
    'BypassPolicyLockoutSafetyCheck' => true || false,
    'Description' => '<string>',
    'KeyId' => '<string>', // REQUIRED
    'Policy' => '<string>',
    'ReplicaRegion' => '<string>', // REQUIRED
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

BypassPolicyLockoutSafetyCheck

Type: boolean

Skips ("bypasses") the key policy lockout safety check. The default value is false.

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, see Default key policy 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.

Description

Type: string

A description of the KMS key. The default value is an empty string (no description).

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

KeyId

Required: Yes
Type: string

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.

Policy

Type: string

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:

The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
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, 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 .

ReplicaRegion

Required: Yes
Type: string

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.

Tags

Type: Array of Tag structures

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

Result Syntax

[
    'ReplicaKeyMetadata' => [
        'AWSAccountId' => '<string>',
        'Arn' => '<string>',
        'CloudHsmClusterId' => '<string>',
        'CreationDate' => <DateTime>,
        'CustomKeyStoreId' => '<string>',
        'CustomerMasterKeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'EncryptionAlgorithms' => ['<string>', ...],
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeySpec' => 'RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT|HMAC_224|HMAC_256|HMAC_384|HMAC_512|SM2',
        'KeyState' => 'Creating|Enabled|Disabled|PendingDeletion|PendingImport|PendingReplicaDeletion|Unavailable|Updating',
        'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT|GENERATE_VERIFY_MAC',
        'MacAlgorithms' => ['<string>', ...],
        'MultiRegion' => true || false,
        'MultiRegionConfiguration' => [
            'MultiRegionKeyType' => 'PRIMARY|REPLICA',
            'PrimaryKey' => [
                'Arn' => '<string>',
                'Region' => '<string>',
            ],
            'ReplicaKeys' => [
                [
                    'Arn' => '<string>',
                    'Region' => '<string>',
                ],
                // ...
            ],
        ],
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM|EXTERNAL_KEY_STORE',
        'PendingDeletionWindowInDays' => <integer>,
        'SigningAlgorithms' => ['<string>', ...],
        'ValidTo' => <DateTime>,
        'XksKeyConfiguration' => [
            'Id' => '<string>',
        ],
    ],
    'ReplicaPolicy' => '<string>',
    'ReplicaTags' => [
        [
            'TagKey' => '<string>',
            'TagValue' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

ReplicaKeyMetadata

Type: KeyMetadata structure

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.

ReplicaPolicy

Type: string

The key policy of the new replica key. The value is a key policy document in JSON format.

ReplicaTags

Type: Array of Tag structures

The tags on the new replica key. The value is a list of tag key and tag value pairs.

Errors

AlreadyExistsException:
The request was rejected because it attempted to create a resource that already exists.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInvalidStateException:
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.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
MalformedPolicyDocumentException:
The request was rejected because the specified policy is not syntactically or semantically correct.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
TagException:
The request was rejected because one or more tags are not valid.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Examples

Example 1: To replicate a multi-Region key in a different AWS Region

This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.

$result = $client->replicateKey([
    'KeyId' => 'arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab', // The key ID or key ARN of the multi-Region primary key
    'ReplicaRegion' => 'us-west-2', // The Region of the new replica.
]);

Result syntax:

[
    'ReplicaKeyMetadata' => [
        'AWSAccountId' => '111122223333',
        'Arn' => 'arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
        'CreationDate' => ,
        'CustomerMasterKeySpec' => 'SYMMETRIC_DEFAULT',
        'Description' => '',
        'Enabled' => 1,
        'EncryptionAlgorithms' => [
            'SYMMETRIC_DEFAULT',
        ],
        'KeyId' => 'mrk-1234abcd12ab34cd56ef1234567890ab',
        'KeyManager' => 'CUSTOMER',
        'KeyState' => 'Enabled',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'MultiRegion' => 1,
        'MultiRegionConfiguration' => [
            'MultiRegionKeyType' => 'REPLICA',
            'PrimaryKey' => [
                'Arn' => 'arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
                'Region' => 'us-east-1',
            ],
            'ReplicaKeys' => [
                [
                    'Arn' => 'arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab',
                    'Region' => 'us-west-2',
                ],
            ],
        ],
        'Origin' => 'AWS_KMS',
    ], // An object that displays detailed information about the replica key.
    'ReplicaPolicy' => '{ "Version" : "2012-10-17", "Id" : "key-default-1",...}', // The key policy of the replica key. If you don't specify a key policy, the replica key gets the default key policy for a KMS key.
    'ReplicaTags' => [
    ], // The tags on the replica key, if any.
]

RetireGrant

$result = $client->retireGrant([/* ... */]);
$promise = $client->retireGrantAsync([/* ... */]);

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation returns both values.

This operation can be called by the retiring principal for a grant, by the grantee principal if the grant allows the RetireGrant operation, and by the Amazon Web Services account in which the grant is created. It can also be called by principals to whom permission for retiring a grant is delegated. For details, see Retiring and revoking grants in the Key Management Service Developer Guide.

Cross-account use: Yes. You can retire a grant on a KMS key in a different Amazon Web Services account.

Required permissions::Permission to retire a grant is determined primarily by the grant. For details, see Retiring and revoking grants in the Key Management Service Developer Guide.

Related operations:

CreateGrant
ListGrants
ListRetirableGrants
RevokeGrant

Parameter Syntax

$result = $client->retireGrant([
    'DryRun' => true || false,
    'GrantId' => '<string>',
    'GrantToken' => '<string>',
    'KeyId' => '<string>',
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantId

Type: string

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

GrantToken

Type: string

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.

KeyId

Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
InvalidGrantIdException:
The request was rejected because the specified GrantId is not valid.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To retire a grant

The following example retires a grant.

$result = $client->retireGrant([
    'GrantId' => '0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60', // The identifier of the grant to retire.
    'KeyId' => 'arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The Amazon Resource Name (ARN) of the KMS key associated with the grant.
]);

RevokeGrant

$result = $client->revokeGrant([/* ... */]);
$promise = $client->revokeGrantAsync([/* ... */]);

Deletes the specified grant. You revoke a grant to terminate the permissions that the grant allows. For more information, see Retiring and revoking grants in the Key Management Service Developer Guide .

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in the Key Management Service Developer Guide .

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:RevokeGrant (key policy).

Related operations:

CreateGrant
ListGrants
ListRetirableGrants
RetireGrant

Parameter Syntax

$result = $client->revokeGrant([
    'DryRun' => true || false,
    'GrantId' => '<string>', // REQUIRED
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantId

Required: Yes
Type: string

Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
InvalidGrantIdException:
The request was rejected because the specified GrantId is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To revoke a grant

The following example revokes a grant.

$result = $client->revokeGrant([
    'GrantId' => '0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60', // The identifier of the grant to revoke.
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

ScheduleKeyDeletion

$result = $client->scheduleKeyDeletion([/* ... */]);
$promise = $client->scheduleKeyDeletionAsync([/* ... */]);

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it.

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key, or an asymmetric or HMAC KMS key with imported key material.) To prevent the use of a KMS key without deleting it, use DisableKey.

You can schedule the deletion of a multi-Region primary key and its replica keys at any time. However, KMS will not delete a multi-Region primary key with existing replica keys. If you schedule the deletion of a primary key with replicas, its key state changes to PendingReplicaDeletion and it cannot be replicated or used in cryptographic operations. This status can continue indefinitely. When the last of its replicas keys is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion and its waiting period (PendingWindowInDays) begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide.

When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material.

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ScheduleKeyDeletion (key policy)

Related operations

CancelKeyDeletion
DisableKey

Parameter Syntax

$result = $client->scheduleKeyDeletion([
    'KeyId' => '<string>', // REQUIRED
    'PendingWindowInDays' => <integer>,
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

PendingWindowInDays

Type: int

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. You can use the kms:ScheduleKeyDeletionPendingWindowInDays condition key to further constrain the values that principals can specify in the PendingWindowInDays parameter.

Result Syntax

[
    'DeletionDate' => <DateTime>,
    'KeyId' => '<string>',
    'KeyState' => 'Creating|Enabled|Disabled|PendingDeletion|PendingImport|PendingReplicaDeletion|Unavailable|Updating',
    'PendingWindowInDays' => <integer>,
]

Result Details

Members

DeletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

KeyId

Type: string

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

KeyState

Type: string

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.

PendingWindowInDays

Type: int

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.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To schedule a KMS key for deletion

The following example schedules the specified KMS key for deletion.

$result = $client->scheduleKeyDeletion([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'PendingWindowInDays' => 7, // The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
]);

Result syntax:

[
    'DeletionDate' => , // The date and time after which KMS deletes the KMS key.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the KMS key that is scheduled for deletion.
]

Sign

$result = $client->sign([/* ... */]);
$promise = $client->signAsync([/* ... */]);

Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed.

To use the Sign operation, provide the following information:

Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have kms:Sign permission on the KMS key.
Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter.
Choose a signing algorithm that is compatible with the KMS key.

When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature.

Best practices recommend that you limit the time during which any signature is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. Signatures do not include a timestamp, but you can include a timestamp in the signed message to help you detect when its time to refresh the signature.

To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of KMS.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:Sign (key policy)

Related operations: Verify

Parameter Syntax

$result = $client->sign([
    'DryRun' => true || false,
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'Message' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'MessageType' => 'RAW|DIGEST',
    'SigningAlgorithm' => 'RSASSA_PSS_SHA_256|RSASSA_PSS_SHA_384|RSASSA_PSS_SHA_512|RSASSA_PKCS1_V1_5_SHA_256|RSASSA_PKCS1_V1_5_SHA_384|RSASSA_PKCS1_V1_5_SHA_512|ECDSA_SHA_256|ECDSA_SHA_384|ECDSA_SHA_512|SM2DSA', // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

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.

Message

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide a message digest.

If you provide a message digest, use the DIGEST value of MessageType to prevent the digest from being hashed again while signing.

MessageType

Type: string

Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.

When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.

Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the signing operation can be compromised.

When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.

You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, this can cause verification failures when verifying with a system that assumes a single hash.

The hashing algorithm in that Sign uses is based on the SigningAlgorithm value.

Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.

SigningAlgorithm

Required: Yes
Type: string

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. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.

Result Syntax

[
    'KeyId' => '<string>',
    'Signature' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SigningAlgorithm' => 'RSASSA_PSS_SHA_256|RSASSA_PSS_SHA_384|RSASSA_PSS_SHA_512|RSASSA_PKCS1_V1_5_SHA_256|RSASSA_PKCS1_V1_5_SHA_384|RSASSA_PKCS1_V1_5_SHA_512|ECDSA_SHA_256|ECDSA_SHA_384|ECDSA_SHA_512|SM2DSA',
]

Result Details

Members

KeyId

Type: string

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

Signature

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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 ANSI 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.

SigningAlgorithm

Type: string

The signing algorithm that was used to sign the message.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To digitally sign a message with an asymmetric KMS key.

This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a given message.

$result = $client->sign([
    'KeyId' => 'alias/ECC_signing_key', // The asymmetric KMS key to be used to generate the digital signature. This example uses an alias of the KMS key.
    'Message' => <BLOB>, // Message to be signed. Use Base-64 for the CLI.
    'MessageType' => 'RAW', // Indicates whether the message is RAW or a DIGEST.
    'SigningAlgorithm' => 'ECDSA_SHA_384', // The requested signing algorithm. This must be an algorithm that the KMS key supports.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the asymmetric KMS key that was used to sign the message.
    'Signature' => <BLOB>, // The digital signature of the message.
    'SigningAlgorithm' => 'ECDSA_SHA_384', // The actual signing algorithm that was used to generate the signature.
]

Example 2: To digitally sign a message digest with an asymmetric KMS key.

This operation uses the private key in an asymmetric RSA signing KMS key to generate a digital signature for a message digest. In this example, a large message was hashed and the resulting digest is provided in the Message parameter. To tell KMS not to hash the message again, the MessageType field is set to DIGEST

$result = $client->sign([
    'KeyId' => 'alias/RSA_signing_key', // The asymmetric KMS key to be used to generate the digital signature. This example uses an alias of the KMS key.
    'Message' => <BLOB>, // Message to be signed. Use Base-64 for the CLI.
    'MessageType' => 'DIGEST', // Indicates whether the message is RAW or a DIGEST. When it is RAW, KMS hashes the message before signing. When it is DIGEST, KMS skips the hashing step and signs the Message value.
    'SigningAlgorithm' => 'RSASSA_PKCS1_V1_5_SHA_256', // The requested signing algorithm. This must be an algorithm that the KMS key supports.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The key ARN of the asymmetric KMS key that was used to sign the message.
    'Signature' => <BLOB>, // The digital signature of the message.
    'SigningAlgorithm' => 'RSASSA_PKCS1_V1_5_SHA_256', // The actual signing algorithm that was used to generate the signature.
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or edits tags on a customer managed key.

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.

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

You can use this operation to tag a customer managed key, but you cannot tag an Amazon Web Services managed key, an Amazon Web Services owned key, a custom key store, or an alias.

You can also add tags to a KMS key while creating it (CreateKey) or replicating it (ReplicateKey).

For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:TagResource (key policy)

Related operations

CreateKey
ListResourceTags
ReplicateKey
UntagResource

Parameter Syntax

$result = $client->tagResource([
    'KeyId' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

Tags

Required: Yes
Type: Array of Tag structures

One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInvalidStateException:
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.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
TagException:
The request was rejected because one or more tags are not valid.

Examples

Example 1: To tag a KMS key

The following example tags a KMS key.

$result = $client->tagResource([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    'Tags' => [
        [
            'TagKey' => 'Purpose',
            'TagValue' => 'Test',
        ],
    ], // A list of tags.
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key.

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.

When it succeeds, the UntagResource operation doesn't return any output. Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:UntagResource (key policy)

Related operations

CreateKey
ListResourceTags
ReplicateKey
TagResource

Parameter Syntax

$result = $client->untagResource([
    'KeyId' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

TagKeys

Required: Yes
Type: Array of strings

One or more tag keys. Specify only the tag keys, not the tag values.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInvalidStateException:
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.
TagException:
The request was rejected because one or more tags are not valid.

Examples

Example 1: To remove tags from a KMS key

The following example removes tags from a KMS key.

$result = $client->untagResource([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose tags you are removing.
    'TagKeys' => [
        'Purpose',
        'CostCenter',
    ], // A list of tag keys. Provide only the tag keys, not the tag values.
]);

UpdateAlias

$result = $client->updateAlias([/* ... */]);
$promise = $client->updateAliasAsync([/* ... */]);

Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region.

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

The current and new KMS key must be the same type (both symmetric or both asymmetric or both HMAC), and they must have the same key usage. This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

You cannot use UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

Because an alias is not a property of a KMS key, you can create, update, and delete the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys in the account, use the ListAliases operation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions

kms:UpdateAlias on the alias (IAM policy).
kms:UpdateAlias on the current KMS key (key policy).
kms:UpdateAlias on the new KMS key (key policy).

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

CreateAlias
DeleteAlias
ListAliases

Parameter Syntax

$result = $client->updateAlias([
    'AliasName' => '<string>', // REQUIRED
    'TargetKeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

TargetKeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
KMSInvalidStateException:
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.

Examples

Example 1: To update an alias

The following example updates the specified alias to refer to the specified KMS key.

$result = $client->updateAlias([
    'AliasName' => 'alias/ExampleAlias', // The alias to update.
    'TargetKeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

UpdateCustomKeyStore

$result = $client->updateCustomKeyStore([/* ... */]);
$promise = $client->updateCustomKeyStoreAsync([/* ... */]);

Changes the properties of a custom key store. You can use this operation to change the properties of an CloudHSM key store or an external key store.

Use the required CustomKeyStoreId parameter to identify the custom key store. Use the remaining optional parameters to change its properties. This operation does not return any property values. To verify the updated property values, use the DescribeCustomKeyStores operation.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

When updating the properties of an external key store, verify that the updated settings connect your key store, via the external key store proxy, to the same external key manager as the previous settings, or to a backup or snapshot of the external key manager with the same cryptographic keys. If the updated connection settings fail, you can fix them and retry, although an extended delay might disrupt Amazon Web Services services. However, if KMS permanently loses its access to cryptographic keys, ciphertext encrypted under those keys is unrecoverable.

For external key stores:

Some external key managers provide a simpler method for updating an external key store. For details, see your external key manager documentation.

When updating an external key store in the KMS console, you can upload a JSON-based proxy configuration file with the desired values. You cannot upload the proxy configuration file to the UpdateCustomKeyStore operation. However, you can use the file to help you determine the correct values for the UpdateCustomKeyStore parameters.

For an CloudHSM key store, you can use this operation to change the custom key store friendly name (NewCustomKeyStoreName), to tell KMS about a change to the kmsuser crypto user password (KeyStorePassword), or to associate the custom key store with a different, but related, CloudHSM cluster (CloudHsmClusterId). To update any property of an CloudHSM key store, the ConnectionState of the CloudHSM key store must be DISCONNECTED.

For an external key store, you can use this operation to change the custom key store friendly name (NewCustomKeyStoreName), or to tell KMS about a change to the external key store proxy authentication credentials (XksProxyAuthenticationCredential), connection method (XksProxyConnectivity), external proxy endpoint (XksProxyUriEndpoint) and path (XksProxyUriPath). For external key stores with an XksProxyConnectivity of VPC_ENDPOINT_SERVICE, you can also update the Amazon VPC endpoint service name (XksProxyVpcEndpointServiceName). To update most properties of an external key store, the ConnectionState of the external key store must be DISCONNECTED. However, you can update the CustomKeyStoreName, XksProxyAuthenticationCredential, and XksProxyUriPath of an external key store when it is in the CONNECTED or DISCONNECTED state.

If your update requires a DISCONNECTED state, before using UpdateCustomKeyStore, use the DisconnectCustomKeyStore operation to disconnect the custom key store. After the UpdateCustomKeyStore operation completes, use the ConnectCustomKeyStore to reconnect the custom key store. To find the ConnectionState of the custom key store, use the DescribeCustomKeyStores operation.

Before updating the custom key store, verify that the new values allow KMS to connect the custom key store to its backing key store. For example, before you change the XksProxyUriPath value, verify that the external key store proxy is reachable at the new path.

If the operation succeeds, it returns a JSON object with no properties.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:UpdateCustomKeyStore (IAM policy)

Related operations:

ConnectCustomKeyStore
CreateCustomKeyStore
DeleteCustomKeyStore
DescribeCustomKeyStores
DisconnectCustomKeyStore

Parameter Syntax

$result = $client->updateCustomKeyStore([
    'CloudHsmClusterId' => '<string>',
    'CustomKeyStoreId' => '<string>', // REQUIRED
    'KeyStorePassword' => '<string>',
    'NewCustomKeyStoreName' => '<string>',
    'XksProxyAuthenticationCredential' => [
        'AccessKeyId' => '<string>', // REQUIRED
        'RawSecretAccessKey' => '<string>', // REQUIRED
    ],
    'XksProxyConnectivity' => 'PUBLIC_ENDPOINT|VPC_ENDPOINT_SERVICE',
    'XksProxyUriEndpoint' => '<string>',
    'XksProxyUriPath' => '<string>',
    'XksProxyVpcEndpointServiceName' => '<string>',
]);

Parameter Details

Members

CloudHsmClusterId

Type: string

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.

CustomKeyStoreId

Required: Yes
Type: string

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.

KeyStorePassword

Type: string

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.

NewCustomKeyStoreName

Type: string

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.

XksProxyAuthenticationCredential

Type: XksProxyAuthenticationCredentialType structure

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.

XksProxyConnectivity

Type: string

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.

XksProxyUriEndpoint

Type: string

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.

XksProxyUriPath

Type: string

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.

XksProxyVpcEndpointServiceName

Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CustomKeyStoreNotFoundException:
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
CustomKeyStoreNameInUseException:
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.
CloudHsmClusterNotFoundException:
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:
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.
CustomKeyStoreInvalidStateException:
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.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
CloudHsmClusterNotActiveException:
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.
CloudHsmClusterInvalidConfigurationException:
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 .
XksProxyUriInUseException:
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.
XksProxyUriEndpointInUseException:
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.
XksProxyUriUnreachableException:
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.
XksProxyIncorrectAuthenticationCredentialException:
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.
XksProxyVpcEndpointServiceInUseException:
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.
XksProxyVpcEndpointServiceNotFoundException:
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.
XksProxyVpcEndpointServiceInvalidConfigurationException:
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.
XksProxyInvalidResponseException:

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

Examples

Example 1: To edit the friendly name of a custom key store

This example changes the friendly name of the AWS KMS custom key store to the name that you specify. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.

$result = $client->updateCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the custom key store that you are updating.
    'NewCustomKeyStoreName' => 'DevelopmentKeys', // A new friendly name for the custom key store.
]);

Result syntax:

[
]

Example 2: To edit the password of an AWS CloudHSM key store

This example tells AWS KMS the password for the kmsuser crypto user in the AWS CloudHSM cluster that is associated with the AWS KMS custom key store. (It does not change the password in the CloudHSM cluster.) This operation does not return any data.

$result = $client->updateCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the custom key store that you are updating.
    'KeyStorePassword' => 'ExamplePassword', // The password for the kmsuser crypto user in the CloudHSM cluster.
]);

Result syntax:

[
]

Example 3: To associate the custom key store with a different, but related, AWS CloudHSM cluster.

This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.

$result = $client->updateCustomKeyStore([
    'CloudHsmClusterId' => 'cluster-234abcdefABC', // The ID of the AWS CloudHSM cluster that you want to associate with the custom key store. This cluster must be related to the original CloudHSM cluster for this key store.
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the custom key store that you are updating.
]);

Result syntax:

[
]

Example 4: To update the proxy authentication credential of an external key store

To update the proxy authentication credential for your external key store, specify both the RawSecretAccessKey and the AccessKeyId, even if you are changing only one of the values. You can use this feature to fix an invalid credential or to change the credential when the external key store proxy rotates it.

$result = $client->updateCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // Identifies the custom key store
    'XksProxyAuthenticationCredential' => [
        'AccessKeyId' => 'ABCDE12345670EXAMPLE',
        'RawSecretAccessKey' => 'DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo=',
    ], // Specifies the values in the proxy authentication credential
]);

Result syntax:

[
]

Example 5: To edit the proxy URI path of an external key store.

This example updates the proxy URI path for an external key store

$result = $client->updateCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // The ID of the custom key store that you are updating
    'XksProxyUriPath' => '/new-path/kms/xks/v1', // The URI path to the external key store proxy APIs
]);

Result syntax:

[
]

Example 6: To update the proxy connectivity of an external key store to VPC_ENDPOINT_SERVICE

To change the external key store proxy connectivity option from public endpoint connectivity to VPC endpoint service connectivity, in addition to changing the XksProxyConnectivity value, you must change the XksProxyUriEndpoint value to reflect the private DNS name associated with the VPC endpoint service. You must also add an XksProxyVpcEndpointServiceName value.

$result = $client->updateCustomKeyStore([
    'CustomKeyStoreId' => 'cks-1234567890abcdef0', // Identifies the custom key store
    'XksProxyConnectivity' => 'VPC_ENDPOINT_SERVICE', // Specifies the connectivity option
    'XksProxyUriEndpoint' => 'https://myproxy-private.xks.example.com', // Specifies the URI endpoint that AWS KMS uses when communicating with the external key store proxy
    'XksProxyVpcEndpointServiceName' => 'com.amazonaws.vpce.us-east-1.vpce-svc-example', // Specifies the name of the VPC endpoint service that the proxy uses for communication
]);

Result syntax:

[
]

UpdateKeyDescription

$result = $client->updateKeyDescription([/* ... */]);
$promise = $client->updateKeyDescriptionAsync([/* ... */]);

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:UpdateKeyDescription (key policy)

Related operations

CreateKey
DescribeKey

Parameter Syntax

$result = $client->updateKeyDescription([
    'Description' => '<string>', // REQUIRED
    'KeyId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

Required: Yes
Type: string

New description for the KMS key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

KeyId

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.

Examples

Example 1: To update the description of a KMS key

The following example updates the description of the specified KMS key.

$result = $client->updateKeyDescription([
    'Description' => 'Example description that indicates the intended use of this KMS key.', // The updated description.
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the KMS key whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
]);

UpdatePrimaryRegion

$result = $client->updatePrimaryRegion([/* ... */]);
$promise = $client->updatePrimaryRegionAsync([/* ... */]);

Changes the primary key of a multi-Region key.

This operation changes the replica key in the specified Region to a primary key and changes the former primary key to a replica key. For example, suppose you have a primary key in us-east-1 and a replica key in eu-west-2. If you run UpdatePrimaryRegion with a PrimaryRegion value of eu-west-2, the primary key is now the key in eu-west-2, and the key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

The primary key of a multi-Region key is the source for properties that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material origin, and automatic key rotation. It's the only key that can be replicated. You cannot delete the primary key until all replica keys are deleted.

The key ID and primary Region that you specify uniquely identify the replica key that will become the primary key. The primary Region must already have a replica key. This operation does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica key, use the ReplicateKey operation.

You can run this operation while using the affected multi-Region keys in cryptographic operations. This operation should not delay, interrupt, or cause failures in cryptographic operations.

Even after this operation completes, the process of updating the primary Region might still be in progress for a few more seconds. Operations such as DescribeKey might display both the old and new primary keys as replicas. The old and new primary keys have a transient key state of Updating. The original key state is restored when the update is complete. While the key state is Updating, you can use the keys in cryptographic operations, but you cannot replicate the new primary key or perform certain management operations, such as enabling or disabling these keys. For details about the Updating key state, see Key states of KMS keys in the Key Management Service Developer Guide.

This operation does not return any output. To verify that primary key is changed, use the DescribeKey operation.

Cross-account use: No. You cannot use this operation in a different Amazon Web Services account.

Required permissions:

kms:UpdatePrimaryRegion on the current primary key (in the primary key's Region). Include this permission primary key's key policy.
kms:UpdatePrimaryRegion on the current replica key (in the replica key's Region). Include this permission in the replica key's key policy.

Related operations

CreateKey
ReplicateKey

Parameter Syntax

$result = $client->updatePrimaryRegion([
    'KeyId' => '<string>', // REQUIRED
    'PrimaryRegion' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

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.

PrimaryRegion

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DisabledException:
The request was rejected because the specified KMS key is not enabled.
InvalidArnException:
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInvalidStateException:
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.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
NotFoundException:
The request was rejected because the specified entity or resource could not be found.
UnsupportedOperationException:
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Examples

Example 1: To update the primary Region of a multi-Region KMS key

The following UpdatePrimaryRegion example changes the multi-Region replica key in the eu-central-1 Region to the primary key. The current primary key in the us-west-1 Region becomes a replica key.The KeyId parameter identifies the current primary key in the us-west-1 Region. The PrimaryRegion parameter indicates the Region of the replica key that will become the new primary key.This operation does not return any output. To verify that primary key is changed, use the DescribeKey operation.

$result = $client->updatePrimaryRegion([
    'KeyId' => 'arn:aws:kms:us-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab', // The current primary key.
    'PrimaryRegion' => 'eu-central-1', // The Region of the replica key that will become the primary key.
]);

Verify

$result = $client->verify([/* ... */]);
$promise = $client->verifyAsync([/* ... */]);

Verifies a digital signature that was generated by the Sign operation.

Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.

A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

To use the Verify operation, specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature. The message type does not need to be the same as the one used for signing, but it must indicate whether the value of the Message parameter should be hashed as part of the verification process.

You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. The advantage of using the Verify operation is that it is performed within KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:Verify (key policy)

Related operations: Sign

Parameter Syntax

$result = $client->verify([
    'DryRun' => true || false,
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'Message' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'MessageType' => 'RAW|DIGEST',
    'Signature' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'SigningAlgorithm' => 'RSASSA_PSS_SHA_256|RSASSA_PSS_SHA_384|RSASSA_PSS_SHA_512|RSASSA_PKCS1_V1_5_SHA_256|RSASSA_PKCS1_V1_5_SHA_384|RSASSA_PKCS1_V1_5_SHA_512|ECDSA_SHA_256|ECDSA_SHA_384|ECDSA_SHA_512|SM2DSA', // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

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.

Message

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

MessageType

Type: string

Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.

When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.

Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the verification operation can be compromised.

When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.

You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.

The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.

Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.

Signature

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The signature that the Sign operation generated.

SigningAlgorithm

Required: Yes
Type: string

The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

Result Syntax

[
    'KeyId' => '<string>',
    'SignatureValid' => true || false,
    'SigningAlgorithm' => 'RSASSA_PSS_SHA_256|RSASSA_PSS_SHA_384|RSASSA_PSS_SHA_512|RSASSA_PKCS1_V1_5_SHA_256|RSASSA_PKCS1_V1_5_SHA_384|RSASSA_PKCS1_V1_5_SHA_512|ECDSA_SHA_256|ECDSA_SHA_384|ECDSA_SHA_512|SM2DSA',
]

Result Details

Members

KeyId

Type: string

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

SignatureValid

Type: boolean

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.

SigningAlgorithm

Type: string

The signing algorithm that was used to verify the signature.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException:
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.
KMSInvalidSignatureException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To use an asymmetric KMS key to verify a digital signature

This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS.

$result = $client->verify([
    'KeyId' => 'alias/ECC_signing_key', // The asymmetric KMS key to be used to verify the digital signature. This example uses an alias to identify the KMS key.
    'Message' => <BLOB>, // The message that was signed.
    'MessageType' => 'RAW', // Indicates whether the message is RAW or a DIGEST.
    'Signature' => <BLOB>, // The signature to be verified.
    'SigningAlgorithm' => 'ECDSA_SHA_384', // The signing algorithm to be used to verify the signature.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the asymmetric KMS key that was used to verify the digital signature.
    'SignatureValid' => 1, // A value of 'true' Indicates that the signature was verified. If verification fails, the call to Verify fails.
    'SigningAlgorithm' => 'ECDSA_SHA_384', // The signing algorithm that was used to verify the signature.
]

Example 2: To use an asymmetric KMS key to verify a digital signature on a message digest

This operation uses the public key in an RSA asymmetric signing key pair to verify the digital signature of a message digest. Hashing a message into a digest before sending it to KMS lets you verify messages that exceed the 4096-byte message size limit. To indicate that the value of Message is a digest, use the MessageType parameter

$result = $client->verify([
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The asymmetric KMS key to be used to verify the digital signature. This example uses an alias to identify the KMS key.
    'Message' => <BLOB>, // The message that was signed.
    'MessageType' => 'DIGEST', // Indicates whether the message is RAW or a DIGEST. When it is RAW, KMS hashes the message before signing. When it is DIGEST, KMS skips the hashing step and signs the Message value.
    'Signature' => <BLOB>, // The signature to be verified.
    'SigningAlgorithm' => 'RSASSA_PSS_SHA_512', // The signing algorithm to be used to verify the signature.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321', // The key ARN of the asymmetric KMS key that was used to verify the digital signature.
    'SignatureValid' => 1, // A value of 'true' Indicates that the signature was verified. If verification fails, the call to Verify fails.
    'SigningAlgorithm' => 'RSASSA_PSS_SHA_512', // The signing algorithm that was used to verify the signature.
]

VerifyMac

$result = $client->verifyMac([/* ... */]);
$promise = $client->verifyMacAsync([/* ... */]);

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification succeeds; otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC was calculated, and the specified key was used to generate and verify the HMAC.

HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.

This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:VerifyMac (key policy)

Related operations: GenerateMac

Parameter Syntax

$result = $client->verifyMac([
    'DryRun' => true || false,
    'GrantTokens' => ['<string>', ...],
    'KeyId' => '<string>', // REQUIRED
    'Mac' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'MacAlgorithm' => 'HMAC_SHA_224|HMAC_SHA_256|HMAC_SHA_384|HMAC_SHA_512', // REQUIRED
    'Message' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

Parameter Details

Members

DryRun

Type: boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

GrantTokens

Type: Array of strings

A list of grant tokens.

KeyId

Required: Yes
Type: string

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.

Mac

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

MacAlgorithm

Required: Yes
Type: string

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.

Message

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

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.

Result Syntax

[
    'KeyId' => '<string>',
    'MacAlgorithm' => 'HMAC_SHA_224|HMAC_SHA_256|HMAC_SHA_384|HMAC_SHA_512',
    'MacValid' => true || false,
]

Result Details

Members

KeyId

Type: string

The HMAC KMS key used in the verification.

MacAlgorithm

Type: string

The MAC algorithm used in the verification.

MacValid

Type: boolean

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.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException:
The request was rejected because the specified KMS key was not available. You can retry the request.
InvalidKeyUsageException:
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.
InvalidGrantTokenException:
The request was rejected because the specified grant token is not valid.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidMacException:
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.
KMSInvalidStateException:
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.
DryRunOperationException:
The request was rejected because the DryRun parameter was specified.

Examples

Example 1: To verify an HMAC

This example verifies an HMAC for a particular message, HMAC KMS keys, and MAC algorithm. A value of 'true' in the MacValid value in the response indicates that the HMAC is valid.

$result = $client->verifyMac([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The HMAC KMS key input to the HMAC algorithm.
    'Mac' => <BLOB>, // The HMAC to be verified.
    'MacAlgorithm' => 'HMAC_SHA_384', // The HMAC algorithm requested for the operation.
    'Message' => <BLOB>, // The message input to the HMAC algorithm.
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The key ARN of the HMAC key used in the operation.
    'MacAlgorithm' => 'HMAC_SHA_384', // The HMAC algorithm used in the operation.
    'MacValid' => 1, // A value of 'true' indicates that verification succeeded. If verification fails, the call to VerifyMac fails.
]

Shapes

AliasListEntry

Description

Contains information about an alias.

Members

AliasArn

Type: string

String that contains the key ARN.

AliasName

Type: string

String that contains the alias. This value begins with alias/.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

LastUpdatedDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.

TargetKeyId

Type: string

String that contains the key identifier of the KMS key associated with the alias.

AlreadyExistsException

Description

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

Members

message

Type: string

CloudHsmClusterInUseException

Description

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.

Members

message

Type: string

CloudHsmClusterInvalidConfigurationException

Description

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 .

Members

message

Type: string

CloudHsmClusterNotActiveException

Description

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.

Members

message

Type: string

CloudHsmClusterNotFoundException

Description

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

Members

message

Type: string

CloudHsmClusterNotRelatedException

Description

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.

Members

message

Type: string

CustomKeyStoreHasCMKsException

Description

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.

Members

message

Type: string

CustomKeyStoreInvalidStateException

Description

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.

Members

message

Type: string

CustomKeyStoreNameInUseException

Description

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.

Members

message

Type: string

CustomKeyStoreNotFoundException

Description

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

Members

message

Type: string

CustomKeyStoresListEntry

Description

Contains information about each custom key store in the custom key store list.

Members

CloudHsmClusterId

Type: string

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.

ConnectionErrorCode

Type: string

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.

ConnectionState

Type: string

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.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the custom key store was created.

CustomKeyStoreId

Type: string

A unique identifier for the custom key store.

CustomKeyStoreName

Type: string

The user-specified friendly name for the custom key store.

CustomKeyStoreType

Type: string

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.

TrustAnchorCertificate

Type: string

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.

XksProxyConfiguration

Type: XksProxyConfigurationType structure

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.

DependencyTimeoutException

Description

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

Members

message

Type: string

DisabledException

Description

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

Members

message

Type: string

DryRunOperationException

Description

The request was rejected because the DryRun parameter was specified.

Members

message

Type: string

ExpiredImportTokenException

Description

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.

Members

message

Type: string

GrantConstraints

Description

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 .

Members

EncryptionContextEquals

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

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.

EncryptionContextSubset

Type: Associative array of custom strings keys (EncryptionContextKey) to strings

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

Description

Contains information about a grant.

Members

Constraints

Type: GrantConstraints structure

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the grant was created.

GrantId

Type: string

The unique identifier for the grant.

GranteePrincipal

Type: string

The identity that gets the permissions in the grant.

IssuingAccount

Type: string

The Amazon Web Services account under which the grant was issued.

KeyId

Type: string

The unique identifier for the KMS key to which the grant applies.

Name

Type: string

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.

Operations

Type: Array of strings

The list of operations permitted by the grant.

RetiringPrincipal

Type: string

The principal that can retire the grant.

IncorrectKeyException

Description

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.

Members

message

Type: string

IncorrectKeyMaterialException

Description

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.

Members

message

Type: string

IncorrectTrustAnchorException

Description

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.

Members

message

Type: string

InvalidAliasNameException

Description

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

Members

message

Type: string

InvalidArnException

Description

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

Members

message

Type: string

InvalidCiphertextException

Description

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.

Members

message

Type: string

InvalidGrantIdException

Description

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

Members

message

Type: string

InvalidGrantTokenException

Description

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

Members

message

Type: string

InvalidImportTokenException

Description

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

Members

message

Type: string

InvalidKeyUsageException

Description

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.

Members

message

Type: string

InvalidMarkerException

Description

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

Members

message

Type: string

KMSInternalException

Description

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

Members

message

Type: string

KMSInvalidMacException

Description

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.

Members

message

Type: string

KMSInvalidSignatureException

Description

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.

Members

message

Type: string

KMSInvalidStateException

Description

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.

Members

message

Type: string

KeyListEntry

Description

Contains information about each entry in the key list.

Members

KeyArn

Type: string

ARN of the key.

KeyId

Type: string

Unique identifier of the key.

KeyMetadata

Description

Contains metadata about a KMS key.

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

Members

AWSAccountId

Type: string

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

Arn

Type: string

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.

CloudHsmClusterId

Type: string

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.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the KMS key was created.

CustomKeyStoreId

Type: string

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.

CustomerMasterKeySpec

Type: string

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.

DeletionDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

Description

Type: string

The description of the KMS key.

Enabled

Type: boolean

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

EncryptionAlgorithms

Type: Array of strings

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.

ExpirationModel

Type: string

Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

KeyId

Required: Yes
Type: string

The globally unique identifier for the KMS key.

KeyManager

Type: string

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.

KeySpec

Type: string

Describes the type of key material in the KMS key.

KeyState

Type: string

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Key Management Service 2014-11-01

Operation Summary

Paginators

Operations

CancelKeyDeletion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To cancel deletion of a KMS key

ConnectCustomKeyStore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To connect a custom key store

CreateAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To create an alias

CreateCustomKeyStore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create an AWS CloudHSM key store

Example 2: To create an external key store with VPC endpoint service connectivity

Example 3: To create an external key store with public endpoint connectivity

CreateGrant

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a grant

CreateKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a KMS key

Example 2: To create an asymmetric RSA KMS key for encryption and decryption

Example 3: To create an asymmetric elliptic curve KMS key for signing and verification

Example 4: To create an HMAC KMS key

Example 5: To create a multi-Region primary KMS key

Example 6: To create a KMS key for imported key material

Example 7: To create a KMS key in an AWS CloudHSM key store

Example 8: To create a KMS key in an external key store

Decrypt

Parameter Syntax

Parameter Details